active_typed_store 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7e95f3805fc3ef46bb5fa9ce567e2470396150130720d78d7617a1bd1b63d44
-  data.tar.gz: 9d178c5936bab0bd8ec4c400102b7b784ea5a4666697e34a6efeebfd3703088a
+  metadata.gz: 81b1efdd481c9034944b0b3ad6acb8972492128a13197a5054d291ee1b2e23ae
+  data.tar.gz: 8af315be7e55e6af5bba99f126b1abf26217f3634aef8aae708abf0887270c5c
 SHA512:
-  metadata.gz: 8c140d6d25206075d0db2493f54dbb468902b45a98a42748c5e56fe7e513b418d1c2ca527fdada93309718dd3f4d92050f66ddd067d5e879c62b0cadd22ba1bc
-  data.tar.gz: ba3b3ce6ed5a4c7c17464765dbe9cfad4aa910fc48e03b3a89ddbaef5fba4a84b2ad57ac2aaad618a45bcf1b7ff59d93d25b0380158001443e6747b45e71bf69
+  metadata.gz: 7dd04ad99513208826305d50e04b558778800b4ce3dbc6873193d995eb638b48a36c84c20b3a9c57dda18af7503751b48d9af291c6d720314ddf60a988f41b8c
+  data.tar.gz: eb4103cf2a62dc935a4cb283896083710f66a60146a5e4086c4fbcf57d215d52e88f5102f744aded09fa4291e1e62afca3375cadc05cf5c2dcbf6e72e9652995

data/Gemfile.lock

@@ -22,7 +22,7 @@ GIT
 PATH
   remote: .
   specs:
-    active_typed_store (1.0.0)
+    active_typed_store (1.2.0)
       activemodel
       activerecord
       activesupport
@@ -141,6 +141,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-23
   x86_64-darwin-21
   x86_64-linux
 

data/README.md

@@ -1,6 +1,6 @@
 # ActiveTypedStore
 
-`active_typed_store` is a lightweight (__65 lines of code__) and highly performant gem (see [benchmarks](#benchmarks))
+`active_typed_store` is a lightweight (__105 lines of code__) and highly performant gem (see [benchmarks](#benchmarks))
 designed to help you store and manage typed data in JSON format within database.
 This gem provides a simple, yet powerful way to ensure that your JSON data cast
 to specific types, enabling more structured and reliable use of JSON fields in your Rails models.
@@ -47,7 +47,7 @@ m.asap? # => true
 - `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` 
+  - `precision`, `limit`, `scale`
   - `default` the default value to use when no value is provided. Otherwise, the default will be nil
   - `array` specifies that the type should be an array
 
@@ -80,17 +80,41 @@ class Model < ActiveRecord::Base
 end
 ```
 
+### Hash safety
+This gem assumes you're using a database that supports structured data types, such as `json` in `PostgreSQL` or `MySQL`, and leverages Rails' [store_accessor](https://edgeapi.rubyonrails.org/classes/ActiveRecord/Store.html) under the hood. However, there’s one caveat: JSON columns use a string-keyed hash and don’t support access via symbols. To avoid unexpected errors when accessing the hash, we raise an error if a symbol is used. You can disable this behavior by setting `config.hash_safety = false`.
+
+```ruby
+class Model < ActiveRecord::Base
+  typed_store(:params) do
+    attr :price,  :decimal
+  end
+end
+
+record = Model.new(price: 1)
+record["price"] # 1
+record[:price] # raises "Symbol keys are not allowed `:price` (ActiveTypedStore::SymbolKeysDisallowed)"
+
+# initializers/active_type_store.rb
+ActiveTypeStore.configure do |config|
+  config.hash_safety = false # default :disallow_symbol_keys
+end
+
+record["price"] # 1
+record[:price] # nil - isn't the expected behavior for most applications
+```
+
 ### Benchmarks
 compare `active_typed_store` with other gems
 ```ruby
+# ruby 3.3.5 arm64-darwin24
 #                    gem     getter  i/s                setter i/s            Lines of code
-#  rails (without types):    27930.8                    660                   170
-#     active_typed_store:    24318.5 - 1.15x  slower    656                   65
-#        store_attribute:    23748.3 - 1.18x  slower    639                   276
-#            store_model:    23324.4 - 1.20x  slower    595                   857
-#              attr_json:    15541.4 - 1.80x  slower    577 - 1.14x  slower   1195
-#         jsonb_accessor:    15000.1 - 1.86x  slower    626                   324
-```       
+#     active_typed_store:    28502.2                    656                   105
+#  rails (without types):    27350.5                    660                   170
+#        store_attribute:    24592.2 - 1.16x  slower    639                   276
+#            store_model:    22833.6 - 1.25x  slower    595                   857
+#              attr_json:    14000.4 - 2.03x  slower    577 - 1.14x  slower   1195
+#         jsonb_accessor:    13995.4 - 2.04x  slower    626                   324
+```
 
 ## License
 

data/lib/active_typed_store/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActiveTypedStore
+  class Configuration
+    attr_accessor :hash_safety
+
+    def initialize
+      self.hash_safety = :disallow_symbol_keys
+    end
+  end
+
+  module Configurable
+    attr_writer :config
+
+    def config
+      @config ||= ActiveTypedStore::Configuration.new
+    end
+
+    def configure
+      yield(config)
+    end
+  end
+end

data/lib/active_typed_store/disallow_symbol_keys.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ActiveTypedStore
+  class SymbolKeysDisallowed < StandardError; end
+
+  DEFAULT_PROC =
+    proc do |_hash, key|
+      raise(SymbolKeysDisallowed, "Symbol keys are not allowed `#{key.inspect}`") if key.is_a?(Symbol)
+    end
+
+  module DisallowSymbolKeys
+    def self.call!(hash)
+      return unless hash.is_a?(Hash)
+
+      hash.default_proc ||= DEFAULT_PROC
+      hash.each_value { call!(_1) }
+    end
+  end
+
+  # Same interface as ActiveRecord::Store::HashAccessor
+  # Optimized by using object.read_attribute(attribute) instead of object.send(attribute)
+  class StoreHashAccessor
+    def self.read(object, attribute, key)
+      prepare(object, attribute)
+      object.read_attribute(attribute)[key]
+    end
+
+    def self.write(object, attribute, key, value)
+      prepare(object, attribute)
+      object.read_attribute(attribute)[key] = value if value != object.read_attribute(attribute)[key]
+    end
+
+    def self.prepare(object, attribute)
+      object.public_send :"#{attribute}=", {} unless object.read_attribute(attribute)
+    end
+  end
+end

data/lib/active_typed_store/store.rb

@@ -6,7 +6,20 @@ module ActiveTypedStore
       attrs = Attrs.new(store_attribute)
       attrs.instance_eval(&)
 
-      store store_attribute, accessors: attrs.fields, coder: JSON
+      store_accessor store_attribute, attrs.fields
+
+      if ActiveTypedStore.config.hash_safety == :disallow_symbol_keys
+        define_method store_attribute do
+          super().tap { ActiveTypedStore::DisallowSymbolKeys.call!(_1) }
+        end
+
+        define_method :store_accessor_for do |_store_attribute|
+          ActiveTypedStore::StoreHashAccessor
+        end
+
+        private :store_accessor_for
+      end
+
       include attrs.store_module
     end
   end

data/lib/active_typed_store/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveTypedStore
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/active_typed_store.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
 require_relative "active_typed_store/version"
+require_relative "active_typed_store/configuration"
 require "active_support"
 
 ActiveSupport.on_load(:active_record) do
   require_relative "active_typed_store/store"
   require_relative "active_typed_store/attrs"
+  require_relative "active_typed_store/disallow_symbol_keys"
+
   ActiveSupport.on_load(:active_record) { extend ActiveTypedStore::Store }
 end
+
+module ActiveTypedStore
+  extend ActiveTypedStore::Configurable
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_typed_store
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ermolaev Andrey
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-11 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -70,6 +70,8 @@ files:
 - bin/setup
 - lib/active_typed_store.rb
 - lib/active_typed_store/attrs.rb
+- lib/active_typed_store/configuration.rb
+- lib/active_typed_store/disallow_symbol_keys.rb
 - lib/active_typed_store/store.rb
 - lib/active_typed_store/version.rb
 homepage: https://github.com/corp-gp/active_typed_store