activerecord-typedstore 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4f681cbd23a432d2e40094499e45a693ebacc8784d639dbd35f5d7467d3f024
-  data.tar.gz: 2adde8a50a784c41a23e188d51ababc7c19a553d6e4599e2265dad9c70ea5ebe
+  metadata.gz: 5f56fb7b6456937890a85e139a296727a04b2c87a2452f45810782849378357a
+  data.tar.gz: 17e694f93e4db21a4b5a08c7795285fd10aaf9bc203f74376a14356873c84802
 SHA512:
-  metadata.gz: 67570832d5d8f6d7d05617f2f6572ed1e629bb1463f4bc123513d84219306a2aca59439082eed57a00d80e97474bd1b5a63269a94caabd530769bd8c098c3da6
-  data.tar.gz: a9f3f3d3ab6bbbe4b47625674fde96e3f3c8c0fbb697f2b557b1aa089ed45bd91e2c3bff98c0bbee8c55d52bc3d473bf16fc92759b65ad5a84548d91a5e81b14
+  metadata.gz: 02d3ce60427903e2c039818c4c77368a42b20c4f9fbf5bf167357e0e932d01c717f5eea6172ea03170b018a468b6b8f0a00d59fd49073a38eb620a27e05870c3
+  data.tar.gz: 96ff55688ac6c1b2d9f56d9a45e796b4c633e6d3d1dd89cdbdb14025044d97c9f5deefce7a53494f35ff5a227f340e8ec9d9fba70b7d861fe488ee6f52ad98fe

data/.github/workflows/ruby.yml

@@ -5,22 +5,22 @@ 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]
+        rails: ['6.1', '7.0', 'edge']
         timezone_aware: [0, 1]
     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/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/lib/active_record/typed_store/behavior.rb

@@ -71,5 +71,24 @@ module ActiveRecord::TypedStore
         super
       end
     end
+
+    private
+
+    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|
+        @attributes.key?(store) && @attributes[store].value_before_type_cast.blank?
+      end
+    end
   end
 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.5.1'
   end
 end

data/spec/active_record/typed_store_spec.rb

@@ -925,7 +925,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 +954,23 @@ 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!
+    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
+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,12 @@ 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: [].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 +81,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 +129,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 +188,15 @@ Models = [
   JsonTypedStoreModel,
   MarshalTypedStoreModel
 ]
+
+class DirtyTrackingModel < ActiveRecord::Base
+  after_update :read_active
+
+  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.5.1
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2022-11-03 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,7 @@ files:
 - activerecord-typedstore.gemspec
 - gemfiles/Gemfile.ar-6.1
 - gemfiles/Gemfile.ar-7.0
-- gemfiles/Gemfile.ar-master
+- gemfiles/Gemfile.ar-edge
 - lib/active_record/typed_store.rb
 - lib/active_record/typed_store/behavior.rb
 - lib/active_record/typed_store/dsl.rb