pg_rails 7.3.0 → 7.3.2

data/pg_engine/app/controllers/concerns/pg_engine/resource.rb

@@ -1,15 +1,108 @@
 module PgEngine
   module Resource
+    # rubocop:disable Metrics/PerceivedComplexity
     def self.included(clazz)
-      # clazz.before_action :authenticate_user!
+      class << clazz
+        # This is a per class variable, all subclasses of clazz inherit it
+        # BUT **the values are independent between all of them**
+        attr_accessor :nested_class, :nested_key, :clase_modelo
+
+        # TODO: separar los endpoints de la lógica de filtros para evitar esta variable
+        # en Agenda
+        attr_accessor :skip_default_breadcrumb
+      end
+      clazz.delegate :nested_key, :nested_class, :clase_modelo, to: clazz
+
+      clazz.helper_method :nested_class, :nested_key, :clase_modelo
+      clazz.helper_method :nested_record, :nested_id
+
       clazz.helper_method :atributos_para_listar
       clazz.helper_method :atributos_para_mostrar
       clazz.helper_method :current_page_size
       clazz.helper_method :show_filters?
       clazz.helper_method :available_page_sizes
 
+      clazz.before_action do
+        # TODO: quitar esto, que se use el attr_accessor
+        #       o sea, quitar todas las referencias a @clase_modelo
+        @clase_modelo = clase_modelo
+      end
+
+      clazz.before_action unless: -> { clazz.skip_default_breadcrumb } do
+        if nested_record.present?
+          # Link al nested, siempre que sea no sea un embedded frame
+          # ya que en tal caso se supone que el nested está visible
+          # en el main frame. Además, si es un modal abierto desde
+          # el nested record, no muestro el link al mismo.
+          unless frame_embedded?
+            if modal_targeted? && referred_by?(nested_record)
+              add_breadcrumb nested_record.decorate.to_s_short
+            else
+              add_breadcrumb nested_record.decorate.to_s_short,
+                             nested_record.decorate.target_object
+            end
+          end
+
+          # Texto de index pero sin link, porque se supone que es un
+          # embedded index o viene de tal
+          add_breadcrumb clase_modelo.nombre_plural
+
+        elsif !modal_targeted?
+          # Link al index, siempre que no sea un modal, porque en tal
+          # caso se supone que el index está visible en el main frame
+          if clase_modelo.present?
+            add_breadcrumb clase_modelo.nombre_plural,
+                           url_for([pg_namespace, nested_record, clase_modelo])
+          else
+            # :nocov:
+            pg_warn 'clase_modelo is nil'
+            # :nocov:
+          end
+        end
+      end
+
       clazz.layout :set_layout
     end
+    # rubocop:enable Metrics/PerceivedComplexity
+
+    def referred_by?(object)
+      url_for(object.decorate.target_object) == request.referer
+    end
+
+    def nested_id
+      return unless nested_key.present? && nested_class.present?
+
+      id = params[nested_key]
+
+      # if using hashid-rails
+      if nested_class.respond_to? :decode_id
+        id = nested_class.decode_id(id)
+      end
+
+      id
+    end
+
+    def nested_record
+      return if nested_id.blank?
+
+      nested_class.find(nested_id)
+    end
+
+    def accepts_turbo_stream?
+      request.headers['Accept'].present? &&
+        request.headers['Accept'].include?('text/vnd.turbo-stream.html')
+    end
+
+    def respond_with_modal?
+      can_open_modal? || modal_targeted?
+    end
+
+    def can_open_modal?
+      request.get? &&
+        clase_modelo.default_modal &&
+        accepts_turbo_stream? &&
+        !in_modal?
+    end
 
     def set_layout
       if action_name == 'index'
@@ -38,13 +131,9 @@ module PgEngine
       pg_respond_show
     end
 
-    def respond_with_modal(klass_or_string)
-      if klass_or_string.is_a?(Class)
-        content = klass_or_string.new(instancia_modelo).render_in(view_context)
-      elsif klass_or_string.is_a?(String)
-        content = ModalContentComponent.new.with_body_content(klass_or_string)
-                                       .render_in(view_context)
-      end
+    # FIXME: refactor
+    def respond_with_modal(component)
+      content = component.render_in(view_context)
 
       if can_open_modal?
         modal = ModalComponent.new.with_content(content)
@@ -55,19 +144,28 @@ module PgEngine
     end
 
     def new
-      if respond_with_modal?
-        respond_with_modal(FormModalComponent)
+      if can_open_modal?
+        path = [request.path, request.query_string].compact.join('?')
+        component = ModalContentComponent.new(src: path)
+        respond_with_modal(component)
       else
         add_breadcrumb instancia_modelo.submit_default_value
       end
     end
 
     def edit
-      if respond_with_modal?
-        respond_with_modal(FormModalComponent)
+      if can_open_modal?
+        path = [request.path, request.query_string].compact.join('?')
+        component = ModalContentComponent.new(src: path)
+        respond_with_modal(component)
       else
-        add_breadcrumb instancia_modelo.to_s_short, instancia_modelo.target_object
-        add_breadcrumb 'Editando'
+        if modal_targeted? && referred_by?(instancia_modelo)
+          add_breadcrumb instancia_modelo.to_s_short
+        else
+          add_breadcrumb instancia_modelo.to_s_short,
+                         instancia_modelo.target_object
+        end
+        add_breadcrumb 'Modificando'
       end
     end
 
@@ -87,36 +185,59 @@ module PgEngine
     protected
 
     def default_sort
-      nil
+      'id desc'
     end
 
     def available_page_sizes
-      [10, 20, 30, 50, 100].push(current_page_size).uniq.sort
+      [5, 10, 20, 30, 50, 100].push(current_page_size).uniq.sort
+    end
+
+    def show_filters_by_default?
+      true
+    end
+
+    def filters_applied?
+      params[RansackMemory::Core.config[:param].presence || :q].present?
+    end
+
+    def session_key_identifier
+      ::RansackMemory::Core.config[:session_key_format]
+                           .gsub('%controller_name%', controller_path.parameterize.underscore)
+                           .gsub('%action_name%', action_name)
+                           .gsub('%request_format%', request.format.symbol.to_s)
+                           .gsub('%turbo_frame%', request.headers['Turbo-Frame'] || 'top')
+      # FIXME: rename to main?
     end
 
     def show_filters?
-      cur_route = pg_current_route
-      idtf = cur_route[:controller] + '#' + cur_route[:action] + '#open-filters'
+      return true if filters_applied?
+
+      idtf = "show-filters_#{session_key_identifier}"
 
       if params[:ocultar_filtros]
-        session[idtf] = nil
+        session[idtf] = false
       elsif params[:mostrar_filtros]
         session[idtf] = true
       end
 
-      session[idtf]
+      if session[idtf].nil?
+        show_filters_by_default?
+      else
+        session[idtf]
+      end
     end
 
     def current_page_size
-      if params[:page_size].present?
-        session[page_size_session_key] = params[:page_size].to_i
+      aux = params[:page_size].presence&.to_i
+      if aux.present? && aux.positive?
+        session[page_size_session_key] = aux
       end
 
       session[page_size_session_key].presence || default_page_size
     end
 
     def page_size_session_key
-      "#{controller_name}/#{action_name}/page_size"
+      "page_size_#{session_key_identifier}"
     end
 
     def default_page_size
@@ -126,22 +247,26 @@ module PgEngine
     def pg_respond_update
       object = instancia_modelo
       if (@saved = object.save)
-        if in_modal?
-          body = <<~HTML.html_safe
-            <pg-event data-event-name="pg:record-created" data-turbo-temporary
-              data-response='#{object.decorate.to_json}'></pg-event>
-          HTML
-          render html: ModalContentComponent.new.with_body_content(body)
-                                            .render_in(view_context)
-        else
-          redirect_to object.decorate.target_object
+        respond_to do |format|
+          format.html do
+            if in_modal?
+              body = <<~HTML.html_safe
+                <pg-event data-event-name="pg:record-updated" data-turbo-temporary
+                  data-response='#{object.decorate.to_json}'></pg-event>
+              HTML
+              render html: ModalContentComponent.new.with_content(body)
+                                                .render_in(view_context)
+            else
+              redirect_to object.decorate.target_object
+            end
+          end
+          format.json do
+            render json: object.decorate.as_json
+          end
         end
-      elsif in_modal?
-        render html: FormModalComponent.new(instancia_modelo.decorate)
-                                       .render_in(view_context)
       else
         add_breadcrumb instancia_modelo.decorate.to_s_short, instancia_modelo.decorate.target_object
-        add_breadcrumb 'Editando'
+        add_breadcrumb 'Modificando'
         # TODO: esto solucionaría el problema?
         # self.instancia_modelo = instancia_modelo.decorate
         #
@@ -157,15 +282,10 @@ module PgEngine
             <pg-event data-event-name="pg:record-created" data-turbo-temporary
               data-response='#{object.decorate.to_json}'></pg-event>
           HTML
-          render html: ModalContentComponent.new.with_body_content(body)
-                                            .render_in(view_context)
-
+          render turbo_stream: turbo_stream.append(current_turbo_frame, body)
         else
           redirect_to object.decorate.target_object
         end
-      elsif in_modal?
-        render html: FormModalComponent.new(instancia_modelo.decorate)
-                                       .render_in(view_context)
       else
         add_breadcrumb instancia_modelo.decorate.submit_default_value
         # TODO: esto solucionaría el problema?
@@ -181,35 +301,17 @@ module PgEngine
         format.html { render_listing }
         format.xlsx do
           render xlsx: 'download',
-                 filename: "#{@clase_modelo.nombre_plural.gsub(' ', '-').downcase}" \
+                 filename: "#{clase_modelo.nombre_plural.gsub(' ', '-').downcase}" \
                            "-#{Time.zone.now.strftime('%Y-%m-%d-%H.%M.%S')}.xlsx"
         end
       end
     end
 
-    def accepts_turbo_stream?
-      request.headers['Accept'].present? &&
-        request.headers['Accept'].include?('text/vnd.turbo-stream.html')
-    end
-
-    def in_modal?
-      request.headers['turbo-frame'] == 'modal_generic'
-    end
-
-    def respond_with_modal?
-      can_open_modal? || in_modal?
-    end
-
-    def can_open_modal?
-      request.get? &&
-        params[:start_modal] == 'true' &&
-        accepts_turbo_stream? &&
-        !in_modal?
-    end
-
     def pg_respond_show
-      if respond_with_modal?
-        respond_with_modal(ShowModalComponent)
+      if can_open_modal?
+        path = [request.path, request.query_string].compact.join('?')
+        component = ModalContentComponent.new(src: path)
+        respond_with_modal(component)
       else
         add_breadcrumb instancia_modelo.to_s_short, instancia_modelo.target_object
       end
@@ -219,14 +321,16 @@ module PgEngine
       "#{model.model_name.human} #{model.gender == 'f' ? 'borrada' : 'borrado'}"
     end
 
+    # rubocop:disable Metrics/PerceivedComplexity
     def pg_respond_destroy(model, redirect_url = nil)
       if destroy_model(model)
-        if respond_with_modal?
+        # FIXME: rename to main
+        if turbo_frame? && current_turbo_frame != 'top'
           body = <<~HTML.html_safe
             <pg-event data-event-name="pg:record-destroyed" data-turbo-temporary>
             </pg-event>
           HTML
-          respond_with_modal(body)
+          render turbo_stream: turbo_stream.append(current_turbo_frame, body)
         elsif redirect_url.present?
           redirect_to redirect_url, notice: destroyed_message(model), status: :see_other
         elsif accepts_turbo_stream?
@@ -251,6 +355,7 @@ module PgEngine
         redirect_back(fallback_location: root_path, status: 303)
       end
     end
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def destroy_model(model)
       @error_message = 'No se pudo eliminar el registro'
@@ -272,17 +377,22 @@ module PgEngine
     end
 
     def render_listing
-      @collection = @collection.page(params[:page]).per(current_page_size)
+      total = @collection.count
+      current_page = params[:page].presence&.to_i || 1
+      if current_page_size * (current_page - 1) > total
+        current_page = (total.to_f / current_page_size).ceil
+      end
+      @collection = @collection.page(current_page).per(current_page_size)
       @records_filtered = default_scope_for_current_model.any? if @collection.empty?
     end
 
     def buscar_instancia
-      if Object.const_defined?('FriendlyId') && @clase_modelo.is_a?(FriendlyId)
-        @clase_modelo.friendly.find(params[:id])
-      elsif @clase_modelo.respond_to? :find_by_hashid!
-        @clase_modelo.find_by_hashid!(params[:id])
+      if Object.const_defined?('FriendlyId') && clase_modelo.is_a?(FriendlyId)
+        clase_modelo.friendly.find(params[:id])
+      elsif clase_modelo.respond_to? :find_by_hashid!
+        clase_modelo.find_by_hashid!(params[:id])
       else
-        @clase_modelo.find(params[:id])
+        clase_modelo.find(params[:id])
       end
     rescue ActiveRecord::RecordNotFound
       raise PgEngine::PageNotFoundError
@@ -290,7 +400,10 @@ module PgEngine
 
     def set_instancia_modelo
       if action_name.in? %w[new create]
-        self.instancia_modelo = @clase_modelo.new(modelo_params)
+        self.instancia_modelo = clase_modelo.new(modelo_params)
+        if nested_id.present?
+          instancia_modelo.send("#{nested_key}=", nested_id)
+        end
       else
         self.instancia_modelo = buscar_instancia
 
@@ -323,12 +436,7 @@ module PgEngine
     end
 
     def nombre_modelo
-      @clase_modelo.name.underscore
-    end
-
-    def clase_modelo
-      # agarro la variable o intento con el nombre del controller
-      @clase_modelo ||= self.class.name.singularize.gsub('Controller', '').constantize
+      clase_modelo.name.underscore
     end
 
     def filtros_y_policy(campos, dflt_sort = nil)
@@ -337,20 +445,35 @@ module PgEngine
       )
       scope = policy_scope(clase_modelo)
 
-      scope = @filtros.filtrar(scope)
+      if nested_id.present?
+        scope = scope.where(nested_key => nested_id)
+        scope = scope.undiscarded if scope.respond_to?(:undiscarded)
+      elsif scope.respond_to?(:kept)
+        scope = scope.kept
+      end
+      # Soft deleted
 
       shared_context = Ransack::Adapters::ActiveRecord::Context.new(scope)
-      @q = @clase_modelo.ransack(params[:q], context: shared_context)
-
+      @q = clase_modelo.ransack(params[:q], context: shared_context)
       @q.sorts = dflt_sort if @q.sorts.empty? && dflt_sort.present?
 
       shared_context.evaluate(@q)
     end
 
     def default_scope_for_current_model
-      PgEngine::FiltrosBuilder.new(
-        self, clase_modelo, []
-      ).filtrar(policy_scope(clase_modelo))
+      scope = policy_scope(clase_modelo)
+
+      if nested_id.present?
+        scope = scope.where(nested_key => nested_id)
+
+        # Skip nested discarded check
+        scope = scope.undiscarded if scope.respond_to?(:undiscarded)
+      elsif scope.respond_to?(:kept)
+        scope = scope.kept
+      end
+      # Soft deleted, including nested discarded check
+
+      scope
     end
   end
 end

data/pg_engine/app/controllers/pg_engine/base_controller.rb

@@ -3,6 +3,10 @@
 module PgEngine
   # rubocop:disable Rails/ApplicationController
   class BaseController < ActionController::Base
+    before_action do
+      Current.controller = self
+    end
+
     # rubocop:enable Rails/ApplicationController
     include Pundit::Authorization
     include PrintHelper
@@ -10,6 +14,7 @@ module PgEngine
     include FlashHelper
     include RouteHelper
     include PgAssociable::Helpers
+    include FrameHelper
 
     class Redirect < PgEngine::Error
       attr_accessor :url

data/pg_engine/app/controllers/public/mensaje_contactos_controller.rb

@@ -6,7 +6,7 @@ module Public
   class MensajeContactosController < PublicController
     include PgEngine::Resource
 
-    before_action { @clase_modelo = MensajeContacto }
+    self.clase_modelo = MensajeContacto
 
     before_action(only: :index) { authorize MensajeContacto }
 

data/pg_engine/app/decorators/pg_engine/base_record_decorator.rb

@@ -49,7 +49,7 @@ module PgEngine
       end
     end
 
-    def destroy_link(confirm_text: '¿Estás seguro?', klass: 'btn-light', redirect_to: nil)
+    def destroy_link(confirm_text: '¿Confirmás que querés borrar el registro?', klass: 'btn-light', redirect_to: nil)
       return unless Pundit.policy!(Current.user, object).destroy?
 
       helpers.content_tag :span, rel: :tooltip, title: 'Eliminar' do
@@ -64,28 +64,28 @@ module PgEngine
     def edit_link(text: ' Modificar', klass: 'btn-warning')
       return unless Pundit.policy!(Current.user, object).edit?
 
-      start_modal = !helpers.using_modal? && object.class.default_modal
+      modal = object.class.default_modal
 
       helpers.content_tag :span, rel: :tooltip, title: 'Modificar' do
-        helpers.link_to edit_object_url + url_suffix(start_modal:), class: "btn btn-sm #{klass}",
-                                                                    'data-turbo-stream': start_modal do
+        helpers.link_to edit_object_url,
+                        class: "btn btn-sm #{klass}",
+                        'data-turbo-frame': modal ? 'modal_content' : '_top',
+                        'data-turbo-stream': modal do
           helpers.content_tag(:span, nil, class: clase_icono('pencil')) + text
         end
       end
     end
 
-    def url_suffix(start_modal: nil)
-      start_modal ? '?start_modal=true' : ''
-    end
-
     def show_link(text: '', klass: 'btn-light')
       return unless Pundit.policy!(Current.user, object).show?
 
-      start_modal = !helpers.using_modal? && object.class.default_modal
+      modal = object.class.default_modal
 
       helpers.content_tag :span, rel: :tooltip, title: 'Ver' do
-        helpers.link_to object_url + url_suffix(start_modal:), class: "btn btn-sm #{klass}",
-                                                               'data-turbo-stream': start_modal do
+        helpers.link_to object_url,
+                        class: "btn btn-sm #{klass}",
+                        'data-turbo-frame': modal ? 'modal_content' : '_top',
+                        'data-turbo-stream': modal do
           helpers.content_tag(:span, nil, class: clase_icono('eye-fill')) + text
         end
       end
@@ -105,11 +105,13 @@ module PgEngine
     def new_link(klass: 'btn-warning')
       return unless Pundit.policy!(Current.user, object).new?
 
-      start_modal = !helpers.using_modal? && object.class.default_modal
+      modal = object.class.default_modal
 
       helpers.content_tag :span, rel: :tooltip, title: submit_default_value do
-        helpers.link_to(new_object_url + url_suffix(start_modal:), class: "btn btn-sm #{klass}",
-                                                                   'data-turbo-stream': start_modal) do
+        helpers.link_to(new_object_url,
+                        class: "btn btn-sm #{klass}",
+                        'data-turbo-frame': modal ? 'modal_content' : '_top',
+                        'data-turbo-stream': modal) do
           helpers.content_tag(:span, nil,
                               class: clase_icono('plus').to_s) + "<span class='d-none d-sm-inline'> #{submit_default_value}</span>".html_safe
         end
@@ -128,13 +130,22 @@ module PgEngine
       helpers.url_for(target_object)
     end
 
+    def nested_record
+      # TODO: esto es raro
+      return if !Current.controller.respond_to?(:nested_record) ||
+                Current.controller.nested_record.nil? ||
+                Current.controller.nested_record.instance_of?(object.class)
+
+      Current.controller.nested_record
+    end
+
     def target_object
-      pg_namespace.present? ? [pg_namespace, object] : object
+      [pg_namespace, nested_record, object].compact
     end
 
     def target_new
       mod_name_sing = object.class.model_name.singular.to_sym
-      pg_namespace.present? ? [:new, pg_namespace, mod_name_sing] : [:new, mod_name_sing]
+      [:new, pg_namespace, nested_record, mod_name_sing]
     end
 
     def target_index

data/pg_engine/app/helpers/pg_engine/form_helper.rb

@@ -2,10 +2,6 @@
 
 module PgEngine
   module FormHelper
-    def using_modal?
-      @using_modal || controller.instance_variable_get(:@using_modal)
-    end
-
     # rubocop:disable Metrics/CyclomaticComplexity
     def pg_form_for(object, *args, &block_passed)
       resource = object
@@ -39,7 +35,6 @@ module PgEngine
       block_with_additives = lambda do |f|
         ret = ''.html_safe
         ret += f.mensajes_de_error if options[:render_errors]
-        # ret += hidden_field_tag(:using_modal, true) if using_modal?
         ret += capture(f, &block_passed)
         ret
       end

data/pg_engine/app/helpers/pg_engine/frame_helper.rb

@@ -0,0 +1,52 @@
+module PgEngine
+  module FrameHelper
+    # Will the current view rendered in a modal?
+    def using_modal?
+      controller.instance_variable_get(:@using_modal) ||
+        modal_targeted?
+    end
+
+    def using_modal2?
+      @using_modal || modal_targeted?
+    end
+
+    def in_modal?
+      request.headers['Modal-Opened'] == 'true'
+    end
+
+    def current_turbo_frame
+      request.headers['Turbo-Frame']
+    end
+
+    def turbo_frame?
+      current_turbo_frame.present?
+    end
+
+    def modal_targeted?
+      current_turbo_frame == 'modal_content'
+    end
+
+    def frame_embedded?
+      turbo_frame? && current_turbo_frame.include?('embedded')
+    end
+
+    def embed_index(object, key)
+      content_tag(:div, 'data-controller': 'embedded-frame') do
+        turbo_frame_tag "embedded--#{key}",
+                        refresh: :morph, src: url_for([pg_namespace, object, key]) do
+          content_tag(:p, class: 'p text-body-secondary text-center') { 'Cargando...' }
+        end
+      end
+    end
+
+    def nav_bg
+      if frame_embedded?
+        'bg-warning bg-opacity-25'
+      elsif using_modal?
+        'bg-warning bg-opacity-50'
+      else
+        'bg-primary-subtle'
+      end
+    end
+  end
+end

data/pg_engine/app/lib/pg_engine/bootstrap5_breadcrumbs_builder.rb

@@ -0,0 +1,22 @@
+module PgEngine
+  class Bootstrap5BreadcrumbsBuilder < BreadcrumbsOnRails::Breadcrumbs::Builder
+    def render
+      @elements.collect do |element|
+        render_element(element)
+      end.join(@options[:separator] || '')
+    end
+
+    def render_element(element)
+      content = if element.path.nil?
+                  compute_name(element)
+                else
+                  # TODO: add aria-current="page"
+                  @context.link_to_unless_current(
+                    compute_name(element), compute_path(element), element.options
+                  )
+                end
+
+      @context.content_tag('li', content, class: 'breadcrumb-item')
+    end
+  end
+end

data/pg_engine/app/lib/pg_engine/filtros_builder.rb

@@ -64,11 +64,12 @@ module PgEngine
       @filtros[campo][:scope_asociacion] = block
     end
 
+    # FIXME: deprecar
     def filtrar(query, parametros = nil)
-      parametros = parametros_controller if parametros.nil?
+      parametros_controller if parametros.nil?
 
       # Filtro soft deleted
-      query = query.kept if query.respond_to?(:kept) && parametros[:archived] != 'true'
+      query = query.kept if query.respond_to?(:kept)
 
       query
     end

data/pg_engine/app/models/current.rb

@@ -1,5 +1,5 @@
 class Current < ActiveSupport::CurrentAttributes
-  attribute :account, :user, :namespace
+  attribute :account, :user, :namespace, :controller
   # attribute :request_id, :user_agent, :ip_address
 
   # resets { Time.zone = nil }