active_fields 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81a03041febfec92f7fdbbb6e9f8b9e1f40cc715744467541fbb0c08011f5a22
+  data.tar.gz: f6d64ed4e8e703c66e0dd7deff7f41c1c8da60b35ff084b1ca8c20986b8776b5
+SHA512:
+  metadata.gz: 660528c8044ef3000116b892cc236de565fe5530f9958b4a0f4ae9c511d2a3c3f4d8944fe6b2894d59f16b6bff6cd529acb6a592100c9e3cc396c0030d2069c6
+  data.tar.gz: 4843897cd9783e5d5489e0cf8c91d103d3136e23ee754ae447b77705f073e7e35750098a83e713ed77948d164d308eb8a690c206d0d52406c26eba0913817710

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,60 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-factory_bot
+
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.3
+  TargetRailsVersion: 7.1
+  NewCops: enable
+  Exclude:
+    - "active_fields.gemspec"
+
+Layout/EmptyLinesAroundAccessModifier:
+  EnforcedStyle: around
+
+Layout/IndentationConsistency:
+  EnforcedStyle: normal
+
+Style/SymbolArray:
+  EnforcedStyle: percent
+
+Style/WordArray:
+  EnforcedStyle: percent
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Rails/ApplicationRecord:
+  Enabled: false
+
+Rails/Date:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/SpecFilePathFormat:
+  Enabled: false
+

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-19
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at kirill@lassoid.ru. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 LassoID
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,5 @@
+# ActiveFields
+
+[![Gem Version](https://img.shields.io/gem/v/active_fields?color=blue&label=version)](https://rubygems.org/gems/active_fields)
+[![Gem downloads count](https://img.shields.io/gem/dt/active_fields)](https://rubygems.org/gems/active_fields)
+[![Github Actions CI](https://github.com/lassoid/active_fields/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/lassoid/active_fields/actions/workflows/main.yml)

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/lib/active_fields/casters/base_caster.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActiveFields
+  module Casters
+    # Typecasts the active_value value
+    class BaseCaster
+      # To raw DB value
+      def serialize(value)
+        raise NotImplementedError
+      end
+
+      # From raw DB value
+      def deserialize(value)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/active_fields/casters/boolean_caster.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "base_caster"
+
+module ActiveFields
+  module Casters
+    class BooleanCaster < BaseCaster
+      def serialize(value)
+        cast(value)
+      end
+
+      def deserialize(value)
+        cast(value)
+      end
+
+      private
+
+      def cast(value)
+        ActiveModel::Type::Boolean.new.cast(value)
+      end
+    end
+  end
+end

data/lib/active_fields/casters/date_array_caster.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "date_caster"
+
+module ActiveFields
+  module Casters
+    class DateArrayCaster < DateCaster
+      def serialize(value)
+        return unless value.is_a?(Array)
+
+        value.map { super(_1) }
+      end
+
+      def deserialize(value)
+        return unless value.is_a?(Array)
+
+        value.map { super(_1) }
+      end
+    end
+  end
+end

data/lib/active_fields/casters/date_caster.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "base_caster"
+
+module ActiveFields
+  module Casters
+    class DateCaster < BaseCaster
+      def serialize(value)
+        cast(value)&.iso8601
+      end
+
+      def deserialize(value)
+        cast(value)
+      end
+
+      private
+
+      def cast(value)
+        casted_value = ActiveModel::Type::Date.new.cast(value)
+
+        casted_value if casted_value.acts_like?(:date)
+      end
+    end
+  end
+end

data/lib/active_fields/casters/decimal_array_caster.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "decimal_caster"
+
+module ActiveFields
+  module Casters
+    class DecimalArrayCaster < DecimalCaster
+      def serialize(value)
+        return unless value.is_a?(Array)
+
+        value.map { super(_1) }
+      end
+
+      def deserialize(value)
+        return unless value.is_a?(Array)
+
+        value.map { super(_1) }
+      end
+    end
+  end
+end

data/lib/active_fields/casters/decimal_caster.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "base_caster"
+
+module ActiveFields
+  module Casters
+    class DecimalCaster < BaseCaster
+      def serialize(value)
+        cast(value)
+      end
+
+      def deserialize(value)
+        cast(value)
+      end
+
+      private
+
+      def cast(value)
+        BigDecimal(value, 0, exception: false)
+      end
+    end
+  end
+end

data/lib/active_fields/casters/enum_array_caster.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "text_array_caster"
+
+module ActiveFields
+  module Casters
+    class EnumArrayCaster < TextArrayCaster; end
+  end
+end

data/lib/active_fields/casters/enum_caster.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "text_caster"
+
+module ActiveFields
+  module Casters
+    class EnumCaster < TextCaster; end
+  end
+end

data/lib/active_fields/casters/integer_array_caster.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "integer_caster"
+
+module ActiveFields
+  module Casters
+    class IntegerArrayCaster < IntegerCaster
+      def serialize(value)
+        return unless value.is_a?(Array)
+
+        value.map { super(_1) }
+      end
+
+      def deserialize(value)
+        return unless value.is_a?(Array)
+
+        value.map { super(_1) }
+      end
+    end
+  end
+end

data/lib/active_fields/casters/integer_caster.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "base_caster"
+
+module ActiveFields
+  module Casters
+    class IntegerCaster < DecimalCaster
+      def serialize(value)
+        cast(value)
+      end
+
+      def deserialize(value)
+        cast(value)
+      end
+
+      private
+
+      def cast(value)
+        super(value)&.to_i
+      end
+    end
+  end
+end

data/lib/active_fields/casters/text_array_caster.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "text_caster"
+
+module ActiveFields
+  module Casters
+    class TextArrayCaster < TextCaster
+      def serialize(value)
+        return unless value.is_a?(Array)
+
+        value.map { super(_1) }
+      end
+
+      def deserialize(value)
+        return unless value.is_a?(Array)
+
+        value.map { super(_1) }
+      end
+    end
+  end
+end

data/lib/active_fields/casters/text_caster.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "base_caster"
+
+module ActiveFields
+  module Casters
+    class TextCaster < BaseCaster
+      def serialize(value)
+        cast(value)
+      end
+
+      def deserialize(value)
+        cast(value)
+      end
+
+      private
+
+      def cast(value)
+        value&.to_s
+      end
+    end
+  end
+end

data/lib/active_fields/models/concerns/concern.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Mix-in that provides ActiveRecord models with active fields functionality
+module ActiveFields
+  module Concern
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def has_active_fields(options = {})
+        include ActiveFields::Customizable
+
+        @__active_fields_options__ = options.dup
+      end
+    end
+  end
+end

data/lib/active_fields/models/concerns/customizable.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# Mix-in that adds the active fields functionality to the ActiveRecord model
+module ActiveFields
+  module Customizable
+    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`.
+      has_many :active_values,
+        class_name: "ActiveFields::Value",
+        as: :customizable,
+        inverse_of: :customizable,
+        autosave: false,
+        dependent: :destroy
+
+      # Firstly, we build active_values that hasn't been already created.
+      # Than, we set values for active_values whose values should be changed
+      # according to `active_values_attributes`.
+      before_validation :initialize_active_values
+
+      # Save all changed active_values on the owner record save.
+      after_save :save_changed_active_values
+
+      # We always validate active_values on the owner record change,
+      # as if they are just an ordinary record columns.
+      validates_associated :active_values
+
+      # This virtual attribute is used for setting active_values values.
+      # Keys are active_fields names,
+      # values are values for corresponding active_values of the record.
+      attr_reader :active_values_attributes
+    end
+
+    def active_fields
+      ActiveFields::Field.for(model_name.name)
+    end
+
+    # Convert hash keys to strings for easier access by fields names.
+    def active_values_attributes=(value)
+      @active_values_attributes =
+        if value.respond_to?(:to_h)
+          value.to_h.transform_keys(&:to_s)
+        else
+          value
+        end
+    end
+
+    private
+
+    def initialize_active_values
+      active_fields.each do |active_field|
+        active_value =
+          find_active_value_by_field(active_field) ||
+          active_values.new(active_field: active_field, value: active_field.default_value)
+
+        next unless active_values_attributes.is_a?(Hash)
+        next unless active_values_attributes.key?(active_field.name)
+
+        active_value.value = active_values_attributes[active_field.name]
+      end
+    end
+
+    def save_changed_active_values
+      active_values.each do |active_value|
+        next unless active_value.new_record? || active_value.changed?
+
+        # For new records association id isn't set right, so we force reassignment of the customizable
+        active_value.customizable = self
+
+        # Do not validate active values twice,
+        # because they have already been validated by `validates_associated`.
+        active_value.save!(validate: false)
+      end
+    end
+
+    def find_active_value_by_field(active_field)
+      active_values.find { |active_value| active_value.active_field_id == active_field.id }
+    end
+  end
+end

data/lib/active_fields/models/concerns/field_concern.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Mix-in with a base logic for the active fields model
+module ActiveFields
+  module FieldConcern
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :active_values,
+        class_name: "ActiveFields::Value",
+        foreign_key: :active_field_id,
+        inverse_of: :active_field,
+        dependent: :destroy
+
+      scope :for, ->(customizable_type) { where(customizable_type: customizable_type) }
+
+      validates :type, presence: true
+      validates :name, presence: true, uniqueness: { scope: :customizable_type }
+      validates :name, format: { with: /\A[a-z0-9_]+\z/ }, allow_blank: true
+      validate :validate_default_value
+
+      after_create :add_field_to_records
+      after_initialize :set_defaults
+    end
+
+    def value_validator_class
+      @value_validator_class ||= "ActiveFields::Validators::#{model_name.name.demodulize}Validator".constantize
+    end
+
+    def value_validator
+      value_validator_class.new(self)
+    end
+
+    def value_caster_class
+      @value_caster_class ||= "ActiveFields::Casters::#{model_name.name.demodulize}Caster".constantize
+    end
+
+    def value_caster
+      value_caster_class.new
+    end
+
+    def customizable_model
+      customizable_type.constantize
+    end
+
+    def default_value=(v)
+      super(value_caster.serialize(v))
+    end
+
+    def default_value
+      value_caster.deserialize(super)
+    end
+
+    private
+
+    def validate_default_value
+      validator = value_validator
+      return if validator.validate(default_value)
+
+      validator.errors.each do |error|
+        if error.is_a?(Array) && error.size == 2 && error.first.is_a?(Symbol) && error.last.is_a?(Hash)
+          errors.add(:default_value, error.first, **error.last)
+        elsif error.is_a?(Symbol)
+          errors.add(:default_value, *error)
+        else
+          raise ArgumentError
+        end
+      end
+    end
+
+    def add_field_to_records
+      customizable_model.find_each do |record|
+        ActiveFields::Value.create!(active_field: self, customizable: record, value: default_value)
+      end
+    end
+
+    def set_defaults; end
+  end
+end

data/lib/active_fields/models/concerns/value_concern.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Mix-in with a base logic for the active fields value model
+module ActiveFields
+  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
+
+      validates :active_field_id, uniqueness: { scope: %i[customizable_id customizable_type] }
+      validate :validate_value
+      validate :validate_customizable_allowed
+    end
+
+    def value=(v)
+      super(active_field&.value_caster&.serialize(v))
+    end
+
+    def value
+      active_field&.value_caster&.deserialize(super)
+    end
+
+    private
+
+    def validate_value
+      return if (validator = active_field&.value_validator).nil?
+      return if validator.validate(value)
+
+      validator.errors.each do |error|
+        if error.is_a?(Array) && error.size == 2 && error.first.is_a?(Symbol) && error.last.is_a?(Hash)
+          errors.add(:value, error.first, **error.last)
+        elsif error.is_a?(Symbol)
+          errors.add(:value, *error)
+        else
+          raise ArgumentError
+        end
+      end
+    end
+
+    def validate_customizable_allowed
+      return true if active_field.nil?
+      return true if customizable_type == active_field.customizable_type
+
+      errors.add(:customizable, :invalid)
+      false
+    end
+  end
+end