active_record-cursor_paginator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f0bf9b4efedd42ab91e3ad4cc65ceddc323e14482d412e191cd5f999c4b7652
-  data.tar.gz: '05907e8c002d776c4f06a7dae8352e058eab6790eaf509af22ba612c287c7369'
+  metadata.gz: 89a00cae4602011f6cf01aed6e09c6956d7eab352ec7b97c2d6ce712cfba972f
+  data.tar.gz: c8164ed441e5ed69dfe1874dcdea8337855b2a2cfc128cb481d013e3bb125a7c
 SHA512:
-  metadata.gz: cbf06f52e6d3acb9be08eb0ec8e88a53d33000670783bb9841d5ece1a67b400478bee8ebbf3bf4a1f85c0f549b42834f5e760a740713a8b469833550495f0b2b
-  data.tar.gz: 1ff2dd7da5bd5ed0e5d63eeee7a41b4d80b0f3ab17dc511843859b63b1b624373ba64c4a84df745cca08bcd043d24ac90d0eb62a75cb55fa7c3151979ccf8426
+  metadata.gz: 0df15ecf4719f1ac64b922193042511a03aa2fc642e0fb98d5f9154043c3c388347646e8e6e566a7418e33b650bfd8017dd55fe9fa276c43c42f7af8b148b1fe
+  data.tar.gz: 9fe08024a3cb033d6e32b07187f803e379b2c57735b27f4dfeb75621cc4da9672a36d23885038d79291773ce9eff90771591242477e26304b0e276a70372d00a

data/.rubocop.yml

@@ -8,6 +8,7 @@ inherit_mode:
 
 # 自動生成されるものはチェック対象から除外する
 AllCops:
+  TargetRubyVersion: 2.7
   SuggestExtensions: false
   NewCops: enable
   Exclude:
@@ -17,17 +18,6 @@ AllCops:
     - "vendor/**/*"
     - "bin/*"
     - "Gemfile*"
-    - "db/schema.rb"
-    - "db/seeds.rb"
-    - 'db/migrate/*_init_schema.rb' # squasher generated
-    - "frontend/**/*"
-    - 'spec/fixtures/**/*'
-    - 'terraform/**/*'
-    - "app/lib/qwan_exception.rb"
-    - "app/controllers/test_data_controller.rb"
-    - "app/apis/api/v1/concerns/errors.rb"
-    - 'docker/**/*'
-    - '**/node_modules/**/*'
 
 #################### Layout ################################
 
@@ -36,13 +26,6 @@ AllCops:
 # のイメージ
 Layout/LineLength:
   Max: 160
-  Exclude:
-    - "db/migrate/*.rb"
-    - "app/lib/ngword.rb"
-    - "app/exceptions/qwan_exception/shop_remove_location_despite_has_ticket.rb"
-    - "spec/apis/api/v1/contact_spec.rb"
-    - "spec/ledger/report/tenant_transactions_spec.rb"
-    - "spec/ledger/report/transactions_spec.rb"
 
 # ガード句と本質を分けるのは良いコードスタイルなので有効化
 Layout/EmptyLineAfterGuardClause:
@@ -171,43 +154,22 @@ Metrics/BlockLength:
     - "**/*.rake"
     - "spec/**/*.rb"
     - "Gemfile"
-    - "Guardfile"
-    - "config/environments/*.rb"
-    - "config/routes.rb"
-    - "config/routes/**/*.rb"
-    - "*.gemspec"
-    - "app/apis/**/*.rb"
-    - 'app/models/concerns/firebase_auth_concern.rb'
-    - 'app/models/concerns/region_location_report_concern.rb'
-    - 'db/migrate/*_init_schema.rb' # squasher generated
 
 # 6 は強すぎるので緩める
 Metrics/CyclomaticComplexity:
   Max: 11
-  Exclude:
-    - "app/models/mission_master.rb"
 
 Metrics/ClassLength:
   Max: 500
   CountAsOne: ['array', 'hash', 'heredoc']
-  Exclude:
-    - 'db/migrate/*_init_schema.rb' # squasher generated
 
 # 20 行超えるのは migration ファイル以外滅多に無い
 Metrics/MethodLength:
   Max: 30
-  Exclude:
-    - "db/migrate/*.rb"
-    - "app/models/**/search.rb"
-    - "app/controllers/test_data_controller.rb"
-    - "app/models/mission_master.rb"
-    - "app/models/region_player/status.rb"
 
 # 分岐の数。ガード句を多用しているとデフォルト 7 だと厳しい
 Metrics/PerceivedComplexity:
   Max: 10
-  Exclude:
-    - "app/models/mission_master.rb"
 
 Metrics/ParameterLists:
   Max: 8

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.3.0

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.2.0] - 2024-03-27
+
+- Support aliases
+
+## [0.1.0] - 2023-09-21
+
+- Initial release

data/README.md

@@ -3,7 +3,7 @@
 This library is an implementation of cursor pagination for ActiveRecord relations based on "https://github.com/xing/rails_cursor_pagination.
 
 Additional features are:
-- receives a relation with orders, and it is unnecessary to specify orders toA this library separately
+- receives a relation with orders, and it is unnecessary to specify orders to this library separately
 - supports bidirectional pagination.
 
 ## Supported environment
@@ -13,25 +13,40 @@ Additional features are:
 
 ## Installation
 
-Add the fllowing line to your `Gemfile` and execute `bundle install`
+Add the following line to your `Gemfile` and execute `bundle install`
 
 ```
-gem 'active_record-cursor_paginator', git: 'https://github.com/ssugiyama/active_record-cursor_paginator'
+gem 'active_record-cursor_paginator'
 ```
 
 ## Usage
 
 ```ruby
 relation = Post.order(...)
-page = ActiveRecord::CursorPaginator.new(relarion, direction: :forward, cursor: '...', per_page: 10)
+page = ActiveRecord::CursorPaginator.new(relation, direction: :forward, cursor: '...', per_page: 10)
 ```
 
-### parameters of CursorPaginator
+### aliases
+
+This library supports column aliases as below, and extracts aliases from select values automatically.
+
+```ruby
+relation = Post.select('posts.*, authors.name author_name').joins(:author).order(author_name: :desc)
+page = ActiveRecord::CursorPaginator.new(relation, direction: :forward, cursor: '...', per_page: 10)
+```
+
+Supported aliases are strings in the format below
+
+- `some expression [as|AS] *alias*`
+
+Other aliases such as symbols or arel functions are ignored.
+
+### Parameters of CursorPaginator
 - cursor: String - cursor to paginate
 - per_page: Integer - record count per page (default to 10)
 - direction: Symbol - direction to paginate. `:forward` (default) or `:backward`
 
-### response of CursorPaginator
+### Response of CursorPaginator
 
 - `page.records`: Array - records splitted per page (Notice: not ActiveRecord::Relation but Array)
 - `page.start_cursor`: String - cursor of the first record. used for the backward paginate call.
@@ -40,6 +55,26 @@ page = ActiveRecord::CursorPaginator.new(relarion, direction: :forward, cursor:
 - `page.next_page?`:  Boolean - whether having the next page forward or not
 - `page.previous_page?`:  Boolean - whether having the next page backward or not
 
+## Notice
+
+You need to specify `ActiveSupport::JSON::Encoding.time_precision` to use time columns as order keys. It must be equals to the maximum precision of your order keys. Default precision of time columns in Rails is 6. So, please specify as follows in your initializers:
+
+```
+ActiveSupport::JSON::Encoding.time_precision = 6
+```
+
+## Limitation
+
+This library does not support the following order expressions
+
+```ruby
+Post.order(Arel::Nodes::NamedFunction.new('abs', [Post.arel_table[:display_index]])) # order by arel function
+Post.order('abs(display_index)') # order by funtion
+Post.order('abs(display_index) asc') # order by function and direction
+```
+
+Use aliases.
+
 ## Development
 
 ### Run test
@@ -49,9 +84,15 @@ ADAPTER=mysql bundle exec rspec
 ADAPTER=postgresql bundle exec rspec
 ```
 
+## ToDo
+
+This library automatically appends `id` column to sorting and filtering columns, if it is not the last one.
+This feature may cause unnecessary performance deterioration.
+So, we plan this feature can be off.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ssugiyama/activerecord-cursor_paginator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ssugiyama/activerecord-cursor_paginator/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/ssugiyama/active_record-cursor_paginator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ssugiyama/active_record-cursor_paginator/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -59,4 +100,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Activerecord::CursorPagination project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ssugiyama/activerecord-cursor_paginator/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Activerecord::CursorPagination project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ssugiyama/active_record-cursor_paginator/blob/main/CODE_OF_CONDUCT.md).

data/lib/active_record/cursor_paginator/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   class CursorPaginator
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/active_record/cursor_paginator.rb

@@ -20,8 +20,8 @@ module ActiveRecord
     #   Number of records to return.
     # @param cursor [String, nil]
     #   Cursor to paginate
-    # @param order [Array, Hash, Symbol, nil]
-    #   Column to order by. If none is provided, will default to ID column.
+    # @param direction [Symbol]
+    #   :forward or :backward
     def initialize(relation, per_page: nil, cursor: nil, direction: DIRECTION_FORWARD)
       @is_forward_pagination = direction == DIRECTION_FORWARD
       relation = relation.order(:id) if relation.order_values.empty?
@@ -31,7 +31,9 @@ module ActiveRecord
       @relation = relation.reorder(@fields)
       @cursor = cursor
       @page_size = per_page
-
+      aliases = parse_aliases
+      aliases[:id] ||= "#{relation.table_name}.id"
+      @aliases = aliases.with_indifferent_access
       @memos = {}
     end
 
@@ -44,10 +46,11 @@ module ActiveRecord
         case o
         when Arel::Attribute # .order(arel_table[:id])
           { o.name => :asc }
-        when Arel::Nodes::Ascending # .order(id: :asc), .order(:id)
-          { o.expr.name => :asc }
-        when Arel::Nodes::Descending # .order(id: :desc)
-          { o.expr.name => :desc }
+        when Arel::Nodes::Ascending, # .order(id: :asc), .order(:id)
+             Arel::Nodes::Descending # .order(id: :desc)
+          key = o.expr.is_a?(Arel::Attributes::Attribute) ? o.expr.name : trim_quote(o.expr)
+          dir = o.direction
+          { key => dir }
         when String # .order('id desc')
           o.split(',').map! do |s|
             s.strip!
@@ -186,8 +189,8 @@ module ActiveRecord
         relation = @relation
 
         @fields.each do |field|
-          field = field.keys.first
-          relation = relation.select(field) unless @relation.select_values.include?(field)
+          field = trim_quote(field.keys.first)
+          relation = relation.select(field) unless @relation.select_values.include?(field) || @aliases.keys.include?(field)
         end
 
         relation
@@ -210,6 +213,7 @@ module ActiveRecord
           next sorted_relation if @cursor.blank?
 
           cursor = decoded_cursor
+
           unless cursor.length == @fields.length && cursor.map {|field| field.keys.first } == @fields.map {|field| field.keys.first }
             raise InvalidCursorError, 'The given cursor is mismatched with current query'
           end
@@ -218,8 +222,7 @@ module ActiveRecord
           relation = nil
           cursor.zip(@fields).each do |cursor_field, field|
             direction = field.values.first
-            # range では 〜より大きいということが表現できないのでarel_tableを使う
-            op = (direction == :asc) ? :gt : :lt
+            op = (direction == :asc) ? '>' : '<'
             current_field = [field.keys.first, cursor_field.values.first]
             new_relation = build_filter_query(sorted_relation, op, current_field, prev_fields)
             relation = relation.nil? ? new_relation : relation.or(new_relation)
@@ -252,10 +255,39 @@ module ActiveRecord
       def build_filter_query(sorted_relation, op, current_field, prev_fields)
         relation = sorted_relation
         prev_fields.each do |col, val|
-          relation = relation.where(relation.arel_table[col].send(:eq, val))
+          col = @aliases[col] if @aliases.has_key? col
+          relation = relation.where("#{col} = ?", val)
         end
         col, val = current_field
-        relation.where(relation.arel_table[col].send(op, val))
+        col = @aliases[col] if @aliases.has_key? col
+        relation.where("#{col} #{op} ?", val)
+      end
+
+      # parse aliases from select values
+      #
+      # @return [Hash]
+      def parse_aliases
+        aliases = {}
+        @relation.select_values.each do |select_value|
+          next unless select_value.is_a? String
+
+          select_value.split(',').each do |expr|
+            expr.strip!
+            # "value [AS|as] alias" という形式に対応する
+            # value: spaceがあってもOK. 最小マッチングのため '?' をつける
+            # 'as' は使わないのでキャプチャしない
+            match = expr.match(/^(?<value>.+?)\s+(?:as\s+)?(?<alias>\S+)$/i)
+            next if match.nil? || match.length < 3
+
+            key = trim_quote(match[:alias])
+            aliases[key] = match[:value]
+          end
+        end
+        aliases
+      end
+
+      def trim_quote(field)
+        field.gsub(/^[`\"]/, '').gsub(/[`\"]$/, '')
       end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-cursor_paginator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shinichi Sugiyama
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -37,9 +37,10 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - lib/active_record/cursor_paginator.rb

data/Gemfile.lock

@@ -1,88 +0,0 @@
-PATH
-  remote: .
-  specs:
-    active_record-cursor_paginator (0.1.0)
-      activerecord (>= 6.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (7.0.8)
-      activesupport (= 7.0.8)
-    activerecord (7.0.8)
-      activemodel (= 7.0.8)
-      activesupport (= 7.0.8)
-    activesupport (7.0.8)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    base64 (0.1.1)
-    concurrent-ruby (1.2.2)
-    diff-lcs (1.5.0)
-    i18n (1.14.1)
-      concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    language_server-protocol (3.17.0.3)
-    minitest (5.20.0)
-    mysql2 (0.5.5)
-    parallel (1.23.0)
-    parser (3.2.2.3)
-      ast (~> 2.4.1)
-      racc
-    pg (1.5.4)
-    racc (1.7.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.56.3)
-      base64 (~> 0.1.1)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.2.2.3)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
-    ruby-progressbar (1.13.0)
-    temping (4.0.0)
-      activerecord (>= 5.2, < 7.1)
-      activesupport (>= 5.2, < 7.1)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
-
-PLATFORMS
-  arm64-darwin-22
-
-DEPENDENCIES
-  active_record-cursor_paginator!
-  mysql2 (~> 0.5)
-  pg (>= 1.2, < 2.0)
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
-  temping
-
-BUNDLED WITH
-   2.4.10