versioned_record 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 949068fec057f339188cdb54a297c3237d806a3c
-  data.tar.gz: 4408334975f62ef080055cc2f1351a4ef7730595
+  metadata.gz: 8d961aed7862c149a656c89584e5e39a36eab865
+  data.tar.gz: efac3b9ce83e333511c5dba682d0ca4b238384b3
 SHA512:
-  metadata.gz: d8b8c37d7f54b9a978b8166a66908426ea6060f8ce5f799dd1948f318226cc78c349cb4aadce06c7708341a41acc08532eba13114405ebff36b85fe9ff7f060f
-  data.tar.gz: ce25740a5627cffd3dcdec8cad7c76518819eaf7b279ba2b6009e1258a8227a5aa1fdf06ec7a6ce58ae4b5dec4e5609680d46f14bec23449f2be2dc02838bb2b
+  metadata.gz: 496b5f7cc0c2d15098bf17b5316253f128e1a7442bb1143c7f6bfdf781586f1b5abbbe1f42b827660d3b79424a4f483089bde85114bfe50de3387f39310ed56a
+  data.tar.gz: 3ff2e0d96885ea548736e846dd77e8385c9448850affd79d8967905ff227933b7400e53d5e85b83a3bc1ffd44bc5597af6f0d4f339b7f1df740e768a4aebfd0c

data/README.md

@@ -70,7 +70,32 @@ Also, the `is_current_version` flag is unset for the old version and set for the
     product.is_current_version? => false
     product_v2.is_current_version? => true
 
-## TODO: Associations
+## Associations
+
+### `belongs_to` A versioned model, but references the latest version (general case)
+
+A simple `belongs_to` will work
+
+### `belongs_to` A versioned model but references a specific version
+
+`belongs_to` must specify the `foreign_key` and primary key settings
+
+    class Contract < ActiveRecord::Base
+      include VersionedRecord
+      has_many :apprentices, :foreign_key => [:contract_id, :contract_version], primary_key: [:id, :version ]
+    end
+
+    class Apprentice < ActiveRecord::Base
+      belongs_to :contract, :foreign_key => [:contract_id, :contract_version], primary_key: [ :id, version ]
+    end
+
+### `belongs_to` a non-versioned model
+
+Normal behaviour
+
+### `belongs_to` when this model is version
+
+As per above cases (versioning here has no effect)
 
 
 ## Database Support
@@ -79,7 +104,9 @@ Right now, only PostgreSQL has been tested. MySQL may or may not work but if you
 
 ## Limitations
 
-Does not currently work with ActiveRecord 4.1+
+* Does not currently work with ActiveRecord 4.1+
+* Calling reload on a model will load the latest _version_ of that record, not the specific one. (This is because id will return just the id and not the id/version composite.)
+
 
 ## Author
 

data/lib/versioned_record.rb

@@ -7,102 +7,113 @@ require 'versioned_record/attribute_builder'
 require 'versioned_record/class_methods'
 require 'versioned_record/connection_adapters/postgresql'
 require 'versioned_record/version'
+require 'versioned_record/composite_predicates'
+
+ActiveRecord::Associations::AssociationScope.include(VersionedRecord::CompositePredicates)
 
 module VersionedRecord
   def self.included(model_class)
-    model_class.extend ClassMethods
     model_class.primary_keys = :id, :version
     model_class.after_save :ensure_version_deprecation!, on: :create
+    model_class.send :alias_method, :id_with_version, :id
+    model_class.extend ClassMethods
+    model_class.include InstanceMethods
   end
 
-  # Create a new version of the existing record
-  # A new version can only be created once for a given record and subsequent
-  # versions must be created by calling create_version! on the latest version
-  #
-  # Attributes that are not specified here will be copied to the new version from
-  # the previous version
-  #
-  # This method will still fire ActiveRecord callbacks for save/create etc as per
-  # normal record creation
-  #
-  # @example
-  #
-  #     person_v1 = Person.create(name: 'Dan')
-  #     person_v2 = person_v1.create_version!(name: 'Daniel')
-  #
-  def create_version!(new_attrs = {})
-    create_operation do
-      self.class.create!(new_version_attrs(new_attrs))
+  module InstanceMethods
+    def id
+      id_with_version[0]
     end
-  end
 
-  # Same as #create_version! but will not raise if the record is invalid
-  # @see VersionedRecord#create_version!
-  #
-  def create_version(new_attrs = {})
-    create_operation do
-      self.class.create(new_version_attrs(new_attrs))
+    # Create a new version of the existing record
+    # A new version can only be created once for a given record and subsequent
+    # versions must be created by calling create_version! on the latest version
+    #
+    # Attributes that are not specified here will be copied to the new version from
+    # the previous version
+    #
+    # This method will still fire ActiveRecord callbacks for save/create etc as per
+    # normal record creation
+    #
+    # @example
+    #
+    #     person_v1 = Person.create(name: 'Dan')
+    #     person_v2 = person_v1.create_version!(name: 'Daniel')
+    #
+    def create_version!(new_attrs = {})
+      create_operation do
+        self.class.create!(new_version_attrs(new_attrs))
+      end
     end
-  end
 
-  # Build (but do not save) a new version of the record
-  # This allows you to use the object in forms etc
-  # After the record is saved, all previous versions will be deprecated
-  # and this record will be marked as current
-  #
-  # @example
-  #
-  #     new_version = first_version.build_version
-  #     new_version.save
-  #
-  def build_version(new_attrs = {})
-    new_version = self.class.new(new_version_attrs(new_attrs)).tap do |built|
-      built.deprecate_old_versions_after_create!
+    # Same as #create_version! but will not raise if the record is invalid
+    # @see VersionedRecord#create_version!
+    #
+    def create_version(new_attrs = {})
+      create_operation do
+        self.class.create(new_version_attrs(new_attrs))
+      end
     end
-  end
-
-  # Retrieve all versions of this record
-  # Can be chained with other scopes
-  #
-  # @example Versions ordered by version number
-  #
-  #     person.versions.order(:version)
-  #
-  def versions
-    self.class.where(id: self.id)
-  end
 
-  # Ensure that old versions are deprecated when we save
-  # (only applies on create)
-  def deprecate_old_versions_after_create!
-    @deprecate_old_versions_after_create = true
-  end
+    # Build (but do not save) a new version of the record
+    # This allows you to use the object in forms etc
+    # After the record is saved, all previous versions will be deprecated
+    # and this record will be marked as current
+    #
+    # @example
+    #
+    #     new_version = first_version.build_version
+    #     new_version.save
+    #
+    def build_version(new_attrs = {})
+      new_version = self.class.new(new_version_attrs(new_attrs)).tap do |built|
+        built.deprecate_old_versions_after_create!
+      end
+    end
 
-  private
-    def new_version_attrs(new_attrs)
-      attr_builder = AttributeBuilder.new(self)
-      attr_builder.attributes(new_attrs)
+    # Retrieve all versions of this record
+    # Can be chained with other scopes
+    #
+    # @example Versions ordered by version number
+    #
+    #     person.versions.order(:version)
+    #
+    def versions
+      self.class.where(id: self.id)
     end
 
-    def deprecate_old_versions(current_version)
-      versions.exclude(current_version).update_all(is_current_version: false)
+    # Ensure that old versions are deprecated when we save
+    # (only applies on create)
+    def deprecate_old_versions_after_create!
+      @deprecate_old_versions_after_create = true
     end
 
-    def create_operation
-      self.class.transaction do
-        yield.tap do |created|
-          deprecate_old_versions(created) if created.persisted?
+    private
+      def new_version_attrs(new_attrs)
+        attr_builder = AttributeBuilder.new(self)
+        attr_builder.attributes(new_attrs)
+      end
+
+      def deprecate_old_versions(current_version)
+        versions.exclude(current_version).update_all(is_current_version: false)
+      end
+
+      def create_operation
+        self.class.transaction do
+          yield.tap do |created|
+            deprecate_old_versions(created) if created.persisted?
+          end
         end
       end
