despecable 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 269604b0ffb17ef578acfa582c7842445bed4c4c
-  data.tar.gz: 7a9f3d1fbee596ef848848b77faaf5cf535b1bc2
+  metadata.gz: 5908cb3b218ad541788407780c2fdf1571e2a8af
+  data.tar.gz: 05a69230f3cfe3952c7163bec4cc5cd167a9b8c3
 SHA512:
-  metadata.gz: e207aaec581f73bd98f52c01e9e2906cd1a784b86dcf682b51f67923d1df59f7ae6a16a9426684b8c1e9696c9d37f2a6bb09410d02afb82905059d15df26ef9c
-  data.tar.gz: d2b3115499c5418afa3a13589fa1f3a049fbc64c2aca21c830774c2f5897791c98c048842fbe07def6322922e7580efa5fdd6850a9dada7fb7d027d448a45e45
+  metadata.gz: 8e3c19a19df045e73e9d201b06f17cb2981410392cd183a0be9cdfdb1b53b32ada0db616ec5591d689ef2cce86879d277abda8c8ec332036842c50016b720516
+  data.tar.gz: b32f165a8d95a821f77df9ba053d7f2f15229a90bad0ae08bdda0895e32b172d9ec0cd9e3c0519b63fbdcc7874ba6efd9a5a35133989e63a4b78472ea49e5c5b

data/lib/despecable.rb

@@ -6,6 +6,7 @@ require "despecable/spectator.rb"
 require "despecable/spectacles.rb"
 
 require "despecable/errors/despecable_error.rb"
+require "despecable/errors/unrecognized_parameter_error.rb"
 require "despecable/errors/missing_parameter_error.rb"
 require "despecable/errors/incorrect_parameter_error.rb"
 require "despecable/errors/invalid_parameter_error.rb"

data/lib/despecable/action_controller.rb

@@ -1,11 +1,16 @@
 module Despecable
   module ActionController
-    def despec(&blk)
-      Despecable::Me.new(params.deep_dup).doit(&blk)
+    def despec(*args, strict: false, &blk)
+      despecable_me(params.deep_dup).doit(*args, strict: strict, &blk)
     end
 
-    def despec!(&blk)
-      Despecable::Me.new(params).doit(&blk)
+    def despec!(*args, &blk)
+      despec(*args, &blk)
+      params.merge!(despecable_me.params)
+    end
+
+    def despecable_me(params = {})
+      @despecable_me ||= Despecable::Me.new(params, request.query_parameters.merge(request.request_parameters))
     end
   end
 end

data/lib/despecable/errors/missing_parameter_error.rb

@@ -1,5 +1,5 @@
 class Despecable::MissingParameterError < Despecable::DespecableError
-  def intro_message(name)
+  def introduction(name)
     "Missing required parameter '#{name}'."
   end
 end

data/lib/despecable/errors/unrecognized_parameter_error.rb

@@ -0,0 +1,5 @@
+class Despecable::UnrecognizedParameterError < Despecable::DespecableError
+  def intro_message(name)
+    "Unrecognized parameter name: '#{name}'"
+  end
+end

data/lib/despecable/me.rb

@@ -2,14 +2,33 @@ module Despecable
   class Me
     attr_reader :params
 
-    def initialize(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).deep_dup
       @params = params
+      @specd = []
     end
 
-    def doit(&blk)
+    def doit(*args, strict: false, &blk)
       spectator = Despecable::Spectator.new(@params)
-      spectator.instance_eval(&blk)
+      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
+      if !unspecd.empty?
+        list = unspecd.map{|x| "'#{x}'"}.join(", ")
+        raise Despecable::UnrecognizedParameterError, "Unrecognized parameters: #{list}"
+      end
+    end
   end
 end

data/lib/despecable/spectator.rb

@@ -1,10 +1,11 @@
 module Despecable
   class Spectator < BasicObject
-    attr_reader :params
+    attr_reader :params, :specd
 
     def initialize(params)
       @params = params
       @spectacles = ::Despecable::Spectacles.new
+      @specd = []
     end
 
     def integer(name, options = {})
@@ -30,6 +31,7 @@ module Despecable
     private
 
     def _spec(name, type, options = {})
+      @specd.append(name)
       if !params.key?(name) && options[:default]
         params[name] = options[:default]
       elsif options[:arrayable] && @spectacles.arrayable?(params[name])

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: despecable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andrew Schwartz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2017-10-13 00:00:00.000000000 Z
 dependencies: []
 description: Write self-documenting parameter validation and type-casting in your
-  API actions.
+  API actions. Docs and development at https://github.com/ozydingo/despecable.
 email: ozydingo@gmail.com
 executables: []
 extensions: []
@@ -23,6 +23,7 @@ files:
 - lib/despecable/errors/incorrect_parameter_error.rb
 - lib/despecable/errors/invalid_parameter_error.rb
 - lib/despecable/errors/missing_parameter_error.rb
+- lib/despecable/errors/unrecognized_parameter_error.rb
 - lib/despecable/me.rb
 - lib/despecable/spectacles.rb
 - lib/despecable/spectator.rb