versioned_record 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 485621958b932f0a1c13be6a89eeb6b915434363
-  data.tar.gz: c5ffe378f6cb1d2685a4fa8db6e65028c3baf157
+  metadata.gz: 922578eddd43ab7241f9508f1e2b69df72348a78
+  data.tar.gz: b6016c21345c767d7ad00c5a8ff56655ec69af9e
 SHA512:
-  metadata.gz: fea26e33efb1a2f4dd5f458faa26f6b74dfb19aebe1288119c4a1a90f84d2635c8d276675d82682ec19429d9958c52a6ed2637959cd89c8fb8172a8bbef29ae5
-  data.tar.gz: c4d33837fd8d60858131fdecda9268a9911f565eb86adf8d7455cfc5aeb0a1bb81731c8fefdff55c67be9fb134f05f842786581f482f01cc0882e3cc9ef7dc4d
+  metadata.gz: 5f45e23784fb7e5924a0baedcf5b2efdd18eb8a5eaabeb4b8c5455c77c5f434e1ebd3706125978e78276af607b37fe75cfc726c17c4db7d5c2e5ce9097d09428
+  data.tar.gz: c1558526c1ba918b7741279b90cb60b5e4312f3585a53f8e8f9c84e64abef9695dd6d2907068ce3e42f43a021dd6fd26a6956583eec80f0fe9750b97a793b7c9

data/README.md

@@ -82,22 +82,18 @@ A simple `belongs_to` will work as normal but will always refer to the latest ve
 
 `belongs_to` A versioned model but references a specific version
 
