store_attribute 1.3.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d79c58e23fa0838516c2eab7130ce8f121941bb99355d9ad7e24dbcb94f231be
-  data.tar.gz: 70cb3d8ff0a587f726756b2d2a1d89cd162fa49e286ee343c8311c9013a4a7f9
+  metadata.gz: 5530282b5ea4488c94d5f90ba1474c9a8b6dd1b153c412cce62a6dca0c69c3d3
+  data.tar.gz: 67f65c84644842ebc7c6cdbcc455f034854d5ada9dd469180cf94a0a4cf02d38
 SHA512:
-  metadata.gz: d15c7344b6f758cea9d405a3c5f765d4e9d6e734cae8866d44030c1788bf3c889ef6e3c2dae9bdb91976a45c7a0dbe3d4439f6cb5b81c169b97eefd1b264fc58
-  data.tar.gz: 8913905537ab1a151d6194b481ec46c17564515346dfe6d79cedb02281879b7e8b3ac906e7eb8dcacfcbab19d2cbe14a5d4097c2285d19827335c4420e0bf572
+  metadata.gz: f00159fa7de150635efa6c2d623ab8aacac3b166582fa5b48d623621f38ee79a123903e538faddd8b42d9cca955a9c18ea0fc4ebd32cfaba7de51b233b203891
+  data.tar.gz: f7ee58675bc257f21343054e131b3708ee3d8f5c1f504e814e80e3eb95eb0e506bf69361815736cf50732f8846b1b73671533802854f402bf72881ceaada3de9

data/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 ## master
 
+## 2.0.1 (2025-05-09) 🎇
+
+- Register store_attributes as attributes. ([@rickcsong](https://github.com/rickcsong))
+
+```ruby
+class User < ActiveRecord::Base
+  self.store_attribute_register_attributes = true
+
+  store_attribute :extra, :color, :string, default: "grey"
+end
+
+User.attribute_types.keys.include?("color") #=> true
+```
+
+## 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,44 @@ 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
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/palkan/store_attribute](https://github.com/palkan/store_attribute).
+
+For local development, you'll need PostgreSQL up and running. You can either install it on your host machine or run via Docker as follows:
+
+```bash
+docker run --name store_attribute_postgres -e POSTGRES_HOST_AUTH_METHOD=trust -e POSTGRES_USER=$USER -e POSTGRES_PASSWORD=postgres -p 5432:5432 -d postgres
+docker exec -it store_attribute_postgres createdb -U $USER store_attribute_test
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/store_attribute/active_record/mutation_tracker.rb

@@ -14,7 +14,7 @@ module StoreAttribute
       prev_store, new_store = orig_changes.map(&:dup)
 
       prev_store&.each do |key, value|
-        if new_store[key] == value
+        if new_store&.dig(key) == value
           prev_store.except!(key)
           new_store&.except!(key)
         end

data/lib/store_attribute/active_record/store.rb

@@ -10,6 +10,7 @@ module ActiveRecord
       alias_method :_orig_store_without_types, :store
       alias_method :_orig_store_accessor_without_types, :store_accessor
 
+      attr_writer :store_attribute_register_attributes
       attr_writer :store_attribute_unset_values_fallback_to_default
 
       # Defines store on this model.
@@ -133,6 +134,28 @@ module ActiveRecord
 
         _local_typed_stored_attributes[store_name][:owner] = self if options.key?(:default) || !_local_typed_stored_attributes?
         _local_typed_stored_attributes[store_name][:types][name] = [type, options]
+
+        if store_attribute_register_attributes
+          cast_type =
+            if type == :value
+              ActiveModel::Type::Value.new(**options.except(:default))
+            else
+              ActiveRecord::Type.lookup(type, **options.except(:default))
+            end
+
+          attribute(name, cast_type, **options)
+        end
+      end
+
+      def store_attribute_register_attributes
+        return @store_attribute_register_attributes if instance_variable_defined?(:@store_attribute_register_attributes)
+
+        @store_attribute_register_attributes =
+          if superclass.respond_to?(:store_attribute_register_attributes)
+            superclass.store_attribute_register_attributes
+          else
+            StoreAttribute.store_attribute_register_attributes
+          end
       end
 
       def store_attribute_unset_values_fallback_to_default
@@ -142,7 +165,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 +193,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 +223,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 = {}
@@ -91,12 +92,16 @@ module ActiveRecord
         self
       end
 
+      def mutable?
+        true
+      end
+
       def write(object, attribute, key, value)
         value = type_for(key).cast(value) if typed?(key)
         store_accessor.write(object, attribute, key, value)
       end
 
-      delegate :read, :prepare, to: :store_accessor
+      delegate :get, :read, :prepare, to: :store_accessor
 
       def build_defaults
         defaults.transform_values do |val|
@@ -140,7 +145,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.1"
 end

data/lib/store_attribute.rb

@@ -4,4 +4,13 @@ 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
+    attr_accessor :store_attribute_register_attributes
+  end
+
+  self.store_attribute_unset_values_fallback_to_default = true
+  self.store_attribute_register_attributes = false
 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.1
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2025-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -91,7 +91,7 @@ metadata:
   documentation_uri: http://github.com/palkan/store_attribute
   homepage_uri: http://github.com/palkan/store_attribute
   source_code_uri: http://github.com/palkan/store_attribute
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -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:
   - - ">="
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.19
-signing_key: 
+signing_key:
 specification_version: 4
 summary: ActiveRecord extension which adds typecasting to store accessors
 test_files: []