-    end
 
-    def deprecate_old_versions_after_create?
-      @deprecate_old_versions_after_create
-    end
+      def deprecate_old_versions_after_create?
+        @deprecate_old_versions_after_create
+      end
 
-    def ensure_version_deprecation!
-      if deprecate_old_versions_after_create?
-        deprecate_old_versions(self)
+      def ensure_version_deprecation!
+        if deprecate_old_versions_after_create?
+          deprecate_old_versions(self)
+        end
       end
-    end
+  end
 end

data/lib/versioned_record/attribute_builder.rb

@@ -14,10 +14,10 @@ module VersionedRecord
     #
     # @param [Hash] new_attrs are the attributes we are changing in this version
     def attributes(new_attrs)
-      @new_attrs = new_attrs.stringify_keys
-      @record.attributes.merge(@new_attrs.merge({
+      @new_attrs = new_attrs.symbolize_keys
+      attrs = @record.attributes.symbolize_keys.merge(@new_attrs.merge({
         is_current_version: true,
-        id:                 @record.id,
+        id:                 @record.id_with_version,
         version:            @record.version + 1
       }))
     end

data/lib/versioned_record/composite_predicates.rb

@@ -0,0 +1,40 @@
+module VersionedRecord
+  module CompositePredicates
+
+    # Lets say location belongs to a company and company is versioned
+    # 
+    #     class Company < ActiveRecord::Base
+    #       include VersionedRecord
+    #       has_many :locations
+    #     end
+    #
+    #     class Location < ActiveRecord::Base
+    #       belongs_to :company
+    #     end
+    #
+    # When we want to load the company from the location we do:
+    #
+    #     location.company
+    #
+    # This will do:
+    #
+    #     Company.where(id: location.company.id, is_current_version: true)
+    #
+    # @param [Arel::Table] association_table the associated_table (in the example, company)
+    # @param [Array,String] association_key the value of the pkey of associated_table (in the example, company)
+    # @param [Arel::Table] table (in the example, location)
+    # @param [Array,String] key reference to the association
+    #
+    def cpk_join_predicate(association_table, association_key, table, key)
+      fields             = Array(key).map { |key| table[key] }
+      association_fields = Array(association_key).map { |key| association_table[key] }
+
+      if fields.size == 1
+        eq_predicates = [ association_fields[0].eq(fields[0]), association_table[:is_current_version].eq(true) ]
+        cpk_and_predicate(eq_predicates)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/versioned_record/version.rb

@@ -1,3 +1,3 @@
 module VersionedRecord
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/spec_helper.rb

@@ -5,6 +5,8 @@ Coveralls.wear!
 require 'versioned_record'
 require 'database_cleaner'
 
+require 'byebug'
+
 Dir[("./spec/support/**/*.rb")].each {|f| require f}
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration

data/spec/versions_spec.rb

@@ -10,7 +10,7 @@ describe VersionedProduct do
 
     it 'unsets current version on first version' do
       perform
-      expect(first_version.reload).to_not be_is_current_version
+      expect(VersionedProduct.find(first_version.id, 0)).to_not be_is_current_version
     end
 
     describe 'the new version' do

data/versioned_record.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: versioned_record
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dan Draper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-28 00:00:00.000000000 Z
+date: 2014-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Version ActiveRecord models using composite primary keys
 email:
 - daniel@codehire.com
@@ -155,6 +169,7 @@ files:
 - lib/versioned_record.rb
 - lib/versioned_record/attribute_builder.rb
 - lib/versioned_record/class_methods.rb
+- lib/versioned_record/composite_predicates.rb
 - lib/versioned_record/connection_adapters/postgresql.rb
 - lib/versioned_record/version.rb
 - spec/spec_helper.rb