activerecord-bitemporal 5.1.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682d7ade7951759a2237d6395aab4dccc06d5c5ea6d1820b20e1bd1301d2efc7
-  data.tar.gz: a58bb4c8b01a5f7724ad367ab69e45a54f715b96a0d789e7690689798d0f0a88
+  metadata.gz: c660ad9554b7d5285a28f3efcd6a6c10e2b5e45b6922956e37f931ae807ba483
+  data.tar.gz: 24646d6dc75344e11f613f70c7847639f8c86524ce3d1b178f4abb69dc60694f
 SHA512:
-  metadata.gz: a1761e5e97fc83beac29d7e23edec2ab5bb4d02958b5a7600073b099ca800a6ad3ffa3f8f9bc423aafb412c4c11a2bb1cb03d09d4fd36b6d77e7dd02560a9493
-  data.tar.gz: efc543c3eb6b2ab89d3556eb25f342983d8e5854ebbec77ee6cf853c01dd0ccd64945264c53f30bacb9d370a6083ba65b3791e88b26c0c5c4ecea4481ad66e0c
+  metadata.gz: 39e0aea4e39482bcb929d0df586232413193f57a232ca7b2b928ca9aaef90d84fa88fc1edb925bcbff466864314beafa69e9caf36057ba7f4529019791d33698
+  data.tar.gz: 84bc4e20042ffb77c2f317fcf6ce85b1b469edb338ec0a1346a9dd0008d1b01e49037503124778144521704ed97af904632bf91f424acc41448968d4beba0a5b

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/release.yml

