ransack 1.8.1 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0000005ab1d9a09827cede9e9d949a7b87308f75
-  data.tar.gz: 72f3bddda6c78c9014b6a4fb1c6e49a622c9e7f2
+  metadata.gz: d6c89a751336d525190857c926e5621b2f1bd911
+  data.tar.gz: b1f8e83f8d95332438067b02f9bfff030700c7e4
 SHA512:
-  metadata.gz: 0fcba1e08c4c8a1096182999c56da5765c9acb8adbb6ccc1e15870b436c9420baafb755ae5988568e14dee0212a062c6cc519e9d8e9eb4e4ee8776c8b1c9912d
-  data.tar.gz: 9d77b3d4de15b392e621d9ad11e546d933f2963075eac390414066dc5957a674c3dad7ccf105a669eaa2c329dae02b2d7d08dbe11666b16ced46c019a39187a3
+  metadata.gz: 0b631ba6e4bf53e1cc64b913669d374e925d3dda3beafa158162288712f3d4981b20e9b71af95e2d724c0919cb95ba86957ebb357ff0eacc31030c50e5c6b96d
+  data.tar.gz: f3a2d612e597d28f37fbca66ea1e160881402473d0649f2618946a31884bbaca92042edfa3b81bea66e2ad62a136ebd6702f9cf62f4604533ebe73238b405bfa

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change Log
 
+## Version 1.8.2 - 2016-08-08
+### Fixed
+
+*   Fix empty attribute_fields regression in advanced search mode introduced by
+    [235eae3](https://github.com/activerecord-hackery/ransack/commit/235eae3).
+    Closes
+    [#701](https://github.com/activerecord-hackery/ransack/issues/701). Commit
+    [2839acf](https://github.com/activerecord-hackery/ransack/commit/2839acf).
+
+    *Jon Atack, Jay Dorsey, Stefan Haslinger, Igor Kasyanchuk*
+
+### Added
+
+*   Add `sort_url` view helper that returns only the url of a `sort_link`. PR
+    [#706](https://github.com/activerecord-hackery/ransack/pull/706).
+
+    *amatotsuji*
+
 ## Version 1.8.1 - 2016-07-27
 ### Fixed
 

data/CONTRIBUTING.md

@@ -72,9 +72,17 @@ Here's a quick guide:
 
    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=pg bundle exec rake spec (`DB=postgres` & `DB=postgresql` work too)
         $ DB=mysql bundle exec rake spec
 
+   To run only the tests in a particular file: `rspec <path/to/filename>`
+
+        $ rspec spec/ransack/search_spec.rb
+
+   To run a single test in that file: `rspec <path/to/filename> -e "test name"`
+
+        $ rspec spec/ransack/search_spec.rb -e "accepts a context option"
+
 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.
 

data/Gemfile

@@ -6,8 +6,6 @@ gem 'rake'
 rails = ENV['RAILS'] || '5-0-stable'
 
 if rails == 'master'
-  gem 'rack', github: 'rack/rack'
-  gem 'arel', github: 'rails/arel'
   gem 'polyamorous', github: 'activerecord-hackery/polyamorous'
 else
   gem 'polyamorous', '~> 1.3'
@@ -50,7 +48,7 @@ if ENV['DB'] =~ /mongoid5/
   gem 'mongoid', '~> 5.0.0', require: false
 end
 
-# Removed from Ruby 2.2 but needed for testing Rails 3.x.
 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'
 end

data/README.md

@@ -29,7 +29,7 @@ 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.8.1).](https://github.com/activerecord-hackery/ransack/tree/v1.8.1)
+[View documentation for the last release (1.8.2).](https://github.com/activerecord-hackery/ransack/tree/v1.8.2)
 
 ## Getting started
 
@@ -221,6 +221,23 @@ Ransack.configure do |c|
 end
 ```
 
+####Ransack's `sort_url` helper is like a `sort_link` but returns only the url
+
+`sort_url` has the same API as `sort_link`:
+
+```erb
+<%= sort_url(@q, :name, default_order: :desc) %>
+```
+
+```erb
+<%= sort_url(@q, :last_name, [:last_name, 'first_name asc']) %>
+```
+
+```erb
+<%= sort_url(@q, :last_name, %i(last_name first_name),
+  default_order: { last_name: 'asc', first_name: 'desc' }) %>
+```
+
 ### Advanced Mode
 
 "Advanced" searches (ab)use Rails' nested attributes functionality in order to

data/lib/ransack/helpers/form_builder.rb

@@ -83,6 +83,10 @@ module Ransack
         @template.sort_link @object, attribute, *args
       end
 
+      def sort_url(attribute, *args)
+        @template.sort_url @object, attribute, *args
+      end
+
       def condition_fields(*args, &block)
         search_fields(:c, args, block)
       end

data/lib/ransack/helpers/form_helper.rb

@@ -54,6 +54,18 @@ module Ransack
         link_to(s.name, url(routing_proxy, s.url_options), s.html_options(args))
       end
 
+      # +sort_url+
+      # <%= sort_url(@q, :created_at, default_order: :desc) %>
+      #
+      def sort_url(search_object, attribute, *args)
+        search, routing_proxy = extract_search_and_routing_proxy(search_object)
+        unless Search === search
+          raise TypeError, 'First argument must be a Ransack::Search!'
+        end
+        s = SortLink.new(search, attribute, args, params)
+        url(routing_proxy, s.url_options)
+      end
+
       private
 
         def options_for(record)

data/lib/ransack/nodes/condition.rb

@@ -127,10 +127,29 @@ module Ransack
       alias :m= :combinator=
       alias :m :combinator
 
+
+      # == build_attribute
+      #
+      #  This method was originally called from Nodes::Grouping#new_condition
+      #  only, without arguments, without #valid? checking, to build a new
+      #  grouping condition.
+      #
+      #  After refactoring in 235eae3, it is now called from 2 places:
+      #
+      #  1. Nodes::Condition#attributes=, with +name+ argument passed or +name+
+      #     and +ransacker_args+. Attributes are included only if #valid?.
+      #
+      #  2. Nodes::Grouping#new_condition without arguments. In this case, the
+      #     #valid? conditional needs to be bypassed, otherwise nothing is
+      #     built. The `name.nil?` conditional below currently does this.
+      #
+      #  TODO: Add test coverage for this behavior and ensure that `name.nil?`
+      #  isn't fixing issue #701 by introducing untested regressions.
+      #
       def build_attribute(name = nil, ransacker_args = [])
         Attribute.new(@context, name, ransacker_args).tap do |attribute|
           @context.bind(attribute, attribute.name)
-          self.attributes << attribute if attribute.valid?
+          self.attributes << attribute if name.nil? || attribute.valid?
           if predicate && !negative?
             @context.lock_association(attribute.parent)
           end

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = '1.8.1'
+  VERSION = '1.8.2'
 end

data/spec/ransack/helpers/form_helper_spec.rb

@@ -43,16 +43,32 @@ module Ransack
         it { should match /Full Name ▼/ }
       end
 
-      describe '#sort_link with default search_key defined as symbol' do
+      describe '#sort_url with default search_key' do
         subject { @controller.view_context
-          .sort_link(
-            Person.search(
-              { sorts: ['name desc'] }, search_key: :people_search
-              ),
+          .sort_url(
+            [:main_app, Person.search(sorts: ['name desc'])],
             :name,
             controller: 'people'
           )
         }
+        it {
+          should match(
+            if ActiveRecord::VERSION::STRING =~ /^3\.[1-2]\./
+              /people\?q%5Bs%5D=name\+asc/
+            else
+              /people\?q(%5B|\[)s(%5D|\])=name\+asc/
+            end
+          )
+        }
+      end
+
+      describe '#sort_link with default search_key defined as symbol' do
+        subject { @controller.view_context
+          .sort_link(
+            Person.search({ sorts: ['name desc'] }, search_key: :people_search),
+            :name, controller: 'people'
+          )
+        }
         it {
           should match(
             if ActiveRecord::VERSION::STRING =~ /^3\.[1-2]\./
@@ -64,7 +80,25 @@ module Ransack
         }
       end
 
-      describe '#sort_link desc through association table defined as a symbol' do
+      describe '#sort_url with default search_key defined as symbol' do
+        subject { @controller.view_context
+          .sort_url(
+            Person.search({ sorts: ['name desc'] }, search_key: :people_search),
+            :name, controller: 'people'
+          )
+        }
+        it {
+          should match(
+            if ActiveRecord::VERSION::STRING =~ /^3\.[1-2]\./
+              /people\?people_search%5Bs%5D=name\+asc/
+            else
+              /people\?people_search(%5B|\[)s(%5D|\])=name\+asc/
+            end
+          )
+        }
+      end
+
+      describe '#sort_link desc through association table defined as symbol' do
         subject { @controller.view_context
           .sort_link(
             Person.search({ sorts: 'comments_body asc' }),
@@ -85,6 +119,25 @@ module Ransack
         it { should match /Body ▲/ }
       end
 
+      describe '#sort_url desc through association table defined as symbol' do
+        subject { @controller.view_context
+          .sort_url(
+            Person.search({ sorts: 'comments_body asc' }),
+            :comments_body,
+            controller: 'people'
+          )
+        }
+        it {
+          should match(
+            if ActiveRecord::VERSION::STRING =~ /^3\.[1-2]\./
+              /people\?q%5Bs%5D=comments.body\+desc/
+            else
+              /people\?q(%5B|\[)s(%5D|\])=comments.body\+desc/
+            end
+          )
+        }
+      end
+
       describe '#sort_link through association table defined as a string' do
         subject { @controller.view_context
           .sort_link(
@@ -106,16 +159,47 @@ module Ransack
         it { should match /Comments.body ▼/ }
       end
 
+      describe '#sort_url through association table defined as a string' do
+        subject { @controller.view_context
+          .sort_url(
+            Person.search({ sorts: 'comments.body desc' }),
+            'comments.body',
+            controller: 'people'
+          )
+        }
+        it {
+          should match(
+            if ActiveRecord::VERSION::STRING =~ /^3\.[1-2]\./
+              /people\?q%5Bs%5D=comments.body\+asc/
+            else
+              /people\?q(%5B|\[)s(%5D|\])=comments.body\+asc/
+            end
+          )
+        }
+      end
+
       describe '#sort_link works even if search params are a blank string' do
         before { @controller.view_context.params[:q] = '' }
         specify {
           expect { @controller.view_context
             .sort_link(
-              Person.search(
-                @controller.view_context.params[:q]),
-                :name,
-                controller: 'people'
-              )
+              Person.search(@controller.view_context.params[:q]),
+              :name,
+              controller: 'people'
+            )
+          }.not_to raise_error
+        }
+      end
+
+      describe '#sort_url works even if search params are a blank string' do
+        before { @controller.view_context.params[:q] = '' }
+        specify {
+          expect { @controller.view_context
+            .sort_url(
+              Person.search(@controller.view_context.params[:q]),
+              :name,
+              controller: 'people'
+            )
           }.not_to raise_error
         }
       end
@@ -153,6 +237,18 @@ module Ransack
         it { should_not match /default_order/ }
       end
 
+      describe '#sort_url with default_order defined with a string key' do
+        subject { @controller.view_context
+          .sort_url(
+            [:main_app, Person.search()],
+            :name,
+            controller: 'people',
+            default_order: 'desc'
+          )
+        }
+        it { should_not match /default_order/ }
+      end
+
       describe '#sort_link with multiple search_keys defined as an array' do
         subject { @controller.view_context
           .sort_link(
@@ -162,14 +258,27 @@ module Ransack
           )
         }
         it {
-          should match(
-            /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+asc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          should match(            /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+asc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
           )
         }
         it { should match /sort_link desc/ }
         it { should match /Full Name ▼/ }
       end
 
+      describe '#sort_url with multiple search_keys defined as an array' do
+        subject { @controller.view_context
+          .sort_url(
+            [:main_app, Person.search(sorts: ['name desc', 'email asc'])],
+            :name, [:name, 'email DESC'],
+            controller: 'people'
+          )
+        }
+        it {
+          should match( /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+asc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          )
+        }
+      end
+
       describe '#sort_link with multiple search_keys does not break on nil values & ignores them' do
         subject { @controller.view_context
           .sort_link(
@@ -179,14 +288,27 @@ module Ransack
           )
         }
         it {
-          should match(
-            /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+asc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          should match(         /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+asc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
           )
         }
         it { should match /sort_link desc/ }
         it { should match /Full Name ▼/ }
       end
 
+      describe '#sort_url with multiple search_keys does not break on nil values & ignores them' do
+        subject { @controller.view_context
+          .sort_url(
+            [:main_app, Person.search(sorts: ['name desc', nil, 'email', nil])],
+            :name, [nil, :name, nil, 'email DESC', nil],
+            controller: 'people'
+          )
+        }
+        it {
+          should match(                     /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+asc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          )
+        }
+      end
+
       describe '#sort_link with multiple search_keys should allow a label to be specified' do
         subject { @controller.view_context
           .sort_link(
@@ -208,14 +330,27 @@ module Ransack
           )
         }
         it {
-          should match(
-            /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+asc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          should match(          /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+asc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
           )
         }
         it { should match /sort_link desc/ }
         it { should match /Full Name ▼/ }
       end
 
+      describe '#sort_url with multiple search_keys should flip multiple fields specified without a direction' do
+        subject { @controller.view_context
+          .sort_url(
+            [:main_app, Person.search(sorts: ['name desc', 'email asc'])],
+            :name, [:name, :email],
+            controller: 'people'
+          )
+        }
+        it {
+          should match(                /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+asc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          )
+        }
+      end
+
       describe '#sort_link with multiple search_keys and default_order specified as a string' do
         subject { @controller.view_context
           .sort_link(
@@ -226,14 +361,28 @@ module Ransack
           )
         }
         it {
-          should match(
-            /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          should match(            /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
           )
         }
         it { should match /sort_link/ }
         it { should match /Full Name/ }
       end
 
+      describe '#sort_url with multiple search_keys and default_order specified as a string' do
+        subject { @controller.view_context
+          .sort_url(
+            [:main_app, Person.search()],
+            :name, [:name, :email],
+            controller: 'people',
+            default_order: 'desc'
+          )
+        }
+        it {
+          should match(                     /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          )
+        }
+      end
+
       describe '#sort_link with multiple search_keys and default_order specified as a symbol' do
         subject { @controller.view_context
           .sort_link(
@@ -244,14 +393,28 @@ module Ransack
           )
         }
         it {
-          should match(
-            /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          should match(            /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
           )
         }
         it { should match /sort_link/ }
         it { should match /Full Name/ }
       end
 
+      describe '#sort_url with multiple search_keys and default_order specified as a symbol' do
+        subject { @controller.view_context
+          .sort_url(
+            [:main_app, Person.search()],
+            :name, [:name, :email],
+            controller: 'people',
+            default_order: :desc
+          )
+        }
+        it {
+          should match(                     /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          )
+        }
+      end
+
       describe '#sort_link with multiple search_keys should allow multiple default_orders to be specified' do
         subject { @controller.view_context
           .sort_link(
@@ -262,14 +425,28 @@ module Ransack
           )
         }
         it {
-          should match(
-            /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+asc/
+          should match(      /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+asc/
           )
         }
         it { should match /sort_link/ }
         it { should match /Full Name/ }
       end
 
+      describe '#sort_url with multiple search_keys should allow multiple default_orders to be specified' do
+        subject { @controller.view_context
+          .sort_url(
+            [:main_app, Person.search()],
+            :name, [:name, :email],
+            controller: 'people',
+            default_order: { name: 'desc', email: 'asc' }
+          )
+        }
+        it {
+          should match(                     /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+asc/
+          )
+        }
+      end
+
       describe '#sort_link with multiple search_keys with multiple default_orders should not override a specified order' do
         subject { @controller.view_context
           .sort_link(
@@ -280,14 +457,28 @@ module Ransack
           )
         }
         it {
-          should match(
-            /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          should match(  /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
           )
         }
         it { should match /sort_link/ }
         it { should match /Full Name/ }
       end
 
+      describe '#sort_url with multiple search_keys with multiple default_orders should not override a specified order' do
+        subject { @controller.view_context
+          .sort_url(
+            [:main_app, Person.search()],
+            :name, [:name, 'email desc'],
+            controller: 'people',
+            default_order: { name: 'desc', email: 'asc' }
+          )
+        }
+        it {
+          should match(        /people\?q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=name\+desc&q(%5B|\[)s(%5D|\])(%5B|\[)(%5D|\])=email\+desc/
+          )
+        }
+      end
+
       describe "#sort_link on polymorphic association should preserve association model name case" do
         subject { @controller.view_context
           .sort_link(
@@ -309,6 +500,25 @@ module Ransack
         it { should match /Notable/ }
       end
 
+      describe "#sort_url on polymorphic association should preserve association model name case" do
+        subject { @controller.view_context
+          .sort_link(
+            [:main_app, Note.search()],
+            :notable_of_Person_type_name, "Notable",
+            controller: 'notes'
+          )
+        }
+        it {
+          should match(
+            if ActiveRecord::VERSION::STRING =~ /^3\.[1-2]\./
+              /notes\?q%5Bs%5D=notable_of_Person_type_name\+asc/
+            else
+              /notes\?q(%5B|\[)s(%5D|\])=notable_of_Person_type_name\+asc/
+            end
+          )
+        }
+      end
+
       context 'view has existing parameters' do
 
         describe '#sort_link should not remove existing params' do
@@ -329,6 +539,24 @@ module Ransack
           it { should match /exist\=existing/ }
         end
 
+        describe '#sort_url should not remove existing params' do
+
+          before { @controller.view_context.params[:exist] = 'existing' }
+
+          subject {
+            @controller.view_context.sort_url(
+              Person.search(
+                { sorts: ['name desc'] },
+                search_key: 'people_search'
+              ),
+              :name,
+              controller: 'people'
+            )
+          }
+
+          it { should match /exist\=existing/ }
+        end
+
         context 'using a real ActionController::Parameter object',
           if: ::ActiveRecord::VERSION::MAJOR > 3 do
 
@@ -347,6 +575,21 @@ module Ransack
             }
           end
 
+          describe 'with symbol q:, #sort_url should include search params' do
+            subject { @controller.view_context.sort_url(Person.search, :name) }
+            let(:params) { ActionController::Parameters.new(
+              { :q => { name_eq: 'TEST' }, controller: 'people' }
+              ) }
+            before { @controller.instance_variable_set(:@params, params) }
+
+            it {
+              should match(
+                /people\?q(%5B|\[)name_eq(%5D|\])=TEST&q(%5B|\[)s(%5D|\])
+                =name\+asc/x,
+              )
+            }
+          end
+
           describe "with string 'q', #sort_link should include search params" do
             subject { @controller.view_context.sort_link(Person.search, :name) }
             let(:params) {
@@ -362,6 +605,22 @@ module Ransack
               )
             }
           end
+
+          describe "with string 'q', #sort_url should include search params" do
+            subject { @controller.view_context.sort_url(Person.search, :name) }
+            let(:params) {
+              ActionController::Parameters.new(
+                { 'q' => { name_eq: 'Test2' }, controller: 'people' }
+                ) }
+            before { @controller.instance_variable_set(:@params, params) }
+
+            it {
+              should match(
+                /people\?q(%5B|\[)name_eq(%5D|\])=Test2&q(%5B|\[)s(%5D|\])
+                =name\+asc/x,
+              )
+            }
+          end
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ransack
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.2
 platform: ruby
 authors:
 - Ernie Miller
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-27 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack