compony 0.9.0 → 0.10.0

data/doc/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Nov 28 12:38:44 2025 by
+  Generated on Mon Dec  8 15:19:19 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.3.5).
 </div>

data/lib/compony/component.rb

@@ -223,7 +223,7 @@ module Compony
         # Build the declared intents
         return @exposed_intents if @exposed_intents
         @exposed_intents = NaturalOrdering.new
-        @exposed_intent_blocks.each { |block| ExposedIntentsDsl.new(@exposed_intents).evaluate(&block) } # alters @exposed_intents
+        @exposed_intent_blocks.each { |block| ManageIntentsDsl.new(@exposed_intents).evaluate(&block) } # alters @exposed_intents
         return @exposed_intents.map!(&:payload)
       end
     end

data/lib/compony/component_mixins/default/labelling.rb

@@ -53,23 +53,35 @@ module Compony
           end
         end
 
-        # DSL method and accessor for an icon.
-        # While this is not used in Compony directly, this is useful if your front-end uses an icon library such as fontawesome.
-        def icon(&block)
-          if block_given?
-            @icon_block = block
-          else
-            @icon_block.call
-          end
+        # DSL method
+        # Defines defaults for intents when rendering buttons. Just like in {label}, the block may be given a resource.
+        # @param [Symbol] keyword The name of the keyword that should be given to the button by the intent if not overwritten
+        # @param [Proc] block The block that, when called in the context of the component while rendering, returns the value for the arg given to the button.
+        # @see {Compony::Component#button_defaults}
+        def button(keyword, &block)
+          fail("Please pass a block to `button` in #{inspect}.") unless block_given?
+          @button_blocks ||= {}
+          @button_blocks[keyword.to_sym] = block
         end
 
-        # DSL method and accessor
-        # While this is not used in Compony directly, this is useful if you use a custom button component class that supports colors.
-        def color(&block)
-          if block_given?
-            @color_block = block
-          else
-            @color_block.call
+        # Executes and retrieves the button blocks
+        # If this component is resourceful, give the block the resource. Expect the arity to match.
+        # @param resource Pass the resource if and only if the component is resourceful.
+        def button_defaults(resource = nil)
+          return @button_blocks.to_h do |keyword, block|
+            value = case block.arity
+                    when 0
+                      block.call
+                    when 1
+                      resource ||= data
+                      if resource.blank?
+                        fail("Button block #{keyword.inspect} of #{inspect} takes a resource, but none was provided and a call to `data` did not return any.")
+                      end
+                      block.call(resource)
+                    else
+                      fail "#{inspect} has a button block #{keyword.inspect} that takes 2 or more arguments, which is unsupported."
+                    end
+            next [keyword, value]
           end
         end
 
@@ -81,8 +93,7 @@ module Compony
             long:  -> { "#{I18n.t(family_name.humanize)}: #{I18n.t(comp_name.humanize)}" },
             short: -> { I18n.t(comp_name.humanize) }
           }
-          @icon_block = -> { :'arrow-right' }
-          @color_block = -> { :primary }
+          @button_blocks = {}
         end
       end
     end

data/lib/compony/components/destroy.rb

@@ -23,8 +23,6 @@ module Compony
 
         label(:long) { |data| I18n.t('compony.components.destroy.label.long', data_label: data.label) }
         label(:short) { |_| I18n.t('compony.components.destroy.label.short') }
-        icon { :trash }
-        color { :danger }
 
         content :confirm_question, hidden: true do
           div I18n.t('compony.components.destroy.confirm_question', data_label: @data.label)
@@ -47,9 +45,8 @@ module Compony
         exposed_intents do
           if data_class.owner_model_attr
             add :show, @data.send(data_class.owner_model_attr),
-                button: { icon: :xmark, color: :secondary },
-                label:  I18n.t('compony.cancel'),
-                name:   :back_to_owner
+                label: I18n.t('compony.cancel'),
+                name:  :back_to_owner
           end
         end
 

data/lib/compony/components/edit.rb

@@ -29,16 +29,14 @@ module Compony
 
         label(:long) { |data| I18n.t('compony.components.edit.label.long', data_label: data.label) }
         label(:short) { |_| I18n.t('compony.components.edit.label.short') }
-        icon { :pencil }
 
         form_cancancan_action :edit
 
         exposed_intents do
           if data_class.owner_model_attr
             add :show, @data.send(data_class.owner_model_attr),
-                button: { icon: :xmark, color: :secondary },
-                label:  I18n.t('compony.cancel'),
-                name:   :back_to_owner
+                label: I18n.t('compony.cancel'),
+                name:  :back_to_owner
           end
         end
 

data/lib/compony/components/form.rb

@@ -28,7 +28,6 @@ module Compony
           # Fake submit button rendered by a button component and submitting the form via JS:
           concat Compony.button_component_class.new(
             label:   @submit_label || I18n.t('compony.components.form.submit'),
-            icon:    'arrow-right',
             href:    '#',
             onclick: "this.closest('form').requestSubmit(); return false;"
           ).render(controller)

data/lib/compony/components/index.rb

@@ -19,7 +19,7 @@ module Compony
         end
 
         exposed_intents do
-          if Compony.comp_class_for(:new, data_class)
+          unless data_class.owner_model_attr
             add :new, data_class.model_name.plural, name: :new
           end
         end

data/lib/compony/components/list.rb

@@ -25,19 +25,25 @@ module Compony
                      skip_sorting_in_filter: false,
                      skip_sorting_links: false,
                      skip_columns: [],
-                     skip_row_actions: [],
+                     skip_row_intents: [],
                      skip_filters: [],
                      default_sorting: 'id asc',
                      **)
-        @pagination = !skip_pagination
+        @pagination = true
+        @skip_pagination = !!skip_pagination
         @results_per_page = results_per_page
-        @filtering = !skip_filtering
-        @sorting_in_filter = !skip_sorting && !skip_sorting_in_filter
-        @sorting_links = !skip_sorting && !skip_sorting_links
+        @filtering = true
+        @skip_filtering = !!skip_filtering
+        @sorting = true
+        @sorting_in_filter = true
+        @sorting_links = true
+        @skip_sorting_in_filter = !!skip_sorting || !!skip_sorting_in_filter
+        @skip_sorting_links = !!skip_sorting || !!skip_sorting_links
         @columns = Compony::NaturalOrdering.new
-        @row_actions = Compony::NaturalOrdering.new
+        @row_intent_blocks = []
         @skipped_columns = skip_columns.map(&:to_sym)
-        @skipped_row_actions = skip_row_actions.map(&:to_sym)
+        @skipped_row_intents = skip_row_intents.is_a?(Enumerable) ? skip_row_intents.map(&:to_sym) : []
+        @skip_row_intents = skip_row_intents.is_a?(TrueClass)
         @filters = Compony::NaturalOrdering.new
         @sorts = Compony::NaturalOrdering.new
         @skipped_filters = skip_filters.map(&:to_sym)
@@ -50,9 +56,9 @@ module Compony
       end
 
       # DSL method
-      # Disables pagination (caution: all records will be loaded).
-      def skip_pagination!
-        @pagination = false
+      # Enables or disables pagination (caution: all records will be loaded).
+      def pagination(new_pagination)
+        @pagination = !!new_pagination
       end
 
       # DSL method
@@ -62,28 +68,28 @@ module Compony
       end
 
       # DSL method
-      # Disables filtering entirely (sorting is independent of this setting).
-      def skip_filtering!
-        @filtering = false
+      # Enables or disables filtering entirely (sorting is independent of this setting).
+      def filtering(new_filtering)
+        @filtering = !!new_filtering
       end
 
       # DSL method
-      # Disables sorting entirely (both links and sorting input in filter).
-      def skip_sorting!
-        @sorting_in_filter = false
-        @sorting_links = false
+      # Enables or disables sorting entirely (both links and sorting input in filter).
+      def sorting(new_sorting)
+        @sorting_in_filter = !!new_sorting
+        @sorting_links = !!new_sorting
       end
 
       # DSL method
-      # Disables sorting in filter.
-      def skip_sorting_in_filter!
-        @sorting_in_filter = false
+      # Enables or disables sorting in filter.
+      def sorting_in_filter(new_sorting_in_filter)
+        @sorting_in_filter = !!new_sorting_in_filter
       end
 
       # DSL method
-      # Disables sorting links.
-      def skip_sorting_links!
-        @sorting_links = false
+      # Enables or disables sorting links.
+      def sorting_links(new_sorting_links)
+        @sorting_links = !!new_sorting_links
       end
 
       # DSL method
@@ -157,28 +163,18 @@ module Compony
       end
 
       # DSL method
-      # Adds a row action. The very last col provides actions such as :show, :edit or :destroy. Use this method to add your own.
-      # In case the action exists as a component in the family of `data_class`, it is enough to pass the action's name, and the rest is auto-generated.
-      # In order to create a custom row action, pass a block that will be given the current record and instance-execed once per row, for every record.
-      # @param name [Symbol, String] The name of the action (e.g. :edit).
-      # @param button_opts [Hash] Only relevant in case of an auto-generated row action, this allows to configure the generated button.
-      # @param block [Block] To create a custom row action; block will be given the current record and instance-execed once per row, for every record.
-      def row_action(name, button_opts: {}, **, &block)
-        name = name.to_sym
-        unless block_given?
-          block = proc do |record|
-            next if Compony.comp_class_for(name, record).nil?
-            render_intent(name, record, **{ label: { format: :short } }.deep_merge(button_opts))
-          end
+      # If a block is given: Enters the DSL where row intents can be added or removed (use from {Component#setup} within the component).
+      # If no block is given: Builds the declared intents for the given record and returns them (use in `content` or `before_render`, pass kwarg `:data`).
+      def row_intents(**intent_opts, &block)
+        if block_given?
+          # Enter DSL
+          @row_intent_blocks << block
+        else
+          # Build the declared intents
+          intents_ordering = NaturalOrdering.new
+          @row_intent_blocks.each { |block| ManageIntentsDsl.new(intents_ordering, **intent_opts).evaluate(&block) } # this populates intents_ordering
+          return intents_ordering.map!(&:payload)
         end
-        @row_actions.natural_push(name, block, **)
-      end
-
-      # DSL method
-      # Marks a single row action as skipped. It will not be displayed, even if it is defined.
-      # @param name [Symbol,String] Name of the row action to be skipped.
-      def skip_row_action(name)
-        @skipped_row_actions << name.to_sym
       end
 
       # DSL method
@@ -237,7 +233,7 @@ module Compony
       def process_data!(controller)
         fail('Data was already processed!') if @processed_data
         # Filtering
-        if filtering_enabled?
+        if filtering_enabled? || sorting_enabled?
           @q = @data.ransack(controller.params[param_name(:q)], auth_object: controller.current_ability, search_key: param_name(:q))
           @q.sorts = @default_sorting if @q.sorts.empty?
           filtered_data = @q.result.accessible_by(controller.current_ability)
@@ -274,10 +270,12 @@ module Compony
           @data = data_class.accessible_by(controller.current_ability)
         end
 
-        # Default row actions (use override or skip_row_action to prevent)
-        row_action(:show)
-        row_action(:edit)
-        row_action(:destroy)
+        # Default row intents
+        row_intents do
+          add :show, name: :show
+          add :edit, name: :edit
+          add :destroy, name: :destroy
+        end
 
         before_render do
           process_data!(controller)
@@ -336,7 +334,7 @@ module Compony
                 @columns.each do |column|
                   th column[:label], class: 'list-data-label'
                 end
-                if @row_actions.any? { |row_action| @skipped_row_actions.exclude?(row_action[:name]) }
+                unless @skip_row_intents
                   th I18n.t('compony.components.index.actions'), class: 'list-actions-label'
                 end
               end
@@ -349,14 +347,11 @@ module Compony
                       instance_exec(record, &column[:payload])
                     end
                   end
-                  rendered_row_actions = @row_actions.map do |row_action|
-                    next if @skipped_row_actions.include?(row_action[:name])
-                    next instance_exec(record, &row_action[:payload])
-                  end.compact
-                  if rendered_row_actions.any?
+                  unless @skip_row_intents
                     td do
-                      rendered_row_actions.each do |row_action_html|
-                        concat row_action_html if row_action_html
+                      row_intents(data: record, label: { format: :short }, button: { data: { 'turbo-frame': :_top } }).each do |row_intent|
+                        next if @skipped_row_intents.include?(row_intent.name)
+                        concat row_intent.render(controller)
                       end
                     end
                   end
@@ -390,27 +385,27 @@ module Compony
 
       # Returns whether filtering is possible and wanted in general (regardless of whether there are any filters defined)
       def filtering_enabled?
-        @filtering && defined?(Ransack)
+        @filtering && defined?(Ransack) && !@skip_filtering
       end
 
       # Returns whether sorting is possible and wanted in general (regardless of whether there are any sorts defined)
       def sorting_enabled?
-        (@sorting_in_filter || @sorting_links) && defined?(Ransack)
+        ((@sorting_in_filter && !@skip_sorting_in_filter) || (@sorting_links && !@skip_sorting_links)) && defined?(Ransack)
       end
 
       # Returns whether sorting in filter is possible and wanted in general (regardless of whether there are any sorts defined)
       def sorting_in_filter_enabled?
-        sorting_enabled? && @sorting_in_filter
+        sorting_enabled? && @sorting_in_filter && !@skip_sorting_in_filter
       end
 
       # Returns whether generating sorting links is possible and wanted in general (regardless of whether there are any sorts defined)
       def sorting_links_enabled?
-        sorting_enabled? && @sorting_links
+        sorting_enabled? && @sorting_links && !@skip_sorting_links
       end
 
       # Returns whether pagination is enabled (regardless of whether there is more than one page)
       def pagination_enabled?
-        @pagination
+        @pagination && !@skip_pagination
       end
 
       # Returns the select options for sorting suitable for passing in a `f.select`. Used in sorting-in-filter feature. Useful for custom subclasses of List.

data/lib/compony/components/new.rb

@@ -30,7 +30,6 @@ module Compony
 
         label(:long) { I18n.t('compony.components.new.label.long', data_class: data_class.model_name.human) }
         label(:short) { I18n.t('compony.components.new.label.short') }
-        icon { :plus }
 
         form_cancancan_action :new
 

data/lib/compony/components/show.rb

@@ -14,23 +14,16 @@ module Compony
 
         label(:long) { |data| data.label } # rubocop:disable Style/SymbolProc
         label(:short) { |_| I18n.t('compony.components.show.label.short') }
-        icon { :eye }
 
         exposed_intents do
           if data_class.owner_model_attr
             add :show, @data.send(data_class.owner_model_attr),
-                button: { icon: :xmark, color: :secondary },
-                label:  I18n.t('compony.back'),
-                name:   :back_to_owner
+                label: I18n.t('compony.back'),
+                name:  :back_to_owner
           end
 
-          if Compony.comp_class_for(:edit, family_name)
-            add :edit, @data, label: { format: :short }, name: :edit
-          end
-
-          if Compony.comp_class_for(:destroy, family_name)
-            add :destroy, @data, label: { format: :short }, name: :destroy
-          end
+          add :edit, @data, label: { format: :short }, name: :edit
+          add :destroy, @data, label: { format: :short }, name: :destroy
         end
 
         content :label do

data/lib/compony/intent.rb

@@ -23,7 +23,7 @@ module Compony
     # @param data_class [Class] If given, the target component will be instanciated with this argument.
     # @param feasibility_target [ApplicationRecord] If given, will override the feasibility target (prevention framework)
     # @param feasibility_action [ApplicationRecord] If given, will override the feasibility action (prevention framework)
-    def initialize(comp_name_or_cst_or_class,
+    def initialize(comp_name_or_cst_or_class = nil,
                    model_or_family_name_or_cst = nil,
                    standalone_name: nil,
                    name: nil,
@@ -42,7 +42,11 @@ module Compony
       @data_class = data_class
 
       # Figure out comp_class
-      if comp_name_or_cst_or_class.is_a?(Class) && (comp_name_or_cst_or_class <= Compony::Component)
+      if comp_name_or_cst_or_class.nil?
+        if name.blank? || !label.is_a?(String)
+          fail('An intent created without positional arguments must be given the kwargs `name:`, `label` (String).')
+        end
+      elsif comp_name_or_cst_or_class.is_a?(Class) && (comp_name_or_cst_or_class <= Compony::Component)
         # A class was given as the first argument
         @comp_class = comp_name_or_cst_or_class
       else
@@ -75,6 +79,7 @@ module Compony
     # Instanciates the component and returns the instance. If `data` and/or `data_class` were specified when instantiating this intent, they are passed.
     # All given arguments will be given to the component's initializer, also overriding `data` and `data_class` if present.
     def comp(*, **)
+      return nil if @comp_class.nil?
       return @comp ||= @comp_class.new(*, data: @data, data_class: @data_class, **)
     end
 
@@ -83,6 +88,7 @@ module Compony
     # @param model [ApplicationRecord] If given and non-nil, will override the model passed to the component's path block
     # @param standalone_name [Symbol] If given and non-nil, will override the `standalone_name` passed to the component's path block
     def path(model = nil, *, standalone_name: nil, **path_opt_overrides)
+      return nil if @comp_class.nil?
       path_opts = @path_opts.deep_merge(path_opt_overrides)
       comp.path(model || (model? ? @data : nil), standalone_name: standalone_name || @standalone_name, **path_opts)
     end
@@ -135,10 +141,10 @@ module Compony
     # @param button_arg_overrides [Hash] Any further kwargs are passed to the button component's initializer.
     def render(controller, parent_comp = nil, style: nil, **button_arg_overrides)
       # Abort if not authorized
-      return nil unless comp.standalone_access_permitted_for?(controller, standalone_name: @standalone_name, verb: method)
+      return nil if comp && !comp.standalone_access_permitted_for?(controller, standalone_name: @standalone_name, verb: method)
       # Prepare opts
       button_comp_class ||= Compony.button_component_class(*[style || @style].compact)
-      button_opts = button_comp_opts.merge(button_arg_overrides)
+      button_opts = (comp&.button_defaults || {}).merge(button_comp_opts).merge(button_arg_overrides) # overrides go right to left
       # Perform render
       if parent_comp
         return parent_comp.sub_comp(button_comp_class, **button_opts).render(controller)

data/lib/compony/{exposed_intents_dsl.rb → manage_intents_dsl.rb}

@@ -1,8 +1,9 @@
 module Compony
-  class ExposedIntentsDsl < Dslblend::Base
-    def initialize(previously_exposed_intents)
+  class ManageIntentsDsl < Dslblend::Base
+    def initialize(previously_exposed_intents, **intent_opts)
       super()
       @exposed_intents = previously_exposed_intents
+      @intent_opts = intent_opts
     end
 
     protected
@@ -12,8 +13,10 @@ module Compony
     # Intents specified this way can be retrieved and rendered by the parent component or by calling `root_intents` in case of standalone access.
     # @param [Symbol] before If specified, will insert the intent before the other.  When replacing, an element keeps its position unless `before:`` is passed.
     def add(*, before: nil, **)
-      intent = Compony.intent(*, **)
+      intent = Compony.intent(*, **@intent_opts, **)
       @exposed_intents.natural_push(intent.name, intent, before:)
+    rescue NameError # Ignore if the component is not actually defined
+      return nil
     end
 
     # DSL method

data/lib/compony/model_mixin.rb

@@ -71,7 +71,7 @@ module Compony
         return if autodetect_feasibilities_completed
         # Add a prevention that reflects the `has_many` `dependent' properties. Avoids that users can press buttons that will result in a failed destroy.
         reflect_on_all_associations.select { |assoc| %i[restrict_with_exception restrict_with_error].include? assoc.options[:dependent] }.each do |assoc|
-          prevent(:destroy, I18n.t('compony.feasibility.has_dependent_models', dependent_class: I18n.t(assoc.klass.humanize_class_name.pluralize))) do
+          prevent(:destroy, I18n.t('compony.feasibility.has_dependent_models', dependent_class: assoc.klass.model_name.human(count: 2))) do
             if assoc.is_a? ActiveRecord::Reflection::HasOneReflection
               !public_send(assoc.name).nil?
             else

data/lib/compony/request_context.rb

@@ -78,9 +78,16 @@ module Compony
     end
 
     # View helper that instanciates a sub comp and renders it.
-    # Example usage: `concat render_sub_comp(Components::Something::Nested)`
-    def render_sub_comp(...)
-      sub_comp(...).render(controller)
+    # Example usage: `concat render_sub_comp(:list, @data.belongings)`
+    # If the parameter `turbo_frame` is given, the sub comp is rendered inside a hotwire turbo frame. This is useful when having forms in multiple nested comps.
+    def render_sub_comp(*, turbo_frame: nil, **)
+      if turbo_frame
+        turbo_frame_tag(turbo_frame.to_sym) do
+          concat sub_comp(*, **).render(controller)
+        end
+      else
+        sub_comp(*, **).render(controller)
+      end
     end
   end
 end

data/lib/compony.rb

@@ -147,9 +147,9 @@ module Compony
   # Same as Compony#comp_class_for but fails if none found
   # @see Intent for allowed parameters.
   # @see Compony#comp_class_for
-  def self.comp_class_for!(...)
-    comp_class_for(...) || fail(
-      "No component found for [#{comp_name_or_cst.inspect}, #{model_or_family_name_or_cst.inspect}]"
+  def self.comp_class_for!(*args, **kwargs)
+    comp_class_for(*args, **kwargs) || fail(
+      "No component found for #{args.inspect}, #{kwargs.inspect}"
     )
   end
 
@@ -218,7 +218,7 @@ require 'compony/component_mixins/default/standalone/verb_dsl'
 require 'compony/component_mixins/default/standalone/resourceful_verb_dsl'
 require 'compony/component_mixins/default/labelling'
 require 'compony/component_mixins/resourceful'
-require 'compony/exposed_intents_dsl'
+require 'compony/manage_intents_dsl'
 require 'compony/component'
 require 'compony/components/buttons/link'
 require 'compony/components/buttons/css_button'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compony
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Sandro Kalbermatter
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-28 00:00:00.000000000 Z
+date: 2025-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -312,8 +312,8 @@ files:
 - lib/compony/components/with_form.rb
 - lib/compony/controller_mixin.rb
 - lib/compony/engine.rb
-- lib/compony/exposed_intents_dsl.rb
 - lib/compony/intent.rb
+- lib/compony/manage_intents_dsl.rb
 - lib/compony/method_accessible_hash.rb
 - lib/compony/model_fields/anchormodel.rb
 - lib/compony/model_fields/association.rb