ransack 1.8.10 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bd4bc9e3845ed5397dbff350844ec9c983bc19f2cc9f95c15db2a67d97ce3ee
-  data.tar.gz: 293cd8927a3623b7468e1feeddd7a9a37a7e68258f141504395e4894e4511614
+  metadata.gz: 35bd0ff11964ff0c0308e7b663a3284510e7f5da71f6799bf061992b6515b616
+  data.tar.gz: 415ef127b34f85c7fdcf48e1f66f764d060cefacfa3a9a3d013688ecc38a07da
 SHA512:
-  metadata.gz: 7e696c2625dd8fa6b3d5b732aadf561f99076cd252c5b44d2fc17049752734b386d6aa80c8afd7460621cd76f787d4690f435b5c00a13df98e4690fc80ef0ee7
-  data.tar.gz: e25d3732e1291ce17bc94895f444ce730def58d125fa93ed8f4d4b2048a3e030ed3529aad19fdba0ea76865da3fed53841629c7137b265796b6c051b78a3c052
+  metadata.gz: 56239015bf48bc38842fa9f09325a04dc047299c0f17da8429a9a1ea95cf3aedf9d07117da157cc036a8fb8280d2925cf318b62a7b66b8a99acaa8d8a48e4b30
+  data.tar.gz: 574ac22523e67dddce34c18a929a9624cde30de3c14e2c53d6476c8136f48541879c1fd4b89467786e3f128327f79f4b6617561de7d11d5fbf6f6e888d37a212

data/.gitignore

