chrono_model 1.2.2 → 2.0.0

data/lib/chrono_model/time_machine.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'chrono_model/time_machine/time_query'
 require 'chrono_model/time_machine/timeline'
 require 'chrono_model/time_machine/history_model'
 
 module ChronoModel
-
   module TimeMachine
     include ChronoModel::Patches::AsOfTimeHolder
 
@@ -11,20 +12,50 @@ module ChronoModel
 
     included do
       if table_exists? && !chrono?
-        puts  "ChronoModel: #{table_name} is not a temporal table. " \
-          "Please use `change_table :#{table_name}, temporal: true` in a migration."
+        logger.warn <<-MSG.squish
+          ChronoModel: #{table_name} is not a temporal table.
+          Please use `change_table :#{table_name}, temporal: true` in a migration.
+        MSG
       end
 
       history = ChronoModel::TimeMachine.define_history_model_for(self)
       ChronoModel.history_models[table_name] = history
 
       class << self
-        alias_method :direct_descendants_with_history, :direct_descendants
-        def direct_descendants
-          direct_descendants_with_history.reject(&:history?)
+        if Rails.version >= '7.0'
+          def subclasses(with_history: false)
+            subclasses = super()
+            subclasses.reject!(&:history?) unless with_history
+            subclasses
+          end
+
+          def subclasses_with_history
+            subclasses(with_history: true)
+          end
+
+          # `direct_descendants` is deprecated method in 7.0 and has been
+          # removed in 7.1
+          if method_defined?(:direct_descendants)
+            alias_method :direct_descendants_with_history, :subclasses_with_history
+            alias_method :direct_descendants, :subclasses
+          end
+
+          # Ruby 3.1 has a native subclasses method and descendants is
+          # implemented with recursion of subclasses
+          if Class.method_defined?(:subclasses)
+            def descendants_with_history
+              subclasses_with_history.concat(subclasses.flat_map(&:descendants_with_history))
+            end
+          end
+        else
+          alias_method :descendants_with_history, :descendants
+
+          alias_method :direct_descendants_with_history, :direct_descendants
+          def direct_descendants
+            direct_descendants_with_history.reject(&:history?)
+          end
         end
 
-        alias_method :descendants_with_history, :descendants
         def descendants
           descendants_with_history.reject(&:history?)
         end
@@ -43,9 +74,9 @@ module ChronoModel
           # Sadly, we can't avoid it by calling +.history?+, because in the
           # subclass the HistoryModel hasn't been included yet.
           #
-          unless subclass.name.nil?
-            ChronoModel::TimeMachine.define_history_model_for(subclass)
-          end
+          return if subclass.name.nil?
+
+          ChronoModel::TimeMachine.define_history_model_for(subclass)
         end
       end
     end
@@ -71,21 +102,23 @@ module ChronoModel
 
       # Returns an ActiveRecord::Relation on the history of this model as
       # it was +time+ ago.
-      def as_of(time)
-        history.as_of(time)
-      end
+      delegate :as_of, to: :history
 
       def attribute_names_for_history_changes
         @attribute_names_for_history_changes ||= attribute_names -
-          %w( id hid validity recorded_at )
+                                                 %w[id hid validity recorded_at]
       end
 
       def has_timeline(options)
         changes = options.delete(:changes)
         assocs  = history.has_timeline(options)
 
-        attributes = changes.present? ?
-          Array.wrap(changes) : assocs.map(&:name)
+        attributes =
+          if changes.present?
+            Array.wrap(changes)
+          else
+            assocs.map(&:name)
+          end
 
         attribute_names_for_history_changes.concat(attributes.map(&:to_s))
       end
@@ -112,7 +145,7 @@ module ChronoModel
     # reasons, to avoid a `rescue` (@lleirborras).
     #
     def _as_of(time)
-      self.class.as_of(time).where(id: self.id)
+      self.class.as_of(time).where(id: id)
     end
     protected :_as_of
 
@@ -132,13 +165,14 @@ module ChronoModel
     # Returns a boolean indicating whether this record is an history entry.
     #
     def historical?
-      self.as_of_time.present?
+      as_of_time.present?
     end
 
     # Inhibit destroy of historical records
     #
     def destroy
       raise ActiveRecord::ReadOnlyRecord, 'Cannot delete historical records' if historical?
+
       super
     end
 
@@ -147,7 +181,7 @@ module ChronoModel
     #
     def pred(options = {})
       if self.class.timeline_associations.empty?
-        history.order(Arel.sql('upper(validity) DESC')).offset(1).first
+        history.reverse_order.second
       else
         return nil unless (ts = pred_timestamp(options))
 
@@ -178,7 +212,11 @@ module ChronoModel
     # Returns the current history version
     #
     def current_version
