Raise ArgumentError on invalid option and alias with to using.

Author: aj0strow

CHANGELOG.md

@@ -12,6 +12,8 @@ Next Release
 * [#43](https://github.com/intridea/grape-entity/pull/43): Call procs in context of entity instance - [@joelvh](https://github.com/joelvh).
 * [#47](https://github.com/intridea/grape-entity/pull/47): Support nested exposures - [@wyattisimo](https://github.com/wyattisimo).
 * [#46](https://github.com/intridea/grape-entity/issues/46), [#50](https://github.com/intridea/grape-entity/pull/50): Added support for specifying the presenter class in `using` in string format - [@larryzhao](https://github.com/larryzhao).
+* [#51](https://github.com/intridea/grape-entity/pull/51): Raise `ArgumentError` if an unknown option is used with `expose` - [@aj0strow](https://github.com/aj0strow).
+* [#51](https://github.com/intridea/grape-entity/pull/51): Alias `:with` to `:using`, consistently with the Grape api endpoints - [@aj0strow](https://github.com/aj0strow).
 * Your contribution here.
 
 0.3.0 (2013-03-29)

README.md

@@ -275,6 +275,8 @@ module API
 end
 ```
 
+Also note that an `ArgumentError` is raised when unknown options are passed to either `expose` or `with_options`.
+
 ## Installation
 
 Add this line to your application's Gemfile:

lib/grape_entity/entity.rb

@@ -161,7 +161,7 @@ def self.expose(*args, &block)
     #     end
     #   end
     def self.with_options(options)
-      (@block_options ||= []).push(options)
+      (@block_options ||= []).push(valid_options(options))
       yield
       @block_options.pop
     end
@@ -479,6 +479,11 @@ def conditions_met?(exposure_options, options)
 
     private
 
+    # All supported options.
+    OPTIONS = [
+      :as, :if, :unless, :using, :with, :proc, :documentation, :format_with, :safe, :if_extras, :unless_extras
+    ].to_set.freeze
+
     # Merges the given options with current block options.
     #
     # @param options [Hash] Exposure options.
@@ -504,7 +509,20 @@ def self.merge_options(options)
       @block_options ||= []
       opts.merge @block_options.inject({}) { |final, step|
         final.merge(step, &merge_logic)
-      }.merge(options, &merge_logic)
+      }.merge(valid_options(options), &merge_logic)
+    end
+
+    # Raises an error if the given options include unknown keys.
+    # Renames aliased options.
+    #
+    # @param options [Hash] Exposure options.
+    def self.valid_options(options)
+      options.keys.each do |key|
+        raise ArgumentError, "#{key.inspect} is not a valid option." unless OPTIONS.include?(key)
+      end
+
+      options[:using] = options.delete(:with) if options.has_key?(:with)
+      options
     end
   end
 end

spec/grape_entity/entity_spec.rb

@@ -15,8 +15,8 @@
         end
 
         it 'sets the same options for all exposures passed' do
-          subject.expose :name, :email, :location, foo: :bar
-          subject.exposures.values.each { |v| v.should == { foo: :bar } }
+          subject.expose :name, :email, :location, documentation: true
+          subject.exposures.values.each { |v| v.should == { documentation: true } }
         end
       end
 
@@ -29,6 +29,10 @@
         it 'makes sure that :format_with as a proc cannot be used with a block' do
           expect { subject.expose :name, format_with: proc {} {} }.to raise_error ArgumentError
         end
+
+        it 'makes sure unknown options are not silently ignored' do
+          expect { subject.expose :name, unknown: nil }.to raise_error ArgumentError
+        end
       end
 
       context 'with a block' do
@@ -203,6 +207,16 @@ class BogusEntity < Grape::Entity
     end
 
     describe '.with_options' do
+      it 'raises an error for unknown options' do
+        block = proc do
+          with_options(unknown: true) do
+            expose :awesome_thing
+          end
+        end
+
+        expect { subject.class_eval(&block) }.to raise_error ArgumentError
+      end
+
       it 'applies the options to all exposures inside' do
         subject.class_eval do
           with_options(if: { awesome: true }) do
@@ -295,6 +309,15 @@ class BogusEntity < Grape::Entity
         subject.exposures[:awesome_thing].should == { using: 'SomethingElse' }
       end
 
+      it 'aliases :with option to :using option' do
+        subject.class_eval do
+          with_options(using: 'Something') do
+            expose :awesome_thing, with: 'SomethingElse'
+          end
+        end
+        subject.exposures[:awesome_thing].should == { using: 'SomethingElse' }
+      end
+
       it 'overrides nested :proc option' do
         match_proc = lambda { |obj, opts| 'more awesomer' }