order_query 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e69a0283a9dcc95fe70d2fd18c02f5aa62120d2
-  data.tar.gz: d1d0a0975074175ff4eb15d7fa5efdd20fc91c3f
+  metadata.gz: 2139f5b59c57d0163c85a86b23b79a3e6fd00a28
+  data.tar.gz: e879b1b335c61133b122c014e49b01acb83c907d
 SHA512:
-  metadata.gz: 0a5d6a00cd9096587584e9c32a1daf05f26577175d9e0bf6a783b8bc189a710482143b18166b82620b3ef315928c51ed837f6776e719ff53c53c644cfc278fa6
-  data.tar.gz: 6ae64249791c2c8ac500b10b3a50c9ed6cf439056301ca1d361f1d8f5559fa1180bcdf72113698922a08ad6fd85f5e3adcd3c25c5b9e9f50776225ce51c616f2
+  metadata.gz: a8c33923361af77ea70eaf89eed9486122ff82e70ebcb8dae13d8ee273155e0075a0207e59a7dc276a9d335548830b6a768db1575cc657e2d64c3ad58cbade63
+  data.tar.gz: a42483806ef779802cf97467ebd53fa95e2e97639ce709e51564320ae184e09274a6aaa001f5c7a4414897e4c6918816d5b680466fd6b784c2384bc288167272

data/Gemfile

@@ -2,22 +2,4 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :test, :development do
-  gem 'codeclimate-test-reporter', group: :test, require: nil
-  gem 'byebug', platform: :mri_21, require: false
-end
-
-platform :mri, :rbx do
-  # version locked because of rbx issue, see https://github.com/travis-ci/travis-ci/issues/2006#issuecomment-36275141
-  gem 'sqlite3', '=1.3.8'
-end
-
-platform :jruby do
-  gem 'activerecord-jdbcsqlite3-adapter'
-end
-
-platform :rbx do
-  gem 'rubysl-singleton', '~> 2.0'
-  gem 'rubysl-optparse', '~> 2.0'
-  gem 'rubysl-ostruct', '~> 2.0'
-end
+eval_gemfile './shared.gemfile'

data/README.md

@@ -4,44 +4,42 @@
   <img src="http://use-the-index-luke.com/img/no-offset.q200.png" alt="100% offset-free" align="right" width="106" height="106">
 </a>
 
-This gem finds the next or previous record(s) relative to the current one efficiently. It is also useful for implementing infinite scroll.
-It uses [keyset pagination](http://use-the-index-luke.com/no-offset) to achieve this.
+This gem finds the next or previous record(s) relative to the current one efficiently using [keyset pagination](http://use-the-index-luke.com/no-offset), e.g. for navigation or infinite scroll.
 
 ## Installation
 
 Add to Gemfile:
 
 ```ruby
-gem 'order_query', '~> 0.3.2'
+gem 'order_query', '~> 0.3.3'
 ```
 
 ## Usage
 
-Define named order columns with `order_query`:
+Define a named list of attributes to order by with `order_query(name, *order)`:
 
 ```ruby
 class Post < ActiveRecord::Base
   include OrderQuery
   order_query :order_home,
     [:pinned, [true, false]],
-    [:published_at, :desc],
-    [:id, :desc]
+    [:published_at, :desc]
 end
 ```
 
-Order query accepts a list of order columns as varargs or one array, each one specified as:
-
-```ruby
-[<attribute name>, (attribute values in order), (:asc or :desc), (options hash)]
-```
+Each attributes is specified as:
 
-Available options:
+1. Attribute name.
+2. Optionally, values to order by, such as `%w(high medium low)` or `[true, false]`.
+3. Sort direction, `:asc` or `:desc`. Default: `:asc`; `:desc` when values to order by are specified.
+4. Options:
 
 | option     | description                                                                |
 |------------|----------------------------------------------------------------------------|
 | unique     | Unique attribute. Default: `true` for primary key, `false` otherwise.      |
-| sql        | Customize attribute value SQL                                              |
+| sql        | Customize column SQL.                                                      |
 
+If no unique column is specified, `[primary_key, :asc]` is used. Unique column must be last.
 
 ### Scopes for `ORDER BY`
 
@@ -68,7 +66,7 @@ p.next     #=> #<Post>
 p.position #=> 5
 ```
 
-Looping to the first / last record is enabled by default. Pass `false` to disable:
+Looping to the first / last record is enabled for `next` / `previous` by default. Pass `false` to disable:
 
 ```ruby
 p = Post.order_home_at(Post.order_home.first)
@@ -88,7 +86,7 @@ post.order_home(posts) #=> #<OrderQuery::Point>
 
 ### Dynamic columns
 
-Query with dynamic order columns using the `seek(*spec)` class method:
+Query with dynamic order columns using the `seek(*order)` class method:
 
 ```ruby
 space = Post.visible.seek([:id, :desc]) #=> #<OrderQuery::Space>
@@ -104,7 +102,13 @@ space.last            #=> scope_reverse.first
 space.at(Post.first)  #=> #<OrderQuery::Point>
 ```
 
-Alternatively, get an `OrderQuery::Point` using the `seek(scope, *spec)` instance method:
+`OrderQuery::Space` is also available for defined order_queries:
+
+```ruby
+Post.visible.order_home_space #=> #<OrderQuery::Space>
+```
+
+Alternatively, get an `OrderQuery::Point` using the `seek(scope, *order)` instance method:
 
 ```ruby
 Post.find(42).seek(Post.visible, [:id, :desc]) #=> #<OrderQuery::Point>
@@ -112,7 +116,7 @@ Post.find(42).seek(Post.visible, [:id, :desc]) #=> #<OrderQuery::Point>
 Post.find(42).seek([:id, :desc]) #=> #<OrderQuery::Point>
 ```
 
-#### Advanced options example
+### Advanced example
 
 ```ruby
 class Post < ActiveRecord::Base

data/Rakefile

@@ -8,3 +8,32 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+desc 'Test all Gemfiles from spec/*.gemfile'
+task :test_all_gemfiles do
+  require 'pty'
+  require 'shellwords'
+  cmd      = 'bundle --quiet && bundle exec rake --trace'
+  statuses = Dir.glob('./spec/gemfiles/*{[!.lock]}').map do |gemfile|
+    env = {'BUNDLE_GEMFILE' => gemfile}
+    cmd_with_env = "  (#{env.map { |k, v| "export #{k}=#{Shellwords.escape v}" } * ' '}; #{cmd})"
+    $stderr.puts "Testing\n#{cmd_with_env}"
+    PTY.spawn(env, cmd) do |r, _w, pid|
+      begin
+        r.each_line { |l| puts l }
+      rescue Errno::EIO
+        # Errno:EIO error means that the process has finished giving output.
+      ensure
+        ::Process.wait pid
+      end
+    end
+    [$? && $?.exitstatus == 0, cmd_with_env]
+  end
+  failed_cmds = statuses.reject(&:first).map { |(_status, cmd_with_env)| cmd_with_env }
+  if failed_cmds.empty?
+    $stderr.puts '✓ Tests pass with all gemfiles'
+  else
+    $stderr.puts "❌ FAILING (#{failed_cmds.size} / #{statuses.size})\n#{failed_cmds * "\n"}"
+    exit 1
+  end
+end

data/lib/order_query.rb

@@ -59,22 +59,17 @@ module OrderQuery
     #   .order_home(scope)
     #     #<OrderQuery::Point...>
     def order_query(name, *spec)
-      space_method = :"#{name}_space"
-      define_singleton_method space_method, -> {
-        seek(*spec)
-      }
-      scope name, -> {
-        send(space_method).scope
-      }
-      scope "#{name}_reverse", -> {
-        send(space_method).scope_reverse
-      }
-      define_singleton_method "#{name}_at", ->(record) {
-        send(space_method).at(record)
-      }
-      define_method(name) { |scope = nil|
-        (scope || self.class).send(space_method).at(self)
-      }
+      define_singleton_method(:"#{name}_space") { seek(*spec) }
+      class_eval <<-RUBY, __FILE__, __LINE__
+        scope :#{name}, -> { #{name}_space.scope }
+        scope :#{name}_reverse, -> { #{name}_space.scope_reverse }
+        def self.#{name}_at(record)
+          #{name}_space.at(record)
+        end
+        def #{name}(scope = self.class)
+          scope.#{name}_space.at(self)
+        end
+      RUBY
     end
   end
 

data/lib/order_query/column.rb

@@ -61,7 +61,7 @@ module OrderQuery
           (@order_enum.inspect if order_enum),
           ('unique' if @unique),
           (column_name if options[:sql]),
-          {desc: '▼', asc: '▲'}[@order]
+          @direction
       ].compact
       "(#{parts.join(' ')})"
     end

data/lib/order_query/direction.rb

@@ -3,8 +3,7 @@ module OrderQuery
   module Direction
     extend self
 
-    DIRECTIONS   = [:asc, :desc].freeze
-    DIRECTIONS_S = DIRECTIONS.map { |d| d.to_s.freeze }.freeze
+    DIRECTIONS = [:asc, :desc].freeze
 
     def all
       DIRECTIONS
@@ -20,11 +19,8 @@ module OrderQuery
     # @raise [ArgumentError]
     # @return [:asc, :desc]
     def parse!(direction)
-      if direction.is_a?(Symbol)
-        direction if DIRECTIONS.include?(direction)
-      else
-        direction = direction.to_s.downcase
-        direction.to_sym if DIRECTIONS_S.include?(direction)
+      if all.include?(direction)
+        direction
       end or
           raise ArgumentError.new("sort direction must be in #{all.map(&:inspect).join(', ')}, is #{direction.inspect}")
     end

data/lib/order_query/point.rb

@@ -26,7 +26,7 @@ module OrderQuery
       unless_record_eq before.first || (last if loop)
     end
 
-    # @return [Integer]
+    # @return [Integer] counting from 1
     def position
       space.count - after.count
     end
@@ -50,11 +50,7 @@ module OrderQuery
               else
                 space.scope_reverse
               end
-      if query.present?
-        scope.where(query, *query_args)
-      else
-        scope
-      end
+      scope.where(query, *query_args)
     end
 
     def value(cond)

data/lib/order_query/space.rb

@@ -5,6 +5,7 @@ module OrderQuery
   class Space
     # @return [Array<OrderQuery::Column>]
     attr_reader :columns
+    delegate :count, :empty?, to: :@base_scope
 
     # @param [ActiveRecord::Relation] base_scope
     # @param [Array<Array<Symbol,String>>, OrderQuery::Spec] order_spec
@@ -44,8 +45,6 @@ module OrderQuery
       scope_reverse.first
     end
 
-    delegate :count, :empty?, to: :@base_scope
-
     def inspect
       "#<OrderQuery::Space @columns=#{@columns.inspect} @base_scope=#{@base_scope.inspect}>"
     end

data/lib/order_query/version.rb

@@ -1,3 +1,3 @@
 module OrderQuery
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/spec/gemfiles/rails_4.gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '~> 4.0'
+gem 'activesupport', '~> 4.0'
+
+eval_gemfile './shared.gemfile'
+

data/spec/gemfiles/rails_4.gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: ../../
+  specs:
+    order_query (0.3.2)
+      activerecord (>= 4.0, < 6.0)
+      activesupport (>= 4.0, < 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+    activerecord (4.2.5)
+      activemodel (= 4.2.5)
+      activesupport (= 4.2.5)
+      arel (~> 6.0)
+    activesupport (4.2.5)
+      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.3)
+    builder (3.2.2)
+    byebug (8.2.1)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.3)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sqlite3 (1.3.11)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.0)
+  activerecord-jdbcsqlite3-adapter
+  activesupport (~> 4.0)
+  byebug
+  codeclimate-test-reporter
+  order_query!
+  rake (~> 10.2)
+  rspec (~> 3.4)
+  sqlite3 (>= 1.3.11)
+
+BUNDLED WITH
+   1.11.2

data/spec/gemfiles/rails_5.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '= 5.0.0.beta1'
+gem 'activesupport', '= 5.0.0.beta1'
+
+eval_gemfile './shared.gemfile'

data/spec/gemfiles/rails_5.gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: ../../
+  specs:
+    order_query (0.3.2)
+      activerecord (>= 4.0, < 6.0)
+      activesupport (>= 4.0, < 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.0.0.beta1)
+      activesupport (= 5.0.0.beta1)
+      builder (~> 3.1)
+    activerecord (5.0.0.beta1)
+      activemodel (= 5.0.0.beta1)
+      activesupport (= 5.0.0.beta1)
+      arel (~> 7.0)
+    activesupport (5.0.0.beta1)
+      concurrent-ruby (~> 1.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      method_source
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.0.0)
+    builder (3.2.2)
+    byebug (8.2.1)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    concurrent-ruby (1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    method_source (0.8.2)
+    minitest (5.8.3)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sqlite3 (1.3.11)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 5.0.0.beta1)
+  activerecord-jdbcsqlite3-adapter
+  activesupport (= 5.0.0.beta1)
+  byebug
+  codeclimate-test-reporter
+  order_query!
+  rake (~> 10.2)
+  rspec (~> 3.4)
+  sqlite3 (>= 1.3.11)
+
+BUNDLED WITH
+   1.11.2

data/spec/order_query_spec.rb

@@ -92,14 +92,15 @@ describe 'OrderQuery' do
             end
             issues.shuffle.reverse_each(&:save!)
             expect(Issue.display_order.to_a).to eq(issues)
-            issues.each_slice(2) do |prev, cur|
-              cur ||= issues.first
-              expect(prev.display_order.next).to eq(cur)
-              expect(cur.display_order.previous).to eq(prev)
+            expect(Issue.display_order_reverse.to_a).to eq(issues.reverse)
+            issues.zip(issues.rotate).each_with_index do |(cur, nxt), i|
+              expect(cur.display_order.position).to eq(i + 1)
+              expect(cur.display_order.next).to eq(nxt)
+              expect(Issue.display_order_at(cur).next).to eq nxt
               expect(cur.display_order.space.count).to eq(Issue.count)
-              expect(cur.display_order.before.count + 1 + cur.display_order.after.count).to eq(cur.display_order.count)
-
-              expect(cur.display_order.before.to_a.reverse + [cur] + cur.display_order.after.to_a).to eq(Issue.display_order.to_a)
+              expect(cur.display_order.before.count + 1 + cur.display_order.after.count).to eq(nxt.display_order.count)
+              expect(nxt.display_order.previous).to eq(cur)
+              expect(nxt.display_order.before.to_a.reverse + [nxt] + nxt.display_order.after.to_a).to eq(Issue.display_order.to_a)
             end
           end
         end
@@ -122,8 +123,10 @@ describe 'OrderQuery' do
 
         it '.seek works on a list of ids' do
           ids = 3.times.map { create_issue.id }
-          expect(Issue.seek([[:id, ids]]).scope.count).to eq ids.length
-          expect(Issue.seek([:id, ids]).scope.count).to eq ids.length
+          expect(Issue.seek([[:id, ids]]).count).to eq ids.length
+          expect(Issue.seek([:id, ids]).count).to eq ids.length
+          expect(Issue.seek([:id, ids]).scope.pluck(:id)).to eq ids
+          expect(Issue.seek([:id, ids]).scope_reverse.pluck(:id)).to eq ids.reverse
         end
 
         context 'partitioned on a boolean flag' do
@@ -138,10 +141,12 @@ describe 'OrderQuery' do
           let!(:inactive) { Issue.where(active: false).seek(order) }
 
           it '.seek preserves scope' do
-            expect(inactive.scope.count).to eq 1
             expect(inactive.count).to eq 1
+            expect(inactive.scope.count).to eq 1
+            expect(inactive.scope_reverse.count).to eq 1
             expect(active.count).to eq 2
             expect(active.scope.count).to eq 2
+            expect(active.scope_reverse.count).to eq 2
           end
 
           it 'gives a valid result if at argument is outside of the space' do
@@ -210,6 +215,30 @@ describe 'OrderQuery' do
           expect(o2.next(true)).to eq(p1)
         end
 
+        context '#inspect' do
+          it 'Column' do
+            expect(OrderQuery::Column.new([:id, :desc], Post).inspect).to eq '(id unique desc)'
+            expect(OrderQuery::Column.new([:virtual, :desc, sql: 'SIN(id)'], Post).inspect).to eq '(virtual SIN(id) desc)'
+          end
+
+          let(:space) {
+            OrderQuery::Space.new(Post, [[:pinned, [true, false]]])
+          }
+
+          it 'Point' do
+            post  = create_post
+            point = OrderQuery::Point.new(post, space)
+            expect(point.inspect).to(
+                eq %Q(#<OrderQuery::Point @record=#<Post id: #{post.id}, pinned: false, published_at: #{post.attribute_for_inspect(:published_at)}> @space=#<OrderQuery::Space @columns=[(pinned [true, false] desc), (id unique asc)] @base_scope=Post(id: integer, pinned: boolean, published_at: datetime)>>)
+            )
+          end
+
+          it 'Space' do
+            expect(space.inspect).to eq '#<OrderQuery::Space @columns=[(pinned [true, false] desc), (id unique asc)] @base_scope=Post(id: integer, pinned: boolean, published_at: datetime)>'
+          end
+        end
+
+
         context 'boolean enum order' do
           before do
             create_post pinned: true

metadata

@@ -1,57 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: order_query
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-15 00:00:00.000000000 Z
+date: 2016-01-05 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +98,10 @@ files:
 - lib/order_query/sql/order_by.rb
 - lib/order_query/sql/where.rb
 - lib/order_query/version.rb
+- spec/gemfiles/rails_4.gemfile
+- spec/gemfiles/rails_4.gemfile.lock
+- spec/gemfiles/rails_5.gemfile
+- spec/gemfiles/rails_5.gemfile.lock
 - spec/order_query_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/glebm/order_query
@@ -109,10 +125,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Find next / previous Active Record(s) in one query
 test_files:
+- spec/gemfiles/rails_4.gemfile
+- spec/gemfiles/rails_4.gemfile.lock
+- spec/gemfiles/rails_5.gemfile
+- spec/gemfiles/rails_5.gemfile.lock
 - spec/order_query_spec.rb
 - spec/spec_helper.rb