store_attribute 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 721458d48d2bb0a7d065ce63e4e3c34829453f3f3060c8536cc4b5a40f378a12
-  data.tar.gz: 0fc7432f8f08b3f3e3d8e8c1c5a77d56267f2cdc6d31c802fbac87dc48dd15ae
+  metadata.gz: 8e666327899587f17df5c5196abd1f6094388d08c4ca4c020b9a67f182fa0660
+  data.tar.gz: 6a23e7d6122483843caaa7ae6d2da59e33e0c250c96306839bbb4cac8242ea87
 SHA512:
-  metadata.gz: f598a6db05ed959744fb1959d7b3675b99e15459668ec4ca957276ada7fc5915cbdcdaedd88a46aa57805d11c99ef710adcd56d45d27e1aa9d7b5eb31fff4974
-  data.tar.gz: 5bca850c0073164d07f607482e4711e0341a06521f3129c92ef1faaf47e0d76b3fa9701d6a37648a3ba98be3b57f9d6afe2986a18a3aab916c0e1f4432d0896f
+  metadata.gz: b61d2f76d32c9ddbe3c993896a1826662b8afc881e7b72674ab21d8954e70dbae25630996ab920eeeb752436e433949bec36914d3b6a3278909ca85fce889de5
+  data.tar.gz: 07bb42459a9925b247b6cea363df401c4c9a92787bf6aca1de2bf795575e5895f331a0d4cd983e9b82ee1d27d0a35b47cd6a791314a756fcf78b438e8a25aea0

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## master
 
+## 0.9.0 (2021-08-17) 📉
+
+- Default values no longer marked as dirty. ([@markedmondson][])
+
+## 0.8.1 (2020-12-03)
+
+- Fix adding dirty tracking methods for `store_attribute`. ([@palkan][])
+
+## 0.8.0
+
+- Add Rails 6.1 compatibility. ([@palkan][])
+
+- Add support for `prefix` and `suffix` options. ([@palkan][])
+
+## 0.7.1
+
+- Fixed bug with `store` called without accessors. ([@ioki-klaus][])
+
+  See [#10](https://github.com/palkan/store_attribute/pull/10).
+
+## 0.7.0 (2020-03-23)
+
 - Added dirty tracking methods. ([@glaszig][])
 
   [PR #8](https://github.com/palkan/store_attribute/pull/8).
@@ -18,3 +40,5 @@
 [@dreikanter]: https://github.com/dreikanter
 [@SumLare]: https://github.com/SumLare
 [@glaszig]: https://github.com/glaszig
+[@ioki-klaus]: https://github.com/ioki-klaus
+[@markedmondson]: https://github.com/markedmondson

data/README.md

@@ -1,4 +1,6 @@
-[![Gem Version](https://badge.fury.io/rb/store_attribute.svg)](https://rubygems.org/gems/store_attribute) [![Build Status](https://travis-ci.org/palkan/store_attribute.svg?branch=master)](https://travis-ci.org/palkan/store_attribute)
+[![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](https://cultofmartians.com/tasks/store-attribute-defaults.html#task)
+[![Gem Version](https://badge.fury.io/rb/store_attribute.svg)](https://rubygems.org/gems/store_attribute)
+![Build](https://github.com/palkan/store_attribute/workflows/Build/badge.svg)
 
 ## Store Attribute
 
@@ -14,7 +16,7 @@ In your Gemfile:
 
 ```ruby
 # for Rails 5+ (6 is supported)
-gem "store_attribute", "~> 0.5.0"
+gem "store_attribute", "~> 0.8.0"
 
 # for Rails 4.2
 gem "store_attribute", "~> 0.4.0"
@@ -47,6 +49,7 @@ class MegaUser < User
   store_attribute :settings, :login_at, :datetime
   store_attribute :settings, :active, :boolean
   store_attribute :settings, :color, :string, default: "red"
+  store_attribute :settings, :colors, :json, default: ["red", "blue"]
   store_attribute :settings, :data, :datetime, default: -> { Time.now }
 end
 
@@ -58,6 +61,8 @@ u.ratio # => 63
 u.active # => false
 # Default value is set
 u.color # => red
+# Default array is set
+u.colors # => ["red", "blue"]
 # A dynamic default can also be provided
 u.data # => Current time
 # And we also have a predicate method

data/lib/store_attribute/active_record/store.rb

@@ -26,7 +26,7 @@ module ActiveRecord
       def store(store_name, options = {})
         accessors = options.delete(:accessors)
         typed_accessors =
-          if accessors.last.is_a?(Hash)
+          if accessors && accessors.last.is_a?(Hash)
             accessors.pop
           else
             {}
@@ -44,24 +44,48 @@ module ActiveRecord
       #
       # +typed_keys+ The key-to-type hash of the accesors with type to the store.
       #
+      # +prefix+ Accessor method name prefix
+      #
+      # +suffix+ Accessor method name suffix
+      #
       # Examples:
       #
       #   class SuperUser < User
       #     store_accessor :settings, :privileges, login_at: :datetime
       #   end
-      def store_accessor(store_name, *keys, **typed_keys)
+      def store_accessor(store_name, *keys, prefix: nil, suffix: nil, **typed_keys)
         keys = keys.flatten
         typed_keys = typed_keys.except(keys)
 
-        _define_accessors_methods(store_name, *keys)
+        accessor_prefix, accessor_suffix = _normalize_prefix_suffix(store_name, prefix, suffix)
 
-        _define_dirty_tracking_methods(store_name, keys)
-        _define_dirty_tracking_methods(store_name, typed_keys.keys)
+        _define_accessors_methods(store_name, *keys, prefix: accessor_prefix, suffix: accessor_suffix)
 
         _prepare_local_stored_attributes(store_name, *keys)
 
+        _store_accessors_module.module_eval do
+          define_method("changes") do
+            return @changes if defined?(@changes)
+            changes = super()
+            self.class.local_stored_attributes.each do |accessor, attributes|
+              next unless attribute_changed?(accessor)
+
+              prev_store, new_store = changes[accessor]
+              prev_store.each do |key, value|
+                if new_store[key] == value
+                  changes[accessor][0].except!(key)
+                  changes[accessor][1].except!(key)
+                end
+              end
+            end
+            @changes = changes
+          end
+        end
+
+        _define_dirty_tracking_methods(store_name, keys + typed_keys.keys, prefix: accessor_prefix, suffix: accessor_suffix)
+
         typed_keys.each do |key, type|
-          store_attribute(store_name, key, type)
+          store_attribute(store_name, key, type, prefix: prefix, suffix: suffix)
         end
       end
 
@@ -78,6 +102,10 @@ module ActiveRecord
       # +type+ A symbol such as +:string+ or +:integer+, or a type object
       # to be used for the accessor.
       #
+      # +prefix+ Accessor method name prefix
+      #
+      # +suffix+ Accessor method name suffix
+      #
       # +options+ A hash of cast type options such as +precision+, +limit+, +scale+.
       #
       # Examples:
@@ -85,13 +113,16 @@ module ActiveRecord
       #   class MegaUser < User
       #     store_attribute :settings, :ratio, :integer, limit: 1
       #     store_attribute :settings, :login_at, :datetime
+      #
+      #     store_attribute :extra, :version, :integer, prefix: :meta
       #   end
       #
-      #   u = MegaUser.new(active: false, login_at: '2015-01-01 00:01', ratio: "63.4608")
+      #   u = MegaUser.new(active: false, login_at: '2015-01-01 00:01', ratio: "63.4608", meta_version: "1")
       #
       #   u.login_at.is_a?(DateTime) # => true
       #   u.login_at = DateTime.new(2015,1,1,11,0,0)
       #   u.ratio # => 63
+      #   u.meta_version #=> 1
       #   u.reload
       #
       #   # After loading record from db store contains casted data
@@ -108,16 +139,33 @@ module ActiveRecord
       #   u.settings['ratio'] # => 3
       #
       # For more examples on using types, see documentation for ActiveRecord::Attributes.
-      def store_attribute(store_name, name, type, **options)
-        _define_accessors_methods(store_name, name)
+      def store_attribute(store_name, name, type, prefix: nil, suffix: nil, **options)
+        prefix, suffix = _normalize_prefix_suffix(store_name, prefix, suffix)
+
+        _define_accessors_methods(store_name, name, prefix: prefix, suffix: suffix)
 
-        _define_predicate_method(name) if type == :boolean
+        _define_predicate_method(name, prefix: prefix, suffix: suffix) if type == :boolean
 
-        decorate_attribute_type(store_name, "typed_accessor_for_#{name}") do |subtype|
-          Type::TypedStore.create_from_type(subtype, name, type, **options)
+        # Rails >6.0
+        if !respond_to?(:decorate_attribute_type) || method(:decorate_attribute_type).parameters.count { |type, _| type == :req } == 1
+          attr_name = store_name.to_s
+          was_type = attributes_to_define_after_schema_loads[attr_name]&.first
+          attribute(attr_name) do |subtype|
+            if defined?(_lookup_cast_type)
+              Type::TypedStore.create_from_type(_lookup_cast_type(attr_name, was_type, {}), name, type, **options)
+            else
+              Type::TypedStore.create_from_type(subtype, name, type, **options)
+            end
+          end
+        else
+          decorate_attribute_type(store_name, "typed_accessor_for_#{name}") do |subtype|
+            Type::TypedStore.create_from_type(subtype, name, type, **options)
+          end
         end
 
         _prepare_local_stored_attributes(store_name, name)
+
+        _define_dirty_tracking_methods(store_name, [name], prefix: prefix, suffix: suffix)
       end
 
       def _prepare_local_stored_attributes(store_name, *keys) # :nodoc:
@@ -128,64 +176,69 @@ module ActiveRecord
         self.local_stored_attributes[store_name] |= keys
       end
 
-      def _define_accessors_methods(store_name, *keys) # :nodoc:
+      def _define_accessors_methods(store_name, *keys, prefix: nil, suffix: nil) # :nodoc:
         _store_accessors_module.module_eval do
           keys.each do |key|
-            define_method("#{key}=") do |value|
+            accessor_key = "#{prefix}#{key}#{suffix}"
+
+            define_method("#{accessor_key}=") do |value|
               write_store_attribute(store_name, key, value)
             end
 
-            define_method(key) do
+            define_method(accessor_key) do
               read_store_attribute(store_name, key)
             end
           end
         end
       end
 
-      def _define_predicate_method(name)
+      def _define_predicate_method(name, prefix: nil, suffix: nil)
         _store_accessors_module.module_eval do
+          name = "#{prefix}#{name}#{suffix}"
+
           define_method("#{name}?") do
             send(name) == true
           end
         end
       end
 
-      def _define_dirty_tracking_methods(store_attribute, keys)
+      def _define_dirty_tracking_methods(store_attribute, keys, prefix: nil, suffix: nil)
         _store_accessors_module.module_eval do
           keys.flatten.each do |key|
             key = key.to_s
+            accessor_key = "#{prefix}#{key}#{suffix}"
 
-            define_method("#{key}_changed?") do
+            define_method("#{accessor_key}_changed?") do
               return false unless attribute_changed?(store_attribute)
               prev_store, new_store = changes[store_attribute]
               prev_store&.dig(key) != new_store&.dig(key)
             end
 
-            define_method("#{key}_change") do
+            define_method("#{accessor_key}_change") do
               return unless attribute_changed?(store_attribute)
               prev_store, new_store = changes[store_attribute]
               [prev_store&.dig(key), new_store&.dig(key)]
             end
 
-            define_method("#{key}_was") do
+            define_method("#{accessor_key}_was") do
               return unless attribute_changed?(store_attribute)
               prev_store, _new_store = changes[store_attribute]
               prev_store&.dig(key)
             end
 
-            define_method("saved_change_to_#{key}?") do
+            define_method("saved_change_to_#{accessor_key}?") do
               return false unless saved_change_to_attribute?(store_attribute)
               prev_store, new_store = saved_change_to_attribute(store_attribute)
               prev_store&.dig(key) != new_store&.dig(key)
             end
 
-            define_method("saved_change_to_#{key}") do
+            define_method("saved_change_to_#{accessor_key}") do
               return unless saved_change_to_attribute?(store_attribute)
               prev_store, new_store = saved_change_to_attribute(store_attribute)
               [prev_store&.dig(key), new_store&.dig(key)]
             end
 
-            define_method("#{key}_before_last_save") do
+            define_method("#{accessor_key}_before_last_save") do
               return unless saved_change_to_attribute?(store_attribute)
               prev_store, _new_store = saved_change_to_attribute(store_attribute)
               prev_store&.dig(key)
@@ -193,6 +246,26 @@ module ActiveRecord
           end
         end
       end
+
+      def _normalize_prefix_suffix(store_name, prefix, suffix)
+        prefix =
+          case prefix
+          when String, Symbol
+            "#{prefix}_"
+          when TrueClass
+            "#{store_name}_"
+          end
+
+        suffix =
+          case suffix
+          when String, Symbol
+            "_#{suffix}"
+          when TrueClass
+            "_#{store_name}"
+          end
+
+        [prefix, suffix]
+      end
     end
   end
 end

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

@@ -43,6 +43,10 @@ module ActiveRecord
         hash
       end
 
+      def changed_in_place?(raw_old_value, new_value)
+        raw_old_value != serialize(new_value)
+      end
+
       def serialize(value)
         return super(value) unless value.is_a?(Hash)
         typed_casted = {}

data/lib/store_attribute/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: store_attribute
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -118,7 +118,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
@@ -133,8 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: ActiveRecord extension which adds typecasting to store accessors
 test_files: []