ransack 2.3.2 → 4.1.1

data/lib/ransack/translate.rb

@@ -32,6 +32,7 @@ module Ransack
         defaults = base_ancestors.map do |klass|
           "ransack.attributes.#{i18n_key(klass)}.#{original_name}".to_sym
         end
+        defaults << options.delete(:default) if options[:default]
 
         translated_names = attribute_names.map do |name|
           attribute_name(context, name, options[:include_associations])
@@ -48,9 +49,8 @@ module Ransack
           defaults << "%{attributes}".freeze
         end
 
-        defaults << options.delete(:default) if options[:default]
         options.reverse_merge! count: 1, default: defaults
-        I18n.translate(defaults.shift, options.merge(interpolations))
+        I18n.translate(defaults.shift, **options.merge(interpolations))
       end
 
       def association(key, options = {})
@@ -66,8 +66,8 @@ module Ransack
             [:"ransack.associations.#{i18n_key(context.klass)}.#{key}"]
           end
         defaults << context.traverse(key).model_name.human
-        options = { :count => 1, :default => defaults }
-        I18n.translate(defaults.shift, options)
+        options = { count: 1, default: defaults }
+        I18n.translate(defaults.shift, **options)
       end
 
       private
@@ -83,7 +83,7 @@ module Ransack
         options = { count: 1, default: defaults }
         interpolations = build_interpolations(associated_class)
 
-        I18n.translate(defaults.shift, options.merge(interpolations))
+        I18n.translate(defaults.shift, **options.merge(interpolations))
       end
 
       def default_attribute_name
@@ -149,7 +149,7 @@ module Ransack
       end
 
       def i18n_key(klass)
-        raise "not implemented"
+        klass.model_name.i18n_key
       end
     end
   end

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = '2.3.2'
+  VERSION = '4.1.1'
 end

data/lib/ransack/visitor.rb

@@ -26,7 +26,14 @@ module Ransack
     end
 
     def visit_and(object)
-      raise "not implemented"
+      nodes = object.values.map { |o| accept(o) }.compact
+      return nil unless nodes.size > 0
+
+      if nodes.size > 1
+        Arel::Nodes::Grouping.new(Arel::Nodes::And.new(nodes))
+      else
+        nodes.first
+      end
     end
 
     def visit_or(object)
@@ -35,17 +42,46 @@ module Ransack
     end
 
     def quoted?(object)
-      raise "not implemented"
+      case object
+      when Arel::Nodes::SqlLiteral, Bignum, Fixnum
+        false
+      else
+        true
+      end
     end
 
     def visit(object)
       send(DISPATCH[object.class], object)
     end
 
+    def visit_Ransack_Nodes_Sort(object)
+      if object.valid?
+        if object.attr.is_a?(Arel::Attributes::Attribute)
+          object.attr.send(object.dir)
+        else
+          ordered(object)
+        end
+      else
+        scope_name = :"sort_by_#{object.name}_#{object.dir}"
+        scope_name if object.context.object.respond_to?(scope_name)
+      end
+    end
+
     DISPATCH = Hash.new do |hash, klass|
       hash[klass] = "visit_#{
         klass.name.gsub(Constants::TWO_COLONS, Constants::UNDERSCORE)
         }"
     end
+
+    private
+
+      def ordered(object)
+        case object.dir
+        when 'asc'.freeze
+          Arel::Nodes::Ascending.new(object.attr)
+        when 'desc'.freeze
+          Arel::Nodes::Descending.new(object.attr)
+        end
+      end
   end
 end

data/lib/ransack.rb

@@ -1,18 +1,15 @@
 require 'active_support/core_ext'
 require 'ransack/configuration'
-require 'ransack/adapters'
-require 'polyamorous'
-
-Ransack::Adapters.object_mapper.require_constants
+require 'polyamorous/polyamorous'
 
 module Ransack
   extend Configuration
-  class UntraversableAssociationError < StandardError; end;
+  class UntraversableAssociationError < StandardError; end
 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|
     config.add_predicate(*args)
@@ -22,8 +19,8 @@ end
 require 'ransack/search'
 require 'ransack/ransacker'
 require 'ransack/translate'
-
-Ransack::Adapters.object_mapper.require_adapter
+require 'ransack/active_record'
+require 'ransack/context'
 
 ActiveSupport.on_load(:action_controller) do
   require 'ransack/helpers'

data/ransack.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 $:.push File.expand_path("../lib", __FILE__)
 require "ransack/version"
 
