gin 1.2.0 → 1.2.1

data/History.rdoc

@@ -1,3 +1,12 @@
+=== 1.2.1 / 2014-03-12
+
+* Minor Enhancements
+  * Controller.autocast_params to determine if/which params should be typecast
+  * Warn when sprockets isn't found and asset pipeline is enabled
+
+* Bugfixes
+  * Fix for numeric and boolean param parsing
+
 === 1.2.0 / 2013-11-18
 
 * Major Enhancements

data/lib/gin.rb

@@ -3,7 +3,7 @@ require 'rack'
 require 'tilt'
 
 class Gin
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 
   LIB_DIR    = File.expand_path("..", __FILE__)            #:nodoc:
   PUBLIC_DIR = File.expand_path("../../public/", __FILE__) #:nodoc:

data/lib/gin/app.rb

@@ -1134,6 +1134,13 @@ class Gin::App
       w.run
       w.wait
     end
+
+  rescue LoadError => e
+    raise e unless e =~ /sprockets/
+    logger << "\nWARNING: #{self.class} asset pipelining is enabled but the \
+sprockets gem wasn't found.\nIf you want asset pipelining turned off, add the \
+following to your #{self.class} definition:
+  asset_pipeline false\n\n"
   end
 
 

data/lib/gin/controller.rb

@@ -69,12 +69,14 @@ class Gin::Controller
 
   def self.inherited subclass
     subclass.setup
+    subclass.autocast_params self.autocast_params
     super
   end
 
 
   def self.setup   # :nodoc:
     @layout = nil
+    @autocast_params = true
     @ctrl_name = Gin.underscore(self.to_s).gsub(/_?controller_?/,'')
   end
 
@@ -178,6 +180,47 @@ class Gin::Controller
   end
 
 
+  ##
+  # Define if params should be cast to autodetected types.
+  # This is an inherited attribute.
+  # * Passing a boolean turns auto-casting on or off for all params.
+  # * Passing a hash with :only or :except limits auto-casting to the
+  #   given param names
+  # By default all params are cast to their autodetected types.
+  #
+  #   autocast_params true  # enabled for all params
+  #   autocast_params false # disabled for all params
+  #   autocast_params except: [:zip, :phone, :fax]
+  #   autocast_params only: [:timestamp, :age]
+  #
+  # Params get cast as follows:
+  #   * TrueClass     true
+  #   * FalseClass:   false
+  #   * Fixnum:       1234, -1234
+  #   * Float:        1.123, -1.123
+  #   * String:       Everything else, including numbers that start with a 0
+
+  def self.autocast_params arg=nil
+    if Hash === arg && Hash === @autocast_params
+      arg.each do |k, v|
+        if @autocast_params[k]
+          @autocast_params[k] |= [*v]
+        else
+          @autocast_params[k] = [*v]
+        end
+      end
+
+    elsif arg == true || arg == false
+      @autocast_params = arg
+
+    elsif Hash === arg
+      @autocast_params = arg.dup
+    end
+
+    return @autocast_params
+  end
+
+
   class_rproxy :controller_name, :actions
 
   # The Gin::App instance used by the controller. The App instance is meant for
@@ -203,6 +246,7 @@ class Gin::Controller
     @env      = env
     @request  = Gin::Request.new env
     @response = Gin::Response.new
+    @request.autocast_params = self.class.autocast_params
   end
 
 

data/lib/gin/request.rb

@@ -1,9 +1,13 @@
 class Gin::Request < Rack::Request
   include Gin::Constants
 
+  attr_accessor :autocast_params  # :nodoc:
+
   def initialize env
+    @params = nil
+    @params_processed = false
+    @autocast_params = true
     super
-    self.params.update env[GIN_PATH_PARAMS] if env[GIN_PATH_PARAMS]
   end
 
 
@@ -28,7 +32,12 @@ class Gin::Request < Rack::Request
 
 
   def params
-    @params ||= process_params(super) || {}
+    return @params if @params_processed
+    @params = super
+    @params.update @env[GIN_PATH_PARAMS] if @env[GIN_PATH_PARAMS]
+    @params = process_params(@params)
+    @params_processed = true
+    @params
   end
 
 
@@ -45,19 +54,23 @@ class Gin::Request < Rack::Request
 
   private
 
