rack-param 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ab70fd19b1ab8288d3730129fa084826b29074b
-  data.tar.gz: 181638cefec8db9eedf116a5f05b9945c40c193e
+  metadata.gz: ab3d04d1dc5029f30b604be0b2490e16140328c8
+  data.tar.gz: 13b3eb4a749b321419056b59e3a3a5918d8adcd8
 SHA512:
-  metadata.gz: 7c42afcc9052f11b231461250f5405b7bac91ea83674ad781e39369e4439751626ab9e72cdaf02e51277084192f56f06d5719bbcc1f61ec8d31228267701f8d8
-  data.tar.gz: 030fc88a1539f90eda4238624813a4439ac0e0381a3ceb3ef1eb897d3557dbeabcfdc0f668ae066441ac70a788bffcf8610d8b248dda17d60c3a8b35cc11a326
+  metadata.gz: 742f43719a390fd85917e14cb3f03897744e79685e05f5b196273a07e9264896e8029b9b624e0c957f26bd3eb3a835269996cd6c4d41bb28ec38fd32942bc780
+  data.tar.gz: f571447e217d3fece1f2c56db92d418e1d751c31e0f113b299e4d626e7f0257f4109cf8e4292418cdd9e77f4923ce1d33fc188e792f112a58da32886d38ced05

data/README.md

