chrono_model 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21c2181fc18f6dd3a5bdd89940eae284b340427bc81a4f024b6ad0686c146598
-  data.tar.gz: e7afa88021f63cd42e160a800f66e84bff1ba90f706c209df436059f70ae04e3
+  metadata.gz: e9dc931f360178771e212906ec3a02d1ff49ffc2393b457a7f531b101bc1e8ce
+  data.tar.gz: 7606b75d5eaf453e0d0f90c760607af50bdf862744f7048cc2c8061f41018bc5
 SHA512:
-  metadata.gz: a99b96b4166a7355016840fd7e7c6cf01febc86e89b1a6e07421db89e7d234972e214a9881b9a3bea2c8210bac2f83735a0d5d7d52c877c5b60160165fc09b16
-  data.tar.gz: 84300076a2b5211d3f1f3b317c087f893c754fcec43a2b64614b1a80b53304d95d6e686b5e25144758dd5731d7cd12de662dd45b981d9e259810346e186fe75d
+  metadata.gz: e64bea647172199e03703f0f4be8538d48276a8cb02fedb2309a68913ed6dad910d01f9ed4498fe345119ff1a12e25a0dda16f2b5976a0cb1b587dc4548eef4a
+  data.tar.gz: e326f5fce5a0fc94df9e23618840edb6baeaf307e85bbb3449fad7540cd85863be533caca5e30d073fc880a2759ce21ceed74f471dbba4959ead30e9ce43e5b5

data/LICENSE

@@ -1,24 +1,23 @@
-Copyright (c) 2012-2014 Marcello Barnaba <m.barnaba@ifad.org>
-Copyright (c) 2012-2014 Peter J. Brindisi <p.brindisi@ifad.org>
-Copyright (c) 2012-2014 IFAD
-
 MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Copyright (c) 2012-2022 Marcello Barnaba <m.barnaba@ifad.org>
+Copyright (c) 2012-2022 Peter J. Brindisi <p.brindisi@ifad.org>
+Copyright (c) 2012-2022 IFAD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,11 +1,13 @@
 # Temporal database system on PostgreSQL using [updatable views][pg-updatable-views], [table inheritance][pg-table-inheritance] and [INSTEAD OF triggers][pg-instead-of-triggers].
 
 [![Build Status][build-status-badge]][build-status]
+[![Legacy Build Status][legacy-build-status-badge]][build-status]
 [![Code Climate][code-analysis-badge]][code-analysis]
 [![Test Coverage][test-coverage-badge]][test-coverage]
+[![Gem Version][gem-version-badge]][gem-version]
 [![Inlinedocs][docs-analysis-badge]][docs-analysis]
 
-![{A Delorean that we all love}][delorean-image]
+![A Delorean that we all love][delorean-image]
 
 ChronoModel implements what Oracle sells as "Flashback Queries", with standard
 SQL on free PostgreSQL. Academically speaking, ChronoModel implements a
@@ -61,8 +63,8 @@ All timestamps are _forcibly_ stored in as UTC, bypassing the
 
 ## Requirements
 
-* Ruby >= 2.3
-* Active Record >= 5.0. See the [detailed supported versions matrix on travis](https://travis-ci.org/ifad/chronomodel)
+* Ruby >= 2.2.2
+* Active Record >= 5.0. See the [detailed supported versions matrix on Ruby GitHub Actions workflows](https://github.com/ifad/chronomodel/blob/master/.github/workflows)
 * PostgreSQL >= 9.4 (legacy support for 9.3)
 * The `btree_gist` PostgreSQL extension
 
@@ -95,6 +97,13 @@ development:
   username: ...
 ```
 
+Configure Active Record in your `config/application.rb` to use the `:sql` schema
+format:
+
+```rb
+config.active_record.schema_format = :sql
+```
+
 ## Schema creation
 
 ChronoModel hooks all `ActiveRecord::Migration` methods to make them temporal
@@ -140,7 +149,7 @@ validity from midnight, January 1st, 1 CE. You can set a specific validity with
 the `:validity` option:
 
 ```ruby
-change_table :your_table, :temporal => true, :copy_data => true, :validity => '1977-01-01'
+change_table :your_table, temporal: true, copy_data: true, validity: '1977-01-01'
 ```
 
 Please note that `change_table` requires you to use *old_style* `up` and
@@ -155,9 +164,9 @@ history.
 You can also choose which fields are to be journaled, passing the following
 options to `create_table`:
 
-  * `:journal => %w( fld1 fld2 .. .. )` - record changes in the history only when changing specified fields
-  * `:no_journal => %w( fld1 fld2 .. )` - do not record changes to the specified fields
-  * `:full_journal => true`             - record changes to *all* fields, including `updated_at`.
+  * `journal: %w( fld1 fld2 .. .. )` - record changes in the history only when changing specified fields
+  * `no_journal: %w( fld1 fld2 .. )` - do not record changes to the specified fields
+  * `full_journal: true`             - record changes to *all* fields, including `updated_at`.
 
 These options are stored as JSON in the [COMMENT][pg-comment] area of the
 public view, alongside with the ChronoModel version that created them.
@@ -194,7 +203,7 @@ to your `create_table`. Example:
 Include the `ChronoModel::TimeMachine` module in your model.
 
 ```ruby
-module Country < ActiveRecord::Base
+class Country < ActiveRecord::Base
   include ChronoModel::TimeMachine
 
   has_many :compositions
@@ -333,7 +342,7 @@ ChronoModel::Json.create
 ## Caveats
 
  * Rails 4+ support requires disabling tsrange parsing support, as it
-   [is broken][r4-tsrange-broken] and  [incomplete][r4-tsrange-incomplete]
+   [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
@@ -344,14 +353,24 @@ ChronoModel::Json.create
    `db:structure:load`.
    Two helper tasks are also added, `db:data:dump` and `db:data:load`.
 
- * The choice of using subqueries instead of [Common Table Expressions]
-   [pg-ctes] was dictated by the fact that CTEs [currently act as an
-   optimization fence][pg-cte-optimization-fence].
+ * The choice of using subqueries instead of [Common Table Expressions][pg-ctes]
+   was dictated by the fact that CTEs [currently act as an optimization
+   fence][pg-cte-optimization-fence].
    If it will be possible [to opt-out of the fence][pg-cte-opt-out-fence]
    in the future, they will be probably be used again as they were [in the
    past][cm-cte-impl], because the resulting queries were more readable,
    and do not inhibit using `.from()` on the `AR::Relation`.
 
+ * 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]
+
+ * Global ID ignores historical objects. [See issue #192][gh-issue-192]
+
+ * Different historical objects are considered the identical. [See issue
+   #206][gh-issue-206]
+
 
 ## Contributing
 
@@ -375,39 +394,41 @@ while using it in many important projects.
 This software is Made in Italy :it: :smile:.
 
 
-[build-status]: https://travis-ci.org/ifad/chronomodel
-[build-status-badge]: https://travis-ci.org/ifad/chronomodel.svg
-[code-analysis]: https://codeclimate.com/github/ifad/chronomodel
-[code-analysis-badge]: https://codeclimate.com/github/ifad/chronomodel.svg
-[docs-analysis]: http://inch-ci.org/github/ifad/chronomodel
-[docs-analysis-badge]: http://inch-ci.org/github/ifad/chronomodel.svg?branch=master
+[build-status]: https://github.com/ifad/chronomodel/actions
+[build-status-badge]: https://github.com/ifad/chronomodel/actions/workflows/ruby.yml/badge.svg
+[code-analysis]: https://codeclimate.com/github/ifad/chronomodel/maintainability
+[code-analysis-badge]: https://api.codeclimate.com/v1/badges/cdee7327938dc2eaff99/maintainability
+[docs-analysis]: https://inch-ci.org/github/ifad/chronomodel
+[docs-analysis-badge]: https://inch-ci.org/github/ifad/chronomodel.svg?branch=master
+[gem-version]: https://rubygems.org/gems/chrono_model
+[gem-version-badge]: https://badge.fury.io/rb/chrono_model.svg
+[legacy-build-status-badge]: https://github.com/ifad/chronomodel/actions/workflows/legacy_ruby.yml/badge.svg
 [test-coverage]: https://codeclimate.com/github/ifad/chronomodel
 [test-coverage-badge]: https://codeclimate.com/github/ifad/chronomodel/badges/coverage.svg
 
 [delorean-image]: https://i.imgur.com/DD77F4s.jpg
-[rebelle-society]: http://www.rebellesociety.com/2012/10/11/the-writers-way-week-two-facing-procrastination/chronos_oeuvre_grand1/
-
-[wp-scd-2]: http://en.wikipedia.org/wiki/Slowly_changing_dimension#Type_2
-[wp-scd-4]: http://en.wikipedia.org/wiki/Slowly_changing_dimension#Type_4
-
-[pg-updatable-views]: http://www.postgresql.org/docs/9.4/static/sql-createview.html#SQL-CREATEVIEW-UPDATABLE-VIEWS
-[pg-table-inheritance]: http://www.postgresql.org/docs/9.4/static/ddl-inherit.html
-[pg-instead-of-triggers]: http://www.postgresql.org/docs/9.4/static/sql-createtrigger.html
-[pg-triggers]: http://www.postgresql.org/docs/9.4/static/trigger-definition.html
-[pg-schema]: http://www.postgresql.org/docs/9.4/static/ddl-schemas.html
-[pg-current-timestamp]: http://www.postgresql.org/docs/9.4/interactive/functions-datetime.html#FUNCTIONS-DATETIME-TABLE
-[pg-partitioning]: http://www.postgresql.org/docs/9.4/static/ddl-partitioning.html
-[pg-partitioning-excl-constraints]: http://www.postgresql.org/docs/9.4/static/ddl-partitioning.html#DDL-PARTITIONING-CONSTRAINT-EXCLUSION
-[pg-gist-indexes]: http://www.postgresql.org/docs/9.4/static/gist.html
-[pg-exclusion-constraints]: http://www.postgresql.org/docs/9.4/static/sql-createtable.html#SQL-CREATETABLE-EXCLUDE
-[pg-btree-gist]: http://www.postgresql.org/docs/9.4/static/btree-gist.html
-[pg-comment]: http://www.postgresql.org/docs/9.4/static/sql-comment.html
+
+[wp-scd-2]: https://en.wikipedia.org/wiki/Slowly_changing_dimension#Type_2
+[wp-scd-4]: https://en.wikipedia.org/wiki/Slowly_changing_dimension#Type_4
+
+[pg-updatable-views]: https://www.postgresql.org/docs/9.4/sql-createview.html#SQL-CREATEVIEW-UPDATABLE-VIEWS
+[pg-table-inheritance]: https://www.postgresql.org/docs/9.4/ddl-inherit.html
+[pg-instead-of-triggers]: https://www.postgresql.org/docs/9.4/sql-createtrigger.html
+[pg-triggers]: https://www.postgresql.org/docs/9.4/trigger-definition.html
+[pg-schema]: https://www.postgresql.org/docs/9.4/ddl-schemas.html
+[pg-current-timestamp]: https://www.postgresql.org/docs/9.4/functions-datetime.html#FUNCTIONS-DATETIME-TABLE
+[pg-partitioning]: https://www.postgresql.org/docs/9.4/ddl-partitioning.html
+[pg-partitioning-excl-constraints]: https://www.postgresql.org/docs/9.4/ddl-partitioning.html#DDL-PARTITIONING-CONSTRAINT-EXCLUSION
+[pg-gist-indexes]: https://www.postgresql.org/docs/9.4/gist.html
+[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]: http://www.postgresql.org/docs/9.4/static/queries-with.html
-[pg-cte-optimization-fence]: http://archives.postgresql.org/pgsql-hackers/2012-09/msg00700.php
-[pg-cte-opt-out-fence]: http://archives.postgresql.org/pgsql-hackers/2012-10/msg00024.php
-[pg-json-type]: http://www.postgresql.org/docs/9.4/static/datatype-json.html
-[pg-json-func]: http://www.postgresql.org/docs/9.4/static/functions-json.html
+[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
+[pg-json-type]: https://www.postgresql.org/docs/9.4/datatype-json.html
+[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
@@ -418,3 +439,7 @@ This software is Made in Italy :it: :smile:.
 [cm-cte-impl]: https://github.com/ifad/chronomodel/commit/18f4c4b
 
 [gh-pzac]: https://github.com/pzac
+[gh-issue-174]: https://github.com/ifad/chronomodel/issues/174
+[gh-issue-186]: https://github.com/ifad/chronomodel/issues/186
+[gh-issue-192]: https://github.com/ifad/chronomodel/issues/192
+[gh-issue-206]: https://github.com/ifad/chronomodel/issues/206

data/lib/active_record/connection_adapters/chronomodel_adapter.rb

@@ -1,13 +1,21 @@
+# frozen_string_literal: true
+
 require 'chrono_model'
 
 module ActiveRecord
+  # TODO: Remove when dropping Rails < 7.2 compatibility
   module ConnectionHandling
+    def chronomodel_adapter_class
+      ChronoModel::Adapter
+    end
 
     # Install the new adapter in ActiveRecord. This approach is required because
     # the PG adapter defines +add_column+ itself, thus making impossible to use
     # super() in overridden Module methods.
     #
     def chronomodel_connection(config) # :nodoc:
+      return chronomodel_adapter_class.new(config) if ActiveRecord::VERSION::STRING >= '7.1'
+
       conn_params = config.symbolize_keys
 
       conn_params.delete_if { |_, v| v.nil? }
@@ -20,24 +28,22 @@ module ActiveRecord
       valid_conn_param_keys = PG::Connection.conndefaults_hash.keys + [:requiressl]
       conn_params.slice!(*valid_conn_param_keys)
 
-      # The postgres drivers don't allow the creation of an unconnected PG::Connection object,
-      # so just pass a nil connection object for the time being.
-      adapter = ChronoModel::Adapter.new(nil, logger, conn_params, config)
+      conn = PG.connect(conn_params) if ActiveRecord::VERSION::MAJOR >= 6
+
+      adapter = ChronoModel::Adapter.new(conn, logger, conn_params, config)
 
       unless adapter.chrono_supported?
-        raise ChronoModel::Error, "Your database server is not supported by ChronoModel. "\
-          "Currently, only PostgreSQL >= 9.3 is supported."
+        raise ChronoModel::Error, 'Your database server is not supported by ChronoModel. ' \
+                                  'Currently, only PostgreSQL >= 9.3 is supported.'
       end
 
       adapter.chrono_setup!
 
-      return adapter
-    end
+      adapter
+    rescue ::PG::Error => e
+      raise ActiveRecord::NoDatabaseError if e.message.include?(conn_params[:dbname])
 
-    module Connectionadapters
-      ChronoModelAdapter = ::ChronoModel::Adapter
+      raise
     end
-
   end
 end
-

data/lib/active_record/tasks/chronomodel_database_tasks.rb

@@ -1,11 +1,18 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module Tasks
     class ChronomodelDatabaseTasks < PostgreSQLDatabaseTasks
+      CHRONOMODEL_SCHEMAS = [
+        ChronoModel::Adapter::TEMPORAL_SCHEMA,
+        ChronoModel::Adapter::HISTORY_SCHEMA
+      ].freeze
 
       def structure_dump(*arguments)
-
-        with_chronomodel_schema_search_path do
-          super(*arguments)
+        if schema_search_path.present?
+          with_chronomodel_schema_search_path { super }
+        else
+          super
         end
 
         # The structure.sql includes CREATE SCHEMA statements, but as these are executed
@@ -18,55 +25,82 @@ module ActiveRecord
         sql = File.read(filename).gsub(/CREATE SCHEMA (?!IF NOT EXISTS)/, '\&IF NOT EXISTS ')
         File.open(filename, 'w') { |file| file << sql }
 
-        remove_sql_header_comments(filename)
+        remove_sql_header_comments(filename) if ActiveRecord::VERSION::STRING < '5.1'
       end
 
       def data_dump(target)
-        set_psql_env
+        psql_env
 
-        args = ['-c', '-f', target]
-        args << configuration['database']
+        args = ['-c', '-f', target.to_s]
+        args << chronomodel_configuration[:database]
 
-        run_cmd "pg_dump", args, 'dumping data'
+        run_cmd 'pg_dump', args, 'dumping data'
       end
 
       def data_load(source)
-        set_psql_env
+        psql_env
 
         args = ['-f', source]
-        args << configuration['database']
+        args << chronomodel_configuration[:database]
 
-        run_cmd "psql", args, 'loading data'
+        run_cmd 'psql', args, 'loading data'
       end
 
       private
 
+      # In Rails 6.1.x the configuration instance variable is not available
+      # and it's been replaced by @configuration_hash (which is frozen).
+      def chronomodel_configuration
+        @chronomodel_configuration ||=
+          if defined?(@configuration_hash)
+            @configuration_hash
+          else
+            configuration.with_indifferent_access
+          end
+      end
+
       # If a schema search path is defined in the configuration file, it will
       # be used by the database tasks class to dump only the specified search
       # path. Here we add also ChronoModel's temporal and history schemas to
       # the search path and yield.
       #
       def with_chronomodel_schema_search_path
-        original_schema_search_path = configuration['schema_search_path']
-
-        if original_schema_search_path.present?
-          configuration['schema_search_path'] = original_schema_search_path.split(',').concat([
-            ChronoModel::Adapter::TEMPORAL_SCHEMA,
-            ChronoModel::Adapter::HISTORY_SCHEMA
-          ]).join(',')
-        end
+        patch_configuration!
 
         yield
-
       ensure
-        configuration['schema_search_path'] = original_schema_search_path
+        reset_configuration!
       end
 
-      unless method_defined? :remove_sql_header_comments
+      def patch_configuration!
+        @original_schema_search_path = schema_search_path
+
+        chronomodel_schema_search_path = "#{schema_search_path},#{CHRONOMODEL_SCHEMAS.join(',')}"
+
+        if defined?(@configuration_hash)
+          @configuration_hash = @configuration_hash.dup
+          @configuration_hash[:schema_search_path] = chronomodel_schema_search_path
+          @configuration_hash.freeze
+        else
+          configuration['schema_search_path'] = chronomodel_schema_search_path
+        end
+      end
+
+      def reset_configuration!
+        if defined?(@configuration_hash)
+          @configuration_hash = @configuration_hash.dup
+          @configuration_hash[:schema_search_path] = @original_schema_search_path
+          @configuration_hash.freeze
+        else
+          configuration['schema_search_path'] = @original_schema_search_path
+        end
+      end
+
+      unless private_instance_methods.include?(:remove_sql_header_comments)
         def remove_sql_header_comments(filename)
           sql_comment_begin = '--'
           removing_comments = true
-          tempfile = Tempfile.open("uncommented_structure.sql")
+          tempfile = Tempfile.open('uncommented_structure.sql')
           begin
             File.foreach(filename) do |line|
               unless removing_comments && (line.start_with?(sql_comment_begin) || line.blank?)
@@ -81,6 +115,13 @@ module ActiveRecord
         end
       end
 
+      unless private_instance_methods.include?(:psql_env)
+        alias psql_env set_psql_env
+      end
+
+      def schema_search_path
+        @schema_search_path ||= chronomodel_configuration[:schema_search_path]
+      end
     end
   end
 end