ransack 2.4.0 → 2.4.2

data/bug_report_templates/test-ransack-scope-and-column-same-name.rb

@@ -0,0 +1,78 @@
+# test-ransack-scope-and-column-same-name.rb
+
+# This is a stand-alone test case.
+
+# Run it in your console with: `ruby test-ransack-scope-and-column-same-name.rb`
+
+# If you change the gem dependencies, run it with:
+# `rm gemfile* && ruby test-ransack-scope-and-column-same-name.rb`
+
+unless File.exist?('Gemfile')
+  File.write('Gemfile', <<-GEMFILE)
+    source 'https://rubygems.org'
+
+    # Rails master
+    gem 'rails', github: 'rails/rails', branch: '6-1-stable'
+
+    # Rails last release
+    # gem 'rails'
+
+    gem 'sqlite3'
+    gem 'ransack', github: 'activerecord-hackery/ransack'
+  GEMFILE
+
+  system 'bundle install'
+end
+
+require 'bundler'
+Bundler.setup(:default)
+
+require 'active_record'
+require 'minitest/autorun'
+require 'logger'
+require 'ransack'
+
+# This connection will do for database-independent bug reports.
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+# Display versions.
+message = "Running test case with Ruby #{RUBY_VERSION}, Active Record #{
+  ::ActiveRecord::VERSION::STRING}, Arel #{Arel::VERSION} and #{
+  ::ActiveRecord::Base.connection.adapter_name}"
+line = '=' * message.length
+puts line, message, line
+
+ActiveRecord::Schema.define do
+  create_table :users, force: true do |t|
+    t.boolean :active, null: false, default: true
+  end
+end
+
+class User < ActiveRecord::Base
+  scope :activated, -> (boolean = true) { where(active: boolean) }
+
+  private
+
+  def self.ransackable_scopes(auth_object = nil)
+    %i(activated)
+  end
+end
+
+class BugTest < Minitest::Test
+  def test_activated_scope_equals_true
+    sql = User.ransack({ activated: true }).result.to_sql
+    puts sql
+    assert_equal(
+      "SELECT \"users\".* FROM \"users\" WHERE \"users\".\"active\" = 1", sql
+      )
+  end
+
+  def test_activated_scope_equals_false
+    sql = User.ransack({ activated: false }).result.to_sql
+    puts sql
+    assert_equal(
+      "SELECT \"users\".* FROM \"users\"", sql
+      )
+  end
+end

data/bug_report_templates/test-ransacker-arel-present-predicate.rb

@@ -0,0 +1,71 @@
+# test-ransacker-arel-present-predicate.rb
+
+# Run it in your console with: `ruby test-ransacker-arel-present-predicate.rb`
+
+# If you change the gem dependencies, run it with:
+# `rm gemfile* && ruby test-ransacker-arel-present-predicate.rb`
+
+unless File.exist?('Gemfile')
+  File.write('Gemfile', <<-GEMFILE)
+    source 'https://rubygems.org'
+
+    # Rails master
+    gem 'rails', github: 'rails/rails', branch: '6-1-stable'
+
+    # Rails last release
+    # gem 'rails'
+
+    gem 'sqlite3'
+    gem 'ransack', github: 'activerecord-hackery/ransack'
+  GEMFILE
+
+  system 'bundle install'
+end
+
+require 'bundler'
+Bundler.setup(:default)
+
+require 'active_record'
+require 'minitest/autorun'
+require 'logger'
+require 'ransack'
+
+# This connection will do for database-independent bug reports.
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+# Display versions.
+message = "Running test case with Ruby #{RUBY_VERSION}, Active Record #{
+  ::ActiveRecord::VERSION::STRING}, Arel #{Arel::VERSION} and #{
+  ::ActiveRecord::Base.connection.adapter_name}"
+line = '=' * message.length
+puts line, message, line
+
+ActiveRecord::Schema.define do
+  create_table :projects, force: true do |t|
+    t.string :name
+    t.string :number
+  end
+end
+
+class Project < ActiveRecord::Base
+  ransacker :name do
+    Arel.sql('projects.name')
+  end
+
+  ransacker :number do |parent|
+    parent.table[:number]
+  end
+end
+
+class BugTest < Minitest::Test
+  def test_ransackers
+    sql = Project.ransack({ number_present: 1 }).result.to_sql
+    puts sql
+    assert_equal "SELECT \"projects\".* FROM \"projects\" WHERE (\"projects\".\"number\" IS NOT NULL AND \"projects\".\"number\" != '')", sql
+
+    sql = Project.ransack({ name_present: 1 }).result.to_sql
+    puts sql
+    assert_equal "SELECT \"projects\".* FROM \"projects\" WHERE (projects.name IS NOT NULL AND projects.name != '')", sql
+  end
+end

data/docs/release_process.md

