ransack 0.7.2 → 1.0.0

data/lib/ransack/constants.rb

@@ -23,7 +23,12 @@ module Ransack
     module_function
     # replace % \ to \% \\
     def escape_wildcards(unescaped)
-      unescaped.gsub(/\\/){ "\\\\" }.gsub(/%/, "\\%")
+      if ActiveRecord::VERSION::MAJOR == 3
+        unescaped.to_s.gsub(/([\\|\%|.])/, '\\\\\\1')
+      else
+        unescaped.to_s.gsub(/\\/){ "\\\\" }.gsub(/%/, "\\%")
+      end
     end
+
   end
 end

data/lib/ransack/context.rb

@@ -28,7 +28,7 @@ module Ransack
     end
 
     def initialize(object, options = {})
-      @object = object.scoped
+      @object = relation_for(object)
       @klass = @object.klass
       @join_dependency = join_dependency(@object)
       @join_type = options[:join_type] || Arel::OuterJoin
@@ -44,6 +44,20 @@ module Ransack
       end
     end
 
+    def klassify(obj)
+      if Class === obj && ::ActiveRecord::Base > obj
+        obj
+      elsif obj.respond_to? :klass
+        obj.klass
+      elsif obj.respond_to? :active_record  # Rails 3
+        obj.active_record
+      elsif obj.respond_to? :base_klass     # Rails 4
+        obj.base_klass
+      else
+        raise ArgumentError, "Don't know how to klassify #{obj}"
+      end
+    end
+
     # Convert a string representing a chain of associations and an attribute
     # into the attribute itself
     def contextualize(str)

data/lib/ransack/helpers/form_builder.rb

@@ -163,7 +163,8 @@ module Ransack
           end
         else
           [obj]
-        end).compact.flatten.map {|v| [prefix, v].compact.join('_')}
+        end).
+        compact.flatten.map { |v| [prefix, v].compact.join('_') }
       end
 
       def attr_from_base_and_column(base, column)

data/lib/ransack/helpers/form_helper.rb

@@ -59,11 +59,12 @@ module Ransack
         query_hash = {}
         query_hash[search.context.search_key] = search_params.merge(:s => "#{attr_name} #{new_dir}")
         options.merge!(query_hash)
+        options_for_url = params.merge options
 
         url = if routing_proxy && respond_to?(routing_proxy)
-          send(routing_proxy).url_for(options)
+          send(routing_proxy).url_for(options_for_url)
         else
-          url_for(options)
+          url_for(options_for_url)
         end
 
         link_to [ERB::Util.h(name), order_indicator_for(current_dir)].compact.join(' ').html_safe,

data/lib/ransack/locale/es.yml

@@ -29,7 +29,7 @@ es:
       lt: "menor que"
       lt_any: "menor que cualquier"
       lt_all: "menor o igual a"
-      lteq: "less than or equal to"
+      lteq: "menor que o igual a"
       lteq_any: "menor o igual a cualquier"
       lteq_all: "menor o igual a todos"
       gt: "mayor que"

data/lib/ransack/locale/fr.yml

@@ -0,0 +1,70 @@
+fr:
+  ransack:
+    search: "recherche"
+    predicate: "prédicat"
+    and: "et"
+    or: "ou"
+    any: "au moins un"
+    all: "tous"
+    combinator: "combinateur"
+    attribute: "attribut"
+    value: "valeur"
+    condition: "condition"
+    sort: "tri"
+    asc: "ascendant"
+    desc: "descendant"
+    predicates:
+      eq: "égal à"
+      eq_any: "égal à au moins un"
+      eq_all: "égal à tous"
+      not_eq: "différent de"
+      not_eq_any: "différent d'au moins un"
+      not_eq_all: "différent de tous"
+      matches: "correspond à"
+      matches_any: "correspond à au moins un"
+      matches_all: "correspond à tous"
+      does_not_match: "ne correspond pas à"
+      does_not_match_any: "ne correspond pas à au moins un"
+      does_not_match_all: "ne correspond à aucun"
+      lt: "inférieur à"
+      lt_any: "inférieur à au moins un"
+      lt_all: "inférieur à tous"
+      lteq: "inférieur ou égal à"
+      lteq_any: "inférieur ou égal à au moins un"
+      lteq_all: "inférieur ou égal à tous"
+      gt: "supérieur à"
+      gt_any: "supérieur à au moins un"
+      gt_all: "supérieur à tous"
+      gteq: "supérieur ou égal à"
+      gteq_any: "supérieur ou égal à au moins un"
+      gteq_all: "supérieur ou égal à tous"
+      in: "inclus dans"
+      in_any: "inclus dans au moins un"
+      in_all: "inclus dans tous"
+      not_in: "non inclus dans"
+      not_in_any: "non inclus dans au moins un"
+      not_in_all: "non inclus dans tous"
+      cont: "contient"
+      cont_any: "contient au moins un"
+      cont_all: "contient tous"
+      not_cont: "ne contient pas"
+      not_cont_any: "ne contient pas au moins un"
+      not_cont_all: "ne contient pas tous"
+      start: "commence par"
+      start_any: "commence par au moins un"
+      start_all: "commence par tous"
+      not_start: "ne commence pas par"
+      not_start_any: "ne commence pas par au moins un"
+      not_start_all: "ne commence pas par tous"
+      end: "finit par"
+      end_any: "finit par au moins un"
+      end_all: "finit par tous"
+      not_end: "ne finit pas par"
+      not_end_any: "ne finit pas par au moins un"
+      not_end_all: "ne finit pas par tous"
+      'true': "est vrai"
+      'false': "est faux"
+      present: "est présent"
+      blank: "est blanc"
+      'null': "est null"
+      not_null: "n'est pas null"

data/lib/ransack/translate.rb

@@ -23,7 +23,7 @@ module Ransack
       attribute_names = attributes_str.split(/_and_|_or_/)
       combinator = attributes_str.match(/_and_/) ? :and : :or
       defaults = base_ancestors.map do |klass|
-        :"ransack.attributes.#{klass.model_name.underscore}.#{original_name}"
+        :"ransack.attributes.#{klass.model_name.singular}.#{original_name}"
       end
 
       translated_names = attribute_names.map do |attr|
@@ -50,7 +50,7 @@ module Ransack
         raise ArgumentError, "A context is required to translate associations"
       end
 
-      defaults = key.blank? ? [:"#{context.klass.i18n_scope}.models.#{context.klass.model_name.underscore}"] : [:"ransack.associations.#{context.klass.model_name.underscore}.#{key}"]
+      defaults = key.blank? ? [:"#{context.klass.i18n_scope}.models.#{context.klass.model_name.singular}"] : [:"ransack.associations.#{context.klass.model_name.singular}.#{key}"]
       defaults << context.traverse(key).model_name.human
       options = {:count => 1, :default => defaults}
       I18n.translate(defaults.shift, options)
@@ -65,19 +65,20 @@ module Ransack
       interpolations = {}
       interpolations[:attr_fallback_name] = I18n.translate(
         (associated_class ?
-          :"ransack.attributes.#{associated_class.model_name.underscore}.#{attr_name}" :
-          :"ransack.attributes.#{context.klass.model_name.underscore}.#{attr_name}"
+          :"ransack.attributes.#{associated_class.model_name.singular}.#{attr_name}" :
+          :"ransack.attributes.#{context.klass.model_name.singular}.#{attr_name}"
         ),
         :default => [
           (associated_class ?
-            :"#{associated_class.i18n_scope}.attributes.#{associated_class.model_name.underscore}.#{attr_name}" :
-            :"#{context.klass.i18n_scope}.attributes.#{context.klass.model_name.underscore}.#{attr_name}"
+            :"#{associated_class.i18n_scope}.attributes.#{associated_class.model_name.singular}.#{attr_name}" :
+            :"#{context.klass.i18n_scope}.attributes.#{context.klass.model_name.singular}.#{attr_name}"
           ),
+          :".attributes.#{attr_name}",
           attr_name.humanize
         ]
       )
       defaults = [
-        :"ransack.attributes.#{context.klass.model_name.underscore}.#{name}"
+        :"ransack.attributes.#{context.klass.model_name.singular}.#{name}"
       ]
       if include_associations && associated_class
         defaults << '%{association_name} %{attr_fallback_name}'
@@ -89,4 +90,4 @@ module Ransack
       I18n.translate(defaults.shift, options.merge(interpolations))
     end
   end
-end
+end

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = "0.7.2"
+  VERSION = "1.0.0"
 end

data/ransack.gemspec

@@ -14,9 +14,9 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "ransack"
 
-  s.add_dependency 'activerecord', '~> 3.0'
-  s.add_dependency 'actionpack', '~> 3.0'
-  s.add_dependency 'polyamorous', '~> 0.5.0'
+  s.add_dependency 'activerecord', '>= 3.0'
+  s.add_dependency 'actionpack', '>= 3.0'
+  s.add_dependency 'polyamorous', '~> 0.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'

data/spec/ransack/adapters/active_record/context_spec.rb

@@ -6,6 +6,12 @@ module Ransack
       describe Context do
         subject { Context.new(Person) }
 
+        describe '#relation_for' do
+          it 'returns relation for given object' do
+            subject.object.should be_an ::ActiveRecord::Relation
+          end
+        end
+
         describe '#evaluate' do
           it 'evaluates search obects' do
             search = Search.new(Person, :name_eq => 'Joe Blow')

data/spec/ransack/helpers/form_builder_spec.rb

@@ -7,7 +7,7 @@ module Ransack
       router = ActionDispatch::Routing::RouteSet.new
       router.draw do
         resources :people
-        match ':controller(/:action(/:id(.:format)))'
+        get ':controller(/:action(/:id(.:format)))'
       end
 
       include router.url_helpers
@@ -48,11 +48,21 @@ module Ransack
       end
 
       describe '#sort_link' do
-        subject { @f.sort_link :name, :controller => 'people' }
+        it 'sort_link for ransack attribute' do
+          sort_link = @f.sort_link :name, :controller => 'people'
+          if ActiveRecord::VERSION::STRING =~ /^3\.[1-2]\./ 
+            sort_link.should match /people\?q%5Bs%5D=name\+asc/
+          else
+            sort_link.should match /people\?q(%5B|\[)s(%5D|\])=name\+asc/
+          end
+          sort_link.should match /sort_link/
+          sort_link.should match /Full Name<\/a>/
+        end
 
-        it { should match /people\?q%5Bs%5D=name\+asc/}
-        it { should match /sort_link/}
-        it { should match /Full Name<\/a>/}
+        it 'sort_link for common attribute' do
+          sort_link = @f.sort_link :id, :controller => 'people'
+          sort_link.should match /id<\/a>/
+        end
       end
 
       describe '#submit' do
@@ -124,4 +134,4 @@ module Ransack
       end
     end
   end
-end
+end

data/spec/ransack/helpers/form_helper_spec.rb

@@ -7,7 +7,7 @@ module Ransack
       router = ActionDispatch::Routing::RouteSet.new
       router.draw do
         resources :people
-        match ':controller(/:action(/:id(.:format)))'
+        get ':controller(/:action(/:id(.:format)))'
       end
 
       include router.url_helpers
@@ -26,24 +26,71 @@ module Ransack
       end
 
       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/ }
+        subject {
+          @controller.view_context.sort_link(
+            [:main_app, Person.search(:sorts => ['name desc'])],
+            :name, :controller => 'people'
+          )
+        }
+        it { should match(
+          if ActiveRecord::VERSION::STRING =~ /^3\.[1-2]\./
+            /people\?q%5Bs%5D=name\+asc/
+          else
+            /people\?q(%5B|\[)s(%5D|\])=name\+asc/
+          end)
+        } 
         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\?people_search%5Bs%5D=name\+asc/ }
+        subject { @controller.
+          view_context.sort_link(
+            Person.search({ :sorts => ['name desc'] }, :search_key => :people_search),
+            :name, :controller => 'people'
+          )
+        }
+        it { should match(
+          if ActiveRecord::VERSION::STRING =~ /^3\.[1-2]\./
+            /people\?people_search%5Bs%5D=name\+asc/
+          else
+            /people\?people_search(%5B|\[)s(%5D|\])=name\+asc/
+          end)
+        } 
       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') }
+        subject {
+          @controller.view_context.sort_link(
+            Person.search({ :sorts => ['name desc'] }, :search_key => 'people_search'),
+            :name, :controller => 'people'
+          )
+        }
+        it { should match(
+          if ActiveRecord::VERSION::STRING =~ /^3\.[1-2]\./
+            /people\?people_search%5Bs%5D=name\+asc/
+          else
+            /people\?people_search(%5B|\[)s(%5D|\])=name\+asc/
+          end)
+        } 
+      end
+
 
-        it { should match /people\?people_search%5Bs%5D=name\+asc/ }
+      context 'view has existing parameters' do
+        before do
+          @controller.view_context.params.merge!({ :exist => 'existing' })
+        end
+        describe '#sort_link should not remove existing params' do
+          subject {
+            @controller.view_context.sort_link(
+              Person.search({ :sorts => ['name desc'] }, :search_key => 'people_search'),
+              :name, :controller => 'people'
+            )
+          }
+          it {
+            should match /exist\=existing/
+          }
+        end
       end
     end
   end

data/spec/ransack/predicate_spec.rb

@@ -7,6 +7,24 @@ module Ransack
       @s = Search.new(Person)
     end
 
