order_query 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 01cd918d06d860206e938baf5f500446132bdbd6
-  data.tar.gz: 39882d3d3d1fb272f88597ed281973618b6f293c
+SHA256:
+  metadata.gz: 140bea826457d9ad046a701da89e0073ca15f6631d3e996b5b44ba01fc7a7910
+  data.tar.gz: aae7c51f4c0c607455b92efa36ca71c2df86b0b7b49c022a94bb209452a6bc4e
 SHA512:
-  metadata.gz: 8b23735d7393e0bc5e8842e644deb06f22618b50e68ed5537c1755c3e6dd88858189104d18cef2279d15fa9fc158dc8a3470570f980b13f929187e80be30d5d8
-  data.tar.gz: a40ec816d36f311647c37515adf8866151505a4205b5c46e0d42f22f47c1f9ef7816a290df711876157bfefe25849065ddb86aff1d5bf4b3f1967ae1d187560e
+  metadata.gz: f3c6db46a213cd3acc4cddc7f9f35247ec7ac6c986005b2d4e9185128b2f8c12ec585230c879e5a911c9c4ff097b00eda7dd530f04f78e242715c0bcda27ed5d
+  data.tar.gz: 6171c2a35660bb8595bfae88e159cb65cafb93039ebd032b8257d5564e99dbedf51c6044d78df8382497b1d74c6a2493a155647ba7c68115c925a6fb2bf1a8a1

data/CHANGES.md

@@ -1,3 +1,11 @@
+## 0.5.0
+
+* Rails 6 now supported.
+* Fixes support for `nil`s with explicit order, when a `nil` is neither
+  the first nor the last element of the explicit order,
+  e.g. `status: ['assigned', nil, 'fixed']`.
+  [#93b08877](https://github.com/glebm/order_query/commit/93b08877790a0ff02eea0d835def6ff3c40a83da)
+
 ## 0.4.1
 
 * If a column had a `nulls:` option and there were multiple records with `NULL`,

data/Gemfile

@@ -2,11 +2,5 @@
 
 source 'https://rubygems.org'
 
-gemspec
-
-# TODO: remove these lines and update spec/gemfiles/rails_5_2.gemfile once
-#   Rails 5.2 is out.
-gem 'activerecord', '~> 5.2.0.rc1'
-gem 'activesupport', '~> 5.2.0.rc1'
-
-eval_gemfile './shared.gemfile'
+eval_gemfile 'spec/gemfiles/rails_6_0.gemfile'
+eval_gemfile 'rubocop.gemfile'

data/README.md

@@ -11,7 +11,7 @@ This gem finds the next or previous record(s) relative to the current one effici
 Add to Gemfile:
 
 ```ruby
-gem 'order_query', '~> 0.4.1'
+gem 'order_query', '~> 0.5.0'
 ```
 
 ## Usage

data/lib/order_query/column.rb

@@ -38,8 +38,9 @@ module OrderQuery
              "extra arguments: #{vals_and_or_dir.map(&:inspect) * ', '}"
       end
       @unique = unique.nil? ? (name.to_s == scope.primary_key) : unique
-      if @order_enum && (@order_enum[0].nil? || @order_enum[-1].nil?)
+      if @order_enum&.include?(nil)
         fail ArgumentError, '`nulls` cannot be set if a value is null' if nulls
+
         @nullable = true
         @nulls = if @order_enum[0].nil?
                    @direction == :desc ? :first : :last
@@ -87,7 +88,7 @@ module OrderQuery
     # @example for [:difficulty, ['Easy', 'Normal', 'Hard']]:
     #  enum_side('Normal', :after) #=> ['Hard']
     #  enum_side('Normal', :after, false) #=> ['Normal', 'Hard']
-    def enum_side(value, side, strict = true)
+    def enum_side(value, side, strict = true) # rubocop:disable Metrics/AbcSize
       ord = order_enum
       pos = ord.index(value)
       if pos

data/lib/order_query/space.rb

@@ -22,6 +22,7 @@ module OrderQuery
         if @columns.detect(&:unique?)
           fail ArgumentError, 'Unique column must be last'
         end
+
         @columns << Column.new(base_scope, base_scope.primary_key)
       end
       @order_by_sql = SQL::OrderBy.new(@columns)

data/lib/order_query/sql/order_by.rb

@@ -51,6 +51,7 @@ module OrderQuery
         if optimize_enum_bools_nil?(col)
           return optimize_enum_bools_nil(col, reverse)
         end
+
         clauses = []
         with_nulls = false
         if col.order_enum.include?(nil)
@@ -69,6 +70,7 @@ module OrderQuery
       def needs_null_sort?(col, reverse,
                            nulls_direction = col.nulls_direction(reverse))
         return false unless col.nullable?
+
         nulls_direction != col.default_nulls_direction(reverse)
       end
 

data/lib/order_query/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OrderQuery
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/spec/gemfiles/rails_5_0.gemfile

@@ -4,7 +4,18 @@ source 'https://rubygems.org'
 
 gemspec path: '../../'
 
-gem 'activerecord', '~> 5.0.5'
-gem 'activesupport', '~> 5.0.5'
+gem 'activerecord', '~> 5.0.6'
+gem 'activesupport', '~> 5.0.6'
+
+platforms :mri, :rbx do
+  # https://github.com/rails/rails/blob/v5.0.6/activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb#L4
+  gem 'mysql2', '< 0.5'
+
+  # https://github.com/rails/rails/blob/v5.0.6/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L2
+  gem 'pg', '~> 0.18'
+
+  # https://github.com/rails/rails/blob/v5.0.6/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L7
+  gem 'sqlite3', '~> 1.3.6'
+end
 
 eval_gemfile '../../shared.gemfile'

data/spec/gemfiles/rails_5_1.gemfile

@@ -7,4 +7,15 @@ gemspec path: '../../'
 gem 'activerecord', '~> 5.1.3'
 gem 'activesupport', '~> 5.1.3'
 
+platforms :mri, :rbx do
+  # https://github.com/rails/rails/blob/v5.1.5/activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb#L4
+  gem 'mysql2', '< 0.5'
+
+  # https://github.com/rails/rails/blob/v5.1.5/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L2
+  gem 'pg', '>= 0.18', '< 2.0'
+
+  # https://github.com/rails/rails/blob/v5.1.5/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L10
+  gem 'sqlite3', '~> 1.3.6'
+end
+
 eval_gemfile '../../shared.gemfile'

data/spec/gemfiles/rails_5_2.gemfile

@@ -4,7 +4,18 @@ source 'https://rubygems.org'
 
 gemspec path: '../../'
 
-gem 'activerecord', '~> 5.2.0.rc1'
-gem 'activesupport', '~> 5.2.0.rc1'
+gem 'activerecord', '~> 5.2.3'
+gem 'activesupport', '~> 5.2.3'
+
+platforms :mri, :rbx do
+  # https://github.com/rails/rails/blob/v5.2.3/activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb#L6
+  gem 'mysql2', '>= 0.4.4', '< 0.6.0'
+
+  # https://github.com/rails/rails/blob/v5.2.3/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L4
+  gem 'pg', '>= 0.18', '< 2.0'
+
+  # https://github.com/rails/rails/blob/v5.2.3/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L12
+  gem 'sqlite3', '~> 1.3', '>= 1.3.6'
+end
 
 eval_gemfile '../../shared.gemfile'

data/spec/gemfiles/rails_6_0.gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '~> 5.2.3'
+gem 'activesupport', '~> 5.2.3'
+
+platforms :mri, :rbx do
+  # https://github.com/rails/rails/blob/v6.0.0/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L13
+  gem 'sqlite3', '~> 1.4'
+
+  # https://github.com/rails/rails/blob/v6.0.0/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L4
+  gem 'pg', '>= 0.18', '< 2.0'
+
+  # https://github.com/rails/rails/blob/v6.0.0/activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb#L6
+  gem 'mysql2', '>= 0.4.4'
+end
+
+eval_gemfile '../../shared.gemfile'

data/spec/gemfiles/rubocop.gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+eval_gemfile '../../rubocop.gemfile'

data/spec/order_query_spec.rb

@@ -221,20 +221,27 @@ RSpec.describe 'OrderQuery' do
         end
 
         context 'nil in string enum' do
+          display = ->(issue) { "##{issue.id}-#{issue.priority || 'NULL'}" }
           priorities = [nil, 'low', 'medium', 'high']
-          let!(:issues) { priorities.map { |p| create_issue(priority: p) } }
-          priorities.permutation do |p|
-            it "works for #{p} (desc)" do
-              scope = Issue.seek([:priority, p]).scope
-              actual = scope.all.map(&:priority)
-              expected = p
-              expect(actual).to eq(expected), scope.to_sql
+          let!(:issues) do
+            priorities.flat_map do |p|
+              [create_issue(priority: p), create_issue(priority: p)]
             end
-            it "works for #{p} (asc)" do
-              scope = Issue.seek([:priority, p, :asc]).scope
-              actual = scope.all.map(&:priority)
-              expected = p.reverse
-              expect(actual).to eq(expected), scope.to_sql
+          end
+          priorities.permutation do |perm|
+            it "works for #{perm} (desc)" do
+              expect_order(
+                Issue.seek([:priority, perm]),
+                issues.sort_by { |x| [perm.index(x.priority), x.id] },
+                &display
+              )
+            end
+            it "works for #{perm} (asc)" do
+              expect_order(
+                Issue.seek([:priority, perm, :asc]),
+                issues.sort_by { |x| [perm.index(x.priority), -x.id] }.reverse,
+                &display
+              )
             end
           end
         end
@@ -340,69 +347,33 @@ RSpec.describe 'OrderQuery' do
         end
 
         context 'nil in boolean enum' do
+          display = ->(post) { "##{post.id}-#{post.pinned || 'NULL'}" }
           states = [nil, false, true]
-          let!(:posts) { states.map { |state| create_post(pinned: state) } }
-          states.permutation do |p|
-            it "works for #{p} (desc)" do
-              scope = Post.seek([:pinned, p]).scope
-              actual = scope.all.map(&:pinned)
-              expected = p
-              expect(actual).to eq(expected), scope.to_sql
+          let!(:posts) do
+            states.flat_map do |state|
+              [create_post(pinned: state), create_post(pinned: state)]
+            end
+          end
+          states.permutation do |perm|
+            it "works for #{perm} (desc)" do
+              expect_order(
+                Post.seek([:pinned, perm]),
+                posts.sort_by { |x| [perm.index(x.pinned), x.id] },
+                &display
+              )
             end
-            it "works for #{p} (asc)" do
-              scope = Post.seek([:pinned, p, :asc]).scope
-              actual = scope.all.map(&:pinned)
-              expected = p.reverse
-              expect(actual).to eq(expected), scope.to_sql
+            it "works for #{perm} (asc)" do
+              expect_order(
+                Post.seek([:pinned, perm, :asc]),
+                posts.sort_by { |x| [-perm.index(x.pinned), x.id] },
+                &display
+              )
             end
           end
         end
 
         context 'nil published_at' do
-          # rubocop:disable Metrics/AbcSize
-
-          def expect_next(space, post, next_post)
-            point = space.at(post)
-            actual = point.next
-            failure_message =
-              "expected: #{post.title}.next == #{next_post.title}\n" \
-              "     got: #{actual ? actual.title : 'nil'}\n" \
-              "     all: #{space.scope.all.map(&:title)}\n" \
-              "     sql: #{space.at(post).after.limit(1).to_sql}"
-            expect(actual ? actual.title : nil).to eq(next_post.title),
-                                                   failure_message
-          end
-
-          def expect_prev(space, post, prev_post)
-            point = space.at(post)
-            actual = point.previous
-            failure_message =
-              "expected: #{post.title}.previous == #{prev_post.title}\n" \
-              "     got: #{actual ? actual.title : 'nil'}\n" \
-              "     all: #{space.scope.all.map(&:title)}\n" \
-              "     sql: #{space.at(post).before.limit(1).to_sql}"
-            expect(actual ? actual.title : nil).to eq(prev_post.title),
-                                                   failure_message
-          end
-
-          def expect_order(space, ordered)
-            actual = space.scope.all.map(&:title)
-            expected = ordered.map(&:title)
-            failure_message =
-              "expected: #{expected * ', '}\n"\
-              "     got: #{actual * ', '}\n"\
-              "     sql: #{space.scope.to_sql}"
-            expect(actual).to eq(expected), failure_message
-
-            ordered.each_cons(2) do |post, next_post|
-              expect_next space, post, next_post
-              expect_prev space, next_post, post
-            end
-            expect_next space, ordered.last, ordered.first
-            expect_prev space, ordered.first, ordered.last
-          end
-
-          # rubocop:enable Metrics/AbcSize
+          display = ->(post) { post.title }
 
           let! :null_1 do
             Post.create!(title: 'null_1', published_at: nil).reload
@@ -419,22 +390,22 @@ RSpec.describe 'OrderQuery' do
 
           it 'orders nulls first (desc)' do
             space = Post.seek([:published_at, :desc, nulls: :first])
-            expect_order space, [null_1, null_2, older, newer]
+            expect_order space, [null_1, null_2, older, newer], &display
           end
 
           it 'orders nulls first (asc)' do
             space = Post.seek([:published_at, :asc, nulls: :first])
-            expect_order space, [null_1, null_2, newer, older]
+            expect_order space, [null_1, null_2, newer, older], &display
           end
 
           it 'orders nulls last (desc)' do
             space = Post.seek([:published_at, :desc, nulls: :last])
-            expect_order space, [older, newer, null_1, null_2]
+            expect_order space, [older, newer, null_1, null_2], &display
           end
 
           it 'orders nulls last (asc)' do
             space = Post.seek([:published_at, :asc, nulls: :last])
-            expect_order space, [newer, older, null_1, null_2]
+            expect_order space, [newer, older, null_1, null_2], &display
           end
         end
 

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ if ENV['COVERAGE'] && !%w[rbx jruby].include?(RUBY_ENGINE)
 end
 require 'order_query'
 
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+require_relative './support/order_expectation'
 
 require 'fileutils'
 FileUtils.mkpath 'log' unless File.directory? 'log'
@@ -35,3 +35,7 @@ else
   fail "Unknown DB adapter #{adapter}. "\
        'Valid adapters are: mysql2, postgresql, sqlite3.'
 end
+
+RSpec.configure do |c|
+  c.include OrderExpectations
+end

data/spec/support/order_expectation.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OrderExpectations
+  # rubocop:disable Metrics/AbcSize
+
+  def expect_next(space, record, next_record, &display)
+    point = space.at(record)
+    actual = point.next
+    failure_message =
+      "expected: next(#{display[record]}) == #{display[next_record]}\n" \
+      "     got: #{actual ? display[actual] : 'nil'}\n" \
+      "     all: #{space.scope.all.map(&display)}\n" \
+      "     sql: #{space.at(record).after.limit(1).to_sql}"
+    expect(actual ? display[actual] : nil).to eq(display[next_record]),
+                                              failure_message
+  end
+
+  def expect_prev(space, record, prev_record, &display)
+    point = space.at(record)
+    actual = point.previous
+    failure_message =
+      "expected: previous(#{display[record]}) == #{display[prev_record]}\n" \
+      "     got: #{actual ? display[actual] : 'nil'}\n" \
+      "     all: #{space.scope.all.map(&display)}\n" \
+      "     sql: #{space.at(record).before.limit(1).to_sql}"
+    expect(actual ? display[actual] : nil).to eq(display[prev_record]),
+                                              failure_message
+  end
+
+  def expect_order(space, ordered, &display)
+    all_actual = space.scope.all.map(&display)
+    all_expected = ordered.map(&display)
+    failure_message =
+      "expected: #{all_expected * ', '}\n"\
+      "     got: #{all_actual * ', '}\n"\
+      "     sql: #{space.scope.to_sql}"
+    expect(all_actual).to eq(all_expected), failure_message
+
+    ordered.each_cons(2) do |record, next_record|
+      expect_next space, record, next_record, &display
+      expect_prev space, next_record, record, &display
+    end
+    expect_next space, ordered.last, ordered.first, &display
+    expect_prev space, ordered.first, ordered.last, &display
+  end
+
+  # rubocop:enable Metrics/AbcSize
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: order_query
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -78,20 +78,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.53.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.53.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -131,8 +117,11 @@ files:
 - spec/gemfiles/rails_5_0.gemfile
 - spec/gemfiles/rails_5_1.gemfile
 - spec/gemfiles/rails_5_2.gemfile
+- spec/gemfiles/rails_6_0.gemfile
+- spec/gemfiles/rubocop.gemfile
 - spec/order_query_spec.rb
 - spec/spec_helper.rb
+- spec/support/order_expectation.rb
 homepage: https://github.com/glebm/order_query
 licenses:
 - MIT
@@ -146,21 +135,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Find next / previous Active Record(s) in one query
 test_files:
 - spec/order_query_spec.rb
 - spec/spec_helper.rb
+- spec/support/order_expectation.rb
 - spec/gemfiles/rails_5_1.gemfile
 - spec/gemfiles/rails_5_2.gemfile
+- spec/gemfiles/rubocop.gemfile
 - spec/gemfiles/rails_5_0.gemfile
+- spec/gemfiles/rails_6_0.gemfile