sortable-by 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a8f7b12ede76157e3c47f2aa2e3448830ec5040
+  data.tar.gz: 32a5f7e54e4be50111e8d9fe40b5c469d37a14b7
+SHA512:
+  metadata.gz: 4f9fe1dec1e74a71f2d73c5b488047a56f5eba5615dcdcf72648b5acd05655467022da4fde1f8dd6aff62ea191ccaeaa3bcbbbbba6b46f7b5ce11926ea486486
+  data.tar.gz: 1a0a02ae09216da95b603fddecbf07bb5e3578961a9f81004e09f4aa9e5976732f1919dd0fc8797b119efdd8a787b5df455bd6be705aea7b3c42a4072279df29

data/.gitignore

@@ -0,0 +1,3 @@
+spec/tmp
+pkg
+*.gem

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.1.2
+  - 2.2.2
+gemfile:
+  - Gemfile

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    sortable-by (0.8.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+    activerecord (4.2.3)
+      activemodel (= 4.2.3)
+      activesupport (= 4.2.3)
+      arel (~> 6.0)
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.2)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.7.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sqlite3 (1.3.10)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rake
+  rspec
+  sortable-by!
+  sqlite3
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,48 @@
+# Sortable By
+
+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
+
+## Installation
+
+Add `gem 'sortable-by'` to your Gemfile.
+
+## Usage
+
+Simple use cases:
+
+```ruby
+class Foo < ActiveRecord::Base
+  sortable_by :title, :updated_at, default: { updated_at: :desc }
+end
+
+Foo.sort_by "-updated_at,title" # => ORDER BY updated_at DESC, title ASC
+Foo.sort_by "bad,title"         # => ORDER BY title ASC
+Foo.sort_by nil                 # => ORDER BY updated_at DESC
+```
+
+## LICENCE
+
+```
+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.
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/sortable-by.rb

@@ -0,0 +1 @@
+require 'sortable_by'

data/lib/sortable_by.rb

@@ -0,0 +1,42 @@
+require 'active_record'
+require 'active_support/concern'
+require 'set'
+
+module ActiveRecord
+  module SortableByHelper
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_sortable_by_scope_options, instance_accessor: false
+      sortable_by
+    end
+
+    module ClassMethods
+
+      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)
+      end
+
+      # @param [String] expr the sort expr
+      # @return [ActiveRecord::Relation] the scoped relation
+      def sort_by(expr)
+        options = {}
+        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)
+        end
+        options = self._sortable_by_scope_options[:default] if options.empty?
+        order(options)
+      end
+
+    end
+  end
+
+  class Base
+    include SortableByHelper
+  end
+end

data/sortable-by.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = 'sortable-by'
+  s.version     = '0.8.0'
+  s.authors     = ['Dimitrij Denissenko']
+  s.email       = ['dimitrij@blacksquaremedia.com']
+  s.summary     = 'Generate white-listed sort scopes from URL parameter values'
+  s.description = 'ActiveRecord plugin'
+  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.test_files    = `git ls-files -z -- spec/*`.split("\x0")
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'activesupport'
+  s.add_dependency 'activerecord'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'sqlite3'
+end

data/spec/sortable_by_spec.rb

@@ -0,0 +1,22 @@
+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)
+  end
+
+  it 'should generate scopes' do
+    expect(Foo.sort_by("title").pluck(:title)).to eq(["A", "B", "B", "C"])
+    expect(Foo.sort_by("-title").pluck(:title)).to eq(["C", "B", "B", "A"])
+    expect(Foo.sort_by("age,title").pluck(:title)).to eq(["B", "A", "B", "C"])
+    expect(Foo.sort_by("invalid , -age").pluck(:title)).to eq(["C", "B", "A", "B"])
+    expect(Foo.sort_by("").pluck(:title)).to eq(["A", "B", "B", "C"])
+    expect(Foo.sort_by(nil).pluck(:title)).to eq(["A", "B", "B", "C"])
+
+    expect(Bar.sort_by("").pluck(:title)).to eq(["Y", "X"])
+    expect(Bar.sort_by("title").pluck(:title)).to eq(["Y", "X"])
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+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 :foos do |t|
+  t.string :title
+  t.integer :age
+end
+
+ActiveRecord::Base.connection.create_table :bars do |t|
+  t.string :title
+end
+
+class Foo < ActiveRecord::Base
+  sortable_by :title, :age, 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
+
+Bar.create! title: 'Y'
+Bar.create! title: 'X'

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: sortable-by
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: rspec
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord plugin
+email:
+- dimitrij@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/sortable-by.rb
+- lib/sortable_by.rb
+- sortable-by.gemspec
+- spec/sortable_by_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bsm/sortable-by
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Generate white-listed sort scopes from URL parameter values
+test_files:
+- spec/sortable_by_spec.rb
+- spec/spec_helper.rb