base_editing_bootstrap 1.15.1 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80fc468a9d1b88f86141bbec31daa80a9ad21251177ad905e09795a1728106e1
-  data.tar.gz: d7315c0afddb62fc17d4a27ca40f33abb107033e4040e6e7b2d95ab25851203f
+  metadata.gz: 8bd43711d49d65d4d703fb15361b66e41699844894e210b6509e7f6d35699b73
+  data.tar.gz: e22898cbe35cfe6c2545c4f5fe711ef4354e6943376699057e9a814da6f778e5
 SHA512:
-  metadata.gz: 94581a8e80610a056bcfcc2f88699e4dff56bcbd1fdf9b835dc822ed0ed7dc8fbab9a34a01ec42c64932eeb637254285530a64eb5847a3cb5c14350ada7a927b
-  data.tar.gz: 5f752eb62c62fc7fb697443da46fa911801fdf90fcad8af88a778994c05bf964fcf3f9ee4e4cc21bfd2c4a825bd06ffdca4f282b590977068b0296f9ada4a44a
+  metadata.gz: ad5021b0cdc14d54b8c88e3f35e9d2f9ad897b977f245553959fb1b6a560b7773a085c40b3a42cb1cccdc307c3b3d87e0586679b1032515dae67e75c3b14beb2
+  data.tar.gz: 4bd0b6718b83b4c8b7041e3ad94b229059909e7962ca361659230ac96b11df57c89c04e205ef6dd9fc3fd6d92e2f23445711197d0df0c3ec0d8da784fc7c5d2f

data/AGENTS.md

@@ -0,0 +1,56 @@
+# AGENTS.md
+
+This file provides context and instructions for AI coding agents working on the **BaseEditingBootstrap** project.
+
+## Project Overview
+BaseEditingBootstrap is a Rails engine designed to provide a standardized, Bootstrap-based administrative interface for Rails models. It integrates with Pundit for authorization and Ransack for searching/sorting.
+
+- **Main Components**:
+    - `BaseEditingController`: The base controller for all CRUD operations.
+    - `BaseModel`: A concern for models that should support standard editing.
+    - `BaseModelPolicy`: A base Pundit policy with specific methods for controlling UI elements.
+
+## Build & Test
+The project uses Docker for environment setup and testing.
+
+- **Setup Environment**:
+    ```bash
+    docker compose run app spec/dummy/bin/setup
+    ```
+- **Run Tests**:
+    ```bash
+    docker compose run app bundle exec rspec
+    ```
+- **Start Development Server**:
+    ```bash
+    docker compose up
+    ```
+
+## Development Workflow
+- **Naming Conventions**: Follow standard Rails/Ruby naming conventions (snake_case for files and methods, CamelCase for classes).
+- **Git Flow**: Use descriptive commit messages. No specific branching strategy is enforced, but use feature branches.
+- **Testing**:
+    - **Controllers**: Use `it_behaves_like "base editing controller"`.
+    - **Models**: Use `it_behaves_like "a base model"`.
+    - **Policies**: Use `it_behaves_like "a standard base model policy"`.
+    - Ensure all new features or bug fixes include corresponding RSpec tests.
+
+## Coding Conventions & Patterns
+- **Pundit Policies**:
+    - Implement `editable_attributes` to define fields visible/editable in forms.
+    - Implement `search_result_fields` to define columns in the index table.
+    - Implement `search_fields` for Ransack search form fields.
+    - Implement `permitted_attributes` for Pundit strong parameters.
+- **Factories**:
+    - Every model factory should include a trait `:with_invalid_attributes` for testing validation failures.
+- **Form/Cell Overrides**:
+    - Use the provided generators for field/cell overrides:
+        ```bash
+        rails g base_editing_bootstrap:field_override ModelName field1 field2:type
+        rails g base_editing_bootstrap:cell_override ModelName field1 field2:type
+        ```
+- **I18n**: Follow the project's translation structure for messages and labels (see `README.md`).
+
+## Security
+- Always use Pundit for authorization (`include Pundit::Authorization` in `ApplicationController`).
+- Ensure `permitted_attributes` in policies correctly restrict user input.

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
 
 - - -
+## 1.16.0 - 2026-06-24
+#### Features
+- Aggiunta possibilità di customizzare label in checkbox - (9c96ddf) - Marino Bonetti
+- Add option to hide fields in form by policy - (ec2a103) - Marino Bonetti
+#### Bug Fixes
+- Rimossa versione i18n non valida - (8e52029) - Marino Bonetti
+- Visualizzazione validazione su file upload - (69223c1) - Marino Bonetti
+- Update expectation to use be_a for search instance type - (3cc4acc) - Marino Bonetti
+#### Miscellaneous Chores
+- Fix Broken cogs configs - (da27444) - Marino Bonetti
+
+- - -
+
 ## 1.15.1 - 2026-04-13
 #### Bug Fixes
 - Correzione pattern per decimali - (08847c0) - Marino Bonetti

data/README.md

@@ -305,6 +305,11 @@ Al generator per i campi standard basta aggiungere il parametro `--readonly` per
   rails g base_editing_bootstrap:field_override ModelName field1 field2:type --readonly
 ```
 
+### Hidden Fields
+E' possibile renderizzare i campi di un modello in modalità nascosta,
+andando a ridefinire nella policy il metodo  `attribute_is_hidden(attribute_name)`.
+I campi nascosti verranno renderizzati tutti assieme all'inizio della form.
+
 
 ### Translations
 

data/app/controllers/base_editing_controller.rb

@@ -5,7 +5,9 @@ class BaseEditingController < RestrictedAreaController
                 :edit_custom_polymorphic_path,
                 :form_attributes,
                 :form_builder,
+                :field_renderer_class,
                 :readonly_attribute?,
+                :hidden_attribute?,
                 :index_custom_polymorphic_path,
                 :new_custom_polymorphic_path,
                 :show_custom_polymorphic_path
@@ -122,6 +124,10 @@ class BaseEditingController < RestrictedAreaController
     BaseEditingBootstrap::Forms::Base
   end
 
+  def field_renderer_class
+    BaseEditingBootstrap::Forms::FieldRenderer
+  end
+
   def form_attributes(model = base_class.new, action = override_pundit_action_name)
     policy = policy(model)
     method_name = if policy.respond_to?("editable_attributes_for_#{action}")
@@ -142,6 +148,16 @@ class BaseEditingController < RestrictedAreaController
     policy.public_send(method_name, attribute)
   end
 
+  def hidden_attribute?(attribute, model = base_class.new, action = override_pundit_action_name)
+    policy = policy(model)
+    method_name = if policy.respond_to?("attribute_is_hidden_for_#{action}")
+                    "attribute_is_hidden_for_#{action}"
+                  else
+                    "attribute_is_hidden"
+                  end
+    policy.public_send(method_name, attribute)
+  end
+
   def load_object
     @object = base_class.find(params[:id])
 

data/app/helpers/utilities/form_helper.rb

@@ -15,95 +15,29 @@ module Utilities
     end
 
     ##
-    # Metodo per il partial corretto per eseguire il render del campo della form
+    # Metodo per il partial corretto per restituire l'oggetto della form con le logiche per
+    # trovare il template e le informazioni necessarie
     #
     # @param [Forms::Base] form
     # @param [Symbol] field
     # @param [Boolean] readonly -> rende possibile nelle nested form, nel caso arrivi da un field padre che definisce
     #                               il campo come readonly di non controllare nemmeno la policy(il padre ha priorità su figlio)
-    # @return [ActiveSupport::SafeBuffer]
-    def form_print_field(form, field, readonly: nil)
-      locals = {form:, field:}
-      if form.object.class.respond_to?(:field_to_form_partial) and (generic_field = form.object.class.field_to_form_partial(field))
-        type = :custom
-      elsif form.object.class.respond_to?(:defined_enums) && form.object.class.defined_enums.key?(field.to_s)
-        type = :enum
-        generic_field = "enum"
-      elsif form.object.class.respond_to?(:reflect_on_association) &&
-            form.object.class.reflect_on_association(field.to_s).is_a?(ActiveRecord::Reflection::BelongsToReflection) &&
-            !form.object.class.reflect_on_association(field.to_s).polymorphic? # non deve essere polymorphic
-        # Abbiamo una relazione belongs_to da gestire
-        reflection = form.object.class.reflect_on_association(field.to_s)
-        type = :belongs_to
-        generic_field = "belongs_to_select"
-        locals[:relation_class] = reflection.klass
-        locals[:foreign_key] = reflection.foreign_key
-      elsif form.object.class.respond_to?(:nested_attributes_options) &&
-            form.object.class.nested_attributes_options.key?(field.to_sym)
-        type = :nested_attributes
-        reflection = form.object.class.reflect_on_association(field.to_s)
-        case reflection
-        when ActiveRecord::Reflection::HasManyReflection
-          locals[:new_object] = reflection.klass.new(reflection.foreign_key => form.object)
-          generic_field = "accept_has_many_nested_field"
-        when ActiveRecord::Reflection::HasOneReflection
-          form.object.send(:"build_#{field}") unless form.object.send(field).present?
-          generic_field = "accept_has_one_nested_field"
-        else
-          raise "Unknown reflection for nested attributes #{field}->#{reflection.class}"
-        end
-      else
-        if form.object.class.respond_to?(:type_for_attribute)
-          type = form.object.class.type_for_attribute(field).type
-
-          # Se non abbiamo ancora il type tentiamo di capire se è di tipo attachment SINGOLO
-          if type.nil? and form.object.respond_to?(:"#{field}_attachment")
-            type = :has_one_attachment
-          end
-        else
-          type = :string
-        end
+    # @return [BaseEditingBootstrap::Forms::FormFieldRenderer]
+    def form_print_field_object(form, field, readonly: nil)
+      field_renderer_class.new(self, form, field, readonly: readonly)
+    end
 
-        case type
-        when :datetime
-          generic_field = "datetime"
-        when :date
-          generic_field = "date"
-        when :decimal
-          locals[:scale] = form.object.class.type_for_attribute(field).scale || 2
-          generic_field = "decimal"
-        when :float
-          locals[:scale] = 2 # usiamo il default dato che non abbiamo questa informazione negli attributes di rails
-          generic_field = "decimal"
-        when :integer
-          generic_field = "integer"
-        when :boolean
-          generic_field = "boolean"
-        when :has_one_attachment
-          generic_field = "has_one_attachment"
-        when :text
-          generic_field = "textarea"
-        else
-          generic_field = "base"
-        end
-      end
 
-      template = find_template_with_fallbacks(
-        form.object,
-        field,
-        "form_field",
-        generic_field,
-        readonly: (readonly.nil? ? readonly_attribute?(field, form.object) : readonly)
-      )
-      bs_logger.debug do
-        <<~TEXT
-          TYPE: #{type}
-          GENERIC_FIELD: #{generic_field}
-          TEMPLATE: #{template.short_identifier}
-          LOCALS:#{locals}
-        TEXT
-      end
-      template.render(self, locals)
+    ##
+    # Metodo per il partial corretto per eseguire il render del campo della form
+    #
+    # @param [Forms::Base] form
+    # @param [Symbol] field
+    # @param [Boolean] readonly -> rende possibile nelle nested form, nel caso arrivi da un field padre che definisce
+    #                               il campo come readonly di non controllare nemmeno la policy(il padre ha priorità su figlio)
+    # @return [ActiveSupport::SafeBuffer]
+    def form_print_field(...)
+      form_print_field_object(...).render
     end
 
   end

data/app/policies/base_model_policy.rb

@@ -36,6 +36,18 @@ class BaseModelPolicy < ApplicationPolicy
   # @return [Boolean] true se l'attributo è di sola lettura, false altrimenti
   def attribute_is_readonly(_attribute) = false
 
+  ##
+  # Permette di specificare se un attributo deve essere trattato come hidden durante il rendering della form.
+  # Analogamente a attribute_is_readonly è possibile definire la versione specifica per azione:
+  # - attribute_is_hidden_for_create?
+  # - attribute_is_hidden_for_update?
+  # - attribute_is_hidden_for_ACTION_NAME?
+  #
+  # @param attribute [Symbol] nome dell'attributo
+  # @param action_name [String] nome dell'azione
+  # @return [Boolean] true se l'attributo è hidden (deve essere renderizzato come hidden_field), false altrimenti
+  def attribute_is_hidden(_attribute) = false
+
   def permitted_attributes_for_ransack
     record.class.column_names + record.class._ransackers.keys
   end

data/app/views/base_editing/_form_field.html.erb

@@ -7,7 +7,8 @@
 <%# locals: (form:, form_field:,readonly:nil) -%>
 <%
   input_group_classes = ["mb-1"]
-  content = form_print_field(form, form_field, readonly: readonly)
+  renderer = form_print_field_object(form, form_field, readonly: readonly)
+  content = renderer.render
   unless content.match "checkbox"
     input_group_classes << "input-group"
   end
@@ -18,7 +19,11 @@
   if content.match "form-switch"
     label_content = nil
   else
-    label_content = form.label(form_field, class: ["form-label", "form-#{form_field}-label"])
+    if renderer.type == :belongs_to
+      label_content = form.label(renderer.locals[:foreign_key], class: ["form-label", "form-#{form_field}-label"] )
+      else
+        label_content = form.label(form_field, class: ["form-label", "form-#{form_field}-label"])
+    end
   end
 
 %>

data/app/views/base_editing/_form_field_container.html.erb

@@ -1,3 +1,3 @@
-<div class="mb-3">
+<div class="mb-3 <%= dom_class(form.object,"form_field_container_#{form_field}") %>">
   <%= yield %>
 </div>

data/app/views/base_editing/_form_full_components.html.erb

@@ -7,7 +7,13 @@
   <%= render partial: "form_field_header", locals: {form:} %>
   <%= render partial: "form_base_errors", locals: {form:} if form.object.errors.key?(:base) %>
   <%= render layout: "form_fields_container" do %>
-    <%= render collection: form_attributes(form.object),
+
+    <% hidden_fields = form_attributes(form.object).select { |field| hidden_attribute?(field) } %>
+    <% hidden_fields.each do |form_field| %>
+      <%= form.hidden_field(form_field) %>
+    <% end %>
+
+    <%= render collection: form_attributes(form.object) - hidden_fields,
                layout: "form_field_container",
                partial: "form_field", locals: {form:, readonly: readonly} %>
   <% end %>

data/app/views/base_editing/form_field/_has_one_attachment.html.erb

@@ -1,6 +1,9 @@
 <%# locals: (form:, field:) -%>
 <%
-  is_attached = form.object.send(field).attached?
+  attachment = form.object.send(field)
+  is_attached = attachment.attached?
+  blob = attachment.attachment&.blob
+  is_persisted_blob = blob&.persisted?
   hidden_field_id = dom_id(form.object, "hidden_#{field}")
   preview_image_id = dom_id(form.object, "preview_image_#{field}")
   filename_id = dom_id(form.object, "filename_#{field}")
@@ -13,22 +16,22 @@
                             JAVASCRIPT
 
 %>
-<div class="d-flex">
-  <%= form.hidden_field field, value: form.object.send(field).signed_id, id: hidden_field_id if is_attached %>
+<div class="d-flex <%= form.object.errors.include?(field) ? "is-invalid" : "" %>">
+  <%= form.hidden_field field, value: attachment.signed_id, id: hidden_field_id if is_attached && is_persisted_blob %>
 
   <%= form.file_field field, direct_upload: true %>
 
   <% if is_attached %>
 
-    <%= content_tag :span, form.object.send(field).attachment.blob.filename, class: "input-group-text  flex-grow-1", id: filename_id %>
+    <%= content_tag :span, blob.filename, class: "input-group-text  flex-grow-1", id: filename_id if blob.present? %>
     <%= content_tag :button, icon(:trash),
                     onclick: javascript_clear_event,
                     class: "btn btn-outline-secondary rounded-0" %>
-    <%= link_to icon(:download), form.object.send(field), class: "btn btn-outline-secondary", target: :_blank %>
+    <%= link_to icon(:download), attachment, class: "btn btn-outline-secondary", target: :_blank if is_persisted_blob %>
 
-    <% if form.object.send(field).representable? %>
+    <% if is_persisted_blob && attachment.representable? %>
       <% content_for :form_field_ending, flush: true do %>
-        <%= content_tag :div, image_tag(form.object.send(field).representation(resize_to_limit: [100, 100])), id: preview_image_id %>
+        <%= content_tag :div, image_tag(attachment.representation(resize_to_limit: [100, 100])), id: preview_image_id %>
       <% end %>
     <% end %>
   <% end %>

data/lib/base_editing_bootstrap/VERSION

@@ -1 +1 @@
-1.15.1
+1.16.0

data/lib/base_editing_bootstrap/forms/base.rb

@@ -60,6 +60,8 @@ module BaseEditingBootstrap::Forms
       label = options.extract!(:label)[:label] || nil
       if label
         label_tag = label(label, class: "form-check-label")
+      elsif block_given?
+        label_tag = yield
       else
         label_tag = nil
       end

data/lib/base_editing_bootstrap/forms/field_renderer.rb

@@ -0,0 +1,129 @@
+module BaseEditingBootstrap::Forms
+  # Responsible for deciding which template and locals to use for form fields
+  # Usage: Utilities::FormFieldRenderer.new(view_context, form, field, readonly:).render
+  class FieldRenderer
+    attr_reader :view, :form, :field, :locals, :type, :generic_field
+
+    def initialize(view, form, field, readonly: nil)
+      @view = view
+      @form = form
+      @field = field
+      @readonly = readonly
+      @locals = { form: form, field: field }
+      @type = nil
+      @generic_field = nil
+      determine_field_and_locals
+    end
+
+    # Perform full rendering and return SafeBuffer
+    def render
+      tmpl = template
+      view.bs_logger.debug do
+        <<~TEXT
+          TYPE: #{type}
+          GENERIC_FIELD: #{generic_field}
+          TEMPLATE: #{tmpl.short_identifier}
+          LOCALS:#{locals}
+        TEXT
+      end
+      tmpl.render(view, locals)
+    end
+
+    # Public helpers for tests or external callers
+    def template
+      view.find_template_with_fallbacks(
+        form.object,
+        field,
+        "form_field",
+        generic_field,
+        readonly: readonly_value
+      )
+    end
+
+    def readonly_value
+      @readonly.nil? ? view.readonly_attribute?(field, form.object) : @readonly
+    end
+
+    private
+
+    def determine_field_and_locals
+      if form.object.class.respond_to?(:field_to_form_partial) &&
+         (generic = form.object.class.field_to_form_partial(field)
+         )
+        @type = :custom
+        @generic_field = generic
+      elsif form.object.class.respond_to?(:defined_enums) && form.object.class.defined_enums.key?(field.to_s)
+        @type = :enum
+        @generic_field = "enum"
+      elsif belongs_to_reflection?
+        reflection = form.object.class.reflect_on_association(field.to_s)
+        @type = :belongs_to
+        @generic_field = "belongs_to_select"
+        locals[:relation_class] = reflection.klass
+        locals[:foreign_key] = reflection.foreign_key
+      elsif nested_attributes?
+        @type = :nested_attributes
+        reflection = form.object.class.reflect_on_association(field.to_s)
+        case reflection
+        when ActiveRecord::Reflection::HasManyReflection
+          locals[:new_object] = reflection.klass.new(reflection.foreign_key => form.object)
+          @generic_field = "accept_has_many_nested_field"
+        when ActiveRecord::Reflection::HasOneReflection
+          form.object.send(:"build_#{field}") unless form.object.send(field).present?
+          @generic_field = "accept_has_one_nested_field"
+        else
+          raise "Unknown reflection for nested attributes #{field}->#{reflection.class}"
+        end
+      else
+        determine_by_attribute_type
+      end
+    end
+
+    def belongs_to_reflection?
+      form.object.class.respond_to?(:reflect_on_association) &&
+        (ref = form.object.class.reflect_on_association(field.to_s)).is_a?(ActiveRecord::Reflection::BelongsToReflection) &&
+        !ref.polymorphic?
+    end
+
+    def nested_attributes?
+      form.object.class.respond_to?(:nested_attributes_options) &&
+        form.object.class.nested_attributes_options.key?(field.to_sym)
+    end
+
+    def determine_by_attribute_type
+      if form.object.class.respond_to?(:type_for_attribute)
+        @type = form.object.class.type_for_attribute(field).type
+
+        # If nil, check for single attachment
+        if @type.nil? && form.object.respond_to?(:"#{field}_attachment")
+          @type = :has_one_attachment
+        end
+      else
+        @type = :string
+      end
+
+      case type
+      when :datetime
+        @generic_field = "datetime"
+      when :date
+        @generic_field = "date"
+      when :decimal
+        locals[:scale] = form.object.class.type_for_attribute(field).scale || 2
+        @generic_field = "decimal"
+      when :float
+        locals[:scale] = 2
+        @generic_field = "decimal"
+      when :integer
+        @generic_field = "integer"
+      when :boolean
+        @generic_field = "boolean"
+      when :has_one_attachment
+        @generic_field = "has_one_attachment"
+      when :text
+        @generic_field = "textarea"
+      else
+        @generic_field = "base"
+      end
+    end
+  end
+end

data/spec/support/external_shared/base_editing_controller_helpers.rb

@@ -114,7 +114,7 @@ RSpec.shared_examples "base editing controller" do |factory: nil, only: [], exce
         params = {q: {"foo_eq": "foo"}}
         get url_for_index, params: params
         expect(response).to have_http_status(200)
-        expect(assigns[:search_instance]).to be_an_instance_of(BaseEditingBootstrap::Searches::Base)
+        expect(assigns[:search_instance]).to be_a(BaseEditingBootstrap::Searches::Base)
                                                .and(have_attributes(
                                                       user: user,
                                                       params: ActionController::Parameters.new(params).permit!,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base_editing_bootstrap
 version: !ruby/object:Gem::Version
-  version: 1.15.1
+  version: 1.16.0
 platform: ruby
 authors:
 - Marino Bonetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-13 00:00:00.000000000 Z
+date: 2026-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -313,6 +313,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- AGENTS.md
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -413,6 +414,7 @@ files:
 - lib/base_editing_bootstrap/base_model.rb
 - lib/base_editing_bootstrap/engine.rb
 - lib/base_editing_bootstrap/forms/base.rb
+- lib/base_editing_bootstrap/forms/field_renderer.rb
 - lib/base_editing_bootstrap/generators_helpers.rb
 - lib/base_editing_bootstrap/is_validated.rb
 - lib/base_editing_bootstrap/logging.rb