@@ -6,27 +7,20 @@ Gem::Specification.new do |s|
   s.name        = "ransack"
   s.version     = Ransack::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Ernie Miller", "Ryan Bigg", "Jon Atack","Sean Carroll"]
-  s.email       = ["ernie@erniemiller.org", "radarlistener@gmail.com", "jonnyatack@gmail.com","sfcarroll@gmail.com"]
+  s.authors     = ["Ernie Miller", "Ryan Bigg", "Jon Atack", "Sean Carroll", "David Rodríguez"]
+  s.email       = ["ernie@erniemiller.org", "radarlistener@gmail.com", "jonnyatack@gmail.com", "sfcarroll@gmail.com"]
   s.homepage    = "https://github.com/activerecord-hackery/ransack"
-  s.summary     = %q{Object-based searching for Active Record and Mongoid (currently).}
+  s.summary     = %q{Object-based searching for Active Record.}
   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.}
-  s.required_ruby_version = '>= 2.3'
+  s.required_ruby_version = '>= 3.0'
   s.license     = 'MIT'
 
-  s.add_dependency 'activerecord', '>= 5.2.1'
-  s.add_dependency 'activesupport', '>= 5.2.1'
+  s.add_dependency 'activerecord', '>= 6.1.5'
+  s.add_dependency 'activesupport', '>= 6.1.5'
   s.add_dependency 'i18n'
-  s.add_dependency 'polyamorous', Ransack::VERSION.to_s
 
   s.files         = `git ls-files`.split("\n")
-
-  s.test_files    = `git ls-files -- {test,spec,features}/*`
-                    .split("\n")
-
-  s.executables   = `git ls-files -- bin/*`
-                    .split("\n")
-                    .map { |f| File.basename(f) }
-
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/spec/blueprints/articles.rb

@@ -2,4 +2,4 @@ Article.blueprint do
   person
   title
   body
-end
+end

data/spec/blueprints/comments.rb

@@ -2,4 +2,4 @@ Comment.blueprint do
   article
   person
   body
-end
+end

data/spec/blueprints/notes.rb

@@ -2,4 +2,4 @@ Note.blueprint do
   note
   notable_type { "Article" }
   notable_id
-end
+end

data/spec/blueprints/tags.rb

@@ -1,3 +1,3 @@
 Tag.blueprint do
   name    { Sham.tag_name }
-end
+end

data/spec/console.rb

@@ -14,11 +14,11 @@ Sham.define do
   title    { Faker::Lorem.sentence }
   body     { Faker::Lorem.paragraph }
   salary   { |index| 30000 + (index * 1000) }
-  tag_name { Faker::Lorem.words(3).join(' ') }
-  note     { Faker::Lorem.words(7).join(' ') }
-  only_admin  { Faker::Lorem.words(3).join(' ') }
-  only_search { Faker::Lorem.words(3).join(' ') }
-  only_sort   { Faker::Lorem.words(3).join(' ') }
+  tag_name { Faker::Lorem.words(number: 3).join(' ') }
+  note     { Faker::Lorem.words(number: 7).join(' ') }
+  only_admin  { Faker::Lorem.words(number: 3).join(' ') }
+  only_search { Faker::Lorem.words(number: 3).join(' ') }
+  only_sort   { Faker::Lorem.words(number: 3).join(' ') }
   notable_id  { |id| id }
 end
 

data/spec/helpers/polyamorous_helper.rb

@@ -3,14 +3,8 @@ module PolyamorousHelper
     Polyamorous::JoinAssociation.new reflection, children, klass
   end
 
-  if ActiveRecord.version >= ::Gem::Version.new("6.0.0.rc1")
-    def new_join_dependency(klass, associations = {})
-      Polyamorous::JoinDependency.new klass, klass.arel_table, associations, Polyamorous::InnerJoin
-    end
-  else
-    def new_join_dependency(klass, associations = {})
-      Polyamorous::JoinDependency.new klass, klass.arel_table, associations
-    end
+  def new_join_dependency(klass, associations = {})
+    Polyamorous::JoinDependency.new klass, klass.arel_table, associations, Polyamorous::InnerJoin
   end
 
   def new_join(name, type = Polyamorous::InnerJoin, klass = nil)

data/spec/helpers/ransack_helper.rb

@@ -6,4 +6,4 @@ module RansackHelper
   def quote_column_name(column)
     ActiveRecord::Base.connection.quote_column_name(column)
   end
-end
+end

data/spec/polyamorous/activerecord_compatibility_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module Polyamorous
+  describe "ActiveRecord Compatibility" do
+    it 'works with self joins and includes' do
+      trade_account = Account.create!
+      Account.create!(trade_account: trade_account)
+
+      accounts = Account.joins(:trade_account).includes(:trade_account, :agent_account)
+      account = accounts.first
+
+      expect(account.agent_account).to be_nil
+    end
+  end
+end

