sortable-by 0.11.1 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f74bd1b80f7d18fe84542fd593e14be0d8dc552bb0a5936fd733d5cf9c93018e
-  data.tar.gz: f44b03bfeb96d7bbdfda93013a10614d394e2731dcf57b0a68233005ba25f063
+  metadata.gz: 6412f520dea934585eaa16b0ec4f4b45fb088ed0274057de0c9c4ad38bd05d2c
+  data.tar.gz: 76a714b65c57e5c3b56ded227be2cfe80f66e469435b3d7f0c94bd11f1364493
 SHA512:
-  metadata.gz: c9ee512ce1eeeb0e4230ee8fe43e01f2bb5695a0b3633dae440f5231ddb53aa6d7cc3e65a97353f3fd344e5838a89340f72349ab43a53dfba9ad50918ac43bd7
-  data.tar.gz: 32bcfed467633bfe35825501e1d8abd6fdf4e48a931e71d66499b705cef73834a20cf62814d40db765e9223bd3338549319cf31b785f6cf6fb0c35ddccb05650
+  metadata.gz: eefaafc008737c4f728164566d6a73a23fb845f04e84660eed18b6ba9770c8b3649c4d7d26b7376cf1f2b24e84e5054bed6038cf0a6ad863cce5db2985dc804d
+  data.tar.gz: 06acb810e43171c8a8e3687c9ebfde4f193750aed2449b5360d7bcc9bffb660b7dc574cbd01f1b6af8923dfb3b7a5bb873a1532f4227b8e16c4a18a770bd2095

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  ruby:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.6", "2.7", "3.0"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.rubocop.yml

@@ -1,9 +1,14 @@
-inherit_from:
-  - https://gitlab.com/bsm/misc/raw/master/rubocop/default.yml
+inherit_gem:
+  rubocop-bsm:
+    - default.yml
+inherit_mode:
+  merge:
+    - Exclude
 
 AllCops:
-  TargetRubyVersion: 2.4
-
+  TargetRubyVersion: 2.6
+Naming/MethodParameterName:
+  MinNameLength: 2
 Naming/MemoizedInstanceVariableName:
   Enabled: false
 Naming/FileName:

data/Gemfile.lock

@@ -1,63 +1,80 @@
 PATH
   remote: .
   specs:
-    sortable-by (0.11.1)
+    sortable-by (0.13.2)
       activerecord
       activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
