base_editing_bootstrap 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74db6610e2c8ab5c7f25de60eb6fb1c7ba1fa83570cd552a3356674356f02518
-  data.tar.gz: 8aea6970cecd4fa8623711b21d9ec77e2b2657757dfa94c91e94028b687a074e
+  metadata.gz: d69ef1800e2eece675666b76837ae189f47c6f054031c12990a4b36181fca951
+  data.tar.gz: e345a8d8545068e50128afe6e55d212fe5f6e87555309898fb72ed0add5e0d69
 SHA512:
-  metadata.gz: 5713323d93896548db8ee7fd75b187e5b7b6b61efb76c3855a92c79139eaa993af1a480a6cc1fe85c84a95e9b8af1f2c0dabe615ce14815728450bbd4390b10e
-  data.tar.gz: 1a6068cc2a7b296c4f8d0a3a20097efd9dddb1752bb6e5e4844053ec8f6997eac49183af26d6873949c44d4bce05235ebfb655f171d7c0d2e203a48bef8988ae
+  metadata.gz: 37e059fd372aeb9ef27780523d13d336e4815c6afb8792990b6a375f1c60a1dfb951d48ea2231045a2715de8022138eb8732dfaa313b2e06d77ed23e1a4ee731
+  data.tar.gz: 4e8778eefe88514f17133dab5c96d5d8eaad61cb71bdf82b5ace11226af0f737a8e4ff15dd1609efd7555610aeaaec8e4783175103f4ad2e0323acd69ee6e2dd

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
 
 - - -
+## 1.15.0 - 2026-04-09
+#### Features
+- Add Read only mode (#25) - (0ba3da2) - Marino Bonetti
+
+- - -
+
 ## 1.14.0 - 2026-03-19
 #### Features
 - Nested elements with limit from rails config (#24) - (f003ce4) - Marino Bonetti

data/README.md

@@ -292,6 +292,20 @@ Note:
 
 Fai riferimento all'implementazione di esempio del dummy `Company->addresses`
 
+### ReadOnly
+E' possibile renderizzare i campi di un modello in sola lettura, andando a ridefinire nella policy
+il metodo  `attribute_is_readonly(attribute_name)`.  
+Per ogni campo abbiamo la versione NOME_CAMPO_readonly.html.erb che viene renderizzato quando il metodo
+precedente restituisce true.  
+I nested attributes verranno renderizzati rispetto a quanto definito dal
+campo padre.  
+La ricerca dei partial avviene nella stessa modalità dei campi sopra definiti.  
+Al generator per i campi standard basta aggiungere il parametro `--readonly` per avere la versione NOME_CAMPO_readonly.html.erb:  
+```shell
+  rails g base_editing_bootstrap:field_override ModelName field1 field2:type --readonly
+```
+
+
 ### Translations
 
 #### Index buttons:  

data/app/controllers/base_editing_controller.rb

@@ -5,6 +5,7 @@ class BaseEditingController < RestrictedAreaController
                 :edit_custom_polymorphic_path,
                 :form_attributes,
                 :form_builder,
+                :readonly_attribute?,
                 :index_custom_polymorphic_path,
                 :new_custom_polymorphic_path,
                 :show_custom_polymorphic_path
@@ -131,6 +132,16 @@ class BaseEditingController < RestrictedAreaController
     policy.public_send(method_name)
   end
 
+  def readonly_attribute?(attribute, model = base_class.new, action = override_pundit_action_name)
+    policy = policy(model)
+    method_name = if policy.respond_to?("attribute_is_readonly_for_#{action}")
+                    "attribute_is_readonly_for_#{action}"
+                  else
+                    "attribute_is_readonly"
+                  end
+    policy.public_send(method_name, attribute)
+  end
+
   def load_object
     @object = base_class.find(params[:id])
 

data/app/helpers/utilities/form_helper.rb

@@ -19,10 +19,13 @@ module Utilities
     #
     # @param [Forms::Base] form
     # @param [Symbol] field
-    def form_print_field(form, 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
+        type = :custom
       elsif form.object.class.respond_to?(:defined_enums) && form.object.class.defined_enums.key?(field.to_s)
         type = :enum
         generic_field = "enum"
@@ -89,7 +92,8 @@ module Utilities
         form.object,
         field,
         "form_field",
-        generic_field
+        generic_field,
+        readonly: (readonly.nil? ? readonly_attribute?(field, form.object) : readonly)
       )
       bs_logger.debug do
         <<~TEXT

data/app/helpers/utilities/template_helper.rb

@@ -12,7 +12,8 @@ module Utilities::TemplateHelper
   # @param [Symbol] field
   # @param [String] base_path
   # @param [String] generic_field
-  def find_template_with_fallbacks(obj, field, base_path, generic_field)
+  # @param [Boolean] readonly #aggiunge nella ricerca del template la versione readonly
+  def find_template_with_fallbacks(obj, field, base_path, generic_field, readonly: false)
     # nei casi in cui passiamo la classe e non l'oggetto, dobbiamo utilizzare un metodo interno a rails per
     # avere la partial_path
 
@@ -31,7 +32,7 @@ module Utilities::TemplateHelper
     end
 
     bs_logger.tagged(field) do
-      [
+      casistiche = [
         # Precedenza modello e campo specifico
         ["Campo SPECIFICO + inheritance tra modelli", field, obj_base_paths],
         # cerco tramite nome modello semplice, con namespace della risorsa (cell_field,header_field,form_field) e nome del campo specifico
@@ -42,7 +43,14 @@ module Utilities::TemplateHelper
         ["Campo GENERICO + inheritance controllers", "#{base_path}/#{generic_field}", lookup_context.prefixes],
         ["Campo GENERICO + inheritance tra modelli", generic_field, obj_base_paths],
         ["Default BaseEditingController", "base_editing/#{base_path}/#{generic_field}", []],
-      ].each do |desc, partial, prefixes|
+      ]
+      # In caso di readonly andremo a ricercare solamente la versione di quel tipo
+      if readonly
+        casistiche = casistiche.collect do |desc, partial, prefixes|
+          [desc, "#{partial}_readonly", prefixes]
+        end
+      end
+      casistiche.each do |desc, partial, prefixes|
         bs_logger.debug { "#{desc} - partial:`#{partial}` in #{prefixes.inspect}" }
         if lookup_context.exists?(partial, prefixes, true)
           return lookup_context.find(partial, prefixes, true)

data/app/policies/base_model_policy.rb

@@ -9,13 +9,33 @@ class BaseModelPolicy < ApplicationPolicy
 
   def show? = general_rule
 
-  # Questo metodo può essere anche scritto specifico per azione:
+  # Questo metodo può essere richiamato specifico per azione:
   # - permitted_attributes_for_create
   # - permitted_attributes_for_update
+  # - permitted_attributes_for_ACTION_NAME
+  # Quindi nella policy possiamo differenziare le due situazioni
   def permitted_attributes = []
 
+  # Questo metodo può essere richiamato specifico per azione:
+  # - editable_attributes_for_create
+  # - editable_attributes_for_update
+  # - editable_attributes_for_ACTION_NAME
+  # Quindi nella policy possiamo differenziare le due situazioni
   def editable_attributes = []
 
+  ##
+  # Permette di specificare se un attributo è di sola lettura durante il rendering della form.
+  # Oltre alla versione standard è possibile definire il metodo specificando il tipo di azione con il
+  # medesimo formato utilizzato negli altri metodi:
+  # - attribute_is_readonly_for_create?
+  # - attribute_is_readonly_for_update?
+  # - attribute_is_readonly_for_ACTION_NAME?
+  #
+  # @param attribute [Symbol] nome dell'attributo
+  # @param action_name [String] nome dell'azione
+  # @return [Boolean] true se l'attributo è di sola lettura, false altrimenti
+  def attribute_is_readonly(_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

@@ -4,11 +4,10 @@
   # - form       -> FormBuilder
   # - form_field -> String
 %>
-<%# locals: (form:, form_field:) -%>
+<%# locals: (form:, form_field:,readonly:nil) -%>
 <%
   input_group_classes = ["mb-1"]
-
-  content = form_print_field(form, form_field)
+  content = form_print_field(form, form_field, readonly: readonly)
   unless content.match "checkbox"
     input_group_classes << "input-group"
   end

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

@@ -2,13 +2,13 @@
   Questo partial è il raggruppamento di tutti gli elementi tranne il footer del form.
   Serve per riutilizzarlo anche nel nested attributes come base per costruire tutti gli elementi
 %>
-<%# locals: (form:) -%>
+<%# locals: (form:,readonly:nil) -%>
 <%= render layout: "form_body_container" do %>
   <%= 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),
                layout: "form_field_container",
-               partial: "form_field", locals: {form:} %>
+               partial: "form_field", locals: {form:, readonly: readonly} %>
   <% end %>
 <% end %>

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

@@ -0,0 +1,8 @@
+<tr id="<%= dom_id(form.object) %>">
+  <% policy(form.object).editable_attributes.each do |field| %>
+    <td>
+      <%= form_print_field(form, field, readonly: true) %>
+      <%= error_messages_for(form.object, field) %>
+    </td>
+  <% end %>
+</tr>

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

@@ -0,0 +1,22 @@
+<%# locals: (form:, field:,new_object:) -%>
+<%= content_tag :table, class: "table read-only" do %>
+  <thead>
+  <tr>
+    <% policy(new_object).editable_attributes.each do |field| %>
+      <th>
+        <%= new_object.class.human_attribute_name(field) %>
+      </th>
+    <% end %>
+  </tr>
+  </thead>
+
+  <tbody>
+
+  <%= form.fields_for field do |form_for_sections| %>
+    <%= render "nested_row_form_readonly", form: form_for_sections %>
+  <% end %>
+
+  </tbody>
+
+<% end %>
+

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

@@ -0,0 +1,4 @@
+<%# locals: (form:, field:) -%>
+<%= form.fields_for field do |form_for_sections| %>
+  <%= render partial: "form_full_components", locals: {form: form_for_sections, readonly: true} %>
+<% end %>

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

@@ -0,0 +1,8 @@
+<%
+  ##
+  # Template per il rendering del vero campo input
+  # eseguire override nei casi in cui si voglia renderizzare qualcosa di differente
+%>
+<%# locals: (form:, field:) -%>
+<%= form.text_field(field, readonly: true, disabled: true, name: "READONLY") %>
+

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

@@ -1,6 +1,6 @@
 <%# locals: (form:, field:,relation_class:,foreign_key:,value_method: :id, label_method: :option_label) -%>
 <%= form.select(foreign_key, options_from_collection_for_select(policy_scope(relation_class),
-                                                          value_method, label_method,
-                                                          selected: form.object.send(foreign_key)),
+                                                                value_method, label_method,
+                                                                selected: form.object.send(foreign_key)),
                 include_blank: true
     ) %>

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

@@ -0,0 +1,6 @@
+<%# locals: (form:, field:,relation_class:,foreign_key:,value_method: :id, label_method: :option_label) -%>
+<%= form.select(foreign_key, options_from_collection_for_select(policy_scope(relation_class),
+                                                                value_method, label_method,
+                                                                selected: form.object.send(foreign_key)),
+                {include_blank: true}, {disabled: true, readonly: true, name: "READONLY"}
+    ) %>

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

@@ -1,2 +1,2 @@
 <%# locals: (form:, field:) -%>
-<%= form.switch_box(field,label: field) %>
+<%= form.switch_box(field, label: field) %>

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

@@ -0,0 +1,2 @@
+<%# locals: (form:, field:) -%>
+<%= form.switch_box(field, label: field, disabled: true, name: "READONLY") %>

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

@@ -0,0 +1,2 @@
+<%# locals: (form:, field:) -%>
+<%= form.date_field(field, disabled: true, readonly: true, name: "READONLY") %>

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

@@ -0,0 +1,2 @@
+<%# locals: (form:, field:) -%>
+<%= form.datetime_field(field, disabled: true, readonly: true, name: "READONLY") %>

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

@@ -0,0 +1,2 @@
+<%# locals: (form:, field:, scale:2) -%>
+<%= form.number_field(field, step: "0.#{"0" * (scale - 1)}1", disabled: true, readonly: true, name: "READONLY") %>

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

@@ -0,0 +1,2 @@
+<%# locals: (form:, field:) -%>
+<%= form.select(field, enum_collection(form.object.class, field, :form_field), {}, {disabled: true, readonly: true, name: "READONLY"}) %>

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

@@ -13,19 +13,23 @@
                             JAVASCRIPT
 
 %>
-<%= form.hidden_field field, value: form.object.send(field).signed_id, id: hidden_field_id if is_attached %>
+<div class="d-flex">
+  <%= form.hidden_field field, value: form.object.send(field).signed_id, id: hidden_field_id if is_attached %>
 
-<%= form.file_field field, direct_upload: true %>
+  <%= form.file_field field, direct_upload: true %>
 
-<% if is_attached %>
-  <%= content_tag :span, form.object.send(field).attachment.blob.filename, class: "input-group-text", id: filename_id %>
-  <%= 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 %>
-  <% if form.object.send(field).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 %>
+  <% 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 :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 %>
+
+    <% if form.object.send(field).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 %>
+      <% end %>
     <% end %>
   <% end %>
-<% end %>
+</div>

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

@@ -0,0 +1,12 @@
+<%# locals: (form:, field:) -%>
+<% if form.object.send(field).attached? %>
+  <div class="d-flex">
+    <%= content_tag :span, form.object.send(field).attachment.blob.filename, class: "input-group-text flex-grow-1" %>
+    <%= link_to icon(:download), form.object.send(field), class: "btn btn-outline-secondary ms-1", target: :_blank %>
+  </div>
+  <% if form.object.send(field).representable? %>
+    <% content_for :form_field_ending, flush: true do %>
+      <%= content_tag :div, image_tag(form.object.send(field).representation(resize_to_limit: [100, 100])) %>
+    <% end %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,2 @@
+<%# locals: (form:, field:) -%>
+<%= form.number_field(field, step: "1", readonly: true) %>

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

@@ -0,0 +1,7 @@
+<%
+  ##
+  # Template per il rendering del vero campo input
+  # eseguire override nei casi in cui si voglia renderizzare qualcosa di differente
+%>
+<%# locals: (form:, field:) -%>
+<%= form.text_area(field, readonly: true) %>

data/lib/base_editing_bootstrap/VERSION

@@ -1 +1 @@
-1.14.0
+1.15.0

data/lib/generators/base_editing_bootstrap/field_override/field_override_generator.rb

@@ -6,7 +6,8 @@ module BaseEditingBootstrap
       include BaseEditingBootstrap::GeneratorsHelpers
       source_root File.expand_path("../../../../app/views/base_editing", __dir__)
       argument :name, type: :string, banner: "Post", required: true
-      argument :attributes, type: :array, default: [], banner: "field field:type"
+      argument :attributes, type: :array, default: [], banner: "field field[:type]"
+      class_option :readonly, type: :boolean, default: false, banner: "--readonly"
 
       TYPES = %i[base date datetime decimal integer enum boolean]
 
@@ -24,13 +25,15 @@ module BaseEditingBootstrap
 
           base_path = class_to_view_path(name)
 
+          readonly_suffix = options[:readonly] ? "_readonly" : ""
+
           attributes.each do |a|
             attr_name, type = a.split(":")
 
             type = :base if type.nil?
             type = type.to_sym
             raise "Type #{type} not found in #{TYPES}" unless TYPES.include?(type)
-            copy_file "form_field/_#{type}.html.erb", File.join(*base_path,"form_field", "_#{attr_name}.html.erb")
+            copy_file "form_field/_#{type}#{readonly_suffix}.html.erb", File.join(*base_path,"form_field", "_#{attr_name}#{readonly_suffix}.html.erb")
           end
         end
 

data/spec/support/external_shared/pundit.rb

@@ -28,6 +28,7 @@ RSpec.shared_examples "a standard base model policy" do |factory, check_default_
         [:permitted_scopes_for_ransack],
         [:editable_attributes],
         [:permitted_attributes],
+        [:attribute_is_readonly],
       ]
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base_editing_bootstrap
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Marino Bonetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-19 00:00:00.000000000 Z
+date: 2026-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -353,6 +353,7 @@ files:
 - app/views/base_editing/_index_title_header.html.erb
 - app/views/base_editing/_navbar.html.erb
 - app/views/base_editing/_nested_row_form.html.erb