@@ -19,7 +19,7 @@ jobs:
       GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
       GEM_HOST_OTP_CODE: ${{ github.event.inputs.rubygems-otp-code }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
           fetch-depth: 0
 

data/.github/workflows/test.yml

@@ -0,0 +1,54 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+
+name: Test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+        gemfile:
+          - rails_6.1
+          - rails_7.0
+          - rails_7.1
+        exclude:
+          - ruby-version: '3.2'
+            gemfile: rails_6.1
+          - ruby-version: '3.3'
+            gemfile: rails_6.1
+    services:
+      postgres:
+        image: postgres:14
+        env:
+          POSTGRES_PASSWORD: postgres
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/Appraisals

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-appraise "rails-main" do
-  gem "rails", git: 'https://github.com/rails/rails.git', branch: "main"
-end
-
 appraise "rails-6.1" do
   gem "rails", "~> 6.1.0"
 end

data/CHANGELOG.md

@@ -1,5 +1,51 @@
 # Changelog
 
+## 5.3.0
+
+### Added
+
+### Changed
+
+- [Replace `default` overrides from `load_schema!` to `attribute` #172](https://github.com/kufu/activerecord-bitemporal/pull/172)
+- [`Or` node changed to `Nary` in Rails 7.2 #173](https://github.com/kufu/activerecord-bitemporal/pull/173)
+- [Exclude record valid range end in uniqueness validation #184](https://github.com/kufu/activerecord-bitemporal/pull/184)
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Chores
+
+- [Add specs under specific conditions #171](https://github.com/kufu/activerecord-bitemporal/pull/171)
+- [Add Dependabot for GitHub Actions #174](https://github.com/kufu/activerecord-bitemporal/pull/174)
+- [Bump actions/checkout from 3 to 4 #175](https://github.com/kufu/activerecord-bitemporal/pull/175)
+- [Replace CircleCI with GitHub Actions #177](https://github.com/kufu/activerecord-bitemporal/pull/177)
+- [Update README as `within_deleted` and `without_deleted` are deprecated #178](https://github.com/kufu/activerecord-bitemporal/pull/178)
+- [Fix typo #181](https://github.com/kufu/activerecord-bitemporal/pull/181)
+- [Fix #force_update block comment #183](https://github.com/kufu/activerecord-bitemporal/pull/183)
+- [Support Docker Compose V2 #186](https://github.com/kufu/activerecord-bitemporal/pull/186)
+
+## 5.2.0
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+- [Delegate CollectionProxy#bitemporal_value to Relation #168](https://github.com/kufu/activerecord-bitemporal/pull/168)
+- [Fix unintended valid_datetime set when `CollectionProxy#load` #169](https://github.com/kufu/activerecord-bitemporal/pull/169)
+
+### Chores
+
+- [Do not run CI against rails_main #166](https://github.com/kufu/activerecord-bitemporal/pull/166)
+
 ## 5.1.0
 
 ### Added

data/README.md

@@ -317,7 +317,7 @@ Timecop.freeze("2019/1/10") {
 }
 
 Timecop.freeze("2019/1/20") {
-  # #force_update のでは自身を受け取る
+  # #force_update のブロック内で自身を受け取る
   # このブロック内であれば履歴を生成せずにレコードの変更が行われる
   employee.force_update { |employee|
     employee.update(name: "Tom")
@@ -415,7 +415,7 @@ BTDM では DB からレコードを参照する場合、暗黙的に
 Timecop.freeze("2019/1/20") {
   # 現在の時間の履歴を返すために暗黙的に時間指定や論理削除されたレコードが除かれる
   puts Employee.all.to_sql
-  # => SELECT "employees".* FROM "employees" WHERE "employees"."valid_from" <= '2019-01-20 00:00:00' AND "employees"."valid_to" > '2019-01-20 00:00:00' AND "employees"."transaction_to" = '9999-12-31 00:00:00'
+  # => SELECT "employees".* FROM "employees" WHERE "employees"."valid_from" <= '2019-01-20 00:00:00' AND "employees"."valid_to" > '2019-01-20 00:00:00' AND "employees"."transaction_from" <= '2019-01-20 00:00:00' AND "employees"."transaction_to" > '2019-01-20 00:00:00'
 }
 ```
 
@@ -454,7 +454,7 @@ Timecop.freeze("2019/1/20") {
 
   # なぜなら暗黙的に時間指定のクエリが追加されている為
   puts Employee.where(name: "Jane").to_sql
-  # => SELECT "employees".* FROM "employees" WHERE "employees"."valid_from" <= '2019-01-20 00:00:00' AND "employees"."valid_to" > '2019-01-20 00:00:00' AND "employees"."transaction_to" = '9999-12-31 00:00:00' AND "employees"."name" = 'Jane'
+  # => SELECT "employees".* FROM "employees" WHERE "employees"."valid_from" <= '2019-01-20 00:00:00' AND "employees"."valid_to" > '2019-01-20 00:00:00' AND "employees"."transaction_from" <= '2019-01-20 00:00:00' AND "employees"."transaction_to" > '2019-01-20 00:00:00' AND "employees"."name" = 'Jane'
 }
 ```
 
@@ -464,7 +464,7 @@ Timecop.freeze("2019/1/20") {
 ```ruby
 # default_scope であれば unscoped で無効化することが出来るが、BTDM のデフォルトクエリはそのまま
 puts Employee.unscoped { Employee.all.to_sql }
-# => SELECT "employees".* FROM "employees" WHERE "employees"."valid_from" <= '2019-10-25 07:56:06.731259' AND "employees"."valid_to" > '2019-10-25 07:56:06.731259' AND "employees"."transaction_to" = '9999-12-31 00:00:00'
+# => SELECT "employees".* FROM "employees" WHERE "employees"."valid_from" <= '2019-10-25 07:56:06.731259' AND "employees"."valid_to" > '2019-10-25 07:56:06.731259' AND "employees"."transaction_from" <= '2019-10-25 07:56:06.731259' AND "employees"."transaction_to" > '2019-10-25 07:56:06.731259'
 ```
 
 
@@ -475,21 +475,21 @@ puts Employee.unscoped { Employee.all.to_sql }
 | スコープ | 動作 |
 | --- | --- |
 | `.ignore_valid_datetime` | 時間指定を無視する |
-| `.within_deleted` | 論理削除されているレコードを含める |
-| `.without_deleted` | 論理削除されているレコードを含めない |
+| `.ignore_transaction_datetime` | 論理削除されているレコードを含める |
+| `.ignore_bitemporal_datetime` | 全てのレコードを対象とする |
 
 ```ruby
 Timecop.freeze("2019/1/20") {
   # 時間指定をしているクエリを取り除く
   puts Employee.ignore_valid_datetime.to_sql
-  # => SELECT "employees".* FROM "employees" WHERE "employees"."transaction_to" = '9999-12-31 00:00:00'
+  # => SELECT "employees".* FROM "employees" WHERE "employees"."transaction_from" <= '2019-01-20 00:00:00' AND "employees"."transaction_to" > '2019-01-20 00:00:00'
 
   # 論理削除しているレコードも含める
-  puts Employee.within_deleted.to_sql
+  puts Employee.ignore_transaction_datetime.to_sql
   # => SELECT "employees".* FROM "employees" WHERE "employees"."valid_from" <= '2019-01-20 00:00:00' AND "employees"."valid_to" > '2019-01-20 00:00:00'
 
   # 全てのレコードを対象とする
-  puts Employee.ignore_valid_datetime.within_deleted.to_sql
+  puts Employee.ignore_bitemporal_datetime.to_sql
   # => SELECT "employees".* FROM "employees"
 }
 ```
@@ -534,7 +534,7 @@ Timecop.freeze("2019/1/15") {
 Timecop.freeze("2019/1/20") {
   # valid_at で任意の時間を参照して検索する事が出来る
   puts Employee.valid_at("2019/1/10").to_sql
-  # => SELECT "employees".* FROM "employees" WHERE "employees"."valid_from" <= '2019-01-10 00:00:00' AND "employees"."valid_to" > '2019-01-10 00:00:00' AND "employees"."transaction_to" = '9999-12-31 00:00:00'
+  # => SELECT "employees".* FROM "employees" WHERE "employees"."valid_from" <= '2019-01-10 00:00:00' AND "employees"."valid_to" > '2019-01-10 00:00:00' AND "employees"."transaction_from" <= '2019-01-20 00:00:00' AND "employees"."transaction_to" > '2019-01-20 00:00:00'
 
   pp Employee.valid_at("2019/1/10").map(&:name)
   # => ["Jane"]
@@ -696,7 +696,7 @@ BTDM では `find_by(id: xxx)` や `where(id: xxx)` を行う場合 `id` では
 Employee.find_by(id: employee.id)
 
 # OK : bitemporal_id で検索を行う
-# MEMO: id = bitemporal_id なの
+# MEMO: id = bitemporal_id なので
 #       find_by(bitemporal_id: employee.id)
 #       でも動作するが employee.bitemporal_id と書いたほうが意図が伝わりやすい
 Employee.find_by(bitemporal_id: employee.bitemporal_id)

data/{docker-compose.yml → compose.yml}

@@ -1,4 +1,3 @@
-version: '2.1'
 services:
   db:
     image: postgres:latest

data/lib/activerecord-bitemporal/bitemporal.rb

@@ -595,8 +595,8 @@ module ActiveRecord
           # レコードを更新する時に valid_datetime が valid_from ~ valid_to の範囲外だった場合、
           #   一番近い未来の履歴レコードを参照して更新する
           # という仕様があるため、それを考慮して valid_to を設定する
-          if (record_valid_time && (record.valid_from..record.valid_to).cover?(record_valid_time)) == false && (record.persisted?)
-            finder_class.ignore_valid_datetime.where(bitemporal_id: record.bitemporal_id).valid_from_gt(target_datetime).order(valid_from: :asc).first.valid_from
+          if (record_valid_time && (record.valid_from...record.valid_to).cover?(record_valid_time)) == false && (record.persisted?)
+            finder_class.ignore_valid_datetime.where(bitemporal_id: record.bitemporal_id).valid_from_gteq(target_datetime).order(valid_from: :asc).first.valid_from
           else
             valid_to
           end

data/lib/activerecord-bitemporal/scope.rb

@@ -27,6 +27,10 @@ module ActiveRecord::Bitemporal
   end
 
   module Relation
+    # see: https://github.com/rails/rails/pull/51492
+    NARY_NODE = ActiveRecord.gem_version >= Gem::Version.new("7.2.0") ? Arel::Nodes::Nary : Arel::Nodes::And
+    private_constant :NARY_NODE
+
     using Module.new {
       refine ActiveRecord::Relation::WhereClause do
         using Module.new {
@@ -56,7 +60,7 @@ module ActiveRecord::Bitemporal
                 case node
                 when Arel::Nodes::LessThan, Arel::Nodes::LessThanOrEqual, Arel::Nodes::GreaterThan, Arel::Nodes::GreaterThanOrEqual
                   y << node if node && node.left.respond_to?(:relation)
-                when Arel::Nodes::And
+                when NARY_NODE
                   each_operatable_node(node.children) { |node| y << node }
                 when Arel::Nodes::Binary
                   each_operatable_node(node.left) { |node| y << node }
@@ -141,6 +145,22 @@ module ActiveRecord::Bitemporal
     end
   end
 
+  module CollectionProxy
+    # Delegate to ActiveRecord::Bitemporal::Relation
+    # @see https://github.com/rails/rails/blob/v7.1.3.4/activerecord/lib/active_record/associations/collection_proxy.rb#L1115-L1124
+    #
+    # In order to update the CollectionProxy state, `load` needs to be excluded.
+    # The reason for using `@association` instead of delegating this method is to preserve state such as `loaded`.
+    # @see https://github.com/rails/rails/blob/v7.1.3.4/activerecord/lib/active_record/associations/collection_proxy.rb#L44
+    #
+    # There is no need to delegate to `scope` as `ActiveRecord::Bitemporal::Relation::Finder`'s methods are delegated
+    # by `ActiveRecord::Delegation`. This is not a problem because `scoping` used in this is delegated to `scope`.
+    # @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
+  end
+
   module Scope
     extend ActiveSupport::Concern
 

data/lib/activerecord-bitemporal/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module Bitemporal
-    VERSION = "5.1.0"
+    VERSION = "5.3.0"
   end
 end

data/lib/activerecord-bitemporal.rb

@@ -29,7 +29,6 @@ module ActiveRecord::Bitemporal::Bitemporalize
         def prepend_relation_delegate_class(mod)
           relation_delegate_class(ActiveRecord::Relation).prepend mod
           relation_delegate_class(ActiveRecord::AssociationRelation).prepend mod
-          relation_delegate_class(ActiveRecord::Associations::CollectionProxy).prepend mod
         end
       end
     end
@@ -38,13 +37,6 @@ module ActiveRecord::Bitemporal::Bitemporalize
   module ClassMethods
     include ActiveRecord::Bitemporal::Relation::Finder
 
-    DEFAULT_ATTRIBUTES = {
-      valid_from:       ActiveRecord::Bitemporal::DEFAULT_VALID_FROM,
-      valid_to:         ActiveRecord::Bitemporal::DEFAULT_VALID_TO,
-      transaction_from: ActiveRecord::Bitemporal::DEFAULT_TRANSACTION_FROM,
-      transaction_to:   ActiveRecord::Bitemporal::DEFAULT_TRANSACTION_TO
-    }.freeze
-
     def bitemporal_id_key
       'bitemporal_id'
     end
@@ -58,20 +50,11 @@ module ActiveRecord::Bitemporal::Bitemporalize
     def inherited(klass)
       super
       klass.prepend_relation_delegate_class ActiveRecord::Bitemporal::Relation
+      klass.relation_delegate_class(ActiveRecord::Associations::CollectionProxy).prepend ActiveRecord::Bitemporal::CollectionProxy
       if relation_delegate_class(ActiveRecord::Relation).ancestors.include? ActiveRecord::Bitemporal::Relation::MergeWithExceptBitemporalDefaultScope
         klass.relation_delegate_class(ActiveRecord::Relation).prepend ActiveRecord::Bitemporal::Relation::MergeWithExceptBitemporalDefaultScope
       end
     end
-
-  private
-    def load_schema!
-      super
-
-      DEFAULT_ATTRIBUTES.each do |name, default_value|
-        type = type_for_attribute(name)
-        define_attribute(name.to_s, type, default: default_value)
-      end
-    end
   end
 
   module InstanceMethods
@@ -153,6 +136,11 @@ module ActiveRecord::Bitemporal::Bitemporalize
       @previously_force_updated = false
     end
 
+    attribute :valid_from, default: ActiveRecord::Bitemporal::DEFAULT_VALID_FROM
+    attribute :valid_to, default: ActiveRecord::Bitemporal::DEFAULT_VALID_TO
+    attribute :transaction_from, default: ActiveRecord::Bitemporal::DEFAULT_TRANSACTION_FROM
+    attribute :transaction_to, default: ActiveRecord::Bitemporal::DEFAULT_TRANSACTION_TO
+
     # Callback hook to `validates :xxx, uniqueness: true`
     const_set(:UniquenessValidator, Class.new(ActiveRecord::Validations::UniquenessValidator) {
       prepend ActiveRecord::Bitemporal::Uniqueness
@@ -169,6 +157,7 @@ module ActiveRecord::Bitemporal::Bitemporalize
     validates bitemporal_id_key, uniqueness: true, allow_nil: true, strict: enable_strict_by_validates_bitemporal_id
 
     prepend_relation_delegate_class ActiveRecord::Bitemporal::Relation
+    relation_delegate_class(ActiveRecord::Associations::CollectionProxy).prepend ActiveRecord::Bitemporal::CollectionProxy
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-bitemporal
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.3.0
 platform: ruby
 authors:
 - SmartHR
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-05 00:00:00.000000000 Z
+date: 2025-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -129,9 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".github/auto_assign.yml"
+- ".github/dependabot.yml"
 - ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - Appraisals
 - CHANGELOG.md
@@ -144,11 +145,10 @@ files:
 - activerecord-bitemporal.gemspec
 - bin/console
 - bin/setup
-- docker-compose.yml
+- compose.yml
 - gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.0.gemfile
 - gemfiles/rails_7.1.gemfile
-- gemfiles/rails_main.gemfile
 - lib/activerecord-bitemporal.rb
 - lib/activerecord-bitemporal/bitemporal.rb
 - lib/activerecord-bitemporal/callbacks.rb

data/.circleci/config.yml

@@ -1,41 +0,0 @@
-version: 2.1
-
-jobs:
-  rspec:
-    parameters:
-      ruby-version:
-        type: string
-      gemfile:
-        type: string
-    docker:
-      - image: ruby:<< parameters.ruby-version >>
-        environment:
-          BUNDLE_GEMFILE: gemfiles/<< parameters.gemfile >>.gemfile
-      - image: cimg/postgres:11.16
-    steps:
-      - checkout
-      - run: gem install bundler
-      - run: bundle install
-      - run: bundle exec rspec
-
-workflows:
-  test:
-    jobs:
-      - rspec:
-          matrix:
-            parameters:
-              ruby-version:
-                - '3.0'
-                - '3.1'
-                - '3.2'
-                - '3.3'
-              gemfile:
-                - rails_6.1
-                - rails_7.0
-                - rails_7.1
-                - rails_main
-            exclude:
-              - ruby-version: '3.2'
-                gemfile: rails_6.1
-              - ruby-version: '3.3'
-                gemfile: rails_6.1

data/gemfiles/rails_main.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-gem "rails", git: "https://github.com/rails/rails.git", branch: "main"
-
-gemspec path: "../"