order_as_specified 1.5 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c11fb5ed7165ea2a50cdab0cdb421ac0faa8a187539b0c1f661d6f64fe8107ed
-  data.tar.gz: 975e533ab7a733c8f3f68c7b6363dab96ac1d90a08f4223ba7bcc067443d21a8
+  metadata.gz: 119668cc688124610b87036f0f929c0fbcc35ef4acea5e1c2a1cdc48c1101241
+  data.tar.gz: a17df8766bfe178cac883311d8ba4b165b4e43a9c4afd1d8e4b8af0e099d5010
 SHA512:
-  metadata.gz: 8b56240f7f9527be2dfb266583ffcccd7aa8992da08139e1824f19c1ea2b82266b5a88bcbbe87db740571d07cd53b4c20bad5d67d4bd4c56d2d3fa0fc132c0cc
-  data.tar.gz: cc12430e2ef88f18225235de1900a0e1662a908da3f2f411cb64fcf9336a82f6fad886ceb99f840c718d140b832002f47aafaebc807844cdcd5cfe51ba1e8a90
+  metadata.gz: 1a53e19dc18fb420fbf88f1fb535b46a0a5c5b13a84158c237a350243f8cfefa5f78ae048087bcc939ea7ecab12e4b7aec5c62bae7960d921a83704f9a53a45e
+  data.tar.gz: 0ca1d4697d3634f442edb58173cf4d7f6199571ae1a69415cb6cb2d8b93079ff588023e5549f99ca998979cfeff93ee3ea1f2f0810afd90c8501df829d41e104

data/.gitignore

@@ -13,3 +13,4 @@
 *.a
 mkmf.log
 *.gem
+.rubocop-https---raw-githubusercontent-com-panorama-ed-code-conventions-master-rubocop-yml

data/.rubocop.yml

@@ -1,17 +1,5 @@
-require:
-  - rubocop/rspec/focused
+inherit_from:
+  - https://raw.githubusercontent.com/panorama-ed/code-conventions/master/rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
-
-AbcSize:
-  Enabled: false
-
-DotPosition:
-  EnforcedStyle: trailing
-
-MethodLength:
-  Enabled: false
-
-StringLiterals:
-  EnforcedStyle: double_quotes
+  TargetRubyVersion: 2.4 # Keep this in sync with .travis.yml

data/.travis.yml

@@ -1,28 +1,41 @@
 language: ruby
 rvm:
-- 2.2.5
-- 2.5.1
+- 2.6
+- 2.5
+- 2.4 # Keep this in sync with .rubocop.yml
+# We test up to the latest version of Ruby here, and test these Ruby versions
+# against all support ActiveRecord versions. One test will be "duplicated"
+# below when we calculate code coverage, but I don't know how to avoid that and
+# still test all combinations of Ruby and ActiveRecord.
 before_script:
-  - psql -c 'create database order_as_specified_test;' -U postgres
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
+- psql -c 'create database order_as_specified_test;' -U postgres
+- mysql -e 'CREATE DATABASE order_as_specified_test;'
 script:
-  - bundle exec rspec
-  - bundle exec rubocop
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-addons:
-  postgresql: "9.3"
+- bundle exec rspec
+services:
+- mysql
+- postgresql
 env:
-  global:
-    CC_TEST_REPORTER_ID=781c439d68cbb928316deaec1c7136f98423e1db87238f99cbc95183de94df9e
   matrix:
-    - AR_VERSION="~> 5.0.0"
-    - AR_VERSION="~> 5.1.0"
-    - AR_VERSION="~> 5.2.0"
+  - ACTIVERECORD_VERSION="~> 5.2.0"
+  - ACTIVERECORD_VERSION="~> 5.1.0"
+  - ACTIVERECORD_VERSION="~> 5.0.0"
+matrix:
+  include:
+  - rvm: 2.6
+    script:
+    - bundle exec rspec
+    - gem install --no-document rubocop rubocop-rspec-focused && rubocop
+    env:
+    - CODE_COVERAGE=true
+    - ACTIVERECORD_VERSION="~> 5.2.0"
+branches:
+  only:
+  # We always run tests for PRs. This prevents running PR tests twice (once "for
+  # the PR" and once "for the branch"), though we do want tests to run always
+  # run on master.
+  - master
 notifications:
   email: false
-  hipchat:
-    rooms:
-      secure: pLL6WXsWnvigZNgcYYwr0el3AG3WbRXOV4zAoBx/pAD/y51/KOjWboUO5szOqIicdSBJTIY5el7wK4uUi5elseumjl1jvOQSG7izvCGzDekuJuOTj9f6MdLtigbIaWO5/NWtXw0/JGHDQJpB4HyOv1mGAjQ3Y6MKxMNv+RUsgRI=
+  slack:
+    secure: lVaScxPymqeYlTh+KlprWDK+O18BkQTyNSBTfzsLFzWF3Dy+p1rp2aeh0AhuLVYQDrlmFZ7cDMZ1ZYDyV2Y6lLtt+4ii7rATagI8R9WUVYb90C97tu1M6v5tpIjoTEOLx9hGc66heyvq1hNCKXbTqsqmrD69FYdjuXnOfrIs6J4=

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# Unreleased (`master`)
+
+# 1.6
+
+We are dropping official support for Ruby 2.3 and below, though they may
+continue to work.
+
+This release adds support for ordering by `Range`s. Big thanks to
+[Karl-Aksel Puulmann](https://github.com/macobo) for adding this functionality!
+
 # 1.5
 
 This release improves performance by switching to use `CASE` statements. Huge

data/Gemfile

@@ -5,4 +5,6 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in order_as_specified.gemspec
 gemspec
 
-gem "activerecord", ENV["AR_VERSION"] if ENV["AR_VERSION"]
+if ENV["TRAVIS"] == "true" && ENV["ACTIVERECORD_VERSION"]
+  gem "activerecord", ENV["ACTIVERECORD_VERSION"]
+end

data/README.md

@@ -1,4 +1,7 @@
-[![Code Climate](https://codeclimate.com/github/panorama-ed/order_as_specified/badges/gpa.svg)](https://codeclimate.com/github/panorama-ed/order_as_specified) [![Test Coverage](https://codeclimate.com/github/panorama-ed/order_as_specified/badges/coverage.svg)](https://codeclimate.com/github/panorama-ed/order_as_specified) [![Build Status](https://travis-ci.org/panorama-ed/order_as_specified.svg)](https://travis-ci.org/panorama-ed/order_as_specified) [![Inline docs](http://inch-ci.org/github/panorama-ed/order_as_specified.png)](http://inch-ci.org/github/panorama-ed/order_as_specified) [![Gem Version](https://badge.fury.io/rb/order_as_specified.svg)](http://badge.fury.io/rb/order_as_specified)
+[![Code Coverage](https://codecov.io/gh/panorama-ed/order_as_specified/branch/master/graph/badge.svg)](https://codecov.io/gh/panorama-ed/order_as_specified)
+[![Build Status](https://travis-ci.com/panorama-ed/order_as_specified.svg)](https://travis-ci.com/panorama-ed/order_as_specified)
+[![Inline docs](http://inch-ci.org/github/panorama-ed/order_as_specified.png)](http://inch-ci.org/github/panorama-ed/order_as_specified)
+[![Gem Version](https://badge.fury.io/rb/order_as_specified.svg)](http://badge.fury.io/rb/order_as_specified)
 
 # OrderAsSpecified
 

data/RELEASING.md

@@ -0,0 +1,14 @@
+# Releasing
+
+## These are steps for the maintainer to take to release a new version of this gem.
+
+1. Create a new branch for bumping the version.
+1. On the new branch, update the VERSION constant in `lib/order_as_specified/version.rb`.
+1. Update the Changelog.
+1. Commit the change: `git add -A && git commit -m 'Bump to vX.X'`.
+1. Add a tag: `git tag -am "vX.X" vX.X`.
+1. Push the branch and tag: `git push --follow-tags`
+1. Make a PR.
+1. Merge the PR.
+1. Push to rubygems: `gem build order_as_specified.gemspec && gem push *.gem && rm *.gem`
+1. Celebrate!

data/lib/order_as_specified.rb

@@ -18,15 +18,15 @@ module OrderAsSpecified
     table = connection.quote_table_name(params[:table])
     attribute = connection.quote_column_name(params[:attribute])
 
-    # We have to explicitly quote for now because SQL sanitization for ORDER BY
-    # queries isn't in less current versions of Rails.
-    # See: https://github.com/rails/rails/pull/13008
-    db_connection = ActiveRecord::Base.connection
     conditions = params[:values].map do |value|
       raise OrderAsSpecified::Error, "Cannot order by `nil`" if value.nil?
 
-      # Sanitize each value to reduce the risk of SQL injection.
-      "#{table}.#{attribute}=#{db_connection.quote(value)}"
+      if value.is_a? Range
+        range_clause("#{table}.#{attribute}", value)
+      else
+        # Sanitize each value to reduce the risk of SQL injection.
+        "#{table}.#{attribute}=#{quote(value)}"
+      end
     end
 
     when_queries = conditions.map.with_index do |cond, index|
@@ -53,7 +53,9 @@ module OrderAsSpecified
   # @param hash [Hash] the ActiveRecord-style arguments, such as:
   #   { other_objects: { id: [1, 5, 3] } }
   def extract_params(hash, table = table_name)
-    raise "Could not parse params" unless hash.size == 1
+    unless hash.size == 1
+      raise OrderAsSpecified::Error, "Could not parse params"
+    end
 
     key, val = hash.first
 
@@ -67,4 +69,20 @@ module OrderAsSpecified
       }
     end
   end
+
+  def range_clause(col, range)
+    if range.first >= range.last
+      raise OrderAsSpecified::Error, "Range needs to be increasing"
+    end
+
+    op = range.exclude_end? ? "<" : "<="
+    "#{col} >= #{quote(range.first)} AND #{col} #{op} #{quote(range.last)}"
+  end
+
+  def quote(value)
+    # We have to explicitly quote for now because SQL sanitization for ORDER BY
+    # queries isn't in less current versions of Rails.
+    # See: https://github.com/rails/rails/pull/13008
+    ActiveRecord::Base.connection.quote(value)
+  end
 end

data/lib/order_as_specified/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OrderAsSpecified
-  VERSION = "1.5"
+  VERSION = "1.6"
 end

data/order_as_specified.gemspec

@@ -23,11 +23,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activerecord", ">= 5.0.0"
 
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "codecov"
+  spec.add_development_dependency "mysql2"
   spec.add_development_dependency "pg"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-rails"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "rubocop-rspec-focused"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "sqlite3", "~> 1.3.13"
 end

data/spec/config/database.yml

@@ -7,3 +7,9 @@ postgresql_test:
   adapter: postgresql
   database: order_as_specified_test
   username: postgres
+
+mysql_test:
+  adapter: mysql2
+  database: order_as_specified_test
+  username: travis
+  encoding: utf8

data/spec/config/test_setup_migration.rb

@@ -9,6 +9,7 @@ class TestSetupMigration < VersionedMigration
 
     create_table :test_classes do |t|
       t.string :field
+      t.float :number_field
     end
 
     create_table :association_test_classes do |t|

data/spec/mysql_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "shared/order_as_specified_examples"
+require "config/test_setup_migration"
+
+RSpec.describe "MySQL" do
+  before :all do
+    ActiveRecord::Base.establish_connection(:mysql_test)
+    TestSetupMigration.migrate(:up)
+  end
+
+  after(:all) { ActiveRecord::Base.remove_connection }
+
+  include_examples ".order_as_specified"
+end

data/spec/postgresql_spec.rb

@@ -4,7 +4,6 @@ require "spec_helper"
 require "shared/order_as_specified_examples"
 require "config/test_setup_migration"
 
-# rubocop:disable Metrics/BlockLength
 RSpec.describe "PostgreSQL" do
   before :all do
     ActiveRecord::Base.establish_connection(:postgresql_test)
@@ -68,4 +67,3 @@ RSpec.describe "PostgreSQL" do
     end
   end
 end
-# rubocop:enable Metrics/BlockLength

data/spec/shared/order_as_specified_examples.rb

@@ -4,7 +4,6 @@ require "support/application_record"
 require "support/test_class"
 require "support/association_test_class"
 
-# rubocop:disable Metrics/BlockLength
 RSpec.shared_examples ".order_as_specified" do
   # Clean up after each test. This is a lot lighter for these few tests than
   # trying to wrangle with RSpec-Rails to get transactional tests to work.
@@ -81,6 +80,54 @@ RSpec.shared_examples ".order_as_specified" do
     end
   end
 
+  context "when the order is a range" do
+    subject do
+      TestClass.order_as_specified(number_field: ranges).order(:number_field)
+    end
+
+    let(:ranges) { [(3..4), (0..2)] }
+    let(:numbers) { [0, 1, 2, 3, 4] }
+
+    let!(:test_objects) do
+      numbers.each do |i|
+        TestClass.create(number_field: i)
+      end
+    end
+
+    it "sorts according to range" do
+      expect(subject.map(&:number_field)).to eq [
+        *numbers.drop(3),
+        *numbers.take(3)
+      ]
+    end
+
+    context "exclusive ranges" do
+      let(:numbers) { [0, 1, 2, 3, 4, 0.9, 1.5] }
+
+      let(:ranges) { [(1...2), (0...1), (2...5)] }
+
+      it "sorts according to range" do
+        expect(subject.map(&:number_field)).to eq [
+          1,
+          1.5,
+          0,
+          0.9,
+          2,
+          3,
+          4
+        ]
+      end
+    end
+
+    context "reverse ranges" do
+      let(:ranges) { [(5..0)] }
+
+      it "raises an error" do
+        expect { subject }.to raise_error(OrderAsSpecified::Error)
+      end
+    end
+  end
+
   context "with another table name specified" do
     subject do
       TestClass.
@@ -149,5 +196,12 @@ RSpec.shared_examples ".order_as_specified" do
       expect(sql).to include(pattern)
     end
   end
+
+  context "invalid hash input" do
+    subject { TestClass.order_as_specified({}) }
+
+    it "raises an error" do
+      expect { subject }.to raise_error(OrderAsSpecified::Error)
+    end
+  end
 end
-# rubocop:enable Metrics/BlockLength

data/spec/spec_helper.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-if ENV["TRAVIS"] == "true"
+if ENV["TRAVIS"] == "true" && ENV["CODE_COVERAGE"] == "true"
   require "simplecov"
-  SimpleCov.start
+  require "codecov"
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
   SimpleCov.start do
     # Omit the spec directory from being counted in code coverage calculations.
     add_filter "/spec/"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: order_as_specified
 version: !ruby/object:Gem::Version
-  version: '1.5'
+  version: '1.6'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
+date: 2019-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,21 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
-  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: rubocop
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec-focused
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -126,16 +112,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.13
 description: Obtain ActiveRecord results with a custom ordering with no need to store
   anything in the database.
 email:
@@ -151,12 +137,14 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - lib/order_as_specified.rb
 - lib/order_as_specified/error.rb
 - lib/order_as_specified/version.rb
 - order_as_specified.gemspec
 - spec/config/database.yml
 - spec/config/test_setup_migration.rb
+- spec/mysql_spec.rb
 - spec/order_as_specified_spec.rb
 - spec/postgresql_spec.rb
 - spec/shared/order_as_specified_examples.rb
@@ -192,6 +180,7 @@ summary: Add arbitrary ordering to ActiveRecord queries.
 test_files:
 - spec/config/database.yml
 - spec/config/test_setup_migration.rb
+- spec/mysql_spec.rb
 - spec/order_as_specified_spec.rb
 - spec/postgresql_spec.rb
 - spec/shared/order_as_specified_examples.rb