despecable 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27abde4ea35465717dd657bc7243ecd69d5060a266531a444db7a1193ca5ba5d
-  data.tar.gz: 85bac7c82642febacbbb55aa1dddbd7673ae5fc921741da3f9d49d8ac097424b
+  metadata.gz: 21d4ff25fc5caeb17ccfea449764dc172f51d7cf9e1bf0029a940fed5b0afae5
+  data.tar.gz: 84773247671c2b31f2a7c898aba845b69857d5c6af096f655bef45a58c738e55
 SHA512:
-  metadata.gz: 2de10da5e0c3743cbb77e3bf3668f6e30015f05c7ca8d5d54c80715f16b24a8bbf3d27a6e7b39c53e691dadaf0c03770062e2bebf303fc194c2ac88be72e4556
-  data.tar.gz: 060645f9d637a3028c3dee97ea8850444e2f4b88cb2e178a998955b0893bd77bc7010e2dda5a552d2f2e9e7c599cccfc8739f9b2d462979539cbb1330f61ff04
+  metadata.gz: 50acf3db2969b86d2328b72fdeaaf87bcff50694087376763e4761c49a86a84d9fa5dd971069085579afda5a45307241ed5e5ec0dc5f74c416b1f78e0a23b716
+  data.tar.gz: c57eb7a82041c66f64a08c669fc1e690098b456204c3a6119de8a5b19386595ab2a38d9f47275c106fae5021411c60dc1c861daa07a4ddcd783e4d5ee96ab3bf

data/lib/despecable/action_controller.rb

@@ -1,24 +1,29 @@
 module Despecable
   module ActionController
     def despec(*args, strict: false, &blk)
-      despecable_me(params.dup).doit(*args, strict: strict, &blk)
+      output_params = params.dup
+      parsed = despecable_me(output_params).doit(*args, &blk)
+      despecable_me.strict(request.query_parameters.keys + request.request_parameters.keys) if strict
+      parsed.each do |key, val|
+        output_params[key] = val
+      end
+      return output_params
     end
 
-    def despec!(*args, &blk)
-      despec(*args, &blk)
-      # Loop in place of merge due to unpermitted params restriction
-      despecable_me.params.each do |key, val|
+    def despec!(*args, strict: false, &blk)
+      parsed = despecable_me(params).doit(*args, &blk)
+      despecable_me.strict(request.query_parameters.keys + request.request_parameters.keys) if strict
+      parsed.each do |key, val|
         params[key] = val
       end
+      return params
     end
 
+    # A cached instance of Despecable::Me will keep track of all despec calls
+    # in a given request / action. This allows despec to be called multiple
+    # times (e.g. in before_actions) and keep track of all spec'd params
     def despecable_me(params = {})
-      supplied_params = request.query_parameters.dup
-      # Loop in place of merge due to unpermitted params restriction
-      request.request_parameters.each do |key, val|
-        supplied_params[key] = val
-      end
-      @despecable_me ||= Despecable::Me.new(params, supplied_params)
+      @despecable_me ||= Despecable::Me.new(params)
     end
   end
 end

data/lib/despecable/me.rb

@@ -2,33 +2,26 @@ module Despecable
   class Me
     attr_reader :params
 
-    # supplied_params are the params that were actually passed in by the user.
-    # In Rails, params has some additional keys (e.g. controller, action), so you can
-    # pass in request.query_parameters (GET) and/or request.request_parameters (POST)
-    # for supplied_params to correctly get only the user-supplied parameters.
-    def initialize(params, supplied_params = nil)
-      @supplied_params = (supplied_params || params).dup
+    def initialize(params)
       @params = params
       @specd = []
     end
 
-    def doit(*args, strict: false, &blk)
+    def doit(*args, &blk)
       spectator = Despecable::Spectator.new(@params)
       spectator.instance_exec(*args, &blk) unless blk.nil?
       @specd += spectator.specd
-      despecably_strict if strict
       return spectator.params
     end
 
