ransack 1.6.4 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 954c9a11f9682b9e3fe5689c40d56d1978c24bb9
-  data.tar.gz: 58f30b75616e213c3afc8a91f92c8a940b4ac837
+  metadata.gz: ab38816eaa6fefc0b47ab0814d69ddf4f9dfbbf8
+  data.tar.gz: ed98ed6e4ede9c729fb05cc4ddfb00d646a79149
 SHA512:
-  metadata.gz: bcbd765da64c6a1919651d7e8544ee74eedf95d69c69b0e777fffc5ebc624fe6312ae6ef88f4789dcaa54a622787f5f67804bdcfd07025163cae71b6100c0fbd
-  data.tar.gz: 876abe7e9d6faf89b99b64e993645add3d1c64bca934c4066c5b97790c46401ed581df97b8ffdc98685a9fd7fd5d4885196374e7a2d9ac5c581a0caba10725bc
+  metadata.gz: 837ce300a188d1e7cf59eff19548d4dc1b1c817276249d83326b9b776b8ba3ae49072ebf1850e3437a54d70a1fafbf3473165856d88afdbb5f139d505ea4309d
+  data.tar.gz: d1cbcb0ec2d6876511b4624a93c9a85f3d5500705305faf8dc566e54c16c3d5572b5838882723d9ee3fc6df696dd5b3ccfe8dfbb73ed47008f782d42983e496c

data/.travis.yml

@@ -5,7 +5,7 @@ language: ruby
 sudo: false
 
 rvm:
-  - 2.2
+  - 2.2.1
   - 2.1
   - 2.0
   - 1.9
@@ -33,10 +33,6 @@ env:
   - RAILS=3-1-stable DB=mysql
   - RAILS=3-1-stable DB=postgres
 
-  - RAILS=3-0-stable DB=sqlite
-  - RAILS=3-0-stable DB=mysql
-  - RAILS=3-0-stable DB=postgres
-
 matrix:
   include:
     - rvm: 2.2
@@ -52,12 +48,6 @@ matrix:
       env: RAILS=3-1-stable DB=mysql
     - rvm: 2.2
       env: RAILS=3-1-stable DB=postgres
-    - rvm: 2.2
-      env: RAILS=3-0-stable DB=sqlite
-    - rvm: 2.2
-      env: RAILS=3-0-stable DB=mysql
-    - rvm: 2.2
-      env: RAILS=3-0-stable DB=postgres
   allow_failures:
     - env: RAILS=master DB=sqlite3
     - env: RAILS=master DB=mysql

data/CHANGELOG.md

@@ -1,6 +1,48 @@
 # Change Log
 