-  M_BOOLEAN = /^true|false$/          #:nodoc:
-  M_FLOAT   = /^-?([^0]\d+|\d)\.\d+$/ #:nodoc:
-  M_INTEGER = /^-?([^0]\d+|\d)$/      #:nodoc:
+  M_BOOLEAN = /^(true|false)$/         #:nodoc:
+  M_FLOAT   = /^-?([1-9]\d+|\d)\.\d+$/ #:nodoc:
+  M_INTEGER = /^-?([1-9]\d+|\d)$/      #:nodoc:
 
   ##
   # Enable string or symbol key access to the nested params hash.
   # Make String numbers into Numerics.
 
   def process_params object
+    return object unless @autocast_params
+
     case object
     when Hash
       new_hash = Gin::StrictHash.new
-      object.each { |key, value| new_hash[key] = process_params(value) }
+      object.each do |key, value|
+        new_hash[key] = process_param?(key) ? process_params(value) : value
+      end
       new_hash
     when Array
       object.map { |item| process_params(item) }
@@ -71,4 +84,17 @@ class Gin::Request < Rack::Request
       object
     end
   end
+
+
+  def process_param? name
+    if Hash === @autocast_params
+      return false if @autocast_params[:except] &&
+                      @autocast_params[:except].include?(name.to_sym)
+
+      return @autocast_params[:only].include?(name.to_sym) if
+        @autocast_params[:only]
+    end
+
+    !!@autocast_params
+  end
 end

data/test/test_controller.rb

@@ -132,6 +132,109 @@ class ControllerTest < Test::Unit::TestCase
   end
 
 
+  def test_autocast_params
+    rack_env['QUERY_STRING'] =
+      'id=456&foo=bar&bar=5&bool=true&nbool=truefalse&zip=01234&nint=m3&nflt=01.123&neg=-12&negf=-2.1'
+
+    klass = Class.new(AppController)
+    params = klass.new(@app, rack_env).params
+
+    assert_equal true, params['bool']
+    assert_equal 'truefalse', params['nbool']
+    assert_equal 'bar', params['foo']
+    assert_equal 5, params['bar']
+    assert_equal '01234', params['zip']
+    assert_equal 'm3', params['nint']
+    assert_equal '01.123', params['nflt']
+    assert_equal -12, params['neg']
+    assert_equal -2.1, params['negf']
+  end
+
+
+  def test_autocast_params_off
+    rack_env['QUERY_STRING'] =
+      'id=456&foo=bar&bar=5&bool=true&nbool=truefalse&zip=01234&nint=m3&nflt=01.123&neg=-12&negf=-2.1'
+
+    klass = Class.new(AppController)
+    klass.autocast_params false
+    params = klass.new(@app, rack_env).params
+
+    assert_equal 'true', params['bool']
+    assert_equal 'truefalse', params['nbool']
+    assert_equal 'bar', params['foo']
+    assert_equal '5', params['bar']
+    assert_equal '01234', params['zip']
+    assert_equal 'm3', params['nint']
+    assert_equal '01.123', params['nflt']
+    assert_equal '-12', params['neg']
+    assert_equal '-2.1', params['negf']
+  end
+
+
+  def test_autocast_params_only
+    rack_env['QUERY_STRING'] =
+      'foo=bar&bar=5&bool=true&nbool=truefalse&zip=01234&nint=m3&nflt=01.123&neg=-12&negf=-2.1'
+
+    klass = Class.new(AppController)
+    klass.autocast_params :only => [:bool, :bar, :zip]
+    params = klass.new(@app, rack_env).params
+
+    assert_equal true, params['bool']
+    assert_equal 'truefalse', params['nbool']
+    assert_equal 'bar', params['foo']
+    assert_equal 5, params['bar']
+    assert_equal '01234', params['zip']
+    assert_equal 'm3', params['nint']
+    assert_equal '01.123', params['nflt']
+    assert_equal '-12', params['neg']
+    assert_equal '-2.1', params['negf']
+  end
+
+
+  def test_autocast_params_except
+    rack_env['QUERY_STRING'] =
+      'id=456&foo=bar&bar=5&bool=true&nbool=truefalse&zip=01234&nint=m3&nflt=01.123&neg=-12&negf=-2.1'
+
+    klass = Class.new(AppController)
+    klass.autocast_params :except => [:bool, :bar, :zip]
+    params = klass.new(@app, rack_env).params
+
+    assert_equal 'true', params['bool']
+    assert_equal 'truefalse', params['nbool']
+    assert_equal 'bar', params['foo']
+    assert_equal '5', params['bar']
+    assert_equal '01234', params['zip']
+    assert_equal 'm3', params['nint']
+    assert_equal '01.123', params['nflt']
+    assert_equal -12, params['neg']
+    assert_equal -2.1, params['negf']
+  end
+
+
+  def test_autocast_params_inherit
+    rack_env['QUERY_STRING'] =
+      'foo=bar&bar=5&bool=true&nbool=truefalse&zip=01234&nint=m3&nflt=01.123&neg=-12&negf=-2.1'
+
+    klass = Class.new(AppController)
+    klass.autocast_params :only => [:bool, :bar, :zip]
+
+    subklass = Class.new(klass)
+    subklass.autocast_params :only => :neg
+
+    params = klass.new(@app, rack_env).params
+
+    assert_equal true, params['bool']
+    assert_equal 5, params['bar']
+    assert_equal '-12', params['neg']
+
+    params = subklass.new(@app, rack_env).params
+
+    assert_equal true, params['bool']
+    assert_equal 5, params['bar']
+    assert_equal -12, params['neg']
+  end
+
+
   def test_class_layout
     assert_equal :foo, BarController.layout
     assert_equal :foo, AppController.layout

