base_editing_bootstrap 1.3.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e340e913487e9367deddd3f112c3a379af1ae132da18d27f19b44b6c4f133f6
-  data.tar.gz: 35c0c82b8cc25665ddbeced4615baec2076ca3c6dc33651cc32d73b622d0b761
+  metadata.gz: e6bf71d45d64bd942a3891d528a28a6ef9b300c31e5764aa27a2c26bd58b64a8
+  data.tar.gz: f2d6638d9c2db49c57f91883a4be6dc7aa5e4232c64b4b98304c3233c61e02bb
 SHA512:
-  metadata.gz: fca88f75c5a9e90adf8fc20a6cb46165745a90545649542f984b70b3dfb5b9310fbfaf11d9fc58debbde83022c46d8ab376b475ea64df88ac608f981e17fd567
-  data.tar.gz: f7f4fe4e1755e174b980915ecd685754f68a9e5ea80cc258aa31c50325c16c709448992e2a3b28a64808d09ddbbff2d0a673e6446f9470b09409614f751921e2
+  metadata.gz: 0b552e2dbb6d71861e4a073ee49a11cdceb3612ced84b4320661583e6c468020c17b8392790b7e87dfd7f0e8b05f7c94e4565b18921a43d0763e68b34da960e1
+  data.tar.gz: 351b8dd26cbaa739e9010d9b24d2721e554b7fdd3f478c5e5bce75717097fcc5ae377b26fadcbfec25b6d5d57b614f5881918a5f6148462fa4deb6a8f32f5fd0

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
 
 - - -
+## 1.5.0 - 2025-01-16
+#### Documentation
+- Update documentation - (3a29e34) - Marino Bonetti
+#### Features
+- Render enum in index - (c520cd1) - Marino Bonetti
+- Belongs_to Form fields - (6572b9f) - Marino Bonetti
+#### Refactoring
+- Estrapolazione policy in metodo - (711746b) - Marino Bonetti
+
+- - -
+
+## 1.4.0 - 2025-01-13
+#### Bug Fixes
+- Correct generator for values - (a83f07a) - Marino Bonetti
+#### Features
+- Has one attached automatic file_field - (fd32678) - Marino Bonetti
+
+- - -
+
 ## 1.3.2 - 2025-01-10
 #### Bug Fixes
 - Fields in form inside layout - (a2e1d42) - Marino Bonetti

data/README.md

@@ -25,6 +25,8 @@ Then run installer:
 $ bundle exec rails g base_editing_bootstrap:install
 ```
 
+**Si presume quindi che ActiveStorage sia correttamente installato, completo del javascript per il direct upload**
+
 ### Generators
 Then Install dependency (if you run base_editing_bootstrap:install you are good to go):
 ```bash
@@ -143,7 +145,20 @@ Utilizzo per modello base, in questo esempio prendiamo come modello Post come es
   **Cell Field**:
   - created_at => timestamps.html.erb
   - updated_at => timestamps.html.erb
+  - Enum              => _enum.html.erb
+    Per gli enum, le traduzioni dei labels di ogni valore provengono da i18n
+    attraverso l'helper: `Utilities::EnumHelper#enum_translation` con variant `:cell_field`
+    il quale sfrutta human_attribute_name del modello con 'attributo.enum_value',
+    quindi ad esempio per un modello `Post` con enum `categoria` e un enum `importante`, la ricerca nelle traduzioni
+    saranno così composte:
+    - it.activerecord.attributes.post/categoria.importante_cell_field
+    - it.activerecord.attributes.categoria.importante_cell_field  
+    - it.attributes.importante_cell_field
+    - it.activerecord.attributes.post/categoria.importante
+    - it.activerecord.attributes.categoria.importante
+    - it.attributes.importante => nil
   - default    => base.html.erb
+  
   **Form Field**
   - Integer           => _integer.html.erb
   - Float             => _decimal.html.erb
@@ -152,9 +167,23 @@ Utilizzo per modello base, in questo esempio prendiamo come modello Post come es
   - Date              => _date.html.erb
   - Boolean           => _boolean.html.erb
   - Enum              => _enum.html.erb
-    Per gli enum, le traduzioni dei labels di ogni valore provvengono da i18n
-    attraverso l'helper: `Utilities::EnumHelper#enum_translation`
-    il quale utilizza il nome dell'attributo con 
+    Per gli enum, le traduzioni dei labels di ogni valore provengono da i18n
+    attraverso l'helper: `Utilities::EnumHelper#enum_translation`" con variante `:form_field`
+    il quale sfrutta human_attribute_name del modello con 'attributo.enum_value', 
+    quindi ad esempio per un modello `Post` con enum `categoria` e un enum `importante`, la ricerca nelle traduzioni
+    saranno così composte: 
+    - it.activerecord.attributes.post/categoria.importante_form_field
+    - it.activerecord.attributes.categoria.importante_form_field
+    - it.attributes.importante_form_field
+    - it.activerecord.attributes.post/categoria.importante
+    - it.activerecord.attributes.categoria.importante
+    - it.attributes.importante => nil
+  - belongs_to      => _belongs_to_select.html.erb 
+    Come si può leggere dal partial, il modello che viene utilizzato come base dati per la collection deve
+    avere come metodo `option_label` che deve ritornare la label da utilizzare nelle options.
+    Di default questo metodo utilizza il semplice #to_s
+    Ha anche un metodo per il valore da utilizzare come chiave, di default viene dedotto dalla reflection
+    come anche il nome della classe da utilizzare come sorgente dei dati della collection
   - Default/String    => _base.html.erb
   
   In futuro si prevede di aggiungere automatismi per renderizzare senza 

data/app/helpers/utilities/form_helper.rb

@@ -2,6 +2,8 @@ module Utilities
   module FormHelper
     include TemplateHelper
     include EnumHelper
+    include IconHelper
+    include Pundit::Authorization
     ##
     # Metodo su cui eseguire override per i campi specifici rispetto all'oggetto gestito dal controller
     # @deprecated Utilizza form_print_field(form, field) senza sovrascriverlo
@@ -19,13 +21,28 @@ module Utilities
     def form_print_field(form, field)
       locals = {form:, field:}
       if 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)
+        # 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
       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
+
         case type
         when :datetime
           generic_field = "datetime"
@@ -41,6 +58,8 @@ module Utilities
           generic_field = "integer"
         when :boolean
           generic_field = "boolean"
+        when :has_one_attachment
+          generic_field = "has_one_attachment"
         else
           generic_field = "base"
         end

data/app/helpers/utilities/search_helper.rb

@@ -3,6 +3,7 @@ module Utilities
     include TemplateHelper
     include PageHelper
     include IconHelper
+    include EnumHelper
 
     ##
     # Per aggiungere bottoni:
@@ -71,10 +72,16 @@ module Utilities
                       when :created_at, :updated_at
                         "timestamps"
                       else
-                        type = klazz.type_for_attribute(field).type
+                        if klazz.respond_to?(:defined_enums) && klazz.defined_enums.key?(field.to_s)
+                          type = :enum
+                        else
+                          type = klazz.type_for_attribute(field).type
+                        end
                         case type
                         when :boolean
                           "boolean"
+                        when :enum
+                          "enum"
                         else
                           "base"
                         end

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

@@ -30,3 +30,5 @@
   <%= error_messages_for(form.object, form_field) %>
 <% end %>
 <%= render partial: "editing_form_help_text", locals: {object: form.object, field: form_field} %>
+<%= content_for :form_field_ending %>
+<% content_for :form_field_ending, "", flush: true #RESET altrimenti ce lo troviamo nel successivo campo %>

data/app/views/base_editing/cell_field/_enum.html.erb

@@ -0,0 +1,3 @@
+<%# Renderizza il campo nella tabella della pagina dei risultati %>
+<%# locals: (obj:,field:)  -%>
+<td><%= enum_translation(obj.class, field, obj.send(field), :cell_field)  %></td>

data/app/views/base_editing/form_field/_belongs_to_select.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
+    ) %>

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

@@ -1,2 +1,2 @@
 <%# locals: (form:, field:) -%>
-<%= form.select(field, enum_collection(form.object.class, field)) %>
+<%= form.select(field, enum_collection(form.object.class, field, :form_field)) %>

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

@@ -0,0 +1,31 @@
+<%# locals: (form:, field:) -%>
+<%
+  is_attached = form.object.send(field).attached?
+  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}")
+
+  javascript_clear_event = <<~JAVASCRIPT
+                            try{document.getElementById('#{hidden_field_id}').value = ''}catch{};
+                            try{document.getElementById('#{preview_image_id}').remove()}catch{};
+                            try{document.getElementById('#{filename_id}').remove()}catch{};
+                            return false
+                            JAVASCRIPT
+
+%>
+<%= 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 %>
+
+<% 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 %>
+    <% end %>
+  <% end %>
+<% end %>

data/base_editing_bootstrap.gemspec

@@ -43,7 +43,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'faker', '~> 3.3'
   spec.add_development_dependency "puma", '~> 6.4'
   spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "sprockets-rails", '~> 3.4'
+  spec.add_development_dependency "propshaft", '~> 1.1.0'
+  spec.add_development_dependency 'importmap-rails', '~> 2.1.0'
+  spec.add_development_dependency "image_processing", "~> 1.2"
   spec.add_development_dependency 'rails-i18n'
   spec.add_development_dependency "i18n-debug", '~> 1.2'
   spec.add_development_dependency "cssbundling-rails", '~> 1.4'

data/lib/base_editing_bootstrap/VERSION

@@ -1 +1 @@
-1.3.2
+1.5.0

data/lib/base_editing_bootstrap/base_model.rb

@@ -8,6 +8,14 @@ module BaseEditingBootstrap
       include IsValidated
       include ActionTranslation
       delegate :ransackable_attributes, :ransackable_associations, to: :@class
+
+
+      ##
+      # Label da utilizzare nelle option per quando si genera le select dei belongs to
+      # @return [String,NilClass]
+      def option_label
+        to_s
+      end
     end
 
     class_methods do

data/lib/base_editing_bootstrap/searches/base.rb

@@ -37,21 +37,27 @@ module BaseEditingBootstrap::Searches
     end
 
     def search_fields
-      Pundit.policy(@user, @model_klass).search_fields.collect { |f| Field.new(self, f) }
+      policy.search_fields.collect { |f| Field.new(self, f) }
     end
 
     def search_result_fields
-      Pundit.policy(@user, @model_klass).search_result_fields
+      policy.search_result_fields
     end
 
     ##
     # Ritorna se il campo deve essere ordinabile o meno
     def sortable?(field)
-      Pundit.policy(@user, @model_klass).sortable_search_result_fields.include?(field)
+      policy.sortable_search_result_fields.include?(field)
     end
 
     def persisted?
       false
     end
+
+    ##
+    # @return [ApplicationPolicy]
+    def policy
+      Pundit.policy(@user, @model_klass)
+    end
   end
 end

data/lib/generators/base_editing_bootstrap/scaffold/templates/policy.rb.tt

@@ -1,8 +1,8 @@
 class <%= class_name %>Policy < BaseModelPolicy
 
-  def editable_attributes = %w[<%= attributes_names.join(" ") %>]
-  def permitted_attributes = %w[<%= attributes_names.join(" ") %>]
-  def search_result_fields = %w[<%= attributes_names.join(" ") %>]
+  def editable_attributes = %i[<%= attributes_names.join(" ") %>]
+  def permitted_attributes = %i[<%= attributes_names.join(" ") %>]
+  def search_result_fields = %i[<%= attributes_names.join(" ") %>]
 <%- if @search_attrs.any? -%>
   def search_fields
     %i[<%= @search_attrs.join(" ") %>]
@@ -11,7 +11,7 @@ class <%= class_name %>Policy < BaseModelPolicy
 <%- if @permitted_attributes.any? -%>
   # TODO check if correct with search_fields
   def permitted_attributes_for_ransack
-    %w[<%= @permitted_attributes.join(" ") %>]
+    %i[<%= @permitted_attributes.join(" ") %>]
   end
 <%- end -%>
 end

data/spec/support/external_shared/base_model.rb

@@ -1,4 +1,4 @@
-RSpec.shared_examples "a base model" do |ransack_permitted_attributes: [], ransack_permitted_associations: []|
+RSpec.shared_examples "a base model" do |ransack_permitted_attributes: [], ransack_permitted_associations: [], option_label_method: :to_s|
 
   it_behaves_like "a validated? object"
 
@@ -6,6 +6,14 @@ RSpec.shared_examples "a base model" do |ransack_permitted_attributes: [], ransa
     expect(described_class).to respond_to(:human_action_message)
   end
 
+  it "have method for belongs_to options" do
+    instance = described_class.new
+    expect(instance).to respond_to(:option_label)
+
+    expect(instance).to receive(option_label_method).and_call_original
+    instance.option_label
+  end
+
   ##
   # Oggetto solitamente di classe User che identifichi l'utente a cui eseguire il check dei permessi
   let(:auth_object) { :auth_object }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base_editing_bootstrap
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Marino Bonetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-10 00:00:00.000000000 Z
+date: 2025-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -175,19 +175,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sprockets-rails
+  name: propshaft
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: image_processing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rails-i18n
   requirement: !ruby/object:Gem::Requirement
@@ -335,14 +363,17 @@ files:
 - app/views/base_editing/_tabs.html.erb
 - app/views/base_editing/cell_field/_base.html.erb
 - app/views/base_editing/cell_field/_boolean.html.erb
+- app/views/base_editing/cell_field/_enum.html.erb
 - app/views/base_editing/cell_field/_timestamps.html.erb
 - app/views/base_editing/edit.html.erb
 - app/views/base_editing/form_field/_base.html.erb
+- app/views/base_editing/form_field/_belongs_to_select.html.erb
 - app/views/base_editing/form_field/_boolean.html.erb
 - app/views/base_editing/form_field/_date.html.erb
 - app/views/base_editing/form_field/_datetime.html.erb
 - app/views/base_editing/form_field/_decimal.html.erb
 - app/views/base_editing/form_field/_enum.html.erb
+- app/views/base_editing/form_field/_has_one_attachment.html.erb
 - app/views/base_editing/form_field/_integer.html.erb
 - app/views/base_editing/header_field/_base.html.erb
 - app/views/base_editing/index.html.erb