data/spec/{ransack → polyamorous}/join_association_spec.rb

@@ -10,7 +10,9 @@ module Polyamorous
       new_join_association(reflection, parent.children, Article)
     }
 
-    it 'leaves the orginal reflection intact for thread safety' do
+    subject { new_join_association(reflection, parent.children, Person) }
+
+    it 'leaves the original reflection intact for thread safety' do
       reflection.instance_variable_set(:@klass, Article)
       join_association
       .swapping_reflection_klass(reflection, Person) do |new_reflection|

data/spec/{ransack → polyamorous}/join_dependency_spec.rb

@@ -77,21 +77,5 @@ module Polyamorous
       specify { expect(subject.send(:join_root).drop(1)[1].table_name)
         .to eq 'comments' }
     end
-
-    context '#left_outer_join in Rails 5 overrides join type specified',
-            if: ActiveRecord::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MAJOR < 6 && ActiveRecord::VERSION::MINOR < 2 do
-
-      let(:join_type_class) do
-        new_join_dependency(
-          Person,
-          new_join(:articles)
-        ).join_constraints(
-          [],
-          Arel::Nodes::OuterJoin
-        ).first.joins.map(&:class)
-      end
-
-      specify { expect(join_type_class).to eq [Arel::Nodes::OuterJoin] }
-    end
   end
 end

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

@@ -8,7 +8,6 @@ module Ransack
         subject { ::ActiveRecord::Base }
 
         it { should respond_to :ransack }
-        it { should respond_to :search }
 
         describe '#search' do
           subject { Person.ransack }
@@ -44,12 +43,12 @@ module Ransack
 
             it 'applies stringy boolean scopes with true value in an array' do
               s = Person.ransack('of_age' => ['true'])
-              expect(s.result.to_sql).to (include 'age >= 18')
+              expect(s.result.to_sql).to (include rails7_and_mysql ? %q{(age >= '18')} : 'age >= 18')
             end
 
             it 'applies stringy boolean scopes with false value in an array' do
               s = Person.ransack('of_age' => ['false'])
-              expect(s.result.to_sql).to (include 'age < 18')
+              expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age < '18'} : 'age < 18')
             end
 
             it 'ignores unlisted scopes' do
@@ -69,15 +68,25 @@ module Ransack
 
             it 'passes values to scopes' do
               s = Person.ransack('over_age' => 18)
-              expect(s.result.to_sql).to (include 'age > 18')
+              expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age > '18'} : 'age > 18')
             end
 
             it 'chains scopes' do
               s = Person.ransack('over_age' => 18, 'active' => true)
-              expect(s.result.to_sql).to (include 'age > 18')
+              expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age > '18'} : 'age > 18')
               expect(s.result.to_sql).to (include 'active = 1')
             end
 
+            it 'applies scopes that define string SQL joins' do
+              allow(Article)
+                .to receive(:ransackable_scopes)
+                .and_return([:latest_comment_cont])
+
+              # Including a negative condition to test removing the scope
+              s = Search.new(Article, notes_note_not_eq: 'Test', latest_comment_cont: 'Test')
+              expect(s.result.to_sql).to include 'latest_comment'
+            end
+
             context "with sanitize_custom_scope_booleans set to false" do
               before(:all) do
                 Ransack.configure { |c| c.sanitize_custom_scope_booleans = false }
@@ -89,12 +98,12 @@ module Ransack
 
               it 'passes true values to scopes' do
                 s = Person.ransack('over_age' => 1)
-                expect(s.result.to_sql).to (include 'age > 1')
+                expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age > '1'} : 'age > 1')
               end
 
               it 'passes false values to scopes'  do
                 s = Person.ransack('over_age' => 0)
-                expect(s.result.to_sql).to (include 'age > 0')
+                expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age > '0'} : 'age > 0')
               end
             end
 
@@ -107,12 +116,12 @@ module Ransack
 
               it 'passes true values to scopes' do
                 s = Person.ransack('over_age' => 1)
-                expect(s.result.to_sql).to (include 'age > 1')
+                expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age > '1'} : 'age > 1')
               end
 
               it 'passes false values to scopes'  do
                 s = Person.ransack('over_age' => 0)
-                expect(s.result.to_sql).to (include 'age > 0')
+                expect(s.result.to_sql).to (include  rails7_and_mysql ? %q{age > '0'} : 'age > 0')
               end
             end
 
