ransack 2.6.0 → 3.0.0

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

@@ -4,7 +4,6 @@ module Ransack
       module Base
 
         def self.extended(base)
-          alias :search :ransack unless base.respond_to? :search
           base.class_eval do
             class_attribute :_ransackers
             class_attribute :_ransack_aliases
@@ -14,7 +13,6 @@ module Ransack
         end
 
         def ransack(params = {}, options = {})
-          ActiveSupport::Deprecation.warn("#search is deprecated and will be removed in 2.3, please use #ransack instead") if __callee__ == :search
           Search.new(self, params, options)
         end
 

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

@@ -143,6 +143,7 @@ module Ransack
             stashed.eql?(association)
           }
           @object.joins_values.delete_if { |jd|
+            jd.instance_variables.include?(:@join_root) &&
             jd.instance_variable_get(:@join_root).children.map(&:object_id) == [association.object_id]
           }
         end

data/lib/ransack/helpers/form_helper.rb

@@ -130,12 +130,20 @@ module Ransack
 
         def url_options
           @params.merge(
-            @options.merge(
+            @options.except(:class).merge(
               @search.context.search_key => search_and_sort_params))
         end
 
         def html_options(args)
-          html_options = extract_options_and_mutate_args!(args)
+          if args.empty?
+            html_options = @options
+          else
+            deprecation_message = "Passing two trailing hashes to `sort_link` is deprecated, merge the trailing hashes into a single one."
+            caller_location = caller_locations(2, 2).first
+            warn "#{deprecation_message} (called at #{caller_location.path}:#{caller_location.lineno})"
+            html_options = extract_options_and_mutate_args!(args)
+          end
+
           html_options.merge(
             class: [['sort_link'.freeze, @current_dir], html_options[:class]]
                    .compact.join(' '.freeze)

data/lib/ransack/search.rb

@@ -43,10 +43,10 @@ module Ransack
       collapse_multiparameter_attributes!(params).each do |key, value|
         if ['s'.freeze, 'sorts'.freeze].freeze.include?(key)
           send("#{key}=", value)
-        elsif base.attribute_method?(key)
-          base.send("#{key}=", value)
         elsif @context.ransackable_scope?(key, @context.object)
           add_scope(key, value)
+        elsif base.attribute_method?(key)
+          base.send("#{key}=", value)
         elsif !Ransack.options[:ignore_unknown_conditions] || !@ignore_unknown_conditions
           raise ArgumentError, "Invalid search term #{key}"
         end

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = '2.6.0'
+  VERSION = '3.0.0'
 end

data/ransack.gemspec

@@ -7,10 +7,10 @@ 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.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.6'
   s.license     = 'MIT'

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 }
@@ -78,6 +77,16 @@ module Ransack
               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 }

data/spec/ransack/helpers/form_helper_spec.rb

@@ -726,6 +726,38 @@ module Ransack
         it { should match /Block label ▼/ }
       end
 
