active_fields 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81a03041febfec92f7fdbbb6e9f8b9e1f40cc715744467541fbb0c08011f5a22
-  data.tar.gz: f6d64ed4e8e703c66e0dd7deff7f41c1c8da60b35ff084b1ca8c20986b8776b5
+  metadata.gz: aee118ed966e5912d28dcf8cb2d1db0cdd68d85f7d4fc3bcdf267cc5629c7ff3
+  data.tar.gz: 99009dea7a5f940034263a85f5f20f76b84911772677dfc69fe97380bd308563
 SHA512:
-  metadata.gz: 660528c8044ef3000116b892cc236de565fe5530f9958b4a0f4ae9c511d2a3c3f4d8944fe6b2894d59f16b6bff6cd529acb6a592100c9e3cc396c0030d2069c6
-  data.tar.gz: 4843897cd9783e5d5489e0cf8c91d103d3136e23ee754ae447b77705f073e7e35750098a83e713ed77948d164d308eb8a690c206d0d52406c26eba0913817710
+  metadata.gz: ca324370030b6028c6a579e4782f37d010e6e01dff7d75054220302e6a36e9aaf35acb30488513f723eadef183ba8fda590890db7bd5f654517ceb03ddfd2a82
+  data.tar.gz: df6501f049664003e9d02571c6f6652b8eaacf92718038e98eea1daae7ee08ddba92a028f737fac5d08042a410f06445ef996bcf418844099d4003d568a53ed5

data/.rspec

@@ -1,2 +1 @@
---color
 --require spec_helper

data/.rubocop.yml

@@ -1,9 +1,10 @@
 require:
+#  - rubocop-factory_bot
   - rubocop-performance
   - rubocop-rails
   - rubocop-rake
   - rubocop-rspec
-  - rubocop-factory_bot
+#  - rubocop-rspec_rails
 
 inherit_gem:
   rubocop-shopify: rubocop.yml
@@ -13,7 +14,7 @@ AllCops:
   TargetRailsVersion: 7.1
   NewCops: enable
   Exclude:
-    - "active_fields.gemspec"
+    - "spec/dummy/db/schema.rb"
 
 Layout/EmptyLinesAroundAccessModifier:
   EnforcedStyle: around
@@ -45,16 +46,3 @@ RSpec/ContextWording:
 
 RSpec/MultipleExpectations:
   Enabled: false
-
-Rails/ApplicationRecord:
-  Enabled: false
-
-Rails/Date:
-  Enabled: false
-
-RSpec/FilePath:
-  Enabled: false
-
-RSpec/SpecFilePathFormat:
-  Enabled: false
-

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-06-13
+
+- Rewrited as a Rails plugin!
+- Custom field types support
+- Global configuration options for changing field and value classes
+- Per-model configuration option for enabling specific field types only
+
 ## [0.1.0] - 2024-05-19
 
 - Initial release

data/Rakefile

@@ -1,3 +1,10 @@
 # frozen_string_literal: true
 
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
 require "bundler/gem_tasks"

data/app/models/active_fields/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveFields
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/active_fields/field/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveFields
+  module Field
+    # If the field base class has been changed, we should prevent this model from being loaded.
+    # Since we cannot remove it entirely, we will not add any functionality to it.
+    if ActiveFields.config.field_base_class_changed?
+      class Base; end
+    else
+      class Base < ApplicationRecord
+        self.table_name = "active_fields"
+
+        include FieldConcern
+      end
+    end
+  end
+end

data/{lib/active_fields/models → app/models/active_fields}/field/boolean.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "../field"
-
 module ActiveFields
-  class Field
-    class Boolean < ActiveFields::Field
+  module Field
+    class Boolean < ActiveFields.config.field_base_class
       store_accessor :options, :required, :nullable
 
       # attribute :required, :boolean, default: false
@@ -15,7 +13,7 @@ module ActiveFields
 
       %i[required nullable].each do |column|
         define_method(column) do
-          ActiveFields::Casters::BooleanCaster.new.deserialize(super())
+          Casters::BooleanCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}?") do
@@ -23,7 +21,7 @@ module ActiveFields
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::BooleanCaster.new.serialize(other))
+          super(Casters::BooleanCaster.new.serialize(other))
         end
       end
 

data/{lib/active_fields/models → app/models/active_fields}/field/date.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "../field"
-
 module ActiveFields
-  class Field
-    class Date < ActiveFields::Field
+  module Field
+    class Date < ActiveFields.config.field_base_class
       store_accessor :options, :required, :min, :max
 
       # attribute :required, :boolean, default: false
@@ -16,7 +14,7 @@ module ActiveFields
 
       %i[required].each do |column|
         define_method(column) do
-          ActiveFields::Casters::BooleanCaster.new.deserialize(super())
+          Casters::BooleanCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}?") do
@@ -24,17 +22,17 @@ module ActiveFields
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::BooleanCaster.new.serialize(other))
+          super(Casters::BooleanCaster.new.serialize(other))
         end
       end
 
       %i[min max].each do |column|
         define_method(column) do
-          ActiveFields::Casters::DateCaster.new.deserialize(super())
+          Casters::DateCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::DateCaster.new.serialize(other))
+          super(Casters::DateCaster.new.serialize(other))
         end
       end
 

data/{lib/active_fields/models → app/models/active_fields}/field/date_array.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "../field"
-
 module ActiveFields
-  class Field
-    class DateArray < ActiveFields::Field
+  module Field
+    class DateArray < ActiveFields.config.field_base_class
       store_accessor :options, :min_size, :max_size, :min, :max
 
       # attribute :min_size, :integer
@@ -18,21 +16,21 @@ module ActiveFields
 
       %i[min_size max_size].each do |column|
         define_method(column) do
-          ActiveFields::Casters::IntegerCaster.new.deserialize(super())
+          Casters::IntegerCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::IntegerCaster.new.serialize(other))
+          super(Casters::IntegerCaster.new.serialize(other))
         end
       end
 
       %i[min max].each do |column|
         define_method(column) do
-          ActiveFields::Casters::DateCaster.new.deserialize(super())
+          Casters::DateCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::DateCaster.new.serialize(other))
+          super(Casters::DateCaster.new.serialize(other))
         end
       end
 

data/{lib/active_fields/models → app/models/active_fields}/field/decimal.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "../field"
-
 module ActiveFields
-  class Field
-    class Decimal < ActiveFields::Field
+  module Field
+    class Decimal < ActiveFields.config.field_base_class
       store_accessor :options, :required, :min, :max
 
       # attribute :required, :boolean, default: false
@@ -16,7 +14,7 @@ module ActiveFields
 
       %i[required].each do |column|
         define_method(column) do
-          ActiveFields::Casters::BooleanCaster.new.deserialize(super())
+          Casters::BooleanCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}?") do
@@ -24,17 +22,17 @@ module ActiveFields
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::BooleanCaster.new.serialize(other))
+          super(Casters::BooleanCaster.new.serialize(other))
         end
       end
 
       %i[min max].each do |column|
         define_method(column) do
-          ActiveFields::Casters::DecimalCaster.new.deserialize(super())
+          Casters::DecimalCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::DecimalCaster.new.serialize(other))
+          super(Casters::DecimalCaster.new.serialize(other))
         end
       end
 

data/{lib/active_fields/models → app/models/active_fields}/field/decimal_array.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "../field"
-
 module ActiveFields
-  class Field
-    class DecimalArray < ActiveFields::Field
+  module Field
+    class DecimalArray < ActiveFields.config.field_base_class
       store_accessor :options, :min_size, :max_size, :min, :max
 
       # attribute :min_size, :integer
@@ -18,21 +16,21 @@ module ActiveFields
 
       %i[min_size max_size].each do |column|
         define_method(column) do
-          ActiveFields::Casters::IntegerCaster.new.deserialize(super())
+          Casters::IntegerCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::IntegerCaster.new.serialize(other))
+          super(Casters::IntegerCaster.new.serialize(other))
         end
       end
 
       %i[min max].each do |column|
         define_method(column) do
-          ActiveFields::Casters::DecimalCaster.new.deserialize(super())
+          Casters::DecimalCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::DecimalCaster.new.serialize(other))
+          super(Casters::DecimalCaster.new.serialize(other))
         end
       end
 

data/{lib/active_fields/models → app/models/active_fields}/field/enum.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "../field"
-
 module ActiveFields
-  class Field
-    class Enum < ActiveFields::Field
+  module Field
+    class Enum < ActiveFields.config.field_base_class
       store_accessor :options, :required, :allowed_values
 
       # attribute :required, :boolean, default: false
@@ -15,7 +13,7 @@ module ActiveFields
 
       %i[required].each do |column|
         define_method(column) do
-          ActiveFields::Casters::BooleanCaster.new.deserialize(super())
+          Casters::BooleanCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}?") do
@@ -23,17 +21,17 @@ module ActiveFields
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::BooleanCaster.new.serialize(other))
+          super(Casters::BooleanCaster.new.serialize(other))
         end
       end
 
       %i[allowed_values].each do |column|
         define_method(column) do
-          ActiveFields::Casters::TextArrayCaster.new.deserialize(super())
+          Casters::TextArrayCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::TextArrayCaster.new.serialize(other))
+          super(Casters::TextArrayCaster.new.serialize(other))
         end
       end
 

data/{lib/active_fields/models → app/models/active_fields}/field/enum_array.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "../field"
-
 module ActiveFields
-  class Field
-    class EnumArray < ActiveFields::Field
+  module Field
+    class EnumArray < ActiveFields.config.field_base_class
       store_accessor :options, :min_size, :max_size, :allowed_values
 
       # attribute :min_size, :integer
@@ -17,21 +15,21 @@ module ActiveFields
 
       %i[min_size max_size].each do |column|
         define_method(column) do
-          ActiveFields::Casters::IntegerCaster.new.deserialize(super())
+          Casters::IntegerCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::IntegerCaster.new.serialize(other))
+          super(Casters::IntegerCaster.new.serialize(other))
         end
       end
 
       %i[allowed_values].each do |column|
         define_method(column) do
-          ActiveFields::Casters::TextArrayCaster.new.deserialize(super())
+          Casters::TextArrayCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::TextArrayCaster.new.serialize(other))
+          super(Casters::TextArrayCaster.new.serialize(other))
         end
       end
 

data/{lib/active_fields/models → app/models/active_fields}/field/integer.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "../field"
-
 module ActiveFields
-  class Field
-    class Integer < ActiveFields::Field
+  module Field
+    class Integer < ActiveFields.config.field_base_class
       store_accessor :options, :required, :min, :max
 
       # attribute :required, :boolean, default: false
@@ -16,7 +14,7 @@ module ActiveFields
 
       %i[required].each do |column|
         define_method(column) do
-          ActiveFields::Casters::BooleanCaster.new.deserialize(super())
+          Casters::BooleanCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}?") do
@@ -24,17 +22,17 @@ module ActiveFields
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::BooleanCaster.new.serialize(other))
+          super(Casters::BooleanCaster.new.serialize(other))
         end
       end
 
       %i[min max].each do |column|
         define_method(column) do
-          ActiveFields::Casters::IntegerCaster.new.deserialize(super())
+          Casters::IntegerCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::IntegerCaster.new.serialize(other))
+          super(Casters::IntegerCaster.new.serialize(other))
         end
       end
 

data/{lib/active_fields/models → app/models/active_fields}/field/integer_array.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "../field"
-
 module ActiveFields
-  class Field
-    class IntegerArray < ActiveFields::Field
+  module Field
+    class IntegerArray < ActiveFields.config.field_base_class
       store_accessor :options, :min_size, :max_size, :min, :max
 
       # attribute :min_size, :integer
@@ -18,11 +16,11 @@ module ActiveFields
 
       %i[min_size max_size min max].each do |column|
         define_method(column) do
-          ActiveFields::Casters::IntegerCaster.new.deserialize(super())
+          Casters::IntegerCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::IntegerCaster.new.serialize(other))
+          super(Casters::IntegerCaster.new.serialize(other))
         end
       end
 

data/{lib/active_fields/models → app/models/active_fields}/field/text.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "../field"
-
 module ActiveFields
-  class Field
-    class Text < ActiveFields::Field
+  module Field
+    class Text < ActiveFields.config.field_base_class
       store_accessor :options, :required, :min_length, :max_length
 
       # attribute :required, :boolean, default: false
@@ -17,7 +15,7 @@ module ActiveFields
 
       %i[required].each do |column|
         define_method(column) do
-          ActiveFields::Casters::BooleanCaster.new.deserialize(super())
+          Casters::BooleanCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}?") do
@@ -25,17 +23,17 @@ module ActiveFields
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::BooleanCaster.new.serialize(other))
+          super(Casters::BooleanCaster.new.serialize(other))
         end
       end
 
       %i[min_length max_length].each do |column|
         define_method(column) do
-          ActiveFields::Casters::IntegerCaster.new.deserialize(super())
+          Casters::IntegerCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::IntegerCaster.new.serialize(other))
+          super(Casters::IntegerCaster.new.serialize(other))
         end
       end
 

data/{lib/active_fields/models → app/models/active_fields}/field/text_array.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "../field"
-
 module ActiveFields
-  class Field
-    class TextArray < ActiveFields::Field
+  module Field
+    class TextArray < ActiveFields.config.field_base_class
       store_accessor :options, :min_size, :max_size, :min_length, :max_length
 
       # attribute :min_size, :integer
@@ -19,11 +17,11 @@ module ActiveFields
 
       %i[min_size max_size min_length max_length].each do |column|
         define_method(column) do
-          ActiveFields::Casters::IntegerCaster.new.deserialize(super())
+          Casters::IntegerCaster.new.deserialize(super())
         end
 
         define_method(:"#{column}=") do |other|
-          super(ActiveFields::Casters::IntegerCaster.new.serialize(other))
+          super(Casters::IntegerCaster.new.serialize(other))
         end
       end
 

data/app/models/active_fields/value.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActiveFields
+  # If value base class has been changed, we should prevent this model from being loaded.
+  # Since we cannot remove it entirely, we will not add any functionality to it.
+  if ActiveFields.config.value_class_changed?
+    class Value; end
+  else
+    class Value < ApplicationRecord
+      self.table_name = "active_fields_values"
+
+      include ValueConcern
+    end
+  end
+end

data/{lib/active_fields/models/concerns/customizable.rb → app/models/concerns/active_fields/customizable_concern.rb}

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
-# Mix-in that adds the active fields functionality to the ActiveRecord model
 module ActiveFields
-  module Customizable
+  # Mix-in that adds the active fields functionality to the ActiveRecord model
+  module CustomizableConcern
     extend ActiveSupport::Concern
 
     included do
       # active_values association for the owner record.
       # We skip built-in autosave because it doesn't work if the owner record isn't changed.
       # Instead, we implement our own autosave callback: `save_changed_active_values`.
+      # rubocop:disable Rails/ReflectionClassName
       has_many :active_values,
-        class_name: "ActiveFields::Value",
+        class_name: ActiveFields.config.value_class_name,
         as: :customizable,
         inverse_of: :customizable,
         autosave: false,
         dependent: :destroy
+      # rubocop:enable Rails/ReflectionClassName
 
       # Firstly, we build active_values that hasn't been already created.
       # Than, we set values for active_values whose values should be changed
@@ -35,7 +37,7 @@ module ActiveFields
     end
 
     def active_fields
-      ActiveFields::Field.for(model_name.name)
+      ActiveFields.config.field_base_class.for(model_name.name)
     end
 
     # Convert hash keys to strings for easier access by fields names.

data/{lib/active_fields/models/concerns → app/models/concerns/active_fields}/field_concern.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
-# Mix-in with a base logic for the active fields model
 module ActiveFields
+  # Mix-in with a base logic for the active fields model
   module FieldConcern
     extend ActiveSupport::Concern
 
     included do
+      # rubocop:disable Rails/ReflectionClassName
       has_many :active_values,
-        class_name: "ActiveFields::Value",
+        class_name: ActiveFields.config.value_class_name,
         foreign_key: :active_field_id,
         inverse_of: :active_field,
         dependent: :destroy
+      # rubocop:enable Rails/ReflectionClassName
 
       scope :for, ->(customizable_type) { where(customizable_type: customizable_type) }
 
@@ -18,6 +20,7 @@ module ActiveFields
       validates :name, presence: true, uniqueness: { scope: :customizable_type }
       validates :name, format: { with: /\A[a-z0-9_]+\z/ }, allow_blank: true
       validate :validate_default_value
+      validate :validate_customizable_model_allows_type
 
       after_create :add_field_to_records
       after_initialize :set_defaults
@@ -68,9 +71,17 @@ module ActiveFields
       end
     end
 
+    def validate_customizable_model_allows_type
+      allowed_types = customizable_model.active_fields_config&.types || []
+      return true if ActiveFields.config.fields.values_at(*allowed_types).include?(type)
+
+      errors.add(:customizable_type, :inclusion)
+      false
+    end
+
     def add_field_to_records
       customizable_model.find_each do |record|
-        ActiveFields::Value.create!(active_field: self, customizable: record, value: default_value)
+        ActiveFields.config.value_class.create!(active_field: self, customizable: record, value: default_value)
       end
     end
 

data/{lib/active_fields/models/concerns → app/models/concerns/active_fields}/value_concern.rb

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
 
-# Mix-in with a base logic for the active fields value model
 module ActiveFields
+  # Mix-in with a base logic for the active fields value model
   module ValueConcern
     extend ActiveSupport::Concern
 
     included do
       belongs_to :customizable, polymorphic: true, optional: false, inverse_of: :active_values
-      belongs_to :active_field, class_name: "ActiveFields::Field", optional: false, inverse_of: :active_values
+      # rubocop:disable Rails/ReflectionClassName
+      belongs_to :active_field,
+        class_name: ActiveFields.config.field_base_class_name,
+        optional: false,
+        inverse_of: :active_values
+      # rubocop:enable Rails/ReflectionClassName
 
       validates :active_field_id, uniqueness: { scope: %i[customizable_id customizable_type] }
       validate :validate_value

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+ActiveFields::Engine.routes.draw do
+end