active_record-cursor_paginator 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19564a0a0f62ea77cf5876fc9d125f27474aba8fec598a6a84e6b215b13edb22
-  data.tar.gz: e9856e7730229847a6d345c7b2cab49062b2351216fb02a775c1a4d3d8c19ca6
+  metadata.gz: 2b976c754e305df50a8c5eb4889bf98a6041a3e4c8fa73b7c6d6a4566068037a
+  data.tar.gz: 680ed7b82dd56e0c1a72db977350b701bdd9c90666053e7399f9dd9d280afae6
 SHA512:
-  metadata.gz: c899b2ea56ffd2a65edabbbd06421bc695263555488b8068cf0c753d4cf84e6ca1c57837b339ed7237d47ab8d200c6242d52ded55ffc991c3df784a0c0056ec6
-  data.tar.gz: 3f037675aa41403536d136e99faa7c08ec0184c5756fd91cabb88e6d72bdbec3f2be3cc1cbe83ab8efa2538218d35121e05c8c312e0683c26332ad16cbb8bc8c
+  metadata.gz: 7097e691c6a902bb42d0c2b8a7cb55a22d768b3d7bedefe344d05500efa6e665145d5e6ed8263bc3cbc313dd256bfab294a2651aa6fc1b230c910a8bdabd7abb
+  data.tar.gz: e1508a1aed8100c86f8f389a16b35996a4d633fb371a0e7a918ab728ee7e236f57b22df4d9d7ab6a1b8fe9785294bd0c5cc804f2f6d0e712d2ef4e88b746de84

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.3.2] - 2026-06-03
+
+- Fix timezone offset in datetime cursor values being ignored in WHERE clause
+- Warn when a datetime cursor column is a join table alias, as type inference may be inaccurate
+
+## [0.3.1] - 2026-03-06
+
+- Add support for Rails enum columns
+
 ## [0.3.0] - 2025-12-10
 
 - Fix ambiguous column error

data/README.md

@@ -65,6 +65,18 @@ ActiveSupport::JSON::Encoding.time_precision = 6
 
 ## Limitation
 
+### Datetime cursor values on join table columns
+
+When ordering by a datetime column from a joined table via an alias (e.g. `authors.created_at as author_created_at`), the column type is inferred from the root model. If the joined table's column type differs from the root model's column with the same name, timezone conversion in cursor values may be inaccurate.
+
+A warning is logged when this situation is detected:
+
+```
+[CursorPaginator] Cursor column 'author_created_at' resolves to 'authors.created_at'
+(join column). Type is inferred from Post and may be inaccurate.
+Timezone-aware datetime cursors on joined tables may not work correctly.
+```
+
 This library does not support the following order expressions
 
 ```ruby

data/lib/active_record/cursor_paginator/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   class CursorPaginator
-    VERSION = '0.3.0'
+    VERSION = '0.3.2'
   end
 end

data/lib/active_record/cursor_paginator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_record'
+require 'set'
 require_relative 'cursor_paginator/version'
 
 module ActiveRecord
@@ -160,10 +161,23 @@ module ActiveRecord
       # value from this other field as well as the records ID to resolve the order
       # of duplicates in the non-ID field.
       #
+      # For enum columns, we store the raw integer value instead of the string
+      # representation to ensure proper SQL comparison in WHERE clauses.
+      #
       # @param record [ActiveRecord] Model instance for which we want the cursor
       # @return [String]
       def cursor_for_record(record)
-        unencoded_cursor = @fields.map {|field| { field.keys.first => record[field.keys.first] } }
+        unencoded_cursor = @fields.map do |field|
+          field_name = field.keys.first
+          value = if record.class.defined_enums.has_key?(field_name.to_s)
+                    # For enum columns, get the raw integer value from the database
+                    record.read_attribute_before_type_cast(field_name)
+                  else
+                    # For regular columns, get the typed value
+                    record[field_name]
+                  end
+          { field_name => value }
+        end
         Base64.strict_encode64(unencoded_cursor.to_json)
       end
 
@@ -255,14 +269,43 @@ module ActiveRecord
       def build_filter_query(sorted_relation, op, current_field, prev_fields)
         relation = sorted_relation
         prev_fields.each do |col, val|
+          col_key = col
           col = @aliases[col] if @aliases.has_key? col
           col = qualify_field_if_needed(col)
-          relation = relation.where("#{col} = ?", val)
+          relation = relation.where("#{col} = ?", cast_cursor_value(col_key, val))
         end
         col, val = current_field
+        col_key = col
         col = @aliases[col] if @aliases.has_key? col
         col = qualify_field_if_needed(col)
-        relation.where("#{col} #{op} ?", val)
+        relation.where("#{col} #{op} ?", cast_cursor_value(col_key, val))
+      end
+
+      def cast_cursor_value(col_name, val)
+        return val unless val.is_a?(String)
+
+        resolved_expr = @aliases[col_name.to_s]
+        resolved_col = (resolved_expr || col_name.to_s).split('.').last
+        type = @relation.klass.type_for_attribute(resolved_col)
+
+        return val unless %i[datetime time timestamp].include?(type.type)
+
+        warn_join_column_cast(col_name, resolved_expr) if resolved_expr&.match?(/\A\w+\.\w+\z/)
+
+        type.cast(val)
+      end
+
+      def warn_join_column_cast(alias_name, expression)
+        @_warned_join_casts ||= Set.new
+        return if @_warned_join_casts.include?(alias_name)
+
+        @_warned_join_casts << alias_name
+
+        msg = "[CursorPaginator] Cursor column '#{alias_name}' resolves to '#{expression}' " \
+              "(join column). Type is inferred from #{@relation.klass.name} and may be " \
+              'inaccurate. Timezone-aware datetime cursors on joined tables may not work correctly.'
+        logger = ActiveRecord::Base.logger
+        logger ? logger.warn(msg) : Kernel.warn(msg)
       end
 
       # parse aliases from select values

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record-cursor_paginator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Shinichi Sugiyama
@@ -42,7 +42,6 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- active_record-cursor_paginator.gemspec
 - lib/active_record/cursor_paginator.rb
 - lib/active_record/cursor_paginator/version.rb
 homepage: https://github.com/ssugiyama/active_record-cursor_paginator

data/active_record-cursor_paginator.gemspec

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/active_record/cursor_paginator/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'active_record-cursor_paginator'
-  spec.version = ActiveRecord::CursorPaginator::VERSION
-  spec.authors = ['Shinichi Sugiyama']
-  spec.email = ['sugiyama-shinichi@kayac.com']
-
-  spec.summary = 'cursor pagination for ActiveRecord'
-  spec.description =
-    '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 to this library separately.' \
-    '- supports bidirectional pagination.'
-
-  spec.homepage = 'https://github.com/ssugiyama/active_record-cursor_paginator'
-  spec.license = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/Changelog.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
-    end
-  end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) {|f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_dependency 'activerecord', '>= 6.0'
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-  spec.metadata['rubygems_mfa_required'] = 'true'
-end