@@ -122,12 +131,32 @@ module Ransack
             expect { Person.ransack('') }.to_not raise_error
           end
 
+          it 'raises exception if ransack! called with unknown condition' do
+            expect { Person.ransack!(unknown_attr_eq: 'Ernie') }.to raise_error(ArgumentError)
+          end
+
           it 'does not modify the parameters' do
             params = { name_eq: '' }
             expect { Person.ransack(params) }.not_to change { params }
           end
         end
 
+        context 'has_one through associations' do
+          let(:address)  { Address.create!(city: 'Boston') }
+          let(:org) { Organization.create!(name: 'Testorg', address: address) }
+          let!(:employee) { Employee.create!(name: 'Ernie', organization: org) }
+
+          it 'works when has_one through association is first' do
+            s = Employee.ransack(address_city_eq: 'Boston', organization_name_eq: 'Testorg')
+            expect(s.result.to_a).to include(employee)
+          end
+
+          it 'works when has_one through association is last' do
+            s = Employee.ransack(organization_name_eq: 'Testorg', address_city_eq: 'Boston')
+            expect(s.result.to_a).to include(employee)
+          end
+        end
+
         context 'negative conditions on HABTM associations' do
           let(:medieval) { Tag.create!(name: 'Medieval') }
           let(:fantasy)  { Tag.create!(name: 'Fantasy') }
@@ -143,14 +172,12 @@ module Ransack
           it 'removes redundant joins from top query' do
             s = Article.ransack(tags_name_not_eq: "Fantasy")
             sql = s.result.to_sql
-
             expect(sql).to_not include('LEFT OUTER JOIN')
           end
 
           it 'handles != for single values' do
             s = Article.ransack(tags_name_not_eq: "Fantasy")
             articles = s.result.to_a
-
             expect(articles).to include marco
             expect(articles).to_not include arthur
           end
@@ -267,10 +294,12 @@ module Ransack
           # end
 
           it 'creates ransack attributes' do
+            person = Person.create!(name: 'Aric Smith')
+
             s = Person.ransack(reversed_name_eq: 'htimS cirA')
             expect(s.result.size).to eq(1)
 
-            expect(s.result.first).to eq Person.where(name: 'Aric Smith').first
+            expect(s.result.first).to eq person
           end
 
           it 'can be accessed through associations' do
@@ -310,7 +339,11 @@ module Ransack
           end
 
           it 'should function correctly with a multi-parameter attribute' do
-            ::ActiveRecord::Base.default_timezone = :utc
+            if ::ActiveRecord::VERSION::MAJOR >= 7
+              ::ActiveRecord.default_timezone = :utc
+            else
+              ::ActiveRecord::Base.default_timezone = :utc
+            end
             Time.zone = 'UTC'
 
             date = Date.current
@@ -460,9 +493,9 @@ module Ransack
               Comment.create(article: Article.create(title: 'Avenger'), person: Person.create(salary: 100_000)),
               Comment.create(article: Article.create(title: 'Avenge'), person: Person.create(salary: 50_000)),
             ]
-            expect(Comment.ransack(article_title_cont: 'aven',s: 'person_salary desc').result).to eq(comments)
+            expect(Comment.ransack(article_title_cont: 'aven', s: 'person_salary desc').result).to eq(comments)
             expect(Comment.joins(:person).ransack(s: 'persons_salarydesc', article_title_cont: 'aven').result).to eq(comments)
-            expect(Comment.joins(:person).ransack(article_title_cont: 'aven',s: 'persons_salary desc').result).to eq(comments)
+            expect(Comment.joins(:person).ransack(article_title_cont: 'aven', s: 'persons_salary desc').result).to eq(comments)
           end
 
           it 'allows sort by `only_sort` field' do
@@ -541,7 +574,6 @@ module Ransack
             )
           end
 
-
           it 'should allow passing ransacker arguments to a ransacker' do
             s = Person.ransack(
               c: [{
@@ -641,6 +673,37 @@ module Ransack
             it { should_not include 'only_sort' }
             it { should include 'only_admin' }
           end
+
+          context 'when not defined in model, nor in ApplicationRecord' do
+            subject { Article.ransackable_attributes }
+
+            it "raises a helpful error" do
+              without_application_record_method(:ransackable_attributes) do
+                expect { subject }.to raise_error(RuntimeError, /Ransack needs Article attributes explicitly allowlisted/)
+              end
+            end
+          end
+
+          context 'when defined only in model by delegating to super' do
+            subject { Article.ransackable_attributes }
+
+            around do |example|
+              Article.singleton_class.define_method(:ransackable_attributes) do
+                super(nil) - super(nil)
+              end
+
+              example.run
+            ensure
+              Article.singleton_class.remove_method(:ransackable_attributes)
+            end
+
+            it "returns the allowlist in the model, and warns" do
+              without_application_record_method(:ransackable_attributes) do
+                expect { subject }.to output(/Ransack's builtin `ransackable_attributes` method is deprecated/).to_stderr
+                expect(subject).to be_empty
+              end
+            end
+          end
         end
 
         describe '#ransortable_attributes' do
@@ -673,6 +736,37 @@ module Ransack
           it { should include 'parent' }
           it { should include 'children' }
           it { should include 'articles' }
+
+          context 'when not defined in model, nor in ApplicationRecord' do
+            subject { Article.ransackable_associations }
+
+            it "raises a helpful error" do
+              without_application_record_method(:ransackable_associations) do
+                expect { subject }.to raise_error(RuntimeError, /Ransack needs Article associations explicitly allowlisted/)
+              end
+            end
+          end
+
+          context 'when defined only in model by delegating to super' do
+            subject { Article.ransackable_associations }
+
+            around do |example|
+              Article.singleton_class.define_method(:ransackable_associations) do
+                super(nil) - super(nil)
+              end
+
+              example.run
+            ensure
+              Article.singleton_class.remove_method(:ransackable_associations)
+            end
+
+            it "returns the allowlist in the model, and warns" do
+              without_application_record_method(:ransackable_associations) do
+                expect { subject }.to output(/Ransack's builtin `ransackable_associations` method is deprecated/).to_stderr
+                expect(subject).to be_empty
+              end
+            end
+          end
         end
 
         describe '#ransackable_scopes' do
@@ -687,6 +781,21 @@ module Ransack
           it { should eq [] }
         end
 
+        private
+
+        def without_application_record_method(method)
+          ApplicationRecord.singleton_class.alias_method :"original_#{method}", :"#{method}"
+          ApplicationRecord.singleton_class.remove_method :"#{method}"
+
+          yield
+        ensure
+          ApplicationRecord.singleton_class.alias_method :"#{method}", :"original_#{method}"
+          ApplicationRecord.singleton_class.remove_method :"original_#{method}"
+        end
+
+        def rails7_and_mysql
+          ::ActiveRecord::VERSION::MAJOR >= 7 && ENV['DB'] == 'mysql'
+        end
       end
     end
   end

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

@@ -9,7 +9,6 @@ module Ransack
       describe Context do
         subject { Context.new(Person) }
 
-
         it 'has an Active Record alias tracker method' do
           expect(subject.alias_tracker)
           .to be_an ::ActiveRecord::Associations::AliasTracker
@@ -79,6 +78,25 @@ module Ransack
             expect(constraint.right.relation.name).to eql 'people'
             expect(constraint.right.name).to eql 'id'
           end
+
+          it 'build correlated subquery for multiple conditions (default scope)' do
+            search = Search.new(Person, { comments_body_not_eq: 'some_title' })
+
+            # Was
+            # SELECT "people".* FROM "people" WHERE "people"."id" NOT IN (
+            #   SELECT "comments"."disabled" FROM "comments"
+            #   WHERE "comments"."disabled" = "people"."id"
+            #     AND NOT ("comments"."body" != 'some_title')
+            # ) ORDER BY "people"."id" DESC
+            # Should Be
+            # SELECT "people".* FROM "people" WHERE "people"."id" NOT IN (
+            #   SELECT "comments"."person_id" FROM "comments"
+            #   WHERE "comments"."person_id" = "people"."id"
+            #     AND NOT ("comments"."body" != 'some_title')
+            # ) ORDER BY "people"."id" DESC
+
+            expect(search.result.to_sql).to match /.comments.\..person_id. = .people.\..id./
+          end
         end
 
         describe 'sharing context across searches' do
@@ -91,23 +109,6 @@ module Ransack
               context: shared_context)
           end
 
-          describe '#join_associations', if: AR_version <= '4.0' do
-            it 'returns dependent join associations for all searches run
-                against the context' do
-              parents, children = shared_context.join_associations
-
-              expect(children.aliased_table_name).to eq "children_people"
-              expect(parents.aliased_table_name).to eq "parents_people"
-            end
-
-            it 'can be rejoined to execute a valid query' do
-              parents, children = shared_context.join_associations
-
-              expect { Person.joins(parents).joins(children).to_a }
-              .to_not raise_error
-            end
-          end
-
           describe '#join_sources' do
             it 'returns dependent arel join nodes for all searches run against
             the context' do