-      self.historical? ? self.class.find(self.id) : self
+      if historical?
+        self.class.find(id)
+      else
+        self
+      end
     end
 
     # Returns the differences between this entry and the previous history one.
@@ -196,17 +234,20 @@ module ChronoModel
     #
     def changes_against(ref)
       self.class.attribute_names_for_history_changes.inject({}) do |changes, attr|
-        old, new = ref.public_send(attr), self.public_send(attr)
+        old = ref.public_send(attr)
+        new = public_send(attr)
 
         changes.tap do |c|
-          changed = old.respond_to?(:history_eql?) ?
-            !old.history_eql?(new) : old != new
+          changed =
+            if old.respond_to?(:history_eql?)
+              !old.history_eql?(new)
+            else
+              old != new
+            end
 
           c[attr] = [old, new] if changed
         end
       end
     end
-
   end
-
 end

data/lib/chrono_model/utilities.rb

@@ -1,5 +1,6 @@
-module ChronoModel
+# frozen_string_literal: true
 
+module ChronoModel
   module Utilities
     # Amends the given history item setting a different period.
     # Useful when migrating from legacy systems.
@@ -11,7 +12,7 @@ module ChronoModel
     #   end
     #
     def amend_period!(hid, from, to)
-      unless [from, to].any? {|ts| ts.respond_to?(:zone) && ts.zone == 'UTC'}
+      unless [from, to].any? { |ts| ts.respond_to?(:zone) && ts.zone == 'UTC' }
         raise 'Can amend history only with UTC timestamps'
       end
 
@@ -23,5 +24,4 @@ module ChronoModel
       ]
     end
   end
-
 end

data/lib/chrono_model/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ChronoModel
-  VERSION = "1.2.2"
+  VERSION = '2.0.0'
 end

data/lib/chrono_model.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
+require 'chrono_model/chrono'
 require 'chrono_model/conversions'
 require 'chrono_model/patches'
 require 'chrono_model/adapter'
@@ -7,8 +10,11 @@ require 'chrono_model/time_machine'
 require 'chrono_model/time_gate'
 require 'chrono_model/version'
 
+require 'chrono_model/railtie' if defined?(Rails::Railtie)
+require 'chrono_model/db_console' if defined?(Rails::DBConsole) && Rails.version < '7.1'
+
 module ChronoModel
-  class Error < ActiveRecord::ActiveRecordError #:nodoc:
+  class Error < ActiveRecord::ActiveRecordError # :nodoc:
   end
 
   # Performs structure upgrade.
@@ -17,7 +23,7 @@ module ChronoModel
     connection = ActiveRecord::Base.connection
 
     unless connection.is_a?(ChronoModel::Adapter)
-      raise ChronoModel::Error, "This database connection is not a ChronoModel::Adapter"
+      raise ChronoModel::Error, 'This database connection is not a ChronoModel::Adapter'
     end
 
     connection.chrono_upgrade!
@@ -27,49 +33,38 @@ module ChronoModel
   # Computed upon inclusion of the +TimeMachine+ module.
   #
   def self.history_models
-    @_history_models||= {}
+    @_history_models ||= {}
   end
 end
 
-if defined?(Rails)
-  require 'chrono_model/railtie'
-end
+ActiveSupport.on_load :active_record do
+  extend ChronoModel::Chrono
 
-ActiveRecord::Base.instance_eval do
-  # Checks whether this Active Recoed model is backed by a temporal table
-  #
-  def chrono?
-    connection.is_chrono?(table_name)
-  end
-end
+  # Hooks into Association#scope to pass the As-Of time automatically
+  # to methods that load associated ChronoModel records.
+  ActiveRecord::Associations::Association.prepend ChronoModel::Patches::Association
 
-# Hooks into Association#scope to pass the As-Of time automatically
-# to methods that load associated ChronoModel records.
-#
-ActiveRecord::Associations::Association.instance_eval do
-  prepend ChronoModel::Patches::Association
-end
+  # Hooks into Relation#build_arel to use `:joins` on your ChronoModels
+  # and join data from associated records As-Of time.
+  ActiveRecord::Relation.prepend ChronoModel::Patches::Relation
 
-# Hooks into Relation#build_arel to use :joins on your ChronoModels
-# and join data from associated records As-Of time.
-#
-ActiveRecord::Relation.instance_eval do
-  prepend ChronoModel::Patches::Relation
-end
+  # Hooks in two points of the AR Preloader to preload As-Of time records of
+  # associated ChronoModels. is used by `.includes`, `.preload`, and `.eager_load`.
+  ActiveRecord::Associations::Preloader.prepend ChronoModel::Patches::Preloader
+
+  ActiveRecord::Associations::Preloader::Association.prepend ChronoModel::Patches::Preloader::Association
 
