ransack 0.5.1 → 0.5.2

data/README.md

@@ -4,10 +4,11 @@ Ransack is a rewrite of [MetaSearch](http://metautonomo.us/projects/metasearch).
 supports many of the same features as MetaSearch, its underlying implementation differs
 greatly from MetaSearch, and _backwards compatibility is not a design goal._
 
-Ransack enables the creation of both simple and advanced search forms against your
-application's models. If you're looking for something that simplifies query generation
-at the model or controller layer, you're probably not looking for Ransack (or MetaSearch,
-for that matter). Try [Squeel](http://metautonomo.us/projects/squeel) instead.
+Ransack enables the creation of both simple and [advanced](http://ransack-demo.heroku.com)
+search forms against your application's models. If you're looking for something that
+simplifies query generation at the model or controller layer, you're probably not looking
+for Ransack (or MetaSearch, for that matter). Try 
+[Squeel](http://metautonomo.us/projects/squeel) instead.
 
 ## Getting started
 
@@ -55,13 +56,21 @@ If you're coming from MetaSearch, things to note:
      is passed to it.
   3. Common ActiveRecord::Relation methods are no longer delegated by the search object.
      Instead, you will get your search results (an ActiveRecord::Relation in the case of
-     the ActiveRecord adapter) via a call to `Search#result`.
+     the ActiveRecord adapter) via a call to `Search#result`. If passed `:distinct => true`,
+     `result` will generate a `SELECT DISTINCT` to avoid returning duplicate rows, even if
+     conditions on a join would otherwise result in some.
+     
+     Please note that for many databases, a sort on an associated table's columns will
+     result in invalid SQL with `:distinct => true` -- in those cases, you're on your own,
+     and will need to modify the result as needed to allow these queries to work. Thankfully,
+     9 times out of 10, sort against the search's base is sufficient, though, as that's
+     generally what's being displayed on your results page.
 
 In your controller:
 
     def index
       @q = Person.search(params[:q])
-      @people = @q.result
+      @people = @q.result(:distinct => true)
     end
 
 In your view:
@@ -106,7 +115,8 @@ This means you'll need to tweak your routes...
                             :html => {:method => :post} do |f| %>
 
 Once you've done so, you can make use of the helpers in Ransack::Helpers::FormBuilder to
-construct much more complex search forms.
+construct much more complex search forms, such as the one on the
+[demo page](http://ransack-demo.heroku.com).
 
 **more docs to come**
 

data/lib/ransack/nodes/attribute.rb

@@ -30,10 +30,6 @@ module Ransack
         end
       end
 
-      def cast_value(value)
-        value.cast_to_type(type)
-      end
-
       def eql?(other)
         self.class == other.class &&
         self.name == other.name

data/lib/ransack/nodes/condition.rb

@@ -4,8 +4,6 @@ module Ransack
       i18n_word :attribute, :predicate, :combinator, :value
       i18n_alias :a => :attribute, :p => :predicate, :m => :combinator, :v => :value
 
-      delegate :cast_value, :to => :first_attribute
-
       attr_reader :predicate
 
       class << self
@@ -20,7 +18,9 @@ module Ransack
               :m => combinator,
               :v => [values]
             )
-            predicate.validate(condition.values) ? condition : nil
+            # TODO: Figure out what to do with multiple types of attributes, if anything.
+            # Tempted to go with "garbage in, garbage out" on this one
+            predicate.validate(condition.values, condition.default_type) ? condition : nil
           end
         end
 
@@ -37,17 +37,13 @@ module Ransack
       end
 
       def valid?
-        attributes.detect(&:valid?) && predicate && valid_arity? && predicate.validate(values) && valid_combinator?
+        attributes.detect(&:valid?) && predicate && valid_arity? && predicate.validate(values, default_type) && valid_combinator?
       end
 
       def valid_arity?
         values.size <= 1 || predicate.compound || %w(in not_in).include?(predicate.name)
       end
 
-      def first_attribute
-        attributes.first
-      end
-
       def attributes
         @attributes ||= []
       end
@@ -117,7 +113,7 @@ module Ransack
       end
 
       def value
-        predicate.compound ? values.map {|v| cast_value(v)} : cast_value(values.first)
+        predicate.compound ? values.map {|v| v.cast(default_type)} : values.first.cast(default_type)
       end
 
       def build(params)
@@ -188,7 +184,7 @@ module Ransack
       end
 
       def casted_values_for_attribute(attr)
-        validated_values.map {|v| v.cast_to_type(predicate.type || attr.type)}
+        validated_values.map {|v| v.cast(predicate.type || attr.type)}
       end
 
       def formatted_values_for_attribute(attr)
@@ -199,6 +195,10 @@ module Ransack
         end
       end
 
+      def default_type
+        predicate.type || (attributes.first && attributes.first.type)
+      end
+
       private
 
       def valid_combinator?

data/lib/ransack/nodes/value.rb

@@ -2,7 +2,7 @@ module Ransack
   module Nodes
     class Value < Node
       attr_accessor :value
-      delegate :blank?, :present?, :to => :value
+      delegate :present?, :blank?, :to => :value
 
       def initialize(context, value = nil)
         super(context)
@@ -23,7 +23,7 @@ module Ransack
         value.hash
       end
 
-      def cast_to_type(type)
+      def cast(type)
          case type
          when :date
            cast_to_date(value)

data/lib/ransack/predicate.rb

@@ -39,7 +39,7 @@ module Ransack
       @arel_predicate = opts[:arel_predicate]
       @type = opts[:type]
       @formatter = opts[:formatter]
-      @validator = opts[:validator]
+      @validator = opts[:validator] || lambda { |v| v.present? }
       @compound = opts[:compound]
     end
 
@@ -61,12 +61,8 @@ module Ransack
       end
     end
 
-    def validate(vals)
-      if validator
-        vals.select {|v| validator.call(v.value)}.any?
-      else
-        vals.select {|v| v.present?}.any?
-      end
+    def validate(vals, type = @type)
+      vals.select {|v| validator.call(type ? v.cast(type) : v.value)}.any?
     end
 
   end

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ransack
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-11 00:00:00.000000000 -04:00
-default_executable: 
+date: 2011-06-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2153456940 !ruby/object:Gem::Requirement
+  requirement: &2156140180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153456940
+  version_requirements: *2156140180
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2153456420 !ruby/object:Gem::Requirement
+  requirement: &2156139280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +32,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153456420
+  version_requirements: *2156139280
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &2153455960 !ruby/object:Gem::Requirement
+  requirement: &2156138640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +43,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153455960
+  version_requirements: *2156138640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153455380 !ruby/object:Gem::Requirement
+  requirement: &2156137960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +54,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2153455380
+  version_requirements: *2156137960
 - !ruby/object:Gem::Dependency
   name: machinist
-  requirement: &2153454840 !ruby/object:Gem::Requirement
+  requirement: &2156137140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +65,10 @@ dependencies:
         version: 1.0.6
   type: :development
   prerelease: false
-  version_requirements: *2153454840
+  version_requirements: *2156137140
 - !ruby/object:Gem::Dependency
   name: faker
-  requirement: &2153454360 !ruby/object:Gem::Requirement
+  requirement: &2156136500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +76,10 @@ dependencies:
         version: 0.9.5
   type: :development
   prerelease: false
-  version_requirements: *2153454360
+  version_requirements: *2156136500
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2153453880 !ruby/object:Gem::Requirement
+  requirement: &2156135640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,7 +87,7 @@ dependencies:
         version: 1.3.3
   type: :development
   prerelease: false
-  version_requirements: *2153453880
+  version_requirements: *2156135640
 description: Ransack is the successor to the MetaSearch gem. It improves and expands
   upon MetaSearch's functionality, but does not have a 100%-compatible API.
 email:
@@ -154,7 +153,6 @@ files:
 - spec/spec_helper.rb
 - spec/support/en.yml
 - spec/support/schema.rb
-has_rdoc: true
 homepage: http://metautonomo.us/projects/ransack
 licenses: []
 post_install_message: 
@@ -175,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ransack
-rubygems_version: 1.6.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Object-based searching for ActiveRecord (currently).