dry_crud 7.1.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf13269261b9cbae5f96418d05f9032805c3a50e1f1e7c02b79d71bfbf6c89c1
-  data.tar.gz: e28764d18296115dcae6119a97ed282d1d4da809585791333c0e6c328634d140
+  metadata.gz: 728d9df7af506d9680cf74d6b7031db221a645816ef03307f1f9a8abca8bd40b
+  data.tar.gz: 748c707433dd4dfea6069f482276e48f45124ba3e26d1ba956d78ab3fc629702
 SHA512:
-  metadata.gz: a767e47df9be1a264bafa9af864278546e14fcfdf5bf728686c01bdf76d52823a73a215177a136a8c696c15898a82da899b88a2fc3252977d88c16a9da811436
-  data.tar.gz: d899147d340aae9dc0e75a64f718b3ada4debdd84a5d77970d2b6284cb9690f2f43877fe77319c900cb524a6da57a79be5c155098114d298cc040c09b6e3353b
+  metadata.gz: 692538e533f409bee57aa7ebc5ac99d040d3fabd2e376ecd4edf4057f1f8732011f4753178af4abffe36973baa2dad81c9afa5edc55047bf6c93eb68aef2b80b
+  data.tar.gz: 247d2b34b35ec952f334635a50e5bba85733f0ffef5abbc2efcafa5b5a581aca44f188946eab0bdef662734554e87ae268638a1674720df773599135fd4ee9b9

data/VERSION

@@ -1 +1 @@
-7.1.0
+8.0.0

data/app/controllers/crud_controller.rb

@@ -8,7 +8,6 @@
 # With the help of additional callbacks, it is possible to hook into the
 # action procedures without overriding the entire method.
 class CrudController < ListController
-
   class_attribute :permitted_attrs
 
   # Defines before and after callback hooks for create, update, save and
@@ -139,7 +138,7 @@ class CrudController < ListController
 
   # The form params for this model.
   def model_params
-    params.require(model_identifier).permit(permitted_attrs)
+    params.expect(model_identifier => permitted_attrs)
   end
 
   # Path of the index page to return to.
@@ -186,7 +185,7 @@ class CrudController < ListController
   # Perform a redirect after a failed operation and set a flash alert.
   def redirect_on_failure(**options)
     location = options[:location] ||
-               request.env['HTTP_REFERER'].presence ||
+               request.env["HTTP_REFERER"].presence ||
                index_path
     flash[:alert] ||= error_messages.presence || flash_message(:failure)
     redirect_to location
@@ -211,10 +210,10 @@ class CrudController < ListController
   # or crud.{action_name}.flash.{state} as fallback.
   def flash_message(state)
     scope = "#{action_name}.flash.#{state}"
-    keys = [:"#{controller_name}.#{scope}_html",
+    keys = [ :"#{controller_name}.#{scope}_html",
             :"#{controller_name}.#{scope}",
             :"crud.#{scope}_html",
-            :"crud.#{scope}"]
+            :"crud.#{scope}" ]
     I18n.t(keys.shift, model: full_entry_label, default: keys)
   end
 
@@ -229,7 +228,7 @@ class CrudController < ListController
   def error_messages
     # rubocop:disable Rails/OutputSafety
     escaped = entry.errors.full_messages.map { |m| ERB::Util.html_escape(m) }
-    escaped.join('<br/>').html_safe
+    escaped.join("<br/>").html_safe
     # rubocop:enable Rails/OutputSafety
   end
 
@@ -242,5 +241,4 @@ class CrudController < ListController
       before_render_edit(*methods)
     end
   end
-
 end

data/app/controllers/dry_crud/generic_model.rb

@@ -1,5 +1,4 @@
 module DryCrud
-
   # Connects the including controller to the model whose name corrsponds to
   # the controller's name.
   #
@@ -7,13 +6,12 @@ module DryCrud
   # Additional helper methods store and retrieve values in instance variables
   # named after their class.
   module GenericModel
-
     extend ActiveSupport::Concern
 
     included do
       helper_method :model_class, :models_label, :path_args
 
-      delegate :model_class, :models_label, :model_identifier, to: 'self.class'
+      delegate :model_class, :models_label, :model_identifier, to: "self.class"
     end
 
     # The scope where model entries will be listed and created.
@@ -43,11 +41,11 @@ module DryCrud
     def model_ivar_set(value)
       name = if value.respond_to?(:klass) # ActiveRecord::Relation
                ivar_name(value.klass).pluralize
-             elsif value.respond_to?(:each) # Array
+      elsif value.respond_to?(:each) # Array
                ivar_name(value.first.class).pluralize
-             else
+      else
                ivar_name(value.class)
-             end
+      end
       instance_variable_set(:"@#{name}", value)
     end
 
@@ -57,7 +55,6 @@ module DryCrud
 
     # Class methods from GenericModel.
     module ClassMethods
-
       # The ActiveRecord class of the model.
       def model_class
         @model_class ||= controller_name.classify.constantize
@@ -77,7 +74,6 @@ module DryCrud
 
         model_class.model_name.human(opts)
       end
-
     end
   end
 end

data/app/controllers/dry_crud/nestable.rb

@@ -1,5 +1,4 @@
 module DryCrud
-
   # Provides functionality to nest controllers/resources.
   # If a controller is nested, the parent classes and namespaces
   # may be defined as an array in the +nesting+ class attribute.
@@ -8,7 +7,6 @@ module DryCrud
   # namespace, may define this attribute as follows:
   #   self.nesting = :admin, Country
   module Nestable
-
     # Adds the :nesting class attribute and parent helper methods
     # to the including controller.
     def self.prepended(klass)
@@ -45,7 +43,7 @@ module DryCrud
 
     # An array of objects used in url_for and related functions.
     def path_args(last)
-      parents + [last]
+      parents + [ last ]
     end
 
     # Uses the parent entry (if any) to constrain the model scope.
@@ -61,6 +59,5 @@ module DryCrud
     def parent_scope
       parent.send(model_class.name.underscore.pluralize)
     end
-
   end
 end

data/app/controllers/dry_crud/rememberable.rb

@@ -1,5 +1,4 @@
 module DryCrud
-
   # Remembers certain params of the index action in order to return
   # to the same list after an entry was viewed or edited.
   # If the index is called with a param :returning, the remembered params
@@ -11,14 +10,13 @@ module DryCrud
   # The params are stored separately for each different +remember_key+, which
   # defaults to the current request's path.
   module Rememberable
-
     extend ActiveSupport::Concern
 
     included do
       class_attribute :remember_params
       self.remember_params = %w[q sort sort_dir page]
 
-      before_action :handle_remember_params, only: [:index]
+      before_action :handle_remember_params, only: [ :index ]
     end
 
     private
@@ -61,6 +59,5 @@ module DryCrud
     def remember_key
       request.path
     end
-
   end
 end

data/app/controllers/dry_crud/render_callbacks.rb

@@ -1,8 +1,6 @@
 module DryCrud
-
   # Provide +before_render+ callbacks.
   module RenderCallbacks
-
     extend ActiveSupport::Concern
 
     included do
@@ -12,16 +10,14 @@ module DryCrud
 
     # Prepended methods for callbacks.
     module Prepends
-
       # Helper method to run +before_render+ callbacks and render the action.
       # If a callback renders or redirects, the action is not rendered.
       def render(...)
         options = _normalize_render(...)
-        callback = "render_#{options[:template]}"
-
+        callback = "render_#{options[:template] || options[:action] || action_name}"
         run_callbacks(callback) if respond_to?(:"_#{callback}_callbacks", true)
 
-        super(...) unless performed?
+        super unless performed?
       end
 
       private
@@ -33,12 +29,10 @@ module DryCrud
           -> { run_callbacks(e, &a) }
         end.call
       end
-
     end
 
     # Class methods for callbacks.
     module ClassMethods
-
       # Defines before callbacks for the render actions.
       def define_render_callbacks(*actions)
         args = actions.map { |a| :"render_#{a}" }
@@ -58,8 +52,6 @@ module DryCrud
           terminate
         end
       end
-
     end
-
   end
 end

data/app/controllers/dry_crud/searchable.rb

@@ -1,10 +1,8 @@
 module DryCrud
-
   # The search functionality for the index table.
   # Define an array of searchable string columns in your subclassing
   # controllers using the class attribute +search_columns+.
   module Searchable
-
     extend ActiveSupport::Concern
 
     included do
@@ -18,7 +16,6 @@ module DryCrud
 
     # Prepended methods for searching.
     module Prepends
-
       private
 
       # Enhance the list entries with an optional search criteria