-# Hooks in two points of the AR Preloader to preload As-Of time records of
-# associated ChronoModels. is used by .includes, .preload and .eager_load.
-#
-ActiveRecord::Associations::Preloader.instance_eval do
-  prepend ChronoModel::Patches::Preloader
+  ActiveRecord::Associations::Preloader::ThroughAssociation.prepend ChronoModel::Patches::Preloader::ThroughAssociation
+
+  ActiveRecord::Batches::BatchEnumerator.prepend ChronoModel::Patches::Batches::BatchEnumerator
 end
 
-ActiveRecord::Associations::Preloader::Association.instance_eval do
-  prepend ChronoModel::Patches::Preloader::Association
+ActiveSupport.on_load :after_initialize do
+  next if Rails.application.config.active_record.schema_format == :sql
+
+  raise 'In order to use ChronoModel, set `config.active_record.schema_format` to `:sql`'
 end
 
-if defined?(Rails::DBConsole)
-  Rails::DBConsole.instance_eval do
-    prepend ChronoModel::Patches::DBConsole
-  end
+if ActiveRecord::ConnectionAdapters.respond_to?(:register)
+  ActiveRecord::ConnectionAdapters.register 'chronomodel', 'ChronoModel::Adapter', 'chrono_model/adapter'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: chrono_model
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Marcello Barnaba
 - Peter Joseph Brindisi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-06 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,16 +17,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,21 +40,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hirb
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -110,7 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: hirb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -138,7 +138,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -152,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,7 +166,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -180,7 +180,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -194,7 +194,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Give your models as-of date temporal extensions. Built entirely for PostgreSQL
-  >= 9.3
+  >= 9.4
 email:
 - vjt@openssl.it
 - p.brindisi@ifad.org
@@ -202,18 +202,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
 - LICENSE
 - README.md
-- README.sql
-- Rakefile
-- chrono_model.gemspec
-- gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.gemfile
-- gemfiles/rails_5.2.gemfile
 - lib/active_record/connection_adapters/chronomodel_adapter.rb
 - lib/active_record/tasks/chronomodel_database_tasks.rb
 - lib/chrono_model.rb
@@ -221,14 +211,19 @@ files:
 - lib/chrono_model/adapter/ddl.rb
 - lib/chrono_model/adapter/indexes.rb
 - lib/chrono_model/adapter/migrations.rb
+- lib/chrono_model/adapter/migrations_modules/legacy.rb
+- lib/chrono_model/adapter/migrations_modules/stable.rb
 - lib/chrono_model/adapter/tsrange.rb
 - lib/chrono_model/adapter/upgrade.rb
+- lib/chrono_model/chrono.rb
 - lib/chrono_model/conversions.rb
+- lib/chrono_model/db_console.rb
 - lib/chrono_model/json.rb
 - lib/chrono_model/patches.rb
 - lib/chrono_model/patches/as_of_time_holder.rb
 - lib/chrono_model/patches/as_of_time_relation.rb
 - lib/chrono_model/patches/association.rb
+- lib/chrono_model/patches/batches.rb
 - lib/chrono_model/patches/db_console.rb
 - lib/chrono_model/patches/join_node.rb
 - lib/chrono_model/patches/preloader.rb
@@ -241,59 +236,15 @@ files:
 - lib/chrono_model/time_machine/timeline.rb
 - lib/chrono_model/utilities.rb
 - lib/chrono_model/version.rb
