ransack 0.6.0 → 0.7.0

data/.travis.yml

@@ -2,8 +2,7 @@ rvm:
   - 1.8.7
   - 1.9.2
   - ree
-  - rbx
-  - rbx-2.0
+  - rbx-18mode
   - ruby-head
 
 env:

data/Gemfile

@@ -3,19 +3,9 @@ gemspec
 
 gem 'rake'
 
-rails = ENV['RAILS'] || 'master'
-arel = ENV['AREL'] || 'master'
+rails = ENV['RAILS'] || '3-2-stable'
 
-arel_opts = case arel
-when /\// # A path
-  {:path => arel}
-when /^v/ # A tagged version
-  {:git => 'git://github.com/rails/arel.git', :tag => arel}
-else
-  {:git => 'git://github.com/rails/arel.git', :branch => arel}
-end
-
-gem 'arel', arel_opts
+gem 'arel', '3.0.2'
 
 case rails
 when /\// # A path

data/README.md

@@ -4,10 +4,10 @@ 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](http://ransack-demo.heroku.com)
+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
 simplifies query generation at the model or controller layer, you're probably not looking
-for Ransack (or MetaSearch, for that matter). Try 
+for Ransack (or MetaSearch, for that matter). Try
 [Squeel](http://metautonomo.us/projects/squeel) instead.
 
 ## Getting started
@@ -15,27 +15,11 @@ for Ransack (or MetaSearch, for that matter). Try
 In your Gemfile:
 
     gem "ransack"  # Last officially released gem
-    # gem "ransack", :git => "git://github.com/ernie/ransack.git" # Track git repo
-
-If you'd like to add your own custom Ransack predicates:
-
-    Ransack.configure do |config|
-      config.add_predicate 'equals_diddly', # Name your predicate
-                           # What non-compound ARel predicate will it use? (eq, matches, etc)
-                           :arel_predicate => 'eq',
-                           # Format incoming values as you see fit. (Default: Don't do formatting)
-                           :formatter => proc {|v| "#{v}-diddly"},
-                           # Validate a value. An "invalid" value won't be used in a search.
-                           # Below is default.
-                           :validator => proc {|v| v.present?},
-                           # Should compounds be created? Will use the compound (any/all) version
-                           # of the arel_predicate to create a corresponding any/all version of
-                           # your predicate. (Default: true)
-                           :compounds => true,
-                           # Force a specific column type for type-casting of supplied values.
-                           # (Default: use type from DB column)
-                           :type => :string
-    end
+
+Or if you want to use the bleeding edge:
+
+    gem "ransack", :git => "git://github.com/ernie/ransack.git" # Track git repo
+
 
 ## Usage
 
@@ -49,9 +33,10 @@ requires very little setup effort.
 If you're coming from MetaSearch, things to note:
 
   1. The default param key for search params is now `:q`, instead of `:search`. This is
-     primarily to shorten query strings, though advanced queries (below) will still 
+     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.
+     POST requests. This key is
+[configurable](https://github.com/ernie/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.
@@ -59,7 +44,7 @@ If you're coming from MetaSearch, things to note:
      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,
@@ -85,7 +70,7 @@ In your view:
 
 `cont` (contains) and `start` (starts with) are just two of the available search predicates.
 See Constants for a full list.
-    
+
 ### Advanced Mode
 
 "Advanced" searches (ab)use Rails' nested attributes functionality in order to generate
@@ -108,30 +93,25 @@ This means you'll need to tweak your routes...
       index
       render :index
     end
-    
+
 ... and update your `search_form_for` line in the view ...
 
-    <%= search_form_for @q, :url => search_people_path, 
+    <%= search_form_for @q, :url => search_people_path,
                             :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, such as the one on the
 [demo page](http://ransack-demo.heroku.com).
 
-**more docs to come**
-
 ## Contributions
 
-If you'd like to support the continued development of Ransack, please consider
-[making a donation](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=48Q9HY64L3TWA).
-
-To support the project in other ways:
+To support the project:
 
-* Use Ransack in your apps, and let me know if you encounter anything that's broken or missing.
+* Use Ransack in your apps, and let us know if you encounter anything that's broken or missing.
   A failing spec is awesome. A pull request is even better!
 * Spread the word on Twitter, Facebook, and elsewhere if Ransack's been useful to you. The more
   people who are using the project, the quicker we can find and fix bugs!
 
 ## Copyright
 
-Copyright &copy; 2011 [Ernie Miller](http://twitter.com/erniemiller)
+Copyright &copy; 2011 [Ernie Miller](http://twitter.com/erniemiller)

data/lib/ransack/adapters/active_record.rb

@@ -1,3 +1,4 @@
+require 'active_record'
 require 'ransack/adapters/active_record/base'
 ActiveRecord::Base.extend Ransack::Adapters::ActiveRecord::Base
 

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

@@ -18,7 +18,10 @@ module Ransack
 
         def evaluate(search, opts = {})
           viz = Visitor.new
-          relation = @object.except(:order).where(viz.accept(search.base)).order(viz.accept(search.sorts))
+          relation = @object.where(viz.accept(search.base))
+          if search.sorts.any?
+            relation = relation.except(:order).order(viz.accept(search.sorts))
+          end
           opts[:distinct] ? relation.select("DISTINCT #{@klass.quoted_table_name}.*") : relation
         end
 

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

@@ -16,7 +16,10 @@ module Ransack
 
         def evaluate(search, opts = {})
           viz = Visitor.new
-          relation = @object.except(:order).where(viz.accept(search.base)).order(viz.accept(search.sorts))
+          relation = @object.where(viz.accept(search.base))
+          if search.sorts.any?
+            relation = relation.except(:order).order(viz.accept(search.sorts))
+          end
           opts[:distinct] ? relation.select("DISTINCT #{@klass.quoted_table_name}.*") : relation
         end
 
@@ -135,7 +138,7 @@ module Ransack
           )
 
           join_nodes.each do |join|
-            join_dependency.table_aliases[join.left.name.downcase] = 1
+            join_dependency.alias_tracker.aliases[join.left.name.downcase] = 1
           end
 
           join_dependency.graft(*stashed_association_joins)

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

@@ -26,6 +26,15 @@ module Ransack
           @engine.connection.schema_cache.columns_hash[table][name].type
         end
         
+        def evaluate(search, opts = {})
+          viz = Visitor.new
+          relation = @object.where(viz.accept(search.base))
+          if search.sorts.any?
+            relation = relation.except(:order).order(viz.accept(search.sorts))
+          end
+          opts[:distinct] ? relation.uniq : relation
+        end
+        
       end
     end
   end

data/lib/ransack/configuration.rb

@@ -4,8 +4,11 @@ require 'ransack/predicate'
 module Ransack
   module Configuration
 
-    mattr_accessor :predicates
+    mattr_accessor :predicates, :options
     self.predicates = {}
+    self.options = {
+        :search_key => :q
+    }
 
     def configure
       yield self
@@ -16,6 +19,7 @@ module Ransack
       opts[:name] = name
       compounds = opts.delete(:compounds)
       compounds = true if compounds.nil?
+      compounds = false if opts[:wants_array]
       opts[:arel_predicate] = opts[:arel_predicate].to_s
 
       self.predicates[name] = Predicate.new(opts)
@@ -31,5 +35,10 @@ module Ransack
       end if compounds
     end
 
+    # default search_key that, it can be overridden on sort_link level
+    def search_key=(name)
+      self.options[:search_key] = name
+    end
+
   end
-end
+end

data/lib/ransack/context.rb

@@ -3,7 +3,7 @@ require 'ransack/visitor'
 module Ransack
   class Context
     attr_reader :search, :object, :klass, :base, :engine, :arel_visitor
-    attr_accessor :auth_object
+    attr_accessor :auth_object, :search_key
 
     class << self
 
@@ -32,6 +32,7 @@ module Ransack
       @klass = @object.klass
       @join_dependency = join_dependency(@object)
       @join_type = options[:join_type] || Arel::OuterJoin
+      @search_key = options[:search_key] || Ransack.options[:search_key]
       @base = @join_dependency.join_base
       @engine = @base.arel_engine
       @default_table = Arel::Table.new(@base.table_name, :as => @base.aliased_table_name, :engine => @engine)

data/lib/ransack/helpers/form_helper.rb

@@ -25,9 +25,15 @@ module Ransack
       end
 
       def sort_link(search, attribute, *args)
+        # Extract out a routing proxy for url_for scoping later
+        if search.is_a?(Array)
+          routing_proxy = search.shift
+          search = search.first
+        end
+
         raise TypeError, "First argument must be a Ransack::Search!" unless Search === search
 
-        search_params = params[:q] || {}.with_indifferent_access
+        search_params = params[search.context.search_key] || {}.with_indifferent_access
 
         attr_name = attribute.to_s
 
@@ -50,12 +56,19 @@ module Ransack
         html_options = args.first.is_a?(Hash) ? args.shift.dup : {}
         css = ['sort_link', current_dir].compact.join(' ')
         html_options[:class] = [css, html_options[:class]].compact.join(' ')
-        options.merge!(
-          :q => search_params.merge(:s => "#{attr_name} #{new_dir}")
-        )
+        query_hash = {}
+        query_hash[search.context.search_key] = search_params.merge(:s => "#{attr_name} #{new_dir}")
+        options.merge!(query_hash)
+
+        url = if routing_proxy && respond_to?(routing_proxy)
+          send(routing_proxy).url_for(options)
+        else
+          url_for(options)
+        end
+
         link_to [ERB::Util.h(name), order_indicator_for(current_dir)].compact.join(' ').html_safe,
-                url_for(options),
-                html_options
+          url,
+          html_options
       end
 
       private
@@ -72,4 +85,4 @@ module Ransack
 
     end
   end
-end
+end

data/lib/ransack/locale/en.yml

@@ -62,9 +62,9 @@ en:
       not_end: "doesn't end with"
       not_end_any: "doesn't end with any"
       not_end_all: "doesn't end with all"
-      true: "is true"
-      false: "is false"
+      'true': "is true"
+      'false': "is false"
       present: "is present"
       blank: "is blank"
-      null: "is null"
-      not_null: "is not null"
+      'null': "is null"
+      not_null: "is not null"

data/lib/ransack/predicate.rb

@@ -41,7 +41,7 @@ module Ransack
       @formatter = opts[:formatter]
       @validator = opts[:validator] || lambda { |v| v.respond_to?(:empty?) ? !v.empty? : !v.nil? }
       @compound = opts[:compound]
-      @wants_array = @compound || ['in', 'not_in'].include?(@arel_predicate)
+      @wants_array = opts[:wants_array] == true || @compound || ['in', 'not_in'].include?(@arel_predicate)
     end
 
     def eql?(other)

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/ransack.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |s|
   s.name        = "ransack"
   s.version     = Ransack::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Ernie Miller"]
-  s.email       = ["ernie@metautonomo.us"]
-  s.homepage    = "http://metautonomo.us/projects/ransack"
+  s.authors     = ["Ernie Miller", "Ryan Bigg"]
+  s.email       = ["ernie@erniemiller.org", "radarlistener@gmail.com"]
+  s.homepage    = "https://github.com/ernie/ransack"
   s.summary     = %q{Object-based searching for ActiveRecord (currently).}
   s.description = %q{Ransack is the successor to the MetaSearch gem. It improves and expands upon MetaSearch's functionality, but does not have a 100%-compatible API.}
 
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activerecord', '~> 3.0'
   s.add_dependency 'actionpack', '~> 3.0'
   s.add_dependency 'polyamorous', '~> 0.5.0'
-  s.add_development_dependency 'rspec', '~> 2.6.0'
+  s.add_development_dependency 'rspec', '~> 2.8.0'
   s.add_development_dependency 'machinist', '~> 1.0.6'
   s.add_development_dependency 'faker', '~> 0.9.5'
   s.add_development_dependency 'sqlite3', '~> 1.3.3'

data/spec/ransack/configuration_spec.rb

@@ -27,5 +27,33 @@ module Ransack
       Ransack.predicates.should_not have_key 'test_predicate_without_compound_any'
       Ransack.predicates.should_not have_key 'test_predicate_without_compound_all'
     end
+
+    it 'should have default value for search key' do
+      Ransack.options[:search_key].should eq :q
+    end
+
+    it 'changes default search key parameter' do
+      # store original state so we can restore it later
+      before = Ransack.options.clone
+
+      Ransack.configure do |config|
+        config.search_key = :query
+      end
+
+      Ransack.options[:search_key].should eq :query
+
+      # restore original state so we don't break other tests
+      Ransack.options = before
+    end
+
+    it 'adds predicates that take arrays, overriding compounds' do
+      Ransack.configure do |config|
+        config.add_predicate :test_array_predicate, :wants_array => true, :compounds => true
+      end
+
+      Ransack.predicates['test_array_predicate'].wants_array.should eq true
+      Ransack.predicates.should_not have_key 'test_array_predicate_any'
+      Ransack.predicates.should_not have_key 'test_array_predicate_all'
+    end
   end
 end

data/spec/ransack/helpers/form_helper_spec.rb

@@ -25,14 +25,26 @@ module Ransack
         end
       end
 
-      describe '#sort_link' do
-        subject { @controller.view_context.sort_link(Person.search(:sorts => ['name desc']), :name, :controller => 'people') }
+      describe '#sort_link with default search_key' do
+        subject { @controller.view_context.sort_link([:main_app, Person.search(:sorts => ['name desc'])], :name, :controller => 'people') }
+        it { should match /people\?q%5Bs%5D=name\+asc/ }
+        it { should match /sort_link desc/ }
+        it { should match /Full Name ▼/ }
+      end
+
+      describe '#sort_link with default search_key defined as symbol' do
+        subject { @controller.view_context.sort_link(Person.search({:sorts => ['name desc']}, :search_key => :people_search),
+                                                     :name, :controller => 'people') }
 
-        it { should match /people\?q%5Bs%5D=name\+asc/}
-        it { should match /sort_link desc/}
-        it { should match /Full Name ▼/}
+        it { should match /people\?people_search%5Bs%5D=name\+asc/ }
       end
 
+      describe '#sort_link with default search_key defined as string' do
+        subject { @controller.view_context.sort_link(Person.search({:sorts => ['name desc']}, :search_key => 'people_search'),
+                                                       :name, :controller => 'people') }
+
+        it { should match /people\?people_search%5Bs%5D=name\+asc/ }
+      end
     end
   end
-end
+end

data/spec/ransack/search_spec.rb

@@ -90,6 +90,20 @@ module Ransack
         conditions.should have(2).items
         conditions.map {|c| c.class}.should eq [Nodes::Condition, Nodes::Condition]
       end
+
+      it 'creates Conditions for custom predicates that take arrays' do
+        Ransack.configure do |config|
+          config.add_predicate 'ary_pred',
+          :wants_array => true
+        end
+
+        search = Search.new(Person, :name_ary_pred => ['Ernie', 'Bert'])
+        condition = search.base[:name_ary_pred]
+        condition.should be_a Nodes::Condition
+        condition.predicate.name.should eq 'ary_pred'
+        condition.attributes.first.name.should eq 'name'
+        condition.value.should eq ['Ernie', 'Bert']
+      end
     end
 
     describe '#result' do
@@ -124,7 +138,9 @@ module Ransack
         )
         search.result.should be_an ActiveRecord::Relation
         where = search.result.where_values.first
-        where.to_sql.should match /"children_people"."name" = 'Ernie' AND \("people"."name" = 'Ernie' OR "children_people_2"."name" = 'Ernie'\)/
+        where.to_sql.should match /"children_people"."name" = 'Ernie'/
+        where.to_sql.should match /"people"."name" = 'Ernie'/
+        where.to_sql.should match /"children_people_2"."name" = 'Ernie'/
       end
 
       it 'evaluates arrays of groupings' do
@@ -146,7 +162,7 @@ module Ransack
 
       it 'returns distinct records when passed :distinct => true' do
         search = Search.new(Person, :g => [{:m => 'or', :comments_body_cont => 'e', :articles_comments_body_cont => 'e'}])
-        search.result.should have(920).items
+        search.result.all.should have(920).items
         search.result(:distinct => true).should have(330).items
         search.result.all.uniq.should eq search.result(:distinct => true).all
       end
@@ -220,4 +236,4 @@ module Ransack
     end
 
   end
-end
+end

data/spec/spec_helper.rb

@@ -44,4 +44,4 @@ RSpec::Matchers.define :have_attribute_method do |expected|
   match do |actual|
     actual.attribute_method?(expected)
   end
-end
+end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: ransack
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
 - Ernie Miller
+- Ryan Bigg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-20 00:00:00.000000000 Z
+date: 2012-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70226024755600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +22,15 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70226024755600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70226024754660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +38,15 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70226024754660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: polyamorous
-  requirement: &70226024753760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,21 +54,31 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70226024753760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70226024753240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70226024753240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: machinist
-  requirement: &70226024752660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +86,15 @@ dependencies:
         version: 1.0.6
   type: :development
   prerelease: false
-  version_requirements: *70226024752660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.6
 - !ruby/object:Gem::Dependency
   name: faker
-  requirement: &70226024768120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +102,15 @@ dependencies:
         version: 0.9.5
   type: :development
   prerelease: false
-  version_requirements: *70226024768120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.5
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70226024767020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,11 +118,17 @@ dependencies:
         version: 1.3.3
   type: :development
   prerelease: false
-  version_requirements: *70226024767020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
 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:
-- ernie@metautonomo.us
+- ernie@erniemiller.org
+- radarlistener@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -151,7 +188,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/en.yml
 - spec/support/schema.rb
-homepage: http://metautonomo.us/projects/ransack
+homepage: https://github.com/ernie/ransack
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -163,15 +200,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4077471372512744125
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4077471372512744125
 requirements: []
 rubyforge_project: ransack
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Object-based searching for ActiveRecord (currently).