constrainable 0.5.1 → 0.6.0

data/README.markdown

@@ -1,10 +1,10 @@
 # Constrainable
 
-Simple filtering for ActiveRecord. Sanitizes simple and readable query parameters -great for building APIs & HTML filters.
+Simple filtering for ActiveRecord. Sanitizes simple and readable query parameters - great for building APIs & HTML filters.
 
 ## Straight to the point. Examples:
 
-Let's asume we have a model called Post, defined as:
+Let's assume we have a model called Post, defined as:
     Post(id: integer, title: string, body: string, author_id: integer, category: string, created_at: datetime, updated_at: datetime)
 
 In the simplest possible case you can define a few attributes and start filtering:
@@ -17,7 +17,7 @@ In the simplest possible case you can define a few attributes and start filterin
 
     end
 
-    # Examle request:
+    # Example request:
     #   GET /posts?where[id__not_eq]=1&where[author_id__eq]=2
     # Params:
     #   "where" => { "id__not_eq" => "1", "author_id__eq" => "2" }
@@ -84,8 +84,8 @@ Integration with controllers, views & filter forms:
       respond_to :html
 
       def index
-        @filters = Post.constrainable.fliter(params[:where])
-        @posts = Post.constrain(@filters)
+        @filters = Post.constrainable.filter(params[:where])
+        @posts   = Post.constrain(@filters)
         respond_with @posts
       end
     end

data/lib/bsm/constrainable/field.rb

@@ -9,6 +9,7 @@ module Bsm::Constrainable::Field
   autoload :Timestamp,'bsm/constrainable/field/common'
   autoload :Datetime, 'bsm/constrainable/field/common'
   autoload :Date,     'bsm/constrainable/field/common'
+  autoload :Boolean,     'bsm/constrainable/field/common'
 
   register self::Number
   register self::Integer
@@ -17,4 +18,5 @@ module Bsm::Constrainable::Field
   register self::Timestamp
   register self::Datetime
   register self::Date
+  register self::Boolean
 end

data/lib/bsm/constrainable/field/base.rb

@@ -11,12 +11,12 @@ class Bsm::Constrainable::Field::Base
     @kind ||= name.demodulize.underscore.to_sym
   end
 
-  attr_reader :name, :operators, :attribute, :scope
+  attr_reader :name, :operators, :attribute, :scope, :options
 
   # Accepts a name and options. Valid options are:
   # * <tt>:using</tt> - a Symbol or a Proc pointing to a DB column, optional (uses name by default)
   # * <tt>:with</tt> - a list of operators to use
-  # * <tt>:scope</tt> - a Proc containing additonal scopes
+  # * <tt>:scope</tt> - a Proc containing additional scopes
   #
   # Examples:
   #
@@ -28,10 +28,11 @@ class Bsm::Constrainable::Field::Base
   #
   def initialize(name, options = {})
     @name      = name.to_s
-    @attribute = options[:using] || name
-    @operators = Set.new(self.class.operators & Array.wrap(options[:with]))
+    @options   = options.dup
+    @attribute = @options.delete(:using) || name
+    @operators = Set.new(self.class.operators & Array.wrap(@options.delete(:with)))
     @operators = Set.new(self.class.defaults) if @operators.empty?
-    @scope     = options[:scope]
+    @scope     = @options.delete(:scope)
   end
 
   # Merge params into a relation

data/lib/bsm/constrainable/field/common.rb

@@ -23,6 +23,11 @@ module Bsm::Constrainable::Field
 
   class String < Base
     self.operators = [:eq, :not_eq]
+
+    def _convert(v)
+      result = super
+      result.blank? && !options[:allow_blank] ? nil : result
+    end
   end
 
   class Timestamp < Base
@@ -43,4 +48,19 @@ module Bsm::Constrainable::Field
       v.to_date rescue nil
     end
   end
+
+  class Boolean < Base
+    self.operators = [:eq, :not_eq]
+
+    TRUE_VALUES = ["true", "TRUE", "t", "T", "1", 1].to_set.freeze
+    FALSE_VALUES = ["false", "FALSE", "f", "F", "0", 0].to_set.freeze
+
+    protected
+
+    def _convert(v)
+      result = super
+      TRUE_VALUES.include?(result) || (FALSE_VALUES.include?(result) ? false : nil)
+    end
+  end
+
 end

data/lib/bsm/constrainable/operation/base.rb

@@ -1,5 +1,4 @@
 class Bsm::Constrainable::Operation::Base
-  extend ActiveSupport::Memoizable
 
   def self.kind
     name.demodulize.underscore.to_sym
@@ -27,9 +26,9 @@ class Bsm::Constrainable::Operation::Base
   end
 
   def clause
-    valid? ? _clause : nil
+    return @clause if defined?(@clause)    
+    @clause ||= valid? ? _clause : nil
   end
-  memoize :clause
 
   protected
 
@@ -38,18 +37,16 @@ class Bsm::Constrainable::Operation::Base
     end
 
     def normalized
-      field.convert(parsed)
+      @normalized ||= field.convert(parsed)
     end
-    memoize :normalized
 
     def attribute
-      case field.attribute
+      @attribute ||= case field.attribute
       when Proc
         field.attribute.call(relation)
       else
         relation.table[field.attribute]
       end
     end
-    memoize :attribute
 
 end

data/lib/bsm/constrainable/relation.rb

@@ -1,7 +1,7 @@
 # Extension for ActiveRecord::Relation
 module Bsm::Constrainable::Relation
 
-  # Apply contraints. Example:
+  # Apply constraints. Example:
   #
   #   Post.constrain("created_at__lt" => "2011-01-01")
   #

data/lib/bsm/constrainable/schema.rb

@@ -40,7 +40,7 @@ class Bsm::Constrainable::Schema < Hash
   #   # Complex example, using an attribute from another table, and ensure it's included (LEFT OUTER JOIN)
   #   match :author, :using => proc { Author.scope.table[:name] }, :scope => { includes(:author) }, :as => :string, :with => [:eq, :matches]
   #
-  # There are also several short-cutrs available. Examples:
+  # There are also several short-cuts available. Examples:
   #
   #   timestamp :created, :using => :created_at, :with => [:lt, :between]
   #   number    :id, :author_id

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: constrainable
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-21 00:00:00.000000000Z
+date: 2012-01-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: abstract
-  requirement: &24194140 !ruby/object:Gem::Requirement
+  name: activerecord
+  requirement: &12912960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *24194140
+  version_requirements: *12912960
 - !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: &24193560 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: &12912280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,18 +32,62 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *24193560
+  version_requirements: *12912280
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &24193060 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &12911680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12911680
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &12910780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12910780
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &12909920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12909920
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: &12908980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12908980
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &12907980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  version_requirements: *24193060
+  version_requirements: *12907980
 description: Sanitizes simple and readable query parameters -great for building APIs
   & HTML filters
 email: dimitrij@blacksquaremedia.com