base_editing_bootstrap 0.16.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e764be908fc80fc7426404c064b407cd2b47239c30d81cb812f30d26e013e0c6
-  data.tar.gz: ce54c97213e70582b4493632cfd9652e2a33c8774d91106854381af17119adda
+  metadata.gz: a1e80d543ff93c2a170069bb78b4f78488819804458f1e5a36c87fd7d0975476
+  data.tar.gz: b65c0f800fe834ac24794e292c8e09c7e2910e2f5e1b0ba215aadd69ee7ff168
 SHA512:
-  metadata.gz: ac4e714e64560dbaa5b5851e67ff3ac439cd9ec5aa2d21b8a5fa246e0850da6f45f641b892576343604ca01bfb3dc984e7afab63470f1818e53479f20e1c5aff
-  data.tar.gz: ae23fcf542349cd98c4d4a1c9f6435261a54fa39c44fdf981e30f179319e04f1c6b0cdba4485acff348fa6fc8d0e0241b30e28d5f8f42f08a18b6fddfc73346a
+  metadata.gz: 776c45e8aab54bb0208bf9b0af8728a2467b9943dec257f6e55527be03c53cfd7996e7f370a63ef29d769fe318a4937435bb7759eabf130c08f070d88c8b0eb8
+  data.tar.gz: 749586e54204dab5ad28c227d03fab252a79483e63a7f6cf07cb6ce84aca05aded2408f6092578ce3f39fca61ac4708b4c4692a3fb67c3722a1ca350dada2392

data/CHANGELOG.md

@@ -2,6 +2,32 @@
 All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
 
 - - -
+## 1.1.0 - 2025-01-03
+#### Continuous Integration
+- Add ruby 3.4 - (5658bb0) - Marino Bonetti
+#### Features
+- Boolean switch render right side label - (d448ef7) - Marino Bonetti
+- Add a new layout container for form_field - (77dec9f) - Marino Bonetti
+#### Tests
+- Add help text example for enabled - (efd4aff) - Marino Bonetti
+
+- - -
+
+## 1.0.0 - 2024-11-26
+#### Bug Fixes
+- Remove fixed versions - (f8dc4b8) - Marino Bonetti
+- Utilizziamo metodo di kaminari per totale pagine - (4451592) - Marino Bonetti
+#### Documentation
+- Add debug info for ransack - (e1355ef) - Marino Bonetti
+#### Features
+- Print header search results - (20fc7be) - Marino Bonetti
+#### Miscellaneous Chores
+- Rails 8.0 stable in test case - (87aff45) - Marino Bonetti
+#### Tests
+- Debugging - (663d5e9) - Marino Bonetti
+
+- - -
+
 ## 0.16.1 - 2024-11-22
 #### Bug Fixes
 - Correct case when attribute to print is virtual - (b86e478) - Marino Bonetti

data/README.md

@@ -133,6 +133,10 @@ Utilizzo per modello base, in questo esempio prendiamo come modello Post come es
   ```shell
   rails g base_editing_bootstrap:cell_override ModelName field1 field2:type
   ```
+- [OPTIONAL] e per fare il rendering dell'header della tabella della index
+  ```shell
+  rails g base_editing_bootstrap:header_override ModelName field1 field2:type
+  ```  
 - [OPTIONAL] Base overrides:  
   E' possibile anche fare un override generico dei campi, sono previsti questi tipi di partial
   legati al tipo di dati:  

data/app/helpers/utilities/search_helper.rb

@@ -30,35 +30,18 @@ module Utilities
     # @param [Symbol] field
     # @return [ActiveSupport::SafeBuffer]
     def render_cell_field(obj, field)
-      generic_field = case field
-                      when :created_at, :updated_at
-                        "timestamps"
-                      else
-                        type = obj.class.type_for_attribute(field).type
-                        case type
-                        when :boolean
-                          "boolean"
-                        else
-                          "base"
-                        end
-
-                      end
-      template = find_template_with_fallbacks(
-        obj,
-        field,
-        "cell_field",
-        generic_field
-      )
+      template = template_for_column(obj.class, field, "cell_field")
       render template, obj:, field:
     end
 
     ##
     # Renderizza header della tabella della index
-    # @param [BaseModel] obj
+    # @param [BaseEditingBootstrap::Searches::Base] search_instance
     # @param [Symbol] field
     # @return [ActiveSupport::SafeBuffer]
-    def render_header_cell_field(obj, field)
-      content_tag(:th, obj.human_attribute_name(field))
+    def render_header_cell_field(search_instance, field)
+      template = template_for_column(search_instance.model_klass, field, "header_field")
+      render template, obj: search_instance.model_klass, field:, search_instance: search_instance
     end
 
     ##
@@ -77,6 +60,33 @@ module Utilities
     def search_form_for_params(ransack_instance)
       [ransack_instance.ransack_query]
     end
+
+    private
+
+    ##
+    # Restituisce il template corretto per la tripletta, andando a ricercare il tipo di campo attraverso le informazioni
+    # che type_for_attribute può restituirci
+    def template_for_column(klazz, field, partial_type)
+      generic_field = case field
+                      when :created_at, :updated_at
+                        "timestamps"
+                      else
+                        type = klazz.type_for_attribute(field).type
+                        case type
+                        when :boolean
+                          "boolean"
+                        else
+                          "base"
+                        end
+
+                      end
+      find_template_with_fallbacks(
+        klazz,
+        field,
+        partial_type,
+        generic_field
+      )
+    end
   end
 end
 

data/app/helpers/utilities/template_helper.rb

@@ -13,10 +13,14 @@ module Utilities::TemplateHelper
   # @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}"
+    # nei casi in cui passiamo la classe e non l'oggetto, dobbiamo utilizzare un metodo interno a rails per
+    # avere la partial_path
+    partial_path = (obj.respond_to? :to_partial_path) ? obj.to_partial_path : obj._to_partial_path
+    obj_base_path = "#{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}"
+    return "base_editing/#{base_path}/#{generic_field}" if lookup_context.find_all("base_editing/#{base_path}/_#{generic_field}").any?
+    "base_editing/#{base_path}/base"
   end
 
 end

data/app/policies/base_model_policy.rb

@@ -28,6 +28,12 @@ class BaseModelPolicy < ApplicationPolicy
 
   def search_result_fields = []
 
+  ##
+  # List of attributes in index to make it sortable
+  def sortable_search_result_fields
+    search_result_fields
+  end
+
   class Scope < Scope
     def resolve
       scope.all

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

@@ -5,6 +5,7 @@
       <div class="card-body">
         <%= render partial: "form_field_header", local: {form:} %>
         <%= render collection: form_attributes(form.object),
+                   layout: "form_field_container",
                    partial: "form_field", locals: {form:} %>
       </div>
 

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

@@ -5,20 +5,25 @@
   # - form_field -> Array[String]
 %>
 <%# locals: (form:, form_field:) -%>
-<%= form.label(form_field, class: ["form-label", "form-#{form_field}-label"]) %>
-
 <%
-  button_group_classes = ["mb-2"]
+  button_group_classes = ["mb-1"]
 
   content = form_print_field(form, form_field)
   unless content.match "checkbox"
     button_group_classes << "input-group"
   end
-
   button_group_classes << (form.object.validated? ? "has-validation" : "")
   button_group_classes << "form-#{form_field}-input-group"
 
+  # Non renderizziamo il contenuto del label in questa vista se siamo nello switch
+  if content.match "form-switch"
+    label_content = nil
+  else
+    label_content = form.label(form_field, class: ["form-label", "form-#{form_field}-label"])
+  end
+
 %>
+<%= label_content %>
 <%= content_tag :div, class: button_group_classes.join(" ") do %>
   <%= render partial: "editing_form_measure_unit", locals: {object: form.object, field: form_field} %>
   <%= content %>

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

@@ -0,0 +1,3 @@
+<div class="mb-3">
+  <%= yield %>
+</div>

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

@@ -5,7 +5,7 @@
     </div>
   <% end %>
 
-  <% if @search_instance.results.count > 0 %>
+  <% if @search_instance.results.total_pages > 0 %>
     <div class="card-body table-responsive p-0">
       <%= render partial: "search_result" %>
     </div>

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

@@ -2,7 +2,7 @@
   <thead>
   <tr>
     <% @search_instance.search_result_fields.each do |srf| %>
-      <%= render_header_cell_field(@search_instance.model_klass, srf) %>
+      <%= render_header_cell_field(@search_instance, srf) %>
     <% end %>
     <th class="action_col"></th>
   </tr>

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

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

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

@@ -0,0 +1,9 @@
+<%# Renderizza il campo header della tabella della pagina dei risultati %>
+<%# locals: (obj:,field:,search_instance:)  -%>
+<th scope="col">
+  <% if search_instance.sortable?(field) %>
+    <%= sort_link(search_instance.ransack_query, field, obj.human_attribute_name(field)) %>
+  <% else %>
+    <%= obj.human_attribute_name(field) %>
+  <% end %>
+</th>

data/base_editing_bootstrap.gemspec

@@ -42,9 +42,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "factory_bot_rails", '~> 6.4'
   spec.add_development_dependency 'faker', '~> 3.3'
   spec.add_development_dependency "puma", '~> 6.4'
-  spec.add_development_dependency "sqlite3", '>= 1.7.x'
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "sprockets-rails", '~> 3.4'
-  spec.add_development_dependency 'rails-i18n', '~> 7.0' # For 7.0.0
+  spec.add_development_dependency 'rails-i18n'
   spec.add_development_dependency "i18n-debug", '~> 1.2'
   spec.add_development_dependency "cssbundling-rails", '~> 1.4'
   spec.add_development_dependency "rspec-parameterized", "~> 1.0", ">= 1.0.0" # https://github.com/tomykaira/rspec-parameterized

data/lib/base_editing_bootstrap/VERSION

@@ -1 +1 @@
-0.16.1
+1.1.0

data/lib/base_editing_bootstrap/forms/base.rb

@@ -64,7 +64,7 @@ module BaseEditingBootstrap::Forms
     end
 
     def switch_box(method, options = {}, checked_value = "1", unchecked_value = "0")
-      options[:class] = (["form-switch"] + (options[:class] || "").split(" ")).join(" ")
+      options[:class] = (["form-check form-switch"] + (options[:class] || "").split(" ")).join(" ")
       self.check_box(method, options, checked_value, unchecked_value)
     end
 

data/lib/base_editing_bootstrap/searches/base.rb

@@ -24,9 +24,11 @@ module BaseEditingBootstrap::Searches
     # Risultato della ricerca, fa da pipeline verso ransack
     # Impostando il sort nel caso in cui non sia già stato impostato da ransack
     def results
-      ransack_query.tap { |r|
-        r.sorts = @sorts if r.sorts.empty?
-      }.result(distinct: true).page(params[:page])
+      ransack_query
+        .tap { |r| r.sorts = @sorts if r.sorts.empty? }
+        .result(distinct: true)
+        .tap { |q| Rails.logger.debug { "[Ransack] params:#{params} - sql: #{q.to_sql}" } }
+        .page(params[:page])
     end
 
     def ransack_query
@@ -42,6 +44,12 @@ module BaseEditingBootstrap::Searches
       Pundit.policy(@user, @model_klass).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)
+    end
+
     def persisted?
       false
     end

data/lib/generators/base_editing_bootstrap/header_override/header_override_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module BaseEditingBootstrap
+  module Generators
+    class HeaderOverrideGenerator < ::Rails::Generators::Base
+      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"
+
+      TYPES = %i[base]
+
+      desc <<-DESCRIPTION.strip_heredoc
+             Description:   
+                Copy partial files for a defined fields, 
+                the possible types are #{TYPES}
+                Default to base
+      DESCRIPTION
+
+      def copy_form_partials
+        if attributes.empty?
+          say "Need one field"
+        else
+          singular_name = name.underscore.downcase.singularize
+          plural_name = singular_name.pluralize
+          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 "header_field/_#{type}.html.erb", File.join("app/views", plural_name, singular_name, 'header_field', "_#{attr_name}.html.erb")
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/support/external_shared/pundit.rb

@@ -17,6 +17,26 @@ RSpec.shared_examples "a standard base model policy" do |factory, check_default_
   let(:user) { create(:user) }
   let(:instance) { described_class.new(user, build(factory)) }
 
+  describe "response to all necessary methods" do
+    where(:method) do
+      [
+        [:sortable_search_result_fields],
+        [:search_result_fields],
+        [:search_fields],
+        [:permitted_associations_for_ransack],
+        [:permitted_attributes_for_ransack],
+        [:editable_attributes],
+        [:permitted_attributes],
+      ]
+    end
+
+    with_them do
+      it "should " do
+        expect(instance).to respond_to(method)
+      end
+    end
+  end
+
   describe "standard_methods" do
     where(:method, :response) do
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base_editing_bootstrap
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Marino Bonetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-22 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -166,14 +166,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.x
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.x
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
@@ -192,16 +192,16 @@ dependencies:
   name: rails-i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n-debug
   requirement: !ruby/object:Gem::Requirement
@@ -317,6 +317,7 @@ files:
 - app/views/base_editing/_editing_form_measure_unit.html.erb
 - app/views/base_editing/_form.html.erb
 - app/views/base_editing/_form_field.html.erb
+- app/views/base_editing/_form_field_container.html.erb
 - app/views/base_editing/_form_field_header.html.erb
 - app/views/base_editing/_form_footer.html.erb
 - app/views/base_editing/_index_body.html.erb
@@ -342,6 +343,7 @@ files:
 - app/views/base_editing/form_field/_decimal.html.erb
 - app/views/base_editing/form_field/_enum.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
 - app/views/base_editing/new.html.erb
 - app/views/base_editing/show.html.erb
@@ -369,6 +371,7 @@ files:
 - lib/base_editing_bootstrap/version.rb
 - lib/generators/base_editing_bootstrap/cell_override/cell_override_generator.rb
 - lib/generators/base_editing_bootstrap/field_override/field_override_generator.rb
+- lib/generators/base_editing_bootstrap/header_override/header_override_generator.rb
 - lib/generators/base_editing_bootstrap/install/USAGE
 - lib/generators/base_editing_bootstrap/install/install_generator.rb
 - lib/generators/base_editing_bootstrap/install/templates/initializer.rb
@@ -403,7 +406,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: 'BaseEditing: funzionalità di base per cms rails'