active_type 1.10.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd315f906e03d147dd627c8d3ba906f272ab449fc1a4b9575c4d5e693659f459
-  data.tar.gz: 473332af36c476e5126f22918fa6d2ad0fcc77ff5fa74d2623d3cf161ea3a79b
+  metadata.gz: b0a5d8d33884c5002323fee2411daea972323f973b14f885ea5b3c6336569f8f
+  data.tar.gz: 4b29935992035498d74b4c4d80c1041e17adc890234f81357828fe71e723288d
 SHA512:
-  metadata.gz: 5c52be3d4270400c51f926c16b25b0b208eafa1484b4c1f5e2393d5d16b049389ff98e6b9e82815b8cbfe7f0153ae113e8af1dcd2fe3c6224946ad7ef24ddd3c
-  data.tar.gz: 96c02ce9e42ef02dbabca4e3b9402c4fcf6a4cf5e774303f77daa4697f692e0d0b25f39ee090175586ded4a01e8c8ca37acbea5a5b249d8095b0a1ed5b5638ba
+  metadata.gz: a853c942d84f065a4f1be9fad10801f635f5d759bbb969bc655d2160d0e9757f579147f0197f52af0335eb412e1cea164a78eff56ce6747f9ca36a2340fdb36f
+  data.tar.gz: b91df99ae7b73ee3702d05b9d70bcde4a45623054293cc3ccbcedd3d6c83c22a5ac2261ca140730fd5afd3299c96ad71b275102a0ac5612260e0d5771cc11f8d

data/.github/workflows/test.yml

@@ -2,9 +2,9 @@ name: Tests
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   test_sqlite:
@@ -28,16 +28,22 @@ jobs:
             gemfile: Gemfile.6.0.sqlite3
           - ruby: "2.6.3"
             gemfile: Gemfile.6.1.sqlite3
-          - ruby: "2.7.2"
+          - ruby: "2.6.3"
+            gemfile: Gemfile.7.0.sqlite3
+          - ruby: "2.7.4"
             gemfile: Gemfile.5.2.sqlite3
-          - ruby: "2.7.2"
+          - ruby: "2.7.4"
             gemfile: Gemfile.6.0.sqlite3
-          - ruby: "2.7.2"
+          - ruby: "2.7.4"
             gemfile: Gemfile.6.1.sqlite3
+          - ruby: "2.7.4"
+            gemfile: Gemfile.7.0.sqlite3
           - ruby: "3.0.1"
             gemfile: Gemfile.6.0.sqlite3
           - ruby: "3.0.1"
             gemfile: Gemfile.6.1.sqlite3
+          - ruby: "3.0.1"
+            gemfile: Gemfile.7.0.sqlite3
 
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
@@ -50,12 +56,11 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
       - name: Bundle
         run: |
-          gem install bundler:2.0.2
+          gem install bundler:2.2.27
           bundle install --no-deployment
       - name: Run tests
         run: bundle exec rake spec
 
-
   test_mysql:
     runs-on: ubuntu-20.04
 
@@ -65,7 +70,7 @@ jobs:
         env:
           MYSQL_ROOT_PASSWORD: password
         ports:
-        - 3306:3306
+          - 3306:3306
         options: >-
           --health-cmd="mysqladmin ping"
           --health-interval=10s
@@ -80,7 +85,7 @@ jobs:
             gemfile: Gemfile.4.2.mysql2
           - ruby: "2.6.3"
             gemfile: Gemfile.5.2.mysql2
-          - ruby: "2.7.2"
+          - ruby: "2.7.4"
             gemfile: Gemfile.5.2.mysql2
 
     env:
@@ -95,10 +100,10 @@ jobs:
       - name: Install database client
         run: |
           sudo apt-get update
-          sudo apt-get install -y mysql-client libmariadbclient-dev
+          sudo apt-get install -y mariadb-client libmariadbclient-dev
       - name: Bundle
         run: |
-          gem install bundler:2.0.2
+          gem install bundler:2.2.27
           bundle install --no-deployment
       - name: Setup databases
         run: |
@@ -106,7 +111,6 @@ jobs:
       - name: Run tests
         run: bundle exec rake spec
 
-
   test_pg:
     runs-on: ubuntu-20.04
 
@@ -137,12 +141,16 @@ jobs:
             gemfile: Gemfile.5.2.pg
           - ruby: "2.6.3"
             gemfile: Gemfile.6.1.pg
-          - ruby: "2.7.2"
+          - ruby: "2.7.4"
             gemfile: Gemfile.5.2.pg
-          - ruby: "2.7.2"
+          - ruby: "2.7.4"
             gemfile: Gemfile.6.1.pg
+          - ruby: "2.7.4"
+            gemfile: Gemfile.7.0.pg
           - ruby: "3.0.1"
             gemfile: Gemfile.6.1.pg
+          - ruby: "3.0.1"
+            gemfile: Gemfile.7.0.pg
 
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
@@ -158,7 +166,7 @@ jobs:
           sudo apt-get install -y postgresql-client
       - name: Bundle
         run: |
-          gem install bundler:2.0.2
+          gem install bundler:2.2.27
           bundle install --no-deployment
       - name: Setup databases
         run: |

data/.ruby-version

@@ -1 +1 @@
-2.3.8
+2.7.4

data/CHANGELOG.md

@@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased changes
 
