store_attribute 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6078ba7214bee86726edd35c8cfbac054907c2aada0e5644d63b906b1884cb37
-  data.tar.gz: b3ac4c23dfdc1f8412fccf67fe8c7e9a441943ae7d3adba95eb735e7cd5e0302
+  metadata.gz: 6c4bd7ca51c3191e560a7cfb18a9edde7caa40c571992a26a84352da9ee5d5d0
+  data.tar.gz: 2577ac2836e7c11b7857b5c8b98b8c3e208480b226e1ec2813ade8377324a97f
 SHA512:
-  metadata.gz: 2c8b70decca97c29ec6b112265d318f7fcb598a87dccbcc6531fc7f9e1de8701830f7d963f6890cfb453704ad19b14e2b6550d9d513c33fbfadf85952a9491a4
-  data.tar.gz: 41a9e77501f4c9e4df33a06fa343c0377e8cb982b0dfda250003345e16d4afc635b39b99c9570ded1f7af27a6781b76c8dba013b3586bf699c048260159bf507
+  metadata.gz: 6f8bcb86379b5235cde3e19b96dbbba05ec2908b409882d872fb86913f2adfc9943f6a54bc0d20f5a8b5fd1c0373edc31594bc999d07c7f229954b13d5287567
+  data.tar.gz: cefb661c7a3e7f7add6a1ffac5eafcbae3941db2a4cc74a8e5fc5b827f10721c409ea8434730c8e6a0ba6cd706daa7e7b1276b7a52efe15bc6709e6047f6e055

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## master
 
+## 1.3.0 (2024-09-03) 🗓️
+
+- Fix using defaults when store attributes are inherited from a parent model. ([@palkan][])
+
+- Allow specifying only default values w/o types. ([@palkan][])
+
+```ruby
+store_attribute :store, :tags, default: []
+```
+
+- **Ruby >= 2.7 and Rails >= 6.1 are required**. ([@palkan][])
+
+## 1.2.0 (2023-11-29)
+
+- Support Rails >7.1. ([@palkan][])
+
+- Fix handling of store attributes for not-yet-defined columns. ([@palkan][])
+
 ## 1.1.1 (2023-06-27)
 
 - Lookup store attribute types only after schema load.

data/README.md

@@ -13,7 +13,7 @@ Originally extracted from not merged PR to Rails: [rails/rails#18942](https://gi
 In your Gemfile:
 
 ```ruby
-# for Rails 6+ (7 is supported)
+# for Rails 6.1+ (7 is supported)
 gem "store_attribute", "~> 1.0"
 
 # for Rails 5+ (6 is supported)

data/lib/store_attribute/active_record/store.rb

@@ -30,6 +30,7 @@ module ActiveRecord
       #   end
       def store(store_name, options = {})
         accessors = options.delete(:accessors)
+        accessor_related_options = options.slice(:prefix, :suffix)
         typed_accessors =
           if accessors && accessors.last.is_a?(Hash)
             accessors.pop
@@ -38,7 +39,7 @@ module ActiveRecord
           end
 
         _orig_store_without_types(store_name, options)
-        store_accessor(store_name, *accessors, **typed_accessors) if accessors
+        store_accessor(store_name, *accessors, **accessor_related_options, **typed_accessors) if accessors
       end
 
       # Adds additional accessors to an existing store on this model.
@@ -114,17 +115,24 @@ module ActiveRecord
       #   u.ratio # => "3.141592653"
       #
       #   # On the other hand, writing through accessor set correct data within store
-      #   u.ratio = "3.14.1592653"
+      #   u.ratio = "3.141592653"
       #   u.ratio # => 3
       #   u.settings['ratio'] # => 3
       #
       # For more examples on using types, see documentation for ActiveRecord::Attributes.
-      def store_attribute(store_name, name, type, prefix: nil, suffix: nil, **options)
+      def store_attribute(store_name, name, type = :value, prefix: nil, suffix: nil, **options)
         _orig_store_accessor_without_types(store_name, name.to_s, prefix: prefix, suffix: suffix)
         _define_predicate_method(name, prefix: prefix, suffix: suffix) if type == :boolean
 
-        _define_store_attribute(store_name) if !_local_typed_stored_attributes? || _local_typed_stored_attributes[store_name].empty?
-        _local_typed_stored_attributes[store_name][name] = [type, options]
+        _define_store_attribute(store_name) if !_local_typed_stored_attributes? ||
+          _local_typed_stored_attributes[store_name][:types].empty? ||
+          # Defaults owner has changed, we must decorate the attribute to correctly propagate the defaults
+          (
+            options.key?(:default) && _local_typed_stored_attributes[store_name][:owner] != self
+          )
+
+        _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]
       end
 
       def store_attribute_unset_values_fallback_to_default
@@ -148,27 +156,24 @@ module ActiveRecord
         @local_typed_stored_attributes =
           if superclass.respond_to?(:_local_typed_stored_attributes)
             superclass._local_typed_stored_attributes.dup.tap do |h|
-              h.transform_values!(&:dup)
+              h.transform_values! { |v| {owner: v[:owner], types: v[:types].dup} }
             end
           else
-            Hash.new { |h, k| h[k] = {}.with_indifferent_access }.with_indifferent_access
+            Hash.new { |h, k| h[k] = {types: {}.with_indifferent_access} }.with_indifferent_access
           end
       end
 
       def _define_store_attribute(store_name)
         attr_name = store_name.to_s
-        was_type = attributes_to_define_after_schema_loads[attr_name]&.first
-
-        # For Rails <6.1
-        use_decorator = respond_to?(:decorate_attribute_type) && method(:decorate_attribute_type).parameters.count { |type, _| type == :req } == 2
 
         defaultik = Type::TypedStore::Defaultik.new
 
         owner = self
 
-        if use_decorator
+        # 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]
+            subtypes = _local_typed_stored_attributes[attr_name][:types]
             type = Type::TypedStore.create_from_type(subtype)
             type.owner = owner
             defaultik.type = type
@@ -180,9 +185,27 @@ module ActiveRecord
 
             type
           end
+        # Rails >7.1
+        elsif 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)
+            type.owner = owner
+            defaultik.type = type
+            subtypes.each do |name, (cast_type, options)|
+              type.add_typed_key(name, cast_type, **options.symbolize_keys)
+            end
+
+            type
+          end
+
+          attribute(attr_name, default: defaultik.proc)
+        # Rails >=6.1, <=7.1
         else
+          was_type = attributes_to_define_after_schema_loads[attr_name]&.first
+
           attribute(attr_name, default: defaultik.proc) do |subtype|
-            subtypes = _local_typed_stored_attributes[attr_name]
+            subtypes = _local_typed_stored_attributes[attr_name][:types]
             subtype = _lookup_cast_type(attr_name, was_type, {}) if defined?(_lookup_cast_type)
 
             type = Type::TypedStore.create_from_type(subtype)

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

@@ -30,13 +30,14 @@ module ActiveRecord
       def initialize(subtype)
         @accessor_types = {}
         @defaults = {}
-        @store_accessor = subtype.accessor
-        super(subtype)
+        @subtype = subtype
+        super
       end
 
       UNDEFINED = Object.new
 
       def add_typed_key(key, type, default: UNDEFINED, **options)
+        type = ActiveModel::Type::Value.new(**options) if type == :value
         type = ActiveRecord::Type.lookup(type, **options) if type.is_a?(Symbol)
         safe_key = key.to_s
         @accessor_types[safe_key] = type
@@ -61,7 +62,7 @@ module ActiveRecord
       end
 
       def serialize(value)
-        return super(value) unless value.is_a?(Hash)
+        return super unless value.is_a?(Hash)
         typed_casted = {}
         accessor_types.each do |str_key, type|
           key = key_to_cast(value, str_key)
@@ -118,7 +119,7 @@ module ActiveRecord
       def key_to_cast(val, key)
         return key if val.key?(key)
         return key.to_sym if val.key?(key.to_sym)
-        return key if defaults.key?(key)
+        key if defaults.key?(key)
       end
 
       def typed?(key)
@@ -133,7 +134,11 @@ module ActiveRecord
         owner&.store_attribute_unset_values_fallback_to_default && defaults.key?(key)
       end
 
-      attr_reader :accessor_types, :defaults, :store_accessor, :owner
+      def store_accessor
+        subtype.accessor
+      end
+
+      attr_reader :accessor_types, :defaults, :subtype, :owner
     end
   end
 end

data/lib/store_attribute/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: store_attribute
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - palkan
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -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,15 +99,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
-signing_key:
+rubygems_version: 3.4.19
+signing_key: 
 specification_version: 4
 summary: ActiveRecord extension which adds typecasting to store accessors
 test_files: []