@@ -3,4 +3,3 @@
 Gemfile.lock
 pkg/*
 coverage/*
-.DS_Store

data/.travis.yml

@@ -7,6 +7,18 @@ rvm:
   - 2.2
 
 env:
+  - RAILS=5-2-stable DB=sqlite3
+  - RAILS=5-2-stable DB=mysql
+  - RAILS=5-2-stable DB=postgres
+
+  - RAILS=v5.2.1 DB=sqlite3
+  - RAILS=v5.2.1 DB=mysql
+  - RAILS=v5.2.1 DB=postgres
+
+  - RAILS=v5.2.0 DB=sqlite3
+  - RAILS=v5.2.0 DB=mysql
+  - RAILS=v5.2.0 DB=postgres
+
   - RAILS=5-1-stable DB=sqlite3
   - RAILS=5-1-stable DB=mysql
   - RAILS=5-1-stable DB=postgres
@@ -15,9 +27,6 @@ env:
   - RAILS=5-0-stable DB=mysql
   - RAILS=5-0-stable DB=postgres
 
-  - RAILS=4-2-stable DB=sqlite3
-  - RAILS=4-2-stable DB=mysql
-  - RAILS=4-2-stable DB=postgres
 matrix:
   allow_failures:
     - env: RAILS=5-2-stable DB=sqlite3

data/CHANGELOG.md

@@ -1,8 +1,32 @@
 # Change Log
 
-## Version 1.8.9 - 2018-08-09
+## Unreleased
 
-* Locked Active Record compatibiity at 5.1.0
+## Version 2.0.0 - 2018-08-09
+
+* Add support for Active Record 5.2.1
+  PR [#938](https://github.com/activerecord-hackery/ransack/pull/938)
+
+* Fix sort with joins on existing association
+  PR [#937](https://github.com/activerecord-hackery/ransack/pull/937)
+
+* Add the ability to skip arg sanitization on a per scope basis. Using
+  `ransackable_scopes_skip_sanitize_args`, users can define a list of
+  scopes which will bypass parameter sanitization. This allows passing 0,
+  1, t, f, etc. to a scope as an actual parameter.
+  PR [#933](https://github.com/activerecord-hackery/ransack/pull/933)
+
+* Drop support for Active Record < 5.0.
+  PR [#929](https://github.com/activerecord-hackery/ransack/pull/929)
+
+* Extract mongoid support to a separate gem.
+  PR [#928](https://github.com/activerecord-hackery/ransack/pull/928)
+
+* Absorb polyamorous
+  PR [#927](https://github.com/activerecord-hackery/ransack/pull/927)
+
+* Fix broken monkey patch of #form_with
+  PR [#922](https://github.com/activerecord-hackery/ransack/pull/922)
 
 ## Version 1.8.8 - 2018-03-16
 * Fix multiple database support
@@ -19,14 +43,14 @@
 
 * Rails 5.2 support
   PR [#868](https://github.com/activerecord-hackery/ransack/pull/868)
- 
+
 * Lock pg gem to 0.21 to support older releases
 
 * Warnings cleanup
   PR [#867](https://github.com/activerecord-hackery/ransack/pull/867)
 
 * Wildcard escaping
-  PR [#866] 
+  PR [#866]
 
 ## Version 1.8.6 - 2018-01-23
 
@@ -40,7 +64,7 @@
 
 ## Version 1.8.5
 
-### Added  
+### Added
 
 * Added Turkish Translations
   PR [#835](https://github.com/activerecord-hackery/ransack/issues/835).

data/Gemfile

@@ -22,7 +22,7 @@ when /^v/ # A tagged version
     gem 'activerecord', require: false
     gem 'actionpack'
   end
-  if rails == 'v5.2.0'
+  if rails >= 'v5.2.0'
     gem 'mysql2', '~> 0.4.4'
   end
 else
@@ -40,14 +40,6 @@ else
   end
 end
 
-if ENV['DB'] =~ /mongoid4/
-  gem 'mongoid', '~> 4.0.0', require: false
-end
-
-if ENV['DB'] =~ /mongoid5/
-  gem 'mongoid', '~> 5.0.0', require: false
-end
-
 group :test do
   # TestUnit was removed from Ruby 2.2 but still needed for testing Rails 3.x.
   gem 'test-unit', '~> 3.0' if RUBY_VERSION >= '2.2'

data/README.md

@@ -1,28 +1,5 @@
 # Ransack
 
-### Maintainer Wanted
-
-A note from [Sean](https://github.com/seanfcarroll).
-Ransack is a fantastic gem, and a key part of many Rails projects. It is also a core component of [ActiveAdmin](https://github.com/activeadmin/activeadmin) and generally a great way to add fairly complex search and filtering without having to resort to external services, such as Elasticsearch.
-
-In my humble opinion, Ransack can be much more, if it does a bit less. What I mean is that the API vector of Ransack is quite large, and really has been issue-driven. There are complications with Polymorphic relations, complex joins and MongoDB. It's not clear sometimes if there is a bug or not.
-
-I was hoping to lead Ransack to version 2.0, and in my opinion this would have included:
-
-- Absorbing Polyamorous
-- Splitting MongoDB support into a seperate gem
-- Dropping support for older Rails versions; strictly follow the [Rails support policy](http://guides.rubyonrails.org/maintenance_policy.html). This is important as the codebase is littered with code for de-supported Rails versions
-- Add a generator to build in Ransack with a scaffold
-- Generate tests for Ransack-enabled applications
-- Update the Wiki / docs with lots of examples of 'how-to', questions are the majority of issues on Ransack
-- Increase supported translations
-
-Unfortunately I am quite occupied at present with several projects, including [crowdAI](https://github.com/crowdAI/crowdai), and I will need to step down as a maintainer. I have also posted it [here](https://github.com/pickhardt/maintainers-wanted).
-
-If you want to step up, please contact me on gmail as **sfcarroll**
-
-
-
 [![Build Status](https://travis-ci.org/activerecord-hackery/ransack.svg)](https://travis-ci.org/activerecord-hackery/ransack)
 [![Gem Version](https://badge.fury.io/rb/ransack.svg)](http://badge.fury.io/rb/ransack)
 [![Code Climate](https://codeclimate.com/github/activerecord-hackery/ransack/badges/gpa.svg)](https://codeclimate.com/github/activerecord-hackery/ransack)
@@ -448,7 +425,7 @@ List of all possible predicates
 | `*_lteq` | less than or equal | |
 | `*_gt` | greater than | |
 | `*_gteq` | greater than or equal | |
-| `*_present` | not null and not empty | e.g. `q[name_present]=1` (SQL: `col is not null AND col != ''`) |
+| `*_present` | not null and not empty | Only compatible with string columns. Example: `q[name_present]=1` (SQL: `col is not null AND col != ''`) |
 | `*_blank` | is null or empty. | (SQL: `col is null OR col = ''`) |
 | `*_null` | is null | |
 | `*_not_null` | is not null | |
@@ -734,7 +711,7 @@ boolean. This is currently resolved in Rails 5 :smiley:
 However, perhaps you have `user_id: [1]` and you do not want Ransack to convert
 1 into a boolean. (Values sanitized to booleans can be found in the
 [constants.rb](https://github.com/activerecord-hackery/ransack/blob/master/lib/ransack/constants.rb#L28)).
-To turn this off, and handle type conversions yourself, set
+To turn this off globally, and handle type conversions yourself, set
 `sanitize_custom_scope_booleans` to false in an initializer file like
 config/initializers/ransack.rb:
 
@@ -744,6 +721,19 @@ Ransack.configure do |c|
 end
 ```
 
+To turn this off on a per-scope basis Ransack adds the following method to 
+`ActiveRecord::Base` that you can redefine to selectively override sanitization:
+
+`ransackable_scopes_skip_sanitize_args`
+
+Add the scope you wish to bypass this behavior to ransackable_scopes_skip_sanitize_args:
+
+```ruby
+def ransackable_scopes_skip_sanitize_args
+  [:scope_to_skip_sanitize_args]
+end
+```
+
 Scopes are a recent addition to Ransack and currently have a few caveats:
 First, a scope involving child associations needs to be defined in the parent
 table model, not in the child model. Second, scopes with an array as an
@@ -875,6 +865,7 @@ en:
 
 ## Mongoid
 
+Mongoid support has been moved to its own gem at [ransack-mongoid](https://github.com/activerecord-hackery/ransack-mongoid).
 Ransack works with Mongoid in the same way as Active Record, except that with
 Mongoid, associations are not currently supported. Demo source code may be found
 [here](https://github.com/Zhomart/ransack-mongodb-demo). A `result` method

data/Rakefile

@@ -11,17 +11,8 @@ RSpec::Core::RakeTask.new(:spec) do |rspec|
   # rspec.rspec_opts = ['--backtrace']
 end
 
-RSpec::Core::RakeTask.new(:mongoid) do |rspec|
-  ENV['SPEC'] = 'spec/mongoid/**/*_spec.rb'
-  rspec.rspec_opts = ['--backtrace']
-end
-
 task :default do
