param_checker 0.2.0 → 0.3.0

data/README.rdoc

@@ -39,13 +39,13 @@ There are currently 5 supported functions:
 * +param+ is the string parameter to check.
 * +default+ is the value that will be returned when +param+ does not pass the check.
 * +options+ are function specific options to check +param+ against:
-  * +min+, +max+ in +check_integer+ and +check_float+ are the minimum and maximum allowed values of param. (If not provided then no range is checked at all.)
-  * +allowed+ in +check_string+ and +check_symbol+ represent the allowed values of +param+. It can be either a regular expression, a string (resp. a symbol for +check_symbol+),  or an array of strings (resp. an array of symbols for +check_symbol+).
-  * +true+ and +false+ represent the allowed string values for the true and false booleans. By default is :true => ["1", "true"] and :false => ["0", "false"]
+  * +:min+, +:max+ in +check_integer+ and +check_float+ are the minimum and maximum allowed values of param. (If not provided then no range is checked at all.)
+  * +:allowed+ in +check_string+ and +check_symbol+ represent the allowed values of +param+. It can be either a regular expression, a string (resp. a symbol for +check_symbol+),  or an array of strings (resp. an array of symbols for +check_symbol+).
+  * +:true+ and +:false+ represent the allowed string values for the true and false booleans. By default is :true => ["1", "true"] and :false => ["0", "false"]
 
 All functions return the casted value (check_integer returns an integer, check_symbol returns a symbol, and so on).
 
-== Examples
+=== Examples
 
 Below are some simple examples how to use those functions.
 
@@ -61,6 +61,33 @@ Below are some simple examples how to use those functions.
   # Have custom boolean string representation values.
   accepted = check_boolean(params[:accepted], false, :true => ["yep", "yes"], :false => ["nope", "no"])
 
+== Alternative usage
+
+Since version 0.3 you can also extend your Hash or HashWithIndifferentAccess with ParamChecker::HashExt. This will allow you to directly call the ParamChecker methods on the +params+ hash:
+
+   params.check(type, params_key, default, options)
+
++type+ can be:
+
+* +:i+ or +:integer+ calls check_integer internally
+* +:f+ or +:float+ calls check_float internally
+* +:s+ or +:string+ calls check_string internally
+* +:sym+ or +:symbol+ calls check_symbol internally
+* +:b+ or +:boolean+ calls check boolean internally
+
++params_key+ can be either an array of keys or just one key to access the hash.
+
+=== Examples
+
+    # Checks params[:page] and returns the integer representation if valid.
+    params.check(:i, :page, 5, :min => 1)
+
+    # Check params[:company][:name] and returns "Comparilla" if invalid.
+    params.check(:s, [:company, :name], "Comparilla")
+
+    # Does exactly the same (alternative type symbol for string type)
+    params.check(:string, [:company, :name], "Comparilla")
+
 == Testing
 
 ParamChecker uses RSpec for testing and has a rake task for executing the provided specs

data/lib/param_checker.rb

@@ -96,3 +96,5 @@ module ParamChecker
          :check_symbol,
          :check_boolean
 end
+
+require 'param_checker/hash_ext'

data/lib/param_checker/hash_ext.rb

@@ -0,0 +1,36 @@
+module ParamChecker
+  module HashExt
+
+    def check(type, key, default, options = {})
+      value = nil
+      if key.class == Array
+        value = self
+        key.each do |k|
+          value = value[k]
+          break if value.nil?
+        end
+      else # String || Symbol
+        value = self[key]
+      end
+
+      if value.nil?
+        default
+      else
+        case type
+        when :integer, :i
+          ParamChecker.check_integer(value, default, options)
+        when :float, :f
+          ParamChecker.check_float(value, default, options)
+        when :string, :s
+          ParamChecker.check_string(value, default, options)
+        when :symbol, :sym
+          ParamChecker.check_symbol(value, default, options)
+        when :boolean, :b
+          ParamChecker.check_boolean(value, default, options)
+        else
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/param_checker/version.rb

@@ -1,3 +1,3 @@
 module ParamChecker
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/lib/param_checker_spec.rb

@@ -121,6 +121,59 @@ describe "ParamChecker" do
     end
   end
 
+  describe "hash extension" do
+
+
+    before do
+      class Hash
+        include ParamChecker::HashExt
+      end
+
+      @params = Hash[
+        :lorem => "ipsum",
+        :foo => { :bar => "dato" }
+      ]
+     # @params.extend(ParamChecker::HashExt)
+    end
+
+    it "should call param checker module functions" do
+      ParamChecker.should_receive(:check_integer)
+      @params.check(:i, :lorem, nil)
+
+      ParamChecker.should_receive(:check_integer)
+      @params.check(:integer, :lorem, nil)
+
+      ParamChecker.should_receive(:check_float)
+      @params.check(:f, :lorem, nil)
+
+      ParamChecker.should_receive(:check_float)
+      @params.check(:float, :lorem, nil)
+
+      ParamChecker.should_receive(:check_string)
+      @params.check(:s, :lorem, nil)
+
+      ParamChecker.should_receive(:check_string)
+      @params.check(:string, :lorem, nil)
+
+      ParamChecker.should_receive(:check_symbol)
+      @params.check(:sym, :lorem, nil)
+
+      ParamChecker.should_receive(:check_symbol)
+      @params.check(:symbol, :lorem, nil)
+
+      ParamChecker.should_receive(:check_boolean)
+      @params.check(:b, :lorem, nil)
+
+      ParamChecker.should_receive(:check_boolean)
+      @params.check(:boolean, :lorem, nil)
+    end
+
+    it "should use multiple keys" do
+      ParamChecker.should_receive(:check_string).with("dato", nil, {})
+      @params.check(:s, [:foo, :bar], nil)
+    end
+  end
+
   it "can be called as module functions" do
     ParamChecker.check_integer("5", 99).should == 5
     ParamChecker.check_float("5.1", 99.2).should == 5.1

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 require 'param_checker'
+require 'param_checker/hash_ext'
 
 load(File.dirname(__FILE__) + '/model.rb')
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: param_checker
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Kai Schlamp
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-21 00:00:00 +01:00
+date: 2011-03-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/param_checker.rb
+- lib/param_checker/hash_ext.rb
 - lib/param_checker/version.rb
 - param_checker.gemspec
 - spec/lib/param_checker_spec.rb