+- app/views/base_editing/_nested_row_form_readonly.html.erb
 - app/views/base_editing/_new_page_title_header.html.erb
 - app/views/base_editing/_search.html.erb
 - app/views/base_editing/_search_field.erb
@@ -367,17 +368,29 @@ files:
 - app/views/base_editing/cell_field/_timestamps.html.erb
 - app/views/base_editing/edit.html.erb
 - app/views/base_editing/form_field/_accept_has_many_nested_field.html.erb
+- app/views/base_editing/form_field/_accept_has_many_nested_field_readonly.html.erb
 - app/views/base_editing/form_field/_accept_has_one_nested_field.html.erb
+- app/views/base_editing/form_field/_accept_has_one_nested_field_readonly.html.erb
 - app/views/base_editing/form_field/_base.html.erb
+- app/views/base_editing/form_field/_base_readonly.html.erb
 - app/views/base_editing/form_field/_belongs_to_select.html.erb
+- app/views/base_editing/form_field/_belongs_to_select_readonly.html.erb
 - app/views/base_editing/form_field/_boolean.html.erb
+- app/views/base_editing/form_field/_boolean_readonly.html.erb
 - app/views/base_editing/form_field/_date.html.erb
+- app/views/base_editing/form_field/_date_readonly.html.erb
 - app/views/base_editing/form_field/_datetime.html.erb
+- app/views/base_editing/form_field/_datetime_readonly.html.erb
 - app/views/base_editing/form_field/_decimal.html.erb
+- app/views/base_editing/form_field/_decimal_readonly.html.erb
 - app/views/base_editing/form_field/_enum.html.erb
+- app/views/base_editing/form_field/_enum_readonly.html.erb
 - app/views/base_editing/form_field/_has_one_attachment.html.erb
+- app/views/base_editing/form_field/_has_one_attachment_readonly.html.erb
 - app/views/base_editing/form_field/_integer.html.erb
+- app/views/base_editing/form_field/_integer_readonly.html.erb
 - app/views/base_editing/form_field/_textarea.html.erb
+- app/views/base_editing/form_field/_textarea_readonly.html.erb
 - app/views/base_editing/header_field/_base.html.erb
 - app/views/base_editing/index.html.erb
 - app/views/base_editing/new.html.erb