-`belongs_to` must specify the `foreign_key` and primary key settings. You should set autosave to false on the `belongs_to` for these types
-of associations.
+`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 ]
+        foreign_key: [:contract_id, :contract_version]
       }
     end
 
     class Apprentice < ActiveRecord::Base
       belongs_to :contract, {
-        foreign_key: [:contract_id, :contract_version],
-        primary_key: [ :id, version ],
-        autosave: false
+        foreign_key: [:contract_id, :contract_version]
       }
     end
 

data/lib/versioned_record/version.rb

@@ -1,3 +1,3 @@
 module VersionedRecord
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/versioned_record.rb

@@ -70,7 +70,8 @@ module VersionedRecord
     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
+        preserve_has_one_associations_to(built) 
+     end
     end
 
     # Retrieve all versions of this record
@@ -124,5 +125,26 @@ module VersionedRecord
           deprecate_old_versions(self)
         end
       end
+
+      # This is required because a new version which has not been persisted
+      # to the database breaks the normal ActiveRecord paradigm.
+      # Because normally when a record has not yet been persisted
+      # it can have no persisted has_one associations because there is no foriegn key.
+      # In our case we have a foreign key because it was determined from the
+      # previous version.
+      #
+      # This doesn't apply to composite has_one associations because they will
+      # use a different foreign key to the parent version.
+      #
+      def preserve_has_one_associations_to(new_version)
+        # Preserve simple has_one reflections
+        self.class.reflections.select { |_, reflection|
+          reflection.macro == :has_one
+        }.each do |key, reflection|
+          if !reflection.foreign_key.kind_of?(Array)
+            new_version.send("#{key}=", self.send(key))
+          end
+        end
+      end
   end
 end

data/spec/association_preservation_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe VersionedProduct do
+  # TODO: This might be a sep spec as well!
+  describe 'preservation across versioning' do
+    let(:installation) { Installation.create(installed_by: 'Sean Connery') }
+    let(:container)    { Container.create(name: 'A Container') }
+
+    let!(:versioned_product) do
+      VersionedProduct.create(
+        name: 'iPad',
+        price: 100,
+        installation: installation,
+        container: container
+      )
+    end
+
+    let!(:comment) { versioned_product.comments.create(content: 'Foo') }
+
+    specify 'the versioned product has its associations set' do
+      versioned_product.reload
+      expect(versioned_product.installation).to eq(installation)
+      expect(versioned_product.container).to eq(container)
+      expect(versioned_product).to have(1).comment
+    end
+
+    describe 'build a new version of the product' do
+      let(:new_version) { versioned_product.build_version }
+      
+      specify 'that the installation is still set' do
+        expect(new_version.installation).to eq(installation)
+      end
+
+      specify 'that the container is NOT set (because its a composite relationship)' do
+        expect(new_version.container).to be_nil
+      end
+
+      specify 'thet the comments are still set' do
+        expect(new_version.comments).to include(comment)
+        expect(new_version).to have(1).comment
+      end
+    end
+
+    describe 'create a new version of the product' do
+      let(:new_version) { versioned_product.create_version }
+      
+      specify 'that the installation is still set' do
+        expect(new_version.installation).to eq(installation)
+      end
+
+      specify 'thet the comments are still set' do
+        expect(new_version.comments).to include(comment)
+        expect(new_version).to have(1).comment
+      end
+    end
+  end
+end

data/spec/has_one_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe VersionedProduct do
+  describe 'installation' do
+    let!(:versioned_product) { VersionedProduct.create(name: 'iPad', price: 100) }
+    let!(:versioned_product_revision) { versioned_product.create_version!(name: 'iPad 2') }
+
+    describe 'creation via association' do
+      let!(:installation) { versioned_product.create_installation!(installed_by: 'Roger Moore') }
+
+      specify 'that the installation belongs to the latest version' do
+        expect(installation.versioned_product).to eq(versioned_product_revision)
+      end
+
+      specify 'that the latest version of the product has the installation set after reload' do
+        expect(versioned_product_revision.reload.installation).to eq(installation)
+      end
+
+      specify 'that the previous version of the product has the installation set after reload' do
+        expect(versioned_product.reload.installation).to eq(installation)
+      end
+    end
+
+    describe 'direct creation' do
+      let(:installation) { Installation.new(installed_by: 'Sean Connery') }
+      subject { VersionedProduct.create(name: 'iPad', price: 100, installation: installation) }
+
+      specify 'that the installation is set and persisted' do
+        expect(subject.reload.installation).to eq(installation)
+      end
+    end
+
+    describe 'simple test' do
+      let(:installation) { Installation.new(installed_by: 'Sean Connery') }
+      subject { Office.create(address: 'CQ Sydney', installation: installation) }
+
+      specify 'that the installation is set and persisted' do
+        expect(subject.reload.installation).to eq(installation)
+      end
+    end
+  end
+end

data/spec/has_one_through_spec.rb

@@ -4,44 +4,6 @@ describe VersionedProduct do
   let!(:versioned_product) { VersionedProduct.create(name: 'iPad', price: 100) }
   let!(:versioned_product_revision) { versioned_product.create_version!(name: 'iPad 2') }
 
-  # TODO: This maybe should go into a different spec
-  describe 'installation' do
-    describe 'creation via association' do
-      let!(:installation) { versioned_product.create_installation!(installed_by: 'Roger Moore') }
-
-      specify 'that the installation belongs to the latest version' do
-        expect(installation.versioned_product).to eq(versioned_product_revision)
-      end
-
-      specify 'that the latest version of the product has the installation set after reload' do
-        expect(versioned_product_revision.reload.installation).to eq(installation)
-      end
-
-      specify 'that the previous version of the product has the installation set after reload' do
-        expect(versioned_product.reload.installation).to eq(installation)
-      end
-    end
-
-    describe 'direct creation' do
-      let(:installation) { Installation.new(installed_by: 'Sean Connery') }
-      subject { VersionedProduct.create(name: 'iPad', price: 100, installation: installation) }
-
-      specify 'that the installation is set and persisted' do
-        expect(subject.reload.installation).to eq(installation)
-      end
-    end
-
-    describe 'simple test' do
-      let(:installation) { Installation.new(installed_by: 'Sean Connery') }
-      subject { Office.create(address: 'CQ Sydney', installation: installation) }
-
-      specify 'that the installation is set and persisted' do
-        expect(subject.reload.installation).to eq(installation)
-      end
-
-    end
-  end
-
   describe 'office' do
     describe 'creation via association' do
       let!(:office) { Office.create!(address: 'Circular Quay, Sydney') }

data/spec/support/container.rb

@@ -0,0 +1,7 @@
+class Container < ActiveRecord::Base
+  include VersionedRecord
+
+  belongs_to :versioned_product, {
+    foreign_key: [:versioned_product_id, :versioned_product_version],
+  }
+end

data/spec/support/database.rb

@@ -50,4 +50,10 @@ ActiveRecord::Schema.define :version => 0 do
   create_table :offices, force: true do |t|
     t.string :address
   end
+
+  create_table :containers, versioned: true, force: true do |t|
+    t.references :versioned_product
+    t.integer :versioned_product_version
+    t.string :name
+  end
 end

data/spec/support/sale.rb

@@ -1,7 +1,6 @@
 class Sale < ActiveRecord::Base
   belongs_to :versioned_product, {
     foreign_key: [:versioned_product_id, :versioned_product_version],
-    primary_key: [:id, :version ],
-    autosave: false
+    autosave: true
   }
 end

data/spec/support/versioned_product.rb

@@ -8,10 +8,9 @@ class VersionedProduct < ActiveRecord::Base
   # Simple Belongs To
   has_many :comments
 
-  # Composite Belongs To
+  # Composite has many
   has_many :sales, {
-    foreign_key: [:versioned_product_id, :versioned_product_version],
-    primary_key: [:id, :version ]
+    foreign_key: [:versioned_product_id, :versioned_product_version]
   }
 
   # Simple HABTM
@@ -29,4 +28,9 @@ class VersionedProduct < ActiveRecord::Base
   # Has one and has one through
   has_one :installation
   has_one :office, through: :installation
+
+  # Composite has_one
+  has_one :container, {
+    foreign_key: [:versioned_product_id, :versioned_product_version]
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: versioned_record
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Dan Draper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -174,14 +174,17 @@ files:
 - lib/versioned_record/composite_predicates.rb
 - lib/versioned_record/connection_adapters/postgresql.rb
 - lib/versioned_record/version.rb
+- spec/association_preservation_spec.rb
 - spec/composite_belongs_to.rb
 - spec/composite_onesided_habtm_spec.rb
+- spec/has_one_spec.rb
 - spec/has_one_through_spec.rb
 - spec/simple_belongs_to_spec.rb
 - spec/simple_onesided_habtm_spec.rb
 - spec/spec_helper.rb
 - spec/support/comment.rb
 - spec/support/company.rb
+- spec/support/container.rb
 - spec/support/database.rb
 - spec/support/database.yml
 - spec/support/installation.rb
@@ -218,14 +221,17 @@ signing_key:
 specification_version: 4
 summary: Version ActiveRecord models using composite primary keys
 test_files:
+- spec/association_preservation_spec.rb
 - spec/composite_belongs_to.rb
 - spec/composite_onesided_habtm_spec.rb
+- spec/has_one_spec.rb
 - spec/has_one_through_spec.rb
 - spec/simple_belongs_to_spec.rb
 - spec/simple_onesided_habtm_spec.rb
 - spec/spec_helper.rb
 - spec/support/comment.rb
 - spec/support/company.rb
+- spec/support/container.rb
 - spec/support/database.rb
 - spec/support/database.yml
 - spec/support/installation.rb