ransack 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e44db6020449735b694bd18943195f6e7cdd3597a8dc776d22a54114b4b9273
-  data.tar.gz: cdcb6ef8b863873fcaa7c2067cb20636c4e856e27f431488978201a310023f45
+  metadata.gz: c2eab955e89328399bcb163a575725ea51969653edb1edd66773b6f60554fd12
+  data.tar.gz: 1e6d34f5d87238a18c7ae2194cd0d5320d9460b97b8d8c30ec79d82de6aa139a
 SHA512:
-  metadata.gz: ded22ffb680b2a358ee72ab348b8f9debc7f2c927c878ec5a4ad872b552b715e561e9b0aac188d874c67cce70f6463d62b3be7655e46900a706214d58d69fa88
-  data.tar.gz: 6f45114a54ef6f83cbd99780ba432069cf4111c4b9d2294141f238526655edc1cb035422705565389e4c60f75666716d8fd201887f7ca9fd90c92314bbb3b9e6
+  metadata.gz: 52c4a46725d9bb474fbb229c39d9638c730d77bd53211f00f639b78690fcd72aaaa2418b56704c30024c36c39ca7cebde0e86b76cba13704a26f4416791ad141
+  data.tar.gz: bd6880992a977511ea37df47d0828e8ee1e855dff39e2620eaed89bc043ffde2960e3006ebcc0609c9738af10faea6947a1db1f91f1f3eebc65b631d97137054

data/.gitignore

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

data/.travis.yml

@@ -4,7 +4,6 @@ sudo: false
 
 rvm:
   - 2.5
-  - 2.2
 
 env:
   - RAILS=5-2-stable DB=sqlite3
@@ -23,10 +22,6 @@ env:
   - RAILS=5-1-stable DB=mysql
   - RAILS=5-1-stable DB=postgres
 
-  - RAILS=5-0-stable DB=sqlite3
-  - RAILS=5-0-stable DB=mysql
-  - RAILS=5-0-stable DB=postgres
-
 matrix:
   allow_failures:
     - env: RAILS=5-2-stable DB=sqlite3

data/CHANGELOG.md

@@ -2,6 +2,57 @@
 
 ## Unreleased
 