-- spec/aruba/dbconsole_spec.rb
-- spec/aruba/fixtures/database_with_default_username_and_password.yml
-- spec/aruba/fixtures/database_without_username_and_password.yml
-- spec/aruba/fixtures/empty_structure.sql
-- spec/aruba/fixtures/migrations/56/20160812190335_create_impressions.rb
-- spec/aruba/fixtures/migrations/56/20171115195229_add_temporal_extension_to_impressions.rb
-- spec/aruba/fixtures/railsapp/config/application.rb
-- spec/aruba/fixtures/railsapp/config/boot.rb
-- spec/aruba/fixtures/railsapp/config/environments/development.rb
-- spec/aruba/migrations_spec.rb
-- spec/aruba/rake_task_spec.rb
-- spec/chrono_model/adapter/base_spec.rb
-- spec/chrono_model/adapter/ddl_spec.rb
-- spec/chrono_model/adapter/indexes_spec.rb
-- spec/chrono_model/adapter/migrations_spec.rb
-- spec/chrono_model/conversions_spec.rb
-- spec/chrono_model/history_models_spec.rb
-- spec/chrono_model/json_ops_spec.rb
-- spec/chrono_model/time_machine/as_of_spec.rb
-- spec/chrono_model/time_machine/changes_spec.rb
-- spec/chrono_model/time_machine/counter_cache_race_spec.rb
-- spec/chrono_model/time_machine/default_scope_spec.rb
-- spec/chrono_model/time_machine/history_spec.rb
-- spec/chrono_model/time_machine/keep_cool_spec.rb
-- spec/chrono_model/time_machine/manipulations_spec.rb
-- spec/chrono_model/time_machine/model_identification_spec.rb
-- spec/chrono_model/time_machine/sequence_spec.rb
-- spec/chrono_model/time_machine/sti_spec.rb
-- spec/chrono_model/time_machine/time_query_spec.rb
-- spec/chrono_model/time_machine/timeline_spec.rb
-- spec/chrono_model/time_machine/timestamps_spec.rb
-- spec/chrono_model/time_machine/transactions_spec.rb
-- spec/config.travis.yml
-- spec/config.yml.example
-- spec/spec_helper.rb
-- spec/support/adapter/helpers.rb
-- spec/support/adapter/structure.rb
-- spec/support/aruba.rb
-- spec/support/connection.rb
-- spec/support/matchers/base.rb
-- spec/support/matchers/column.rb
-- spec/support/matchers/function.rb
-- spec/support/matchers/index.rb
-- spec/support/matchers/schema.rb
-- spec/support/matchers/table.rb
-- spec/support/time_machine/helpers.rb
-- spec/support/time_machine/structure.rb
-- sql/json_ops.sql
-- sql/uninstall-json_ops.sql
 homepage: https://github.com/ifad/chronomodel
-licenses: []
-metadata: {}
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/ifad/chronomodel/issues
+  homepage_uri: https://github.com/ifad/chronomodel
+  source_code_uri: https://github.com/ifad/chronomodel
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -301,63 +252,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Temporal extensions (SCD Type II) for Active Record
-test_files:
-- spec/aruba/dbconsole_spec.rb
-- spec/aruba/fixtures/database_with_default_username_and_password.yml
-- spec/aruba/fixtures/database_without_username_and_password.yml
-- spec/aruba/fixtures/empty_structure.sql
-- spec/aruba/fixtures/migrations/56/20160812190335_create_impressions.rb
-- spec/aruba/fixtures/migrations/56/20171115195229_add_temporal_extension_to_impressions.rb
-- spec/aruba/fixtures/railsapp/config/application.rb
-- spec/aruba/fixtures/railsapp/config/boot.rb
-- spec/aruba/fixtures/railsapp/config/environments/development.rb
-- spec/aruba/migrations_spec.rb
-- spec/aruba/rake_task_spec.rb
-- spec/chrono_model/adapter/base_spec.rb
-- spec/chrono_model/adapter/ddl_spec.rb
-- spec/chrono_model/adapter/indexes_spec.rb
-- spec/chrono_model/adapter/migrations_spec.rb
-- spec/chrono_model/conversions_spec.rb
-- spec/chrono_model/history_models_spec.rb
-- spec/chrono_model/json_ops_spec.rb
-- spec/chrono_model/time_machine/as_of_spec.rb
-- spec/chrono_model/time_machine/changes_spec.rb
-- spec/chrono_model/time_machine/counter_cache_race_spec.rb
-- spec/chrono_model/time_machine/default_scope_spec.rb
-- spec/chrono_model/time_machine/history_spec.rb
-- spec/chrono_model/time_machine/keep_cool_spec.rb
-- spec/chrono_model/time_machine/manipulations_spec.rb
-- spec/chrono_model/time_machine/model_identification_spec.rb
-- spec/chrono_model/time_machine/sequence_spec.rb
-- spec/chrono_model/time_machine/sti_spec.rb
-- spec/chrono_model/time_machine/time_query_spec.rb
-- spec/chrono_model/time_machine/timeline_spec.rb
-- spec/chrono_model/time_machine/timestamps_spec.rb
-- spec/chrono_model/time_machine/transactions_spec.rb
-- spec/config.travis.yml
-- spec/config.yml.example
-- spec/spec_helper.rb
-- spec/support/adapter/helpers.rb
-- spec/support/adapter/structure.rb
-- spec/support/aruba.rb
-- spec/support/connection.rb
-- spec/support/matchers/base.rb
-- spec/support/matchers/column.rb
-- spec/support/matchers/function.rb
-- spec/support/matchers/index.rb
-- spec/support/matchers/schema.rb
-- spec/support/matchers/table.rb
-- spec/support/time_machine/helpers.rb
-- spec/support/time_machine/structure.rb
+test_files: []

data/.gitignore

@@ -1,21 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.byebug_history
-Gemfile.lock
-gemfiles/*.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-spec/config.yml
-spec/debug.log
-test/tmp
-test/version_tmp
-tmp

data/.rspec

@@ -1,2 +0,0 @@
---color
---format Fuubar