sortable-by 0.9.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c69dc4027db827d7339df15f6b6a82a00dd106c3
-  data.tar.gz: 6542aa11412834bd4360db4f6f989e2fb56358de
+SHA256:
+  metadata.gz: 7e89dd7025ad14bfd9a012b10d68a70183692121625d14e56feea7e3484d8398
+  data.tar.gz: 931017877555f573485ebbaecb5501ba36e5e4c3a2c7d0842ada6ff2f68cd5fb
 SHA512:
-  metadata.gz: 12165f68bf353d543f8701ed328586822a8c43d729cd514b8695821214a424926507e53e0fb443639a2051e28626733e6edcb47a5f5530949ae9bd6e9e80aa0a
-  data.tar.gz: 9008ae98a2a8aacb2bf807b9db1eb428fc6934e39e84ae11369919f46cbe75463c3e63ceb3897f88819cd5b125071c47591290bb0c2d33f950114c0966cd2219
+  metadata.gz: 45ef18f0d53caa91e2e9cb0c8bcbae4bf4cdc3da59b844e1ddae2f5fa16454905d925a7212a31e4355f077fe7436b25303f17422c47f25592a3036cd623caba3
+  data.tar.gz: 724fd46c5ea0fd379980dcfe64a58ea579d9d03edab02516862d654ccc5a472d10bc810ccf48a32d4cc96e70ed5608100596425091c7a541dae5f380f8f4a173

data/.gitignore

@@ -1,3 +1,5 @@
 spec/tmp
 pkg
 *.gem
+.rake_tasks~
+.rubocop-*

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from:
+  - https://gitlab.com/bsm/misc/raw/master/rubocop/default.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Naming/FileName:
+  Exclude: [lib/sortable-by.rb]

data/.travis.yml

@@ -1,8 +1,8 @@
+sudo: false
 rvm:
-  - 1.9.3
-  - 2.1.2
-  - 2.2.2
-  - 2.3.2
-  - 2.4.0
+  - 2.5
+  - 2.6
 gemfile:
   - Gemfile
+before_install:
+  - gem install bundler

data/Gemfile

@@ -1,2 +1,2 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 gemspec

data/Gemfile.lock

@@ -1,47 +1,66 @@
 PATH
   remote: .
   specs:
-    sortable-by (0.9.0)
+    sortable-by (0.12.1)
       activerecord
       activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (5.0.1)
-      activesupport (= 5.0.1)
-    activerecord (5.0.1)
-      activemodel (= 5.0.1)
-      activesupport (= 5.0.1)
-      arel (~> 7.0)
-    activesupport (5.0.1)
+    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)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (7.1.4)
-    concurrent-ruby (1.0.4)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
-    i18n (0.8.1)
-    minitest (5.10.1)
-    rake (12.0.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.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-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    sqlite3 (1.3.13)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.84.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.2)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -50,8 +69,9 @@ DEPENDENCIES
   bundler
   rake
   rspec
+  rubocop
   sortable-by!
   sqlite3
 
 BUNDLED WITH
-   1.14.3
+   2.1.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015-2018 Black Square Media
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,5 +1,8 @@
 # Sortable By
 
+[![Build Status](https://travis-ci.org/bsm/sortable-by.png?branch=master)](https://travis-ci.org/bsm/sortable-by)
+[![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.
 
 [jsonapi]: http://jsonapi.org/format/#fetching-sorting
@@ -10,39 +13,75 @@ Add `gem 'sortable-by'` to your Gemfile.
 
 ## Usage
 
-Simple use cases:
+Simple:
 
 ```ruby
-class Foo < ActiveRecord::Base
-  sortable_by :title, :updated_at, default: { updated_at: :desc }
+class Post < ActiveRecord::Base
+  sortable_by :title, :id
 end
 
-Foo.sorted_by "-updated_at,title" # => ORDER BY updated_at DESC, title ASC
-Foo.sorted_by "bad,title"         # => ORDER BY title ASC
-Foo.sorted_by nil                 # => ORDER BY updated_at DESC
+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
 ```
 
-## LICENCE
+Case-insensitive:
+
+```ruby
+class Post < ActiveRecord::Base
+  sortable_by do |x|
+    x.field :title, as: arel_table[:title].lower
+    x.field :id
+  end
+end
 
+Post.sorted_by('title') # => ORDER BY LOWER(posts.title) ASC
 ```
-Copyright (c) 2015 Black Square Media
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+With custom default:
+
+```ruby
+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
+```
+
+Composition:
+
+```ruby
+class App < ActiveRecord::Base
+  sortable_by :name, default: '-version' do |x|
+    x.field :version, as: %i[major minor patch]]
+  end
+end
+
+App.sorted_by('version') # => ORDER BY apps.major ASC, apps.minor ASC, apps.patch ASC
+App.sorted_by(nil)       # => ORDER BY apps.major DESC, apps.minor DESC, apps.patch DESC
+```
+
+Associations (eager load):
+
+```ruby
+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.default 'shop,name'
+  end
+end
+```
+
+Associations (custom scope):
+
+```
+class Product < ActiveRecord::Base
+  belongs_to :shop
+  sortable_by do |x|
+    x.field :shop, as: Shop.arel_table[:name].lower, scope: -> { joins(:shop) }
+  end
+end
 ```

data/Rakefile

@@ -1,6 +1,9 @@
 require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/lib/sortable_by.rb

@@ -1,42 +1,184 @@
 require 'active_record'
-require 'active_support/concern'
-require 'set'
 
-module ActiveRecord
-  module SortableByHelper
-    extend ActiveSupport::Concern
+module ActiveRecord # :nodoc:
+  module SortableBy # :nodoc:
+    class Config # :nodoc:
+      attr_reader :_fields, :_default
 
-    included do
-      class_attribute :_sortable_by_scope_options, instance_accessor: false
-      sortable_by
-    end
+      def initialize
+        @_fields  = {}
+        @_default = nil
+      end
+
+      def dup
+        duplicate = self.class.new
+        duplicate.instance_variable_set :@_fields, _fields.deep_dup
+        duplicate.instance_variable_set :@_default, _default.deep_dup
+        duplicate
+      end
 
-    module ClassMethods
+      def field(name, opts = {})
+        name = name.to_s
+        @_fields[name] = Field.new(name, opts)
+        @_default ||= name
+      end
+
+      def default(expr)
+        # legacy support
+        if expr.is_a?(Hash)
+          expr = expr.map do |field, dir|
+            [(dir == :desc ? '-' : ''), field].join
+          end.join(',')
+        end
 
-      def sortable_by(*whitelist)
-        opts = whitelist.extract_options!
-        opts[:default] ||= {id: :asc}
-        self._sortable_by_scope_options = opts.merge(whitelist: whitelist.map(&:to_s).to_set)
+        @_default = expr.to_s
       end
 
-      # @param [String] expr the sort expr
-      # @return [ActiveRecord::Relation] the scoped relation
-      def sorted_by(expr)
-        options = {}
+      protected
+
+      def order(relation, expr, fallback = true)
+        matched = false
         expr.to_s.split(',').each do |name|
           name.strip!
+
           rank = :asc
-          rank, name = :desc, name[1..-1] if name[0] == '-'
-          options[name.to_sym] = rank if self._sortable_by_scope_options[:whitelist].include?(name)
+          if name[0] == '-'
+            rank = :desc
+            name = name[1..-1]
+          end
+
+          field = _fields[name]
+          next unless field
+
+          matched  = true
+          relation = field.order(relation, rank)
         end
-        options = self._sortable_by_scope_options[:default] if options.empty?
-        order(options)
+
+        relation = order(relation, _default, 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
+
+        # validate custom_scope
+        @custom_scope = opts[:scope]
+        raise ArgumentError, "Invalid sortable-by field '#{name}': scope must be a Proc." if @custom_scope && !@custom_scope.is_a?(Proc)
+
+        # normalize cols
+        @cols.push name if @cols.empty?
+        @cols.each do |col|
+          case col
+          when String, Symbol, Arel::Attributes::Attribute, Arel::Nodes::Node
+            next
+          when Proc
+            raise ArgumentError, "Invalid sortable-by field '#{name}': proc must accept 2 arguments." unless col.arity == 2
+          else
+            raise ArgumentError, "Invalid sortable-by field '#{name}': invalid type #{col.class}."
+          end
+        end
+      end
+
+      def order(relation, rank)
+        @cols.each do |col|
+          case col
+          when String, Symbol
+            relation = relation.order(col => rank)
+          when Arel::Nodes::Node, Arel::Attributes::Attribute
+            relation = relation.order(col.send(rank))
+          when Proc
+            relation = col.call(relation, rank)
+          end
+        end
+
+        relation = relation.eager_load(*@eager_load) if @eager_load
+        relation = relation.instance_eval(&@custom_scope) if @custom_scope
+        relation
+      end
+    end
+
+    def self.extended(base) # :nodoc:
+      base.class_attribute :_sortable_by_config, instance_accessor: false, instance_predicate: false
+      base._sortable_by_config = Config.new
+    end
+
+    def inherited(base) # :nodoc:
+      base._sortable_by_config = _sortable_by_config.deep_dup
+      super
+    end
+
+    # Declare sortable attributes and scopes. Examples:
+    #
+    #   # Simple
+    #   class Post < ActiveRecord::Base
+    #     sortable_by :title, :id
+    #   end
+    #
+    #   # Case-insensitive
+    #   class Post < ActiveRecord::Base
+    #     sortable_by do |x|
+    #       x.field :title, as: arel_table[:title].lower
+    #       x.field :id
+    #     end
+    #   end
+    #
+    #   # With default
+    #   class Post < ActiveRecord::Base
+    #     sortable_by :id, :topic, :created_at,
+    #       default: 'topic,-created_at'
+    #   end
+    #
+    #   # Composition
+    #   class App < ActiveRecord::Base
+    #     sortable_by :name, default: '-version' do |x|
+    #       x.field :version, as: %i[major minor patch]]
+    #     end
+    #   end
+    #
+    #   # Associations (eager load)
+    #   class Product < ActiveRecord::Base
+    #     belongs_to :shop
+    #
+    #     sortable_by do |x|
+    #       x.field :name
+    #       x.field :shop, as: Shop.arel_table[:name].lower, eager_load: :shop
+    #       x.default 'shop,name'
+    #     end
+    #   end
+    #
+    #   # Associations (custom scope)
+    #   class Product < ActiveRecord::Base
+    #     belongs_to :shop
+    #
+    #     sortable_by do |x|
+    #       x.field :shop, as: Shop.arel_table[:name].lower, scope: -> { joins(:shop) }
+    #     end
+    #   end
+    #
+    def sortable_by(*attributes)
+      config  = _sortable_by_config
+      opts    = attributes.extract_options!
+      default = opts.delete(:default)
+
+      attributes.each do |name|
+        config.field(name, opts)
+      end
+      config.default(default) if default
+      yield config if block_given?
+      config
+    end
 
+    # @param [String] expr the sort expr
+    # @return [ActiveRecord::Relation] the scoped relation
+    def sorted_by(expr)
+      _sortable_by_config.send :order, self, expr
     end
   end
 
-  class Base
-    include SortableByHelper
+  class Base # :nodoc:
+    extend SortableBy
   end
 end

data/sortable-by.gemspec

@@ -1,7 +1,6 @@
-# -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = 'sortable-by'
-  s.version     = '0.9.0'
+  s.version     = '0.12.1'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Generate white-listed sort scopes from URL parameter values'
@@ -12,13 +11,14 @@ 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 = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.5'
 
-  s.add_dependency 'activesupport'
   s.add_dependency 'activerecord'
+  s.add_dependency 'activesupport'
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
   s.add_development_dependency 'sqlite3'
 end

data/spec/sortable_by_spec.rb

@@ -1,23 +1,86 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.expand_path('./spec_helper', __dir__)
 
-describe ActiveRecord::SortableByHelper do
+describe ActiveRecord::SortableBy do
+  before do
+    c = ActiveRecord::Base.connection
+    c.tables.each do |t|
+      c.update "DELETE FROM #{t}"
+    end
+  end
 
   it 'should have config' do
-    expect(Foo._sortable_by_scope_options).to eq(default: {title: :asc}, whitelist: Set.new(["title", "age"]))
-    expect(Bar._sortable_by_scope_options).to eq(default: {id: :asc}, whitelist: Set.new)
+    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 'should generate scopes' do
-    expect(Foo.sorted_by("title").pluck(:title)).to eq(["A", "B", "B", "C"])
-    expect(Foo.sorted_by("-title").pluck(:title)).to eq(["C", "B", "B", "A"])
-    expect(Foo.sorted_by("age,title").pluck(:title)).to eq(["B", "A", "B", "C"])
-    expect(Foo.sorted_by("invalid , -age").pluck(:title)).to eq(["C", "B", "A", "B"])
-    expect(Foo.sorted_by("").pluck(:title)).to eq(["A", "B", "B", "C"])
-    expect(Foo.sorted_by(nil).pluck(:title)).to eq(["A", "B", "B", "C"])
-
-    expect(Bar.sorted_by("").pluck(:title)).to eq(["Y", "X"])
-    expect(Bar.sorted_by("title").pluck(:title)).to eq(["Y", "X"])
-    expect(Bar.where(title: "X").sorted_by("title").pluck(:title)).to eq(["X"])
+  it 'should simply 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 'should support 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 'should support 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 'should support 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,29 +1,72 @@
-ENV['RACK_ENV'] ||= "test"
+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
-ActiveRecord::Base.connection.create_table :foos do |t|
-  t.string :title
-  t.integer :age
+
+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' do |s|
+    s.field :created, as: arel_table[:created_at]
+  end
 end
 
-ActiveRecord::Base.connection.create_table :bars do |t|
-  t.string :title
+class SubPost < Post
+  sortable_by do |s|
+    s.field :title, as: arel_table[:title].lower
+  end
 end
 
-class Foo < ActiveRecord::Base
-  sortable_by :title, :age, default: {title: :asc}
+# ---------------------------------------------------------------------
+
+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 Bar < ActiveRecord::Base
+class App < ActiveRecord::Base
+  sortable_by :name do |s|
+    s.field :version, as: %i[major minor patch]
+  end
 end
 
-Foo.create! title: 'A', age: 25
-Foo.create! title: 'B', age: 24
-Foo.create! title: 'B', age: 26
-Foo.create! title: 'C', age: 27
+# ---------------------------------------------------------------------
 
-Bar.create! title: 'Y'
-Bar.create! title: 'X'
+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, as: arel_table[:name].lower
+    s.field :shop, as: Shop.arel_table[:name].lower, eager_load: :shop
+    s.default 'shop,name'
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: sortable-by
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -102,9 +116,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - lib/sortable-by.rb
@@ -124,15 +140,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Generate white-listed sort scopes from URL parameter values