active_type 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36a9d94011bdc8c1f856f86a6e8727c486a5c913
-  data.tar.gz: 4519e88999647fdfa0010d316c93a74121e3e713
+  metadata.gz: af57ff59af07cfdb0a8576c733da8aa2d0e254ce
+  data.tar.gz: e1e04618118baf2b5260e20ed3685d695930e756
 SHA512:
-  metadata.gz: 73db269866a0b4cfc512636679733ea14e9c4d5b1130804b305eec33a771dace04ef08a31c91637c9e0a97a79b8b878a8d8be519eceded9a1b43492d49b7bfd9
-  data.tar.gz: daacc8590bd0afd465eafdb0cca1967c4a8612a34180587d9e20cc65831b39456753ddba149c3e42d2d92708f047f6b2e4d1edf2d7c588ec7c98a0252e2f77a2
+  metadata.gz: 91477402f2df135aa9a2bef4a3b63f51c113be820940f83c350230af27b76dcc3c16d587c11874bd64320e1115f68b8fb25c7904e9d6579e3313853fddb8ad08
+  data.tar.gz: 7f9fa15fc5ed489c5bee1350f07b97852e32732017c4bb0535d53f4e3fb36c928f20bb9b44dcb5ab6f1ebce5cb892a60e3c382e5e92044e38ef51c823409fb7b

data/README.md

@@ -271,6 +271,39 @@ Supported options for `nests_many` / `nests_one` are:
   ```
 
 
+Casting
+-------
+
+When working with ActiveType you will often find it useful to cast an ActiveRecord instance to its extended `ActiveType::Record` variant.
+
+Use `ActiveType.cast` for this:
+
+```
+class User < ActiveRecord::Base
+  ...
+end
+
+class SignUp < ActiveType::Record[User]
+  ...
+end
+
+user = User.find(1)
+sign_up = ActiveType.cast(SignUp)
+sign_up.is_a?(SignUp) # => true
+```
+
+This is basically like [`ActiveRecord#becomes`](http://apidock.com/rails/v4.2.1/ActiveRecord/Persistence/becomes), but with less bugs and more consistent behavior.
+
+You can also cast an entire relation (scope) to a relation of an `ActiveType::Record`:
+
+```
+adult_users = User.where('age >= 18')
+adult_sign_ups = ActiveType.cast(adult_users, SignUp)
+sign_up = adult_sign_ups.find(1)
+sign_up.is_a?(SignUp) # => true
+```
+
+
 Supported Rails versions
 ------------------------
 

data/gemfiles/Gemfile.3.2.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    active_type (0.3.4)
+    active_type (0.4.0)
       activerecord (>= 3.2)
 
 GEM

data/gemfiles/Gemfile.4.0.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    active_type (0.3.4)
+    active_type (0.4.0)
       activerecord (>= 3.2)
 
 GEM

data/gemfiles/Gemfile.4.1.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    active_type (0.3.4)
+    active_type (0.4.0)
       activerecord (>= 3.2)
 
 GEM

data/gemfiles/Gemfile.4.2.1.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    active_type (0.3.4)
+    active_type (0.4.0)
       activerecord (>= 3.2)
 
 GEM

data/gemfiles/Gemfile.4.2.1.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    active_type (0.3.4)
+    active_type (0.4.0)
       activerecord (>= 3.2)
 
 GEM

data/lib/active_type/util.rb

