versioned_record 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d961aed7862c149a656c89584e5e39a36eab865
-  data.tar.gz: efac3b9ce83e333511c5dba682d0ca4b238384b3
+  metadata.gz: 485621958b932f0a1c13be6a89eeb6b915434363
+  data.tar.gz: c5ffe378f6cb1d2685a4fa8db6e65028c3baf157
 SHA512:
-  metadata.gz: 496b5f7cc0c2d15098bf17b5316253f128e1a7442bb1143c7f6bfdf781586f1b5abbbe1f42b827660d3b79424a4f483089bde85114bfe50de3387f39310ed56a
-  data.tar.gz: 3ff2e0d96885ea548736e846dd77e8385c9448850affd79d8967905ff227933b7400e53d5e85b83a3bc1ffd44bc5597af6f0d4f339b7f1df740e768a4aebfd0c
+  metadata.gz: fea26e33efb1a2f4dd5f458faa26f6b74dfb19aebe1288119c4a1a90f84d2635c8d276675d82682ec19429d9958c52a6ed2637959cd89c8fb8172a8bbef29ae5
+  data.tar.gz: c4d33837fd8d60858131fdecda9268a9911f565eb86adf8d7455cfc5aeb0a1bb81731c8fefdff55c67be9fb134f05f842786581f482f01cc0882e3cc9ef7dc4d

data/README.md

@@ -72,21 +72,33 @@ Also, the `is_current_version` flag is unset for the old version and set for the
 
 ## Associations
 
-### `belongs_to` A versioned model, but references the latest version (general case)
+### Simple Belongs Too
 
-A simple `belongs_to` will work
+`belongs_to` A versioned model, but references the latest version (general case)
 
-### `belongs_to` A versioned model but references a specific version
+A simple `belongs_to` will work as normal but will always refer to the latest version of its parent.
 
-`belongs_to` must specify the `foreign_key` and primary key settings
+### Composite Belongs To
+
+`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.
 
     class Contract < ActiveRecord::Base
       include VersionedRecord
-      has_many :apprentices, :foreign_key => [:contract_id, :contract_version], primary_key: [:id, :version ]
+      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 ]
+      belongs_to :contract, {
+        foreign_key: [:contract_id, :contract_version],
+        primary_key: [ :id, version ],
+        autosave: false
+      }
     end
 
 ### `belongs_to` a non-versioned model
@@ -105,7 +117,8 @@ 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+
-* 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.)
+* Polymorphic belongs to does not work on versioned records
+* HABTM where models on _both_ sides are versioned have not been tested
 
 
 ## Author

data/lib/versioned_record/active_record_versioning.rb

@@ -0,0 +1,13 @@
+module ActiveRecord
+  class Base
+    def self.versioned?
+      false
+    end
+
+    def versioned?
+      self.class.versioned?
+    end
+  end
+end
+
+

data/lib/versioned_record/attribute_builder.rb

@@ -17,7 +17,7 @@ module VersionedRecord
       @new_attrs = new_attrs.symbolize_keys
       attrs = @record.attributes.symbolize_keys.merge(@new_attrs.merge({
         is_current_version: true,
-        id:                 @record.id_with_version,
+        id:                 @record.id,
         version:            @record.version + 1
       }))
     end

data/lib/versioned_record/attribute_methods/write.rb

@@ -0,0 +1,18 @@
+module ActiveRecord
+  module AttributeMethods
+    module Write
+      alias_method :write_attribute_original, :write_attribute
+
+      def write_attribute(attr_name, value)
+        #byebug if attr_name == 'contract_id' && Apprenticeship === self
+        # We only have a single value to set, but an array was provided
+        if !attr_name.kind_of?(Array) && value.kind_of?(Array)
+          # Use just the ID and ignore the version
+          write_attribute_original(attr_name, value[0])
+        else
+          write_attribute_original(attr_name, value)
+        end
+      end
+    end
+  end
+end

data/lib/versioned_record/class_methods.rb

@@ -1,5 +1,9 @@
 module VersionedRecord
   module ClassMethods
+    def versioned?
+      true
+    end
+
     # Scope to limit records to only the current versions
     def current_versions
       where(is_current_version: true)

data/lib/versioned_record/composite_predicates.rb

@@ -30,7 +30,28 @@ module VersionedRecord
       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) ]
+        eq_predicates = [ association_fields[0].eq(fields[0]) ]
+        case association.reflection.macro
+          when :belongs_to
+            # We don't handle Polymorphic associations at this stage
+            if !association.options[:polymorphic]
+              if association.reflection.klass.versioned?
+                eq_predicates << association_table[:is_current_version].eq(true)
+              end
+            end
+          when :has_and_belongs_to_many
+            if association.reflection.klass.versioned?
+              if association.reflection.klass.table_name == association_table.name
+                eq_predicates << association_table[:is_current_version].eq(true)
+              end
+            end
+          when :has_many, :has_one
+            if association.reflection.klass.versioned?
+              if association.reflection.klass.table_name == association_table.name
+                eq_predicates << association_table[:is_current_version].eq(true)
+              end
+            end
+        end
         cpk_and_predicate(eq_predicates)
       else
         super

data/lib/versioned_record/version.rb

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

data/lib/versioned_record.rb

@@ -6,8 +6,10 @@ require 'composite_primary_keys'
 require 'versioned_record/attribute_builder'
 require 'versioned_record/class_methods'
 require 'versioned_record/connection_adapters/postgresql'
+require 'versioned_record/attribute_methods/write'
 require 'versioned_record/version'
 require 'versioned_record/composite_predicates'
+require 'versioned_record/active_record_versioning'
 
 ActiveRecord::Associations::AssociationScope.include(VersionedRecord::CompositePredicates)
 
@@ -15,14 +17,14 @@ module VersionedRecord
   def self.included(model_class)
     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
 
   module InstanceMethods
-    def id
-      id_with_version[0]
+    # @return just the ID integer value (not the composite id, version key)
+    def _id
+      id[0]
     end
 
     # Create a new version of the existing record
@@ -82,6 +84,13 @@ module VersionedRecord
       self.class.where(id: self.id)
     end
 
+    # Retrieve the current version of an object
+    # (May be itself)
+    #
+    def current_version
+      versions.current_versions.first
+    end
+
     # Ensure that old versions are deprecated when we save
     # (only applies on create)
     def deprecate_old_versions_after_create!

data/spec/composite_belongs_to.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Sale 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
+    subject(:sale) { versioned_product.sales.create(purchaser: 'Dan Draper') }
+
+    specify 'that the sale belongs to the specific version' do
+      expect(subject.versioned_product(true)).to eq(versioned_product)
+    end
+  end
+
+  describe 'create directly' do
+    let!(:sale) { Sale.create(purchaser: 'Dan Draper', versioned_product: versioned_product_revision) }
+
+    specify 'that the comment belongs to the specific version' do
+      expect(sale.versioned_product(true)).to eq(versioned_product_revision)
+    end
+
+    context 'create another version of the parent' do
+      let!(:vp3) { versioned_product_revision.create_version!(name: 'iPad 3') }
+
+      specify 'that the comment STILL belongs to the specific version' do
+        expect(sale.versioned_product(true)).to eq(versioned_product_revision)
+      end
+    end
+  end
+end
+

data/spec/composite_onesided_habtm_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Package 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
+    subject(:package) { versioned_product.packages.create!(dimensions: '100x100') }
+
+    specify 'that the package belongs to the specific version' do
+      expect(subject.versioned_products(true).to_a).to eq([versioned_product])
+    end
+  end
+end
+

data/spec/has_one_through_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+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') }
+
+      before { versioned_product.office = office }
+
+      specify "that the office's versioned product is the latest version" do
+        expect(office.reload.versioned_product).to eq(versioned_product_revision)
+      end
+
+      specify 'that the previous version of the product has the office set after reload' do
+        expect(versioned_product.reload.office).to eq(office)
+      end
+
+      specify 'that the latest version of the product has the office set after reload' do
+        expect(versioned_product_revision.reload.office).to eq(office)
+      end
+    end
+  end
+end
+

data/spec/simple_belongs_to_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Comment 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
+    subject(:comment) { versioned_product.comments.create(content: 'Awesome') }
+
+    specify 'that the comment belongs to the latest version' do
+      expect(subject.versioned_product).to eq(versioned_product_revision)
+    end
+  end
+
+  describe 'create directly' do
+    let!(:comment) { Comment.create(content: 'Awesome', versioned_product: versioned_product) }
+
+    specify 'that the comment belongs to the latest version' do
+      expect(comment.versioned_product(true)).to eq(versioned_product_revision)
+    end
+
+    context 'create another version of the parent' do
+      let!(:vp3) { versioned_product_revision.create_version!(name: 'iPad 3') }
+
+      specify 'that the comment STILL belongs to the latest version' do
+        expect(comment.versioned_product(true)).to eq(vp3)
+      end
+    end
+  end
+end
+

data/spec/simple_onesided_habtm_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Tag do
+  let!(:versioned_product) { VersionedProduct.create(name: 'iPad', price: 100) }
+  let!(:versioned_product_revision) { versioned_product.create_version!(name: 'iPad 2') }
+
+  describe 'add a tag' do
+    let!(:tag_a) { versioned_product.tags.create(name: 'Electronics') }
+    let!(:tag_b) { versioned_product.tags.create(name: 'Consumer') }
+    
+    specify { expect(versioned_product_revision).to have(2).tags }
+    specify { expect(tag_a.versioned_products.to_a).to eq([versioned_product_revision]) }
+  end
+
+end

data/spec/spec_helper.rb

@@ -9,6 +9,8 @@ require 'byebug'
 
 Dir[("./spec/support/**/*.rb")].each {|f| require f}
 
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/spec/support/comment.rb

@@ -0,0 +1,3 @@
+class Comment < ActiveRecord::Base
+  belongs_to :versioned_product
+end

data/spec/support/company.rb

@@ -0,0 +1,3 @@
+class Company < ActiveRecord::Base
+  has_many :users
+end

data/spec/support/database.rb

@@ -4,8 +4,50 @@ ActiveRecord::Base.establish_connection(dbconfig[env]['postgresql'])
 
 ActiveRecord::Schema.define :version => 0 do
 
+  create_table :companies, force: true do |t|
+    t.string :name
+  end
+
   create_table :versioned_products, versioned: true, force: true do |t|
+    t.references :company
     t.string :name
     t.decimal :price
   end
+
+  create_table :comments, force: true do |t|
+    t.references :versioned_product
+    t.string :content
+  end
+
+  create_table :sales, force: true do |t|
+    t.references :versioned_product
+    t.integer :versioned_product_version
+    t.string :purchaser
+  end
+
+  create_table :tags, force: true do |t|
+    t.string :name
+  end
+
+  create_table :tags_versioned_products, force: true, id: false do |t|
+    t.references :versioned_product, :tag
+  end
+
+  create_table :packages, force: true do |t|
+    t.string :dimensions
+  end
+
+  create_table :packages_versioned_products, force: true, id: false do |t|
+    t.references :versioned_product, :package
+    t.integer :versioned_product_version
+  end
+
+  create_table :installations, force: true do |t|
+    t.references :versioned_product, :office
+    t.string :installed_by
+  end
+
+  create_table :offices, force: true do |t|
+    t.string :address
+  end
 end

data/spec/support/installation.rb

@@ -0,0 +1,4 @@
+class Installation < ActiveRecord::Base
+  belongs_to :versioned_product
+  belongs_to :office
+end

data/spec/support/office.rb

@@ -0,0 +1,4 @@
+class Office < ActiveRecord::Base
+  has_one :installation
+  has_one :versioned_product, through: :installation
+end

data/spec/support/package.rb

@@ -0,0 +1,6 @@
+class Package < ActiveRecord::Base
+  has_and_belongs_to_many :versioned_products, {
+    association_foreign_key: [:versioned_product_id, :versioned_product_version],
+    foreign_key: :package_id
+  }
+end

data/spec/support/sale.rb

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

data/spec/support/tag.rb

@@ -0,0 +1,3 @@
+class Tag < ActiveRecord::Base
+  has_and_belongs_to_many :versioned_products
+end

data/spec/support/versioned_product.rb

@@ -2,4 +2,31 @@ class VersionedProduct < ActiveRecord::Base
   include VersionedRecord
   validates :name, presence: true
   validates :name, length: { minimum: 2 }
+
+  belongs_to :company
+
+  # Simple Belongs To
+  has_many :comments
+
+  # Composite Belongs To
+  has_many :sales, {
+    foreign_key: [:versioned_product_id, :versioned_product_version],
+    primary_key: [:id, :version ]
+  }
+
+  # Simple HABTM
+  has_and_belongs_to_many :tags
+
+  # Composite HABTM
+  has_and_belongs_to_many :packages, {
+    foreign_key: [:versioned_product_id, :versioned_product_version],
+    association_foreign_key: :package_id
+  }
+
+  # Composite Mutual HABTM
+  # TODO location?
+
+  # Has one and has one through
+  has_one :installation
+  has_one :office, through: :installation
 end

data/spec/versions_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 describe VersionedProduct do
-  let!(:first_version) { VersionedProduct.create(name: 'iPad', price: 100) }
+  let(:company)        { Company.create(name: 'Acme Corp') }
+  let!(:first_version) { VersionedProduct.create(name: 'iPad', price: 100, company: company) }
 
   shared_examples 'successful version creation' do
     it 'creates a new version' do
@@ -10,17 +11,30 @@ describe VersionedProduct do
 
     it 'unsets current version on first version' do
       perform
-      expect(VersionedProduct.find(first_version.id, 0)).to_not be_is_current_version
+      expect(VersionedProduct.find(first_version._id, 0)).to_not be_is_current_version
+    end
+
+    describe '#current_version' do
+      let!(:old_version) { VersionedProduct.find(first_version._id, 0) }
+      let!(:new_version)  { perform }
+      specify { expect(old_version.current_version).to eq(new_version) }
     end
 
     describe 'the new version' do
       subject { perform.reload }
-      specify { expect(subject).to be_is_current_version }
-      specify { expect(subject.version).to eq(1) }
-      specify { expect(subject.name).to eq('iPad 2') }
-      specify { expect(subject.price).to eq(100) }
-      specify { expect(subject).to be_valid }
-      specify { expect(subject).to be_persisted }
+
+      specify do
+        expect(subject).to be_is_current_version
+        expect(subject).to be_valid
+        expect(subject).to be_persisted
+      end
+
+      specify do
+        expect(subject.version).to eq(1)
+        expect(subject.name).to eq('iPad 2')
+        expect(subject.price).to eq(100)
+        expect(subject.company).to eq(company)
+      end
     end
   end
 

data/versioned_record.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_runtime_dependency "activerecord", "~> 4.0.0"
-  spec.add_runtime_dependency 'composite_primary_keys', '>= 6.0.3'
+  spec.add_runtime_dependency 'composite_primary_keys', '>= 6.0.5'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: versioned_record
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Dan Draper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-30 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 6.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 6.0.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -167,14 +167,28 @@ files:
 - README.md
 - Rakefile
 - lib/versioned_record.rb
+- lib/versioned_record/active_record_versioning.rb
 - lib/versioned_record/attribute_builder.rb
+- lib/versioned_record/attribute_methods/write.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/composite_belongs_to.rb
+- spec/composite_onesided_habtm_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/database.rb
 - spec/support/database.yml
+- spec/support/installation.rb
+- spec/support/office.rb
+- spec/support/package.rb
+- spec/support/sale.rb
+- spec/support/tag.rb
 - spec/support/versioned_product.rb
 - spec/version_class_methods_spec.rb
 - spec/versions_spec.rb
@@ -204,9 +218,21 @@ signing_key:
 specification_version: 4
 summary: Version ActiveRecord models using composite primary keys
 test_files:
+- spec/composite_belongs_to.rb
+- spec/composite_onesided_habtm_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/database.rb
 - spec/support/database.yml
+- spec/support/installation.rb
+- spec/support/office.rb
+- spec/support/package.rb
+- spec/support/sale.rb
+- spec/support/tag.rb
 - spec/support/versioned_product.rb
 - spec/version_class_methods_spec.rb
 - spec/versions_spec.rb