active_type 1.10.1 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69b64cf59cc14b34fae5a6ce26172b11e4877f763e5b2aef834004e66d697f8c
-  data.tar.gz: b446e1c689241ff6f4b96494a29e7b05347e6962322c3eda37c4cf01647a125e
+  metadata.gz: b0d4c00a8c504822572083cb1a051ff4582c5e0638bc4eca0f064df38f175b2e
+  data.tar.gz: b38c8570c9ecf88d267ae7f6e46bd1773c5658494a329b6ae00de114ce274d01
 SHA512:
-  metadata.gz: c9a257cb54508547e77592691c58193cf287866e32f51243a09b6300b58f78fe559ed8d6410d550906753cb850220178c23d35a5727850f23f7dad10f77e8b4f
-  data.tar.gz: ac3a81f9655a783fa15e928ee42c2d4a01ff04ff576f5709a7e862a99a2fdb2db1ca3107f50f1882ec57392f28cf23a25dfae57b0ecc3944d9da015edc7b4d3b
+  metadata.gz: 925a22fc4566431fc6fa4c3a22cdb86d2889e2c6066ece8a652b98fc8b2a81267c3c4221dc3429bbae7cc34bf9a14534d75b6f0e286c78b95909e581a27e840b
+  data.tar.gz: '097eafa44f1c006d76185d0e697bcca2072e820e019c84327432e18d4bf767925f69b988c468a82978fc5cfcfe2a21751b714dd2914adbcc94065ca70aba4a09'

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased changes
 
+## 2.0.0 (2021-11-24)
+
+* Added: Casting is prevented when the base record has changes in its already loaded associations, because those would be lost. Option `force: true` can be used to override this and still do the cast (this is not recommended).
+* Added: After casting, the base record will not be usable any more. The base record and the newly created casted record share state which is unexpected. Option `force: true` can be used to override this, so the base record is still usable (this is not recommended).
+
 ## 1.10.1 (2021-10-19)
 
 * Removed: When casting an unsaved record, the new record will no longer have the same associations as the base record. This was introduced with version 1.8.0 and lead to issues (#147 and #148). Therefore the change was rolled back.

data/Gemfile.4.2.mysql2.lock

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

data/Gemfile.4.2.pg.lock

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

data/Gemfile.4.2.sqlite3.lock

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

data/Gemfile.5.2.mysql2.lock

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

data/Gemfile.5.2.pg.lock

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

data/Gemfile.5.2.sqlite3.lock

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

data/Gemfile.6.0.sqlite3.lock

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

data/Gemfile.6.1.pg.lock

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

data/Gemfile.6.1.sqlite3.lock

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

data/README.md

@@ -364,8 +364,10 @@ 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.
 
 **Note that `cast` is destructive.** The originally casted record (`user`) and the returned record (`sign_up`)
-share internal state (such as attributes). To avoid unexpected behavior, do not use the original record
-after casting it.
+share internal state (such as attributes). To avoid unexpected behavior, the original record will raise an error when trying to change or persist it. Also, casting of a record that has changes in its loaded associations is prevented, because those changes would be lost.  
+If you know what you are doing and absolutely want that, you may use the option `force: true` to allow this potentially problematic behaviour, e.g. `sign_up = ActiveType.cast(user, SignUp, force: true)`
+
+
 
 You can also cast an entire relation (scope) to a relation of an `ActiveType::Record`:
 

data/lib/active_type/mutation_after_cast_error.rb

@@ -0,0 +1,6 @@
+module ActiveType
+
+  class MutationAfterCastError < StandardError
+  end
+
+end

data/lib/active_type/not_castable_error.rb

@@ -0,0 +1,6 @@
+module ActiveType
+
+  class NotCastableError < StandardError
+  end
+
+end

data/lib/active_type/util/unmutable_attributes.rb

@@ -0,0 +1,32 @@
+require 'active_type/mutation_after_cast_error'
+
+module ActiveType
+  module Util
+
+    # This object is used as a substitute for a record's @attributes.
+    # Reading from the original @attributes is still allowed, to enable
+    # `#inspect` and similar functions.
+    # But the @attributes can no longer be mutated and will raise instead.
+    class UnmutableAttributes
+
+      attr_reader :original_attributes
+
+      def initialize(attributes)
+        @original_attributes = attributes
+      end
+
+      def fetch_value(key)
+        original_attributes.fetch_value(key)
+      end
+
+      def key?(key)
+        original_attributes.key?(key)
+      end
+
+      def method_missing(*args)
+        raise MutationAfterCastError, 'Changing a record that has been used to create an ActiveType::Record could have unexpected side effects!'
+      end
+
+    end
+  end
+end

data/lib/active_type/util.rb

@@ -1,11 +1,14 @@
+require 'active_type/not_castable_error'
+require 'active_type/util/unmutable_attributes'
+
 module ActiveType
   module Util
 
-    def cast(object, klass)
+    def cast(object, klass, force: false)
       if object.is_a?(ActiveRecord::Relation)
         cast_relation(object, klass)
       elsif object.is_a?(ActiveRecord::Base)
-        cast_record(object, klass)
+        cast_record(object, klass, force: force)
       else
         raise ArgumentError, "Don't know how to cast #{object.inspect}"
       end
@@ -17,7 +20,11 @@ module ActiveType
 
     private
 
-    def cast_record(record, klass)
+    def cast_record(record, klass, force: false)
+      if associations_touched?(record) && !force
+        raise NotCastableError, 'Record has changes in its loaded associations!'
+      end
+
       # record.becomes(klass).dup
       klass.new do |casted|
         using_single_table_inheritance = using_single_table_inheritance?(klass, casted)
@@ -48,6 +55,11 @@ module ActiveType
         casted.instance_variable_set(:@errors, errors)
 
         casted[klass.inheritance_column] = klass.sti_name if using_single_table_inheritance
+
+        if !force
+          make_record_unusable(record)
+        end
+        casted
       end
     end
 
@@ -61,6 +73,23 @@ module ActiveType
       scoped(klass).merge(scoped(relation))
     end
 
+    def associations_touched?(record)
+      return false unless record.instance_variable_get(:@association_cache)
+
+      !!record.instance_variable_get(:@association_cache)[:associated_records]&.target&.any? do |target|
+        target.changed?
+      end
+    end
+
+    def make_record_unusable(record)
+      # Changing and saving the base record may lead to unexpected behaviour,
+      # since the casted record may have different changes in its autosave
+      # associations and will be saved to the same record in the database as
+      # the casted record. Therefore we prevent that.
+      original_attributes = record.instance_variable_get(:@attributes)
+      record.instance_variable_set(:@attributes, UnmutableAttributes.new(original_attributes) )
+    end
+
     extend self
 
   end

data/lib/active_type/version.rb

@@ -1,3 +1,3 @@
 module ActiveType
-  VERSION = '1.10.1'
+  VERSION = '2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_type
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: '2.0'
 platform: ruby
 authors:
 - Tobias Kraze
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,18 +90,21 @@ files:
 - active_type.gemspec
 - lib/active_type.rb
 - lib/active_type/change_association.rb
+- lib/active_type/mutation_after_cast_error.rb
 - lib/active_type/nested_attributes.rb
 - lib/active_type/nested_attributes/association.rb
 - lib/active_type/nested_attributes/builder.rb
 - lib/active_type/nested_attributes/nests_many_association.rb
 - lib/active_type/nested_attributes/nests_one_association.rb
 - lib/active_type/no_table.rb
+- lib/active_type/not_castable_error.rb
 - lib/active_type/object.rb
 - lib/active_type/record.rb
 - lib/active_type/record_extension.rb
 - lib/active_type/record_extension/inheritance.rb
 - lib/active_type/type_caster.rb
 - lib/active_type/util.rb
+- lib/active_type/util/unmutable_attributes.rb
 - lib/active_type/version.rb
 - lib/active_type/virtual_attributes.rb
 homepage: https://github.com/makandra/active_type
@@ -123,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Make any Ruby object quack like ActiveRecord