+## 2.1.1 (2021-12-22)
+
+* Fixed: Ruby compiler warning and suboptimal attribut name validation. Thanks to @remofrizsche.
+
+## 2.1.0 (2021-12-22)
+
+* Fixed: ActiveType now works for Rails 7.
+
+## 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.
+
 ## 1.10.0 (2021-08-11)
 
 * Removed: Tests for Ruby 2.4 and ActiveRecord 3.2.

data/Gemfile.4.2.mysql2.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_type (1.10.0)
+    active_type (2.1.1)
       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.1.1)
       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.1.1)
       activerecord (>= 3.2)
 
 GEM

data/Gemfile.5.2.mysql2.lock

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

data/Gemfile.5.2.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_type (1.10.0)
+    active_type (2.1.1)
       activerecord (>= 3.2)
 
 GEM
@@ -56,4 +56,4 @@ DEPENDENCIES
   rspec (~> 3.4)
 
 BUNDLED WITH
-   2.2.16
+   2.2.27

data/Gemfile.5.2.sqlite3.lock

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

data/Gemfile.6.0.sqlite3.lock

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

data/Gemfile.6.1.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_type (1.10.0)
+    active_type (2.1.1)
       activerecord (>= 3.2)
 
 GEM
@@ -44,6 +44,7 @@ GEM
     zeitwerk (2.4.2)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

data/Gemfile.6.1.sqlite3.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_type (1.10.0)
+    active_type (2.1.1)
       activerecord (>= 3.2)
 
 GEM
@@ -44,6 +44,7 @@ GEM
     zeitwerk (2.4.2)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

data/Gemfile.7.0.pg

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~>6.1.0'
+gem 'rspec', '~>3.4'
+gem 'pg'
+gem 'rake'
+gem 'gemika'
+
+gem 'active_type', :path => '.'

data/Gemfile.7.0.pg.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    active_type (2.1.1)
+      activerecord (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4.4)
+      activesupport (= 6.1.4.4)
+    activerecord (6.1.4.4)
+      activemodel (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
+    activesupport (6.1.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    gemika (0.6.1)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    pg (1.2.3)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_type!
+  activerecord (~> 6.1.0)
+  gemika
+  pg
+  rake
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   2.1.4

data/Gemfile.7.0.sqlite3

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~>6.1.0'
+gem 'rspec', '~>3.4'
+gem 'sqlite3'
+gem 'rake'
+gem 'gemika'
+
+gem 'active_type', :path => '.'

data/Gemfile.7.0.sqlite3.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    active_type (2.1.1)
+      activerecord (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4.4)
+      activesupport (= 6.1.4.4)
+    activerecord (6.1.4.4)
+      activemodel (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
+    activesupport (6.1.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    gemika (0.6.1)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    sqlite3 (1.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_type!
+  activerecord (~> 6.1.0)
+  gemika
+  rake
+  rspec (~> 3.4)
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -53,7 +53,7 @@ end
 
 ### A note on Rails 5+
 
-Rails 5 comes with its own implementation of `.attribute`. This implementation is functionally very
+Rails 5+ comes with its own implementation of `.attribute`. This implementation is functionally very
 similar, but not identical to ActiveType's.
 
 We have decided to continue to use our own implementation. This means that if you use ActiveType, `ActiveRecord::Base.attribute` will be overriden.
@@ -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/active_type.gemspec

@@ -10,16 +10,17 @@ Gem::Specification.new do |s|
   s.summary = 'Make any Ruby object quack like ActiveRecord'
   s.description = s.summary
   s.license = 'MIT'
+  s.metadata = { 'rubygems_mfa_required' => 'true' }
 
   s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "bundler", ">= 1.5"
   s.add_development_dependency "rake"
 
   s.add_runtime_dependency('activerecord', '>= 3.2')
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.5.0'
 end

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/record_extension/inheritance.rb

@@ -120,7 +120,7 @@ module ActiveType
             type_name = base_class.type_for_attribute(inheritance_column).cast(type_name)
             subclass = begin
               if store_full_sti_class
-                ActiveSupport::Dependencies.constantize(type_name)
+                type_name.constantize
               else
                 compute_type(type_name)
               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)
@@ -37,8 +44,6 @@ module ActiveType
         # Rails 5.2+
         casted.instance_variable_set(:@mutations_from_database, record.instance_variable_get(:@mutations_from_database))
 
-        casted.instance_variable_set(:@association_cache, record.instance_variable_get(:@association_cache))
-
         # Rails 3.2, 4.2
         errors = record.errors
         if errors.kind_of? ActiveModel::Errors
@@ -50,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
 
@@ -63,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.0'
+  VERSION = '2.1.1'
 end

data/lib/active_type/virtual_attributes.rb

@@ -112,7 +112,7 @@ module ActiveType
       end
 
       def validate_attribute_name!(name)
-        unless name.to_s =~ /\A[A-z0-9_]*\z/
+        unless name.to_s =~ /\A[A-Za-z0-9_]*\z/
           raise InvalidAttributeNameError.new("'#{name}' is not a valid name for a virtual attribute")
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_type
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Tobias Kraze
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
@@ -83,6 +83,10 @@ files:
 - Gemfile.6.1.pg.lock
 - Gemfile.6.1.sqlite3
 - Gemfile.6.1.sqlite3.lock
+- Gemfile.7.0.pg
+- Gemfile.7.0.pg.lock
+- Gemfile.7.0.sqlite3
+- Gemfile.7.0.sqlite3.lock
 - Gemfile.lock
 - LICENSE
 - README.md
@@ -90,24 +94,28 @@ 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
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -116,14 +124,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: Make any Ruby object quack like ActiveRecord