+    shared_examples 'wildcard escaping' do |method, regexp|
+      it 'automatically converts integers to strings' do
+        subject.parent_id_cont = 1
+        expect { subject.result }.to_not raise_error
+      end
+
+      it (
+        if ActiveRecord::VERSION::MAJOR == 3
+          "escapes '%', '.' and '\\\\' in value"
+        else
+          "escapes % and \\ in value"
+        end
+      ) do
+        subject.send(:"#{method}=", '%._\\')
+        subject.result.to_sql.should match(regexp)
+      end
+    end
+
     describe 'eq' do
       it 'generates an equality condition for boolean true' do
         @s.awesome_eq = true
@@ -25,17 +43,32 @@ module Ransack
     end
 
     describe 'cont' do
+  
+      it_has_behavior 'wildcard escaping', :name_cont, (
+        if ActiveRecord::VERSION::MAJOR == 3
+          /"people"."name" LIKE '%\\%\\._\\\\%'/
+        else
+          /"people"."name" LIKE '%\\%._\\\\%'/ 
+        end) do
+        subject { @s }
+      end
+
       it 'generates a LIKE query with value surrounded by %' do
         @s.name_cont = 'ric'
         @s.result.to_sql.should match /"people"."name" LIKE '%ric%'/
       end
-      it 'escapes %, _ and \\ in value' do
-        @s.name_cont = '%_\\'
-        @s.result.to_sql.should match /"people"."name" LIKE '%\\%\\_\\\\%'/
-      end
     end
 
     describe 'not_cont' do
+      it_has_behavior 'wildcard escaping', :name_not_cont, (
+        if ActiveRecord::VERSION::MAJOR == 3
+          /"people"."name" NOT LIKE '%\\%\\._\\\\%'/
+        else
+          /"people"."name" NOT LIKE '%\\%._\\\\%'/
+        end) do
+        subject { @s }
+      end
+
       it 'generates a NOT LIKE query with value surrounded by %' do
         @s.name_not_cont = 'ric'
         @s.result.to_sql.should match /"people"."name" NOT LIKE '%ric%'/

data/spec/ransack/search_spec.rb

@@ -32,8 +32,10 @@ module Ransack
       end
 
       it 'creates Conditions for multiple polymorphic belongs_to association attributes' do
-        search = Search.new(Note, :notable_of_Person_type_name_or_notable_of_Article_type_title_eq => 'Ernie')
-        condition = search.base[:notable_of_Person_type_name_or_notable_of_Article_type_title_eq]
+        search = Search.new(Note,
+          :notable_of_Person_type_name_or_notable_of_Article_type_title_eq => 'Ernie')
+        condition = search.
+          base[:notable_of_Person_type_name_or_notable_of_Article_type_title_eq]
         condition.should be_a Nodes::Condition
         condition.predicate.name.should eq 'eq'
         condition.attributes.first.name.should eq 'notable_of_Person_type_name'
@@ -50,8 +52,8 @@ module Ransack
       it 'accepts arrays of groupings' do
         search = Search.new(Person,
           :g => [
-            {:m => 'or', :name_eq => 'Ernie', :children_name_eq => 'Ernie'},
-            {:m => 'or', :name_eq => 'Bert', :children_name_eq => 'Bert'},
+            { :m => 'or', :name_eq => 'Ernie', :children_name_eq => 'Ernie' },
+            { :m => 'or', :name_eq => 'Bert', :children_name_eq => 'Bert' },
           ]
         )
         ors = search.groupings
@@ -66,8 +68,8 @@ module Ransack
       it 'accepts "attributes" hashes for groupings' do
         search = Search.new(Person,
           :g => {
-            '0' => {:m => 'or', :name_eq => 'Ernie', :children_name_eq => 'Ernie'},
-            '1' => {:m => 'or', :name_eq => 'Bert', :children_name_eq => 'Bert'},
+            '0' => { :m => 'or', :name_eq => 'Ernie', :children_name_eq => 'Ernie' },
+            '1' => { :m => 'or', :name_eq => 'Bert', :children_name_eq => 'Bert' },
           }
         )
         ors = search.groupings
@@ -82,8 +84,8 @@ module Ransack
       it 'accepts "attributes" hashes for conditions' do
         search = Search.new(Person,
           :c => {
-            '0' => {:a => ['name'], :p => 'eq', :v => ['Ernie']},
-            '1' => {:a => ['children_name', 'parent_name'], :p => 'eq', :v => ['Ernie'], :m => 'or'}
+            '0' => { :a => ['name'], :p => 'eq', :v => ['Ernie'] },
+            '1' => { :a => ['children_name', 'parent_name'], :p => 'eq', :v => ['Ernie'], :m => 'or' }
           }
         )
         conditions = search.base.conditions
@@ -93,8 +95,7 @@ module Ransack
 
       it 'creates Conditions for custom predicates that take arrays' do
         Ransack.configure do |config|
-          config.add_predicate 'ary_pred',
-          :wants_array => true
+          config.add_predicate 'ary_pred', :wants_array => true
         end
 
         search = Search.new(Person, :name_ary_pred => ['Ernie', 'Bert'])
@@ -135,11 +136,12 @@ module Ransack
 
       it 'evaluates nested conditions' do
         search = Search.new(Person, :children_name_eq => 'Ernie',
-          :g => [{
-            :m => 'or',
-            :name_eq => 'Ernie',
-            :children_children_name_eq => 'Ernie'
-          }]
+          :g => [
+            { :m => 'or',
+              :name_eq => 'Ernie',
+              :children_children_name_eq => 'Ernie'
+            }
+          ]
         )
         search.result.should be_an ActiveRecord::Relation
         where = search.result.where_values.first
@@ -151,8 +153,8 @@ module Ransack
       it 'evaluates arrays of groupings' do
         search = Search.new(Person,
           :g => [
-            {:m => 'or', :name_eq => 'Ernie', :children_name_eq => 'Ernie'},
-            {:m => 'or', :name_eq => 'Bert', :children_name_eq => 'Bert'},
+            { :m => 'or', :name_eq => 'Ernie', :children_name_eq => 'Ernie' },
+            { :m => 'or', :name_eq => 'Bert', :children_name_eq => 'Bert' },
           ]
         )
         search.result.should be_an ActiveRecord::Relation
@@ -166,10 +168,25 @@ module Ransack
       end
 
       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.all.should have(920).items
-        search.result(:distinct => true).should have(330).items
-        search.result.all.uniq.should eq search.result(:distinct => true).all
+        search = Search.new(
+          Person, :g => [
+            { :m => 'or',
+              :comments_body_cont => 'e',
+              :articles_comments_body_cont => 'e'
+            }
+          ]
+        )
+        if ActiveRecord::VERSION::MAJOR == 3
+          all_or_load, uniq_or_distinct = :all, :uniq
+        else
+          all_or_load, uniq_or_distinct = :load, :distinct
+        end
+        search.result.send(all_or_load).
+          should have(920).items
+        search.result(:distinct => true).
+          should have(330).items
+        search.result.send(all_or_load).send(uniq_or_distinct).
+          should eq search.result(:distinct => true).send(all_or_load)
       end
     end
 
@@ -201,22 +218,21 @@ module Ransack
 
       it 'creates sorts based on multiple attributes/directions in hash format' do
         @s.sorts = {
-          '0' => {
-            :name => 'id',
-            :dir => 'desc'
-          },
-          '1' => {
-            :name => 'name',
-            :dir => 'asc'
-          }
+          '0' => { :name => 'id', :dir => 'desc' },
+          '1' => { :name => 'name', :dir => 'asc' }
         }
         @s.sorts.should have(2).items
-        @s.sorts.should be_all {|s| Nodes::Sort === s}
-        id_sort = @s.sorts.detect {|s| s.name == 'id'}
-        name_sort = @s.sorts.detect {|s| s.name == 'name'}
+        @s.sorts.should be_all { |s| Nodes::Sort === s }
+        id_sort = @s.sorts.detect { |s| s.name == 'id' }
+        name_sort = @s.sorts.detect { |s| s.name == 'name' }
         id_sort.dir.should eq 'desc'
         name_sort.dir.should eq 'asc'
       end
+
+      it 'overrides existing sort' do
+        @s.sorts = 'id asc'
+        @s.result.first.id.should eq 1
+      end
     end
 
     describe '#method_missing' do
@@ -225,7 +241,7 @@ module Ransack
       end
 
       it 'raises NoMethodError when sent an invalid attribute' do
-        expect {@s.blah}.to raise_error NoMethodError
+        expect { @s.blah }.to raise_error NoMethodError
       end
 
       it 'sets condition attributes when sent valid attributes' do
@@ -234,8 +250,7 @@ module Ransack
       end
 
       it 'allows chaining to access nested conditions' do
-        @s.groupings = [{:m => 'or', :name_eq => 'Ernie', :children_name_eq => 'Ernie'}]
-        @s.groupings.first.name_eq.should eq 'Ernie'
+        @s.groupings = [{ :m => 'or', :name_eq => 'Ernie', :children_name_eq => 'Ernie' }]
         @s.groupings.first.children_name_eq.should eq 'Ernie'
       end
     end