store_attribute 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d79c58e23fa0838516c2eab7130ce8f121941bb99355d9ad7e24dbcb94f231be
-  data.tar.gz: 70cb3d8ff0a587f726756b2d2a1d89cd162fa49e286ee343c8311c9013a4a7f9
+  metadata.gz: 8a7e7f09f536e3ca33ac3ade96579b1e21d44dc4d40ffa24d9b2450a6c91e9e1
+  data.tar.gz: e8fd0c4de5b2ecfdd0f2f3154ffa37d5ff5bf11cbf4c225c7681ec5294de3b78
 SHA512:
-  metadata.gz: d15c7344b6f758cea9d405a3c5f765d4e9d6e734cae8866d44030c1788bf3c889ef6e3c2dae9bdb91976a45c7a0dbe3d4439f6cb5b81c169b97eefd1b264fc58
-  data.tar.gz: 8913905537ab1a151d6194b481ec46c17564515346dfe6d79cedb02281879b7e8b3ac906e7eb8dcacfcbab19d2cbe14a5d4097c2285d19827335c4420e0bf572
+  metadata.gz: f3ed249e25a049a2a8cbe728f45e586c4504f5604e26c40914e1bfc5c6512b4929cae2a59141e2b198e81627ad4fc0504f6104bd9b58fc6c526699358c3f04d5
+  data.tar.gz: 906e39d1c5304a09688650afb5365b53363972cdd684cb1bfd58fe6ebf588cfd406309d3907b7766144510bb9325ba1102e10ede0c9e29e3291cde4988f902ad

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## master
 
+## 2.0.0 (2024-12-12)
+
+- **Breaking:** The `store_attribute_unset_values_fallback_to_default` option is now true by default, meaning that the default value will be returned when the attribute key is not present in the serialized value.
+
+For v1.x behavior, set the option to `false` globally as follows:
+
+```ruby
+StoreAttribute.store_attribute_unset_values_fallback_to_default = false
+```
+
+- Ruby >= 3.0 is required.
+
 ## 1.3.1 (2024-09-19)
 
 - Populate missing defaults on user input when `store_attribute_unset_values_fallback_to_default` is true. ([@palkan][])

data/README.md

@@ -146,15 +146,29 @@ another_user.name #=> nil
 another_user.expired_at #=> nil
 ```
 
-It is possible to configure `store_attribute` to return the default value even when the record is persisted and the attribute name is not present. By using the `store_attribute_unset_values_fallback_to_default` class option, default values will be returned for missing keys. For example:
+By default, Store Attribute returns the default value even when the record is persisted but the attribute name is not present:
+
+```ruby
+user = User.create!(extra: {})
+user.expired_at #=> 2022-03-19
+```
+
+You can disable this behaviour by setting the `store_attribute_unset_values_fallback_to_default` class option to `false` in your model:
 
 ```ruby
 class User < ApplicationRecord
-  self.store_attribute_unset_values_fallback_to_default = true
+  self.store_attribute_unset_values_fallback_to_default = false
 end
 
 user = User.create!(extra: {})
-user.expired_at #=> 2022-03-19
+user.expired_at #=> nil
 ```
 
-**IMPORTANT:** Due to implementation limitations, it's not recommended to toggle the value of `store_attribute_unset_values_fallback_to_default` in sub-classes. We recommend to set this value in base classes (e.g., `ApplicationRecord`).
+You can also configure the global default for this option in an initializer or application configuration:
+
+```ruby
+# config/initializers/store_attribute.rb
+# # or
+# config/application.rb
+StoreAttribute.store_attribute_unset_values_fallback_to_default = false
+```

data/lib/store_attribute/active_record/store.rb

@@ -142,7 +142,7 @@ module ActiveRecord
           if superclass.respond_to?(:store_attribute_unset_values_fallback_to_default)
             superclass.store_attribute_unset_values_fallback_to_default
           else
-            false
+            StoreAttribute.store_attribute_unset_values_fallback_to_default
           end
       end
 
@@ -170,23 +170,8 @@ module ActiveRecord
 
         owner = self
 
-        # For Rails <6.1
-        if respond_to?(:decorate_attribute_type) && method(:decorate_attribute_type).parameters.count { |type, _| type == :req } == 2
-          decorate_attribute_type(attr_name, "typed_accessor_for_#{attr_name}") do |subtype|
-            subtypes = _local_typed_stored_attributes[attr_name][:types]
-            type = Type::TypedStore.create_from_type(subtype)
-            type.owner = owner
-            defaultik.type = type
-            subtypes.each do |name, (cast_type, options)|
-              type.add_typed_key(name, cast_type, **options.symbolize_keys)
-            end
-
-            define_default_attribute(attr_name, defaultik.proc, type, from_user: true)
-
-            type
-          end
         # Rails >7.1
-        elsif respond_to?(:decorate_attributes)
+        if respond_to?(:decorate_attributes)
           decorate_attributes([attr_name]) do |_, subtype|
             subtypes = _local_typed_stored_attributes[attr_name][:types]
             type = Type::TypedStore.create_from_type(subtype)
@@ -215,6 +200,13 @@ module ActiveRecord
               type.add_typed_key(name, cast_type, **options.symbolize_keys)
             end
 
+            # Make sure default attribute uses the correct type, so #changed? works as expected
+            # This is dirty hack that makes Rails <7.2 works similar to Rails >=7.2. Please, upgrade :)
+            if type.defaults.any? && _default_attributes[attr_name] && !_default_attributes[attr_name].type.is_a?(Type::TypedStore)
+              _default_attributes[attr_name] =
+                ActiveModel::Attribute.from_database(attr_name, _default_attributes[attr_name].value.deep_dup, type)
+            end
+
             type
           end
         end

data/lib/store_attribute/active_record/type/typed_store.rb

@@ -26,6 +26,7 @@ module ActiveRecord
       end
 
       attr_writer :owner
+      attr_reader :defaults
 
       def initialize(subtype)
         @accessor_types = {}
@@ -140,7 +141,7 @@ module ActiveRecord
         subtype.accessor
       end
 
-      attr_reader :accessor_types, :defaults, :subtype, :owner
+      attr_reader :accessor_types, :subtype, :owner
     end
   end
 end

data/lib/store_attribute/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StoreAttribute # :nodoc:
-  VERSION = "1.3.1"
+  VERSION = "2.0.0"
 end

data/lib/store_attribute.rb

@@ -4,4 +4,11 @@ require "store_attribute/version"
 require "store_attribute/active_record"
 
 module StoreAttribute
+  class << self
+    # Global default value for `store_attribute_unset_values_fallback_to_default` option.
+    # Must be set before any model is loaded
+    attr_accessor :store_attribute_unset_values_fallback_to_default
+  end
+
+  self.store_attribute_unset_values_fallback_to_default = true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: store_attribute
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -99,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="