chrono_model 3.0.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 222db0e6673e7171d44dac2163b5048ebf6b459c18fa2a2609a3051fce8c6591
-  data.tar.gz: 871fdf28717c85267e6b783f1f2d6ba3a24b1261e974e53a25de28d745bc8579
+  metadata.gz: b8e1a4cdc29f1fa0435f82c9277674a7085e6caf445ea45673995864038d8a1b
+  data.tar.gz: 60df7e87f659a392cf22e8a754b608d7d1fc030d4f63a30dde4af1644ab7917d
 SHA512:
-  metadata.gz: 0bf942259052f134ea38de898307a65f20a6b448d8e8ff99a09ae06cd751f9834e1eb22abd4498c880005b8fc91f44ecebea4702be8c174570c50027dce13a75
-  data.tar.gz: 2b894f82a0cb9687d59dca9c3427a854cf6dc02191a08df71a215dfc577a8d1dd58632d44eb179395f097aa7d2391a7c738968d0f4c68f16cc14fffd2d18e034
+  metadata.gz: 22333be09e65a5347f3413976eea41581b76c7ad94dc138924cd7e5e8f6cb36cd572567f6b195c896a14262d96a3623f7b49116ed2856dcf58441ad4f43ceff2
+  data.tar.gz: 9d96851d9dc3947e485a1c09c89eb06c0e5b07a0ddf9c43e75bdd1c3bb13ca4df599e7f4e8050268ba30c00de7878d1a6c496db1f70b2e3e9c76f0bb10d3d63c

data/README.md

@@ -67,24 +67,19 @@ All timestamps are _forcibly_ stored in as UTC, bypassing the
 * PostgreSQL >= 9.4
 * The `btree_gist` PostgreSQL extension
 
-With Homebrew:
-
-    brew install postgres
-
-With apt:
-
-    apt-get install postgresql-11
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'chrono_model'
+```ruby
+gem 'chrono_model'
+```
 
 And then execute:
 
-    $ bundle
-
+```sh
+$ bundle
+```
 
 ## Configuration
 
@@ -99,7 +94,7 @@ development:
 Configure Active Record in your `config/application.rb` to use the `:sql` schema
 format:
 
-```rb
+```ruby
 config.active_record.schema_format = :sql
 ```
 
@@ -121,7 +116,7 @@ view and all the trigger machinery. Every other housekeeping of the temporal
 structure is handled behind the scenes by the other schema statements. E.g.:
 
  * `rename_table`  - renames tables, views, sequences, indexes and triggers
- * `drop_table`    - drops the temporal table and all dependant objects
+ * `drop_table`    - drops the temporal table and all dependent objects
  * `add_column`    - adds the column to the current table and updates triggers
  * `rename_column` - renames the current table column and updates the triggers
  * `remove_column` - removes the current table column and updates the triggers
@@ -192,10 +187,12 @@ occur (see https://github.com/ifad/chronomodel/issues/71).
 In such cases, ensure to add `no_journal: %w( your_counter_cache_column_name )`
 to your `create_table`. Example:
 
-    create_table 'sections', temporal: true, no_journal: %w( articles_count ) do |t|
-      t.string :name
-      t.integer :articles_count, default: 0
-    end
+```ruby
+create_table 'sections', temporal: true, no_journal: %w[articles_count] do |t|
+  t.string :name
+  t.integer :articles_count, default: 0
+end
+```
 
 ## Data querying
 
@@ -282,12 +279,12 @@ cannot be deleted.
 
 ChronoModel currently performs upgrades by dropping and re-creating the views
 that give access to current data. If you have built other database objects on
-these views, the upgrade cannot be performed automatically as the dependant
+these views, the upgrade cannot be performed automatically as the dependent
 objects must be dropped first.
 
 When booting, ChronoModel will issue a warning in your logs about the need of
 a structure upgrade. Structure usually changes across versions. In this case,
-you need to set up a rake task that drops your dependant objects, runs
+you need to set up a rake task that drops your dependent objects, runs
 ChronoModel.upgrade! and then re-creates them.
 
 A migration system should be introduced, but it is seen as overkill for now,
@@ -304,7 +301,9 @@ You need to connect as  a database superuser, because specs need to create the
 
 To run the full test suite, use
 
-    rake
+```sh
+$ rake
+```
 
 SQL queries are logged to `spec/debug.log`. If you want to see them in your
 output, set the `VERBOSE=true` environment variable.
@@ -313,7 +312,9 @@ Some tests check the nominal execution of rake tasks within a test Rails app,
 and those are quite time consuming. You can run the full ChronoModel tests
 only against ActiveRecord by using
 
-    rspec spec/chrono_model
+```sh
+$ rspec spec/chrono_model
+```
 
 Ensure to run the full test suite before pushing.
 
@@ -328,10 +329,6 @@ Ensure to run the full test suite before pushing.
    of an object at a specific point in time within the application could
    lead to inaccuracies.
 
- * Rails 4+ support requires disabling tsrange parsing support, as it
-   [is broken][r4-tsrange-broken] and [incomplete][r4-tsrange-incomplete]
-   as of now, mainly due to a [design clash with ruby][pg-tsrange-and-ruby].
-
  * The triggers and temporal indexes cannot be saved in schema.rb. The AR
    schema dumper is quite basic, and it isn't (currently) extensible.
    As we're using many database-specific features, Chronomodel forces the
@@ -351,7 +348,7 @@ Ensure to run the full test suite before pushing.
  * Foreign keys are not supported. [See issue #174][gh-issue-174]
 
  * There may be unexpected results when combining eager loading and joins.
-  [See issue #186][gh-issue-186]
+   [See issue #186][gh-issue-186]
 
  * Global ID ignores historical objects. [See issue #192][gh-issue-192]
 
@@ -412,7 +409,6 @@ This software is Made in Italy :it: :smile:.
 [pg-exclusion-constraints]: https://www.postgresql.org/docs/9.4/sql-createtable.html#SQL-CREATETABLE-EXCLUDE
 [pg-btree-gist]: https://www.postgresql.org/docs/9.4/btree-gist.html
 [pg-comment]: https://www.postgresql.org/docs/9.4/sql-comment.html
-[pg-tsrange-and-ruby]: https://bugs.ruby-lang.org/issues/6864
 [pg-ctes]: https://www.postgresql.org/docs/9.4/queries-with.html
 [pg-cte-optimization-fence]: https://www.postgresql.org/message-id/201209191305.44674.db@kavod.com
 [pg-cte-opt-out-fence]: https://www.postgresql.org/message-id/CAHyXU0zpM5+Dsb_pKxDmm-ZoWUAt=SkHHaiK_DBqcmtxTas6Nw@mail.gmail.com
@@ -420,9 +416,6 @@ This software is Made in Italy :it: :smile:.
 [pg-json-func]: https://www.postgresql.org/docs/9.4/functions-json.html
 [pg-json-opclass]: https://github.com/ifad/chronomodel/blob/master/sql/json_ops.sql
 
-[r4-tsrange-broken]: https://github.com/rails/rails/pull/13793#issuecomment-34608093
-[r4-tsrange-incomplete]: https://github.com/rails/rails/issues/14010
-
 [cm-readme-sql]: https://github.com/ifad/chronomodel/blob/master/README.sql
 [cm-timemachine]: https://github.com/ifad/chronomodel/blob/master/lib/chrono_model/time_machine.rb
 [cm-cte-impl]: https://github.com/ifad/chronomodel/commit/18f4c4b

data/lib/chrono_model/adapter/upgrade.rb

@@ -42,7 +42,7 @@ module ChronoModel
         return if upgrade.empty?
 
         logger.warn 'ChronoModel: There are tables needing a structure upgrade, and ChronoModel structures need to be recreated.'
-        logger.warn 'ChronoModel: Please run ChronoModel.upgrade! to attempt the upgrade. If you have dependant database objects'
+        logger.warn 'ChronoModel: Please run ChronoModel.upgrade! to attempt the upgrade. If you have dependent database objects'
         logger.warn 'ChronoModel: the upgrade will fail and you have to drop the dependent objects, run .upgrade! and create them'
         logger.warn 'ChronoModel: again. Sorry. Some features or the whole library may not work correctly until upgrade is complete.'
         logger.warn "ChronoModel: Tables pending upgrade: #{upgrade}"

data/lib/chrono_model/adapter.rb

@@ -7,7 +7,6 @@ require 'chrono_model/adapter/migrations_modules/stable'
 
 require 'chrono_model/adapter/ddl'
 require 'chrono_model/adapter/indexes'
-require 'chrono_model/adapter/tsrange'
 require 'chrono_model/adapter/upgrade'
 
 module ChronoModel
@@ -19,7 +18,6 @@ module ChronoModel
     include ChronoModel::Adapter::Migrations
     include ChronoModel::Adapter::DDL
     include ChronoModel::Adapter::Indexes
-    include ChronoModel::Adapter::TSRange
     include ChronoModel::Adapter::Upgrade
 
     # The schema holding current data

data/lib/chrono_model/conversions.rb

@@ -6,19 +6,6 @@ module ChronoModel
 
     ISO_DATETIME = /\A(\d{4})-(\d\d)-(\d\d) (\d\d):(\d\d):(\d\d)(?:\.(\d+))?\z/
 
-    # rubocop:disable Style/PerlBackrefs
-    def string_to_utc_time(string)
-      return string if string.is_a?(Time)
-
-      return unless string =~ ISO_DATETIME
-
-      # .1 is .100000, not .000001
-      usec = $7.ljust(6, '0') unless $7.nil?
-
-      Time.utc $1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i, usec.to_i
-    end
-    # rubocop:enable Style/PerlBackrefs
-
     def time_to_utc_string(time)
       time.to_fs(:db) << '.' << format('%06d', time.usec)
     end

data/lib/chrono_model/time_machine/history_model.rb

@@ -107,7 +107,7 @@ module ChronoModel
         # name has the "::History" suffix but that is never going to be
         # present in the data.
         #
-        # As such it is overriden here to return the same contents that
+        # As such it is overridden here to return the same contents that
         # the parent would have returned.
         delegate :sti_name, to: :superclass
 
@@ -132,7 +132,7 @@ module ChronoModel
       end
 
       # The history id is `hid`, but this cannot set as primary key
-      # or temporal assocations will break. Solutions are welcome.
+      # or temporal associations will break. Solutions are welcome.
       def id
         hid
       end
@@ -204,24 +204,24 @@ module ChronoModel
         self.class.superclass.find(rid)
       end
 
-      def record # :nodoc:
-        ActiveSupport::Deprecation.warn '.record is deprecated in favour of .current_version'
-        current_version
-      end
-
+      # Return `nil` instead of -Infinity/Infinity to preserve current
+      # Chronomodel behaviour and avoid failures with Rails 7.0 and
+      # unbounded time ranges
+      #
+      # Check if `begin` and `end` are `Time` because validity is a `tsrange`
+      # column, so it is either `Time`, `nil`, and in some cases Infinity.
+      #
+      # Ref: rails/rails#45099
+      # TODO: consider removing when Rails 7.0 support will be dropped
       def valid_from
-        validity.first
+        validity.begin if validity.begin.is_a?(Time)
       end
 
       def valid_to
-        validity.last
+        validity.end if validity.end.is_a?(Time)
       end
       alias as_of_time valid_to
 
-      def recorded_at
-        ChronoModel::Conversions.string_to_utc_time attributes_before_type_cast['recorded_at']
-      end
-
       # Starting from Rails 6.0, `.read_attribute` will use the memoized
       # `primary_key` if it detects that the attribute name is `id`.
       #

data/lib/chrono_model/time_machine/time_query.rb

@@ -46,7 +46,8 @@ module ChronoModel
       end
 
       def time_for_time_query(t, column)
-        if t == :now || t == :today
+        case t
+        when :now, :today
           now_for_column(column)
         else
           quoted_t = connection.quote(connection.quoted_date(t))

data/lib/chrono_model/time_machine/timeline.rb

@@ -81,9 +81,7 @@ module ChronoModel
         sql << " LIMIT #{options[:limit].to_i}" if options.key?(:limit)
 
         connection.on_schema(Adapter::HISTORY_SCHEMA) do
-          connection.select_values(sql, "#{name} periods").map! do |ts|
-            Conversions.string_to_utc_time ts
-          end
+          connection.select_values(sql, "#{name} periods")
         end
       end
 

data/lib/chrono_model/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChronoModel
-  VERSION = '3.0.1'
+  VERSION = '4.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chrono_model
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Marcello Barnaba
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2024-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -72,7 +72,6 @@ files:
 - lib/chrono_model/adapter/indexes.rb
 - lib/chrono_model/adapter/migrations.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
@@ -117,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Temporal extensions (SCD Type II) for Active Record

data/lib/chrono_model/adapter/tsrange.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module ChronoModel
-  class Adapter < ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
-    module TSRange
-      # HACK: Redefine tsrange parsing support, as it is broken currently.
-      #
-      # This self-made API is here because currently AR4 does not support
-      # open-ended ranges. The reasons are poor support in Ruby:
-      #
-      #   https://bugs.ruby-lang.org/issues/6864
-      #
-      # and an instable interface in Active Record:
-      #
-      #   https://github.com/rails/rails/issues/13793
-      #   https://github.com/rails/rails/issues/14010
-      #
-      # so, for now, we are implementing our own.
-      #
-      class Type < ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Range
-        OID = 3908
-
-        def cast_value(value)
-          return if value == 'empty'
-          return value if value.is_a?(::Array)
-
-          extracted = extract_bounds(value)
-
-          from = Conversions.string_to_utc_time extracted[:from]
-          to   = Conversions.string_to_utc_time extracted[:to]
-
-          [from, to]
-        end
-
-        def extract_bounds(value)
-          from, to = value[1..-2].split(',')
-
-          from_bound =
-            if value[1] == ',' || from == '-infinity'
-              nil
-            else
-              from[1..-2]
-            end
-
-          to_bound =
-            if value[-2] == ',' || to == 'infinity'
-              nil
-            else
-              to[1..-2]
-            end
-
-          {
-            from: from_bound,
-            to: to_bound
-          }
-        end
-      end
-
-      def initialize_type_map(m = type_map)
-        super.tap do
-          typ = ChronoModel::Adapter::TSRange::Type
-          oid = typ::OID
-
-          ar_type = type_map.fetch(oid)
-          cm_type = typ.new(ar_type.subtype, ar_type.type)
-
-          type_map.register_type oid, cm_type
-        end
-      end
-    end
-  end
-end