base_editing_bootstrap 0.1.2

data/app/helpers/utilities/form_helper.rb

@@ -0,0 +1,61 @@
+module Utilities
+  module FormHelper
+    include TemplateHelper
+    ##
+    # Metodo su cui eseguire override per i campi specifici rispetto all'oggetto gestito dal controller
+    # @deprecated Utilizza form_print_field(form, field) senza sovrascriverlo
+    # @param [Forms::Base] form
+    # @param [Symbol] field
+    def editing_form_print_field(form, field)
+      form_print_field(form, field)
+    end
+
+    ##
+    # Metodo per il partial corretto per eseguire il render del campo della form
+    #
+    # @param [Forms::Base] form
+    # @param [Symbol] field
+    def form_print_field(form, field)
+      locals = {form:, field:}
+      case form.object.class.type_for_attribute(field).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"
+      else
+        generic_field = "base"
+      end
+
+      template = find_template_with_fallbacks(
+        form.object,
+        field,
+        "form_field",
+        generic_field
+      )
+      Rails.logger.debug { "#{template}->#{ locals.inspect}" }
+      render template, **locals
+    end
+
+  end
+end
+
+BaseEditingBootstrap.deprecator.deprecate_methods(Utilities::FormHelper, editing_form_print_field: <<-MESSAGE
+
+        Non vogliamo utilizzare più il sistema degli helpers ma direttamente le view,
+        creare nella cartella del relativo modello la struttura di cartelle derivato
+        dal to_partial_path chiamato sull'oggetto del modello che stiamo generando
+        `nome_modello_plurale/nome_modello_singolare/form_field/_nomeField.html.erb`
+        a cui vengono passati i parametri form e field
+
+        <\%\# \locals: (form:, field:) -%\>
+        <\%\= form.check_box(:field_name, class: "form-control") \%\>
+MESSAGE
+)

data/app/helpers/utilities/modal_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Utilities::ModalHelper
+  ##
+  # Metodo speciale per l'inclusione del contenuto nelle modal, forzando il flush in modo da poter utilizzare
+  # più modal contemporaneamente
+  def content_for_modal(*args, &block)
+    opts = args.extract_options!
+    content_for(*args, opts.merge(flush: true), &block)
+  end
+end

data/app/helpers/utilities/page_helper.rb

@@ -0,0 +1,51 @@
+module Utilities::PageHelper
+  # @param [BaseModel] base_class
+  def title_mod_g(base_class)
+    "#{t("edit")} #{base_class.model_name.human}"
+  end
+
+  # @param [BaseModel] base_class
+  def title_new_g(base_class)
+    "#{t("new")} #{base_class.model_name.human}"
+  end
+
+  # Quando e se servirà verrà testato:
+  # - form_field dovrebbe essere il campo del modello che ha associato il has_one_attached
+  # def link_download(form_field)
+  #   link_to rails_blob_path(form_field, disposition: 'attachment'), class: "btn btn-primary", style: "margin:5px;" do
+  #     icon("fas", "eye") + content_tag(:span, " #{I18n.t('download')} #{form_field.filename.to_s}")
+  #   end
+  # end
+  #
+  # def link_delete(form_field, delete_link)
+  #   link_to delete_link, data: {turbo_method: :delete, turbo_confirm: t('are_you_sure')},
+  #           class: "btn btn-danger", style: "margin:5px;" do
+  #     icon("fas", "times") + content_tag(:span, " #{I18n.t('delete')} #{form_field.filename.to_s}")
+  #   end
+  # end
+
+  # @param [TrueClass, FalseClass] valore
+  def boolean_to_icon(valore)
+    if valore
+      icon("check-lg", class: "text-success")
+    else
+      icon("x-lg", class: "text-danger")
+    end
+  end
+
+  # @param [String] path
+  # @param [Hash] options
+  def new_button(path, options = {})
+    options.merge!({class: 'btn btn-success btn-sm'})
+    link_to icon("plus-lg", I18n.t(:new)), path, options
+  end
+
+  # @param [BaseModel] obj instance
+  # @param [Symbol] field
+  def error_messages_for(obj, field)
+    if obj.errors.include?(field)
+      msg = obj.errors.full_messages_for(field).join(",")
+      content_tag(:div, icon("x-circle-fill", msg), class: "invalid-feedback")
+    end
+  end
+end

data/app/helpers/utilities/search_helper.rb

@@ -0,0 +1,110 @@
+module Utilities
+  module SearchHelper
+    include TemplateHelper
+
+    ##
+    # Per aggiungere bottoni:
+    # ES:
+    #    def search_form_buttons(ransack_form, &block)
+    #       super #<-  questo serve per costruiri i bottoni definiti da super
+    #       content_for(:search_form_buttons) do #<- questo serve per aggiungere al content_for un'altro bottone
+    #         link_to "xls", admins_log_alarms_path(params: {q: params.permit(q:{})[:q]}, format: :xlsx), class: "btn btn-info", target: :_blank
+    #       end
+    #     end
+    # @return [ActiveSupport::SafeBuffer]
+    # @param [Ransack::Helpers::FormBuilder] ransack_form
+    def search_form_buttons(ransack_form)
+      content_for(:search_form_buttons) do
+        ransack_form.submit(I18n.translate('.search'), class: "btn btn-primary")
+      end
+    end
+
+    ##
+    # Renderizza la cella della tabella nella pagina della index
+    # @param [BaseModel] obj
+    # @param [Symbol] field
+    # @return [ActiveSupport::SafeBuffer]
+    def render_cell_field(obj, field)
+      generic_field = case field
+                      when :created_at, :updated_at
+                        "timestamps"
+                      else
+                        "base"
+                      end
+      template = find_template_with_fallbacks(
+        obj,
+        field,
+        "cell_field",
+        generic_field
+      )
+      render template, obj:, field:
+    end
+
+    ##
+    # Renderizza header della tabella della index
+    # @param [BaseModel] obj
+    # @param [Symbol] field
+    # @return [ActiveSupport::SafeBuffer]
+    def render_header_cell_field(obj, field)
+      content_tag(:th, obj.human_attribute_name(field))
+    end
+
+    ##
+    # Restituisce il valore che vogliamo mostrare
+    def render_raw_field(obj, field)
+      case field
+      when :created_at, :updated_at
+        l(obj.read_attribute(field), format: :long)
+      else
+        obj[field]
+      end
+    end
+
+    def search_result_buttons(rec)
+      btns = ActiveSupport::SafeBuffer.new
+
+      if policy(rec).edit?
+        btns << link_to(icon("pencil-square"),
+                        edit_custom_polymorphic_path(rec),
+                        class: "btn btn-sm btn-primary me-1")
+      end
+
+      if policy(rec).show?
+        btns << link_to(icon(:eye),
+                        show_custom_polymorphic_path(rec),
+                        class: "btn btn-sm btn-primary me-1")
+      end
+
+      if policy(rec).destroy?
+        btns << link_to(icon(:trash),
+                        destroy_custom_polymorphic_path(rec),
+                        data: {
+                          turbo_method: :delete,
+                          turbo_confirm: t("are_you_sure")
+                        },
+                        class: "btn btn-sm btn-danger me-1")
+      end
+      btns
+    end
+
+    ##
+    # Possibile override dei parametri da passare a ransack nella form
+    def search_form_for_params(ransack_instance)
+      [ransack_instance.ransack_query]
+    end
+  end
+end
+
+BaseEditingBootstrap.deprecator.deprecate_methods(Utilities::SearchHelper, render_raw_field: <<-MESSAGE
+Abbiamo migrato ad un sistema di rendering tramite views, 
+è stato lasciato come memo per una migrazione semplificata
+nel caso si voglia renderizzare un determinato campo in modo differente dal normale dato del DB
+creare nalla path del modello la cartella cell_field e creare al suo interno il file con il nome
+del _campo.html.erb e quindi inserire li il rendering (ES modello User, campo :name):
+app/views/users/user/cell_field/_campo.html.erb
+```
+<%# locals: (obj:,field:)  -%>
+<td><%= obj.name.upcase %></td>
+```
+MESSAGE
+)

data/app/helpers/utilities/template_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Utilities::TemplateHelper
+
+  ##
+  # Ricerca template con fallbacks.
+  # In ordine, cerca di trovare il partial per l'oggetto(tramite il metodo to_partial_path) e il campo specifico.
+  # In successione cerca poi per il partial con nome relativo al tipo di dato
+  # sempre nella cartella dell'oggetto
+  # ed infine nella cerca nella cartella del base editing
+  # @param [Object#to_partial_path] obj
+  # @param [Symbol] field
+  # @param [String] base_path
+  # @param [String] generic_field
+  def find_template_with_fallbacks(obj, field, base_path, generic_field)
+    obj_base_path = "#{obj.to_partial_path}/#{base_path}"
+    return "#{obj_base_path}/#{field}" if lookup_context.exists?(field, [obj_base_path], true)
+    return "#{obj_base_path}/#{generic_field}" if lookup_context.exists?(generic_field, [obj_base_path], true)
+    "base_editing/#{base_path}/#{generic_field}"
+  end
+
+end

data/app/policies/base_model_policy.rb

@@ -0,0 +1,42 @@
+class BaseModelPolicy < ApplicationPolicy
+  def index? = general_rule
+
+  def create? = general_rule
+
+  def update? = general_rule
+
+  def destroy? = general_rule
+
+  def show? = false
+
+  # Questo metodo può essere anche scritto specifico per azione:
+  # - permitted_attributes_for_create
+  # - permitted_attributes_for_update
+  def permitted_attributes = []
+
+  def editable_attributes = []
+
+  def permitted_attributes_for_ransack
+    record.class.column_names + record.class._ransackers.keys
+  end
+
+  def permitted_associations_for_ransack
+    []
+  end
+
+  def search_fields = []
+
+  def search_result_fields = []
+
+  class Scope < Scope
+    def resolve
+      scope.all
+    end
+  end
+
+  private
+
+  def general_rule
+    true
+  end
+end

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

@@ -0,0 +1,3 @@
+<h2>
+  <%= title_mod_g(base_class) %>
+</h2>

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

@@ -0,0 +1,15 @@
+<%
+  # LOCALS disponibili per rendering del flag dell'unità di misura
+  # object: classe active_model che mi serve per cercare la traduzione dell'unità
+  # field: campo che dobbiamo tradurre
+%>
+<%# locals: (object:,field:) -%>
+<%
+  translation = object.class.human_attribute_name("#{field}/unit", default: "")
+  unless translation.blank?
+%>
+  <span class="input-group-text"><%= translation %></span>
+<%
+  end
+%>
+

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

@@ -0,0 +1,17 @@
+<div class="card" id="card_id">
+  <div class="card-header">
+    <%= form_for @object, builder: form_builder do |form| %>
+
+      <div class="card-body">
+        <%= render partial: "form_field_header", local: {form:} %>
+        <%= render collection: form_attributes(form.object),
+                   partial: "form_field", locals: {form:} %>
+      </div>
+
+      <div class="card-footer">
+        <%= render partial: "form_footer", locals: {form: form} %>
+      </div>
+
+    <% end %>
+  </div>
+</div>

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

@@ -0,0 +1,6 @@
+<%= form.label(form_field, class: "form-label") %>
+<div class="input-group mb-2 <%= form.object.validated? ? "has-validation" : "" %>">
+  <%= render partial: "editing_form_measure_unit", locals: {object: form.object, field: form_field} %>
+  <%= form_print_field(form, form_field) %>
+  <%= error_messages_for(form.object, form_field) %>
+</div>

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

@@ -0,0 +1 @@
+<%# header degli elementi della form, nel caso dovessimo fare una testata %>

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

@@ -0,0 +1,3 @@
+<div class="row justify-content-end">
+  <%= form.submit %>
+</div>  

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

@@ -0,0 +1,17 @@
+<div class="card">
+  <% if @search_instance.search_fields.count > 0 %>
+    <div class="card-header">
+      <%= render partial: "search" %>
+    </div>
+  <% end %>
+
+  <% if @search_instance.results.count > 0 %>
+    <div class="card-body table-responsive p-0">
+      <%= render partial: "search_result" %>
+    </div>
+
+    <div class="card-footer clearfix">
+      <%= render partial: "search_footer" %>
+    </div>
+  <% end %>
+</div>

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

@@ -0,0 +1 @@
+<%= new_button new_custom_polymorphic_path(base_class) if policy(base_class.new).create? %>

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

@@ -0,0 +1,10 @@
+<div>
+  <div class="row align-items-center">
+    <div class="col-md-8 col-xs-8">
+      <h2><%= base_class.model_name.human(count: 2) %></h2>
+    </div>
+    <div class="col-md-4 col-xs-4 text-end">
+      <%= render 'index_main_buttons' %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,3 @@
+<h2>
+  <%= title_new_g(base_class) %>
+</h2>

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

@@ -0,0 +1,17 @@
+<%= search_form_for *search_form_for_params(@search_instance) do |f| %>
+
+  <div class="row g-2">
+    <%= render @search_instance.search_fields, ransack_form_builder: f %>
+  </div>
+
+  <div class="row mt-4">
+    <div class="col-1">
+      <div class="btn-group mr-1">
+        <% search_form_buttons(f) %>
+        <%= content_for :search_form_buttons %>
+      </div>
+    </div>
+  </div>
+<% end %>
+
+

data/app/views/base_editing/_search_field.erb

@@ -0,0 +1,4 @@
+<div class="form-group col-xs-6 col-sm-4 col-md-3">
+  <%= ransack_form_builder.label(search_field.name) %>
+  <%= ransack_form_builder.search_field(search_field.name, class: "form-control form-control-sm") %>
+</div>

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

@@ -0,0 +1 @@
+<%= paginate @search_instance.results %>

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

@@ -0,0 +1,13 @@
+<table class="table table-head-fixed text-nowrap <%= dom_class(@search_instance.model_klass,:search_results) %>">
+  <thead>
+  <tr>
+    <% @search_instance.search_result_fields.each do |srf| %>
+      <%= render_header_cell_field(@search_instance.model_klass, srf) %>
+    <% end %>
+    <th class="action_col"></th>
+  </tr>
+  </thead>
+  <tbody>
+  <%= render partial: 'search_result_row', collection: @search_instance.results, as: :obj %>
+  </tbody>
+</table>

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

@@ -0,0 +1,8 @@
+<tr>
+  <% @search_instance.search_result_fields.each do |srf| %>
+    <%= render_cell_field(obj, srf) %>
+  <% end %>
+  <td>
+    <%= search_result_buttons(obj) %>
+  </td>
+</tr>

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

@@ -0,0 +1,2 @@
+<div class="row" id="tab_row">
+</div>

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

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

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

@@ -0,0 +1,3 @@
+<%# Renderizza il campo nella tabella della pagina dei risultati %>
+<%# locals: (obj:,field:)  -%>
+<td><%= l(obj.read_attribute(field), format: :long) %></td>

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

@@ -0,0 +1,3 @@
+<%= render partial: "navbar" %>
+<%= render 'edit_page_title_header' %>
+<%= render partial: "form" %>

data/app/views/base_editing/form_field/_base.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_field(field) %>

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,5 @@
+<%= render partial: "navbar" %>
+
+<%= render partial: "index_title_header" %>
+
+<%= render 'index_body' %>

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

@@ -0,0 +1,3 @@
+<%= render partial: "navbar" %>
+<%= render 'new_page_title_header' %>
+<%= render 'form' %>

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

@@ -0,0 +1 @@
+<h1>Show</h1>

data/app/views/kaminari/_first_page.html.erb

@@ -0,0 +1,3 @@
+<li class="page-item">
+  <%= link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, remote: remote, class: 'page-link' %>
+</li>

data/app/views/kaminari/_gap.html.erb

@@ -0,0 +1,3 @@
+<li class='page-item disabled'>
+  <%= link_to raw(t 'views.pagination.truncate'), '#', class: 'page-link' %>
+</li>

data/app/views/kaminari/_last_page.html.erb

@@ -0,0 +1,3 @@
+<li class="page-item">
+  <%= link_to_unless current_page.last?, raw(t 'views.pagination.last'), url, remote: remote, class: 'page-link' %>
+</li>

data/app/views/kaminari/_next_page.html.erb

@@ -0,0 +1,3 @@
+<li class="page-item">
+  <%= link_to_unless current_page.last?, raw(t 'views.pagination.next'), url, rel: 'next', remote: remote, class: 'page-link' %>
+</li>

data/app/views/kaminari/_page.html.erb

@@ -0,0 +1,9 @@
+<% if page.current? %>
+  <li class="page-item active">
+    <%= content_tag :a, page, data: {remote: remote}, rel: page.rel, class: 'page-link' %>
+  </li>
+<% else %>
+  <li class="page-item">
+    <%= link_to page, url, remote: remote, rel: page.rel, class: 'page-link' %>
+  </li>
+<% end %>

data/app/views/kaminari/_paginator.html.erb

@@ -0,0 +1,17 @@
+<%= paginator.render do %>
+  <nav>
+    <ul class="pagination">
+      <%= first_page_tag unless current_page.first? %>
+      <%= prev_page_tag unless current_page.first? %>
+      <% each_page do |page| %>
+        <% if page.left_outer? || page.right_outer? || page.inside_window? %>
+          <%= page_tag page %>
+        <% elsif !page.was_truncated? -%>
+          <%= gap_tag %>
+        <% end %>
+      <% end %>
+      <%= next_page_tag unless current_page.last? %>
+      <%= last_page_tag unless current_page.last? %>
+    </ul>
+  </nav>
+<% end %>

data/app/views/kaminari/_prev_page.html.erb

@@ -0,0 +1,3 @@
+<li class="page-item">
+  <%= link_to_unless current_page.first?, raw(t 'views.pagination.previous'), url, rel: 'prev', remote: remote, class: 'page-link' %>
+</li>

data/base_editing_bootstrap.gemspec

@@ -0,0 +1,39 @@
+require_relative "lib/base_editing_bootstrap/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "base_editing_bootstrap"
+  spec.version = BaseEditingBootstrap::VERSION
+  spec.authors = ["Marino Bonetti"]
+  spec.email = ["marinobonetti@gmail.com"]
+  spec.summary = "BaseEditing: funzionalità di base per cms rails"
+  spec.description = "Raccolta di utility per semplificare costruzione cms in rails"
+  spec.homepage = "https://github.com/oniram88/BaseEditingBootstrap"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/oniram88/BaseEditingBootstrap"
+  spec.metadata["changelog_uri"] = "https://github.com/oniram88/BaseEditingBootstrap/CHANGELOG"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .gitlab-ci.yml appveyor Gemfile])
+    end
+  end
+  spec.files += Dir['spec/support/external_shared/*.rb']
+
+  spec.add_dependency "rails", ">= 7.0"
+  spec.add_dependency "pundit", ">= 2.3.1"
+
+  # Search
+  spec.add_dependency 'ransack', '>= 4.0.0'
+  # Pagination
+  spec.add_dependency 'kaminari', '>= 1.2.2'
+
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "factory_bot_rails"
+
+end

data/cog.toml

@@ -0,0 +1,26 @@
+from_latest_tag = false
+ignore_merge_commits = false
+disable_changelog = false
+generate_mono_repository_global_tag = true
+branch_whitelist = []
+skip_ci = "[skip ci]"
+skip_untracked = false
+pre_bump_hooks = []
+post_bump_hooks = [
+    "git push",
+    "git push origin {{version}}"
+]
+pre_package_bump_hooks = []
+post_package_bump_hooks = []
+
+[git_hooks]
+
+[commit_types]
+
+[changelog]
+path = "CHANGELOG.md"
+authors = []
+
+[bump_profiles]
+
+[packages]

data/config/initializers/base_field_error_proc.rb

@@ -0,0 +1 @@
+ActionView::Base.field_error_proc = Proc.new { |html_tag, instance| html_tag }