store_model 4.4.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe31f43187a97021f54c79cbc8372b7e2b1c5a3c4bcb7b07b13def128bf69f34
-  data.tar.gz: '0456813d7c47e3a9888c23bd83dc90c233f8919734766e348c064350c3d502ce'
+  metadata.gz: e69ab65c67b3cd46e0285be5860d8cd5b1d501b38e126f9833fbe01b3dda3ee8
+  data.tar.gz: 04b8d780feaaa6bfcb578465582b845d66960ba5f9df6e5d7aaa8d99f3d568bb
 SHA512:
-  metadata.gz: 54a697b1a4782fa6bf3a6f84972789f6b42aab7ef9702e243d7fa4b9d7a6c035ea1421a560eb848083dd414b9bd594d577ca82a50642718d80607d742db64561
-  data.tar.gz: d591bf765bb19d91cc7972762349075edbb5ec9d633f3b0e4b9c290069af132e35b9d011e4537de43c18f3de76ca863e8b0576d93502ac95b24e4abb250bedd3
+  metadata.gz: f8176e449148b7b7aa04596bf75b4932a156f737bac32395e79ae4ca5af9d6e186addb5c1de47b503f754b491f3a98a2ae081ce44fb8f3608c077f81fbcbe8d7
+  data.tar.gz: 9a771879567e9bbe266fa3825327469ac5b2e2008e7f90a7b608b72d28bbbb9704bd7f28e1498e4d65879c6014321a368557f54ec04fe23af0c7d4f8074d0613

data/README.md

@@ -22,7 +22,10 @@ class Product < ApplicationRecord
 end
 ```
 
-You can support my open–source work [here](https://boosty.to/dmitry_tsepelev).
+## Professional Support
+
+Working on a complex Rails application and need an experienced eye?
+I'm available for consulting — [get in touch](https://dmitrytsepelev.dev/consulting).
 
 ## Why should I wrap my JSON columns?
 
@@ -122,6 +125,48 @@ def supplier_params
 end
 ```
 
+### ActiveAdmin Integration
+
+If you're using [ActiveAdmin](https://activeadmin.info/), enable compatibility mode to make the `has_many` form helper work with StoreModel attributes:
+
+```ruby
+# config/initializers/store_model.rb
+StoreModel.config.active_admin_compatibility = true
+```
+
+Example usage:
+
+```ruby
+# app/models/supplier.rb
+class Supplier
+  include StoreModel::Model
+
+  attribute :title, :string
+  attribute :address, :string
+end
+
+# app/models/product.rb
+class Product < ApplicationRecord
+  include StoreModel::NestedAttributes
+
+  attribute :suppliers, Supplier.to_array_type
+  accepts_nested_attributes_for :suppliers, allow_destroy: true
+end
+
+# app/admin/products.rb
+ActiveAdmin.register Product do
+  permit_params suppliers_attributes: [:title, :address, :_destroy]
+
+  form do |f|
+    f.has_many :suppliers, allow_destroy: true do |s|
+      s.input :title
+      s.input :address
+    end
+    f.actions
+  end
+end
+```
+
 ## Documentation
 
 1. [Installation](./docs/installation.md)

data/lib/store_model/configuration.rb

@@ -32,11 +32,26 @@ module StoreModel
     # @return [Boolean]
     attr_accessor :enable_parent_assignment
 
+    # Controls if ActiveAdmin compatibility patches are applied.
+    # When enabled, adds methods like `new_record?` and `reflect_on_association`
+    # that are expected by ActiveAdmin's form builders.
+    # Default: false
+    # @return [Boolean]
+    attr_accessor :active_admin_compatibility
+
+    # Controls whether nested attributes updates preserve existing model instances by default.
+    # When true, acts like `update_only: true` for all singular nested attributes unless overridden.
+    # Default: false
+    # @return [Boolean]
+    attr_accessor :nested_attributes_update_only
+
     def initialize
       @serialize_unknown_attributes = true
       @enable_parent_assignment = true
       @serialize_enums_using_as_json = true
       @serialize_empty_attributes = true
+      @active_admin_compatibility = false
+      @nested_attributes_update_only = false
     end
   end
 end

data/lib/store_model/ext/active_admin_compatibility.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module StoreModel
+  # ActiveAdmin compatibility patches
+  #
+  # This module contains patches that make StoreModel compatible with ActiveAdmin's
+  # form builders, particularly the has_many helper which expects certain ActiveRecord-like
+  # methods to be present.
+  #
+  # To enable these patches, set:
+  #   StoreModel.config.active_admin_compatibility = true
+  module ActiveAdminCompatibility
+    # Reflection class for StoreModel associations.
+    # This provides compatibility with form builders like ActiveAdmin's has_many
+    # that expect ActiveRecord-style reflection objects.
+    class Reflection
+      attr_reader :name, :klass
+
+      # @param name [Symbol] association name
+      # @param klass [Class] the StoreModel class
+      def initialize(name, klass)
+        @name = name
+        @klass = klass
+      end
+    end
+
+    # Patch for StoreModel::Model to add new_record? method
+    module NewRecordPatch
+      # Always returns true for StoreModel instances when ActiveAdmin compatibility is enabled.
+      # This is needed for compatibility with form builders like ActiveAdmin's has_many.
+      # For ActiveRecord models, delegates to the original implementation.
+      #
+      # @return [Boolean]
+      def new_record?
+        super
+      rescue NoMethodError
+        true
+      end
+    end
+
+    # Patch for StoreModel::NestedAttributes::ClassMethods to add reflection methods
+    module ReflectionMethods
+      # Returns reflection for the given association name.
+      # This provides compatibility with form builders like ActiveAdmin's has_many.
+      # First checks if the attribute is a StoreModel collection type, and if so,
+      # returns a reflection for it. Otherwise, delegates to the original implementation
+      # for ActiveRecord associations.
+      #
+      # @param name [Symbol, String] association name
+      # @return [StoreModel::ActiveAdminCompatibility::Reflection, nil]
+      def reflect_on_association(name)
+        # First check if this is a StoreModel attribute
+        # Use attribute_types directly to get the type for the given attribute
+        type = attribute_types[name.to_s]
+
+        if type.is_a?(StoreModel::Types::ManyBase) && type.respond_to?(:model_klass) && type.model_klass
+          # Return reflection for StoreModel collection attributes
+          return StoreModel::ActiveAdminCompatibility::Reflection.new(name.to_sym, type.model_klass)
+        end
+
+        # Not a StoreModel attribute, try to call the original method for ActiveRecord associations
+        super
+      rescue NoMethodError
+        # No super method exists (pure StoreModel class), return nil
+        nil
+      end
+    end
+  end
+end

data/lib/store_model/ext/active_record/base.rb

@@ -8,14 +8,25 @@ module StoreModel
     include ParentAssignment
 
     def _read_attribute(*)
-      super.tap do |attribute|
-        assign_parent_to_store_model_relation(attribute)
-      end
+      value = super
+      assign_parent_to_store_model_relation(value) if store_model_attribute?(value)
+      value
     end
 
     def _write_attribute(*)
-      super.tap do |attribute|
-        assign_parent_to_store_model_relation(attribute)
+      value = super
+      assign_parent_to_store_model_relation(value) if store_model_attribute?(value)
+      value
+    end
+
+    private
+
+    def store_model_attribute?(value)
+      case value
+      when StoreModel::Model then true
+      when Array then value.first.is_a?(StoreModel::Model)
+      when Hash then value.each_value.any? { |v| v.is_a?(StoreModel::Model) }
+      else false
       end
     end
   end

data/lib/store_model/ext/parent_assignment.rb

@@ -13,7 +13,10 @@ module StoreModel
     end
 
     def assign_parent_to_singular_store_model(item)
-      item.parent = self if item.is_a?(StoreModel::Model)
+      return unless item.is_a?(StoreModel::Model)
+      return if item.frozen?
+
+      item.parent = self
     end
   end
 end

data/lib/store_model/model.rb

@@ -15,6 +15,7 @@ module StoreModel
       base.include ActiveRecord::AttributeMethods::BeforeTypeCast
       base.include ActiveModel::AttributeMethods
       base.include StoreModel::NestedAttributes
+      base.include ActiveModel::Validations::Callbacks
 
       if ActiveModel::VERSION::MAJOR >= 8 && ActiveModel::VERSION::MINOR >= 1
         base.include ActiveModel::Attributes::Normalization
@@ -215,7 +216,10 @@ module StoreModel
     #
     # @return [Hash]
     def unknown_attributes
-      @unknown_attributes ||= {}
+      return @unknown_attributes if defined?(@unknown_attributes)
+      return {}.freeze if frozen?
+
+      @unknown_attributes = {}
     end
 
     # Returns the value of the `@serialize_unknown_attributes` instance
@@ -313,6 +317,10 @@ module StoreModel
       return unless Array(attr.value).all? { |value| value.is_a?(StoreModel::Model) }
 
       Array(attr.value).each do |value|
+        # Skip frozen objects - they cannot have instance variables modified
+        # but will still serialize correctly with their existing settings
+        next if value.frozen?
+
         value.serialize_unknown_attributes = serialize_unknown_attributes
         value.serialize_enums_using_as_json = serialize_enums_using_as_json
         value.serialize_empty_attributes = serialize_empty_attributes

data/lib/store_model/nested_attributes.rb

@@ -50,7 +50,7 @@ module StoreModel
 
         attributes.each do |attribute|
           if nested_attribute_type(attribute).is_a?(Types::Base)
-            options.reverse_merge!(allow_destroy: false, update_only: false)
+            options.reverse_merge!(allow_destroy: false, update_only: StoreModel.config.nested_attributes_update_only)
             define_store_model_attr_accessors(attribute, options)
           else
             super(*attribute, options)

data/lib/store_model/railtie.rb

@@ -2,6 +2,7 @@
 
 require "store_model/ext/active_model/attributes"
 require "store_model/ext/active_record/base"
+require "store_model/ext/active_admin_compatibility"
 
 module StoreModel # :nodoc:
   class Railtie < Rails::Railtie # :nodoc:
@@ -11,6 +12,11 @@ module StoreModel # :nodoc:
           ActiveModel::Attributes.prepend(Attributes)
           prepend(Base)
         end
+
+        if StoreModel.config.active_admin_compatibility
+          StoreModel::Model.prepend(ActiveAdminCompatibility::NewRecordPatch)
+          StoreModel::NestedAttributes::ClassMethods.prepend(ActiveAdminCompatibility::ReflectionMethods)
+        end
       end
     end
   end

data/lib/store_model/types/one_of.rb

@@ -7,12 +7,13 @@ module StoreModel
     # Implements ActiveModel::Type::Value type for handling an array of
     # StoreModel::Model
     class OneOf
-      def initialize(&block)
+      def initialize(union: false, &block)
         @block = block
+        @union = union
       end
 
       def to_type
-        Types::OnePolymorphic.new(@block)
+        Types::OnePolymorphic.new(@block, union: @union)
       end
 
       def to_array_type

data/lib/store_model/types/one_polymorphic.rb

@@ -13,8 +13,9 @@ module StoreModel
       # @param model_wrapper [Proc] class to handle
       #
       # @return [StoreModel::Types::OnePolymorphic ]
-      def initialize(model_wrapper)
+      def initialize(model_wrapper, union: false)
         @model_wrapper = model_wrapper
+        @union = union
         super()
       end
 
@@ -30,8 +31,9 @@ module StoreModel
       # @param value [Object] a value to cast
       #
       # @return StoreModel::Model
-      def cast_value(value) # rubocop:disable Metrics/MethodLength
+      def cast_value(value) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
         return nil if value.nil?
+        return nil if @union && value.respond_to?(:empty?) && value.empty?
 
         if value.is_a?(String)
           decode_and_initialize(value)
@@ -87,6 +89,18 @@ module StoreModel
               "Hash or instances which implement StoreModel::Model are allowed"
       end
 
+      # rubocop:disable Style/RescueModifier
+      def decode_and_initialize(value)
+        decoded = ActiveSupport::JSON.decode(value) rescue nil
+        return nil if decoded.nil?
+        return nil if @union && decoded.respond_to?(:empty?) && decoded.empty?
+
+        model_instance(decoded)
+      rescue ActiveModel::UnknownAttributeError => e
+        handle_unknown_attribute(decoded, e)
+      end
+      # rubocop:enable Style/RescueModifier
+
       def model_instance(value)
         extract_model_klass(value).new(value)
       end

data/lib/store_model/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StoreModel # :nodoc:
-  VERSION = "4.4.0"
+  VERSION = "4.6.0"
 end

data/lib/store_model.rb

@@ -58,7 +58,7 @@ module StoreModel # :nodoc:
     end
 
     def union_one_of(discriminator, class_map)
-      Types::OneOf.new do |attributes|
+      Types::OneOf.new(union: true) do |attributes|
         next nil unless attributes
 
         discriminator_value = attributes.with_indifferent_access[discriminator]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: store_model
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.6.0
 platform: ruby
 authors:
 - DmitryTsepelev
@@ -84,6 +84,7 @@ files:
 - lib/store_model/combine_errors_strategies/merge_hash_error_strategy.rb
 - lib/store_model/configuration.rb
 - lib/store_model/enum.rb
+- lib/store_model/ext/active_admin_compatibility.rb
 - lib/store_model/ext/active_model/attributes.rb
 - lib/store_model/ext/active_record/base.rb
 - lib/store_model/ext/parent_assignment.rb