+## Version 2.1.1 - 2018-12-05
+
+* Add `arabic` translation
+  https://github.com/activerecord-hackery/ransack/pull/979
+
+* Deprecate #search
+  PR [975](https://github.com/activerecord-hackery/ransack/pull/975)
+
+## Version 2.1.0 - 2018-10-26
+
+* Add support for sorting by scopes
+  PR [973](https://github.com/activerecord-hackery/ransack/pull/973)
+
+  *Diego Borges*
+
+* Added a new logo for Ransack
+  PR [972](https://github.com/activerecord-hackery/ransack/pull/972)
+
+  *Anıl Kılıç*, *Greg Molnar*
+
+* Greek translations
+  PR [971](https://github.com/activerecord-hackery/ransack/pull/971)
+  PR [960](https://github.com/activerecord-hackery/ransack/pull/960)
+
+  *Sean Carroll*, *Greg Molnar*
+
+* README improvements
+  PR [963](https://github.com/activerecord-hackery/ransack/pull/963)
+
+  *tommaso1*
+
+* Bulgarian translations
+  PR [961](https://github.com/activerecord-hackery/ransack/pull/961)
+
+  *Sean Carroll*
+
+* README improvements
+  PR [956](https://github.com/activerecord-hackery/ransack/pull/956)
+
+  *Alex Konoval*
+
+* Remove lib/ransack/adapters/active_record/compat.rb
+  PR [954](https://github.com/activerecord-hackery/ransack/pull/954)
+
+  *Ryuta Kamizono*
+
+* Remove unused aliases
+  PR [953](https://github.com/activerecord-hackery/ransack/pull/953)
+
+  *Ryuta Kamizono*
+
 ## Version 2.0.1 - 2018-08-18
 
 * Don't return association if table is nil

data/README.md

@@ -1,15 +1,16 @@
-# Ransack
+# ![Ransack](./logo/ransack-h.png "Ransack")
 
 [![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)
+[![Backers on Open Collective](https://opencollective.com/ransack/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/ransack/sponsors/badge.svg)](#sponsors) 
 
 Ransack is a rewrite of [MetaSearch](https://github.com/activerecord-hackery/meta_search)
 created by [Ernie Miller](http://twitter.com/erniemiller)
 and developed/maintained for years by
 [Jon Atack](http://twitter.com/jonatack) and
 [Ryan Bigg](http://twitter.com/ryanbigg) with the help of a great group of
-[contributors](https://github.com/activerecord-hackery/ransack/graphs/contributors).
+[contributors](https://github.com/activerecord-hackery/ransack/graphs/contributors). Ransack's logo is designed by [Anıl Kılıç](https://github.com/anilkilic).
 While it supports many of the same features as MetaSearch, its underlying
 implementation differs greatly from MetaSearch,
 and backwards compatibility is not a design goal.
@@ -132,6 +133,11 @@ which are defined in
 <% end %>
 ```
 
+The argument of `f.search_field` has to be in this form:
+ `attribute_name[_or_attribute_name]..._predicate`
+
+where `[_or_another_attribute_name]...` means any repetition of `_or_` plus the name of the attribute.
+
 `cont` (contains) and `start` (starts with) are just two of the available
 search predicates. See
 [Constants](https://github.com/activerecord-hackery/ransack/blob/master/lib/ransack/constants.rb)
@@ -196,6 +202,23 @@ This example toggles the sort directions of both fields, by default
 initially sorting the `last_name` field by ascending order, and the
 `first_name` field by descending order.
 
+In the case that you wish to sort by some complex value, such as the result
+of a SQL function, you may do so using scopes. In your model, define scopes
+whose names line up with the name of the virtual field you wish to sort by,
+as so:
+
+```ruby
+class Person < ActiveRecord::Base
+  scope :sort_by_reverse_name_asc, lambda { order("REVERSE(name) ASC") }
+  scope :sort_by_reverse_name_desc, lambda { order("REVERSE(name) DESC") }
+...
+```
+
+and you can then sort by this virtual field:
+
+```erb
+<%= sort_link(@q, :reverse_name) %>
+```
 
 The sort link order indicator arrows may be globally customized by setting a
 `custom_arrows` option in an initializer file like
@@ -483,7 +506,7 @@ avoid returning duplicate rows, even if conditions on a join would otherwise
 result in some. It generates the same SQL as calling `uniq` on the relation.
 
 Please note that for many databases, a sort on an associated table's columns
-may result in invalid SQL with `distinct: true` -- in those cases, you will
+may result in invalid SQL with `distinct: true` -- in those cases, you
 will need to modify the result as needed to allow these queries to work.
 
 For example, you could call joins and includes on the result which has the
@@ -722,7 +745,7 @@ Ransack.configure do |c|
 end
 ```
 
-To turn this off on a per-scope basis Ransack adds the following method to 
+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`
@@ -911,3 +934,32 @@ directly related to bug reports, pull requests, or documentation improvements.
 * Spread the word on Twitter, Facebook, and elsewhere if Ransack's been useful
 to you. The more people who are using the project, the quicker we can find and
 fix bugs!
+
+## Contributors
+
+This project exists thanks to all the people who contribute. <img src="https://opencollective.com/ransack/contributors.svg?width=890&button=false" />
+
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/ransack#backer)]
+
+<a href="https://opencollective.com/ransack#backers" target="_blank"><img src="https://opencollective.com/ransack/backers.svg?width=890"></a>
+
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/ransack#sponsor)]
+
+<a href="https://opencollective.com/ransack/sponsor/0/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/0/avatar.svg"></a>
+<a href="https://opencollective.com/ransack/sponsor/1/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/ransack/sponsor/2/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/ransack/sponsor/3/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/ransack/sponsor/4/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/ransack/sponsor/5/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/ransack/sponsor/6/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/ransack/sponsor/7/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/ransack/sponsor/8/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/ransack/sponsor/9/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/9/avatar.svg"></a>
+
+

data/lib/polyamorous.rb

@@ -1,22 +1,10 @@
 if defined?(::ActiveRecord)
   module Polyamorous
-    if defined?(Arel::InnerJoin)
-      InnerJoin = Arel::InnerJoin
-      OuterJoin = Arel::OuterJoin
-    else
-      InnerJoin = Arel::Nodes::InnerJoin
-      OuterJoin = Arel::Nodes::OuterJoin
-    end
+    InnerJoin = Arel::Nodes::InnerJoin
+    OuterJoin = Arel::Nodes::OuterJoin
 
-    if defined?(::ActiveRecord::Associations::JoinDependency)
-      JoinDependency  = ::ActiveRecord::Associations::JoinDependency
-      JoinAssociation = ::ActiveRecord::Associations::JoinDependency::JoinAssociation
-      JoinBase = ::ActiveRecord::Associations::JoinDependency::JoinBase
-    else
-      JoinDependency  = ::ActiveRecord::Associations::ClassMethods::JoinDependency
-      JoinAssociation = ::ActiveRecord::Associations::ClassMethods::JoinDependency::JoinAssociation
-      JoinBase = ::ActiveRecord::Associations::ClassMethods::JoinDependency::JoinBase
-    end
+    JoinDependency  = ::ActiveRecord::Associations::JoinDependency
+    JoinAssociation = ::ActiveRecord::Associations::JoinDependency::JoinAssociation
   end
 
   require 'polyamorous/tree_node'
@@ -24,7 +12,8 @@ if defined?(::ActiveRecord)
   require 'polyamorous/swapping_reflection_class'
 
   ar_version = ::ActiveRecord::VERSION::STRING[0,3]
-  ar_version = ::ActiveRecord::VERSION::STRING[0,5] if ar_version >= '5.2'
+  ar_version = ::ActiveRecord::VERSION::STRING[0,5] if ar_version >= "5.2"
+  ar_version = "5.2.1" if ::ActiveRecord::VERSION::STRING >= "5.2.1"
 
   %w(join_association join_dependency).each do |file|
     require "polyamorous/activerecord_#{ar_version}_ruby_2/#{file}"
@@ -33,10 +22,4 @@ if defined?(::ActiveRecord)
   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)
-      alias_method :base_klass, :active_record
-    end
-  end
 end

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

@@ -14,6 +14,7 @@ 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

@@ -1,5 +1,4 @@
 require 'ransack/context'
-require 'ransack/adapters/active_record/compat'
 require 'polyamorous'
 
 module Ransack
@@ -7,11 +6,6 @@ module Ransack
     module ActiveRecord
       class Context < ::Ransack::Context
 
-        # Because the AR::Associations namespace is insane
-        if defined? ::ActiveRecord::Associations::JoinDependency
-          JoinDependency = ::ActiveRecord::Associations::JoinDependency
-        end
-
         def initialize(object, options = {})
           super
           if ::ActiveRecord::VERSION::STRING < Constants::RAILS_5_2
@@ -37,9 +31,29 @@ module Ransack
         def evaluate(search, opts = {})
           viz = Visitor.new
           relation = @object.where(viz.accept(search.base))
+
           if search.sorts.any?
-            relation = relation.except(:order).reorder(viz.accept(search.sorts))
+            relation = relation.except(:order)
+            # Rather than applying all of the search's sorts in one fell swoop,
+            # as the original implementation does, we apply one at a time.
+            #
+            # If the sort (returned by the Visitor above) is a symbol, we know
+            # that it represents a scope on the model and we can apply that
+            # scope.
+            #
+            # Otherwise, we fall back to the applying the sort with the "order"
+            # method as the original implementation did. Actually the original
+            # implementation used "reorder," which was overkill since we already
+            # have a clean slate after "relation.except(:order)" above.
+            viz.accept(search.sorts).each do |scope_or_sort|
+              if scope_or_sort.is_a?(Symbol)
+                relation = relation.send(scope_or_sort)
+              else
+                relation = relation.order(scope_or_sort)
+              end
+            end
           end
+
           opts[:distinct] ? relation.distinct : relation
         end
 
@@ -235,19 +249,19 @@ module Ransack
           join_list = join_nodes + convert_join_strings_to_ast(relation.table, string_joins)
 
           if ::ActiveRecord::VERSION::STRING < Constants::RAILS_5_2_0
-            join_dependency = JoinDependency.new(relation.klass, association_joins, join_list)
+            join_dependency = Polyamorous::JoinDependency.new(relation.klass, association_joins, join_list)
             join_nodes.each do |join|
               join_dependency.send(:alias_tracker).aliases[join.left.name.downcase] = 1
             end
           elsif ::ActiveRecord::VERSION::STRING == Constants::RAILS_5_2_0
             alias_tracker = ::ActiveRecord::Associations::AliasTracker.create(self.klass.connection, relation.table.name, join_list)
-            join_dependency = JoinDependency.new(relation.klass, relation.table, association_joins, alias_tracker)
+            join_dependency = Polyamorous::JoinDependency.new(relation.klass, relation.table, association_joins, alias_tracker)
             join_nodes.each do |join|
               join_dependency.send(:alias_tracker).aliases[join.left.name.downcase] = 1
             end
           else
             alias_tracker = ::ActiveRecord::Associations::AliasTracker.create(self.klass.connection, relation.table.name, join_list)
-            join_dependency = JoinDependency.new(relation.klass, relation.table, association_joins)
+            join_dependency = Polyamorous::JoinDependency.new(relation.klass, relation.table, association_joins)
             join_dependency.instance_variable_set(:@alias_tracker, alias_tracker)
             join_nodes.each do |join|
               join_dependency.send(:alias_tracker).aliases[join.left.name.downcase] = 1
@@ -276,7 +290,7 @@ module Ransack
 
         def build_association(name, parent = @base, klass = nil)
           if ::ActiveRecord::VERSION::STRING < Constants::RAILS_5_2_0
-            jd = JoinDependency.new(
+            jd = Polyamorous::JoinDependency.new(
               parent.base_klass,
               Polyamorous::Join.new(name, @join_type, klass),
               []
@@ -284,7 +298,7 @@ module Ransack
             found_association = jd.join_root.children.last
           elsif ::ActiveRecord::VERSION::STRING == Constants::RAILS_5_2_0
             alias_tracker = ::ActiveRecord::Associations::AliasTracker.create(self.klass.connection, parent.table.name, [])
-            jd = JoinDependency.new(
+            jd = Polyamorous::JoinDependency.new(
               parent.base_klass,
               parent.base_klass.arel_table,
               Polyamorous::Join.new(name, @join_type, klass),
@@ -292,7 +306,7 @@ module Ransack
             )
             found_association = jd.instance_variable_get(:@join_root).children.last
           else
-            jd = JoinDependency.new(
+            jd = Polyamorous::JoinDependency.new(
               parent.base_klass,
               parent.base_klass.arel_table,
               Polyamorous::Join.new(name, @join_type, klass),

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

@@ -21,11 +21,15 @@ module Ransack
     end
 
     def visit_Ransack_Nodes_Sort(object)
-      return unless object.valid?
-      if object.attr.is_a?(Arel::Attributes::Attribute)
-        object.attr.send(object.dir)
+      if object.valid?
+        if object.attr.is_a?(Arel::Attributes::Attribute)
+          object.attr.send(object.dir)
+        else
+          ordered(object)
+        end
       else
-        ordered(object)
+        scope_name = :"sort_by_#{object.name}_#{object.dir}"
+        scope_name if object.context.object.respond_to?(scope_name)
       end
     end
 

data/lib/ransack/locale/ar.yml

@@ -0,0 +1,70 @@
+ar:
+  ransack:
+    search: "بحث"
+    predicate: "فاعل"
+    and: "و"
+    or: "أو"
+    any: "أيُّ"
+    all: "كل"
+    combinator: "دالة توافقية"
+    attribute: "خاصية"
+    value: "قيمة"
+    condition: "شرط"
+    sort: "ترتيب"
+    asc: "تصاعدي"
+    desc: "تنازلي"
+    predicates:
+      eq: "معادل"
+      eq_any: "معادل على اﻷقل لواحد"
+      eq_all: "معادل للجميع"
+      not_eq: "ليس معادلا لـ"
+      not_eq_any: "ليس معادلا على اﻷقل لواحد"
+      not_eq_all: "ليس معادلا للجميع"
+      matches: "موائم"
+      matches_any: "موائم لواحد على اﻷقل"
+      matches_all: "موائم للجميع"
+      does_not_match: "لا يتواءم"
+      does_not_match_any: "لا يتواءم مع واحد على اﻷقل"
+      does_not_match_all: "لا يتواءم مع الجميع"
+      lt: "أصغر من"
+      lt_any: "أصغر لواحد على اﻷقل"
+      lt_all: "أصغر من الجميع"
+      lteq: "أصغر أو مساو لـ"
+      lteq_any: "أصغر أو مساو لواحد على اﻷقل"
+      lteq_all: "أصغر أو مساو للجميع"
+      gt: "أكبر من"
+      gt_any: "أكبر من واحد على اﻷقل"
+      gt_all: "أكبر من الجميع"
+      gteq: "أكبر أو مساو لـ"
+      gteq_any: "أكبر أو مساو لواحد على اﻷقل"
+      gteq_all: "أكبر أو مساو للجميع"
+      in: "متضمن لـ"
+      in_any: "متضمن لواحد على اﻷقل"
+      in_all: "متضمن للجميع"
+      not_in: "غير متضمن"
+      not_in_any: "غير متضمن لواحد على اﻷقل"
+      not_in_all: "غير متضمن للجميع"
+      cont: "محتو"
+      cont_any: "محتو لواحد على اﻷقل"
+      cont_all: "محتو لجميع"
+      not_cont: "غير محتو"
+      not_cont_any: "غير محتو لواحد على اﻷقل"
+      not_cont_all: "غير محتو للجميع"
+      start: "يبدأ بـ"
+      start_any: "يبدأ بواحد على اﻷقل"
+      start_all: "يبدأ بالجميع"
+      not_start: "لا يبدأ بـ"
+      not_start_any: "لا يبدأ بواحد على اﻷقل"
+      not_start_all: "لا يبدأ بالجميع"
+      end: "ينتهي بـ"
+      end_any: "ينتهي بواحد على اﻷقل"
+      end_all: "ينتهي بالجميع"
+      not_end: "لا ينتهي بـ"
+      not_end_any: "لا ينتهي بواحد على اﻷقل"
+      not_end_all: "لا ينتهي بالجميع"
+      'true': "صحيح"
+      'false': "خطأ"
+      present: "مستقبل"
+      blank: "فراغ"
+      'null': "عدم"
+      not_null: "غير مساو لقيمة عدم"

data/lib/ransack/locale/bg.yml

@@ -0,0 +1,70 @@
+bg:
+  ransack:
+    search: "търсене"
+    predicate: "предикат"
+    and: "и"
+    or: "или"
+    any: "всякакво"
+    all: "всички"
+    combinator: "комбинатор"
+    attribute: "атрибут"
+    value: "стойност"
+    condition: "условие"
+    sort: "сортиране"
+    asc: "възходящ"
+    desc: "низходящ"
+    predicates:
+      eq: "се равнява на"
+      eq_any: "се равнява на всяко"
+      eq_all: "се равнява на всички"
+      not_eq: "не е равно на"
+      not_eq_any: "не е равно на никое от"
+      not_eq_all: "не е равно на всички"
+      matches: "съвпада"
+      matches_any: "съвпада с някое"
+      matches_all: "съвпада с всички"
+      does_not_match: "не съвпада"
+      does_not_match_any: "не съвпада с никое"
+      does_not_match_all: "не съвпада с всички"
+      lt: "по-малко от"
+      lt_any: "по-малко от някое"
+      lt_all: "по-малко от всички"
+      lteq: "по-малко или равно на"
+      lteq_any: "по-малко или равно на някое"
+      lteq_all: "по-малко или равно на всички"
+      gt: "по-голямо от"
+      gt_any: "по-голямо от всякое"
+      gt_all: "по-голямо от всички"
+      gteq: "по-голямо или равно на"
+      gteq_any: "по-голямо или равно на всякое"
+      gteq_all: "по-голямо или равно на всички"
+      in: "в"
+      in_any: "във всякое"
+      in_all: "във всички"
+      not_in: "не в"
+      not_in_any: "не в никое"
+      not_in_all: "не във всички"
+      cont: "съдържа"
+      cont_any: "съдържа всякое"
+      cont_all: "съдържа всички"
+      not_cont: "не съдържа"
+      not_cont_any: "не съдържа никое"
+      not_cont_all: "не съдържа всички"
+      start: "започва с"
+      start_any: "започва с всякое"
+      start_all: "започва с всички"
+      not_start: "не започва с"
+      not_start_any: "не започва с никое"
+      not_start_all: "не започва с всички"
+      end: "завършва с"
+      end_any: "завършва с всякое"
+      end_all: "завършва с всички"
+      not_end: "не завършва с"
+      not_end_any: "не завършва с никое"
+      not_end_all: "не завършва с всички"
+      'true': "истина"
+      'false': "неистина"
+      present: "присъства"
+      blank: "е празно"
+      'null': "е нула"
+      not_null: "не е нула"