base_editing_bootstrap 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec2173d4ede7597e31056daba4097d643b427878115e0e2898e5e43c09d80d80
-  data.tar.gz: 6e8325daa90163681e969003f1a32612eab37e0bcc40fac78618b5f79cf24d35
+  metadata.gz: e6bf71d45d64bd942a3891d528a28a6ef9b300c31e5764aa27a2c26bd58b64a8
+  data.tar.gz: f2d6638d9c2db49c57f91883a4be6dc7aa5e4232c64b4b98304c3233c61e02bb
 SHA512:
-  metadata.gz: 7ce5b95dd4da6535fbe6e3388d7dbc65b4ec11ea1c304b4141f7c299a2974d3a30b72ce65fb2d000216fb92cc028c24ef4b2c4bdd4819c033bc50696ea8ce801
-  data.tar.gz: d923d2daed952f049ad97b13e723d6c5343639fce7b873d923aee776bfca3f3021e78d45db4c199c524a9a4a8ebd1bd5a6c5ea509c0a14ba5bbd9644b546c0e8
+  metadata.gz: 0b552e2dbb6d71861e4a073ee49a11cdceb3612ced84b4320661583e6c468020c17b8392790b7e87dfd7f0e8b05f7c94e4565b18921a43d0763e68b34da960e1
+  data.tar.gz: 351b8dd26cbaa739e9010d9b24d2721e554b7fdd3f478c5e5bce75717097fcc5ae377b26fadcbfec25b6d5d57b614f5881918a5f6148462fa4deb6a8f32f5fd0

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 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

data/README.md

@@ -145,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
@@ -154,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

@@ -3,6 +3,7 @@ module Utilities
     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
@@ -20,7 +21,16 @@ 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

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/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/lib/base_editing_bootstrap/VERSION

@@ -1 +1 @@
-1.4.0
+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/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.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Marino Bonetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-13 00:00:00.000000000 Z
+date: 2025-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -363,9 +363,11 @@ 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