order_query 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be66ba349bb0a4819d39ee8f01d8bfa12e82177e
-  data.tar.gz: 56637889ea73d1f90e70dcd72e09431eb357f1e1
+  metadata.gz: 6e69a0283a9dcc95fe70d2fd18c02f5aa62120d2
+  data.tar.gz: d1d0a0975074175ff4eb15d7fa5efdd20fc91c3f
 SHA512:
-  metadata.gz: c8f9fe60869ae746f9d095dfc549f651b994ded8b75875cd60761e9e7683cdcb6968834916ae6eb881b3dc684f26220adf4e873948923b8e41daee90b11d6671
-  data.tar.gz: b068a5d7bcc50af28dbdff396adca897f8f502640fcad0f162f1ea9ee4424c9a9cf1afde85837261908bd984a9339bbb6fdce50477d0aa9ed99b394cabf2e53a
+  metadata.gz: 0a5d6a00cd9096587584e9c32a1daf05f26577175d9e0bf6a783b8bc189a710482143b18166b82620b3ef315928c51ed837f6776e719ff53c53c644cfc278fa6
+  data.tar.gz: 6ae64249791c2c8ac500b10b3a50c9ed6cf439056301ca1d361f1d8f5559fa1180bcdf72113698922a08ad6fd85f5e3adcd3c25c5b9e9f50776225ce51c616f2

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.3.2
+
+* Optimization: do not wrap top-level disjunctive in `AND` when the column has an enumerated order. [Read more](https://github.com/glebm/order_query/issues/3#issuecomment-54764638).
+* Boolean enum columns (e.g. `[:pinned, [true, false]]`) are now automatically collapsed to `ORDER by column ASC|DESC`.
+
 ## 0.3.1
 
 * Automatically add primary key when there is no unique column for the order

data/README.md

@@ -12,7 +12,7 @@ It uses [keyset pagination](http://use-the-index-luke.com/no-offset) to achieve
 Add to Gemfile:
 
 ```ruby
-gem 'order_query', '~> 0.3.1'
+gem 'order_query', '~> 0.3.2'
 ```
 
 ## Usage

data/lib/order_query/column.rb

@@ -1,29 +1,32 @@
 # coding: utf-8
+require 'order_query/direction'
 require 'order_query/sql/column'
 module OrderQuery
   # An order column (sort column)
   class Column
-    attr_reader :name, :order, :order_enum, :options
+    attr_reader :name, :order_enum, :options
     delegate :column_name, :quote, to: :@sql
 
     # @option spec [String] :unique    Mark the attribute as unique to avoid redundant columns
     def initialize(spec, scope)
-      spec    = spec.dup
-      options = spec.extract_options!
-      @name   = spec[0]
-      case spec[1]
-        when Array
-          @order_enum = spec[1]
-          @order      = spec[2] || :desc
-        else
-          @order = spec[1] || :asc
+      spec       = spec.dup
+      options    = spec.extract_options!
+      @name      = spec[0]
+      if spec[1].is_a?(Array)
+        @order_enum = spec.delete_at(1)
+        spec[1] ||= :desc
       end
-      @options  = options.reverse_merge(
+      @direction = Direction.parse!(spec[1] || :asc)
+      @options   = options.reverse_merge(
           unique:   name.to_s == scope.primary_key,
           complete: true
       )
-      @unique   = @options[:unique]
-      @sql      = SQL::Column.new(self, scope)
+      @unique    = @options[:unique]
+      @sql       = SQL::Column.new(self, scope)
+    end
+
+    def direction(reverse = false)
+      reverse ? Direction.reverse(@direction) : @direction
     end
 
     def unique?
@@ -40,7 +43,7 @@ module OrderQuery
       ord = order_enum
       pos = ord.index(value)
       if pos
-        dir = order
+        dir = direction
         if side == :after && dir == :desc || side == :before && dir == :asc
           ord.from pos + (strict ? 1 : 0)
         else

data/lib/order_query/direction.rb

@@ -0,0 +1,32 @@
+module OrderQuery
+  # Responsible for handling :asc and :desc
+  module Direction
+    extend self
+
+    DIRECTIONS   = [:asc, :desc].freeze
+    DIRECTIONS_S = DIRECTIONS.map { |d| d.to_s.freeze }.freeze
+
+    def all
+      DIRECTIONS
+    end
+
+    # @param [:asc, :desc] direction
+    # @return [:asc, :desc]
+    def reverse(direction)
+      all[(all.index(direction) + 1) % 2].to_sym
+    end
+
+    # @param [:asc, :desc, String] direction
+    # @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)
+      end or
+          raise ArgumentError.new("sort direction must be in #{all.map(&:inspect).join(', ')}, is #{direction.inspect}")
+    end
+  end
+end

data/lib/order_query/sql/order_by.rb

@@ -13,48 +13,52 @@ module OrderQuery
 
       # @return [String]
       def build_reverse
-        @reverse_sql ||= join_order_by_clauses order_by_reverse_sql_clauses
+        @reverse_sql ||= join_order_by_clauses order_by_sql_clauses(true)
       end
 
       protected
 
       # @return [Array<String>]
-      def order_by_sql_clauses
-        @columns.map { |cond| column_clause cond }
+      def order_by_sql_clauses(reverse = false)
+        @columns.map { |col| column_clause col, reverse }
       end
 
-      def column_clause(cond)
-        dir_sql = sort_direction_sql cond.order
-        col_sql = cond.column_name
-        if cond.order_enum
-          cond.order_enum.map { |v| "#{col_sql}=#{cond.quote v} #{dir_sql}" }.join(', ').freeze
+      def column_clause(col, reverse = false)
+        if col.order_enum
+          column_clause_enum col, reverse
         else
-          "#{col_sql} #{dir_sql}".freeze
+          column_clause_ray col, reverse
         end
       end
 
-      SORT_DIRECTIONS = [:asc, :desc].freeze
-      # @return [String]
-      def sort_direction_sql(direction)
-        if SORT_DIRECTIONS.include?(direction)
-          direction.to_s.upcase.freeze
-        else
-          raise ArgumentError.new("sort direction must be in #{SORT_DIRECTIONS.map(&:inspect).join(', ')}, is #{direction.inspect}")
+      def column_clause_ray(col, reverse = false)
+        "#{col.column_name} #{sort_direction_sql(col, reverse)}".freeze
+      end
+
+      def column_clause_enum(col, reverse = false)
+        enum = col.order_enum
+        # Collapse boolean enum to `ORDER BY column ASC|DESC`
+        if enum == [false, true] || enum == [true, false]
+          return column_clause_ray col, reverse ^ enum.last
         end
+        enum.map { |v|
+          "#{order_by_value_sql col, v} #{sort_direction_sql(col, reverse)}"
+        }.join(', ').freeze
+      end
+
+      def order_by_value_sql(col, v)
+        "#{col.column_name}=#{col.quote v}"
+      end
+
+      # @return [String]
+      def sort_direction_sql(col, reverse = false)
+        col.direction(reverse).to_s.upcase.freeze
       end
 
       # @param [Array<String>] clauses
       def join_order_by_clauses(clauses)
         clauses.join(', ').freeze
       end
-
-      # @return [Array<String>]
-      def order_by_reverse_sql_clauses
-        swap = {'DESC' => 'ASC', 'ASC' => 'DESC'}
-        order_by_sql_clauses.map { |s|
-          s.gsub(/DESC|ASC/) { |m| swap[m] }
-        }
-      end
     end
   end
 end

data/lib/order_query/sql/where.rb

@@ -65,9 +65,8 @@ module OrderQuery
       # Read more at https://github.com/glebm/order_query/issues/3
       def wrap_top_level_or(query, terms, side)
         top_term_i = terms.index(&:present?)
-        if top_term_i && terms[top_term_i].length == 2 &&
-            (cond = where_side(@columns[top_term_i], side, false)) != WHERE_IDENTITY
-          join_terms 'AND'.freeze, cond, wrap_term_with_parens(query)
+        if top_term_i && terms[top_term_i].length == 2 && !(col = @columns[top_term_i]).order_enum
+          join_terms 'AND'.freeze, where_side(col, side, false), wrap_term_with_parens(query)
         else
           query
         end
@@ -107,11 +106,9 @@ module OrderQuery
         [%Q(#{col.column_name} = ?).freeze, [value]]
       end
 
+      RAY_OP = {asc: '>'.freeze, desc: '<'.freeze}.freeze
       def where_ray(col, from, mode, strict = true)
-        ops = %w(< >)
-        ops = ops.reverse if mode == :after
-        op  = {asc: ops[0], desc: ops[1]}[col.order || :asc]
-        ["#{col.column_name} #{op}#{'=' unless strict} ?".freeze, [from]]
+        ["#{col.column_name} #{RAY_OP[col.direction(mode == :before)]}#{'=' unless strict} ?".freeze, [from]]
       end
 
       WHERE_IDENTITY = [''.freeze, [].freeze].freeze

data/lib/order_query/version.rb

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

data/spec/order_query_spec.rb

@@ -57,7 +57,7 @@ end
 describe 'OrderQuery' do
 
   [false, true].each do |wrap_top_level_or|
-    context "(wrap_top_level_or: #{wrap_top_level_or})" do
+    context "(wtlo: #{wrap_top_level_or})" do
       wrap_top_level_or wrap_top_level_or
 
       context 'Issue test model' do
@@ -210,6 +210,42 @@ describe 'OrderQuery' do
           expect(o2.next(true)).to eq(p1)
         end
 
+        context 'boolean enum order' do
+          before do
+            create_post pinned: true
+            create_post pinned: false
+          end
+          after do
+            Post.delete_all
+          end
+          it 'ORDER BY is collapsed' do
+            expect(Post.seek([:pinned, [true, false]]).scope.to_sql).to include('ORDER BY "posts"."pinned" DESC')
+          end
+          it 'enum asc' do
+            expect(Post.seek([:pinned, [false, true], :asc]).scope.pluck(:pinned)).to eq([true, false])
+            expect(Post.seek([:pinned, [true, false], :asc]).scope.pluck(:pinned)).to eq([false, true])
+          end
+          it 'enum desc' do
+            expect(Post.seek([:pinned, [false, true], :desc]).scope.pluck(:pinned)).to eq([false, true])
+            expect(Post.seek([:pinned, [true, false], :desc]).scope.pluck(:pinned)).to eq([true, false])
+          end
+        end
+
+        xcontext 'nil in enum' do
+          states = [nil, false, true]
+          let!(:posts) { states.map { |state| create_post(pinned: state) } }
+          states.permutation do |p|
+            # There is no cross-DB SQL that can be generated to position nil results
+            # http://use-the-index-luke.com/sql/sorting-grouping/order-by-asc-desc-nulls-last
+            next unless p.first.nil? || p.last.nil?
+            # Positioning NULLs first or last can be achieved, but remains on the ToDo / contributions welcome list
+            it "nil in enum works for #{p}" do
+              expect(Post.seek([:pinned, p]).scope.all.map(&:pinned)).to eq(p)
+              expect(Post.seek([:pinned, p, :asc]).scope.all.map(&:pinned)).to eq(p.reverse)
+            end
+          end
+        end
+
         before do
           Post.delete_all
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: order_query
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-07 00:00:00.000000000 Z
+date: 2014-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -79,6 +79,7 @@ files:
 - Rakefile
 - lib/order_query.rb
 - lib/order_query/column.rb
+- lib/order_query/direction.rb
 - lib/order_query/point.rb
 - lib/order_query/space.rb
 - lib/order_query/sql/column.rb