activerecord-typedstore 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4f681cbd23a432d2e40094499e45a693ebacc8784d639dbd35f5d7467d3f024
-  data.tar.gz: 2adde8a50a784c41a23e188d51ababc7c19a553d6e4599e2265dad9c70ea5ebe
+  metadata.gz: 9cbd38a8c2df073a4576501953ef2e9debb1d4c36c673c7e5467c04a247ba9cd
+  data.tar.gz: f12be53e1013b2302706e6471bebec9abd0d9edd74efe660d0fcf6d4859368c1
 SHA512:
-  metadata.gz: 67570832d5d8f6d7d05617f2f6572ed1e629bb1463f4bc123513d84219306a2aca59439082eed57a00d80e97474bd1b5a63269a94caabd530769bd8c098c3da6
-  data.tar.gz: a9f3f3d3ab6bbbe4b47625674fde96e3f3c8c0fbb697f2b557b1aa089ed45bd91e2c3bff98c0bbee8c55d52bc3d473bf16fc92759b65ad5a84548d91a5e81b14
+  metadata.gz: 8e9ff18057af10d974dc456f3ff66633dd2483aae664f6acab881a895ef341b8006a25641441b216189dd61f972fefad067e41351e3cd04020e51d9a7d974272
+  data.tar.gz: 230a6686e806dac2ad28892f2f2f2344f1f7b6b7627f1eb048a1e0e2cce4e4b5f6336e162aa23f37de52197ca41909fa9ac43476a828b4d3fcf5e7ffbdb0dc96

data/.github/workflows/ruby.yml

@@ -5,22 +5,31 @@ on: [push, pull_request]
 jobs:
   build:
     runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
+    name: ${{ matrix.ruby }} / Rails ${{ matrix.rails }} / TZ ${{ matrix.timezone_aware }}
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.7', '3.0', '3.1']
-        gemfile: [Gemfile.ar-6.1, Gemfile.ar-7.0, Gemfile.ar-master]
+        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3']
+        rails: ['6.1', '7.0', '7.1', 'edge']
         timezone_aware: [0, 1]
+        exclude:
+          - ruby: '3.2'
+            rails: '6.1'
+          - ruby: '3.3'
+            rails: '6.1'
+          - ruby: '2.7'
+            rails: 'edge'
+          - ruby: '3.0'
+            rails: 'edge'
     env:
-      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}
+      BUNDLE_GEMFILE: gemfiles/Gemfile.ar-${{ matrix.rails }}
       TIMEZONE_AWARE: ${{ matrix.timezone_aware }}
       POSTGRES: 1
       MYSQL: 1
       POSTGRES_JSON: 1
     steps:
       - name: Check out code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Set up Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:

data/README.md

@@ -1,6 +1,6 @@
 # ActiveRecord::TypedStore
 
-[![Gem Version](https://badge.fury.io/rb/activerecord-typedstore.png)](http://badge.fury.io/rb/activerecord-typedstore)
+[![Gem Version](https://badge.fury.io/rb/activerecord-typedstore.svg)](http://badge.fury.io/rb/activerecord-typedstore)
 
 [ActiveRecord::Store](http://api.rubyonrails.org/classes/ActiveRecord/Store.html) but with typed attributes.
 

data/activerecord-typedstore.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activerecord', '>= 6.1'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'sqlite3', '~> 1'
   spec.add_development_dependency 'database_cleaner', '~> 1'

data/gemfiles/Gemfile.ar-7.1

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'activerecord', '~> 7.0.0'

data/lib/active_record/typed_store/behavior.rb

@@ -71,5 +71,33 @@ module ActiveRecord::TypedStore
         super
       end
     end
+
+    private
+
+    if ActiveRecord.version.segments.first >= 7
+      def attribute_names_for_partial_inserts
+        # Contrary to all vanilla Rails types, typedstore attribute have an inherent default
+        # value that doesn't match the database column default.
+        # As such we need to insert them on partial inserts even if they weren't changed.
+        super | self.class.typed_stores.keys.map(&:to_s)
+      end
+
+      def attribute_names_for_partial_updates
+        # On partial updates we shouldn't need to force stores to be persisted. However since
+        # we weren't persisting them for a while on insertion, we now need to gracefully deal
+        # with existing records that may have been persisted with a `NULL` store
+        # We use `blank?` as an heuristic to detect these.
+        super | self.class.typed_stores.keys.map(&:to_s).select do |store|
+          has_attribute?(store) && read_attribute_before_type_cast(store).blank?
+        end
+      end
+    else
+      # Rails 6.1 capability
+      def attribute_names_for_partial_writes
+        super | self.class.typed_stores.keys.map(&:to_s).select do |store|
+          has_attribute?(store) && read_attribute_before_type_cast(store).blank?
+        end
+      end
+    end
   end
 end

data/lib/active_record/typed_store/extension.rb

@@ -22,7 +22,12 @@ module ActiveRecord::TypedStore
       typed_klass = TypedHash.create(dsl.fields.values)
       const_set("#{store_attribute}_hash".camelize, typed_klass)
 
-      if ActiveRecord.version >= Gem::Version.new('6.1.0.alpha')
+      if ActiveRecord.version >= Gem::Version.new('7.2.0.alpha')
+        decorate_attributes([store_attribute]) do |name, subtype|
+          subtype = subtype.subtype if subtype.is_a?(Type)
+          Type.new(typed_klass, dsl.coder, subtype)
+        end
+      elsif ActiveRecord.version >= Gem::Version.new('6.1.0.alpha')
         attribute(store_attribute) do |subtype|
           subtype = subtype.subtype if subtype.is_a?(Type)
           Type.new(typed_klass, dsl.coder, subtype)

data/lib/active_record/typed_store/field.rb

@@ -11,12 +11,12 @@ module ActiveRecord::TypedStore
 
       @accessor = options.fetch(:accessor, true)
       @name = name
+      @array = options.fetch(:array, false)
       if options.key?(:default)
         @default = extract_default(options[:default])
       end
       @null = options.fetch(:null, true)
       @blank = options.fetch(:blank, true)
-      @array = options.fetch(:array, false)
     end
 
     def has_default?
@@ -27,6 +27,8 @@ module ActiveRecord::TypedStore
       casted_value = type_cast(value)
       if !blank
         casted_value = default if casted_value.blank?
+      elsif array && has_default?
+        casted_value = default if value.nil?
       elsif !null
         casted_value = default if casted_value.nil?
       end

data/lib/active_record/typed_store/type.rb

@@ -41,12 +41,7 @@ module ActiveRecord::TypedStore
 
     def changed_in_place?(raw_old_value, value)
       return false if value.nil?
-      if ActiveRecord.version.segments.first >= 5
-        raw_new_value = serialize(value)
-      else
-        # 4.2 capability
-        raw_new_value = type_cast_for_database(value)
-      end
+      raw_new_value = serialize(value)
       raw_old_value.nil? != raw_new_value.nil? || raw_old_value != raw_new_value
     end
   end

data/lib/active_record/typed_store/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module TypedStore
-    VERSION = '1.5.0'
+    VERSION = '1.6.0'
   end
 end

data/spec/active_record/typed_store_spec.rb

@@ -524,7 +524,7 @@ shared_examples 'a store' do |retain_type = true, settings_type = :text|
   describe 'model.typed_stores' do
     it "can access keys" do
       stores = model.class.typed_stores
-      expect(stores[:settings].keys).to eq [:no_default, :name, :email, :cell_phone, :public, :enabled, :age, :max_length, :rate, :price, :published_on, :remind_on, :published_at_time, :remind_at_time, :published_at, :remind_at, :total_price, :shipping_cost, :grades, :tags, :nickname, :author, :source, :signup, :country]
+      expect(stores[:settings].keys).to eq [:no_default, :name, :email, :cell_phone, :public, :enabled, :age, :max_length, :rate, :price, :published_on, :remind_on, :published_at_time, :remind_at_time, :published_at, :remind_at, :total_price, :shipping_cost, :grades, :tags, :subjects, :nickname, :author, :source, :signup, :country]
     end
 
     it "can access keys even when accessors are not defined" do
@@ -889,9 +889,15 @@ shared_examples 'a model supporting arrays' do |pg_native=false|
       expect(model.reload.grades).to be == [[1, 2], [3, 4, 5]]
     end
 
+    it 'defaults to [] if provided default is not an array' do
+      model.update(subjects: nil)
+      expect(model.reload.subjects).to be == []
+    end
+
+    # Not sure about pg_native and if this test should be outside of this block.
     it 'retreive default if assigned null' do
       model.update(tags: nil)
-      expect(model.reload.tags).to be == []
+      expect(model.reload.tags).to be == ['article']
     end
   end
 end
@@ -925,7 +931,7 @@ describe YamlTypedStoreModel do
 
   it 'nested hashes are not serialized as HashWithIndifferentAccess' do
     model = described_class.create!
-    expect(model.settings_before_type_cast).not_to include('HashWithIndifferentAccess')
+    expect(model.settings_before_type_cast.to_s).not_to include('HashWithIndifferentAccess')
   end
 end
 
@@ -954,3 +960,33 @@ describe InheritedTypedStoreModel do
     expect(model.settings[:new_attribute]).to be == '42'
   end
 end
+
+describe DirtyTrackingModel do
+  it 'stores the default on creation' do
+    model = DirtyTrackingModel.create!
+    model = DirtyTrackingModel.find(model.id)
+    expect(model.settings_before_type_cast).to_not be_blank
+  end
+
+  it 'handles loaded records having uninitialized defaults' do
+    model = DirtyTrackingModel.create!
+    DirtyTrackingModel.update_all("settings = NULL") # bypass validation
+    model = DirtyTrackingModel.find(model.id)
+    expect(model.settings_changed?).to be false
+    expect(model.changes).to be_empty
+
+    model.update!(title: "Hello")
+
+    expect(model.settings_changed?).to be false
+    expect(model.changes).to be_empty
+  end
+
+  it 'does not update missing attributes in partially loaded records' do
+    model = DirtyTrackingModel.create!(active: true)
+    model = DirtyTrackingModel.select(:id, :title).find(model.id)
+    model.update!(title: "Hello")
+
+    model = DirtyTrackingModel.find(model.id)
+    expect(model.active).to be true
+  end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,12 @@ Dir[File.expand_path(File.join(File.dirname(__FILE__), 'support', '**', '*.rb'))
 
 Time.zone = 'UTC'
 
+if ActiveRecord.respond_to?(:yaml_column_permitted_classes)
+  ActiveRecord.yaml_column_permitted_classes |= [Date, Time, BigDecimal]
+elsif ActiveRecord::Base.respond_to?(:yaml_column_permitted_classes)
+  ActiveRecord::Base.yaml_column_permitted_classes |= [Date, Time, BigDecimal]
+end
+
 RSpec.configure do |config|
   config.order = 'random'
 end

data/spec/support/models.rb

@@ -1,4 +1,5 @@
 require 'active_record'
+require 'base64'
 require 'json'
 require 'yaml'
 
@@ -12,7 +13,7 @@ ActiveRecord::Base.configurations = {
   }
 }
 
-def define_columns(t)
+def define_columns(t, array: false)
   t.integer :no_default
 
   t.string :name, default: '', null: false
@@ -40,11 +41,13 @@ def define_columns(t)
   t.decimal :total_price, default: 4.2, null: false, precision: 16, scale: 2
   t.decimal :shipping_cost, precision: 16, scale: 2
 
-  t.integer :grades, array: true
+  if t.is_a?(ActiveRecord::TypedStore::DSL)
+    t.integer :grades, array: true
+    t.string :tags, array: true, null: false, default: ['article']
+    t.string :subjects, array: true, null: false, default: ['mathematics'].to_yaml
 
-  t.string :tags, array: true, null: false, default: [].to_yaml
-
-  t.string :nickname, blank: false, default: 'Please enter your nickname'
+    t.string :nickname, blank: false, default: 'Please enter your nickname'
+  end
 end
 
 def define_store_with_no_attributes(**options)
@@ -79,15 +82,21 @@ def define_stores_with_prefix_and_suffix(**options)
   typed_store(:custom_suffixed_settings, suffix: :custom, **options) { |t| t.any :language }
 end
 
-MigrationClass = ActiveRecord::Migration["5.0"]
+MigrationClass = ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"]
 class CreateAllTables < MigrationClass
-
   def self.up
     ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations.configs_for(env_name: "test", name: :test_sqlite3))
     create_table(:sqlite3_regular_ar_models, force: true) { |t| define_columns(t); t.text :untyped_settings }
-    create_table(:yaml_typed_store_models, force: true) { |t| %i[settings explicit_settings partial_settings untyped_settings prefixed_settings suffixed_settings custom_prefixed_settings custom_suffixed_settings].each { |column| t.text column} }
-    create_table(:json_typed_store_models, force: true) { |t| %i[settings explicit_settings partial_settings untyped_settings prefixed_settings suffixed_settings custom_prefixed_settings custom_suffixed_settings].each { |column| t.text column} }
-    create_table(:marshal_typed_store_models, force: true) { |t| %i[settings explicit_settings partial_settings untyped_settings prefixed_settings suffixed_settings custom_prefixed_settings custom_suffixed_settings].each { |column| t.text column} }
+    create_table(:yaml_typed_store_models, force: true) { |t| %i[settings explicit_settings partial_settings untyped_settings prefixed_settings suffixed_settings custom_prefixed_settings custom_suffixed_settings].each { |column| t.text column}; t.string :regular_column }
+    create_table(:json_typed_store_models, force: true) { |t| %i[settings explicit_settings partial_settings untyped_settings prefixed_settings suffixed_settings custom_prefixed_settings custom_suffixed_settings].each { |column| t.text column}; t.string :regular_column }
+    create_table(:marshal_typed_store_models, force: true) { |t| %i[settings explicit_settings partial_settings untyped_settings prefixed_settings suffixed_settings custom_prefixed_settings custom_suffixed_settings].each { |column| t.text column}; t.string :regular_column }
+
+    create_table(:dirty_tracking_models, force: true) do |t|
+      t.string :title
+      t.text :settings
+
+      t.timestamps
+    end
   end
 end
 ActiveRecord::Migration.verbose = true
@@ -121,6 +130,11 @@ class YamlTypedStoreModel < ActiveRecord::Base
   establish_connection :test_sqlite3
   store :untyped_settings, accessors: [:title]
 
+  after_update :read_active
+  def read_active
+    enabled
+  end
+
   define_store_with_attributes
   define_store_with_no_attributes
   define_store_with_partial_attributes
@@ -175,3 +189,15 @@ Models = [
   JsonTypedStoreModel,
   MarshalTypedStoreModel
 ]
+
+class DirtyTrackingModel < ActiveRecord::Base
+  after_update :read_active, if: -> { has_attribute?(:settings) }
+
+  typed_store(:settings) do |f|
+    f.boolean :active, default: false, null: false
+  end
+
+  def read_active
+    active
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-typedstore
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2024-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +111,8 @@ files:
 - activerecord-typedstore.gemspec
 - gemfiles/Gemfile.ar-6.1
 - gemfiles/Gemfile.ar-7.0
-- gemfiles/Gemfile.ar-master
+- gemfiles/Gemfile.ar-7.1
+- gemfiles/Gemfile.ar-edge
 - lib/active_record/typed_store.rb
 - lib/active_record/typed_store/behavior.rb
 - lib/active_record/typed_store/dsl.rb
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: Add type casting and full method attributes support to АctiveRecord store