sortable-by 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bb07dd11741d2ea29ae694e1e6bc11711e8427b137855ff84fe6760e182e59e
-  data.tar.gz: a5d2b6e874053630307e891855e542b6874adad75788e6a0c822a2e9336d490d
+  metadata.gz: 8ecdfdde420426271df2fbc5ed0c8360f2d3397ef8def31a94847f5dd78916a9
+  data.tar.gz: 4abb2f7fae1f56d461ac2c834db694182aa3c8e61c24a9af05618536243abb52
 SHA512:
-  metadata.gz: 95feb9e2a5ba054e128572c35da39246760472ecb12c456976e267cac7eaa425c61505bce2037af98c5e33d5f20513571405395f1c462ad2054f6032d6600a5c
-  data.tar.gz: 610babd95b3ba593f9f566720e549929e13aef5031aa7330f7e87a07feac48b68483f2c5d2bc14489d81dd0728e39d405aeeb6d7681437598a98078e10f2e437
+  metadata.gz: 8da947750cfc43e55b56b9040cd251368d93ac48efdeeee853da1294d2f5e69103f13271fe0da998cd1f4cb4e32e04e5a1643d406d8e057b19637cca152c7e94
+  data.tar.gz: e2a0a08467f48a5357e12e33cf98069e8b1026e950fca8512ae0a278484dab3ff3022f9ea0ff1bdfbd650996831aa8190705dbb91e320332236da1d3f8339286

data/.github/workflows/{ruby.yml → test.yml}

@@ -1,4 +1,4 @@
-name: Ruby
+name: Test
 
 on:
   push:
@@ -7,13 +7,16 @@ on:
     branches: [main]
 
 jobs:
-  test:
+  ruby:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["2.6", "2.7", "3.0"]
+        ruby-version: ["2.7", "3.0", "3.1"]
+        gemfiles: ["Gemfile", "Gemfile.rails6"]
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}

data/.rubocop.yml

@@ -6,10 +6,12 @@ inherit_mode:
     - Exclude
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 Naming/MethodParameterName:
   MinNameLength: 2
 Naming/MemoizedInstanceVariableName:
   Enabled: false
 Naming/FileName:
   Exclude: [lib/sortable-by.rb]
+Metrics/ParameterLists:
+  Max: 10

data/Gemfile.lock

@@ -1,86 +1,77 @@
 PATH
   remote: .
   specs:
-    sortable-by (0.13.1)
+    sortable-by (0.14.0)
       activerecord
       activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activesupport (6.1.3)
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activerecord (7.0.3)
+      activemodel (= 7.0.3)
+      activesupport (= 7.0.3)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       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.9)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    minitest (5.16.1)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    rack (2.2.3)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.4)
-    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)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-bsm (0.5.4)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-bsm (0.6.0)
       rubocop (~> 1.0)
       rubocop-performance
-      rubocop-rails
       rubocop-rake
       rubocop-rspec
-    rubocop-performance (1.10.1)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-performance (1.14.2)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
-      activesupport (>= 4.2.0)
-      rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    sqlite3 (1.4.2)
+    sqlite3 (1.4.4)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   ruby
@@ -94,4 +85,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.1.4
+   2.3.9

data/Gemfile.rails6

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'activerecord', '~> 6.1'

data/Gemfile.rails6.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    sortable-by (0.14.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.6)
+      activesupport (= 6.1.6)
+    activerecord (6.1.6)
+      activemodel (= 6.1.6)
+      activesupport (= 6.1.6)
+    activesupport (6.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.1)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-bsm (0.6.0)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rake
+      rubocop-rspec
+    rubocop-performance (1.14.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    sqlite3 (1.4.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (~> 6.1)
+  bundler
+  rake
+  rspec
+  rubocop-bsm
+  sortable-by!
+  sqlite3
+
+BUNDLED WITH
+   2.3.9

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,10 +20,12 @@ class Post < ActiveRecord::Base
   sortable_by :title, :id
 end
 
-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
+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-sensitive:

data/lib/sortable_by.rb

@@ -38,7 +38,7 @@ module ActiveRecord # :nodoc:
 
       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
@@ -65,6 +65,10 @@ module ActiveRecord # :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
+        if @eager_load
+          inner = @eager_load.inspect
+          ActiveSupport::Deprecation.warn("using :eager_load in sortable_by blocks is deprecated. Please pass scope: -> { includes(#{inner}) } instead.")
+        end
         @case_sensitive = case_sensitive == true
 
         # validate custom_scope
@@ -101,7 +105,7 @@ module ActiveRecord # :nodoc:
         end
 
         relation = relation.eager_load(*@eager_load) if @eager_load
-        relation = relation.instance_eval(&@custom_scope) if @custom_scope
+        relation = relation.instance_exec(&@custom_scope) if @custom_scope
         relation
       end
     end

data/sortable-by.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'sortable-by'
-  s.version     = '0.13.1'
+  s.version     = '0.14.0'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Generate white-listed sort scopes from URL parameter values'
@@ -9,9 +9,8 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
 
   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.6'
+  s.required_ruby_version = '>= 2.7'
 
   s.add_dependency 'activerecord'
   s.add_dependency 'activesupport'
@@ -21,4 +20,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop-bsm'
   s.add_development_dependency 'sqlite3'
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sortable-by
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -115,23 +115,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
+- Gemfile.rails6
+- Gemfile.rails6.lock
 - LICENSE
 - README.md
 - Rakefile
 - lib/sortable-by.rb
 - lib/sortable_by.rb
 - sortable-by.gemspec
-- spec/active_record/sortable_by_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/bsm/sortable-by
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -140,17 +141,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Generate white-listed sort scopes from URL parameter values
-test_files:
-- spec/active_record/sortable_by_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/spec/active_record/sortable_by_spec.rb

@@ -1,86 +0,0 @@
-require 'spec_helper'
-
-describe ActiveRecord::SortableBy do
-  before do
-    c = ActiveRecord::Base.connection
-    c.tables.each do |t|
-      c.update "DELETE FROM #{t}"
-    end
-  end
-
-  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])
-    expect(SubPost._sortable_by_config._default).to eq('-created')
-
-    expect(App._sortable_by_config._fields.keys).to match_array(%w[name version])
-    expect(App._sortable_by_config._default).to eq('name')
-
-    expect(Shop._sortable_by_config._fields.keys).to be_empty
-    expect(Shop._sortable_by_config._default).to be_nil
-
-    expect(Product._sortable_by_config._fields.keys).to match_array(%w[name shop])
-    expect(Product._sortable_by_config._default).to eq('shop,name')
-  end
-
-  it 'simplies order' 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)
-
-    expect(Post.sorted_by(nil).pluck(:title)).to eq(%w[b A C])
-    expect(Post.sorted_by('').pluck(:title)).to eq(%w[b A C])
-    expect(Post.sorted_by('invalid').pluck(:title)).to eq(%w[b A C])
-
-    expect(Post.sorted_by('-created').pluck(:title)).to eq(%w[b A C])
-    expect(Post.sorted_by('created').pluck(:title)).to eq(%w[C A b])
-
-    expect(Post.sorted_by('title').pluck(:title)).to eq(%w[A C b])
-    expect(Post.sorted_by('-title').pluck(:title)).to eq(%w[b C A])
-    expect(Post.sorted_by('   title ').pluck(:title)).to eq(%w[A C b])
-  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)
-    SubPost.create! title: 'D', created_at: Time.at(1515151500)
-
-    expect(Post.sorted_by(nil).pluck(:title)).to eq(%w[A b D C])
-    expect(SubPost.sorted_by(nil).pluck(:title)).to eq(%w[A b D])
-    expect(SubPost.sorted_by('-created').pluck(:title)).to eq(%w[A b D])
-    expect(SubPost.sorted_by('created').pluck(:title)).to eq(%w[D b A])
-
-    expect(Post.sorted_by('title').pluck(:title)).to eq(%w[A C D b])
-    expect(SubPost.sorted_by('title').pluck(:title)).to eq(%w[A b D])
-  end
-
-  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
-    App.create! name: 'C', major: 1, minor: 1, patch: 0
-    App.create! name: 'B', major: 2, minor: 2, patch: 0
-
-    expect(App.sorted_by(nil).pluck(:name)).to eq(%w[A B C D E])
-    expect(App.sorted_by('version').pluck(:name)).to eq(%w[E A D C B])
-    expect(App.sorted_by('-version').pluck(:name)).to eq(%w[B C D A E])
-  end
-
-  it 'supports associations' do
-    y = Shop.create! name: 'Y'
-    x = Shop.create! name: 'X'
-
-    Product.create! name: 'a', shop_id: y.id
-    Product.create! name: 'B', shop_id: y.id, active: false
-    Product.create! name: 'c', shop_id: x.id
-    Product.create! name: 'D', shop_id: y.id
-    Product.create! name: 'e', shop_id: x.id
-    Product.create! name: 'f', shop_id: x.id, active: false
-
-    expect(Product.sorted_by(nil).pluck(:name)).to eq(%w[c e f a B D])
-    expect(Product.where(active: true).sorted_by(nil).pluck(:name)).to eq(%w[c e a D])
-    expect(Product.sorted_by('name').pluck(:name)).to eq(%w[a B c D e f])
-  end
-end

data/spec/spec_helper.rb

@@ -1,72 +0,0 @@
-ENV['RACK_ENV'] ||= 'test'
-require 'sortable-by'
-require 'rspec'
-
-ActiveRecord::Base.configurations = {
-  'test' => {
-    'adapter'  => 'sqlite3',
-    'database' => ':memory:',
-  },
-}
-ActiveRecord::Base.establish_connection :test
-
-ActiveRecord::Base.connection.create_table :posts do |t|
-  t.string :type
-  t.string :title, null: false
-  t.timestamp :created_at, null: false
-end
-
-class Post < ActiveRecord::Base
-  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
-  end
-end
-
-# ---------------------------------------------------------------------
-
-ActiveRecord::Base.connection.create_table :apps do |t|
-  t.string :name, null: false
-  t.integer :major, null: false
-  t.integer :minor, null: false
-  t.integer :patch, null: false
-end
-
-class App < ActiveRecord::Base
-  sortable_by :name do |s|
-    s.field :version, as: %i[major minor patch]
-  end
-end
-
-# ---------------------------------------------------------------------
-
-ActiveRecord::Base.connection.create_table :shops do |t|
-  t.string :name, null: false
-end
-
-class Shop < ActiveRecord::Base
-end
-
-# ---------------------------------------------------------------------
-
-ActiveRecord::Base.connection.create_table :products do |t|
-  t.string :name, null: false
-  t.integer :shop_id, null: false
-  t.boolean :active, null: false, default: true
-  t.foreign_key :shops
-end
-
-class Product < ActiveRecord::Base
-  belongs_to :shop
-
-  sortable_by do |s|
-    s.field :name
-    s.field :shop, as: Shop.arel_table[:name], eager_load: :shop
-    s.default 'shop,name'
-  end
-end