sortable-by 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e89dd7025ad14bfd9a012b10d68a70183692121625d14e56feea7e3484d8398
-  data.tar.gz: 931017877555f573485ebbaecb5501ba36e5e4c3a2c7d0842ada6ff2f68cd5fb
+  metadata.gz: 4639f942b5f628b07367a343160d7e4301b00bf3c6e0db9f57ff43d204a85ab5
+  data.tar.gz: 2f424ec2cda37112ca64fdf628b7ff0aee3e223dbee81d585040eff79ee468c8
 SHA512:
-  metadata.gz: 45ef18f0d53caa91e2e9cb0c8bcbae4bf4cdc3da59b844e1ddae2f5fa16454905d925a7212a31e4355f077fe7436b25303f17422c47f25592a3036cd623caba3
-  data.tar.gz: 724fd46c5ea0fd379980dcfe64a58ea579d9d03edab02516862d654ccc5a472d10bc810ccf48a32d4cc96e70ed5608100596425091c7a541dae5f380f8f4a173
+  metadata.gz: ff08a62e083e324f9baa4118423c82d90ad93d00f42b4cd6ae74d915a637439315f4cf5ebd8b9d598075bd9565064429a06d0017bae3b5f7998c35b39a50f14c
+  data.tar.gz: b084242394054b896d594c923e262c6325a74c58c836e2224ee5c4f91c3bc087bedfe0b42eb7aa2438ea2a84dd41ddd54c6b5718f68e181d5869bbb5efcb2397

data/.rubocop.yml

@@ -4,6 +4,8 @@ inherit_from:
 AllCops:
   TargetRubyVersion: 2.5
 
+Naming/MethodParameterName:
+  MinNameLength: 2
 Naming/MemoizedInstanceVariableName:
   Enabled: false
 Naming/FileName:

data/.travis.yml

@@ -2,6 +2,7 @@ sudo: false
 rvm:
   - 2.5
   - 2.6
+  - 2.7
 gemfile:
   - Gemfile
 before_install:

data/Gemfile.lock

@@ -1,41 +1,42 @@
 PATH
   remote: .
   specs:
-    sortable-by (0.12.1)
+    sortable-by (0.13.0)
       activerecord
       activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activerecord (6.0.3.1)