-      arel (>= 9.0)
-    activesupport (5.2.3)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activerecord (6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
-    ast (2.4.0)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    i18n (1.6.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
-    minitest (5.11.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.72.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.16.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    sqlite3 (1.4.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-bsm (0.6.0)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rake
+      rubocop-rspec
+    rubocop-performance (1.11.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    sqlite3 (1.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -66,9 +83,9 @@ DEPENDENCIES
   bundler
   rake
   rspec
-  rubocop
+  rubocop-bsm
   sortable-by!
   sqlite3
 
 BUNDLED WITH
-   1.17.2
+   2.2.19

data/README.md

@@ -1,6 +1,6 @@
 # Sortable By
 
-[![Build Status](https://travis-ci.org/bsm/sortable-by.png?branch=master)](https://travis-ci.org/bsm/sortable-by)
+[![Test](https://github.com/bsm/sortable-by/actions/workflows/test.yml/badge.svg)](https://github.com/bsm/sortable-by/actions/workflows/test.yml)
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 ActiveRecord plugin to parse the sort order from a query parameter, match against a white-list and generate a scope. Useful for [JSON-API][jsonapi] compatibility.
@@ -20,23 +20,25 @@ 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('title,-id')      # => ORDER BY LOWER(posts.title) ASC, id DESC
+Post.sorted_by(['title', '-id']) # => ORDER BY LOWER(posts.title) ASC, id 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 +48,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 +70,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 +79,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,36 +36,39 @@ 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|
+        Array.wrap(expr).flat_map {|v| v.to_s.split(',') }.each do |name|
           name.strip!
 
           rank = :asc
           if name[0] == '-'
             rank = :desc
-            name = name[1..-1]
+            name = name[1..]
           end
 
           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.11.1'
+  s.version     = '0.13.2'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Generate white-listed sort scopes from URL parameter values'
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^spec/}) }
   s.test_files    = `git ls-files -z -- spec/*`.split("\x0")
   s.require_paths = ['lib']
-  s.required_ruby_version = '>= 2.4'
+  s.required_ruby_version = '>= 2.6'
 
   s.add_dependency 'activerecord'
   s.add_dependency 'activesupport'
@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-bsm'
   s.add_development_dependency 'sqlite3'
 end

data/spec/{sortable_by_spec.rb → active_record/sortable_by_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('./spec_helper', __dir__)
+require 'spec_helper'
 
 describe ActiveRecord::SortableBy do
   before do
@@ -8,7 +8,7 @@ describe ActiveRecord::SortableBy do
     end
   end
 
-  it 'should have config' do
+  it 'has config' do
     expect(Post._sortable_by_config._fields.keys).to match_array(%w[title created])
     expect(Post._sortable_by_config._default).to eq('-created')
     expect(SubPost._sortable_by_config._fields.keys).to match_array(%w[title created])
@@ -24,7 +24,7 @@ describe ActiveRecord::SortableBy do
     expect(Product._sortable_by_config._default).to eq('shop,name')
   end
 
-  it 'should simply order' do
+  it 'supports simple ordering' do
     Post.create! title: 'A', created_at: Time.at(1515151500)
     Post.create! title: 'b', created_at: Time.at(1515151600)
     Post.create! title: 'C', created_at: Time.at(1515151400)
@@ -41,7 +41,16 @@ describe ActiveRecord::SortableBy do
     expect(Post.sorted_by('   title ').pluck(:title)).to eq(%w[A C b])
   end
 
-  it 'should support STI inheritance and overrides' do
+  it 'supports array params' do
+    Post.create! title: 'A', created_at: Time.at(1515151500)
+    Post.create! title: 'C', created_at: Time.at(1515151400)
+    Post.create! title: 'B', created_at: Time.at(1515151400)
+
+    expect(Post.sorted_by(['created', '-title']).pluck(:title)).to eq(%w[C B A])
+    expect(Post.sorted_by(['created ,  -title']).pluck(:title)).to eq(%w[C B A])
+  end
+
+  it 'supports STI inheritance and overrides' do
     SubPost.create! title: 'A', created_at: Time.at(1515151700)
     SubPost.create! title: 'b', created_at: Time.at(1515151600)
     Post.create! title: 'C', created_at: Time.at(1515151400)
@@ -56,7 +65,7 @@ describe ActiveRecord::SortableBy do
     expect(SubPost.sorted_by('title').pluck(:title)).to eq(%w[A b D])
   end
 
-  it 'should support composition' do
+  it 'supports composition' do
     App.create! name: 'E', major: 0, minor: 9, patch: 2
     App.create! name: 'A', major: 1, minor: 0, patch: 1
     App.create! name: 'D', major: 1, minor: 0, patch: 6
@@ -68,7 +77,7 @@ describe ActiveRecord::SortableBy do
     expect(App.sorted_by('-version').pluck(:name)).to eq(%w[B C D A E])
   end
 
-  it 'should support associations' do
+  it 'supports associations' do
     y = Shop.create! name: 'Y'
     x = Shop.create! name: 'X'
 

data/spec/spec_helper.rb

@@ -2,9 +2,11 @@ ENV['RACK_ENV'] ||= 'test'
 require 'sortable-by'
 require 'rspec'
 
-ActiveRecord::Base.configurations['test'] = {
-  'adapter'  => 'sqlite3',
-  'database' => ':memory:',
+ActiveRecord::Base.configurations = {
+  'test' => {
+    'adapter'  => 'sqlite3',
+    'database' => ':memory:',
+  },
 }
 ActiveRecord::Base.establish_connection :test
 
@@ -15,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
 
@@ -63,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.11.1
+  version: 0.13.2
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2021-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-bsm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,9 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -126,7 +126,7 @@ files:
 - lib/sortable-by.rb
 - lib/sortable_by.rb
 - sortable-by.gemspec
-- spec/sortable_by_spec.rb
+- spec/active_record/sortable_by_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bsm/sortable-by
 licenses:
@@ -140,17 +140,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Generate white-listed sort scopes from URL parameter values
 test_files:
-- spec/sortable_by_spec.rb
+- spec/active_record/sortable_by_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,7 +0,0 @@
-sudo: false
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-gemfile:
-  - Gemfile