-  if ENV['DB'] =~ /mongoid/
-    Rake::Task["mongoid"].invoke
-  else
-    Rake::Task["spec"].invoke
-  end
+  Rake::Task["spec"].invoke
 end
 
 desc "Open an irb session with Ransack and the sample data used in specs"
@@ -31,15 +22,3 @@ task :console do
   ARGV.clear
   Pry.start
 end
-
-desc "Open an irb session with Ransack, Mongoid and the sample data used in specs"
-task :mongoid_console do
-  require 'irb'
-  require 'irb/completion'
-  require 'pry'
-  require 'mongoid'
-  require File.expand_path('../lib/ransack.rb', __FILE__)
-  require File.expand_path('../spec/mongoid/support/schema.rb', __FILE__)
-  ARGV.clear
-  Pry.start
-end

data/lib/polyamorous.rb

@@ -24,28 +24,15 @@ if defined?(::ActiveRecord)
   require 'polyamorous/swapping_reflection_class'
 
   ar_version = ::ActiveRecord::VERSION::STRING[0,3]
-  ar_version = '3_and_4.0' if ar_version < '4.1'
-  ar_version = ::ActiveRecord::VERSION::STRING[0,5] if ar_version == '5.2'
-
-  method, ruby_version =
-    if RUBY_VERSION >= '2.0' && ar_version >= '4.1'
-      # Ruby 2; we can use `prepend` to patch Active Record cleanly.
-      [:prepend, '2']
-    else
-      # Ruby 1.9; we must use `alias_method` to patch Active Record.
-      [:include, '1.9']
-    end
+  ar_version = ::ActiveRecord::VERSION::STRING[0,5] if ar_version >= '5.2'
 
   %w(join_association join_dependency).each do |file|
-    require "polyamorous/activerecord_#{ar_version}_ruby_#{ruby_version}/#{file}"
+    require "polyamorous/activerecord_#{ar_version}_ruby_2/#{file}"
   end
 
-  Polyamorous::JoinDependency.send(method, Polyamorous::JoinDependencyExtensions)
-  if method == :prepend
-    Polyamorous::JoinDependency.singleton_class
-    .send(:prepend, Polyamorous::JoinDependencyExtensions::ClassMethods)
-  end
-  Polyamorous::JoinAssociation.send(method, Polyamorous::JoinAssociationExtensions)
+  Polyamorous::JoinDependency.send(:prepend, Polyamorous::JoinDependencyExtensions)
+  Polyamorous::JoinDependency.singleton_class.send(:prepend, Polyamorous::JoinDependencyExtensions::ClassMethods)
+  Polyamorous::JoinAssociation.send(:prepend, Polyamorous::JoinAssociationExtensions)
 
   Polyamorous::JoinBase.class_eval do
     if method_defined?(:active_record)

data/lib/polyamorous/activerecord_5.1_ruby_2/join_dependency.rb

@@ -9,7 +9,7 @@ module Polyamorous
         if name.is_a? Join
           reflection = find_reflection base_klass, name.name
           reflection.check_validity!
-          reflection.check_eager_loadable! if ActiveRecord::VERSION::MAJOR >= 5
+          reflection.check_eager_loadable!
 
           klass = if reflection.polymorphic?
                     name.klass || base_klass
@@ -20,7 +20,7 @@ module Polyamorous
         else
           reflection = find_reflection base_klass, name
           reflection.check_validity!
-          reflection.check_eager_loadable! if ActiveRecord::VERSION::MAJOR >= 5
+          reflection.check_eager_loadable!
 
           if reflection.polymorphic?
             raise ActiveRecord::EagerLoadPolymorphicError.new(reflection)

data/lib/polyamorous/activerecord_5.2.0_ruby_2/join_dependency.rb

@@ -9,7 +9,7 @@ module Polyamorous
         if name.is_a? Join
           reflection = find_reflection base_klass, name.name
           reflection.check_validity!
-          reflection.check_eager_loadable! if ActiveRecord::VERSION::MAJOR >= 5
+          reflection.check_eager_loadable!
 
           klass = if reflection.polymorphic?
             name.klass || base_klass
@@ -20,7 +20,7 @@ module Polyamorous
         else
           reflection = find_reflection base_klass, name
           reflection.check_validity!
-          reflection.check_eager_loadable! if ActiveRecord::VERSION::MAJOR >= 5
+          reflection.check_eager_loadable!
 
           if reflection.polymorphic?
             raise ActiveRecord::EagerLoadPolymorphicError.new(reflection)

data/lib/polyamorous/activerecord_5.2.1_ruby_2/join_association.rb

@@ -0,0 +1,38 @@
+# active_record_5.2.1_ruby_2/join_association.rb
+
+module Polyamorous
+  module JoinAssociationExtensions
+    include SwappingReflectionClass
+    def self.prepended(base)
+      base.class_eval { attr_reader :join_type }
+    end
+
+    def initialize(reflection, children, polymorphic_class = nil, join_type = Arel::Nodes::InnerJoin)
+      @join_type = join_type
+      if polymorphic_class && ::ActiveRecord::Base > polymorphic_class
+        swapping_reflection_klass(reflection, polymorphic_class) do |reflection|
+          super(reflection, children)
+          self.reflection.options[:polymorphic] = true
+        end
+      else
+        super(reflection, children)
+      end
+    end
+
+    # Reference: https://github.com/rails/rails/commit/9b15db5
+    # NOTE: Not sure we still need it?
+    #
+    def ==(other)
+      base_klass == other.base_klass
+    end
+
+    def build_constraint(klass, table, key, foreign_table, foreign_key)
+      if reflection.polymorphic?
+        super(klass, table, key, foreign_table, foreign_key)
+        .and(foreign_table[reflection.foreign_type].eq(reflection.klass.name))
+      else
+        super(klass, table, key, foreign_table, foreign_key)
+      end
+    end
+  end
+end

data/lib/polyamorous/activerecord_5.2.1_ruby_2/join_dependency.rb

@@ -0,0 +1,75 @@
+# active_record_5.2.1_ruby_2/join_dependency.rb
+
+module Polyamorous
+  module JoinDependencyExtensions
+    # Replaces ActiveRecord::Associations::JoinDependency#build
+    #
+    def build(associations, base_klass)
+      associations.map do |name, right|
+        if name.is_a? Join
+          reflection = find_reflection base_klass, name.name
+          reflection.check_validity!
+          reflection.check_eager_loadable!
+
+          klass = if reflection.polymorphic?
+            name.klass || base_klass
+          else
+            reflection.klass
+          end
+          JoinAssociation.new(reflection, build(right, klass), name.klass, name.type)
+        else
+          reflection = find_reflection base_klass, name
+          reflection.check_validity!
+          reflection.check_eager_loadable!
+
+          if reflection.polymorphic?
+            raise ActiveRecord::EagerLoadPolymorphicError.new(reflection)
+          end
+          JoinAssociation.new(reflection, build(right, reflection.klass))
+        end
+      end
+    end
+
+    def find_join_association_respecting_polymorphism(reflection, parent, klass)
+      if association = parent.children.find { |j| j.reflection == reflection }
+        unless reflection.polymorphic?
+          association
+        else
+          association if association.base_klass == klass
+        end
+      end
+    end
+
+    def build_join_association_respecting_polymorphism(reflection, parent, klass)
+      if reflection.polymorphic? && klass
+        JoinAssociation.new(reflection, self, klass)
+      else
+        JoinAssociation.new(reflection, self)
+      end
+    end
+
+    module ClassMethods
+      # Prepended before ActiveRecord::Associations::JoinDependency#walk_tree
+      #
+      def walk_tree(associations, hash)
+        case associations
+        when TreeNode
+          associations.add_to_tree(hash)
+        when Hash
+          associations.each do |k, v|
+            cache =
+              if TreeNode === k
+                k.add_to_tree(hash)
+              else
+                hash[k] ||= {}
+              end
+            walk_tree(v, cache)
+          end
+        else
+          super(associations, hash)
+        end
+      end
+    end
+
+  end
+end

data/lib/ransack/adapters/active_record.rb

@@ -12,12 +12,3 @@ ActiveSupport.on_load(:active_record) do
 end
 
 require 'ransack/adapters/active_record/context'
-
-case ActiveRecord::VERSION::STRING
-when /^3\.0\./
-  require 'ransack/adapters/active_record/3.0/context'
-when /^3\.1\./
-  require 'ransack/adapters/active_record/3.1/context'
-when /^3\.2\./
-  require 'ransack/adapters/active_record/3.2/context'
-end

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

@@ -64,6 +64,14 @@ module Ransack
           []
         end
 
+        # ransack_scope_skip_sanitize_args, by default, returns an empty array.
+        # i.e. use the sanitize_scope_args setting to determin if args should be converted.
+        # For overriding with a list of scopes which should be passed the args as-is.
+        #
+        def ransackable_scopes_skip_sanitize_args
+          []
+        end
+
       end
     end
   end