@@ -0,0 +1,49 @@
+module ActiveType
+  module Util
+
+    def cast(object, klass)
+      if object.is_a?(ActiveRecord::Relation)
+        cast_relation(object, klass)
+      elsif object.is_a?(ActiveRecord::Base)
+        cast_record(object, klass)
+      else
+        raise ArgumentError, "Don't know how to cast #{object.inspect}"
+      end
+    end
+
+    def scoped(klass_or_relation)
+      klass_or_relation.where(nil)
+    end
+
+    private
+
+    def cast_record(record, klass)
+      # record.becomes(klass).dup
+      klass.new do |casted|
+        # Rails 3.2, 4.2
+        casted.instance_variable_set(:@attributes, record.instance_variable_get(:@attributes))
+        # Rails 3.2
+        record.instance_variable_set(:@attributes_cache, record.instance_variable_get(:@attributes_cache))
+        # Rails 4.2
+        casted.instance_variable_set(:@changed_attributes, record.instance_variable_get(:@changed_attributes))
+        # Rails 3.2, 4.2
+        casted.instance_variable_set(:@new_record, record.new_record?)
+        # Rails 3.2, 4.2
+        casted.instance_variable_set(:@destroyed, record.destroyed?)
+        # Rails 3.2, 4.2
+        casted.instance_variable_set(:@errors, record.errors)
+      end
+    end
+
+    def cast_relation(relation, klass)
+      scoped(klass).merge(scoped(relation))
+    end
+
+    extend self
+
+  end
+
+  # Make Util methods available under the `ActiveType` namespace
+  # like `ActiveType.cast(...)`
+  extend Util
+end

data/lib/active_type/version.rb

@@ -1,3 +1,3 @@
 module ActiveType
-  VERSION = '0.3.5'
+  VERSION = '0.4.0'
 end

data/lib/active_type.rb

@@ -2,6 +2,7 @@
 
 require 'active_type/version'
 require 'active_record'
+require 'active_type/util'
 require 'active_type/record'
 require 'active_type/object'
 
@@ -10,4 +11,4 @@ if ActiveRecord::VERSION::STRING == '4.2.0'
     ActiveType is not compatible with ActiveRecord 4.2.0. Please upgrade to 4.2.1
     For details see https://github.com/makandra/active_type/issues/31
   MESSAGE
-end
+end

data/spec/active_type/util_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+module UtilSpec
+
+  class BaseRecord < ActiveRecord::Base
+    self.table_name = 'records'
+  end
+
+  class ExtendedRecord < ActiveType::Record[BaseRecord]
+
+    attribute :virtual_string
+    after_initialize :set_virtual_string
+
+    def set_virtual_string
+      self.virtual_string = "persisted_string is #{persisted_string}"
+    end
+
+  end
+
+  class Parent < ActiveRecord::Base
+    self.table_name = 'sti_records'
+  end
+
+  class Child < Parent
+  end
+
+  class ChildSibling < Parent
+  end
+
+  class ExtendedChild < ActiveType::Record[Child]
+  end
+
+end
+
+describe ActiveType::Util do
+  
+  describe '.cast' do
+
+    describe 'for a relation' do
+    
+      it 'casts a scope to a scope of another class' do
+        record = UtilSpec::BaseRecord.create!(persisted_string: 'foo')
+        base_scope = UtilSpec::BaseRecord.where(persisted_string: 'foo')
+        casted_scope = ActiveType::Util.cast(base_scope, UtilSpec::ExtendedRecord)
+        casted_scope.build.should be_a(UtilSpec::ExtendedRecord)
+        found_record = casted_scope.find(record.id)
+        found_record.persisted_string.should == 'foo'
+        found_record.should be_a(UtilSpec::ExtendedRecord)
+      end
+
+      it 'preserves existing scope conditions' do
+        match = UtilSpec::BaseRecord.create!(persisted_string: 'foo')
+        no_match = UtilSpec::BaseRecord.create!(persisted_string: 'bar')
+        base_scope = UtilSpec::BaseRecord.where(persisted_string: 'foo')
+        casted_scope = ActiveType::Util.cast(base_scope, UtilSpec::ExtendedRecord)
+        casted_match = UtilSpec::ExtendedRecord.find(match.id)
+        casted_scope.to_a.should == [casted_match]
+      end
+
+    end
+
+    describe 'for a record type' do
+
+      it 'casts a base record to an extended record' do
+        base_record = UtilSpec::BaseRecord.create!(persisted_string: 'foo')
+        extended_record = ActiveType::Util.cast(base_record, UtilSpec::ExtendedRecord)
+        extended_record.should be_a(UtilSpec::ExtendedRecord)
+        extended_record.should be_persisted
+        extended_record.id.should be_present
+        extended_record.id.should == base_record.id
+        extended_record.persisted_string.should == 'foo'
+      end
+
+      it 'casts an extended record to a base record' do
+        extended_record = UtilSpec::ExtendedRecord.create!(persisted_string: 'foo')
+        base_record = ActiveType::Util.cast(extended_record, UtilSpec::BaseRecord)
+        base_record.should be_a(UtilSpec::BaseRecord)
+        base_record.should be_persisted
+        base_record.id.should be_present
+        base_record.id.should == extended_record.id
+        base_record.persisted_string.should == 'foo'
+      end
+
+      it 'calls after_initialize callbacks of the cast target' do
+        base_record = UtilSpec::BaseRecord.create!(persisted_string: 'foo')
+        extended_record = ActiveType::Util.cast(base_record, UtilSpec::ExtendedRecord)
+        extended_record.virtual_string.should be_present
+      end
+
+      it 'lets after_initialize callbacks access attributes (bug in ActiveRecord#becomes)' do
+        base_record = UtilSpec::BaseRecord.create!(persisted_string: 'foo')
+        extended_record = ActiveType::Util.cast(base_record, UtilSpec::ExtendedRecord)
+        extended_record.virtual_string.should == 'persisted_string is foo'
+      end
+
+      it 'preserves the #type of an STI record that is casted to an ExtendedRecord' do
+        child_record = UtilSpec::Child.create!(persisted_string: 'foo')
+        extended_child_record = ActiveType::Util.cast(child_record, UtilSpec::ExtendedChild)
+        extended_child_record.should be_a(UtilSpec::ExtendedChild)
+        extended_child_record.type.should == 'UtilSpec::Child'
+      end
+
+      it 'changes the #type of an STI record when casted to another type in the hierarchy' do
+        child_record = UtilSpec::Child.create!(persisted_string: 'foo')
+        child_sibling_record = ActiveType::Util.cast(child_record, UtilSpec::ChildSibling)
+        child_sibling_record.should be_a(UtilSpec::ChildSibling)
+        child_sibling_record.type.should == 'UtilSpec::Child'
+      end
+
+      it 'preserves dirty tracking flags' do
+        base_record = UtilSpec::BaseRecord.create!(persisted_string: 'foo')
+        base_record.changes.should == {}
+        base_record.persisted_string = 'bar'
+        base_record.changes.should == { 'persisted_string' => ['foo', 'bar'] }
+        extended_record = ActiveType::Util.cast(base_record, UtilSpec::ExtendedRecord)
+        extended_record.should be_a(UtilSpec::ExtendedRecord)
+        extended_record.changes.should == { 'persisted_string' => ['foo', 'bar'] }
+      end
+
+    end
+
+  end
+
+  it "exposes all methods through ActiveType's root namespace" do
+    ActiveType.should respond_to(:cast)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_type
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Tobias Kraze
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ files:
 - lib/active_type/object.rb
 - lib/active_type/record.rb
 - lib/active_type/type_caster.rb
+- lib/active_type/util.rb
 - lib/active_type/version.rb
 - lib/active_type/virtual_attributes.rb
 - spec/active_type/extended_record/single_table_inheritance_spec.rb
@@ -95,6 +96,7 @@ files:
 - spec/active_type/nested_attributes_spec.rb
 - spec/active_type/object_spec.rb
 - spec/active_type/record_spec.rb
+- spec/active_type/util_spec.rb
 - spec/integration/holidays_spec.rb
 - spec/integration/shape_spec.rb
 - spec/integration/sign_in_spec.rb
@@ -142,6 +144,7 @@ test_files:
 - spec/active_type/nested_attributes_spec.rb
 - spec/active_type/object_spec.rb
 - spec/active_type/record_spec.rb
+- spec/active_type/util_spec.rb
 - spec/integration/holidays_spec.rb
 - spec/integration/shape_spec.rb
 - spec/integration/sign_in_spec.rb