large_text_field 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fff0ae6fef43accd89e4d85adc223752579dc4202cd79eff6ad52bd322f4d7c5
-  data.tar.gz: 5a0b69d8d87f8bb86f5ca83b1926e17298e0a7ac2cdba20e502df92c3e22fd0b
+  metadata.gz: f2e280facc3621c0a56580099e140094ddd0a02c3d8679b1fd62f7f8e85c23c5
+  data.tar.gz: 2a312b3f22593f142ddce7526b7fa388d41297ab61cf0fb59f603495300c5f94
 SHA512:
-  metadata.gz: 14f76e0df0369ef995cecda988176032d20dde40b6fba59bd3c97aa0250bd87b5ac1f40c89dcdc8064d5de4735eaa31e4a06a366a1f83173caa43820ea547457
-  data.tar.gz: 6491b14da859550bd9277f22ac4fbc9d89042e06f3798c105b5f47761ff3167b0d65b3168231d542d10b7ccd51181f4eb2b0745357f52e1f820ee2ead50b8090
+  metadata.gz: 8f748d3c267b4cd971db249bfd2b647166eda4e6b25da091caa0a71f08318b049a23acdafdde592e037a9932491ff0cf4983e9d21f61e7f73611bbe0f452b7dd
+  data.tar.gz: 118a78c39fa5d35bc49dd92a0785d0beb510e0d5479f132408e0bc3723cbcc1781321b89a7790126996c2bc8cd2cc5c28773c30d3f83eaa0cb48042f7d3490e8

data/README.md

@@ -5,6 +5,7 @@ characters. Defining new fields on models does not require database migrations.
 central table that is polymorphically associated with the model, but they act like a column on the same model.
 
 ## How do I use it?
+
 In you Gemfile add:
 
 ```
@@ -13,8 +14,8 @@ In you Gemfile add:
 
 There will be database migration you need to run to define the table, so go ahead and run that...
 
-Any class that wants to define a large text field should include **::LargeTextField::Owner**, 
-and then define text fields by calling the **large_text_field** macro.  
+Any class that wants to define a large text field should include **::LargeTextField::Owner**,
+and then define text fields by calling the **large_text_field** macro.
 
 For example the following is a `Library` class that has large text fields for `notes` and `description`.
 
@@ -27,25 +28,35 @@ class Library < ApplicationRecord
 end
 ```
 
-That's it!  You can then access `notes` and `description` as if they were columns on your class.
+That's it! You can then access `notes` and `description` as if they were columns on your class.
 
 The `large_text_field` macro takes the following options...
 
- * **maximum: number** - The maximum length of a large text field. By default this is 5,000,000 characters, 
-but it can be set to less using this option.
- * **singularize_errors: boolean** - should validation messages be singularized.
+- **maximum: number** - The maximum length of a large text field. By default this is 5,000,000 characters,
+  but it can be set to less using this option.
+- **singularize_errors: boolean** - should validation messages be singularized.
 
-Large text fields defaults to an empty string.  You cannot store `nil` in a large text field.
+Large text fields defaults to an empty string. You cannot store `nil` in a large text field.
 
-**Please note:** Large text field uses the *before_save* callback on the class that is the owner for book-keeping.   
-Callbacks are great, but if there are multiple handlers for the same callback the order in which they are called is 
-not predictable. If you want to make changes to large_text_field values in the before_save callback, use the 
-**large_text_field_save** callback instead. This will be called before the large text field book-keeping so your 
-changes will be saved. For example, this will call the `save_preprocess` method on your class before the large text 
+**Please note:** Large text field uses the _before_save_ callback on the class that is the owner for book-keeping.  
+Callbacks are great, but if there are multiple handlers for the same callback the order in which they are called is
+not predictable. If you want to make changes to large_text_field values in the before_save callback, use the
+**large_text_field_save** callback instead. This will be called before the large text field book-keeping so your
+changes will be saved. For example, this will call the `save_preprocess` method on your class before the large text
 fields are saved...
 
 ```ruby
   set_callback(:large_text_field_save, :before, :save_preprocess)
 ```
 
-This project rocks and uses MIT-LICENSE.  You should too.
+Added class methods:
+
+```ruby
+  large_text_field_deprecated_class_name_override "LargeTextField::NamedTextValue"
+  large_text_field_class_name_override "MyCustomLargeTextField"
+```
+
+You will not generally need this support; however, it can be helpful when trying to separate a model into a
+different database.
+
+This project rocks and uses MIT-LICENSE. You should too.

data/lib/large_text_field/named_text_value.rb

@@ -5,7 +5,8 @@ require_relative 'application_record'
 module LargeTextField
   class NamedTextValue < ApplicationRecord
     # Schema
-    #   field_name :string, :limit => 255
+     #   field_name :string, :limit => 255
+     #   foo :string
     #   value      :text, :null=>true, :limit => MYSQL_MEDIUM_TEXT_UTF8_LIMIT
     #
     # index [ :owner_type, :owner_id, :field_name ], :name => 'large_text_field_by_owner_field', :unique=>true

data/lib/large_text_field/owner.rb

@@ -8,20 +8,25 @@ module LargeTextField
     include ActiveSupport::Callbacks
 
     included do
-      has_many(
-        :large_text_fields,
-        class_name: "LargeTextField::NamedTextValue",
-        as: :owner,
-        autosave: true,
-        dependent: :destroy,
-        inverse_of: :owner
-      )
       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
@@ -42,7 +47,13 @@ module LargeTextField
     end
 
     def text_field_hash
-      @text_field_hash ||= large_text_fields.build_hash { |text_field| [text_field.field_name, text_field] }
+      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?
@@ -61,7 +72,7 @@ module LargeTextField
       if (field = text_field_hash[field_name])
         field.value = value
       else
-        text_field_hash[field_name] = LargeTextField::NamedTextValue.new(owner: self, field_name: field_name, value: value)
+        text_field_hash[field_name] = large_text_field_class.new(owner: self, field_name:, value:)
       end
     end
 
@@ -91,7 +102,10 @@ module LargeTextField
     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 }
+      @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
@@ -103,7 +117,43 @@ module LargeTextField
     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
@@ -117,7 +167,7 @@ module LargeTextField
           end
         end
 
-        large_text_field_options[field_name] = { maximum: maximum, singularize_errors: singularize_errors }
+        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) }

data/lib/large_text_field/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: large_text_field
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Invoca
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-11 00:00:00.000000000 Z
+date: 2025-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: invoca-utils
@@ -68,7 +67,6 @@ metadata:
   documentation_uri: https://github.com/invoca/large_text_field
   changelog_uri: https://github.com/invoca/large_text_field/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/invoca/large_text_field/issues
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Add large text fields to models without database migrations
 test_files: []