-      activemodel (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activesupport (6.0.3.1)
+    activemodel (6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activerecord (6.0.3.3)
+      activemodel (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activesupport (6.0.3.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.0)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    i18n (1.8.2)
+    ast (2.4.1)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
+    minitest (5.14.2)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.8.1)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
+    rspec-core (3.9.3)
       rspec-support (~> 3.9.3)
     rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -44,23 +45,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.84.0)
+    rubocop (0.92.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 0.5.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
     sqlite3 (1.4.2)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
@@ -74,4 +76,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -20,23 +20,23 @@ class Post < ActiveRecord::Base
   sortable_by :title, :id
 end
 
-Post.sorted_by('title')     # => ORDER BY posts.title ASC
-Post.sorted_by('-title')    # => ORDER BY posts.title DESC
-Post.sorted_by('bad,title') # => ORDER BY posts.title ASC
-Post.sorted_by(nil)         # => ORDER BY posts.title ASC
+Post.sorted_by('title')     # => ORDER BY LOWER(posts.title) ASC
+Post.sorted_by('-title')    # => ORDER BY LOWER(posts.title) DESC
+Post.sorted_by('bad,title') # => ORDER BY LOWER(posts.title) ASC
+Post.sorted_by(nil)         # => ORDER BY LOWER(posts.title) ASC
 ```
 
-Case-insensitive:
+Case-sensitive:
 
 ```ruby
 class Post < ActiveRecord::Base
   sortable_by do |x|
-    x.field :title, as: arel_table[:title].lower
+    x.field :title, case_sensitive: true
     x.field :id
   end
 end
 
-Post.sorted_by('title') # => ORDER BY LOWER(posts.title) ASC
+Post.sorted_by('title') # => ORDER BY posts.title ASC
 ```
 
 With custom default:
@@ -46,7 +46,7 @@ class Post < ActiveRecord::Base
   sortable_by :id, :topic, :created_at, default: 'topic,-created_at'
 end
 
-Post.sorted_by(nil) # => ORDER BY posts.topic ASC, posts.created_at DESC
+Post.sorted_by(nil) # => ORDER BY LOWER(posts.topic) ASC, posts.created_at DESC
 ```
 
 Composition:
@@ -68,8 +68,8 @@ Associations (eager load):
 class Product < ActiveRecord::Base
   belongs_to :shop
   sortable_by do |x|
-    x.field :name, as: arel_table[:name].lower
-    x.field :shop, as: Shop.arel_table[:name].lower, eager_load: :shop
+    x.field :name
+    x.field :shop, as: Shop.arel_table[:name], eager_load: :shop
     x.default 'shop,name'
   end
 end
@@ -77,11 +77,11 @@ end
 
 Associations (custom scope):
 
-```
+```ruby
 class Product < ActiveRecord::Base
   belongs_to :shop
   sortable_by do |x|
-    x.field :shop, as: Shop.arel_table[:name].lower, scope: -> { joins(:shop) }
+    x.field :shop, as: Shop.arel_table[:name], scope: -> { joins(:shop) }
   end
 end
 ```

data/lib/sortable_by.rb

@@ -17,9 +17,9 @@ module ActiveRecord # :nodoc:
         duplicate
       end
 
-      def field(name, opts = {})
+      def field(name, **opts)
         name = name.to_s
-        @_fields[name] = Field.new(name, opts)
+        @_fields[name] = Field.new(name, **opts)
         @_default ||= name
       end
 
@@ -36,7 +36,7 @@ module ActiveRecord # :nodoc:
 
       protected
 
-      def order(relation, expr, fallback = true)
+      def order(relation, expr, fallback: true)
         matched = false
         expr.to_s.split(',').each do |name|
           name.strip!
@@ -50,22 +50,25 @@ module ActiveRecord # :nodoc:
           field = _fields[name]
           next unless field
 
-          matched  = true
+          matched = true
           relation = field.order(relation, rank)
         end
 
-        relation = order(relation, _default, false) if fallback && !matched && _default
+        relation = order(relation, _default, fallback: false) if fallback && !matched && _default
         relation
       end
     end
 
     class Field # :nodoc:
-      def initialize(name, opts = {})
-        @cols = Array.wrap(opts[:as])
-        @eager_load = Array.wrap(opts[:eager_load]).presence
+      STRING_TYPES = %i[string text].freeze # :nodoc:
+
+      def initialize(name, as: nil, scope: nil, eager_load: nil, case_sensitive: false)
+        @cols = Array.wrap(as)
+        @eager_load = Array.wrap(eager_load).presence
+        @case_sensitive = case_sensitive == true
 
         # validate custom_scope
-        @custom_scope = opts[:scope]
+        @custom_scope = scope
         raise ArgumentError, "Invalid sortable-by field '#{name}': scope must be a Proc." if @custom_scope && !@custom_scope.is_a?(Proc)
 
         # normalize cols
@@ -86,7 +89,10 @@ module ActiveRecord # :nodoc:
         @cols.each do |col|
           case col
           when String, Symbol
-            relation = relation.order(col => rank)
+            type = relation.columns_hash[col.to_s].type
+            col  = relation.arel_table[col]
+            col  = col.lower if STRING_TYPES.include?(type) && !@case_sensitive
+            relation = relation.order(col.send(rank))
           when Arel::Nodes::Node, Arel::Attributes::Attribute
             relation = relation.order(col.send(rank))
           when Proc
@@ -117,10 +123,10 @@ module ActiveRecord # :nodoc:
     #     sortable_by :title, :id
     #   end
     #
-    #   # Case-insensitive
+    #   # Case-sensitive
     #   class Post < ActiveRecord::Base
     #     sortable_by do |x|
-    #       x.field :title, as: arel_table[:title].lower
+    #       x.field :title, case_sensitive: true
     #       x.field :id
     #     end
     #   end
@@ -144,7 +150,7 @@ module ActiveRecord # :nodoc:
     #
     #     sortable_by do |x|
     #       x.field :name
-    #       x.field :shop, as: Shop.arel_table[:name].lower, eager_load: :shop
+    #       x.field :shop, as: Shop.arel_table[:name], eager_load: :shop
     #       x.default 'shop,name'
     #     end
     #   end
@@ -154,17 +160,16 @@ module ActiveRecord # :nodoc:
     #     belongs_to :shop
     #
     #     sortable_by do |x|
-    #       x.field :shop, as: Shop.arel_table[:name].lower, scope: -> { joins(:shop) }
+    #       x.field :shop, as: Shop.arel_table[:name], scope: -> { joins(:shop) }
     #     end
     #   end
     #
-    def sortable_by(*attributes)
+    def sortable_by(*attributes, **opts)
       config  = _sortable_by_config
-      opts    = attributes.extract_options!
       default = opts.delete(:default)
 
       attributes.each do |name|
-        config.field(name, opts)
+        config.field(name, **opts)
       end
       config.default(default) if default
       yield config if block_given?

data/sortable-by.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'sortable-by'
-  s.version     = '0.12.1'
+  s.version     = '0.13.0'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Generate white-listed sort scopes from URL parameter values'

data/spec/spec_helper.rb

@@ -17,14 +17,14 @@ ActiveRecord::Base.connection.create_table :posts do |t|
 end
 
 class Post < ActiveRecord::Base
-  sortable_by :title, default: '-created' do |s|
+  sortable_by :title, default: '-created', case_sensitive: true do |s|
     s.field :created, as: arel_table[:created_at]
   end
 end
 
 class SubPost < Post
   sortable_by do |s|
-    s.field :title, as: arel_table[:title].lower
+    s.field :title
   end
 end
 
@@ -65,8 +65,8 @@ class Product < ActiveRecord::Base
   belongs_to :shop
 
   sortable_by do |s|
-    s.field :name, as: arel_table[:name].lower
-    s.field :shop, as: Shop.arel_table[:name].lower, eager_load: :shop
+    s.field :name
+    s.field :shop, as: Shop.arel_table[:name], eager_load: :shop
     s.default 'shop,name'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sortable-by
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord