activerecord-bitemporal 6.1.0 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7676d93276c1c24acbb001b135c344b94d3b0b8084d2ef17423c238b5e06bfaf
-  data.tar.gz: f07cc0d7a716c99d3d85f352588309351b3ed408e6ddec5ad153096dd2310786
+  metadata.gz: 553dc55266366a109d0f4275ed0e70229984d1fb139b858be2828c2d75e0c182
+  data.tar.gz: dccb0a53b560b6c3a8eebd29e46e30b816c15002eddfbf0cbf6355838167fd76
 SHA512:
-  metadata.gz: 95b6ea9e934a5818d3fc3e0409faef14bde66aeafbd0a0a168a1649e3b88ed6a11a0e8174094f7527ae4ba47076449db17a17597b83587a8986815af458b6c19
-  data.tar.gz: ece5cc5e3a8846f6495b63b30eb35eb4648e95b712e582b72fa67dafd1cfe9af1384737a11cf272d06cf73ed9e9121a674a6e0ea90434edb77d1715603cf7ffe
+  metadata.gz: fcb1d50c24df2103608ff407207145b84a87649f862db1625343ce0f5281dde85f5c2a43af10ab5b72b6b2f118ace4705137a28a774ed159c7472bde4b1b091b
+  data.tar.gz: 93fb11c615891a252b597678c4c53049460c093e80003f657e17a9c7ef2149592fd0ae91bc51f80da7619074e3de62f32e6207a7cbd281d48ea44ac23f6646b7

data/CHANGELOG.md

@@ -1,8 +1,87 @@
 # Changelog
 
+## Unreleased
+
+### Breaking Changes
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Chores
+
+## 7.0.1
+
+### Breaking Changes
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+- [Use bitemporal_id as primary key for Rails 8+ excluding/without #252](https://github.com/kufu/activerecord-bitemporal/pull/252)
+- [Use bitemporal_id as primary key for Rails 8+ AR::Batches #251](https://github.com/kufu/activerecord-bitemporal/pull/251)
+
+### Chores
+
+- [Bump ruby/setup-ruby from 1.299.0 to 1.300.0 #253](https://github.com/kufu/activerecord-bitemporal/pull/253)
+- [Bump rubygems/release-gem from 1.1.2 to 1.2.0 #250](https://github.com/kufu/activerecord-bitemporal/pull/250)
+- [Bump ruby/setup-ruby from 1.295.0 to 1.299.0 #249](https://github.com/kufu/activerecord-bitemporal/pull/249)
+- [Bump ruby/setup-ruby from 1.288.0 to 1.295.0 #248](https://github.com/kufu/activerecord-bitemporal/pull/248)
+
+## 7.0.0
+
+### Breaking Changes
+
+- [Drop support Rails 7.0 #230](https://github.com/kufu/activerecord-bitemporal/pull/230)
+
+### Added
+
+- [Add Ruby 4.0 in CI #236](https://github.com/kufu/activerecord-bitemporal/pull/236)
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+- [Localize patch for AR::Relation#primary_key in Rails 8.0+ #243](https://github.com/kufu/activerecord-bitemporal/pull/243)
+  - In Rails 8.0+, the global override of `ActiveRecord::Relation#primary_key` with `bitemporal_id_key` has been removed. As a result, the following methods now use `primary_key` (i.e., `id`) instead of `bitemporal_id_key`:
+    - `find_each`, `find_in_batches`, and `in_batches`: the default cursor column for ordering and keyset pagination changes (records are not missed or duplicated, but iteration order differs)
+- [Fix finder methods ordering on Rails 8.0+ #237](https://github.com/kufu/activerecord-bitemporal/pull/237)
+
+### Chores
+
+- [Manage development dependencies in gemfiles #240](https://github.com/kufu/activerecord-bitemporal/pull/240)
+- [Randomize test execution order #239](https://github.com/kufu/activerecord-bitemporal/pull/239)
+- [Update release GitHub Action #232](https://github.com/kufu/activerecord-bitemporal/pull/232)
+- [Bump ruby/setup-ruby from 1.286.0 to 1.288.0 #244](https://github.com/kufu/activerecord-bitemporal/pull/244)
+- [Bump actions/checkout from 6.0.1 to 6.0.2 #242](https://github.com/kufu/activerecord-bitemporal/pull/242)
+- [Bump ruby/setup-ruby from 1.278.0 to 1.286.0 #241](https://github.com/kufu/activerecord-bitemporal/pull/241)
+- [Bump ruby/setup-ruby from 1.268.0 to 1.278.0 #234](https://github.com/kufu/activerecord-bitemporal/pull/234)
+- [Update reviewers #231](https://github.com/kufu/activerecord-bitemporal/pull/231)
+- [Bump actions/checkout from 6.0.0 to 6.0.1 #229](https://github.com/kufu/activerecord-bitemporal/pull/229)
+- [Bump ruby/setup-ruby from 1.267.0 to 1.268.0 #228](https://github.com/kufu/activerecord-bitemporal/pull/228)
+- [Bump actions/checkout from 5.0.0 to 6.0.0 #227](https://github.com/kufu/activerecord-bitemporal/pull/227)
+- [Bump codespell-project/actions-codespell from 2.1 to 2.2 #226](https://github.com/kufu/activerecord-bitemporal/pull/226)
+- [Bump ruby/setup-ruby from 1.265.0 to 1.267.0 #225](https://github.com/kufu/activerecord-bitemporal/pull/225)
+
 ## 6.1.0
 
-### Breaking Changed
+### Breaking Changes
 
 ### Added
 
@@ -39,7 +118,7 @@
 
 ## 6.0.0
 
-### Breaking Changed
+### Breaking Changes
 
 - [Add Ruby 3.4 and remove Ruby 3.0 in CI #185](https://github.com/kufu/activerecord-bitemporal/pull/185)
 - [Drop support Rails 6.1 #192](https://github.com/kufu/activerecord-bitemporal/pull/192)
@@ -147,7 +226,7 @@
 
 ## 5.0.0
 
-### Breaking Changed
+### Breaking Changes
 
 - [CI against Ruby 3.2, 3.3, Drop Ruby 2.7 and Rails 6.0 #150](https://github.com/kufu/activerecord-bitemporal/pull/150)
 
@@ -228,7 +307,7 @@
 
 ## 4.0.0
 
-### Breaking Changed
+### Breaking Changes
 
 - [[proposal]When bitemporal_at exists inside the nest, the specified date was not prioritized, so the date of the inner bitemporal_at is now prioritized. #121](https://github.com/kufu/activerecord-bitemporal/pull/121)
 - [Drop support Rails 5.2 #122](https://github.com/kufu/activerecord-bitemporal/pull/122)
@@ -283,7 +362,7 @@
 
 ## 3.0.0
 
-### Breaking Changed
+### Breaking Changes
 - [Assign updated bitemporal times to the receiver after update/destroy](https://github.com/kufu/activerecord-bitemporal/pull/118)
 
 ### Added
@@ -298,7 +377,7 @@
 
 ## 2.3.0
 
-### Breaking Changed
+### Breaking Changes
 
 ### Added
 - [Add `InstanceMethods#swapped_id_previously_was`](https://github.com/kufu/activerecord-bitemporal/pull/114)
@@ -313,7 +392,7 @@
 
 ## 2.2.0
 
-### Breaking Changed
+### Breaking Changes
 
 ### Added
 - [replace postgres docker image](https://github.com/kufu/activerecord-bitemporal/pull/103)
@@ -330,7 +409,7 @@
 
 ## 2.1.0
 
-### Breaking Changed
+### Breaking Changes
 
 ### Added
 - [Update valid_to after #update](https://github.com/kufu/activerecord-bitemporal/pull/105)
@@ -347,7 +426,7 @@
 
 ## 2.0.0
 
-### Breaking Changed
+### Breaking Changes
 - [[Proposal] Changed valid_in to exclude valid_from = to and valid_to = from. by osyo-manga · Pull Request #95](https://github.com/kufu/activerecord-bitemporal/pull/95)
 
 ### Added

data/README.md

@@ -6,6 +6,12 @@ ActiveRecord::Bitemporal
 [![gem-download](https://img.shields.io/gem/dt/activerecord-bitemporal.svg)](https://rubygems.org/gems/activerecord-bitemporal)
 [![CircleCI](https://circleci.com/gh/kufu/activerecord-bitemporal.svg?style=svg)](https://circleci.com/gh/kufu/activerecord-bitemporal)
 
+## Requirements
+
+- Ruby 3.1+
+- Rails 7.1, 7.2, 8.0, or 8.1
+- PostgreSQL
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/activerecord-bitemporal/bitemporal.rb

@@ -112,15 +112,36 @@ module ActiveRecord
     end
 
     module Relation
-      module Finder
-        def find(*ids)
-          return super if block_given?
-          all.spawn.yield_self { |obj|
-            def obj.primary_key
-              "bitemporal_id"
+      module BitemporalIdAsPrimaryKey # :nodoc:
+        private
+
+        # Generate a method that temporarily changes the primary key to
+        # bitemporal_id for localizing the effect of the change to only the
+        # method specified by `name`.
+        #
+        # DO NOT use this method outside of this module.
+        def use_bitemporal_id_as_primary_key(name) # :nodoc:
+          module_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def #{name}(...)
+              all.spawn.yield_self { |relation|
+                def relation.primary_key
+                  bitemporal_id_key
+                end
+                relation.method(:#{name}).super_method.call(...)
+              }
             end
-            obj.method(:find).super_method.call(*ids)
-          }
+          RUBY
+        end
+      end
+      extend BitemporalIdAsPrimaryKey
+
+      module Finder
+        extend BitemporalIdAsPrimaryKey
+
+        use_bitemporal_id_as_primary_key :find
+
+        if ActiveRecord.version >= Gem::Version.new("8.0.0")
+          use_bitemporal_id_as_primary_key :exists?
         end
 
         def find_at_time!(datetime, *ids)
@@ -136,6 +157,23 @@ module ActiveRecord
       end
       include Finder
 
+      if ActiveRecord.version >= Gem::Version.new("8.0.0")
+        use_bitemporal_id_as_primary_key :ids
+
+        # Ensure that AR::Batches
+        # (https://github.com/rails/rails/blob/v8.0.5/activerecord/lib/active_record/relation/batches.rb)
+        # works with `bitemporal_id` as the primary key in Rails 8+.
+        use_bitemporal_id_as_primary_key :find_each
+        use_bitemporal_id_as_primary_key :find_in_batches
+        use_bitemporal_id_as_primary_key :in_batches
+
+        # Ensure that `#excluding` and `#without`
+        # (https://github.com/rails/rails/blob/v8.0.5/activerecord/lib/active_record/relation/query_methods.rb#L1548-L1591)
+        # work with `bitemporal_id` as the primary key in Rails 8+.
+        use_bitemporal_id_as_primary_key :excluding
+        use_bitemporal_id_as_primary_key :without
+      end
+
       def build_arel(*)
         ActiveRecord::Bitemporal.with_bitemporal_option(**bitemporal_option) {
           super
@@ -168,8 +206,12 @@ module ActiveRecord
         end
       end
 
-      def primary_key
-        bitemporal_id_key
+      # Use original primary_key for Active Record 8.0+ as much as possible
+      # to avoid issues with patching primary_key of AR::Relation globally.
+      if ActiveRecord.version < Gem::Version.new("8.0.0")
+        def primary_key
+          bitemporal_id_key
+        end
       end
     end
 
@@ -385,16 +427,14 @@ module ActiveRecord
         false
       end
 
-      if Gem::Version.new("7.1.0") <= ActiveRecord.version
-        # MEMO: Since Rails 7.1 #_find_record refers to a record with find_by!(@primary_key => id)
-        #       But if @primary_key is "id", it can't refer to the intended record, so we hack it to refer to the record based on self.class.bitemporal_id_key
-        #       see: https://github.com/rails/rails/blob/v7.1.0/activerecord/lib/active_record/persistence.rb#L1152-#L1171
-        def _find_record(*)
-          tmp_primary_key, @primary_key = @primary_key, self.class.bitemporal_id_key
-          super
-        ensure
-          @primary_key = tmp_primary_key
-        end
+      # MEMO: Since Rails 7.1 #_find_record refers to a record with find_by!(@primary_key => id)
+      #       But if @primary_key is "id", it can't refer to the intended record, so we hack it to refer to the record based on self.class.bitemporal_id_key
+      #       see: https://github.com/rails/rails/blob/v7.1.0/activerecord/lib/active_record/persistence.rb#L1152-#L1171
+      def _find_record(*)
+        tmp_primary_key, @primary_key = @primary_key, self.class.bitemporal_id_key
+        super
+      ensure
+        @primary_key = tmp_primary_key
       end
 
       module ::ActiveRecord::Persistence

data/lib/activerecord-bitemporal/bitemporalize.rb

@@ -128,6 +128,15 @@ module ActiveRecord::Bitemporal::Bitemporalize
     attribute :transaction_from, default: ActiveRecord::Bitemporal::DEFAULT_TRANSACTION_FROM
     attribute :transaction_to, default: ActiveRecord::Bitemporal::DEFAULT_TRANSACTION_TO
 
+    # Rails 8 support: ensure finder methods (.first, .last, etc.) use bitemporal_id ordering.
+    # Rails 8.0 changed _order_columns to use model.primary_key instead of Relation's primary_key.
+    # The nil-terminated format (Rails 8.1 feature, PR #54679) prevents automatic primary_key
+    # appending to the ORDER BY clause.
+    # See: https://github.com/rails/rails/pull/54679
+    if ActiveRecord.gem_version >= Gem::Version.new("8.0.0")
+      self.implicit_order_column ||= [bitemporal_id_key, nil]
+    end
+
     # Callback hook to `validates :xxx, uniqueness: true`
     const_set(:UniquenessValidator, Class.new(ActiveRecord::Validations::UniquenessValidator) {
       prepend ActiveRecord::Bitemporal::Uniqueness

data/lib/activerecord-bitemporal/scope.rb

@@ -160,7 +160,13 @@ module ActiveRecord::Bitemporal
     # @see https://github.com/rails/rails/blob/v7.1.3.4/activerecord/lib/active_record/relation/delegation.rb#L117
     delegate :bitemporal_value, :bitemporal_value=, :valid_datetime, :valid_date,
              :transaction_datetime, :bitemporal_option, :bitemporal_option_merge!,
-             :build_arel, :primary_key, to: :scope
+             :build_arel, to: :scope
+
+    if ActiveRecord.version < Gem::Version.new("8.0.0")
+      delegate :primary_key, to: :scope
+    else
+      delegate :ids, :exists?, to: :scope
+    end
   end
 
   module Scope

data/lib/activerecord-bitemporal/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module Bitemporal
-    VERSION = "6.1.0"
+    VERSION = "7.0.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-bitemporal
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 7.0.1
 platform: ruby
 authors:
 - SmartHR
@@ -15,140 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: globalid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
 description: Enable ActiveRecord models to be handled as BiTemporal Data Model.
 email:
 - oss@smarthr.co.jp
@@ -188,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: BiTemporal Data Model for ActiveRecord
 test_files: []