ransack 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa2e8ee70ef82d95b0bc2c83e0005505252e2b13
-  data.tar.gz: ae83094fdd4be127ba5471b48442a6c1f2922680
+  metadata.gz: 1b7aa5bc2bb1d2e9d78aea7431f3f3124b09ffdb
+  data.tar.gz: f16d483b98b63bd8d427678a185cb8ce7e6e56a3
 SHA512:
-  metadata.gz: f2d9b0b0be3432472e801b0fdbfc19075a71461bba475c64f0cafa7cc32f9b8606b9136488fd7e1f1ef0dc34b7f2877815d32fc30a626ad74c3c75d21422e1b8
-  data.tar.gz: dbb0b40594df15a6e7321d97e9ba134402168facc2de41b9a07cdf58683bb172f61aa01a6f5a61c5f73d6ff7053c597e2ce13b3b942cba2aea1b79f67de614cd
+  metadata.gz: 03ca0f504276420d2bc2f3ed1b2e2685091043f01fac0bcf538802d8ddae0ba6ee8c4fc36224d12aaf955beb3f709581dd7a207ef9b98a4eb10af136c0c38f2f
+  data.tar.gz: f77643a092da8bc3119b4f85d8cdc90977df7b78fc8738b3c0a490d18a21c492bed5e84df349bf4d3214016783c32ae07a82f14ea48435d94abbc63774af72b8

data/.travis.yml

@@ -1,9 +1,16 @@
+language: ruby
+
+before_install:
+  - travis_retry gem install bundler
+
 rvm:
-  - 1.9.3
   - 2.0.0
 
 env:
--   RAILS=4-0-stable DB=sqlite
+  - RAILS=4-1-stable DB=sqlite3
+  - RAILS=4-1-stable DB=mysql
+  - RAILS=4-1-stable DB=postgres
+  - RAILS=4-0-stable DB=sqlite3
   - RAILS=4-0-stable DB=mysql
   - RAILS=4-0-stable DB=postgres
   - RAILS=3-2-stable DB=sqlite
@@ -17,5 +24,6 @@ env:
   - RAILS=3-0-stable DB=postgres
 
 before_script:
-  - mysql -e 'create database ransack;'
-  - psql -c 'create database ransack;' -U postgres
+  - mysql -e 'create database ransack collate utf8_general_ci;'
+  - mysql -e 'use ransack;show variables like "%character%";show variables like "%collation%";'
+  - psql -c 'create database ransack;' -U postgres

data/CONTRIBUTING.md

@@ -8,13 +8,17 @@ When filing an issue on the Ransack project, please provide these details:
 * The version of Ransack *and* the version of Rails.
 * Any relevant stack traces ("Full trace" preferred)
 
-In 99% of cases, this information is enough to determine the cause and solution to the problem that is being described.
+In 99% of cases, this information is enough to determine the cause and
+solution to the problem that is being described.
 
-Any issue that is open for 14 days without actionable information or activity will be marked as "stalled" and then closed. Stalled issues can be re-opened if the information requested is provided.
+Any issue that is open for 14 days without actionable information or activity
+will be marked as "stalled" and then closed. Stalled issues can be re-opened
+if the information requested is provided.
 
 ## Pull requests
 
-We gladly accept pull requests to fix bugs and, in some circumstances, add new features to Ransack.
+We gladly accept pull requests to fix bugs and, in some circumstances, add new
+features to Ransack.
 
 Here's a quick guide:
 
@@ -32,7 +36,9 @@ a test!
 
 4. Make the test pass.
 
-5. Push to your fork and submit a pull request. If the changes will apply cleanly to the latest stable branches and master branch, you will only need to submit one pull request.
+5. Push to your fork and submit a pull request. If the changes will apply
+cleanly to the latest stable branches and master branch, you will only need
+to submit one pull request.
 
 At this point you're waiting on us. We like to at least comment on, if not
 accept, pull requests within three business days (and, typically, one business

data/Gemfile

@@ -1,30 +1,33 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
 
-rails = ENV['RAILS'] || '4-0-stable'
+rails = ENV['RAILS'] || 'master'
 
-gem 'arel'
+gem 'polyamorous', github: 'activerecord-hackery/polyamorous'
 
 case rails
 when /\// # A path
-  gem 'activesupport', :path => "#{rails}/activesupport"
-  gem 'activemodel', :path => "#{rails}/activemodel"
-  gem 'activerecord', :path => "#{rails}/activerecord"
-  gem 'actionpack', :path => "#{rails}/activerecord"
+  gem 'activesupport', path: "#{rails}/activesupport"
+  gem 'activemodel', path: "#{rails}/activemodel"
+  gem 'activerecord', path: "#{rails}/activerecord"
+  gem 'actionpack', path: "#{rails}/activerecord"
 when /^v/ # A tagged version
-  git 'git://github.com/rails/rails.git', :tag => rails do
+  git 'git://github.com/rails/rails.git', tag: rails do
     gem 'activesupport'
     gem 'activemodel'
     gem 'activerecord'
     gem 'actionpack'
   end
 else
-  git 'git://github.com/rails/rails.git', :branch => rails do
+  git 'git://github.com/rails/rails.git', branch: rails do
     gem 'activesupport'
     gem 'activemodel'
     gem 'activerecord'
     gem 'actionpack'
   end
+  if rails == '3-0-stable'
+    gem 'mysql2', '< 0.3'
+  end
 end

data/README.md

@@ -1,29 +1,42 @@
 # Ransack
 
-[![Build Status](https://travis-ci.org/ernie/ransack.png?branch=master)](https://travis-ci.org/ernie/ransack)
+[![Build Status](https://travis-ci.org/activerecord-hackery/ransack.svg)](https://travis-ci.org/activerecord-hackery/ransack)
 
-Ransack is a rewrite of [MetaSearch](https://github.com/ernie/meta_search). While it
+Ransack is a rewrite of [MetaSearch](https://github.com/activerecord-hackery/meta_search) created by [Ernie Miller](http://twitter.com/erniemiller) and maintained by [Ryan Bigg](http://twitter.com/ryanbigg), [Jon Atack](http://twitter.com/jonatack) and a great group of [contributors](https://github.com/activerecord-hackery/ransack/graphs/contributors). While it
 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](http://ransack-demo.herokuapp.com/users/advanced_search)
-search forms against your application's models. If you're looking for something that
+search forms against your application's models (demo source code [here](https://github.com/activerecord-hackery/ransack_demo)). 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](https://github.com/ernie/squeel) instead.
+[Squeel](https://github.com/activerecord-hackery/squeel) instead.
 
 ## Getting started
 
 In your Gemfile:
 
 ```ruby
-gem "ransack"  # Last officially released gem (Rails 3 and 4)
+gem "ransack"  # Last officially released gem (compatible Rails 3.x and 4.0, but not 4.1)
 ```
 
-Or if you want to use the bleeding edge:
+Or if you want to use the latest updates (Rails 3.x and 4.0, but not 4.1):
 
 ```ruby
-gem "ransack", github: "ernie/ransack"  # Track git repo
+gem "ransack", github: "activerecord-hackery/ransack"  # Track git repo 
+```
+
+If you are on Rails 4.0, you may prefer to use the streamlined, legacy code-free, latest-updates version of Ransack on the [Rails 4 branch](https://github.com/activerecord-hackery/ransack/tree/rails-4):
+
+```ruby
+gem "ransack", github: "activerecord-hackery/ransack", branch: "rails-4"
+```
+
+Finally, if you are on Rails 4.1 (or 4.2.0.alpha), use the [Rails 4.1 branch](https://github.com/activerecord-hackery/ransack/tree/rails-4.1) which contains the latest updates also on master and rails-4. In your Gemfile you'll need to include (for the moment) both Ransack and Polyamorous as follows:
+
+```ruby
+gem "ransack", github: "activerecord-hackery/ransack", branch: "rails-4.1"
+gem "polyamorous", github: "activerecord-hackery/polyamorous"
 ```
 
 ## Usage
@@ -41,9 +54,11 @@ If you're coming from MetaSearch, things to note:
      primarily to shorten query strings, though advanced queries (below) will still
      run afoul of URL length limits in most browsers and require a switch to HTTP
      POST requests. This key is
-[configurable](https://github.com/ernie/ransack/wiki/Configuration)
+[configurable](https://github.com/activerecord-hackery/ransack/wiki/Configuration).
+
   2. `form_for` is now `search_form_for`, and validates that a Ransack::Search object
      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`. If passed `distinct: true`,
@@ -78,7 +93,7 @@ In your view:
 ```
 
 `cont` (contains) and `start` (starts with) are just two of the available search predicates.
-See [Constants](https://github.com/ernie/ransack/blob/master/lib/ransack/constants.rb) for a full list and the [wiki](https://github.com/ernie/ransack/wiki/Basic-Searching) for more description.
+See [Constants](https://github.com/activerecord-hackery/ransack/blob/master/lib/ransack/constants.rb) for a full list and the [wiki](https://github.com/activerecord-hackery/ransack/wiki/Basic-Searching) for more description.
 
 ### Advanced Mode
 
@@ -116,7 +131,16 @@ end
 
 Once you've done so, you can make use of the helpers in Ransack::Helpers::FormBuilder to
 construct much more complex search forms, such as the one on the
-[demo page](http://ransack-demo.heroku.com).
+[demo page](http://ransack-demo.heroku.com) (source code [here](https://github.com/activerecord-hackery/ransack_demo)).
+
+### Ransack #search method
+
+Ransack will try to to make `#search` available in your models, but in the case that `#search` has already been defined, you can use `#ransack` instead. For example the following would be equivalent:
+
+```
+Article.search(params[:q])
+Article.ransack(params[:q])
+```
 
 ### has_many and belongs_to associations
 
@@ -173,6 +197,17 @@ end
 <% end %>
 ```
 
+## Using SimpleForm
+
+If you want to combine form builders of ransack and SimpleForm, just set the RANSACK_FORM_BUILDER environment variable before Rails started, e.g. in ``config/application.rb`` before ``require 'rails/all'`` and of course use ``gem 'simple_form'`` in your ``Gemfile``:
+```ruby
+require File.expand_path('../boot', __FILE__)
+
+ENV['RANSACK_FORM_BUILDER'] = '::SimpleForm::FormBuilder'
+
+require 'rails/all'
+```
+
 ## I18n
 
 Take a look at our locale file on ``lib/ransack/locale/en.yml`` to check all available messages. You may also be interested in one of the many translations that are available on:
@@ -190,4 +225,4 @@ To support the project:
 
 ## Copyright
 
-Copyright &copy; 2011 [Ernie Miller](http://twitter.com/erniemiller)
+Copyright &copy; 2011-2014 [Ernie Miller](http://twitter.com/erniemiller)

data/lib/ransack.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext'
+
 require 'ransack/configuration'
 
 module Ransack
@@ -8,7 +10,7 @@ end
 
 Ransack.configure do |config|
   Ransack::Constants::AREL_PREDICATES.each do |name|
-    config.add_predicate name, :arel_predicate => name
+    config.add_predicate name, arel_predicate: name
   end
 
   Ransack::Constants::DERIVED_PREDICATES.each do |args|
@@ -23,4 +25,4 @@ require 'ransack/adapters/active_record' if defined?(::ActiveRecord::Base)
 require 'ransack/helpers'
 require 'action_controller'
 
-ActionController::Base.helper Ransack::Helpers::FormHelper
+ActionController::Base.helper Ransack::Helpers::FormHelper

data/lib/ransack/adapters/active_record.rb

@@ -10,4 +10,4 @@ when /^3\.2\./
   require 'ransack/adapters/active_record/3.2/context'
 else
   require 'ransack/adapters/active_record/context'
-end
+end

data/lib/ransack/adapters/active_record/3.0/compat.rb

@@ -2,7 +2,7 @@
 if Arel::Nodes::And < Arel::Nodes::Binary
   class Ransack::Visitor
     def visit_Ransack_Nodes_And(object)
-      nodes = object.values.map {|o| accept(o)}.compact
+      nodes = object.values.map { |o| accept(o) }.compact
       return nil unless nodes.size > 0
 
       if nodes.size > 1
@@ -132,9 +132,15 @@ module Arel
       end
 
       def visit_Arel_Nodes_NamedFunction o
-        "#{o.name}(#{o.distinct ? 'DISTINCT ' : ''}#{o.expressions.map { |x|
-          visit x
-        }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
+        "#{
+          o.name
+          }(#{
+          o.distinct ? 'DISTINCT ' : ''
+          }#{
+          o.expressions.map { |x| visit x }.join(', ')
+          })#{
+          o.alias ? " AS #{visit o.alias}" : ''
+          }"
       end
 
       def visit_Arel_Nodes_And o
@@ -146,13 +152,17 @@ module Arel
       end
 
       def visit_Arel_Nodes_Values o
-        "VALUES (#{o.expressions.zip(o.columns).map { |value, attr|
+        "VALUES (#{
+        o.expressions.zip(o.columns)
+        .map { |value, attr|
           if Nodes::SqlLiteral === value
             visit_Arel_Nodes_SqlLiteral value
           else
             quote(value, attr && column_for(attr))
           end
-        }.join ', '})"
+        }
+        .join ', '
+        })"
       end
     end
   end

data/lib/ransack/adapters/active_record/3.0/context.rb

@@ -26,9 +26,11 @@ module Ransack
           viz = Visitor.new
           relation = @object.where(viz.accept(search.base))
           if search.sorts.any?
-            relation = relation.except(:order).reorder(viz.accept(search.sorts))
+            relation = relation.except(:order)
+            .reorder(viz.accept(search.sorts))
           end
-          opts[:distinct] ? relation.select("DISTINCT #{@klass.quoted_table_name}.*") : relation
+          opts[:distinct] ?
+          relation.select("DISTINCT #{@klass.quoted_table_name}.*") : relation
         end
 
         def attribute_method?(str, klass = @klass)
@@ -39,10 +41,15 @@ module Ransack
           elsif (segments = str.split(/_/)).size > 1
             remainder = []
             found_assoc = nil
-            while !found_assoc && remainder.unshift(segments.pop) && segments.size > 0 do
-              assoc, poly_class = unpolymorphize_association(segments.join('_'))
+            while !found_assoc && remainder.unshift(segments.pop) &&
+              segments.size > 0 do
+              assoc, poly_class = unpolymorphize_association(
+                segments.join('_')
+                )
               if found_assoc = get_association(assoc, klass)
-                exists = attribute_method?(remainder.join('_'), poly_class || found_assoc.klass)
+                exists = attribute_method?(
+                  remainder.join('_'), poly_class || found_assoc.klass
+                  )
               end
             end
           end
@@ -56,7 +63,9 @@ module Ransack
 
         def type_for(attr)
           return nil unless attr && attr.valid?
-          klassify(attr.parent).columns_hash[attr.arel_attribute.name.to_s].type
+          klassify(attr.parent)
+          .columns_hash[attr.arel_attribute.name.to_s]
+          .type
         end
 
         private
@@ -69,22 +78,26 @@ module Ransack
           elsif (segments = str.split(/_/)).size > 1
             remainder = []
             found_assoc = nil
-            while remainder.unshift(segments.pop) && segments.size > 0 && !found_assoc do
+            while remainder.unshift(segments.pop) && segments.size > 0 &&
+              !found_assoc do
               assoc, klass = unpolymorphize_association(segments.join('_'))
               if found_assoc = get_association(assoc, parent)
-                join = build_or_find_association(found_assoc.name, parent, klass)
-                parent, attr_name = get_parent_and_attribute_name(remainder.join('_'), join)
+                join = build_or_find_association(
+                  found_assoc.name, parent, klass
+                  )
+                parent, attr_name = get_parent_and_attribute_name(
+                  remainder.join('_'), join
+                  )
               end
             end
           end
-
           [parent, attr_name]
         end
 
         def get_association(str, parent = @base)
           klass = klassify parent
           ransackable_association?(str, klass) &&
-          klass.reflect_on_all_associations.detect {|a| a.name.to_s == str}
+          klass.reflect_on_all_associations.detect { |a| a.name.to_s == str }
         end
 
         def join_dependency(relation)
@@ -114,9 +127,9 @@ module Ransack
           association_joins         = buckets['association_join'] || []
           stashed_association_joins = buckets['stashed_join'] || []
           join_nodes                = buckets['join_node'] || []
-          string_joins              = (buckets['string_join'] || []).map { |x|
-            x.strip
-          }.uniq
+          string_joins              = (buckets['string_join'] || [])
+                                      .map { |x| x.strip }
+                                      .uniq
 
           join_list = relation.send :custom_join_sql, (string_joins + join_nodes)
 
@@ -134,13 +147,16 @@ module Ransack
         end
 
         def build_or_find_association(name, parent = @base, klass = nil)
-          found_association = @join_dependency.join_associations.detect do |assoc|
+          found_association = @join_dependency.join_associations
+          .detect do |assoc|
             assoc.reflection.name == name &&
             assoc.parent == parent &&
             (!klass || assoc.reflection.klass == klass)
           end
           unless found_association
-            @join_dependency.send(:build, Polyamorous::Join.new(name, @join_type, klass), parent)
+            @join_dependency.send(
+              :build, Polyamorous::Join.new(name, @join_type, klass), parent
+              )
             found_association = @join_dependency.join_associations.last
             # Leverage the stashed association functionality in AR
             @object = @object.joins(found_association)

data/lib/ransack/adapters/active_record/3.1/context.rb

@@ -25,9 +25,12 @@ module Ransack
           viz = Visitor.new
           relation = @object.where(viz.accept(search.base))
           if search.sorts.any?
-            relation = relation.except(:order).reorder(viz.accept(search.sorts))
+            relation = relation.except(:order)
+              .reorder(viz.accept(search.sorts))
           end
-          opts[:distinct] ? relation.select("DISTINCT #{@klass.quoted_table_name}.*") : relation
+          opts[:distinct] ?
+            relation.select("DISTINCT #{@klass.quoted_table_name}.*") :
+            relation
         end
 
         def attribute_method?(str, klass = @klass)
@@ -38,10 +41,15 @@ module Ransack
           elsif (segments = str.split(/_/)).size > 1
             remainder = []
             found_assoc = nil
-            while !found_assoc && remainder.unshift(segments.pop) && segments.size > 0 do
-              assoc, poly_class = unpolymorphize_association(segments.join('_'))
+            while !found_assoc && remainder.unshift(segments.pop) &&
+            segments.size > 0 do
+              assoc, poly_class = unpolymorphize_association(
+                segments.join('_')
+                )
               if found_assoc = get_association(assoc, klass)
-                exists = attribute_method?(remainder.join('_'), poly_class || found_assoc.klass)
+                exists = attribute_method?(
+                  remainder.join('_'), poly_class || found_assoc.klass
+                  )
               end
             end
           end
@@ -75,11 +83,16 @@ module Ransack
           elsif (segments = str.split(/_/)).size > 1
             remainder = []
             found_assoc = nil
-            while remainder.unshift(segments.pop) && segments.size > 0 && !found_assoc do
+            while remainder.unshift(segments.pop) && segments.size > 0 &&
+              !found_assoc do
               assoc, klass = unpolymorphize_association(segments.join('_'))
               if found_assoc = get_association(assoc, parent)
-                join = build_or_find_association(found_assoc.name, parent, klass)
-                parent, attr_name = get_parent_and_attribute_name(remainder.join('_'), join)
+                join = build_or_find_association(
+                  found_assoc.name, parent, klass
+                  )
+                parent, attr_name = get_parent_and_attribute_name(
+                  remainder.join('_'), join
+                  )
               end
             end
           end
@@ -90,7 +103,7 @@ module Ransack
         def get_association(str, parent = @base)
           klass = klassify parent
           ransackable_association?(str, klass) &&
-          klass.reflect_on_all_associations.detect {|a| a.name.to_s == str}
+          klass.reflect_on_all_associations.detect { |a| a.name.to_s == str }
         end
 
         def join_dependency(relation)
@@ -120,11 +133,12 @@ module Ransack
           association_joins         = buckets['association_join'] || []
           stashed_association_joins = buckets['stashed_join'] || []
           join_nodes                = buckets['join_node'] || []
-          string_joins              = (buckets['string_join'] || []).map { |x|
-            x.strip
-          }.uniq
+          string_joins              = (buckets['string_join'] || [])
+                                      .map { |x| x.strip }
+                                      .uniq
 
-          join_list = relation.send :custom_join_ast, relation.table.from(relation.table), string_joins
+          join_list = relation.send :custom_join_ast,
+            relation.table.from(relation.table), string_joins
 
           join_dependency = JoinDependency.new(
             relation.klass,
@@ -140,13 +154,16 @@ module Ransack
         end
 
         def build_or_find_association(name, parent = @base, klass = nil)
-          found_association = @join_dependency.join_associations.detect do |assoc|
+          found_association = @join_dependency.join_associations
+          .detect do |assoc|
             assoc.reflection.name == name &&
             assoc.parent == parent &&
             (!klass || assoc.reflection.klass == klass)
           end
           unless found_association
-            @join_dependency.send(:build, Polyamorous::Join.new(name, @join_type, klass), parent)
+            @join_dependency.send(
+              :build, Polyamorous::Join.new(name, @join_type, klass), parent
+              )
             found_association = @join_dependency.join_associations.last
             # Leverage the stashed association functionality in AR
             @object = @object.joins(found_association)