-    def unspecd
-      @supplied_params.keys.map(&:to_s) - @specd.map(&:to_s)
-    end
-
-    def despecably_strict
+    def strict(user_params)
+      unspecd = user_params.map(&:to_s).uniq - @specd.map(&:to_s)
       if !unspecd.empty?
         list = unspecd.map{|x| "'#{x}'"}.join(", ")
-        error = Despecable::UnrecognizedParameterError.new("Unrecognized parameters supplied: #{list}", parameters: unspecd)
-        raise error
+        raise Despecable::UnrecognizedParameterError.new(
+          "Unrecognized parameters supplied: #{list}",
+          parameters: unspecd
+        )
       end
     end
   end

data/lib/despecable/spectacles.rb

@@ -1,5 +1,16 @@
 module Despecable
   class Spectacles
+    def read(name, value, type, options, &blk)
+      if options[:array]
+        arrayify(value).map{|val| parse(name, val, type, options, &blk)}
+      elsif options[:arrayable] && arrayable?(value)
+        # TODO: :arrayable is deprecated in favor of :array
+        arrayify(value).map{|val| parse(name, val, type, options, &blk)}
+      else
+        parse(name, value, type, options, &blk)
+      end
+    end
+
     def arrayable?(value)
       value.is_a?(::Array) || /,/ =~ value.to_s
     end
@@ -9,19 +20,10 @@ module Despecable
       value.to_s.split(",")
     end
 
-    def read(name, value, type, options)
-      value = public_send(type, name, value, options) unless value.nil?
-      validate_param(name, value, options)
-      return value
-    end
-
-    def validate_param(name, value, options)
-      validate_param_presence(name, value) if options[:required]
+    def parse(name, value, type, options, &blk)
+      value = public_send(type, name, value, options, &blk)
       validate_param_value(name, value, options) if options.key?(:in) && !value.nil?
-    end
-
-    def validate_param_presence(name, value)
-      raise Despecable::MissingParameterError.new("Missing required parameter: '#{name}'", parameters: name) if value.nil?
+      return value
     end
 
     def validate_param_value(name, value, options)
@@ -110,5 +112,9 @@ module Despecable
     def any(name, value, options)
       value
     end
+
+    def custom(name, value, options)
+      return yield(name, value, options)
+    end
   end
 end

data/lib/despecable/spectator.rb

@@ -1,9 +1,15 @@
 module Despecable
   class Spectator < BasicObject
+    # This class is used to read (eval) the despec block
+    # Any methods in that block must be defined here, and this object
+    # must be stateful to be read by the controller
+
     attr_reader :params, :specd
 
     def initialize(params)
-      @params = params
+      @input_params = params
+      # TODO: allow this to be the same object to save copies
+      @params = {}
       @spectacles = ::Despecable::Spectacles.new
       @specd = []
     end
@@ -40,22 +46,20 @@ module Despecable
       _spec(name, :any, options)
     end
 
+    def custom(name, options = {}, &blk)
+      _spec(name, :custom, options, &blk)
+    end
+
     private
 
-    def _spec(name, type, options = {})
+    def _spec(name, type, options = {}, &blk)
       @specd << (name)
-      if !params.key?(name) && options.key?(:default)
-        params[name] = options[:default]
-      elsif options[:array]
-        values = @spectacles.arrayify(params[name])
-        params[name] = values.map{|val| @spectacles.read(name, val, type, options)}
-      elsif options[:arrayable] && @spectacles.arrayable?(params[name])
-        # TODO: deprecate arrayable in favor of array
-        values = @spectacles.arrayify(params[name])
-        params[name] = values.map{|val| @spectacles.read(name, val, type, options)}
-      else
-        value = @spectacles.read(name, params[name], type, options)
-        params[name] = value if params.key?(name)
+      if @input_params.key?(name)
+        @params[name] = @spectacles.read(name, @input_params[name], type, options, &blk)
+      elsif options.key?(:default)
+        @params[name] = options[:default]
+      elsif options.key?(:required)
+        ::Kernel.raise ::Despecable::MissingParameterError.new("Missing required parameter: '#{name}'", parameters: name)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: despecable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrew Schwartz