order_as_specified 1.2 → 1.7

data/spec/shared/order_as_specified_examples.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require "support/application_record"
 require "support/test_class"
 require "support/association_test_class"
 
@@ -10,7 +13,7 @@ RSpec.shared_examples ".order_as_specified" do
   end
 
   let(:shuffled_objects) do
-    5.times.map { |i| TestClass.create(field: "Field #{i}") }.shuffle
+    Array.new(5) { |i| TestClass.create(field: "Field #{i}") }.shuffle
   end
   let(:shuffled_object_fields) { shuffled_objects.map(&:field) }
   let(:shuffled_object_ids) { shuffled_objects.map(&:id) }
@@ -50,11 +53,75 @@ RSpec.shared_examples ".order_as_specified" do
 
     context "when the order includes nil" do
       let(:shuffled_objects) do
-        5.times.map do |i|
+        Array.new(5) do |i|
           TestClass.create(field: (i == 0 ? nil : "Field #{i}"))
         end.shuffle
       end
 
+      it "returns results in the given order" do
+        expect(subject.map(&:id)).to eq shuffled_object_ids
+      end
+    end
+  end
+
+  context "when the order is empty array" do
+    subject { TestClass.order_as_specified(field: []) }
+
+    let(:test_objects) do
+      Array.new(5) do |i|
+        TestClass.create(field: "Field #{i}")
+      end
+    end
+
+    it "keep the original order" do
+      test_objects # Build test objects
+      expect(subject.map(&:id)).
+        to eq test_objects.map(&:id)
+    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 "when ranges are exclusive" 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 "when ranges are in reverse order" do
+      let(:ranges) { [(5..0)] }
+
       it "raises an error" do
         expect { subject }.to raise_error(OrderAsSpecified::Error)
       end
@@ -96,21 +163,22 @@ RSpec.shared_examples ".order_as_specified" do
     end
   end
 
-  context "input safety" do
+  describe "input safety" do
     before(:each) do
       2.times { |i| TestClass.create(field: "foo#{i}") }
     end
 
     it "sanitizes column values" do
-      # Verify that the result set includes two records when using good column value.
+      # Verify that the result set includes two records when using good column
+      # value.
       good_value = "foo"
       records = TestClass.order_as_specified(field: [good_value]).to_a
       expect(records.count).to eq(2)
 
       # Attempt to inject a LIMIT clause into the query. If the SQL inputs are
       # properly sanitized, it will be ignored and the returned result set will
-      # include two records. If not, the LIMIT clause will execute and the result
-      # set will include just one record.
+      # include two records. If not, the LIMIT clause will execute and the
+      # result set will include just one record.
       bad_value = "' LIMIT 1 --"
       records = TestClass.order_as_specified(field: [bad_value]).to_a
       expect(records.count).to eq(2)
@@ -124,7 +192,39 @@ RSpec.shared_examples ".order_as_specified" do
       quoted_column = AssociationTestClass.connection.quote_column_name(column)
 
       sql = TestClass.order_as_specified(table => { column => ["foo"] }).to_sql
-      expect(sql).to include("ORDER BY #{quoted_table}.#{quoted_column}")
+      pattern = "ORDER BY (CASE WHEN #{quoted_table}.#{quoted_column}"
+      expect(sql).to include(pattern)
+    end
+  end
+
+  context "when hash input is invalid" do
+    subject { TestClass.order_as_specified({}) }
+
+    it "raises an error" do
+      expect { subject }.to raise_error(OrderAsSpecified::Error)
+    end
+  end
+
+  context "when case insensitive option is used" do
+    subject do
+      TestClass.
+        order_as_specified(field: %w[abc def], case_insensitive: true).
+        pluck(TestClass.arel_table[:field].lower)
+    end
+
+    before :each do
+      TestClass.create!(
+        [
+          { field: "dEf" },
+          { field: "aBc" },
+          { field: "ABC" },
+          { field: "DEF" }
+        ]
+      )
+    end
+
+    it "orders in a case insensitive manner" do
+      expect(subject).to eq(%w[abc abc def def])
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
+# frozen_string_literal: true
 
 require "active_record"
 

data/spec/sqlite3_spec.rb

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

data/spec/support/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/support/association_test_class.rb

@@ -1,4 +1,6 @@
-class AssociationTestClass < ActiveRecord::Base
+# frozen_string_literal: true
+
+class AssociationTestClass < ApplicationRecord
   extend OrderAsSpecified
 
   belongs_to :test_class

data/spec/support/test_class.rb

@@ -1,4 +1,6 @@
-class TestClass < ActiveRecord::Base
+# frozen_string_literal: true
+
+class TestClass < ApplicationRecord
   extend OrderAsSpecified
 
   has_one :association_test_class

metadata

@@ -1,141 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: order_as_specified
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.7'
 platform: ruby
 authors:
 - Jacob Evelyn
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-10-13 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: overcommit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.23'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.29'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.29'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 description: Obtain ActiveRecord results with a custom ordering with no need to store
   anything in the database.
 email:
@@ -144,59 +116,66 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .overcommit.yml
-- .rubocop.yml
-- .travis.yml
+- ".dependabot/config.yml"
+- ".github/workflows/auto-approve-dependabot.yml"
+- ".github/workflows/remove-needs-qa.yml"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - 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
 - spec/spec_helper.rb
 - spec/sqlite3_spec.rb
+- spec/support/application_record.rb
 - spec/support/association_test_class.rb
 - spec/support/test_class.rb
 homepage: https://github.com/panorama-ed/order_as_specified
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 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
 - spec/spec_helper.rb
 - spec/sqlite3_spec.rb
+- spec/support/application_record.rb
 - spec/support/association_test_class.rb
 - spec/support/test_class.rb
-has_rdoc: