active_fields 2.0.1 → 3.0.1

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

@@ -12,15 +12,22 @@ module ActiveFields
         inverse_of: :active_field,
         dependent: :destroy
 
-      scope :for, ->(customizable_type) { where(customizable_type: customizable_type) }
+      # Returns active fields for the given customizable type, including both
+      # scoped fields (when scope parameter is provided) and global fields (where scope is nil).
+      scope :for, ->(customizable_type, scope: nil) do
+        # Global fields are available to all records of the given customizable type.
+        scopes = [scope, nil].uniq
+        where(customizable_type: customizable_type, scope: scopes)
+      end
 
       validates :type, presence: true
-      validates :name, presence: true, uniqueness: { scope: :customizable_type }
-      validates :name, format: { with: /\A[a-z0-9_]+\z/ }, allow_blank: true
+      validates :name, presence: true
+      validate :validate_name_uniqueness
       validate :validate_default_value
       validate :validate_customizable_model_allows_type
 
       after_initialize :set_defaults
+      before_validation :set_scope
     end
 
     class_methods do
@@ -89,7 +96,7 @@ module ActiveFields
 
     # Returns customizable types that allow this field type.
     #
-    # Notes:
+    # NOTE:
     # - The customizable model must be loaded to appear in this list.
     #   Relationships between customizable models and field types are established in the `has_active_fields` method,
     #   which is typically called within the customizable model.
@@ -104,6 +111,26 @@ module ActiveFields
 
     private
 
+    # NOTE: The uniqueness constraint in the DB does not fully enforce this validation:
+    # Records where scope is NULL do not prevent the existence of records with the same
+    # [name, customizable_type] but with a non-NULL scope, and vice versa.
+    def validate_name_uniqueness
+      base_scope =
+        ActiveFields.config.field_base_class.excluding(self).where(customizable_type: customizable_type, name: name)
+
+      if scope.nil?
+        if base_scope.exists?
+          errors.add(:name, :taken)
+          return false
+        end
+      elsif base_scope.exists?(scope: [scope, nil])
+        errors.add(:name, :taken)
+        return false
+      end
+
+      true
+    end
+
     def validate_default_value
       validator = value_validator
       return if validator.validate(default_value)
@@ -128,5 +155,12 @@ module ActiveFields
     end
 
     def set_defaults; end
+
+    # Forces scope to nil if the customizable model does not have a scope method.
+    def set_scope
+      return if customizable_model.nil?
+
+      self.scope = nil if customizable_model.active_fields_scope_method.nil?
+    end
   end
 end

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

@@ -59,7 +59,14 @@ module ActiveFields
 
     def validate_customizable_allowed
       return true if active_field.nil?
-      return true if customizable_type == active_field.customizable_type
+
+      if customizable_type != active_field.customizable_type
+        errors.add(:customizable, :invalid)
+        return false
+      end
+
+      return true if active_field.scope.nil?
+      return true if customizable&.active_fields_scope == active_field.scope
 
       errors.add(:customizable, :invalid)
       false

data/db/migrate/20250229230000_add_scope_to_active_fields.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class AddScopeToActiveFields < ActiveRecord::Migration[7.1]
+  def change
+    change_table :active_fields do |t|
+      t.string :scope
+
+      t.remove_index %i[name customizable_type], unique: true
+      t.remove_index :customizable_type
+
+      t.index %i[customizable_type scope name], unique: true, nulls_not_distinct: true
+    end
+  end
+end

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "puma"
+gem "propshaft"
+gem "importmap-rails"
+gem "stimulus-rails"
+gem "rails", "~> 7.1.0"
+
+group :development do
+  gem "web-console"
+end
+
+gemspec path: "../"

data/gemfiles/rails_7.2.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "puma"
+gem "propshaft"
+gem "importmap-rails"
+gem "stimulus-rails"
+gem "rails", "~> 7.2.0"
+
+group :development do
+  gem "web-console"
+end
+
+gemspec path: "../"

data/gemfiles/rails_8.0.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "puma"
+gem "propshaft"
+gem "importmap-rails"
+gem "stimulus-rails"
+gem "rails", "~> 8.0.0"
+
+group :development do
+  gem "web-console"
+end
+
+gemspec path: "../"

data/gemfiles/rails_8.1.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "puma"
+gem "propshaft"
+gem "importmap-rails"
+gem "stimulus-rails"
+gem "rails", "~> 8.1.0"
+
+group :development do
+  gem "web-console"
+end
+
+gemspec path: "../"

data/lib/active_fields/casters/date_array_caster.rb

@@ -6,13 +6,13 @@ module ActiveFields
       def serialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
 
       def deserialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
     end
   end

data/lib/active_fields/casters/date_time_array_caster.rb

@@ -6,13 +6,13 @@ module ActiveFields
       def serialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
 
       def deserialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
     end
   end

data/lib/active_fields/casters/decimal_array_caster.rb

@@ -6,13 +6,13 @@ module ActiveFields
       def serialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
 
       def deserialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
     end
   end

data/lib/active_fields/casters/enum_array_caster.rb

@@ -6,13 +6,13 @@ module ActiveFields
       def serialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
 
       def deserialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
     end
   end

data/lib/active_fields/casters/integer_array_caster.rb

@@ -6,13 +6,13 @@ module ActiveFields
       def serialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
 
       def deserialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
     end
   end

data/lib/active_fields/casters/text_array_caster.rb

@@ -6,13 +6,13 @@ module ActiveFields
       def serialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
 
       def deserialize(value)
         return unless value.is_a?(Array)
 
-        value.map { super(_1) }
+        value.map { |element| super(element) }
       end
     end
   end

data/lib/active_fields/config.rb

@@ -11,8 +11,6 @@ module ActiveFields
     attr_reader :fields
 
     def initialize
-      @field_base_class_name = DEFAULT_FIELD_BASE_CLASS_NAME
-      @value_class_name = DEFAULT_VALUE_CLASS_NAME
       @fields = {
         boolean: "ActiveFields::Field::Boolean",
         date: "ActiveFields::Field::Date",
@@ -28,6 +26,8 @@ module ActiveFields
         text: "ActiveFields::Field::Text",
         text_array: "ActiveFields::Field::TextArray",
       }
+      @field_base_class_name = DEFAULT_FIELD_BASE_CLASS_NAME
+      @value_class_name = DEFAULT_VALUE_CLASS_NAME
     end
 
     def field_base_class

data/lib/active_fields/finders/array_finder.rb

@@ -91,7 +91,10 @@ module ActiveFields
       def jsonb_path_exists(target, jsonpath, vars = nil)
         Arel::Nodes::NamedFunction.new(
           "jsonb_path_exists",
-          [target, *[jsonpath, vars&.to_json].compact.map { Arel::Nodes.build_quoted(_1) }],
+          [
+            target,
+            *[jsonpath, vars&.to_json].compact.map { |element| Arel::Nodes.build_quoted(element) },
+          ],
         )
       end
 
@@ -99,7 +102,10 @@ module ActiveFields
       def jsonb_path_query_array(target, jsonpath, vars = nil)
         Arel::Nodes::NamedFunction.new(
           "jsonb_path_query_array",
-          [target, *[jsonpath, vars&.to_json].compact.map { Arel::Nodes.build_quoted(_1) }],
+          [
+            target,
+            *[jsonpath, vars&.to_json].compact.map { |element| Arel::Nodes.build_quoted(element) },
+          ],
         )
       end
 

data/lib/active_fields/has_active_fields.rb

@@ -6,12 +6,14 @@ module ActiveFields
     extend ActiveSupport::Concern
 
     class_methods do
-      def has_active_fields(types: ActiveFields.config.type_names)
+      def has_active_fields(types: ActiveFields.config.type_names, scope_method: nil)
         include CustomizableConcern
 
         types.each do |field_type|
           ActiveFields.registry.add(field_type, name)
         end
+
+        define_singleton_method(:active_fields_scope_method) { scope_method }
       end
     end
   end

data/lib/active_fields/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveFields
-  VERSION = "2.0.1"
+  VERSION = "3.0.1"
 end

data/lib/generators/active_fields/scaffold/templates/controllers/active_fields_controller.rb

@@ -4,7 +4,7 @@ class ActiveFieldsController < ApplicationController
   before_action :set_active_field, only: %i[show edit update destroy]
 
   def index
-    @active_fields = ActiveFields.config.field_base_class.order(:customizable_type, :id)
+    @active_fields = ActiveFields.config.field_base_class.order(:customizable_type, :scope, :id)
   end
 
   def show; end
@@ -13,23 +13,23 @@ class ActiveFieldsController < ApplicationController
     @active_field = model_class.new
   end
 
+  def edit; end
+
   def create
     @active_field = model_class.new(active_field_create_params(model_class))
 
     if @active_field.save
       redirect_to edit_active_field_path(@active_field), status: :see_other
     else
-      render :new, status: :unprocessable_entity
+      render :new, status: :unprocessable_content
     end
   end
 
-  def edit; end
-
   def update
     if @active_field.update(active_field_update_params(@active_field.class))
       redirect_to edit_active_field_path(@active_field), status: :see_other
     else
-      render :edit, status: :unprocessable_entity
+      render :edit, status: :unprocessable_content
     end
   end
 
@@ -60,31 +60,31 @@ class ActiveFieldsController < ApplicationController
   # It is strongly recommended to move it to, for example, policies.
   def permitted_attributes_for_create(model_class)
     if model_class == ActiveFields::Field::Boolean
-      %i[customizable_type name required nullable default_value]
+      %i[customizable_type name scope required nullable default_value]
     elsif model_class == ActiveFields::Field::Date
-      %i[customizable_type name required min max default_value]
+      %i[customizable_type name scope required min max default_value]
     elsif model_class == ActiveFields::Field::DateArray
-      [:customizable_type, :name, :min_size, :max_size, :min, :max, default_value: []]
+      [:customizable_type, :name, :scope, :min_size, :max_size, :min, :max, default_value: []]
     elsif model_class == ActiveFields::Field::DateTime
-      %i[customizable_type name required min max precision default_value]
+      %i[customizable_type name scope required min max precision default_value]
     elsif model_class == ActiveFields::Field::DateTimeArray
-      [:customizable_type, :name, :min_size, :max_size, :min, :max, :precision, default_value: []]
+      [:customizable_type, :name, :scope, :min_size, :max_size, :min, :max, :precision, default_value: []]
     elsif model_class == ActiveFields::Field::Decimal
-      %i[customizable_type name required min max precision default_value]
+      %i[customizable_type name scope required min max precision default_value]
     elsif model_class == ActiveFields::Field::DecimalArray
-      [:customizable_type, :name, :min_size, :max_size, :min, :max, :precision, default_value: []]
+      [:customizable_type, :name, :scope, :min_size, :max_size, :min, :max, :precision, default_value: []]
     elsif model_class == ActiveFields::Field::Enum
-      [:customizable_type, :name, :required, :default_value, allowed_values: []]
+      [:customizable_type, :name, :scope, :required, :default_value, allowed_values: []]
     elsif model_class == ActiveFields::Field::EnumArray
-      [:customizable_type, :name, :min_size, :max_size, allowed_values: [], default_value: []]
+      [:customizable_type, :name, :scope, :min_size, :max_size, allowed_values: [], default_value: []]
     elsif model_class == ActiveFields::Field::Integer
-      %i[customizable_type name required min max default_value]
+      %i[customizable_type name scope required min max default_value]
     elsif model_class == ActiveFields::Field::IntegerArray
-      [:customizable_type, :name, :min_size, :max_size, :min, :max, default_value: []]
+      [:customizable_type, :name, :scope, :min_size, :max_size, :min, :max, default_value: []]
     elsif model_class == ActiveFields::Field::Text
-      %i[customizable_type name min_length max_length default_value]
+      %i[customizable_type name scope min_length max_length default_value]
     elsif model_class == ActiveFields::Field::TextArray
-      [:customizable_type, :name, :min_size, :max_size, :min_length, :max_length, default_value: []]
+      [:customizable_type, :name, :scope, :min_size, :max_size, :min_length, :max_length, default_value: []]
     else
       raise ArgumentError, "undefined model_class `#{model_class.inspect}`"
     end

data/lib/generators/active_fields/scaffold/templates/javascript/controllers/active_field_form_controller.js

@@ -0,0 +1,19 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = [
+    "scopeInput",
+    "disableScopeInput",
+  ]
+
+  toggleScopeInput(e) {
+    e.preventDefault()
+
+    if (this.disableScopeInputTarget.checked) { 
+      this.scopeInputTarget.disabled = true
+      this.scopeInputTarget.value = ""
+    } else {
+      this.scopeInputTarget.disabled = false
+    }
+  }
+}

data/lib/generators/active_fields/scaffold/templates/views/active_fields/forms/_boolean.html.erb

@@ -1,4 +1,9 @@
-<%= form_with(model: active_field, scope: :active_field, url: active_field.persisted? ? active_field_path(active_field) : active_fields_path) do |f| %>
+<%= form_with(
+      model: active_field,
+      scope: :active_field,
+      url: active_field.persisted? ? active_field_path(active_field) : active_fields_path,
+      data: { controller: "active-field-form" }
+    ) do |f| %>
   <% if active_field.errors.any? %>
     <div style="color: red">
       <h2><%= pluralize(active_field.errors.count, "error") %> prohibited this record from being saved:</h2>
@@ -32,6 +37,22 @@
     <%= f.text_field :name %>
   </div>
 
+  <% if active_field.persisted? %>
+    <% if active_field.scope %>
+      <div>
+        <%= f.label :scope %>
+        <%= f.text_field :scope, disabled: true %>
+      </div>
+    <% end %>
+  <% else %>
+    <div>
+      <%= f.label :scope %>
+      <%= f.text_field :scope, data: { "active-field-form-target": "scopeInput" } %>
+      <%= f.label :disable_scope %>
+      <%= f.check_box :disable_scope, data: { "active-field-form-target": "disableScopeInput", "action": "change->active-field-form#toggleScopeInput" } %>
+    </div>
+  <% end %>
+
   <div>
     <%= f.label :required %>
     <%= f.check_box :required, disabled: active_field.persisted? %>

data/lib/generators/active_fields/scaffold/templates/views/active_fields/forms/_date.html.erb

@@ -1,4 +1,9 @@
-<%= form_with(model: active_field, scope: :active_field, url: active_field.persisted? ? active_field_path(active_field) : active_fields_path) do |f| %>
+<%= form_with(
+      model: active_field,
+      scope: :active_field,
+      url: active_field.persisted? ? active_field_path(active_field) : active_fields_path,
+      data: { controller: "active-field-form" }
+    ) do |f| %>
   <% if active_field.errors.any? %>
     <div style="color: red">
       <h2><%= pluralize(active_field.errors.count, "error") %> prohibited this record from being saved:</h2>
@@ -32,6 +37,22 @@
     <%= f.text_field :name %>
   </div>
 
+  <% if active_field.persisted? %>
+    <% if active_field.scope %>
+      <div>
+        <%= f.label :scope %>
+        <%= f.text_field :scope, disabled: true %>
+      </div>
+    <% end %>
+  <% else %>
+    <div>
+      <%= f.label :scope %>
+      <%= f.text_field :scope, data: { "active-field-form-target": "scopeInput" } %>
+      <%= f.label :disable_scope %>
+      <%= f.check_box :disable_scope, data: { "active-field-form-target": "disableScopeInput", "action": "change->active-field-form#toggleScopeInput" } %>
+    </div>
+  <% end %>
+
   <div>
     <%= f.label :required %>
     <%= f.check_box :required, disabled: active_field.persisted? %>

data/lib/generators/active_fields/scaffold/templates/views/active_fields/forms/_date_array.html.erb

@@ -1,4 +1,9 @@
-<%= form_with(model: active_field, scope: :active_field, url: active_field.persisted? ? active_field_path(active_field) : active_fields_path) do |f| %>
+<%= form_with(
+      model: active_field,
+      scope: :active_field,
+      url: active_field.persisted? ? active_field_path(active_field) : active_fields_path,
+      data: { controller: "active-field-form" }
+    ) do |f| %>
   <% if active_field.errors.any? %>
     <div style="color: red">
       <h2><%= pluralize(active_field.errors.count, "error") %> prohibited this record from being saved:</h2>
@@ -32,6 +37,22 @@
     <%= f.text_field :name %>
   </div>
 
+  <% if active_field.persisted? %>
+    <% if active_field.scope %>
+      <div>
+        <%= f.label :scope %>
+        <%= f.text_field :scope, disabled: true %>
+      </div>
+    <% end %>
+  <% else %>
+    <div>
+      <%= f.label :scope %>
+      <%= f.text_field :scope, data: { "active-field-form-target": "scopeInput" } %>
+      <%= f.label :disable_scope %>
+      <%= f.check_box :disable_scope, data: { "active-field-form-target": "disableScopeInput", "action": "change->active-field-form#toggleScopeInput" } %>
+    </div>
+  <% end %>
+
   <div>
     <%= f.label :min_size %>
     <%= f.number_field :min_size, disabled: active_field.persisted? %>

data/lib/generators/active_fields/scaffold/templates/views/active_fields/forms/_datetime.html.erb

@@ -1,4 +1,9 @@
-<%= form_with(model: active_field, scope: :active_field, url: active_field.persisted? ? active_field_path(active_field) : active_fields_path) do |f| %>
+<%= form_with(
+      model: active_field,
+      scope: :active_field,
+      url: active_field.persisted? ? active_field_path(active_field) : active_fields_path,
+      data: { controller: "active-field-form" }
+    ) do |f| %>
   <% if active_field.errors.any? %>
     <div style="color: red">
       <h2><%= pluralize(active_field.errors.count, "error") %> prohibited this record from being saved:</h2>
@@ -32,6 +37,22 @@
     <%= f.text_field :name %>
   </div>
 
+  <% if active_field.persisted? %>
+    <% if active_field.scope %>
+      <div>
+        <%= f.label :scope %>
+        <%= f.text_field :scope, disabled: true %>
+      </div>
+    <% end %>
+  <% else %>
+    <div>
+      <%= f.label :scope %>
+      <%= f.text_field :scope, data: { "active-field-form-target": "scopeInput" } %>
+      <%= f.label :disable_scope %>
+      <%= f.check_box :disable_scope, data: { "active-field-form-target": "disableScopeInput", "action": "change->active-field-form#toggleScopeInput" } %>
+    </div>
+  <% end %>
+
   <div>
     <%= f.label :required %>
     <%= f.check_box :required, disabled: active_field.persisted? %>

data/lib/generators/active_fields/scaffold/templates/views/active_fields/forms/_datetime_array.html.erb

@@ -1,4 +1,9 @@
-<%= form_with(model: active_field, scope: :active_field, url: active_field.persisted? ? active_field_path(active_field) : active_fields_path) do |f| %>
+<%= form_with(
+      model: active_field,
+      scope: :active_field,
+      url: active_field.persisted? ? active_field_path(active_field) : active_fields_path,
+      data: { controller: "active-field-form" }
+    ) do |f| %>
   <% if active_field.errors.any? %>
     <div style="color: red">
       <h2><%= pluralize(active_field.errors.count, "error") %> prohibited this record from being saved:</h2>
@@ -32,6 +37,22 @@
     <%= f.text_field :name %>
   </div>
 
+  <% if active_field.persisted? %>
+    <% if active_field.scope %>
+      <div>
+        <%= f.label :scope %>
+        <%= f.text_field :scope, disabled: true %>
+      </div>
+    <% end %>
+  <% else %>
+    <div>
+      <%= f.label :scope %>
+      <%= f.text_field :scope, data: { "active-field-form-target": "scopeInput" } %>
+      <%= f.label :disable_scope %>
+      <%= f.check_box :disable_scope, data: { "active-field-form-target": "disableScopeInput", "action": "change->active-field-form#toggleScopeInput" } %>
+    </div>
+  <% end %>
+
   <div>
     <%= f.label :min_size %>
     <%= f.number_field :min_size, disabled: active_field.persisted? %>

data/lib/generators/active_fields/scaffold/templates/views/active_fields/forms/_decimal.html.erb

@@ -1,4 +1,9 @@
-<%= form_with(model: active_field, scope: :active_field, url: active_field.persisted? ? active_field_path(active_field) : active_fields_path) do |f| %>
+<%= form_with(
+      model: active_field,
+      scope: :active_field,
+      url: active_field.persisted? ? active_field_path(active_field) : active_fields_path,
+      data: { controller: "active-field-form" }
+    ) do |f| %>
   <% if active_field.errors.any? %>
     <div style="color: red">
       <h2><%= pluralize(active_field.errors.count, "error") %> prohibited this record from being saved:</h2>
@@ -32,6 +37,22 @@
     <%= f.text_field :name %>
   </div>
 
+  <% if active_field.persisted? %>
+    <% if active_field.scope %>
+      <div>
+        <%= f.label :scope %>
+        <%= f.text_field :scope, disabled: true %>
+      </div>
+    <% end %>
+  <% else %>
+    <div>
+      <%= f.label :scope %>
+      <%= f.text_field :scope, data: { "active-field-form-target": "scopeInput" } %>
+      <%= f.label :disable_scope %>
+      <%= f.check_box :disable_scope, data: { "active-field-form-target": "disableScopeInput", "action": "change->active-field-form#toggleScopeInput" } %>
+    </div>
+  <% end %>
+
   <div>
     <%= f.label :required %>
     <%= f.check_box :required, disabled: active_field.persisted? %>