store_attribute 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 076f7b987e61b6d32a5ee894f42d9ac85cf226df332400ff133bc492e4a4c184
-  data.tar.gz: 94fcf6d42c30e98888b8a9a7f7af880c1c2e3d0cabf25fc0e63b84e41d6e0f28
+  metadata.gz: 2134f240621f2f546e5521fe4db4b66e3b6ec0a4a76ebb832fbcae8654c0904e
+  data.tar.gz: 862ce5201d0c1ad548035161b0f51b50a9a540a85ae8be0a9c550976f918701c
 SHA512:
-  metadata.gz: 6ddff720796fe0c048712b846cdf1bebe54dfdaea59d93d1fbe59557fc263156e53955fb2ee8aef0cea840b7e50f629f193ae2da8a7580108c7c466781341b1f
-  data.tar.gz: 0e6d69b002d492fd4619b4fd4f24eddabbc5e06332c6a597d6b292f7c0cdcb565b4189f63f5bef9e342e40cf20d585d7508b2fc54cc9c0b4dc1f2763ca3bdf7d
+  metadata.gz: efe4992702c419f392f4fcbfd16c0ab32c862acf4679e841a7a8c28d40e0fb2eb66c2b72b2ac0156517a49bce4ee7308ec75ffa64604d4b879c735da0201d7f3
+  data.tar.gz: a9b8d3683abcd37f99a7c0ef68431e80e32a79537c5dab426e150a85b7d15c4b8ce1cb92e0a6c1c24031418286223e854fb2e2c73083c801781553f6559cd2c1

data/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 ## master
 
+## 1.1.0 (2023-03-08) 🌷
+
+- Add configuration option to return default values when attribute key is not present in the serialized value ([@markedmondson][], [@palkan][]).
+
+Add to the class (preferrable `ApplicationRecord` or some other base class):
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  self.store_attribute_unset_values_fallback_to_default = true
+
+  store_attribute :extra, :color, :string, default: "grey"
+end
+
+user = User.create!(extra: {})
+# without the fallback
+user.color #=> nil
+# with fallback
+user.color #=> "grey"
+```
+
 ## 1.0.2 (2022-07-29)
 
 - Fix possible conflicts with Active Model objects. ([@palkan][])

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright 2016-2020 palkan
+Copyright 2016-2023 palkan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -36,7 +36,7 @@ Where:
 - `store_name` The name of the store.
 - `name` The name of the accessor to the store.
 - `type` A symbol such as `:string` or `:integer`, or a type object to be used for the accessor.
-- `options` (optional) A hash of cast type options such as `precision`, `limit`, `scale`, `default`.
+- `options` (optional) A hash of cast type options such as `precision`, `limit`, `scale`, `default`. Regular `store_accessor` options, such as `prefix`, `suffix` are also supported.
 
 Type casting occurs every time you write data through accessor or update store itself
 and when object is loaded from database.
@@ -131,17 +131,30 @@ end
 Date.current #=> 2022-03-17
 
 user = User.new
-user.name #=> "john"
+user.name #=> "Joe"
 user.expired_at #=> 2022-03-19
 user.save!
 
 raw_user = RawUser.find(user.id)
-user.name #=> "john"
-user.expired_at #=> 2022-03-19
+raw_user.name #=> "Joe"
+raw_user.expired_at #=> 2022-03-19
 
 another_raw_user = RawUser.create!
 another_user = User.find(another_raw_user.id)
 
-user.name #=> nil
-user.expired_at #=> nil
+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:
+
+```ruby
+class User < ApplicationRecord
+  self.store_attribute_unset_values_fallback_to_default = true
+end
+
+user = User.create!(extra: {})
+user.expired_at #=> 2022-03-19
+```
+
+**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`).

data/lib/store_attribute/active_record/store.rb

@@ -10,6 +10,8 @@ module ActiveRecord
       alias_method :_orig_store_without_types, :store
       alias_method :_orig_store_accessor_without_types, :store_accessor
 
+      attr_writer :store_attribute_unset_values_fallback_to_default
+
       # Defines store on this model.
       #
       # +store_name+ The name of the store.
@@ -125,6 +127,17 @@ module ActiveRecord
         _store_local_stored_attribute(store_name, name, type, **options)
       end
 
+      def store_attribute_unset_values_fallback_to_default
+        return @store_attribute_unset_values_fallback_to_default if instance_variable_defined?(:@store_attribute_unset_values_fallback_to_default)
+
+        @store_attribute_unset_values_fallback_to_default =
+          if superclass.respond_to?(:store_attribute_unset_values_fallback_to_default)
+            superclass.store_attribute_unset_values_fallback_to_default
+          else
+            false
+          end
+      end
+
       def _store_local_stored_attribute(store_name, key, cast_type, default: Type::TypedStore::UNDEFINED, **options) # :nodoc:
         cast_type = ActiveRecord::Type.lookup(cast_type, **options) if cast_type.is_a?(Symbol)
         _local_typed_stored_attributes[store_name][key] = [cast_type, default]
@@ -156,10 +169,13 @@ module ActiveRecord
 
         defaultik = Type::TypedStore::Defaultik.new
 
+        owner = self
+
         if use_decorator
           decorate_attribute_type(attr_name, "typed_accessor_for_#{attr_name}") do |subtype|
             subtypes = _local_typed_stored_attributes[attr_name]
             type = Type::TypedStore.create_from_type(subtype)
+            type.owner = owner
             defaultik.type = type
             subtypes.each { |name, (cast_type, default)| type.add_typed_key(name, cast_type, default: default) }
 
@@ -173,6 +189,7 @@ module ActiveRecord
             subtype = _lookup_cast_type(attr_name, was_type, {}) if defined?(_lookup_cast_type)
 
             type = Type::TypedStore.create_from_type(subtype)
+            type.owner = owner
             defaultik.type = type
             subtypes.each { |name, (cast_type, default)| type.add_typed_key(name, cast_type, default: default) }
 

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

@@ -25,6 +25,8 @@ module ActiveRecord
         new(basetype)
       end
 
+      attr_writer :owner
+
       def initialize(subtype)
         @accessor_types = {}
         @defaults = {}
@@ -47,6 +49,8 @@ module ActiveRecord
         accessor_types.each do |key, type|
           if hash.key?(key)
             hash[key] = type.deserialize(hash[key])
+          elsif fallback_to_default?(key)
+            hash[key] = built_defaults[key]
           end
         end
         hash
@@ -106,6 +110,10 @@ module ActiveRecord
 
       protected
 
+      def built_defaults
+        @built_defaults ||= build_defaults
+      end
+
       # We cannot rely on string keys 'cause user input can contain symbol keys
       def key_to_cast(val, key)
         return key if val.key?(key)
@@ -121,7 +129,11 @@ module ActiveRecord
         accessor_types.fetch(key.to_s)
       end
 
-      attr_reader :accessor_types, :defaults, :store_accessor
+      def fallback_to_default?(key)
+        owner&.store_attribute_unset_values_fallback_to_default && defaults.key?(key)
+      end
+
+      attr_reader :accessor_types, :defaults, :store_accessor, :owner
     end
   end
 end

data/lib/store_attribute/version.rb

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

data/lib/store_attribute.rb

@@ -2,3 +2,6 @@
 
 require "store_attribute/version"
 require "store_attribute/active_record"
+
+module StoreAttribute
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: store_attribute
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-30 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: ActiveRecord extension which adds typecasting to store accessors