compony 0.3.0 → 0.3.2

data/doc/file.README.html

@@ -555,6 +555,15 @@
 <pre class="code ruby"><code class="ruby">&lt;div class=&quot;card card-body&quot;&gt;&lt;h1&gt;Hello&lt;/h1&gt;&lt;p&gt;Welcome to my site.&lt;/p&gt;&lt;/div&gt;
 </code></pre>
 
+<h5 id="label-Removing+content+blocks">Removing content blocks</h5>
+
+<p>If a component’s parent class defines a content block that is undesired in a subclass component, the content block can be removed as follows:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_setup'>setup</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_remove_content'>remove_content</span> <span class='symbol'>:some_content_defined_in_parent</span> <span class='comment'># This component will now behave as if this content block was never declared in its parent.
+</span><span class='kw'>end</span>
+</code></pre>
+
 <h4 id="label-Redirecting+away+-2F+Intercepting+rendering">Redirecting away / Intercepting rendering</h4>
 
 <p>Immediately before the <code>content</code> block(s) are evaluated, another chain of blocks is evaluated if present: <code>before_render</code>. If on of these blocks creates a reponse body in the Rails controller, the subsequent <code>before_render</code> blocks and all <code>content</code> blocks are skipped.</p>
@@ -1612,7 +1621,7 @@ my_button = Compony.button(:index, :users, enabled: -&gt; { |controller| control
 </div></div>
 
       <div id="footer">
-  Generated on Wed May 29 15:53:00 2024 by
+  Generated on Sat Jun  1 14:22:42 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.2.2).
 </div>

data/doc/index.html

@@ -555,6 +555,15 @@
 <pre class="code ruby"><code class="ruby">&lt;div class=&quot;card card-body&quot;&gt;&lt;h1&gt;Hello&lt;/h1&gt;&lt;p&gt;Welcome to my site.&lt;/p&gt;&lt;/div&gt;
 </code></pre>
 
+<h5 id="label-Removing+content+blocks">Removing content blocks</h5>
+
+<p>If a component’s parent class defines a content block that is undesired in a subclass component, the content block can be removed as follows:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_setup'>setup</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_remove_content'>remove_content</span> <span class='symbol'>:some_content_defined_in_parent</span> <span class='comment'># This component will now behave as if this content block was never declared in its parent.
+</span><span class='kw'>end</span>
+</code></pre>
+
 <h4 id="label-Redirecting+away+-2F+Intercepting+rendering">Redirecting away / Intercepting rendering</h4>
 
 <p>Immediately before the <code>content</code> block(s) are evaluated, another chain of blocks is evaluated if present: <code>before_render</code>. If on of these blocks creates a reponse body in the Rails controller, the subsequent <code>before_render</code> blocks and all <code>content</code> blocks are skipped.</p>
@@ -1612,7 +1621,7 @@ my_button = Compony.button(:index, :users, enabled: -&gt; { |controller| control
 </div></div>
 
       <div id="footer">
-  Generated on Wed May 29 15:52:59 2024 by
+  Generated on Sat Jun  1 14:22:41 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.2.2).
 </div>

data/doc/method_list.html

@@ -932,6 +932,22 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Compony/Component.html#remove_content-instance_method" title="Compony::Component#remove_content (method)">#remove_content</a></span>
+      <small>Compony::Component</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Compony/Component.html#remove_content!-instance_method" title="Compony::Component#remove_content! (method)">#remove_content!</a></span>
+      <small>Compony::Component</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Compony/Component.html#render-instance_method" title="Compony::Component#render (method)">#render</a></span>

data/doc/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 29 15:53:00 2024 by
+  Generated on Sat Jun  1 14:22:42 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.2.2).
 </div>

data/lib/compony/component.rb

@@ -130,8 +130,31 @@ module Compony
     # @param [Hash] kwargs If hidden is true, the content will not be rendered by default, allowing you to nest it in another content block.
     # @param [Proc] block The block that should be run as part of the content pipeline. Will run in the component's context. You can use Dyny here.
     def content(name = :main, before: nil, **kwargs, &block)
-      fail("`content` expects a block in #{inspect}.") unless block_given?
-      @content_blocks.natural_push(name, block, before:, **kwargs)
+      # A block is required here, but if this is an override (e.g. to hide another content block), we can tolerate the missing block.
+      if !block_given? && @content_blocks.find { |b| b.name == name }.nil?
+        fail("`content` expects a block in #{inspect}.")
+      end
+      @content_blocks.natural_push(name, block || :missing, before:, **kwargs)
+    end
+
+    # DSL method
+    # Removes a content block. Use this in subclasses if a content block defined in the parent should be removed from the child.
+    # @param [Symbol,String] name Name of the content block that should be removed
+    def remove_content(name)
+      existing_index = @content_blocks.find_index { |el| el.name == name.to_sym }
+      if existing_index.nil?
+        return false
+      else
+        @content_blocks.delete_at(existing_index)
+        return true
+      end
+    end
+
+    # DSL method
+    # Removes a content block and fails if the content block was not found.
+    # @param [Symbol,String] name Name of the content block that should be removed
+    def remove_content!(name)
+      remove_content(name) || fail("Content block #{name.inspect} not found for removal in #{inspect}.")
     end
 
     # Renders the component using the controller passsed to it and returns it as a string.

data/lib/compony/components/destroy.rb

@@ -26,8 +26,11 @@ module Compony
         icon { :trash }
         color { :danger }
 
-        content do
+        content :confirm_question, hidden: true do
           div I18n.t('compony.components.destroy.confirm_question', data_label: @data.label)
+        end
+
+        content :confirm_button, hidden: true do
           div do
             concat compony_button(comp_cst,
                                   @data,
@@ -36,6 +39,11 @@ module Compony
           end
         end
 
+        content do
+          content :confirm_question
+          content :confirm_button
+        end
+
         action :back_to_owner do
           next if data_class.owner_model_attr.blank?
           Compony.button(:show, @data.send(data_class.owner_model_attr), icon: :xmark, color: :secondary, label: I18n.t('compony.cancel'))

data/lib/compony/components/edit.rb

@@ -35,6 +35,10 @@ module Compony
           Compony.button(:show, @data.send(data_class.owner_model_attr), icon: :xmark, color: :secondary, label: I18n.t('compony.cancel'))
         end
 
+        content :label do
+          h2 component.label
+        end
+
         content do
           concat form_comp.render(controller, data: @data)
         end

data/lib/compony/components/form.rb

@@ -13,19 +13,30 @@ module Compony
           # Make sure the error message is going to be nice if form_fields were not implemented
           fail "#{component.inspect} requires config.form_fields do ..." if @form_fields.nil?
 
-          # Must render the buttons now as the rendering within simple form breaks the form
-          @submit_button = Compony.button_component_class.new(
-            label: @submit_label || I18n.t('compony.components.form.submit'), icon: 'arrow-right', type: :submit
-          ).render(controller)
+          # Calculate paths
           @submit_path = @comp_opts[:submit_path]
           @submit_path = @submit_path.call(controller) if @submit_path.respond_to?(:call)
         end
 
+        # Override this to provide a custom submit button
+        content :submit_button, hidden: true do
+          concat Compony.button_component_class.new(
+            label: @submit_label || I18n.t('compony.components.form.submit'), icon: 'arrow-right', type: :submit
+          ).render(controller)
+        end
+
+        # Override this to provide additional submit buttons.
+        content :buttons, hidden: true do
+          content(:submit_button)
+        end
+
         content do
           form_html = simple_form_for(data, method: @comp_opts[:submit_verb], url: @submit_path) do |f|
             component.with_simpleform(f) do
               instance_exec(&form_fields)
-              div @submit_button, class: 'compony-form-buttons'
+              div class: 'compony-form-buttons' do
+                content(:buttons)
+              end
             end
           end
           concat form_html

data/lib/compony/components/new.rb

@@ -35,6 +35,7 @@ module Compony
         content :label do
           h2 component.label
         end
+
         content do
           concat form_comp.render(controller, data: @data)
         end

data/lib/compony/natural_ordering.rb

@@ -15,21 +15,25 @@ module Compony
   # collection.map(&:payload) # --> a_new_payload, b_payload, c_payload, d_payload
   # ```
   class NaturalOrdering < Array
-    def natural_push(name, payload, before: nil, **kwargs)
+    def natural_push(name, payload = :missing, before: nil, **kwargs)
       name = name.to_sym
       before_name = before&.to_sym
       old_kwargs = {}
+      old_payload = nil
 
       # Fetch existing element if any
       existing_index = find_index { |el| el.name == name }
       if existing_index.present?
         # Copy all non-mentionned kwargs from the element we are about to overwrite
         old_kwargs = self[existing_index].except(:name, :payload)
+        old_payload = self[existing_index].payload
 
         # Replacing an existing element with a before: directive - must delete before calculating indices
         if before_name.present?
           delete_at(existing_index)
         end
+      elsif payload == :missing
+        fail("Cannot insert new element #{name} without a payload (payload can only omitted if overriding another element) in #{inspect}.")
       end
 
       # Fetch before element
@@ -38,7 +42,7 @@ module Compony
       end
 
       # Create the element to insert
-      element = MethodAccessibleHash.new(name:, payload:, **old_kwargs.merge(kwargs))
+      element = MethodAccessibleHash.new(name:, payload: payload == :missing ? old_payload : payload, **old_kwargs.merge(kwargs))
 
       # Insert new element
       if before_index.present?

data/lib/compony/request_context.rb

@@ -46,8 +46,14 @@ module Compony
     def content(name)
       name = name.to_sym
       content_block = component.content_blocks.find { |el| el.name == name } || fail("Content block #{name.inspect} not found in #{component.inspect}.")
-      # A fresh RequestContext is needed due to Rails' buffer
-      concat Compony::RequestContext.new(component, controller, helpers:, locals: local_assigns).evaluate(&content_block.payload)
+      # We have to clear Rails' output_buffer to prevent double rendering of blocks. To achieve this, a fresh render context is instanciated.
+      concat controller.render_to_string(
+        type:   :dyny,
+        locals: { render_component: component, render_controller: controller, render_locals: local_assigns, render_block: content_block },
+        inline: <<~RUBY
+          Compony::RequestContext.new(render_component, render_controller, helpers: self, locals: local_assigns).evaluate_with_backfire(&render_block.payload)
+        RUBY
+      )
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compony
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Sandro Kalbermatter
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard