sortable-by 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c69dc4027db827d7339df15f6b6a82a00dd106c3
-  data.tar.gz: 6542aa11412834bd4360db4f6f989e2fb56358de
+SHA256:
+  metadata.gz: 5b5117bc573fa2cf18ccee9dec86c53cd09920af83463e161ad97c34a50c87c4
+  data.tar.gz: 47bed91f217dfc04a5d9180040a18a163e0f2da6597059bb73ce8390c01d5d6e
 SHA512:
-  metadata.gz: 12165f68bf353d543f8701ed328586822a8c43d729cd514b8695821214a424926507e53e0fb443639a2051e28626733e6edcb47a5f5530949ae9bd6e9e80aa0a
-  data.tar.gz: 9008ae98a2a8aacb2bf807b9db1eb428fc6934e39e84ae11369919f46cbe75463c3e63ceb3897f88819cd5b125071c47591290bb0c2d33f950114c0966cd2219
+  metadata.gz: 68712cabc1e8d2bc54d4716d27cd896170fad207448814a0c784f7a018bd2da8b0fad7d26ba1cfca8cb884969665f014c3aa0912c457fbb2465a1fa4c7214c5c
+  data.tar.gz: 9d9b0f42b50c94cbcd36eec6cb2b1c1367150943a6c252092d84d45b3aecdb5ea1431ff227faa68db045b32fc02983f4d0bcb41fa1619a9f28d4a1ffd1789666

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics/AbcSize:
+  Enabled: false
+Naming/FileName:
+  Exclude: [lib/sortable-by.rb]
+Metrics/MethodLength:
+  Max: 20
+Metrics/LineLength:
+  Max: 120
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

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.2
+  - 2.3
+  - 2.4
+  - 2.5
 gemfile:
   - Gemfile

data/Gemfile

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

data/Gemfile.lock

@@ -1,47 +1,63 @@
 PATH
   remote: .
   specs:
-    sortable-by (0.9.0)
+    sortable-by (0.10.0)
       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 (5.1.5)
+      activesupport (= 5.1.5)
+    activerecord (5.1.5)
+      activemodel (= 5.1.5)
+      activesupport (= 5.1.5)
+      arel (~> 8.0)
+    activesupport (5.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (7.1.4)
-    concurrent-ruby (1.0.4)
+    arel (8.0.0)
+    ast (2.4.0)
+    concurrent-ruby (1.0.5)
     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 (0.9.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.0.4)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.53.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
     sqlite3 (1.3.13)
     thread_safe (0.3.6)
-    tzinfo (1.2.2)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
@@ -50,8 +66,9 @@ DEPENDENCIES
   bundler
   rake
   rspec
+  rubocop
   sortable-by!
   sqlite3
 
 BUNDLED WITH
-   1.14.3
+   1.16.1

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,38 @@ Add `gem 'sortable-by'` to your Gemfile.
 
 ## Usage
 
-Simple use cases:
+Simple use case:
 
 ```ruby
 class Foo < ActiveRecord::Base
   sortable_by :title, :updated_at, default: { updated_at: :desc }
 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
+Foo.sorted_by "-updated_at,title" # => ORDER BY foos.updated_at DESC, foos.title ASC
+Foo.sorted_by "bad,title"         # => ORDER BY foos.title ASC
+Foo.sorted_by nil                 # => ORDER BY foos.updated_at DESC
 ```
 
-## LICENCE
+Aliases and composition:
+
+```ruby
+class Foo < ActiveRecord::Base
+  sortable_by semver: %i[major minor patch], default: { id: :asc }
+end
 
+Foo.sorted_by "semver"   # => ORDER BY foos.major ASC, foos.minor ASC, foos.patch ASC
+Foo.sorted_by "-semver"  # => ORDER BY foos.major DESC, foos.minor DESC, foos.patch DESC
+Foo.sorted_by nil        # => ORDER BY foos.id 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.
+
+Custom functions:
+
+```ruby
+class Foo < ActiveRecord::Base
+  sortable_by insensitive: Arel::Nodes::NamedFunction.new('LOWER', [arel_table[:title]]), default: { id: :asc }
+end
+
+Foo.sorted_by "insensitive"   # => ORDER BY LOWER(foos.title) ASC
+Foo.sorted_by "-insensitive"  # => ORDER BY LOWER(foos.title) DESC
+Foo.sorted_by nil             # => ORDER BY foos.id ASC
 ```

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)
+RuboCop::RakeTask.new(:rubocop)
+
 task default: :spec

data/lib/sortable_by.rb

@@ -2,8 +2,8 @@ require 'active_record'
 require 'active_support/concern'
 require 'set'
 
-module ActiveRecord
-  module SortableByHelper
+module ActiveRecord # :nodoc:
+  module SortableByHelper # :nodoc:
     extend ActiveSupport::Concern
 
     included do
@@ -11,32 +11,86 @@ module ActiveRecord
       sortable_by
     end
 
-    module ClassMethods
+    def self.validate_custom_scope!(custom, original = custom)
+      case custom
+      when true, Arel::Nodes::Node, String, Symbol
+        nil # OK
+      when Array
+        custom.each do |v|
+          validate_custom_scope!(v, original)
+        end
+      else
+        raise ArgumentError, "Option #{original.inspect} contains unexpected values."
+      end
+    end
 
+    def self.order_clause(name, rank, value)
+      case value
+      when true
+        { name => rank }
+      when String, Symbol
+        { value => rank }
+      when Arel::Nodes::Node
+        value.send(rank)
+      when Array
+        value.map { |v| order_clause(name, rank, v) }
+      end
+    end
+
+    module ClassMethods # :nodoc:
+      # Copy _sortable_by_scope_options on inheritance.
+      def inherited(base) #:nodoc:
+        base._sortable_by_scope_options = _sortable_by_scope_options.deep_dup
+        super
+      end
+
+      # Provide a whitelist and options for sorted_by
       def sortable_by(*whitelist)
+        self._sortable_by_scope_options ||= { scopes: {}, default: { id: :asc } }
+
         opts = whitelist.extract_options!
-        opts[:default] ||= {id: :asc}
-        self._sortable_by_scope_options = opts.merge(whitelist: whitelist.map(&:to_s).to_set)
+        default = opts.delete(:default)
+        self._sortable_by_scope_options[:default] = default if default
+
+        whitelist.each do |attr|
+          self._sortable_by_scope_options[:scopes][attr.to_s] = true
+        end
+        opts.each do |attr, custom|
+          SortableByHelper.validate_custom_scope!(custom)
+          self._sortable_by_scope_options[:scopes][attr.to_s] = custom
+        end
       end
 
       # @param [String] expr the sort expr
       # @return [ActiveRecord::Relation] the scoped relation
       def sorted_by(expr)
-        options = {}
-        expr.to_s.split(',').each do |name|
+        relation = self
+        matches = expr.to_s.split(',').count 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
+
+          value  = self._sortable_by_scope_options[:scopes][name]
+          clause = SortableByHelper.order_clause(name, rank, value)
+          relation = relation.order(clause) if clause
+          clause
+        end
+
+        if matches.zero?
+          default  = self._sortable_by_scope_options[:default]
+          relation = relation.order(default)
         end
-        options = self._sortable_by_scope_options[:default] if options.empty?
-        order(options)
-      end
 
+        relation
+      end
     end
   end
 
-  class Base
+  class Base # :nodoc:
     include SortableByHelper
   end
 end

data/sortable-by.gemspec

@@ -1,7 +1,7 @@
-# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
   s.name        = 'sortable-by'
-  s.version     = '0.9.0'
+  s.version     = '0.10.0'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Generate white-listed sort scopes from URL parameter values'
@@ -9,16 +9,17 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bsm/sortable-by'
   s.license     = 'MIT'
 
-  s.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^spec/}) }
+  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.2.0'
 
-  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,28 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe ActiveRecord::SortableByHelper do
-
   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(Foo._sortable_by_scope_options).to include(:default, :scopes)
+    expect(Foo._sortable_by_scope_options[:default]).to eq(title: :asc)
+    expect(Foo._sortable_by_scope_options[:scopes]).to be_instance_of(Hash)
+    expect(Foo._sortable_by_scope_options[:scopes]).to include('title', 'age', 'semver', 'insensitive')
+    expect(Bar._sortable_by_scope_options).to eq(default: { id: :asc }, scopes: {})
   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(Foo.sorted_by('title').pluck(:title)).to eq(%w[A B C b])
+    expect(Foo.sorted_by('-title').pluck(:title)).to eq(%w[b C B A])
+    expect(Foo.sorted_by('age,title').pluck(:title)).to eq(%w[B A b C])
+    expect(Foo.sorted_by('invalid , -age').pluck(:title)).to eq(%w[C b A B])
+    expect(Foo.sorted_by('insensitive,age').pluck(:title)).to eq(%w[A B b C])
+    expect(Foo.sorted_by('-insensitive,age').pluck(:title)).to eq(%w[C B b A])
+    expect(Foo.sorted_by('semver').pluck(:title)).to eq(%w[b B C A])
+    expect(Foo.sorted_by('-semver').pluck(:title)).to eq(%w[A C B b])
+    expect(Foo.sorted_by('').pluck(:title)).to eq(%w[A B C b])
+    expect(Foo.sorted_by(nil).pluck(:title)).to eq(%w[A B C b])
 
-    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"])
+    expect(Bar.sorted_by('').pluck(:title)).to eq(%w[Y X])
+    expect(Bar.sorted_by('title').pluck(:title)).to eq(%w[Y X])
+    expect(Bar.where(title: 'X').sorted_by('title').pluck(:title)).to eq(%w[X])
   end
-
 end

data/spec/spec_helper.rb

@@ -1,29 +1,42 @@
-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
+
+  t.integer :major
+  t.integer :minor
 end
 
 ActiveRecord::Base.connection.create_table :bars do |t|
   t.string :title
 end
 
+ActiveRecord::Base.connection.create_table :boos do |t|
+  t.string :title
+end
+
 class Foo < ActiveRecord::Base
-  sortable_by :title, :age, default: {title: :asc}
+  sortable_by :title, :age,
+              insensitive: Arel::Nodes::NamedFunction.new('LOWER', [arel_table[:title]]),
+              semver: %i[major minor],
+              default: { title: :asc }
 end
 
 class Bar < ActiveRecord::Base
 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
+Foo.create! title: 'A', age: 25, major: 10, minor: 1
+Foo.create! title: 'B', age: 24, major: 8, minor: 3
+Foo.create! title: 'b', age: 26, major: 0, minor: 2
+Foo.create! title: 'C', age: 27, major: 8, minor: 6
 
 Bar.create! title: 'Y'
 Bar.create! title: 'X'

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: sortable-by
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2018-03-19 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,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -132,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Generate white-listed sort scopes from URL parameter values