+      describe '#sort_link with class option' do
+        subject { @controller.view_context
+          .sort_link(
+            [:main_app, Person.ransack(sorts: ['name desc'])],
+            :name,
+            class: 'people', controller: 'people'
+          )
+        }
+        it { should match /class="sort_link desc people"/ }
+        it { should_not match /people\?class=people/ }
+      end
+
+      describe '#sort_link with class option workaround' do
+        it "generates a correct link and prints a deprecation" do
+          expect do
+            link = @controller.view_context
+              .sort_link(
+                [:main_app, Person.ransack(sorts: ['name desc'])],
+                :name,
+                'name',
+                { controller: 'people' },
+                class: 'people'
+              )
+
+            expect(link).to match(/class="sort_link desc people"/)
+            expect(link).not_to match(/people\?class=people/)
+          end.to output(
+            /Passing two trailing hashes to `sort_link` is deprecated, merge the trailing hashes into a single one\. \(called at #{Regexp.escape(__FILE__)}:/
+          ).to_stderr
+        end
+      end
+
       describe '#search_form_for with default format' do
         subject { @controller.view_context
           .search_form_for(Person.ransack) {} }

data/spec/ransack/search_spec.rb

@@ -312,6 +312,29 @@ module Ransack
         expect { Search.new(Person, params) }.not_to change { params }
       end
 
+      context "ransackable_scope" do
+        around(:each) do |example|
+          Person.define_singleton_method(:name_eq) do |name|
+            self.where(name: name)
+          end
+
+          begin
+            example.run
+          ensure
+            Person.singleton_class.undef_method :name_eq
+          end
+        end
+
+        it "is prioritized over base predicates" do
+          allow(Person).to receive(:ransackable_scopes)
+            .and_return(Person.ransackable_scopes + [:name_eq])
+
+          s = Search.new(Person, name_eq: "Johny")
+          expect(s.instance_variable_get(:@scope_args)["name_eq"]).to eq("Johny")
+          expect(s.base[:name_eq]).to be_nil
+        end
+      end
+
     end
 
     describe '#result' do

data/spec/support/schema.rb

@@ -138,6 +138,22 @@ class Article < ActiveRecord::Base
   alias_attribute :content, :body
 
   default_scope { where("'default_scope' = 'default_scope'") }
+  scope :latest_comment_cont, lambda { |msg|
+    join = <<-SQL
+      (LEFT OUTER JOIN (
+          SELECT
+            comments.*,
+            row_number() OVER (PARTITION BY comments.article_id ORDER BY comments.id DESC) AS rownum
+          FROM comments
+        ) AS latest_comment
+        ON latest_comment.article_id = article.id
+        AND latest_comment.rownum = 1
+      )
+    SQL
+    .squish
+
+    joins(join).where("latest_comment.body ILIKE ?", "%#{msg}%")
+  }
 
   ransacker :title_type, formatter: lambda { |tuples|
     title, type = JSON.parse(tuples)

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: ransack
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ernie Miller
 - Ryan Bigg
 - Jon Atack
 - Sean Carroll
+- David Rodríguez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -72,6 +73,7 @@ files:
 - ".github/workflows/rubocop.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".nojekyll"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -81,8 +83,58 @@ files:
 - Rakefile
 - bug_report_templates/test-ransack-scope-and-column-same-name.rb
 - bug_report_templates/test-ransacker-arel-present-predicate.rb
-- docs/img/create_release.png
-- docs/release_process.md
+- docs/.gitignore
+- docs/.nojekyll
+- docs/babel.config.js
+- docs/blog/2022-03-27-ransack-3.0.0.md
+- docs/docs/getting-started/_category_.json
+- docs/docs/getting-started/advanced-mode.md
+- docs/docs/getting-started/configuration.md
+- docs/docs/getting-started/search-matches.md
+- docs/docs/getting-started/simple-mode.md
+- docs/docs/getting-started/sorting.md
+- docs/docs/getting-started/using-predicates.md
+- docs/docs/going-further/_category_.json
+- docs/docs/going-further/associations.md
+- docs/docs/going-further/custom-predicates.md
+- docs/docs/going-further/documentation.md
+- docs/docs/going-further/exporting-to-csv.md
+- docs/docs/going-further/external-guides.md
+- docs/docs/going-further/form-customisation.md
+- docs/docs/going-further/i18n.md
+- docs/docs/going-further/img/create_release.png
+- docs/docs/going-further/merging-searches.md
+- docs/docs/going-further/other-notes.md
+- docs/docs/going-further/ransackers.md
+- docs/docs/going-further/release_process.md
+- docs/docs/going-further/saving-queries.md
+- docs/docs/going-further/searching-postgres.md
+- docs/docs/intro.md
+- docs/docusaurus.config.js
+- docs/package-lock.json
+- docs/package.json
+- docs/sidebars.js
+- docs/src/components/HomepageFeatures/index.js
+- docs/src/components/HomepageFeatures/styles.module.css
+- docs/src/css/custom.css
+- docs/src/pages/index.module.css
+- docs/src/pages/markdown-page.md
+- docs/static/.nojekyll
+- docs/static/img/docusaurus.png
+- docs/static/img/favicon.ico
+- docs/static/img/logo.svg
+- docs/static/img/tutorial/docsVersionDropdown.png
+- docs/static/img/tutorial/localeDropdown.png
+- docs/static/img/undraw_docusaurus_mountain.svg
+- docs/static/img/undraw_docusaurus_react.svg
+- docs/static/img/undraw_docusaurus_tree.svg
+- docs/static/logo/ransack-h.png
+- docs/static/logo/ransack-h.svg
+- docs/static/logo/ransack-v.png
+- docs/static/logo/ransack-v.svg
+- docs/static/logo/ransack.png
+- docs/static/logo/ransack.svg
+- docs/yarn.lock
 - lib/polyamorous.rb
 - lib/polyamorous/activerecord_6.0_ruby_2/join_association.rb
 - lib/polyamorous/activerecord_6.0_ruby_2/join_dependency.rb
@@ -154,12 +206,6 @@ files:
 - lib/ransack/translate.rb
 - lib/ransack/version.rb
 - lib/ransack/visitor.rb
-- logo/ransack-h.png
-- logo/ransack-h.svg
-- logo/ransack-v.png
-- logo/ransack-v.svg
-- logo/ransack.png
-- logo/ransack.svg
 - ransack.gemspec
 - spec/blueprints/articles.rb
 - spec/blueprints/comments.rb
@@ -205,10 +251,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: Object-based searching for Active Record and Mongoid (currently).
+summary: Object-based searching for Active Record.
 test_files:
 - spec/blueprints/articles.rb
 - spec/blueprints/comments.rb

data/docs/release_process.md

@@ -1,17 +0,0 @@
-## Release Process
-
-*For maintainers of Ransack.*
-
-To release a new version of Ransack and publish it to RubyGems, take the following steps:
-
-- Create a new release, marked `Prerelease`.
-- Update the versions file to the new release, commit and push to `master`.
-- Update the [`version.rb`](../lib/ransack/version.rb) file to the new release, commit and push to `master`.
-- From the terminal, run the following commands:
-
-```bash
-rake build
-rake release
-```
-
-![Create a Release](img/create_release.png)