data/test/test_request.rb

@@ -7,8 +7,8 @@ class RequestTest < Test::Unit::TestCase
       'HTTP_HOST' => 'example.com',
       'rack.input' => '',
       'QUERY_STRING' =>
-        'id=456&foo=bar&bar=5&bool=true&zip=01234&nflt=01.123&neg=-12&negf=-2.1',
-      'gin.path_query_hash' => {'id' => 123},
+        'id=456&foo=bar&bar=5&bool=true&nbool=truefalse&zip=01234&nint=m3&nflt=01.123&neg=-12&negf=-2.1',
+      'gin.path_query_hash' => {'id' => 123, 'age' => '22'},
     }
     @req = Gin::Request.new @env
   end
@@ -16,9 +16,55 @@ class RequestTest < Test::Unit::TestCase
 
   def test_query_hash_as_param
     assert_equal 123, @req.params['id']
+    assert_equal 22, @req.params['age']
+    assert_equal true, @req.params['bool']
+    assert_equal 'truefalse', @req.params['nbool']
     assert_equal 'bar', @req.params['foo']
     assert_equal 5, @req.params['bar']
     assert_equal '01234', @req.params['zip']
+    assert_equal 'm3', @req.params['nint']
+    assert_equal '01.123', @req.params['nflt']
+    assert_equal -12, @req.params['neg']
+    assert_equal -2.1, @req.params['negf']
+  end
+
+
+  def test_query_hash_as_param_w_autocast_off
+    @req.autocast_params = false
+    assert_equal '22', @req.params['age']
+    assert_equal 'true', @req.params['bool']
+    assert_equal 'bar', @req.params['foo']
+    assert_equal '5', @req.params['bar']
+    assert_equal '01234', @req.params['zip']
+    assert_equal 'm3', @req.params['nint']
+    assert_equal '01.123', @req.params['nflt']
+    assert_equal '-12', @req.params['neg']
+    assert_equal '-2.1', @req.params['negf']
+  end
+
+
+  def test_query_hash_as_param_w_autocast_only
+    @req.autocast_params = {:only => [:age, :bool, :zip]}
+    assert_equal 22, @req.params['age']
+    assert_equal true, @req.params['bool']
+    assert_equal 'bar', @req.params['foo']
+    assert_equal '5', @req.params['bar']
+    assert_equal '01234', @req.params['zip']
+    assert_equal 'm3', @req.params['nint']
+    assert_equal '01.123', @req.params['nflt']
+    assert_equal '-12', @req.params['neg']
+    assert_equal '-2.1', @req.params['negf']
+  end
+
+
+  def test_query_hash_as_param_w_autocast_except
+    @req.autocast_params = {:except => [:age, :bool, :zip]}
+    assert_equal '22', @req.params['age']
+    assert_equal 'true', @req.params['bool']
+    assert_equal 'bar', @req.params['foo']
+    assert_equal 5, @req.params['bar']
+    assert_equal '01234', @req.params['zip']
+    assert_equal 'm3', @req.params['nint']
     assert_equal '01.123', @req.params['nflt']
     assert_equal -12, @req.params['neg']
     assert_equal -2.1, @req.params['negf']
@@ -74,6 +120,7 @@ class RequestTest < Test::Unit::TestCase
     assert_equal false, @req.send(:process_params, "false")
     assert_equal 1,     @req.send(:process_params, "1")
     assert_equal 1.1,   @req.send(:process_params, "1.1")
+    assert_equal "w1",  @req.send(:process_params, "w1")
     assert_equal "not_true", @req.send(:process_params, "not_true")
 
     ary = @req.send(:process_params, ["true", "1", "foo"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gin
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -232,7 +232,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -366786020832610929
+      hash: -1291900085741485412
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: