active_typed_store 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50bbecd62a4d3aa891d342f43de9e619b0d01a767b975a4fd12b4b529a3c1255
-  data.tar.gz: bb70b58ecadd380b1510be0687fc2a89ce709a53f3176538ccedb6cb0393cade
+  metadata.gz: e69cb858697a79e92cbfcfb8147a2c8c5861e94a693b7097ce8f961bc4973bf6
+  data.tar.gz: 934c15165efc0c5f04d59c2f831b262866abedd49ec1ab0efaf978417a58783e
 SHA512:
-  metadata.gz: 47d26171b7aac604865a99ec2bca566093b49314eba00543b75a82e3d415ee2b89a55cbce121086689b4827bcd88937983c1ec24225a6948d7393f984f1aa09e
-  data.tar.gz: c8ddba819be92a726cda8ff7cb00cfe2054c4afd69564790899079d85c00c0a395dbca979f32381923e58aed1b76cb55327bcf1319924bc58b43282a2c9e24e5
+  metadata.gz: 9507a3d04171ca491053553829c22662c46f301efd01712ddf47173a07bcfb1867eec373ec7d9e8d9ec907216bc8fbd383ba2fa4e79e1953c6ed313de511eb9a
+  data.tar.gz: 010a2ac3ad8063d1ee9bab17b7437bd348ff2d78856cf970c23a6bb2603822c4c8f1dfa844e3456ec81d4b95c80c1de444b85bbf164f9a725ceaa31f095c13bf

data/Gemfile.lock

@@ -22,10 +22,10 @@ GIT
 PATH
   remote: .
   specs:
-    active_typed_store (2.5.0)
-      activemodel
-      activerecord
-      activesupport
+    active_typed_store (2.7.0)
+      activemodel (>= 7.1)
+      activerecord (>= 7.1)
+      activesupport (>= 7.1)
 
 GEM
   remote: https://rubygems.org/
@@ -75,7 +75,6 @@ GEM
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     logger (1.6.1)
-    mini_portile2 (2.8.9)
     minitest (5.25.1)
     parallel (1.26.3)
     parser (3.3.5.0)
@@ -131,8 +130,9 @@ GEM
     ruby-progressbar (1.13.0)
     rumoji (0.5.0)
     securerandom (0.3.1)
-    sqlite3 (1.7.3)
-      mini_portile2 (~> 2.8.0)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-darwin)
+    sqlite3 (1.7.3-x86_64-linux)
     timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -143,6 +143,31 @@ class Parcel
 end
 ```
 
+### Encrypted store
+
+`encrypted: true` keeps keys of the store readable and encrypts every value like Rails `encrypts`:
+
+```ruby
+class SupplierImportSetting < ActiveRecord::Base
+  typed_store :marketplace_credentials, encrypted: true do
+    attr :wb_token,       :string
+    attr :ozon_token,     :string
+    attr :ozon_client_id, :string
+  end
+end
+
+setting.update!(wb_token: "secret", ozon_client_id: "123")
+# in the database: {"wb_token": "{\"p\":\"...\",\"h\":{...}}", "ozon_client_id": "{\"p\":\"...\",\"h\":{...}}"}
+```
+
+- Values are encrypted by `ActiveRecord::Encryption::EncryptedAttributeType` with the same scheme as `encrypts`:
+  [Active Record Encryption](https://guides.rubyonrails.org/active_record_encryption.html) must be configured,
+  `encrypts` options can be passed instead of `true`: `encrypted: { deterministic: true }`,
+  `encrypted: { previous: { key: "old key" } }`, `encrypted: { support_unencrypted_data: true }`.
+- Any value type is supported: the value is JSON-encoded before encryption.
+- Don't add `encrypts` for the store column or its accessors: it conflicts with typed_store or silently does nothing.
+- Like with `encrypts`, decrypted values are in `changes`, `attributes` and the store hash.
+
 ### 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`.
 

data/lib/active_typed_store/encrypted_json.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ActiveTypedStore
+  module Store
+    # typed_store(:params, encrypted: true): keys are stored as is, every value is encrypted like Rails `encrypts`.
+    # Options are `encrypts` options: encrypted: { deterministic: true, previous: ..., support_unencrypted_data: true }
+    class EncryptedJson < CustomJson
+      # value is JSON-encoded before encryption to keep its type; not encrypted value (support_unencrypted_data)
+      # is returned as is, it may be not JSON
+      class ValueJson < ActiveRecord::Type::Json
+        def deserialize(value)
+          return value unless value.is_a?(::String)
+
+          ActiveSupport::JSON.decode(value)
+        rescue JSON::ParserError
+          value
+        end
+      end
+
+      def initialize(scheme_options)
+        super()
+        @scheme_options = scheme_options
+      end
+
+      def serialize(value) = super(value.is_a?(Hash) ? value.transform_values { value_type.serialize(_1) } : value)
+
+      def deserialize(value)
+        hash = super
+        hash.is_a?(Hash) ? hash.transform_values { value_type.deserialize(_1) } : hash
+      end
+
+      # deserialize(serialize(value)) gives the same as plain json, but encrypts and decrypts every value
+      # on every assignment and dirty check
+      def cast(value) = CUSTOM_JSON.cast(value)
+      def changed_in_place?(raw_old_value, new_value) = deserialize(raw_old_value) != cast(new_value)
+
+      # built lazily like `encrypts` does: encryption config may be not loaded yet when the model is defined
+      private def value_type
+        @value_type ||= ActiveRecord::Encryption::EncryptedAttributeType.new(
+          scheme:    ActiveRecord::Base.send(:scheme_for, **@scheme_options),
+          cast_type: ValueJson.new,
+        )
+      end
+    end
+  end
+end

data/lib/active_typed_store/store.rb

@@ -10,16 +10,25 @@ module ActiveTypedStore
 
     CUSTOM_JSON = CustomJson.new
 
-    def typed_store(store_attribute, &)
+    def typed_store(store_attribute, encrypted: false, &block)
       attrs = Attrs.new(store_attribute)
-      attrs.instance_eval(&)
+      attrs.instance_eval(&block)
+
+      json_type =
+        if encrypted
+          # not required on load: it loads ActiveRecord::Encryption
+          require_relative "encrypted_json"
+          EncryptedJson.new(encrypted == true ? {} : encrypted)
+        else
+          CUSTOM_JSON
+        end
 
       define_singleton_method(:inherited) do |subclass|
         super(subclass)
-        subclass.define_attribute(store_attribute.name, CUSTOM_JSON)
+        subclass.define_attribute(store_attribute.name, json_type)
       end
 
-      define_attribute store_attribute.name, CUSTOM_JSON
+      define_attribute store_attribute.name, json_type
       store_accessor store_attribute, attrs.fields
 
       if ActiveTypedStore.config.hash_safety == :disallow_symbol_keys

data/lib/active_typed_store/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_typed_store
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Ermolaev Andrey
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-06-29 00:00:00.000000000 Z
+date: 2026-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,43 +16,43 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description:
+        version: '7.1'
+description: 
 email:
 - andruhafirst@yandex.ru
 executables: []
@@ -72,6 +72,7 @@ files:
 - lib/active_typed_store/attrs.rb
 - lib/active_typed_store/configuration.rb
 - lib/active_typed_store/disallow_symbol_keys.rb
+- lib/active_typed_store/encrypted_json.rb
 - lib/active_typed_store/store.rb
 - lib/active_typed_store/version.rb
 homepage: https://github.com/corp-gp/active_typed_store
@@ -79,7 +80,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Typed store for active records json columns (postgresql, mysql, sqlite)
 test_files: []