compony 0.4.0 → 0.4.1

data/doc/method_list.html

@@ -221,6 +221,14 @@
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Compony/Component.html#comp_cst-class_method" title="Compony::Component.comp_cst (method)">comp_cst</a></span>
+      <small>Compony::Component</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Compony/Component.html#comp_cst-instance_method" title="Compony::Component#comp_cst (method)">#comp_cst</a></span>
       <small>Compony::Component</small>
@@ -228,6 +236,14 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Compony/Component.html#comp_name-class_method" title="Compony::Component.comp_name (method)">comp_name</a></span>
+      <small>Compony::Component</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Compony/Component.html#comp_name-instance_method" title="Compony::Component#comp_name (method)">#comp_name</a></span>
@@ -397,6 +413,14 @@
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Compony/Component.html#family_cst-class_method" title="Compony::Component.family_cst (method)">family_cst</a></span>
+      <small>Compony::Component</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Compony/Component.html#family_cst-instance_method" title="Compony::Component#family_cst (method)">#family_cst</a></span>
       <small>Compony::Component</small>
@@ -404,6 +428,14 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Compony/Component.html#family_name-class_method" title="Compony::Component.family_name (method)">family_name</a></span>
+      <small>Compony::Component</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Compony/Component.html#family_name-instance_method" title="Compony::Component#family_name (method)">#family_name</a></span>

data/doc/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jun 11 11:15:53 2024 by
+  Generated on Thu Sep 12 16:31:18 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.36 (ruby-3.2.2).
 </div>

data/lib/compony/component.rb

@@ -20,6 +20,26 @@ module Compony
       setup_blocks << block
     end
 
+    # Returns the name of the module constant (=family) of this component. Do not override.
+    def self.family_cst
+      module_parent.to_s.demodulize.to_sym
+    end
+
+    # Returns the family name
+    def self.family_name
+      family_cst.to_s.underscore
+    end
+
+    # Returns the name of the class constant of this component. Do not override.
+    def self.comp_cst
+      name.demodulize.to_sym
+    end
+
+    # Returns the component name
+    def self.comp_name
+      comp_cst.to_s.underscore
+    end
+
     def initialize(parent_comp = nil, index: 0, **comp_opts)
       @parent_comp = parent_comp
       @sub_comps = []
@@ -94,22 +114,22 @@ module Compony
 
     # Returns the name of the module constant (=family) of this component. Do not override.
     def family_cst
-      self.class.module_parent.to_s.demodulize.to_sym
+      self.class.family_cst
     end
 
     # Returns the family name
     def family_name
-      family_cst.to_s.underscore
+      self.class.family_name
     end
 
     # Returns the name of the class constant of this component. Do not override.
     def comp_cst
-      self.class.name.demodulize.to_sym
+      self.class.comp_cst
     end
 
     # Returns the component name
     def comp_name
-      comp_cst.to_s.underscore
+      self.class.comp_name
     end
 
     # DSL method

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

@@ -108,13 +108,13 @@ module Compony
         # To have a component listen to multiple paths, call standalone again and provide a name, e.g.: standalone(:autocomplete, path: 'foo/bar/autocomplete')
         # The kwarg parameter `path` is handled analog to the Rails route path
         # @param name [Symbol,nil] The name of the standalone config, defaults to nil. Only provide if you add additional configs.
-        def standalone(name = nil, *args, **nargs, &block)
+        def standalone(name = nil, *, **nargs, &block)
           block = proc {} unless block_given? # If called without a block, must default to an empty block to provide a binding to the DSL.
           name = name&.to_sym # nil name is the most common case
           if @standalone_configs[name]
-            @standalone_configs[name].deep_merge! StandaloneDsl.new(self, name, *args, provide_defaults: false, **nargs).to_conf(&block)
+            @standalone_configs[name].deep_merge! StandaloneDsl.new(self, name, *, provide_defaults: false, **nargs).to_conf(&block)
           else
-            @standalone_configs[name] = Compony::MethodAccessibleHash.new(StandaloneDsl.new(self, name, *args, provide_defaults: true, **nargs).to_conf(&block))
+            @standalone_configs[name] = Compony::MethodAccessibleHash.new(StandaloneDsl.new(self, name, *, provide_defaults: true, **nargs).to_conf(&block))
           end
         end
 

data/lib/compony/component_mixins/resourceful.rb

@@ -15,14 +15,14 @@ module Compony
       attr_reader :global_after_assign_attributes_block
       attr_reader :global_store_data_block
 
-      def initialize(*args, data: nil, data_class: nil, **nargs, &block)
+      def initialize(*, data: nil, data_class: nil, **nargs, &)
         @data = data
         @data_class = data_class
 
         # Provide defaults for hook blocks
         @global_load_data_block ||= proc { @data = self.data_class.find(controller.params[:id]) }
 
-        super(*args, **nargs, &block)
+        super(*, **nargs, &)
       end
 
       # DSL method

data/lib/compony/components/button.rb

@@ -7,7 +7,7 @@ module Compony
 
       # path: If given a block, it will be evaluated in the helpers context when rendering
       # enabled: If given a block, it will be evaluated in the helpers context when rendering
-      def initialize(*args, label: nil, path: nil, method: nil, type: nil, enabled: nil, visible: nil, title: nil, **kwargs, &block)
+      def initialize(*, label: nil, path: nil, method: nil, type: nil, enabled: nil, visible: nil, title: nil, **, &)
         @label = label || Compony.button_defaults[:label]
         @type = type&.to_sym || Compony.button_defaults[:type] || :button
         @path = path || Compony.button_defaults[:path] || 'javascript:void(0)'
@@ -26,7 +26,7 @@ module Compony
 
         fail "Unsupported button type #{@type}, use on of: #{SUPPORTED_TYPES.inspect}" unless SUPPORTED_TYPES.include?(@type)
 
-        super(*args, **kwargs, &block)
+        super(*, **, &)
       end
 
       setup do

data/lib/compony/model_fields/attachment.rb

@@ -12,7 +12,7 @@ module Compony
       end
 
       def simpleform_input(form, _component, name: nil, accept: nil, **input_opts)
-        input_opts.merge!(input_html: { accept: }) if accept
+        input_opts.deep_merge!(input_html: { accept: }) if accept
         return form.input(name || @name, **input_opts)
       end
     end

data/lib/compony.rb

@@ -96,17 +96,19 @@ module Compony
 
   # Generates a Rails path to a component. Examples: `Compony.path(:index, :users)`, `Compony.path(:show, User.first)`
   # @param comp_name_or_cst [String,Symbol] The component that should be loaded, for instance `ShowForAll`, `'ShowForAll'` or `:show_for_all`
+  #                         or can also pass a component class (such as Components::Users::Show)
   # @param model_or_family_name_or_cst [String,Symbol,ApplicationRecord] Either the family that contains the requested component,
   #                                    or an instance implementing `model_name` from which the family name is auto-generated. Examples:
   #                                    `Users`, `'Users'`, `:users`, `User.first`
+  # @param standalone_name [Symbol,nil] Name of the standalone config to point to (defaults to nil the default standalone config).
   # @param args_for_path_helper [Array] Positional arguments passed to the Rails helper
   # @param kwargs_for_path_helper [Hash] Named arguments passed to the Rails helper. If a model is given to `model_or_family_name_or_cst`,
   #                                      the param `id` defaults to the passed model's ID.
-  def self.path(comp_name_or_cst, model_or_family_name_or_cst, *args_for_path_helper, **kwargs_for_path_helper)
+  def self.path(comp_name_or_cst, model_or_family_name_or_cst = nil, *args_for_path_helper, standalone_name: nil, **kwargs_for_path_helper)
     # Extract model if any, to get the ID
     kwargs_for_path_helper.merge!(id: model_or_family_name_or_cst.id) if model_or_family_name_or_cst.respond_to?(:model_name)
     return Rails.application.routes.url_helpers.send(
-      "#{path_helper_name(comp_name_or_cst, model_or_family_name_or_cst)}_path",
+      "#{path_helper_name(comp_name_or_cst, model_or_family_name_or_cst, standalone_name&.to_sym)}_path",
       *args_for_path_helper,
       **kwargs_for_path_helper
     )
@@ -143,18 +145,23 @@ module Compony
     "#{rails_action_name(...)}_comp"
   end
 
-  # Given a component and a family, this returns the name of the ComponyController action for this component.<br>
+  # Given a component and a family or a component class, this returns the name of the ComponyController action for this component.<br>
   # Optionally can pass a name for extra standalone configs.
   # @param comp_name_or_cst [String,Symbol] Name of the component the action points to.
   # @param model_or_family_name_or_cst [String,Symbol] Name of the family the action points to.
   # @param name [String,Symbol] If referring to an extra standalone entrypoint, specify its name using this param.
   # @see Compony#path
-  def self.rails_action_name(comp_name_or_cst, model_or_family_name_or_cst, name = nil)
-    [name.presence, comp_name_or_cst.to_s.underscore, family_name_for(model_or_family_name_or_cst)].compact.join('_')
+  def self.rails_action_name(comp_name_or_cst_or_class, model_or_family_name_or_cst, name = nil)
+    if comp_name_or_cst_or_class.is_a?(Class) && (comp_name_or_cst_or_class <= Compony::Component)
+      comp_class = comp_name_or_cst_or_class
+      comp_name_or_cst_or_class = comp_class.comp_name
+      model_or_family_name_or_cst = comp_class.family_name
+    end
+    [name.presence, comp_name_or_cst_or_class.to_s.underscore, family_name_for(model_or_family_name_or_cst)].compact.join('_')
   end
 
   # Given a component and a family/model, this instanciates and returns a button component.
-  # @param comp_name_or_cst [String,Symbol] The component that should be loaded, for instance `ShowForAll`, `'ShowForAll'` or `:show_for_all`
+  # @param comp_name_or_cst_or_class [String,Symbol,Class] The component that should be loaded, for instance `ShowForAll`, `'ShowForAll'` or `:show_for_all`
   # @param model_or_family_name_or_cst [String,Symbol,ApplicationRecord] Either the family that contains the requested component,
   #                                    or an instance implementing `model_name` from which the family name is auto-generated. Examples:
   #                                    `Users`, `'Users'`, `:users`, `User.first`
@@ -162,28 +169,34 @@ module Compony
   # @param params [Hash] GET parameters to be inclued into the path this button points to. Special case: e.g. format: :pdf -> some.url/foo/bar.pdf
   # @param feasibility_action [Symbol] Name of the feasibility action that should be checked for this button, defaults to the component name
   # @param feasibility_target [Symbol] Name of the feasibility target (subject) that the feasibility should be checked on, defaults to the model if given
+  # @param standalone_name [Symbol,nil] Name of the standalone config to point to (defaults to nil the default standalone config).
   # @param override_kwargs [Hash] Override button options, see options for {Compony::Components::Button}
   # @see Compony::ViewHelpers#compony_button View helper providing a wrapper for this method that immediately renders a button.
   # @see Compony::Components::Button Compony::Components::Button: the default underlying implementation
-  def self.button(comp_name_or_cst,
-                  model_or_family_name_or_cst,
+  def self.button(comp_name_or_cst_or_class,
+                  model_or_family_name_or_cst = nil,
                   label_opts: nil,
                   params: nil,
                   feasibility_action: nil,
                   feasibility_target: nil,
                   method: nil,
+                  standalone_name: nil,
                   **override_kwargs)
     label_opts ||= button_defaults[:label_opts] || {}
     params ||= button_defaults[:params] || {}
     model = model_or_family_name_or_cst.respond_to?(:model_name) ? model_or_family_name_or_cst : nil
-    target_comp_instance = Compony.comp_class_for!(comp_name_or_cst, model_or_family_name_or_cst).new(data: model)
-    feasibility_action ||= button_defaults[:feasibility_action] || comp_name_or_cst.to_s.underscore.to_sym
+    if comp_name_or_cst_or_class.is_a?(Class) && (comp_name_or_cst_or_class <= Compony::Component)
+      target_comp_instance = comp_name_or_cst_or_class.new(data: model)
+    else
+      target_comp_instance = Compony.comp_class_for!(comp_name_or_cst_or_class, model_or_family_name_or_cst).new(data: model)
+    end
+    feasibility_action ||= button_defaults[:feasibility_action] || comp_name_or_cst_or_class.to_s.underscore.to_sym
     feasibility_target ||= button_defaults[:feasibility_target] || model
     options = {
       label:   target_comp_instance.label(model, **label_opts),
       icon:    target_comp_instance.icon,
       color:   target_comp_instance.color,
-      path:    Compony.path(target_comp_instance.comp_name, target_comp_instance.family_name, model, **params),
+      path:    Compony.path(target_comp_instance.comp_name, target_comp_instance.family_name, model, standalone_name:, **params),
       method:,
       visible: ->(controller) { target_comp_instance.standalone_access_permitted_for?(controller, verb: method) }
     }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compony
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Sandro Kalbermatter
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -330,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Compony is a Gem that allows you to write your Rails application in component-style