base_editing_bootstrap 1.5.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aee3afb2ce6b96c834dbc1491588c42355e8e726ce1ba030f1ebd9c31d368800
-  data.tar.gz: 6ee2f8827e7ec00045a710c113f1e432a874a3900d840257f9602902aaad6466
+  metadata.gz: 9c363b9569d715a8519f72345250ee7dd019de73ce87330e6a49d62acc0e0e10
+  data.tar.gz: 9d7499c1ba5fbf66c2d0f466237e7b69bce234d022d21cd9d74b920564b6960f
 SHA512:
-  metadata.gz: ce1a79b4abb27bc8f1297b7100bdc0ed5beb6589a0fe2ddf0915bc5f258a85cfa071644a84f35ff1b0a03444c57246d15bebb2a1dcf9a738c654675f48f45b19
-  data.tar.gz: b65de7345289bb1ef0724f27279a4afba4017ca3620714982b94f1fdc958e0322b91c8ee9a3e3ccc82040bd5c2a7b632b376a34f5e95d7ee7c00364e8efd57e3
+  metadata.gz: b2243dc34ddba312f01465774a8df4662ea78e832885774966d29c685164201284aae102b8188a59c54d8b3c44a1c8af81227e04ef28a780651e6cdcd1abe6c1
+  data.tar.gz: 7c43ad6f7059a50c7719633e432d941ebd2433518712b9b5d20b5fff573cc802b24de785e81a96eebaf31c6d96639b2e3a99445dca3df086956d73a0529cc6d3

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
 
 - - -
+## 1.7.0 - 2025-02-11
+#### Bug Fixes
+- Add permits of ransack scopes - (5fa26c6) - Marino Bonetti
+- Correct set select classes - (a5ef685) - Marino Bonetti
+- Boolean_icon with nil value - (211c91f) - Marino Bonetti
+- Better expection for spec helper - (65b26ce) - Marino Bonetti
+#### Documentation
+- Add documentation for help html version - (dbc1c01) - Marino Bonetti
+#### Features
+- Add HTML helper version in form field help - (f06c438) - Marino Bonetti
+- Add Configurable distinct query in controller - (184d772) - Marino Bonetti
+#### Tests
+- Correct validation for selects - (e4b8016) - Marino Bonetti
+
+- - -
+
+## 1.6.0 - 2025-01-23
+#### Features
+- Add new test helper for association relation - (15690c7) - Marino Bonetti
+#### Tests
+- Fix association for order - (9e2bdd4) - Marino Bonetti
+- Example order by ransack - (79cccc7) - Marino Bonetti
+
+- - -
+
 ## 1.5.1 - 2025-01-22
 #### Bug Fixes
 - Ricerca template anche con contesto del controller - (ac93a9f) - Marino Bonetti

data/README.md

@@ -126,7 +126,8 @@ Utilizzo per modello base, in questo esempio prendiamo come modello Post come es
     ```
   - è possibile customizzare 
     - un text help per ogni campo andando ad aggiungere nelle traduzioni la relativa 
-      traduzione nella posizione: `it.activerecord.attributes.MODEL.FIELD/help_text`
+      traduzione nella posizione: `it.activerecord.attributes.MODEL.FIELD/help_text` oppure `help_text_html` in caso di
+      contenuto con html
     - un blocco per l'unità di misura accanto al campo aggiungendo alle traduzioni: 
       `it.activerecord.attributes.MODEL.FIELD/unit`
       

data/app/controllers/base_editing_controller.rb

@@ -14,13 +14,19 @@ class BaseEditingController < RestrictedAreaController
   # Works like documented in https://activerecord-hackery.github.io/ransack/getting-started/sorting/#sorting-in-the-controller
   class_attribute :default_sorts, default: ["id"]
 
+  ##
+  # Configure default distinct results in the index query.
+  # Works like documented in https://activerecord-hackery.github.io/ransack/going-further/other-notes/#problem-with-distinct-selects
+  class_attribute :default_distinct, default: true
+
   def index
     authorize base_class
 
     q = policy_scope(base_scope)
     @search_instance = search_class.new(q, current_user,
                                         params: params.permit(:page, :q => {}), # FIXME trovare modo per essere più "STRONG"
-                                        sorts: default_sorts
+                                        sorts: default_sorts,
+                                        distinct: default_distinct
     )
     @search_instance = yield(@search_instance) if block_given?
   end

data/app/helpers/utilities/page_helper.rb

@@ -1,4 +1,5 @@
 module Utilities::PageHelper
+  include Utilities::IconHelper
   # @param [BaseModel] base_class
   def title_mod_g(base_class)
     "#{t("edit")} #{base_class.model_name.human}"
@@ -24,12 +25,15 @@ module Utilities::PageHelper
   #   end
   # end
 
-  # @param [TrueClass, FalseClass] valore
+  # @param [TrueClass, FalseClass, NilClass] valore
   def boolean_to_icon(valore)
-    if valore
+    case valore
+    when true
       icon("check-lg", class: "text-success")
-    else
+    when false
       icon("x-lg", class: "text-danger")
+    else
+      nil
     end
   end
 

data/app/policies/base_model_policy.rb

@@ -24,6 +24,8 @@ class BaseModelPolicy < ApplicationPolicy
     []
   end
 
+  def permitted_scopes_for_ransack = []
+
   def search_fields = []
 
   def search_result_fields = []

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

@@ -6,7 +6,13 @@
 %>
 <%# locals: (object:,field:) -%>
 <%
-  help_text = object.class.human_attribute_name("#{field}/help_text", default: "")
+  nf = "NOT_FOUND_HTML"
+  help_text = object.class.human_attribute_name("#{field}/help_text_html", default: nf)
+  if help_text != nf
+    help_text = help_text.html_safe
+  else
+    help_text = object.class.human_attribute_name("#{field}/help_text", default: "")
+  end
   unless help_text.blank?
 %>
   <div class="form-text"><%= help_text %></div>

data/lib/base_editing_bootstrap/VERSION

@@ -1 +1 @@
-1.5.1
+1.7.0

data/lib/base_editing_bootstrap/base_model.rb

@@ -7,7 +7,9 @@ module BaseEditingBootstrap
     included do
       include IsValidated
       include ActionTranslation
-      delegate :ransackable_attributes, :ransackable_associations, to: :@class
+      delegate :ransackable_attributes,
+               :ransackable_associations,
+               :ransackable_scopes, to: :@class
 
 
       ##
@@ -34,6 +36,14 @@ module BaseEditingBootstrap
           Pundit.policy(User.new, self.new).permitted_associations_for_ransack.map(&:to_s)
         end
       end
+
+      def ransackable_scopes(auth_object = nil)
+        if auth_object
+          Pundit.policy(auth_object, self.new).permitted_scopes_for_ransack.map(&:to_s)
+        else
+          Pundit.policy(User.new, self.new).permitted_scopes_for_ransack.map(&:to_s)
+        end
+      end
     end
   end
 end

data/lib/base_editing_bootstrap/forms/base.rb

@@ -24,8 +24,8 @@ module BaseEditingBootstrap::Forms
     ##
     # Costruisce l'array delle classi che devono essere presenti sul campo della form
     #
-    def form_style_class_for(method, options = {})
-      classes = ["form-control"]
+    def form_style_class_for(method, options = {}, base_classes: ["form-control"])
+      classes = base_classes
       classes << "is-invalid" if object.errors && object.errors.include?(method)
       classes << options[:class].split(" ") if options[:class]
       classes.flatten.compact.uniq.join(" ")
@@ -46,8 +46,8 @@ module BaseEditingBootstrap::Forms
     end
 
     def select(method, choices = nil, options = {}, html_options = {}, &block)
-      html_options[:class] = "form-select #{html_options[:class]}"
-      super(method, choices, options, html_options.merge(class: form_style_class_for(method, html_options)), &block)
+      html_options.merge!(class: form_style_class_for(method, html_options, base_classes: ["form-control", "form-select"]))
+      super(method, choices, options,html_options , &block)
     end
 
     def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
@@ -57,9 +57,10 @@ module BaseEditingBootstrap::Forms
       else
         label_tag = nil
       end
-      classes = (["form-check"] + (options.extract!(:class)[:class] || "").split(" ")).join(" ")
-      @template.content_tag(:div, class: classes) do
-        super(method, options.reverse_merge(class: "form-check-input"), checked_value, unchecked_value) + label_tag
+      @template.content_tag(:div, class: form_style_class_for(method, {class: (options.extract!(:class)[:class] || "")}, base_classes: ["form-check"])) do
+        checkbox_class = ["form-check-input"]
+        checkbox_class << "is-invalid" if object.errors && object.errors.include?(method)
+        super(method, options.reverse_merge(class: checkbox_class.join(" ")), checked_value, unchecked_value) + label_tag
       end
     end
 
@@ -75,7 +76,7 @@ module BaseEditingBootstrap::Forms
                                options = {},
                                html_options = {},
                                &block)
-      form_check_classes = (["form-check"] + [(html_options.delete(:form_check_class){""}).split(" ").collect(&:strip)]).compact.join(" ")
+      form_check_classes = (["form-check"] + [(html_options.delete(:form_check_class) { "" }).split(" ").collect(&:strip)]).compact.join(" ")
       super do |builder|
         @template.content_tag(:div, class: form_check_classes) do
           builder.check_box(class: "form-check-input") + builder.label(class: "form-check-label")

data/lib/base_editing_bootstrap/searches/base.rb

@@ -7,17 +7,18 @@ module BaseEditingBootstrap::Searches
     include ActiveModel::Naming
     include ActiveModel::Conversion
 
-    attr_reader :model_klass, :user, :params, :scope, :sorts
+    attr_reader :model_klass, :user, :params, :scope, :sorts, :distinct
 
     # @param [User] user
     # @param [ActiveRecord::Associations::CollectionProxy] scope
     # @param [Array<String (frozen)>] sort
-    def initialize(scope, user, params: {page: nil}, sorts: ["id"])
+    def initialize(scope, user, params: {page: nil}, sorts: ["id"], distinct: true)
       @model_klass = scope.klass
       @user = user
       @scope = scope
       @params = params
       @sorts = sorts
+      @distinct = distinct
     end
 
     ##
@@ -26,7 +27,7 @@ module BaseEditingBootstrap::Searches
     def results
       ransack_query
         .tap { |r| r.sorts = @sorts if r.sorts.empty? }
-        .result(distinct: true)
+        .result(distinct: @distinct)
         .tap { |q| Rails.logger.debug { "[Ransack] params:#{params} - sql: #{q.to_sql}" } }
         .page(params[:page])
     end

data/lib/generators/base_editing_bootstrap/scaffold/templates/spec/model.rb.tt

@@ -5,11 +5,14 @@ RSpec.describe <%= class_name %>, type: :model do
 
  # it_behaves_like "a base model",
  #                 ransack_permitted_attributes: %w[<%= attributes_names.join(" ") %>],
- #                 ransack_permitted_associations: []  do
+ #                 ransack_permitted_associations: [],
+ #                 option_label_method: :to_s,
+ #                 ransack_permitted_scopes: []  do
  #     let(:auth_object) { :auth_object } <- default
  #     let(:auth_object) { create(:user, :as_admin) } <- in caso di necessità di override
  #     let(:new_user_ransack_permitted_attributes) { ransack_permitted_attributes }
  #     let(:new_user_ransack_permitted_associations) { ransack_permitted_associations }
+ #     let(:new_user_ransack_permitted_scopes) { ransack_permitted_scopes }
  # end
 
 end

data/spec/support/external_shared/base_editing_controller_helpers.rb

@@ -49,7 +49,9 @@ RSpec.shared_examples "base editing controller" do |factory: nil, only: [], exce
 
   ##
   # Possibili override per la costruzione delle path
-  #
+
+  let(:default_sorts) { BaseEditingController.default_sorts } # configurazione nel controller per ordine di default del modello
+  let(:default_distinct) { BaseEditingController.default_distinct } # configurazione nel controller per distinct nella ricerca di ransack
   let(:url_for_new) { url_for([model.new, action: :new]) }
   let(:url_for_index) { url_for(model) }
   let(:url_for_create) { url_for(model.new) }
@@ -89,10 +91,13 @@ RSpec.shared_examples "base editing controller" do |factory: nil, only: [], exce
         params = {q: {"foo_eq": "foo"}}
         get url_for_index, params: params
         expect(response).to have_http_status(200)
-        expect(assigns[:search_instance]).to be_an_instance_of(BaseEditingBootstrap::Searches::Base).and(have_attributes(
-                                                                                                           user: user,
-                                                                                                           params: ActionController::Parameters.new(params).permit!
-                                                                                                         ))
+        expect(assigns[:search_instance]).to be_an_instance_of(BaseEditingBootstrap::Searches::Base)
+                                               .and(have_attributes(
+                                                      user: user,
+                                                      params: ActionController::Parameters.new(params).permit!,
+                                                      sorts: default_sorts,
+                                                      distinct: default_distinct,
+                                                    ))
       end
     end
   end
@@ -194,7 +199,7 @@ default_unathorized_failure = -> { raise "TODO - passare proc con richiesta che
 RSpec.shared_examples "fail with unauthorized" do |request: default_unathorized_failure|
   it "is expected to redirect to root" do
 
-    if Gem::Version.create( Pundit::VERSION) < Gem::Version.create('2.3.2')
+    if Gem::Version.create(Pundit::VERSION) < Gem::Version.create('2.3.2')
       allow(Pundit).to receive(:authorize).with(user, any_args).and_raise(Pundit::NotAuthorizedError)
     else
       allow_any_instance_of(Pundit::Context).to receive(:authorize).and_raise(Pundit::NotAuthorizedError)

data/spec/support/external_shared/base_model.rb

@@ -1,4 +1,7 @@
-RSpec.shared_examples "a base model" do |ransack_permitted_attributes: [], ransack_permitted_associations: [], option_label_method: :to_s|
+RSpec.shared_examples "a base model" do |ransack_permitted_attributes: [],
+  ransack_permitted_associations: [],
+  option_label_method: :to_s,
+  ransack_permitted_scopes: []|
 
   it_behaves_like "a validated? object"
 
@@ -10,15 +13,24 @@ RSpec.shared_examples "a base model" do |ransack_permitted_attributes: [], ransa
     instance = described_class.new
     expect(instance).to respond_to(:option_label)
 
-    expect(instance).to receive(option_label_method).and_call_original
+    expect(instance).to receive(option_label_method).and_call_original, "Expected `#{instance.class}#option_label` chiami il metodo `##{option_label_method}` per la traduzione del label nelle options"
     instance.option_label
   end
 
+  if ransack_permitted_scopes.any?
+    it "have scopes" do
+      ransack_permitted_scopes.each do |scope|
+        expect(described_class).to respond_to(scope)
+      end
+    end
+  end
+
   ##
   # Oggetto solitamente di classe User che identifichi l'utente a cui eseguire il check dei permessi
   let(:auth_object) { :auth_object }
   let(:new_user_ransack_permitted_attributes) { ransack_permitted_attributes }
   let(:new_user_ransack_permitted_associations) { ransack_permitted_associations }
+  let(:new_user_ransack_permitted_scopes) { ransack_permitted_scopes }
 
   describe "with ransackables" do
     where(:base_model_method, :result, :new_user_result) do
@@ -29,6 +41,9 @@ RSpec.shared_examples "a base model" do |ransack_permitted_attributes: [], ransa
         [
           :ransackable_associations, ransack_permitted_associations.map(&:to_s), lazy { new_user_ransack_permitted_associations.map(&:to_s) }
         ],
+        [
+          :ransackable_scopes, ransack_permitted_scopes.map(&:to_s), lazy { new_user_ransack_permitted_scopes.map(&:to_s) }
+        ],
       ]
     end
 

data/spec/support/external_shared/pundit.rb

@@ -25,6 +25,7 @@ RSpec.shared_examples "a standard base model policy" do |factory, check_default_
         [:search_fields],
         [:permitted_associations_for_ransack],
         [:permitted_attributes_for_ransack],
+        [:permitted_scopes_for_ransack],
         [:editable_attributes],
         [:permitted_attributes],
       ]
@@ -37,6 +38,47 @@ RSpec.shared_examples "a standard base model policy" do |factory, check_default_
     end
   end
 
+  # Controllo che se negli elementi dei #sortable_search_result_fields è presente un elemento
+  # che ha come prefisso il nome di una relazione presente in #permitted_associations_for_ransack
+  # allora nella policy della relativa associazione dovrò trovare in #permitted_attributes_for_ransack
+  # il nome della colonna da ordinare.
+  # ES:
+  # relazione: User -> Post
+  # class PostPolicy
+  #   def sortable_search_result_fields = %i[user_username]
+  #   def permitted_associations_for_ransack = %i[user]
+  # end
+  # class UserPolicy
+  #   def permitted_attributes_for_ransack = %[username]
+  # end
+  # ordinamento per #user_username, quindi devo cercare relazione in `user` e attribute `username`
+  it "check associated sortable attributes" do
+    klass = instance.record.class
+    # non facciamo nulla se non è un active record il record da controllare
+    if klass.respond_to?(:reflect_on_association)
+
+      # escludiamo le colonne del modello
+      col_to_check = (instance.sortable_search_result_fields.collect(&:to_s) - instance.record.class.column_names).uniq
+
+      elenco_campi_ordinabili_in_relazione = col_to_check.map do |field|
+        instance.permitted_associations_for_ransack.map do |rel|
+          if field.match(/^#{rel}_(.*)$/)
+            [rel, Regexp.last_match(1)]
+          end
+        end
+      end.flatten(1).compact.uniq
+
+      elenco_campi_ordinabili_in_relazione.each do |relation,field|
+        reflection = klass.reflect_on_association(relation.to_s)
+        policy = Pundit.policy(instance.user, reflection.class_name.constantize.new)
+        expect(policy.permitted_attributes_for_ransack.collect(&:to_sym).include?(field.to_sym)).to be_truthy, lambda{
+          "Mi aspetto che `#{policy.class.name}#permitted_attributes_for_ransack` includa `#{field}` per permettere l'ordinamento del campo tramite relazione"
+        }
+      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: 1.5.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Marino Bonetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-22 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails