THUND-174: Default to immediate initialization of the association

CHANGELOG.md

@@ -4,6 +4,12 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.0] - 2025-07-11
+
+### Added
+
+- New LargeTextField::Base module, which delays the initialization of the association(s), and made LargeTextField::Owner a simple wrapper around Base which includes Base and initializes the association immediately. This was required to handle regressions for use cases that included the module, but did not define any large text value fields
+
 ## [1.3.0] - 2025-07-09
 
 ### Added

Gemfile.lock

@@ -1,25 +1,25 @@
 PATH
   remote: .
   specs:
-    large_text_field (1.3.0)
+    large_text_field (1.4.0)
       invoca-utils (~> 0.3)
       rails (>= 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     actioncable (6.1.7.3)
       actionpack (= 6.1.7.3)
       activesupport (= 6.1.7.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
     actionmailbox (6.1.7.3)
       actionpack (= 6.1.7.3)
       activejob (= 6.1.7.3)
       activerecord (= 6.1.7.3)
       activestorage (= 6.1.7.3)
       activesupport (= 6.1.7.3)
       mail (>= 2.7.1)
     actionmailer (6.1.7.3)
       actionpack (= 6.1.7.3)
       actionview (= 6.1.7.3)
@@ -29,16 +29,16 @@
       rails-dom-testing (~> 2.0)
     actionpack (6.1.7.3)
       actionview (= 6.1.7.3)
       activesupport (= 6.1.7.3)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
     actiontext (6.1.7.3)
       actionpack (= 6.1.7.3)
       activerecord (= 6.1.7.3)
       activestorage (= 6.1.7.3)
       activesupport (= 6.1.7.3)
       nokogiri (>= 1.8.5)
     actionview (6.1.7.3)
       activesupport (= 6.1.7.3)
@@ -96,7 +96,7 @@
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
       net-pop
       net-smtp
@@ -164,7 +164,7 @@
       thor (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.0)
     rexml (3.2.5)
     rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)

lib/large_text_field/base.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require "invoca/utils"
+
+module LargeTextField
+  module Base
+    extend ActiveSupport::Concern
+    include ActiveSupport::Callbacks
+
+    included do
+      validate         :validate_large_text_fields
+      before_save      :write_large_text_field_changes
+      define_callbacks :large_text_field_save
+
+      class_attribute :large_text_field_options
+      self.large_text_field_options = {}
+
+      class_attribute :initialized
+      self.initialized = false
+
+      class_attribute :large_text_field_class_name
+      self.large_text_field_class_name = "LargeTextField::NamedTextValue"
+      class_attribute :large_text_field_class
+      self.large_text_field_class = LargeTextField::NamedTextValue
+
+      class_attribute :large_text_field_deprecated_class_name
+      self.large_text_field_deprecated_class_name = nil
+      class_attribute :large_text_field_deprecated_class
+      self.large_text_field_deprecated_class = nil
+    end
+
+    def dup
+      result = super
+
+      result._clear_text_field_on_dup
+
+      large_text_field_options.each_key { |key| result.set_text_field(key, get_text_field(key)) }
+
+      result
+    end
+
+    def reload(options = nil)
+      super(options)
+
+      @text_field_hash = nil
+      self
+    end
+
+    def text_field_hash
+      unless @text_field_hash
+        @text_field_hash = large_text_fields.build_hash { |text_field| [text_field.field_name, text_field] }
+        if large_text_field_deprecated_class_name
+          deprecated_large_text_fields.each { |text_field| @text_field_hash[text_field.field_name] ||= text_field }
+        end
+      end
+      @text_field_hash
+    end
+
+    def text_field_hash_loaded?
+      defined?(@text_field_hash) && @text_field_hash.present?
+    end
+
+    def get_text_field(field_name)
+      text_field_hash[field_name.to_s]&.value || ''
+    end
+
+    def set_text_field(original_field_name, original_value)
+      !original_value.nil? or raise "LargeTextField value cannot be set value to nil."
+
+      field_name = original_field_name.to_s
+      value = original_value.is_a?(File) ? original_value.read : original_value.to_s
+      if (field = text_field_hash[field_name])
+        field.value = value
+      else
+        text_field_hash[field_name] = large_text_field_class.new(owner: self, field_name:, value:)
+      end
+    end
+
+    def text_field_changed(field_name)
+      text_field_hash_loaded? && @text_field_hash[field_name]&.changes&.any?
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def validate_large_text_fields
+      if text_field_hash_loaded?
+        large_text_field_options.each do |key, options|
+          value = text_field_hash[key]&.value
+          conjugation = options[:singularize_errors] ? "is" : "are"
+          maximum = options[:maximum] || MAX_LENGTH
+
+          if value.present? && value.size > maximum
+            errors.add(
+              key,
+              "#{conjugation} too long (maximum is #{self.class.formatted_integer_value(maximum)} characters)"
+            )
+          end
+        end
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    def write_large_text_field_changes
+      run_callbacks(:large_text_field_save)
+
+      @text_field_hash = text_field_hash
+                         .compact
+                         .select { |_key, value| value.value.presence }
+                         .transform_values { |value| value.is_a?(large_text_field_class) ? value : large_text_field_class.new(owner: self, field_name: value.field_name, value: value.value) }
+      self.large_text_fields = text_field_hash.values.compact
+      true
+    end
+
+    def _clear_text_field_on_dup
+      if instance_variable_defined?(:@text_field_hash)
+        remove_instance_variable(:@text_field_hash)
+      end
+    end
+
+    module ClassMethods
+      def large_text_field_class_name_override(value)
+        self.large_text_field_class_name = value
+        self.large_text_field_class = Object.const_get(value)
+      end
+
+      def large_text_field_deprecated_class_name_override(value)
+        self.large_text_field_deprecated_class_name = value
+        self.large_text_field_deprecated_class = Object.const_get(value)
+      end
+
+      def initialize_large_text_field
+        return if initialized # skip if already initialized
+
+        has_many(
+          :large_text_fields,
+          class_name: large_text_field_class_name,
+          as: :owner,
+          autosave: true,
+          dependent: :destroy,
+          inverse_of: :owner
+        )
+        if large_text_field_deprecated_class_name
+          has_many(
+            :deprecated_large_text_fields,
+            class_name: large_text_field_deprecated_class_name,
+            as: :owner,
+            autosave: true,
+            dependent: :destroy,
+            inverse_of: :owner
+          )
+        end
+        self.initialized = true
+      end
+
+      def large_text_field(field_name, maximum: nil, singularize_errors: false)
+        initialize_large_text_field # ensure the association is initialized
+
+        field_name = field_name.to_s
+
+        # validate custom maximum
+        if maximum
+          if !maximum.is_a? Integer
+            raise ArgumentError, "maximum must be a number"
+          elsif maximum > MAX_LENGTH
+            raise ArgumentError, "maximum can't be greater than #{formatted_integer_value(MAX_LENGTH)}"
+          elsif maximum.negative?
+            raise ArgumentError, "maximum can't be less than 0"
+          end
+        end
+
+        large_text_field_options[field_name] = { maximum:, singularize_errors: }
+        define_method(field_name)              {         get_text_field(field_name)        }
+        define_method("#{field_name}=")        { |value| set_text_field(field_name, value) }
+        define_method("#{field_name}_changed?") { text_field_changed(field_name) }
+      end
+
+      def formatted_integer_value(value)
+        value.to_i.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
+      end
+    end
+  end
+end

lib/large_text_field/owner.rb

@@ -1,181 +1,16 @@
 # frozen_string_literal: true
 
 require "invoca/utils"
+require_relative "base"
 
 module LargeTextField
   module Owner
     extend ActiveSupport::Concern
     include ActiveSupport::Callbacks
+    include LargeTextField::Base
 
     included do
-      validate         :validate_large_text_fields
-      before_save      :write_large_text_field_changes
-      define_callbacks :large_text_field_save
-
-      class_attribute :large_text_field_options
-      self.large_text_field_options = {}
-
-      class_attribute :initialized
-      self.initialized = false
-
-      class_attribute :large_text_field_class_name
-      self.large_text_field_class_name = "LargeTextField::NamedTextValue"
-      class_attribute :large_text_field_class
-      self.large_text_field_class = LargeTextField::NamedTextValue
-
-      class_attribute :large_text_field_deprecated_class_name
-      self.large_text_field_deprecated_class_name = nil
-      class_attribute :large_text_field_deprecated_class
-      self.large_text_field_deprecated_class = nil
-    end
-
-    def dup
-      result = super
-
-      result._clear_text_field_on_dup
-
-      large_text_field_options.each_key { |key| result.set_text_field(key, get_text_field(key)) }
-
-      result
-    end
-
-    def reload(options = nil)
-      super(options)
-
-      @text_field_hash = nil
-      self
-    end
-
-    def text_field_hash
-      unless @text_field_hash
-        @text_field_hash = large_text_fields.build_hash { |text_field| [text_field.field_name, text_field] }
-        if large_text_field_deprecated_class_name
-          deprecated_large_text_fields.each { |text_field| @text_field_hash[text_field.field_name] ||= text_field }
-        end
-      end
-      @text_field_hash
-    end
-
-    def text_field_hash_loaded?
-      defined?(@text_field_hash) && @text_field_hash.present?
-    end
-
-    def get_text_field(field_name)
-      text_field_hash[field_name.to_s]&.value || ''
-    end
-
-    def set_text_field(original_field_name, original_value)
-      !original_value.nil? or raise "LargeTextField value cannot be set value to nil."
-
-      field_name = original_field_name.to_s
-      value = original_value.is_a?(File) ? original_value.read : original_value.to_s
-      if (field = text_field_hash[field_name])
-        field.value = value
-      else
-        text_field_hash[field_name] = large_text_field_class.new(owner: self, field_name:, value:)
-      end
-    end
-
-    def text_field_changed(field_name)
-      text_field_hash_loaded? && @text_field_hash[field_name]&.changes&.any?
-    end
-
-    # rubocop:disable Metrics/CyclomaticComplexity
-    def validate_large_text_fields
-      if text_field_hash_loaded?
-        large_text_field_options.each do |key, options|
-          value = text_field_hash[key]&.value
-          conjugation = options[:singularize_errors] ? "is" : "are"
-          maximum = options[:maximum] || MAX_LENGTH
-
-          if value.present? && value.size > maximum
-            errors.add(
-              key,
-              "#{conjugation} too long (maximum is #{self.class.formatted_integer_value(maximum)} characters)"
-            )
-          end
-        end
-      end
-    end
-    # rubocop:enable Metrics/CyclomaticComplexity
-
-    def write_large_text_field_changes
-      run_callbacks(:large_text_field_save)
-
-      @text_field_hash = text_field_hash
-                         .compact
-                         .select { |_key, value| value.value.presence }
-                         .transform_values { |value| value.is_a?(large_text_field_class) ? value : large_text_field_class.new(owner: self, field_name: value.field_name, value: value.value) }
-      self.large_text_fields = text_field_hash.values.compact
-      true
-    end
-
-    def _clear_text_field_on_dup
-      if instance_variable_defined?(:@text_field_hash)
-        remove_instance_variable(:@text_field_hash)
-      end
-    end
-
-    module ClassMethods
-      def large_text_field_class_name_override(value)
-        self.large_text_field_class_name = value
-        self.large_text_field_class = Object.const_get(value)
-      end
-
-      def large_text_field_deprecated_class_name_override(value)
-        self.large_text_field_deprecated_class_name = value
-        self.large_text_field_deprecated_class = Object.const_get(value)
-      end
-
-      def initialize_large_text_field
-        return if initialized # skip if already initialized
-
-        has_many(
-          :large_text_fields,
-          class_name: large_text_field_class_name,
-          as: :owner,
-          autosave: true,
-          dependent: :destroy,
-          inverse_of: :owner
-        )
-        if large_text_field_deprecated_class_name
-          has_many(
-            :deprecated_large_text_fields,
-            class_name: large_text_field_deprecated_class_name,
-            as: :owner,
-            autosave: true,
-            dependent: :destroy,
-            inverse_of: :owner
-          )
-        end
-        self.initialized = true
-      end
-
-      def large_text_field(field_name, maximum: nil, singularize_errors: false)
-        initialize_large_text_field # ensure the association is initialized
-
-        field_name = field_name.to_s
-
-        # validate custom maximum
-        if maximum
-          if !maximum.is_a? Integer
-            raise ArgumentError, "maximum must be a number"
-          elsif maximum > MAX_LENGTH
-            raise ArgumentError, "maximum can't be greater than #{formatted_integer_value(MAX_LENGTH)}"
-          elsif maximum.negative?
-            raise ArgumentError, "maximum can't be less than 0"
-          end
-        end
-
-        large_text_field_options[field_name] = { maximum:, singularize_errors: }
-        define_method(field_name)              {         get_text_field(field_name)        }
-        define_method("#{field_name}=")        { |value| set_text_field(field_name, value) }
-        define_method("#{field_name}_changed?") { text_field_changed(field_name) }
-      end
-
-      def formatted_integer_value(value)
-        value.to_i.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
-      end
+      initialize_large_text_field
     end
   end
 end

lib/large_text_field/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LargeTextField
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end