@@ -61,24 +58,20 @@ module DryCrud
       def search_support?
         search_columns.present?
       end
-
     end
 
     # Class methods for Searchable.
     module ClassMethods
-
       # All search columns divided in table and field names.
       def search_tables_and_fields
         @search_tables_and_fields ||= search_columns.map do |f|
-          if f.to_s.include?('.')
-            f.split('.', 2)
+          if f.to_s.include?(".")
+            f.split(".", 2)
           else
-            [model_class.table_name, f]
+            [ model_class.table_name, f ]
           end
         end
       end
-
     end
-
   end
 end

data/app/controllers/dry_crud/sortable.rb

@@ -1,10 +1,8 @@
 module DryCrud
-
   # Sort functionality for the index table.
   # Define a default sort expression that is always appended to the
   # current sort params with the class attribute +default_sort+.
   module Sortable
-
     extend ActiveSupport::Concern
 
     included do
@@ -20,7 +18,6 @@ module DryCrud
 
     # Class methods for sorting.
     module ClassMethods
-
       # Define a map of (virtual) attributes to SQL order expressions.
       # May be used for sorting table columns that do not appear directly
       # in the database table. E.g., map city_id: 'cities.name' to
@@ -29,20 +26,18 @@ module DryCrud
         self.sort_mappings_with_indifferent_access =
           hash.with_indifferent_access
       end
-
     end
 
     # Prepended methods for sorting.
     module Prepends
-
       private
 
       # Enhance the list entries with an optional sort order.
       def list_entries
         sortable = sortable?(params[:sort])
         if sortable || default_sort
-          clause = [sortable ? sort_expression : nil, default_sort]
-          super.reorder(Arel.sql(clause.compact.join(', ')))
+          clause = [ sortable ? sort_expression : nil, default_sort ]
+          super.reorder(Arel.sql(clause.compact.join(", ")))
         else
           super
         end
@@ -57,7 +52,7 @@ module DryCrud
 
       # The sort direction, either 'asc' or 'desc'.
       def sort_dir
-        params[:sort_dir] == 'desc' ? 'DESC' : 'ASC'
+        params[:sort_dir] == "desc" ? "DESC" : "ASC"
       end
 
       # Returns true if the passed attribute is sortable.
@@ -66,8 +61,6 @@ module DryCrud
         model_class.column_names.include?(attr.to_s) ||
         sort_mappings_with_indifferent_access.include?(attr))
       end
-
     end
-
   end
 end

data/app/controllers/list_controller.rb

@@ -7,7 +7,6 @@
 # Furthermore, it remembers the last search and sort parameters after the
 # user returns from a displayed or edited entry.
 class ListController < ApplicationController
-
   include DryCrud::GenericModel
   prepend DryCrud::Nestable
   include DryCrud::RenderCallbacks
@@ -48,5 +47,4 @@ class ListController < ApplicationController
   # Include these modules after the #list_entries method is defined.
   include DryCrud::Searchable
   include DryCrud::Sortable
-
 end

data/app/helpers/actions_helper.rb

@@ -3,19 +3,18 @@
 # of action links, change the method #action_link, e.g. to generate a button.
 # The common crud actions show, edit, destroy, index and add are provided here.
 module ActionsHelper
-
   # A generic helper method to create action links.
   # These link could be styled to look like buttons, for example.
   def action_link(label, icon = nil, url = {}, html_options = {})
-    add_css_class html_options, 'action btn btn-light'
+    add_css_class html_options, "action btn btn-light"
     link_to(icon ? action_icon(icon, label) : label,
             url, html_options)
   end
 
   # Outputs an icon for an action with an optional label.
   def action_icon(icon, label = nil)
-    html = tag.i('', class: "bi-#{icon}")
-    html << ' ' << label if label
+    html = tag.i("", class: "bi-#{icon}")
+    html << " " << label if label
     html
   end
 
@@ -23,7 +22,7 @@ module ActionsHelper
   # Uses the current +entry+ if no path is given.
   def show_action_link(path = nil)
     path ||= path_args(entry)
-    action_link(ti('link.show'), 'zoom-in', path)
+    action_link(ti("link.show"), "zoom-in", path)
   end
 
   # Standard edit action to given path.
@@ -31,14 +30,14 @@ module ActionsHelper
   def edit_action_link(path = nil)
     path ||= path_args(entry)
     path = edit_polymorphic_path(path) unless path.is_a?(String)
-    action_link(ti('link.edit'), 'pencil', path)
+    action_link(ti("link.edit"), "pencil", path)
   end
 
   # Standard destroy action to the given path.
   # Uses the current +entry+ if no path is given.
   def destroy_action_link(path = nil)
     path ||= path_args(entry)
-    action_link(ti('link.delete'), 'trash', path,
+    action_link(ti("link.delete"), "trash", path,
                 data: { 'turbo-confirm': ti(:confirm_delete),
                         'turbo-method': :delete })
   end
@@ -48,7 +47,7 @@ module ActionsHelper
   def index_action_link(path = nil, url_options = { returning: true })
     path ||= path_args(model_class)
     path = polymorphic_path(path, url_options) unless path.is_a?(String)
-    action_link(ti('link.list'), 'list', path)
+    action_link(ti("link.list"), "list", path)
   end
 
   # Standard add action to given path.
@@ -56,7 +55,6 @@ module ActionsHelper
   def add_action_link(path = nil, url_options = {})
     path ||= path_args(model_class)
     path = new_polymorphic_path(path, url_options) unless path.is_a?(String)
-    action_link(ti('link.add'), 'plus', path)
+    action_link(ti("link.add"), "plus", path)
   end
-
 end

data/app/helpers/dry_crud/form/builder.rb

@@ -1,6 +1,5 @@
 module DryCrud
   module Form
-
     # A form builder that automatically selects the corresponding input field
     # for ActiveRecord column types. Convenience methods for each column type
     # allow one to customize the different fields.
@@ -14,7 +13,6 @@ module DryCrud
     # See the Control class for how to customize the html rendered for a
     # single input field.
     class Builder < ActionView::Helpers::FormBuilder
-
       class_attribute :control_class
       self.control_class = Control
 
@@ -70,10 +68,10 @@ module DryCrud
 
       # Render a boolean field.
       def boolean_field(attr, **html_options)
-        tag.div(class: 'checkbox') do
+        tag.div(class: "checkbox") do
           tag.label do
-            detail = html_options.delete(:detail) || '&nbsp;'.html_safe
-            safe_join([check_box(attr, html_options), ' ', detail])
+            detail = html_options.delete(:detail) || "&nbsp;".html_safe
+            safe_join([ check_box(attr, html_options), " ", detail ])
           end
         end
       end
@@ -82,7 +80,7 @@ module DryCrud
       %w[text_field password_field email_field
          number_field date_field time_field datetime_field].each do |method|
         define_method(method) do |attr, **html_options|
-          add_css_class(html_options, 'form-control')
+          add_css_class(html_options, "form-control")
           super(attr, html_options)
         end
       end
@@ -93,7 +91,7 @@ module DryCrud
       end
 
       def float_field(attr, **html_options)
-        html_options[:step] ||= 'any'
+        html_options[:step] ||= "any"
         number_field(attr, **html_options)
       end
 
@@ -105,9 +103,9 @@ module DryCrud
 
       # Customize the standard text area to have 5 rows by default.
       def text_area(attr, **html_options)
-        add_css_class(html_options, 'form-control')
+        add_css_class(html_options, "form-control")
         html_options[:rows] ||= 5
-        super(attr, **html_options)
+        super
       end
 
       # Render a select element for a :belongs_to association defined by attr.
@@ -118,7 +116,7 @@ module DryCrud
       def belongs_to_field(attr, **html_options)
         list = association_entries(attr, **html_options).to_a
         if list.present?
-          add_css_class(html_options, 'form-control')
+          add_css_class(html_options, "form-control")
           collection_select(attr, list, :id, :to_s,
                             select_options(attr, **html_options),
                             **html_options)
@@ -140,7 +138,7 @@ module DryCrud
       # association.
       def has_many_field(attr, **html_options)
         html_options[:multiple] = true
-        add_css_class(html_options, 'multiselect')
+        add_css_class(html_options, "multiselect")
         belongs_to_field(attr, **html_options)
       end
       # rubocop:enable Naming/PredicateName
@@ -149,46 +147,46 @@ module DryCrud
 
       # Render the error messages for the current form.
       def error_messages
-        @template.render('shared/error_messages',
+        @template.render("shared/error_messages",
                          errors: @object.errors,
                          object: @object)
       end
 
       # Renders the given content with an addon.
       def with_addon(content, addon)
-        tag.div(class: 'input-group') do
-          content + tag.span(addon, class: 'input-group-text')
+        tag.div(class: "input-group") do
+          content + tag.span(addon, class: "input-group-text")
         end
       end
 
       # Renders a static text where otherwise form inputs appear.
       def static_text(text)
-        tag.p(text, class: 'form-control-static')
+        tag.p(text, class: "form-control-static")
       end
 
       # Generates a help block for fields
       def help_block(text)
-        tag.p(text, class: 'help-block')
+        tag.p(text, class: "help-block")
       end
 
       # Render a submit button and a cancel link for this form.
-      def standard_actions(submit_label = ti('button.save'), cancel_url = nil)
-        tag.div(class: 'col-md-offset-2 col-md-8') do
-          safe_join([submit_button(submit_label),
-                     cancel_link(cancel_url)],
-                    ' ')
+      def standard_actions(submit_label = ti("button.save"), cancel_url = nil)
+        tag.div(class: "col-md-offset-2 col-md-8") do
+          safe_join([ submit_button(submit_label),
+                     cancel_link(cancel_url) ],
+                    " ")
         end
       end
 
       # Render a standard submit button with the given label.
-      def submit_button(label = ti('button.save'))
-        button(label, class: 'btn btn-primary', data: { disable_with: label })
+      def submit_button(label = ti("button.save"))
+        button(label, class: "btn btn-primary", data: { disable_with: label })
       end
 
       # Render a cancel link pointing to the given url.
       def cancel_link(url = nil)
         url ||= cancel_url
-        link_to(ti('button.cancel'), url, class: 'cancel')
+        link_to(ti("button.cancel"), url, class: "cancel")
       end
 
       # Depending if the given attribute must be present, return
@@ -265,7 +263,7 @@ module DryCrud
       # Checks if the passed name corresponds to a field method with a
       # 'labeled_' prefix.
       def labeled_field_method?(name)
-        prefix = 'labeled_'
+        prefix = "labeled_"
         if name.to_s.start_with?(prefix)
           field_method = name.to_s[prefix.size..]
           field_method if respond_to?(field_method)
@@ -321,7 +319,6 @@ module DryCrud
           options[:cancel_url_edit] || options[:cancel_url]
         end
       end
-
     end
   end
 end

data/app/helpers/dry_crud/form/control.rb

@@ -1,18 +1,16 @@
 module DryCrud
   module Form
-
     # Internal class to handle the rendering of a single form control,
     # consisting of a label, input field, addon, help text or
     # required mark.
     class Control
-
       attr_reader :builder, :attr, :args, :options, :addon, :help
 
       delegate :tag, :object, :add_css_class,
                to: :builder
 
       # Html displayed to mark an input as required.
-      REQUIRED_MARK = '*'.freeze
+      REQUIRED_MARK = "*".freeze
 
       # Number of default input field span columns depending
       # on the #field_method.
@@ -70,8 +68,8 @@ module DryCrud
 
       # Create the HTML markup for any labeled content.
       def labeled
-        tag.div(class: 'row mb-3') do
-          builder.label(attr, caption, class: 'col-md-2 col-form-label') +
+        tag.div(class: "row mb-3") do
+          builder.label(attr, caption, class: "col-md-2 col-form-label") +
             tag.div(content, class: "col-md-#{span}")
         end
       end
@@ -98,8 +96,8 @@ module DryCrud
       # depending on the attribute.
       def input
         @input ||= begin
-          options[:required] = 'required' if required
-          add_css_class(options, 'is-invalid') if errors?
+          options[:required] = "required" if required
+          add_css_class(options, "is-invalid") if errors?
           builder.send(field_method, attr, *args, **options)
         end
       end
@@ -143,9 +141,9 @@ module DryCrud
           :belongs_to_field
         elsif association_kind?(:has_and_belongs_to_many, :has_many)
           :has_many_field
-        elsif attr.to_s.include?('password')
+        elsif attr.to_s.include?("password")
           :password_field
-        elsif attr.to_s.include?('email')
+        elsif attr.to_s.include?("email")
           :email_field
         elsif builder.respond_to?(:"#{type}_field")
           :"#{type}_field"
@@ -170,8 +168,6 @@ module DryCrud
           false
         end
       end
-
     end
-
   end
 end