-## Version 1.6.4 - 2015-03-20
+## Version 1.6.5 - 2015-03-28 - Rails 5.0.0 update
+### Added
+
+*   [WIP/experimental] Add compatibility with Rails 5/master and Arel 7.
+
+*   Update the [Contributing Guide](CONTRIBUTING.md) with detailed steps for
+    contributing to Ransack.
+
+*   Broaden the test suite database options in `schema.rb` and add
+    code documentation.
+
+*   Improve the header message when running tests.
+
+    *Jon Atack*
+
+*   Allow `:wants_array` to be set to `false` in the predicate options
+    ([#32](https://github.com/activerecord-hackery/ransack/issues/32)).
+
+    *Michael Pavling*
+
+*   Add a failing spec for issue
+    [#374](https://github.com/activerecord-hackery/ransack/issues/374).
+
+    *Jamie Davidson*, *Jon Atack*
+
+### Fixed
+
+*   Stop relying on `Active Record::relation#where_values` which are deprecated
+    in Rails 5.
+
+*   Make the test for passing search arguments to a ransacker
+    (`ransacker_args`) work correctly with Sqlite3.
+
+    *Jon Atack*
+
+### Changed
+
+*   Stop CI testing for Rails 3.0 to reduce the size of the Travis test matrix.
+
+    *Jon Atack*
+
+
+## Version 1.6.4 - 2015-03-20 - Rails 4.2.1 update
 
 *   ActionView patch to maintain compatibility with Rails 4.2.1 released today.
 
@@ -16,6 +58,7 @@
 
     *Denis Tataurov*, *Jon Atack*
 
+
 ## Version 1.6.3 - 2015-01-21
 
 *   Fix a regression
@@ -147,24 +190,22 @@
 
 
 ## Version 1.5.1 - 2014-10-30
-### Fixed
-
-*   Fix a regression caused by incorrect string constants in `context.rb`.
-
-    *Kazuhiro Nishiyama*
-
 ### Added
 
 *   Add base specs for search on fields with `_start` and `_end`.
 
-    *Jon Atack*
-
 *   Add a failing spec for detecting attribute fields containing `_and_` that
     needs to be fixed. Attribute names containing `_and_` and `_or_` are still
     not parsed/detected correctly.
 
     *Jon Atack*
 
+### Fixed
+
+*   Fix a regression caused by incorrect string constants in `context.rb`.
+
+    *Kazuhiro Nishiyama*
+
 ### Changed
 
 *   Remove duplicate code in `spec/support/schema.rb`.
@@ -241,7 +282,6 @@
 
 
 ## Version 1.4.1 - 2014-09-23
-### Fixed
 
 *   Fix README markdown so RubyGems documentation picks up the formatting correctly.
 

data/CONTRIBUTING.md

@@ -34,7 +34,8 @@ if the information requested is provided.
 ## Pull requests
 
 We gladly accept pull requests to fix bugs and, in some circumstances, add new
-features to Ransack.
+features to Ransack. If you'd like to contribute and wonder what would be
+helpful, simply run a search for "FIXME" and "TODO" on the codebase :smiley:
 
 If you're new to contributing to open source, welcome! It can seem scary, so
 here is a [great blog post to help you get started]
@@ -47,37 +48,47 @@ backward compatibility has a very good reason for doing so.
 
 Here's a quick guide:
 
-1. Fork the repo, clone it, create a thoughtfully-named branch for your changes,
-   and install the development dependencies by running `bundle install`.
+1. Fork the repo.
 
-2. Begin by running the tests. We only take pull requests with passing tests,
+2. Create a thoughtfully-named branch for your changes (`git checkout -b my-new-feature`).
+
+3. Install the development dependencies by running `bundle install`.
+
+4. Begin by running the tests. We only take pull requests with passing tests,
    and it's great to know that you have a clean slate:
 
         $ bundle exec rake spec
 
-3. Hack away! Please use Ruby features that are compatible down to Ruby 1.9.
+   The test suite runs by default with SQLite3. To run the test suite with PostgreSQL or MySQL, use:
+
+        $ DB=postgresql bundle exec rake spec (`DB=pg` & `DB=postgres` work too)
+        $ DB=mysql bundle exec rake spec
+
+5. Hack away! Please use Ruby features that are compatible down to Ruby 1.9.
    Since version 1.5, Ransack no longer maintains Ruby 1.8 compatibility.
 
-4. Add tests for your changes. Only refactoring and documentation changes
+6. Add tests for your changes. Only refactoring and documentation changes
    require no new tests. If you are adding functionality or fixing a bug, we
    need a test!
 
-5. Make the tests pass.
+7. Make the tests pass.
 
-6. Update the Change Log. If you are adding new functionality, document it in
+8. Update the Change Log. If you are adding new functionality, document it in
    the README.
 
-7. Do not change the version number; we will do that on our end.
+9. Commit your changes (`git commit -am 'Add feature/fix bug/improve docs'`).
 
-8. If necessary, rebase your commits into logical chunks, without errors.
+10. If necessary, rebase your commits into logical chunks, without errors. To
+   interactively rebase and cherry-pick from, say, the last 10 commits:
+   `git rebase -i HEAD~10`, then `git push -f`.
 
-9. Push the branch up to your fork on Github and submit a pull request. If the
-   changes will apply cleanly to the latest stable branches and master branch,
-   you will only need to submit one pull request.
+11. Push the branch up to your fork on Github
+   (`git push origin my-new-feature`) and from Github submit a pull request to
+   Ransack's `master` branch.
 
-10. If your pull request only contains documentation changes, please remember to
-   add `[skip ci]` to your commit message so the Travis test suite doesn't run
-   needlessly.
+12. If your pull request only contains documentation changes, please remember
+   to add `[skip ci]` to the beginning of your commit message so the Travis
+   test suite doesn't :runner: needlessly.
 
 At this point you're waiting on us. We like to at least comment on, if not
 accept, pull requests within three business days (and, typically, one business
@@ -85,14 +96,14 @@ day). We may suggest some changes or improvements or alternatives.
 
 Some things that will increase the chance that your pull request is accepted:
 
-* Use idiomatic Ruby and follow the syntax conventions below.
 * Include tests that fail without your code, and pass with it.
 * Update the README, the change log, the wiki documentation... anything that is
   affected by your contribution.
+* Use idiomatic Ruby and follow the syntax conventions below.
 
 Syntax:
 
-* Two spaces, no tabs.
+* Indent with two spaces, no tabs.
 * 80 characters per line.
 * No trailing whitespace. Blank lines should not have any space.
 * Prefer `&&`/`||` over `and`/`or`.

data/README.md

@@ -27,17 +27,18 @@ instead.
 If you're viewing this at
 [github.com/activerecord-hackery/ransack](https://github.com/activerecord-hackery/ransack),
 you're reading the documentation for the master branch with the latest features.
-[View documentation for the last release (1.6.4).]
-(https://github.com/activerecord-hackery/ransack/tree/v1.6.4)
+[View documentation for the last release (1.6.5).]
+(https://github.com/activerecord-hackery/ransack/tree/v1.6.5)
 
 ## Getting started
 
-Ransack is compatible with Rails 3 and 4 (including 4.2) on Ruby 1.9 and later.
-We try to keep it functioning with Rails master too, although frequent changes
-in Arel and Active Record make that a moving target. Ransack works
-out-of-the-box with Active Record and features new support for Mongoid 4.0
-(without associations, further details below). If you are on Ruby 1.8, you may
-need to use an earlier version of Ransack like 1.3.0.
+Ransack is compatible with Rails 3 and 4 (including 4.2.1) on Ruby 1.9 and
+later. It currently works with Rails 5 as well, though changes in Arel and
+Active Record keep that a moving target. If you are using Ruby 1.8, you can use
+an earlier version of Ransack up to v1.3.0.
+
+Ransack works out-of-the-box with Active Record and also features experimental
+support for Mongoid 4.0 (without associations, further details below).
 
 In your Gemfile, for the last officially released Ransack gem:
 
@@ -51,29 +52,6 @@ Or, if you would like to use the latest updates, use the `master` branch:
 gem 'ransack', github: 'activerecord-hackery/ransack'
 ```
 
-The other branches (`rails-4`, `rails-4.1`, and `rails-4.2`) were each used for
-developing and running Ransack with the latest upcoming version of Rails at the
-time. They are smaller and possibly slightly faster because they do not have to
-support previous versions of Rails and Active Record. Once support for that
-Rails version is merged from the branch into Ransack master, the branch is no
-longer actively maintained -- unless the open source community submits pull
-requests to maintain them. You are welcome to do so!
-
-To use one of the branches, for example the `rails-4.1` branch:
-
-```ruby
-gem 'ransack', github: 'activerecord-hackery/ransack', branch: 'rails-4.1'
-```
-
-If you are using Rails master, be advised that Ransack master does not yet work
-with the breaking changes in Rails master and Arel master added since December
-2014. The most recent working commits are:
-
-```ruby
-gem 'rails', github: 'rails/rails', ref: '266ff70'
-gem 'arel', github: 'rails/arel', ref: '008445d'
-```
-
 ## Usage
 
 Ransack can be used in one of two modes, simple or advanced.

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

@@ -96,7 +96,7 @@ module Ransack
           def join_sources
             base =
               if ::ActiveRecord::VERSION::MAJOR >= 5
-                Arel::SelectManager.new(@object.engine)
+                Arel::SelectManager.new(@object.table)
               else
                 Arel::SelectManager.new(@object.engine, @object.table)
               end
@@ -171,39 +171,37 @@ module Ransack
           if relation.respond_to?(:join_dependency) # Squeel will enable this
             relation.join_dependency
           else
-            build_join_dependency(relation)
+            build_joins(relation)
           end
         end
 
         # Checkout active_record/relation/query_methods.rb +build_joins+ for
         # reference. Lots of duplicated code maybe we can avoid it
-        def build_join_dependency(relation)
+        def build_joins(relation)
           buckets = relation.joins_values.group_by do |join|
             case join
             when String
-              Constants::STRING_JOIN
+              :string_join
             when Hash, Symbol, Array
-              Constants::ASSOCIATION_JOIN
-            when JoinDependency, JoinDependency::JoinAssociation
-              Constants::STASHED_JOIN
+              :association_join
+            when ActiveRecord::Associations::JoinDependency
+              :stashed_join
             when Arel::Nodes::Join
-              Constants::JOIN_NODE
+              :join_node
             else
               raise 'unknown class: %s' % join.class.name
             end
           end
-
-          association_joins = buckets[Constants::ASSOCIATION_JOIN] || []
-
-          stashed_association_joins = buckets[Constants::STASHED_JOIN] || []
-
-          join_nodes = buckets[Constants::JOIN_NODE] || []
-
-          string_joins = (buckets[Constants::STRING_JOIN] || []).map(&:strip).uniq
+          buckets.default = []
+          association_joins         = buckets[:association_join]
+          stashed_association_joins = buckets[:stashed_join]
+          join_nodes                = buckets[:join_node].uniq
+          string_joins              = buckets[:string_join].map(&:strip).uniq
 
           join_list =
             if ::ActiveRecord::VERSION::MAJOR >= 5
-              relation.send :custom_join_ast, relation.table.from, string_joins
+              join_nodes +
+              convert_join_strings_to_ast(relation.table, string_joins)
             else
               relation.send :custom_join_ast,
                 relation.table.from(relation.table), string_joins
@@ -224,6 +222,13 @@ module Ransack
           end
         end
 
+        def convert_join_strings_to_ast(table, joins)
+          joins
+          .flatten
+          .reject(&:blank?)
+          .map { |join| table.create_string_join(Arel.sql(join)) }
+        end
+
         if ::ActiveRecord::VERSION::STRING >= Constants::RAILS_4_1
 
           def build_or_find_association(name, parent = @base, klass = nil)

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

@@ -37,7 +37,7 @@ module Ransack
       end
 
       @default_table = Arel::Table.new(
-        @base.table_name, :as => @base.aliased_table_name, :engine => @engine
+        @base.table_name, as: @base.aliased_table_name, type_caster: self
         )
       @bind_pairs = Hash.new do |hash, key|
         parent, attr_name = get_parent_and_attribute_name(key.to_s)

data/lib/ransack/predicate.rb

@@ -48,8 +48,8 @@ module Ransack
       @validator = opts[:validator] ||
         lambda { |v| v.respond_to?(:empty?) ? !v.empty? : !v.nil? }
       @compound = opts[:compound]
-      @wants_array = opts[:wants_array] == true || @compound ||
-        Constants::IN_NOT_IN.include?(@arel_predicate)
+      @wants_array = opts.fetch(:wants_array,
+        @compound || Constants::IN_NOT_IN.include?(@arel_predicate))
     end
 
     def eql?(other)

data/lib/ransack/translate.rb

@@ -150,11 +150,6 @@ module Ransack
     end
 
     def self.i18n_key(klass)
-      # if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 0
-      #   klass.model_name.i18n_key.to_s.tr('.', '/')
-      # else
-      #   klass.model_name.i18n_key.to_s
-      # end
       raise "not implemented"
     end
   end

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = "1.6.4"
+  VERSION = "1.6.5"
 end

data/spec/mongoid/configuration_spec.rb

@@ -62,5 +62,41 @@ module Ransack
       expect(Ransack.predicates).not_to have_key 'test_array_predicate_any'
       expect(Ransack.predicates).not_to have_key 'test_array_predicate_all'
     end
+
+    describe '`wants_array` option takes precedence over Arel predicate' do
+      it 'implicitly wants an array for in/not in predicates' do
+        Ransack.configure do |config|
+          config.add_predicate(
+            :test_in_predicate,
+            :arel_predicate => 'in'
+          )
+          config.add_predicate(
+            :test_not_in_predicate,
+            :arel_predicate => 'not_in'
+          )
+        end
+
+        expect(Ransack.predicates['test_in_predicate'].wants_array).to eq true
+        expect(Ransack.predicates['test_not_in_predicate'].wants_array).to eq true
+      end
+
+      it 'explicitly does not want array for in/not_in predicates' do
+        Ransack.configure do |config|
+          config.add_predicate(
+            :test_in_predicate_no_array,
+            :arel_predicate => 'in',
+            :wants_array => false
+          )
+          config.add_predicate(
+            :test_not_in_predicate_no_array,
+            :arel_predicate => 'not_in',
+            :wants_array => false
+          )
+        end
+
+        expect(Ransack.predicates['test_in_predicate_no_array'].wants_array).to eq false
+        expect(Ransack.predicates['test_not_in_predicate_no_array'].wants_array).to eq false
+      end
+    end
   end
 end

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

@@ -71,7 +71,7 @@ module Ransack
           end
 
           it 'does not raise exception for string :params argument' do
-            lambda { Person.ransack('') }.should_not raise_error
+            expect { Person.ransack('') }.to_not raise_error
           end
 
           it 'does not modify the parameters' do
@@ -319,19 +319,20 @@ module Ransack
               c: [{
                 a: {
                   '0' => {
-                    name: 'with_passed_arguments', ransacker_args: [10, 100]
+                    name: 'with_arguments', ransacker_args: [10, 100]
                   }
                 },
                 p: 'cont',
-                v: ['Rails has been released']
+                v: ['Passing arguments to ransackers!']
               }]
             )
             expect(s.result.to_sql).to match(
-              /CHAR_LENGTH\(articles.body\) BETWEEN 10 AND 100/
+              /LENGTH\(articles.body\) BETWEEN 10 AND 100/
             )
             expect(s.result.to_sql).to match(
-              /LIKE \'\%Rails has been released\%\'/
-            )
+              /LIKE \'\%Passing arguments to ransackers!\%\'/
+              )
+            expect { s.result.first }.to_not raise_error
           end
         end