@@ -0,0 +1,20 @@
+## 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`.
+<<<<<<< Updated upstream
+- 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`.
+>>>>>>> Stashed changes
+- From the terminal, run the following commands
+
+```bash
+rake build
+rake release
+```
+
+![Create a Release](img/create_release.png)

data/lib/polyamorous/activerecord_6.2_ruby_2/join_association.rb

@@ -0,0 +1 @@
+require 'polyamorous/activerecord_6.1_ruby_2/join_association'

data/lib/polyamorous/activerecord_6.2_ruby_2/join_dependency.rb

@@ -0,0 +1 @@
+require 'polyamorous/activerecord_6.1_ruby_2/join_dependency'

data/lib/polyamorous/activerecord_6.2_ruby_2/reflection.rb

@@ -0,0 +1 @@
+require 'polyamorous/activerecord_6.1_ruby_2/reflection'

data/lib/polyamorous/polyamorous.rb

@@ -11,7 +11,7 @@ if defined?(::ActiveRecord)
   require 'polyamorous/join'
   require 'polyamorous/swapping_reflection_class'
 
-  ar_version = ::ActiveRecord::VERSION::STRING[0,3]
+  ar_version = ::ActiveRecord::VERSION::STRING[0, 3]
   %w(join_association join_dependency reflection).each do |file|
     require "polyamorous/activerecord_#{ar_version}_ruby_2/#{file}"
   end

data/lib/ransack.rb

@@ -1,13 +1,13 @@
 require 'active_support/core_ext'
 require 'ransack/configuration'
 require 'ransack/adapters'
-require 'polyamorous/polyamorous.rb'
+require 'polyamorous/polyamorous'
 
 Ransack::Adapters.object_mapper.require_constants
 
 module Ransack
   extend Configuration
-  class UntraversableAssociationError < StandardError; end;
+  class UntraversableAssociationError < StandardError; end
 end
 
 Ransack.configure do |config|

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

@@ -18,6 +18,10 @@ module Ransack
           Search.new(self, params, options)
         end
 
+        def ransack!(params = {}, options = {})
+          ransack(params, options.merge(ignore_unknown_conditions: false))
+        end
+
         def ransacker(name, opts = {}, &block)
           self._ransackers = _ransackers.merge name.to_s => Ransacker
             .new(self, name, opts, &block)

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

@@ -42,6 +42,13 @@ module Ransack
               if scope_or_sort.is_a?(Symbol)
                 relation = relation.send(scope_or_sort)
               else
+                case Ransack.options[:postgres_fields_sort_option]
+                when :nulls_first
+                  scope_or_sort = scope_or_sort.direction == :asc ? "#{scope_or_sort.to_sql} NULLS FIRST" : "#{scope_or_sort.to_sql} NULLS LAST"
+                when :nulls_last
+                  scope_or_sort = scope_or_sort.direction == :asc ? "#{scope_or_sort.to_sql} NULLS LAST" : "#{scope_or_sort.to_sql} NULLS FIRST"
+                end
+
                 relation = relation.order(scope_or_sort)
               end
             end
@@ -99,7 +106,7 @@ module Ransack
         def join_sources
           base, joins = begin
             alias_tracker = ::ActiveRecord::Associations::AliasTracker.create(self.klass.connection, @object.table.name, [])
-            constraints   = if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_1_ALPHA)
+            constraints   = if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_1)
               @join_dependency.join_constraints(@object.joins_values, alias_tracker, @object.references_values)
             elsif ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_0)
               @join_dependency.join_constraints(@object.joins_values, alias_tracker)
@@ -327,7 +334,7 @@ module Ransack
           @join_dependency.instance_variable_get(:@join_root).children.push found_association
 
           # Builds the arel nodes properly for this association
-          if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_1_ALPHA)
+          if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_1)
             @tables_pot[found_association] = @join_dependency.construct_tables_for_association!(jd.instance_variable_get(:@join_root), found_association)
           else
             @join_dependency.send(:construct_tables!, jd.instance_variable_get(:@join_root))
@@ -341,7 +348,7 @@ module Ransack
         def extract_joins(association)
           parent = @join_dependency.instance_variable_get(:@join_root)
           reflection = association.reflection
-          join_constraints = if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_1_ALPHA)
+          join_constraints = if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_1)
                                association.join_constraints_with_tables(
                                  parent.table,
                                  parent.base_klass,

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

@@ -97,7 +97,7 @@ module Ransack
         arel_predicate: proc { |v| v ? EQ : NOT_EQ },
         compounds: false,
         type: :boolean,
-        validator: proc { |v| BOOLEAN_VALUES.include?(v)},
+        validator: proc { |v| BOOLEAN_VALUES.include?(v) },
         formatter: proc { |v| nil }
         }
       ],

data/lib/ransack/configuration.rb

@@ -33,7 +33,8 @@ module Ransack
       :up_arrow => '▼'.freeze,
       :down_arrow => '▲'.freeze,
       :default_arrow => nil,
-      :sanitize_scope_args => true
+      :sanitize_scope_args => true,
+      :postgres_fields_sort_option => nil
     }
 
     def configure
@@ -141,6 +142,21 @@ module Ransack
       self.options[:sanitize_scope_args] = boolean
     end
 
+    # The `NULLS FIRST` and `NULLS LAST` options can be used to determine
+    # whether nulls appear before or after non-null values in the sort ordering.
+    #
+    # User may want to configure it like this:
+    #
+    # Ransack.configure do |c|
+    #   c.postgres_fields_sort_option = :nulls_first # or :nulls_last
+    # end
+    #
+    # See this feature: https://www.postgresql.org/docs/13/queries-order.html
+    #
+    def postgres_fields_sort_option=(setting)
+      self.options[:postgres_fields_sort_option] = setting
+    end
+
     # By default, Ransack displays sort order indicator arrows in sort links.
     # The default may be globally overridden in an initializer file like
     # `config/initializers/ransack.rb` as follows:

data/lib/ransack/constants.rb

@@ -36,7 +36,7 @@ module Ransack
       'lt'.freeze, 'lteq'.freeze,
       'gt'.freeze, 'gteq'.freeze,
       'in'.freeze, 'not_in'.freeze
-      ].freeze
+    ].freeze
     A_S_I               = ['a'.freeze, 's'.freeze, 'i'.freeze].freeze
 
     EQ                  = 'eq'.freeze
@@ -46,10 +46,9 @@ module Ransack
     CONT                = 'cont'.freeze
 
     RAILS_6_0           = '6.0.0'.freeze
-    RAILS_6_1_ALPHA     = '6.1.0.alpha'.freeze
+    RAILS_6_1           = '6.1.0'.freeze
 
     RANSACK_SLASH_SEARCHES = 'ransack/searches'.freeze
     RANSACK_SLASH_SEARCHES_SLASH_SEARCH = 'ransack/searches/search'.freeze
   end
 end
-

data/lib/ransack/helpers.rb

@@ -1,2 +1,2 @@
 require 'ransack/helpers/form_builder'
-require 'ransack/helpers/form_helper'
+require 'ransack/helpers/form_helper'

data/lib/ransack/helpers/form_builder.rb

@@ -45,9 +45,9 @@ module Ransack
       end
 
       def attribute_select(options = nil, html_options = nil, action = nil)
-        options = options || {}
-        html_options = html_options || {}
-        action = action || Constants::SEARCH
+        options ||= {}
+        html_options ||= {}
+        action ||= Constants::SEARCH
         default = options.delete(:default)
         raise ArgumentError, formbuilder_error_message(
           "#{action}_select") unless object.respond_to?(:context)

data/lib/ransack/nodes/attribute.rb

@@ -30,7 +30,7 @@ module Ransack
 
       def type
         if ransacker
-          return ransacker.type
+          ransacker.type
         else
           context.type_for(self)
         end

data/lib/ransack/nodes/condition.rb

@@ -127,7 +127,6 @@ module Ransack
       alias :m= :combinator=
       alias :m :combinator
 
-
       # == build_attribute
       #
       #  This method was originally called from Nodes::Grouping#new_condition
@@ -263,7 +262,6 @@ module Ransack
         attr.attr
       end
 
-
       def default_type
         predicate.type || (attributes.first && attributes.first.type)
       end

data/lib/ransack/nodes/sort.rb

@@ -9,7 +9,7 @@ module Ransack
       class << self
         def extract(context, str)
           return unless str
-          attr, direction = str.split(/\s+/,2)
+          attr, direction = str.split(/\s+/, 2)
           self.new(context).build(name: attr, dir: direction)
         end
       end

data/lib/ransack/nodes/value.rb

@@ -50,7 +50,7 @@ module Ransack
           y, m, d = *[val].flatten
           m ||= 1
           d ||= 1
-          Date.new(y,m,d) rescue nil
+          Date.new(y, m, d) rescue nil
         end
       end
 

data/lib/ransack/search.rb

@@ -30,6 +30,7 @@ module Ransack
         )
       @scope_args = {}
       @sorts ||= []
+      @ignore_unknown_conditions = options[:ignore_unknown_conditions] == false ? false : true
       build(params.with_indifferent_access)
     end
 
@@ -45,7 +46,7 @@ module Ransack
           base.send("#{key}=", value)
         elsif @context.ransackable_scope?(key, @context.object)
           add_scope(key, value)
-        elsif !Ransack.options[:ignore_unknown_conditions]
+        elsif !Ransack.options[:ignore_unknown_conditions] || !@ignore_unknown_conditions
           raise ArgumentError, "Invalid search term #{key}"
         end
       end

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = '2.4.0'
+  VERSION = '2.4.2'
 end

data/ransack.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 $:.push File.expand_path("../lib", __FILE__)
 require "ransack/version"
 
@@ -6,12 +7,12 @@ 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"]
+  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.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 = '>= 2.6'
   s.license     = 'MIT'
 
   s.add_dependency 'activerecord', '>= 5.2.4'

data/spec/blueprints/articles.rb

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