temporality 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fd5d7006b68f06a13dd0f46790440a31d179384
-  data.tar.gz: f4e6b4354ede8fc9c0ad6fa8717fe0a6b080f290
+  metadata.gz: b3427d7d435600ebdf7609aaf3fa32a929fcb49c
+  data.tar.gz: 6af589c77936c6c98573e129723c27ec4f4facc9
 SHA512:
-  metadata.gz: d9dec839f133d29763adab32b68c017ecc12ef960398c8156c84f40e8bb4640c7161dcfa8d0e0f5268ff8e6d82ce7ed2b31e33bab330c3cbf979ada953a224ac
-  data.tar.gz: ecd202980a60ec146c429a45750dfffeff4337bb6aeac56c94f8a43aa4907f6fc058a59315587b850fcba471c670b4b253f3eedf72e557cd2052bc862b0a20fe
+  metadata.gz: 10d40a04e6b406620aa808f615650ae5045ca897b6deefa0d509e59761736c03b9e3985dd1cdbd038957e052046df042eda0ae29d80aa362b6d16fac25f076ac
+  data.tar.gz: 6f2498c1fb678cdf6f54f29beb6913c79c4637196db1e0ab436e33931e3503d087fe5cfcebe1985985734f2aa1faffb10c6de086b37b15d58fa7bb63a9c9cfac

data/README.md

@@ -4,20 +4,6 @@ Temporality [![Build Status](https://secure.travis-ci.org/davout/temporality.png
 ## What is Temporality
 Temporality adds the ability to `ActiveRecord::Base` descendants to validate temporal data on themselves, and their associations.
 
-## Target features
-- Completeness implique prevent_overlap! implique également d'être deferred jusqu'au commit de la transaction
-- Enforce this is only used on belong_to associations
-- Doit permettre de valider que le parent est rempli
-- Doit permettre au parent de valider que les enfants sont inclus
-- Doit ne pas permettre l'overlap des records enfants
-
-- Doit faire l'auto-close des records précédents, avec callbacks
-- Doit faire l'auto-close des enfants, avec callbacks
-- Doit permettre d'initialiser l'enfant avec les bornes du parent en faisant par exemple parent.children.build
-- Scopes AR : intersecting, contained, englobant
-- Quand les bornes du parent sont changées on doit jouer les validations de l'enfant, sinon dans les autres cas, c'est l'enfant qu'on valide
-- Que se passe-t-il quand on modifie les bornes du parent, mais qu'on modifie en même temps les bornes de l'enfant ?
-
 ## Examples
 
 ````ruby
@@ -37,3 +23,4 @@ class Compensation < ActiveRecord::Base
   belongs_to :contract, temporality: { inclusion: true, auto_close_previous: true, allow_overlap: false, completeness: true }
 end
 ````
+

data/lib/temporality.rb

@@ -3,7 +3,7 @@ require 'date'
 require 'temporality/version'
 
 require 'temporality/slice_collection'
-
+require 'temporality/errors'
 require 'temporality/validation'
 require 'temporality/default_boundary_values'
 require 'temporality/attribute_overrides'
@@ -11,17 +11,66 @@ require 'temporality/associations'
 require 'temporality/schema'
 require 'temporality/scopes'
 require 'temporality/day_count'
+require 'temporality/transaction'
 
+# = Temporality
+#
+# Root module for temporal functionality, include it in ActiveRecord classes
+# to benefit from the temporality features.
+#
+# This functionality requires a +starts_on+ and +ends_on+ attribute pair defined
+# on the models in which the module is included.
+#
+# == Example
+#
+# This will define three classes with temporality constraints. An employment
+# contract will be required to be temporally within the bounds of the legal entity
+# with which it is made. A contract will also be required to have a temporally
+# complete set of compensation records.
+#
+#   class LegalEntity < ActiveRecord::Base
+#     include Temporality
+#     has_many :employment_contracts
+#   end
+#
+#   class EmploymentContract < ActiveRecord::Base
+#     include Temporality
+#     has_many :compensations
+#     belongs_to :legal_entity, temporality: {
+#       inclusion: true,
+#       auto_close: false,
+#       completeness: false,
+#       prevent_overlap: false
+#     }
+#   end
+#
+#   class Compensation < ActiveRecord::Base
+#     include Temporality
+#     belongs_to :employment_contract, temporality: {
+#       inclusion: true,
+#       auto_close: true,
+#       completeness: true,
+#       prevent_overlap: true
+#     }
+#   end
+#
 module Temporality
 
+  extend Transaction
+
   # Used when no start date is defined
   PAST_INFINITY = Date.new(1500, 1, 1)
 
   # Used when no end date is defined
   FUTURE_INFINITY = Date.new(5000, 1, 1)
 
+  # Prepended modules
   PREPENDS  = [ AttributeOverrides, Validation ]
+
+  # Extensions to the included class
   EXTENDS   = [ Associations, Scopes ]
+
+  # Inclusions for the included class
   INCLUDES  = [ DefaultBoundaryValues ]
 
   def self.included(base)
@@ -29,6 +78,7 @@ module Temporality
     EXTENDS.each  { |mod| base.extend(mod) }
     INCLUDES.each { |mod| base.include(mod) }
 
+    # TODO : On va peut-être pas l'inclure 50 fois ce truc...
     ActiveRecord::Base.send(:include, DayCount)
   end
 

data/lib/temporality/associations.rb

@@ -1,9 +1,22 @@
 module Temporality
-  module Associations
 
-    # TODO : Use class-inheritable instance variables
+  # = Temporal associations
+  #
+  # This module overrides +ActiveRecord::Base.belongs_to+ with the ability to 
+  # specifiy temporality options on the association.
+  #
+  # == Inverse associations
+  #
+  # It is necessary that ActiveRecord knows the inverse association on the
+  # +has_many+ side. If it isn't inferred automatically you must specify it
+  # using the +:inverse_of+ option on the +has_many+ declaration.
+  #
+  # @todo Use class-inheritable instance variables
+  #
+  module Associations
 
-    DEFAULTS = { inclusion: true, completeness: false, prevent_overlap: false, auto_close: false }
+    # The default temporality options
+    DEFAULTS = { inclusion: true, completeness: false, prevent_overlap: false, auto_close: false }.freeze
 
     def belongs_to(*args, &block)
       @temporality ||= {}
@@ -17,13 +30,34 @@ module Temporality
             end
           end
 
-          @temporality[assoc_name] = DEFAULTS.merge(opts)
+          @temporality[assoc_name] = with_implied_options(DEFAULTS.merge(opts))
         end
       end
 
       super(*args, &block)
     end
 
+
+    private
+
+    #
+    # Sets options implied by other options as follows:
+    #
+    #  - +:auto_close+ implies +:completeness+
+    #  - +:completeness+ implies +:prevent_overlap+
+    #  - +:completeness+ implies +:inclusion+
+    #
+    # @param opts [Hash] The options hash
+    # @return [Hash] The options with implied options set
+    #
+    def with_implied_options(opts)
+      res = opts.dup
+      res[:completeness]    ||= res[:auto_close]
+      res[:prevent_overlap] ||= res[:completeness]
+      res[:inclusion]       ||= res[:completeness]
+      res
+    end
+
   end
 end
 

data/lib/temporality/auto_close.rb

@@ -3,7 +3,33 @@ require 'temporality/validation_strategy'
 module Temporality
   class AutoClose < ValidationStrategy
 
-    def validate
+    def call
+      prev = nil
+
+      if @model.id
+        prev = inverse.order('starts_on ASC').where('id <> ?', @model.id).last
+      else
+        prev = inverse.order('starts_on ASC').last
+      end
+
+      if prev
+        if prev.starts_on >= @model.starts_on
+        raise Temporality::AutoCloseError.new("Can't auto-close a previous sibling with a fully overlapping record")
+        end
+
+        if prev.ends_on != Temporality::FUTURE_INFINITY
+          raise Temporality::AutoCloseError.new("Can't auto-close previous record if it's end date is finite")
+        end
+      end
+
+      if prev
+        if Temporality.active_transaction?
+          prev.ends_on = @model.starts_on - 1
+          prev.save
+        else
+          raise Temporality::NoTransactionError.new("Auto-closing previous records requires a Temporality transaction")
+        end
+      end
     end
 
   end

data/lib/temporality/completeness.rb

@@ -4,18 +4,28 @@ module Temporality
   class Completeness < ValidationStrategy
 
     def validate
+      if Temporality.active_transaction?
+        Temporality.defer(defer_key) { perform_validation }
+      else
+        perform_validation
+      end
+    end
+
+    def perform_validation
       days = @model.day_count + (inverse.where('id <> ?', @model.id || -1).map(&:day_count).inject(&:+) || 0)
       parent_days = @model.send(@assoc).day_count
-
       raise Temporality::Violation.new(error_message) unless (parent_days == days)
     end
 
+    def defer_key
+      parent = @model.send(@assoc)
+      "#{parent.class.name}_#{parent.id}_#{inverse_name}"
+    end
+
     def error_message
       "#{@model.send(@assoc).class} record must have a temporally complete children collection for assocation #{inverse_name}"
     end
 
-    # TODO : Check if in transaction ActiveRecord::Base.connection.open_transactions
-
   end
 end
 

data/lib/temporality/day_count.rb

@@ -2,7 +2,7 @@ module Temporality
   module DayCount
 
     def day_count
-      (ends_on - starts_on).to_i
+      (ends_on - starts_on).to_i + 1
     end
 
   end

data/lib/temporality/errors.rb

@@ -0,0 +1,6 @@
+module Temporality
+  class Violation < RuntimeError; end
+  class AutoCloseError < Violation; end
+  class NoTransactionError < Violation; end
+end
+

data/lib/temporality/schema.rb

@@ -1,8 +1,9 @@
-#
-# Defines a `temporality` migration helper for use in a `create_table` block as well
-# as a `temporality(:table)` helper to be used to alter existing table definitions.
-#
 module Temporality
+
+  #
+  # Defines a +temporality+ migration helper for use in a +create_table+ block as well
+  # as a +temporality(:table)+ helper to be used to alter existing table definitions.
+  #
   module Schema
 
     def self.include_helpers!

data/lib/temporality/transaction.rb

@@ -0,0 +1,42 @@
+module Temporality
+  module Transaction
+
+    QUEUE = :deferred_temporality_constraints
+
+    def transaction(*args, &block)
+      raise RuntimeError.new("There already is a currently active temporality transaction") if active_transaction?
+
+      ActiveRecord::Base.transaction(*args) do
+        begin
+          init_queue
+          block.call
+          process_queue
+        ensure
+          cleanup_queue
+        end
+      end
+    end
+
+    def defer(key, &block)
+      Thread.current[QUEUE][key] = block
+    end
+
+    def active_transaction?
+      !!Thread.current[QUEUE]
+    end
+
+    def process_queue
+      Thread.current[QUEUE].values.each(&:call)
+    end
+
+    def init_queue
+      Thread.current[QUEUE] = Hash.new
+    end
+
+    def cleanup_queue
+      Thread.current[QUEUE] = nil
+    end
+
+  end
+end
+

data/lib/temporality/validation.rb

@@ -1,5 +1,3 @@
-require 'temporality/violation'
-
 require 'temporality/auto_close'
 require 'temporality/completeness'
 require 'temporality/overlap'
@@ -8,11 +6,10 @@ require 'temporality/inclusion'
 module Temporality
   module Validation
 
-    VALIDATIONS = {
+    CONSTRAINTS = {
       inclusion:        Inclusion,
       prevent_overlap:  Overlap,
-      completeness:     Completeness,
-      auto_close:       AutoClose
+      completeness:     Completeness
     }
 
     DEFAULTS = { inclusion: true, completeness: false, prevent_overlap: false, auto_close: false }
@@ -28,15 +25,21 @@ module Temporality
     def validate_temporality_contraints!
       validate_bounds_order
 
-      temporal_associations.each do |assoc, constraints|
-        constraints.select { |k,v| v }.keys.each do |constraint|
+      temporal_associations.each do |assoc, constrs|
+        constraints = constrs.dup
+
+        if constraints.delete(:auto_close)
+          AutoClose.new(self, assoc).call
+        end
+
+        constraints.map { |constraint, enabled| constraint if enabled }.compact.each do |constraint|
           validate_constraint(assoc, constraint)
         end
       end
     end
 
-    def validate_constraint(assoc, constraint)
-      VALIDATIONS[constraint].new(self, assoc).validate
+    def validate_constraint(assoc, constraint_name)
+      CONSTRAINTS[constraint_name].new(self, assoc).validate
     end
 
     def validate_bounds_order

data/lib/temporality/version.rb

@@ -1,7 +1,7 @@
 module Temporality
 
   # Temporality gem version
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: temporality
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - David FRANCOIS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -98,44 +98,44 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '9.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '9.0'
 description: Give records the ability to validate temporal constraints on themselves
   and associations
 email:
@@ -153,6 +153,7 @@ files:
 - lib/temporality/completeness.rb
 - lib/temporality/day_count.rb
 - lib/temporality/default_boundary_values.rb
+- lib/temporality/errors.rb
 - lib/temporality/inclusion.rb
 - lib/temporality/overlap.rb
 - lib/temporality/schema.rb
@@ -161,10 +162,10 @@ files:
 - lib/temporality/slice_collection.rb
 - lib/temporality/time_span.rb
 - lib/temporality/time_span_collection.rb
+- lib/temporality/transaction.rb
 - lib/temporality/validation.rb
 - lib/temporality/validation_strategy.rb
 - lib/temporality/version.rb
-- lib/temporality/violation.rb
 homepage: https://paygun.fr
 licenses:
 - MIT

data/lib/temporality/violation.rb

@@ -1,5 +0,0 @@
-module Temporality
-  class Violation < RuntimeError
-  end
-end
-