chrono_model 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e2f6c55882d65be9f8fb0ff2ef4bbc2260d7d0a
-  data.tar.gz: f1d2aa3879ea83b657a7c3954ad1335817c8f8ce
+  metadata.gz: 46c5c3d3c7a91b99e025dbf9dbd961962cc36914
+  data.tar.gz: 0d120a3f68b711f77031e3e3df5d203efd812a23
 SHA512:
-  metadata.gz: 3b5c36f3ce8e4947038141179a04361f0b3eec0d36a7f50334a9b86903d904a852434ddfad69fa957cc6e2164e0d7dee89aa91593be4b8d72cafdfbcf7cce4d6
-  data.tar.gz: e1e2f4938157129ff3eaea888b67716ac1e24a9ee45bd0345c6aa1b1c381f309635f1f855eeccfb3b40d5b8008ca7ede2e66460a630306adebcd18ff4b16b2e9
+  metadata.gz: 17f0b8f514b94579d9cd5f4b32fad9c5d8bed4d95282c361acf10f930d7f1fd64d503139b6eb6f5bde6e9c2c51134f3bcfafdb5034b0dde95af1814bdae563c4
+  data.tar.gz: 4f7d2ee5109d774d3217cec430bf74964b269e9fff6c8b790a6a328fd7bcb043c3e18c87defc3601a4c85e2c2a597bf314c4e0a0251054ca923d4250cc89b6c2

data/.travis.yml

@@ -1,20 +1,21 @@
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1.7
+  - 2.2.3
 
-services:
-  - postgresql
+sudo: false
 
-bundler_args: --without development
+language: ruby
+cache: bundler
 
-before_install:
-  - sudo service postgresql stop
-  - sudo apt-get update
-  - sudo apt-get install postgresql-9.3 postgresql-plpython-9.3
-  - sudo service postgresql start 9.3
+addons:
+  postgresql: "9.4"
+  apt:
+    packages: postgresql-plpython-9.4
 
 before_script:
   - psql -c "CREATE DATABASE chronomodel;" -U postgres
 
-script: bundle exec rake TEST_CONFIG=./spec/config.travis.yml
+script:
+  - bundle exec rake TEST_CONFIG=./spec/config.travis.yml CODECLIMATE_REPO_TOKEN=dedfb7472ee410eec459bff3681d9a8fd8dd237e9bd7e8675a7c8eb7e253bba9

data/Gemfile

@@ -2,22 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in chrono_model.gemspec
 gemspec
-
-group :development do
-  gem 'pry'
-  gem 'hirb'
-
-  gem(
-    case RUBY_VERSION.to_f
-    when 1.8 then 'ruby-debug'
-    when 1.9 then 'debugger'
-    else          'byebug'
-    end
-  )
-end
-
-group :test do
-  gem 'rspec'
-  gem 'rake'
-  gem 'fuubar'
-end

data/README.md

@@ -1,6 +1,17 @@
-# Temporal database system on PostgreSQL using [updatable views][], [table inheritance][] and [INSTEAD OF triggers][]. [![Build Status][build-status-badge]][build-status] [![Dependency Status][deps-status-badge]][deps-status] [![Code Climate][code-analysis-badge]][code-analysis]
+# Temporal database system on PostgreSQL using [updatable views][], [table inheritance][] and [INSTEAD OF triggers][].
 
-ChronoModel does what Oracle sells as "Flashback Queries", but with standard
+[![Build Status][build-status-badge]][build-status]
+[![Dependency Status][deps-status-badge]][deps-status]
+[![Code Climate][code-analysis-badge]][code-analysis]
+[![Test Coverage][test-coverage-badge]][test-coverage]
+[![Inlinedocs][docs-analysis-badge]][docs-analysis]
+
+![{chronos - greek god of time}][chronos-image]
+
+> Chronos, the greek god of time.
+> Courtesy of [REBELLE SOCIETY][rebelle-society]
+
+ChronoModel implements what Oracle sells as "Flashback Queries", with standard
 SQL on free PostgreSQL. Academically speaking, ChronoModel implements a
 [Type-2 Slowly-Changing Dimension][wp-scd-2] with [history tables][wp-scd-4].
 
@@ -52,10 +63,17 @@ All timestamps are _forcibly_ stored in as UTC, bypassing the
 ## Requirements
 
 * Ruby >= 2.0 (1.9 is still supported, but support will be dropped soon).
-* Active Record = 4.0
+* Active Record = 4.2
 * PostgreSQL >= 9.3
-* The `btree_gist` PostgreSQL extension
+* The `btree_gist` and `plpython` PostgreSQL extensions:
+
+With Homebrew:
 
+    brew install --with-python postgres
+
+With Apt:
+
+    apt-get install postgresql-plpython
 
 ## Installation
 
@@ -236,7 +254,7 @@ History objects can be changed and `.save`d just like any other record.
 
 ## Running tests
 
-You need a running PostgreSQL 9.3 instance. Create `spec/config.yml` with the
+You need a running PostgreSQL >= 9.3 instance. Create `spec/config.yml` with the
 connection authentication details (use `spec/config.yml.example` as template).
 
 You need to connect as  a database superuser, because specs need to create the
@@ -257,6 +275,10 @@ comparison of JSON objects [implemented in pl/python][json-opclass].
 To load the opclass you can use the `ChronoModel::Json.create`
 convenience method. If you don't use JSON don't bother doing this.
 
+If you are on Postgres 9.4, you are strongly encouraged to use JSONB,
+that has an equality operator built-in, it's faster and stricter, and
+offers many more indexing abilities and better performance than JSON.
+
 ## Caveats
 
  * Rails 4 support requires disabling tsrange parsing support, as it
@@ -264,7 +286,7 @@ convenience method. If you don't use JSON don't bother doing this.
    as of now, mainly due to a [design clash with ruby][pg-tsrange-and-ruby].
 
  * There is (yet) no upgrade path from [v0.5][chronomodel-0.5],
-   (PG 9.0-compatible, `box()` and hacks) to v0.6 and up (9.3-only, `tsrange`
+   (PG 9.0-compatible, `box()` and hacks) to v0.6 and up (>=9.3-only, `tsrange`
    and _less_ hacks).
 
  * The triggers and temporal indexes cannot be saved in schema.rb. The AR
@@ -296,40 +318,47 @@ convenience method. If you don't use JSON don't bother doing this.
 
 
 [build-status]: https://travis-ci.org/ifad/chronomodel
-[build-status-badge]: https://travis-ci.org/ifad/chronomodel.png?branch=master
+[build-status-badge]: https://travis-ci.org/ifad/chronomodel.svg
 [deps-status]: https://gemnasium.com/ifad/chronomodel
-[deps-status-badge]: https://gemnasium.com/ifad/chronomodel.png
+[deps-status-badge]: https://gemnasium.com/ifad/chronomodel.svg
 [code-analysis]: https://codeclimate.com/github/ifad/chronomodel
-[code-analysis-badge]: https://codeclimate.com/github/ifad/chronomodel.png
-
-[updatable views]: http://www.postgresql.org/docs/9.3/static/sql-createview.html#SQL-CREATEVIEW-UPDATABLE-VIEWS
-[table inheritance]: http://www.postgresql.org/docs/9.3/static/ddl-inherit.html
-[INSTEAD OF triggers]: http://www.postgresql.org/docs/9.3/static/sql-createtrigger.html
+[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
+[test-coverage]: https://codeclimate.com/github/ifad/chronomodel
+[test-coverage-badge]: https://codeclimate.com/github/ifad/chronomodel/badges/coverage.svg
+
+[chronos-image]: http://i.imgur.com/8NObYiZl.jpg
+[rebelle-society]: http://www.rebellesociety.com/2012/10/11/the-writers-way-week-two-facing-procrastination/chronos_oeuvre_grand1/
+
+[updatable views]: http://www.postgresql.org/docs/9.4/static/sql-createview.html#SQL-CREATEVIEW-UPDATABLE-VIEWS
+[table inheritance]: http://www.postgresql.org/docs/9.4/static/ddl-inherit.html
+[INSTEAD OF triggers]: http://www.postgresql.org/docs/9.4/static/sql-createtrigger.html
 [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
-[triggers]: http://www.postgresql.org/docs/9.3/static/trigger-definition.html
-[schema]: http://www.postgresql.org/docs/9.3/static/ddl-schemas.html
-[inherits]: http://www.postgresql.org/docs/9.3/static/ddl-inherit.html
-[`current_timestamp`]: http://www.postgresql.org/docs/9.3/interactive/functions-datetime.html#FUNCTIONS-DATETIME-TABLE
+[triggers]: http://www.postgresql.org/docs/9.4/static/trigger-definition.html
+[schema]: http://www.postgresql.org/docs/9.4/static/ddl-schemas.html
+[inherits]: http://www.postgresql.org/docs/9.4/static/ddl-inherit.html
+[`current_timestamp`]: http://www.postgresql.org/docs/9.4/interactive/functions-datetime.html#FUNCTIONS-DATETIME-TABLE
 
-[Partitioning]: http://www.postgresql.org/docs/9.3/static/ddl-partitioning.html)
-[partitioning-excl-constraints]: http://www.postgresql.org/docs/9.3/static/ddl-partitioning.html#DDL-PARTITIONING-CONSTRAINT-EXCLUSION
+[Partitioning]: http://www.postgresql.org/docs/9.4/static/ddl-partitioning.html)
+[partitioning-excl-constraints]: http://www.postgresql.org/docs/9.4/static/ddl-partitioning.html#DDL-PARTITIONING-CONSTRAINT-EXCLUSION
 [README.sql]: https://github.com/ifad/chronomodel/blob/master/README.sql
-[GiST indexes]: http://www.postgresql.org/docs/9.3/static/gist.html
-[exclusion constraints]: http://www.postgresql.org/docs/9.3/static/sql-createtable.html#SQL-CREATETABLE-EXCLUDE
-[btree_gist]: http://www.postgresql.org/docs/9.3/static/btree-gist.html
-[COMMENT]: http://www.postgresql.org/docs/9.3/static/sql-comment.html
+[GiST indexes]: http://www.postgresql.org/docs/9.4/static/gist.html
+[exclusion constraints]: http://www.postgresql.org/docs/9.4/static/sql-createtable.html#SQL-CREATETABLE-EXCLUDE
+[btree_gist]: http://www.postgresql.org/docs/9.4/static/btree-gist.html
+[COMMENT]: http://www.postgresql.org/docs/9.4/static/sql-comment.html
 [TimeMachine]: https://github.com/ifad/chronomodel/blob/master/lib/chrono_model/time_machine.rb
 
 [r4-tsrange-broken]: https://github.com/rails/rails/pull/13793#issuecomment-34608093
 [r4-tsrange-incomplete]: https://github.com/rails/rails/issues/14010)
 [pg-tsrange-and-ruby]: https://bugs.ruby-lang.org/issues/6864
 [chronomodel-0.5]: https://github.com/ifad/chronomodel/tree/c2daa0f
-[Common Table Expressions]: http://www.postgresql.org/docs/9.3/static/queries-with.html
+[Common Table Expressions]: http://www.postgresql.org/docs/9.4/static/queries-with.html
 [cte-optimization-fence]: http://archives.postgresql.org/pgsql-hackers/2012-09/msg00700.php
 [cte-opt-out-fence]: http://archives.postgresql.org/pgsql-hackers/2012-10/msg00024.php
 [chronomodel-cte-impl]: https://github.com/ifad/chronomodel/commit/18f4c4b
 
-[json-type]: http://www.postgresql.org/docs/9.3/static/datatype-json.html
-[json-func]: http://www.postgresql.org/docs/9.3/static/functions-json.html
+[json-type]: http://www.postgresql.org/docs/9.4/static/datatype-json.html
+[json-func]: http://www.postgresql.org/docs/9.4/static/functions-json.html
 [json-opclass]: https://github.com/ifad/chronomodel/blob/master/sql/json_ops.sql

data/chrono_model.gemspec

@@ -4,9 +4,9 @@ require File.expand_path('../lib/chrono_model/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ['Marcello Barnaba', 'Peter Joseph Brindisi']
   gem.email         = ['vjt@openssl.it', 'p.brindisi@ifad.org']
-  gem.description   = %q{Give your models as-of date temporal extensions. Built entirely for PostgreSQL >= 9.0}
+  gem.description   = %q{Give your models as-of date temporal extensions. Built entirely for PostgreSQL >= 9.3}
   gem.summary       = %q{Temporal extensions (SCD Type II) for Active Record}
-  gem.homepage      = 'http://github.com/ifad/chronomodel'
+  gem.homepage      = 'https://github.com/ifad/chronomodel'
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
@@ -15,7 +15,15 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = ChronoModel::VERSION
 
-  gem.add_dependency "activerecord", "~> 4.0.0"
+  gem.add_dependency "activerecord", "~> 4.2.0"
   gem.add_dependency "pg"
   gem.add_dependency "multi_json"
+
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'hirb'
+  gem.add_development_dependency RUBY_VERSION.to_f == 1.9 ? 'debugger' : 'byebug'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'fuubar'
+  gem.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/chrono_model.rb

@@ -23,6 +23,10 @@ if RUBY_VERSION.to_i >= 2
   ActiveRecord::Associations::Association.instance_eval do
     prepend ChronoModel::Patches::Association
   end
+
+  ActiveRecord::Relation.instance_eval do
+    prepend ChronoModel::Patches::Relation
+  end
 else
   ActiveSupport::Deprecation.warn 'Ruby 1.9 is deprecated. Please update your Ruby <3'
 
@@ -32,5 +36,11 @@ else
     end
 
     ActiveRecord::Associations::Association = ChronoModel::Patches::AssociationPatch
+
+    class ChronoModel::Patches::RelationPatch < ActiveRecord::Relation
+      include ChronoModel::Patches::Relation
+    end
+
+    ActiveRecord::Relation = ChronoModel::Patches::RelationPatch
   end
 end

data/lib/chrono_model/adapter.rb

@@ -1,6 +1,8 @@
 require 'active_record'
 require 'active_record/connection_adapters/postgresql_adapter'
 
+require 'multi_json'
+
 module ChronoModel
 
   # This class implements all ActiveRecord::ConnectionAdapters::SchemaStatements
@@ -285,7 +287,19 @@ module ChronoModel
       chrono_alter(table_name) { super }
     end
 
-    # Runs column_definitions, primary_key and indexes in the temporal schema,
+    # Runs column_definitions in the temporal schema, as the table there
+    # defined is the source for this information.
+    #
+    # The default search path is included however, since the table
+    # may reference types defined in other schemas, which result in their
+    # names becoming schema qualified, which will cause type resolutions to fail.
+    #
+    define_method(:column_definitions) do |table_name|
+      return super(table_name) unless is_chrono?(table_name)
+      on_schema(TEMPORAL_SCHEMA + ',' + self.schema_search_path, false) { super(table_name) }
+    end
+
+    # Runs primary_key, indexes and default_sequence_name in the temporal schema,
     # as the table there defined is the source for this information.
     #
     # Moreover, the PostgreSQLAdapter +indexes+ method uses current_schema(),
@@ -294,10 +308,11 @@ module ChronoModel
     # Schema nesting is disabled on these calls, make sure to fetch metadata
     # from the first caller's selected schema and not from the current one.
     #
-    [:column_definitions, :primary_key, :indexes].each do |method|
-      define_method(method) do |table_name|
-        return super(table_name) unless is_chrono?(table_name)
-        _on_temporal_schema(false) { super(table_name) }
+    [:primary_key, :indexes, :default_sequence_name].each do |method|
+      define_method(method) do |*args|
+        table_name = args.first
+        return super(*args) unless is_chrono?(table_name)
+        _on_temporal_schema(false) { super(*args) }
       end
     end
 
@@ -454,6 +469,12 @@ module ChronoModel
       end
     end
 
+    def chrono_setup!
+      chrono_create_schemas
+
+      chrono_upgrade_structure!
+    end
+
     # HACK: Redefine tsrange parsing support, as it is broken currently.
     #
     # This self-made API is here because currently AR4 does not support
@@ -468,18 +489,13 @@ module ChronoModel
     #
     # so, for now, we are implementing our own.
     #
-    class TSRange < OID::Type
-      def extract_bounds(value)
-        from, to = value[1..-2].split(',')
-        {
-          from:          (value[1] == ',' || from == '-infinity') ? nil : from[1..-2],
-          to:            (value[-2] == ',' || to == 'infinity') ? nil : to[1..-2],
-          #exclude_start: (value[0] == '('),
-          #exclude_end:   (value[-1] == ')')
-        }
-      end
+    class TSRange < ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Range
+      OID = 3908
+
+      def cast_value(value)
+        return if value == 'empty'
+        return value if value.is_a?(::Array)
 
-      def type_cast(value)
         extracted = extract_bounds(value)
 
         from = Conversions.string_to_utc_time extracted[:from]
@@ -487,13 +503,23 @@ module ChronoModel
 
         [from, to]
       end
+
+      def extract_bounds(value)
+        from, to = value[1..-2].split(',')
+        {
+          from:          (value[1] == ',' || from == '-infinity') ? nil : from[1..-2],
+          to:            (value[-2] == ',' || to == 'infinity') ? nil : to[1..-2],
+        }
+      end
     end
 
-    def chrono_setup!
-      chrono_create_schemas
-      chrono_setup_type_map
+    def initialize_type_map(type_map)
+      super.tap do
+        ar_type = type_map.fetch(TSRange::OID)
+        cm_type = TSRange.new(ar_type.subtype, ar_type.type)
 
-      chrono_upgrade_structure!
+        type_map.register_type TSRange::OID, cm_type
+      end
     end
 
     # Copy the indexes from the temporal table to the history table if the indexes
@@ -529,12 +555,6 @@ module ChronoModel
         end
       end
 
-      # Adds the above TSRange class to the PG Adapter OID::TYPE_MAP
-      #
-      def chrono_setup_type_map
-        OID::TYPE_MAP[3908] = TSRange.new
-      end
-
       # Upgrades existing structure for each table, if required.
       # TODO: allow upgrades from pre-0.6 structure with box() and stuff.
       #

data/lib/chrono_model/patches.rb

@@ -3,6 +3,60 @@ require 'active_record'
 module ChronoModel
   module Patches
 
+    module AsOfTimeHolder
+      # Sets the virtual 'as_of_time' attribute to the given time, converting to UTC.
+      #
+      # See ChronoModel::Patches::AsOfTimeHolder
+      #
+      def as_of_time!(time)
+        @_as_of_time = time.utc
+
+        self
+      end
+
+      # Reads the virtual 'as_of_time' attribute
+      #
+      # See ChronoModel::Patches::AsOfTimeHolder
+      #
+      def as_of_time
+        @_as_of_time
+      end
+    end
+
+    module Relation
+      include AsOfTimeHolder
+
+      def load
+        return super unless @_as_of_time && !loaded?
+
+        super.each {|record| record.as_of_time!(@_as_of_time) }
+      end
+
+      def merge(*)
+        return super unless @_as_of_time
+
+        super.as_of_time!(@_as_of_time)
+      end
+
+      def build_arel
+        return super unless @_as_of_time
+
+        super.tap do |arel|
+
+          arel.join_sources.each do |join|
+            model = TimeMachine.chrono_models[join.left.table_name]
+            next unless model
+
+            join.left = Arel::Nodes::SqlLiteral.new(
+              model.history.virtual_table_at(@_as_of_time,
+                join.left.table_alias || join.left.table_name)
+            )
+          end
+
+        end
+      end
+    end
+
     # Patches ActiveRecord::Associations::Association to add support for
     # temporal associations.
     #
@@ -12,6 +66,9 @@ module ChronoModel
     # on the join model's (:through association) one.
     #
     module Association
+      def skip_statement_cache?
+        super || _chrono_target?
+      end
 
       # If the association class or the through association are ChronoModels,
       # then fetches the records from a virtual table using a subquery scope
@@ -20,11 +77,7 @@ module ChronoModel
         scope = super
         return scope unless _chrono_record?
 
-        klass = reflection.options[:polymorphic] ?
-          owner.public_send(reflection.foreign_type).constantize :
-          reflection.klass
-
-        if klass.chrono?
+        if _chrono_target?
           # For standard associations, replace the table name with the virtual
           # as-of table name at the owner's as-of-time
           #
@@ -54,9 +107,10 @@ module ChronoModel
               join.left.table_alias = table_alias
             end
           end
-
         end
 
+        scope.as_of_time!(owner.as_of_time)
+
         return scope
       end
 
@@ -64,6 +118,15 @@ module ChronoModel
         def _chrono_record?
           owner.respond_to?(:as_of_time) && owner.as_of_time.present?
         end
+
+        def _chrono_target?
+          @_target_klass ||= reflection.options[:polymorphic] ?
+            owner.public_send(reflection.foreign_type).constantize :
+            reflection.klass
+
+          @_target_klass.chrono?
+        end
+
     end
 
   end