@@ -2,11 +2,12 @@
 
 Parameter checking and validation for `Rack::Request`. Originally designed to be used with [`Sansom`](http://github.com/fhsjaagshs/fhsjaagshs), but it also works with [`Rack`](http://github.com/rack/rack).
 
-## Installation
+Installation
+-
 
 Add this line to your application's Gemfile:
 
-    gem 'rack-param'
+    gem "rack-param"
 
 And then execute:
 
@@ -16,39 +17,159 @@ Or install it through `gem`:
 
     $ gem install rack-param
 
-## Usage
+Usage
+-
+
+For example:
 
     require "rack/param"
     
     r = Rack::Request env # pass your env
-    r.param :param_name, Integer, :required => true ...
+    r.param :positive, Integer, :min => 0, :required => true
     
-Now, `r.params` should contain a single entry:
+Now, `r.params` should contain a single entry, regardless of the original request's parameters.
     
-    { :param_name => <some Integer> }
+    { "positive" => <some Integer> }
     
-`Rack::Param` patches `Rack::Request#params` to contain only the validated parameters, in coerced form.
-
-Here's a list of options:
-
-`:required` => `true`/`false`<br />
-`:blank` => `true`/`false`<br />
-`:greater_than` => Any `Numeric`<br />
-`:less_than` => Any `Numeric`<br />
-`:min` => Any `Numeric`<br />
-`:max` => Any `Numeric`<br />
-`:length` => Any `Numeric`<br />
-`:min_length` => Any `Numeric`<br />
-`:max_length` => Any `Numeric`<br />
-`:in` => Something that responds to `include?`<br />
-`:regex` => A `Regexp`<br />
-`:validator` => A block: `{ |param| true }`<br />
-`:error_message` => A `String`. `$` is the parameter and `#` is the validator object. (`"Invalid password: $"`)
-
-## Contributing
+`Rack::Param` patches `Rack::Request#params` to contain only the validated parameters, in coerced form. If you want the original parameters hash, use the `Rack::Request#raw_params` method.
+
+Rules
+-
+
+Rules are a way of making sure parameters are valid. Rather than type them yourself, use the rules below to 
+
+<table border="0" style="width:100%">
+  <tr>
+    <td><b>Rule</b></td>
+    <td><b>Argument</b></td>
+    <td><b>Default</b></td>
+    <td><b>Description</b></td>
+  </tr>
+  <tr>
+    <td><code>:greater_than</code></td>
+    <td><code>Numeric</code></td>
+    <td>none</td>
+    <td>Self explanatory.</td>
+  </tr>
+  <tr>
+    <td><code>:less_than</code></td>
+    <td><code>Numeric</code></td>
+    <td>none</td>
+    <td>Self explanatory.</td>	
+  </tr>
+  <tr>
+    <td><code>:min</code></td>
+    <td><code>Numeric</code></td>
+    <td>none</td>
+    <td>Greater than or equal to.</td>	
+  </tr>
+  <tr>
+    <td><code>:max</code></td>
+    <td><code>Numeric</code></td>
+    <td>none</td>
+    <td>Less than or equal to.</td>	
+  </tr>
+  <tr>
+    <td><code>:length</code></td>
+    <td><code>Numeric</code></td>
+    <td>none</td>
+    <td>Self explanatory.</td>	
+  </tr>
+  <tr>
+    <td><code>:min_length</code></td>
+    <td><code>Numeric</code></td>
+    <td>none</td>
+    <td>Greater than or equal to, using the parameter's length.</td>	
+  </tr>
+  <tr>
+    <td><code>:max_length</code></td>
+    <td><code>Numeric</code></td>
+    <td>none</td>
+    <td>Less than or equal to, using the parameter's length.</td>	
+  </tr>
+  <tr>
+    <td><code>:in</code></td>
+    <td>Responds to <code>include?</code></td>
+    <td>none</td>
+    <td>Less than or equal to, using the parameter's length.</td>	
+  </tr>
+  <tr>
+    <!--TODO: This should be :matches-->
+    <td><code>:regex</code></td>
+    <td>Responds to <code>match</code></td>
+    <td>none</td>
+    <td>Self explanatory.</td>	
+  </tr>
+  <tr>
+    <td><code>:validator</code></td>
+    <td>Responds to <code>call</code> with a <i>single</i> argument. Returns <code>true</code> or <code>false</code<</td>
+    <td>none</td>
+    <td>If the argument returns something truthy or <code>true</code>, this rule is true.</td>
+  </tr>
+</table>
+
+There are also a couple options used to control parameter checking.
+
+<table border="0" style="width:100%">
+  <tr>
+    <td><b>Option</b></td>
+    <td><b>Argument</b></td>
+    <td><b>Default</b></td>
+    <td><b>Description</b></td>
+  </tr>
+  <tr>
+  	<td><code>:error_message</code></td>
+    <td><code>String</code></td>
+    <td>depends on rule</td>
+    <td>The message to be used when a <code>Rack::ParameterError</code> is raised. It has a specific format: <code>$</code> is the parameter and <code>#</code> is the argument. (ex "Invalid token: $")</td>
+   </tr>
+   <tr>
+    <td><code>:coerce</code></td>
+    <td><code>true</code>/<code>false</code></td>
+    <td><code>true</code></td>
+    <td>Whether or not rack-param coerces the parameter.</td>	
+  </tr>
+  <tr>
+    <td><code>:required</code></td>
+    <td><code>true</code>/<code>false</code></td>
+    <td><code>false</code></td>
+    <td>Whether or not the parameter is required.</td>	
+  </tr>
+  <tr>
+    <td><code>:default</code></td>
+    <td><code>Object</code></td>
+    <td><code>none</code></td>
+    <td>If the parameter doesn't exist, this value takes its place. It should be a fully coerced value.</td>	
+  </tr>
+  <tr>
+    <td><code>:transform</code></td>
+    <td>Responds to <code>call</code> with a <i>single</i> argument. Returns a new value.</td>
+    <td><code>none</code></td>
+    <td>Called to transform a coerced value.</td>	
+  </tr>
+ </table>
+ 
+Custom Types & Coercion
+-
+
+Have a custom type that you want to be able to coerce a value? Write a function whose name is the same as your class. It should take one argument, a `String`. In fact, most classes already have this (like `Integer()`)
+
+    class Money
+       ...
+    end
+    
+    # somewhere in the global scope (or in `Kernel`)
+    def Money str
+      # turn str into a `Money` and return it
+    end
+
+Contributing
+-
 
 1. Fork it ( https://github.com/sansomrb/rack-param/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+Your changes must pass the rspec test suite.

data/lib/rack/param.rb

@@ -4,136 +4,88 @@ require "rack"
 require "time"
 require "date"
 
-Boolean = "Boolean" # A boldfaced hack
+Boolean = Class.new TrueClass # giant hack
 
 module Rack
   ParameterError = Class.new StandardError
   
   class ::String
-    def truthy?
-      (/^(true|t|yes|y|1|on)$/ =~ downcase) != nil
-    end
-
-    def falsey?
-      (/^(false|f|no|n|0|off)$/ =~ downcase) != nil
-    end
+    def truthy?; (/^(true|t|yes|y|1|on)$/ =~ downcase) != nil; end
+    def falsey?; (/^(false|f|no|n|0|off)$/ =~ downcase) != nil; end
   end
   
-  class Request
-    alias_method :params_original, :params
-    def params
-      @processed_parameters ||= {}
+  class Rule
+    def self.rule message, █ new message, █ end
+    
+    def initialize message, &block
+      @blk = block
+      @msg = message
     end
     
-    def param name, type, opts={}
-			_name = name.to_s
-      
-      if params_original.member? _name
-        p = Rack::Parameter.new(
-          :name => _name,
-          :value => params_original[_name] || params[_name],
-          :type => type,
-          :conditions => opts
-        )
-      
-        raise ParameterError, p.error unless p.valid?
-        params[_name] = p.value
-      end
+    def validate! param, val, emsg=nil
+      raise ParameterError, (emsg || @msg).sub('$',"`#{param}`").sub('#',"`#{val}`") unless @blk.call(param, val)
     end
   end
   
-  class Parameter
-    attr_reader :error, :value
+  class Request
+    alias_method :raw_params, :params
+    def params; @processed_parameters ||= {}; end
     
-    class Rule
-      def initialize message, &block
-        @block = block
-        @message = message
-      end
-      
-      def self.rule message, &block
-        new message, &block
-      end
+    def param name, type, opts={}
+			name = name.to_s
+      opts = Hash[opts.map { |k,v| [k.to_sym,v] }]
 
-      def validate param, value, error_msg=nil
-        return (error_msg || @message).sub('$',"`#{param.to_s}`").sub('#',"`#{value.to_s}`") unless @block.call(param,value)
+      if raw_params.member? name
+        v = raw_params[name] || params[name]
+        
+        if !v.is_a?(type) && ((opts.member?(:coerce) && opts[:coerce]) || !opts.member?(:coerce))
+          begin
+            v = self.class.coercers[type].call type, v
+          rescue StandardError
+            raise ParameterError, "Parameter `#{name}` is not a valid #{type}."
+          end
+        end
+        
+        # will raise an error on an invalid param
+        opts.select { |k,_| self.class.rules.member? k }
+            .each { |k,arg| self.class.rules[k].validate! v, arg, opts[:error_message] }
+        
+        v = opts[:transform].to_proc.call v if opts.member?(:transform)
+        params[name] = v
+      else
+        raise ParameterError, "Parameter #{name} is required." if opts.member?(:required) && opts[:required] && !opts.member?(:default)
+        params[name] = opts[:default]
       end
     end
     
-    def initialize(opts={})
-      opts[:value].inspect
-			_opts = Hash[opts.dup.map { |k,v| [k.to_sym,v] }]
-      _opts.merge! _opts.delete(:conditions)
-      @error_message = _opts.delete :error_message
-			@default = _opts.delete :default
-			@required = _opts.delete :required
-			@transform = _opts.delete :transform
-			@delimiter = _opts.delete(:delimiter) || ","
-			@separator = _opts.delete(:separator) || ":"
-      @name = _opts.delete :name
-      @type = _opts.delete :type
-      @value = _opts.delete(:value) || @default
-      @error = process(_opts) unless default?
-    end
-
-    def valid?
-      @error.nil?
+    def self.coercers
+      @coercers ||= {
+        Date     => lambda { |t,v| Date.parse v },
+        Time     => lambda { |t,v| Time.parse v },
+        DateTime => lambda { |t,v| DateTime.parse v },
+        Array    => lambda { |t,v| v.split(',') },
+        Hash     => lambda { |t,v| Hash[v.split(',').map { |c| c.split ':', 2 }] },
+        Boolean  => lambda { |t,v| v.falsey? ? false : (v.truthy? ? true : raise(StandardError)) }
+      }
+      @coercers.default_proc = lambda { |h, k| h[k] = lambda { |t,v| method(t.to_s.to_sym).call v } }
+      @coercers
     end
     
-		def default?
-			@default == @value && !@value.nil?
-		end
-		
-		def required?
-			@required
-		end
-		
-    def nil?
-      @value.nil?
-    end
-
-    def process opts
-      return "Parameter #{@name} is required." if @value.nil? && required?
-      
-      unless @value.class == @type || @value.nil?
-        begin
-          @value = case @type.to_s.downcase.to_sym
-            when :date then Date.parse @value
-            when :time then Time.parse @value
-            when :datetime then DateTime.parse @value
-            when :array then @value.split(@delimiter)
-            when :hash then Hash[@value.split(@delimiter).map { |c| c.split @separator, 2 }]
-            when :boolean then (@value.falsey? ? false : @value.truthy? ? true : raise(StandardError))
-            else method(@type.to_s.to_sym).call @value end
-        rescue StandardError => e
-          return "Parameter `#{@name}` is not a valid #{@type.to_s}."
-        end
-      end
-      
-      validate_error = opts.detect { |k,v| break rules[k].validate @value, v, @error_message }
-      return validate_error unless validate_error.nil?
-      
-      @value = @transform.to_proc.call @value if @transform
-      nil
-    end
-     
-    def rules
-      @rules ||= {}
-      if @rules.empty?
-        @rules[:blank] = Rule.rule("$ cannot be blank.") { |p,v| v == (p.empty? rescue false) }
-        @rules[:greater_than] = Rule.rule("$ can't be less than #.") { |p,v| p > v }
-        @rules[:less_than] = Rule.rule("$ can't be greater than #.") { |p,v| p < v }
-        @rules[:min] = Rule.rule("$ can't be less than #.") { |p,v| p >= v }
-        @rules[:max] = Rule.rule("$ can't be greater than #.") { |p,v| p <= v }
-        @rules[:length] = Rule.rule("$ can't be longer or shorter than #.") { |p,v| p.length == v }
-        @rules[:min_length] = Rule.rule("$ must be longer than #.") { |p,v| p.length >= v }
-        @rules[:max_length] = Rule.rule("$ must be shorter than #.") { |p,v| p.length <= v }
-        @rules[:in] = Rule.rule("$ must be included in #.") { |p,v| v.include? p }
-        @rules[:contains] = Rule.rule("$ must include #") { |p,v| p.include? v }
-        @rules[:regex] = Rule.rule("$ failed validation.") { |p,v| v.match(p) rescue false }
-        @rules[:validator] = Rule.rule("$ failed validation.") { |p,v| v.call p }
-      end
-      @rules
+    def self.rules
+      @rules ||= {
+        :blank        => Rule.rule("$ cannot be blank.")                   { |p,v| v == (p.empty? rescue false) },
+        :greater_than => Rule.rule("$ can't be less than #.")              { |p,v| p > v },
+        :less_than    => Rule.rule("$ can't be greater than #.")           { |p,v| p < v },
+        :min          => Rule.rule("$ can't be less than #.")              { |p,v| p >= v },
+        :max          => Rule.rule("$ can't be greater than #.")           { |p,v| p <= v },
+        :length       => Rule.rule("$ can't be longer or shorter than #.") { |p,v| p.length == v },
+        :min_length   => Rule.rule("$ must be longer than #.")             { |p,v| p.length >= v },
+        :max_length   => Rule.rule("$ must be shorter than #.")            { |p,v| p.length <= v },
+        :in           => Rule.rule("$ must be included in #.")             { |p,v| v.include? p },
+        :contains     => Rule.rule("$ must include #")                     { |p,v| p.include? v },
+        :regex        => Rule.rule("$ failed validation.")                 { |p,v| v.match(p) rescue false },
+        :validator    => Rule.rule("$ failed validation.")                 { |p,v| v.call p }
+      }
     end
   end
 end

data/rack-param.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "rack-param"
-  spec.version       = "0.1.6"
+  spec.version       = "0.2.0"
   spec.authors       = ["Nathaniel Symer"]
   spec.email         = ["nate@natesymer.com"]
   spec.summary       = "Sane parameter validation for Rack::Request."
@@ -18,5 +18,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_dependency "rack", "~> 1.0"
 end

data/spec/coercion_spec.rb

@@ -2,7 +2,7 @@
 
 require_relative "./spec_helper.rb"
 
-describe Rack::Parameter do
+describe Rack::Request do
   before :all do
     @p = {
       :date => "2014/8/4",
@@ -18,38 +18,34 @@ describe Rack::Parameter do
       :integer => "42",
       :float => "420.42",
       :string => "foo bar baz",
-      :should_fail => "asdfasdf"
+      :should_fail => "asdfasdf",
+      :dont_coerce => "1"
     }
   end
   
   context "when coercing types" do
     it "parses a Date" do
       @r.param :date, Date
-
       expect(@r.params["date"]).to eq(Date.new(2014, 8, 4))
     end
     
     it "parses a Time" do
       @r.param :time, Time
-
       expect(@r.params["time"].to_i).to eq(1007044400)
     end
     
     it "parses a DateTime" do
       @r.param :datetime, DateTime
-      
       expect(@r.params["datetime"].to_s).to eq("2012-02-09T20:05:33+00:00")
     end
     
     it "parses an Array" do
       @r.param :array, Array
-      
       expect(@r.params["array"]).to eq(["asdf", "asdf", "asdf"])
     end
     
     it "parses a Hash" do
       @r.param :hash, Hash
-      
       expect(@r.params["hash"]).to eq({"key" => "value", "this" => "that", "foo" => "bar"})
     end
     
@@ -69,24 +65,27 @@ describe Rack::Parameter do
     
     it "coerces an Integer" do
       @r.param :integer, Integer
-
       expect(@r.params["integer"]).to eq(42)
     end
     
     it "coerces a Float" do
       @r.param :float, Float
-
       expect(@r.params["float"]).to eq(420.42)
     end
     
     it "\"coerces\" a String" do
       @r.param :string, String
-      
       expect(@r.params["string"]).to eq("foo bar baz")
     end
     
     it "errors out on unrecognized types" do
       expect { @r.param :should_fail, Date }.to raise_error(Rack::ParameterError)
     end
+    
+    it "doesn't coerce when the coerce option is set to false" do
+      @r.param :dont_coerce, Integer, :coerce => false
+      expect(@r.params["dont_coerce"]).to eq(@p[:dont_coerce])
+      expect(@r.params["dont_coerce"].class).to eq(String)
+    end
   end
 end

data/spec/rules_spec.rb

@@ -2,7 +2,7 @@
 
 require_relative "./spec_helper.rb"
 
-describe Rack::Parameter do
+describe Rack::Rule do
   before :all do
     @p = {
       :int_three => "3",
@@ -17,7 +17,7 @@ describe Rack::Parameter do
   
   context "when given rules" do
     it "checks a parameter based on :required" do
-      expect { @r.param :not_a_param, String, :required => true }.to raise_error(Rack::ParameterError)
+      expect { @r.param :not_a_param_asdfasdfasdfasdf, String, :required => true }.to raise_error(Rack::ParameterError)
       expect { @r.param :required, String, :required => true }.to_not raise_error
     end
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-param
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Nathaniel Symer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-05 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement