compony 0.5.3 → 0.5.4

data/doc/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Dec 20 13:46:32 2024 by
+  Generated on Fri Feb 14 13:24:11 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.5).
 </div>

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

@@ -17,6 +17,7 @@ module Compony
             @scope_args = scope_args
             @verbs = {}
             @skip_authentication = false
+            @skip_forgery_protection = false
             @layout = true # can be overriden by false or a string
           end
 
@@ -25,16 +26,17 @@ module Compony
             evaluate(&block)
             @component = block.binding.eval('self') # Fetches the component holding this DSL call (via the block)
             return {
-              name:                @name,
-              path:                @path,
-              constraints:         @constraints,
-              scope:               @scope,
-              scope_args:          @scope_args,
-              verbs:               @verbs,
-              rails_action_name:   Compony.rails_action_name(comp_name, family_name, @name),
-              path_helper_name:    Compony.path_helper_name(comp_name, family_name, @name),
-              skip_authentication: @skip_authentication,
-              layout:              @layout
+              name:                    @name,
+              path:                    @path,
+              constraints:             @constraints,
+              scope:                   @scope,
+              scope_args:              @scope_args,
+              verbs:                   @verbs,
+              rails_action_name:       Compony.rails_action_name(comp_name, family_name, @name),
+              path_helper_name:        Compony.path_helper_name(comp_name, family_name, @name),
+              skip_authentication:     @skip_authentication,
+              skip_forgery_protection: @skip_forgery_protection,
+              layout:                  @layout
             }.compact
           end
 
@@ -65,6 +67,12 @@ module Compony
             @skip_authentication = true
           end
 
+          # DSL
+          # Defines that for this component, no forgery protection (CSRF) should be performed.
+          def skip_forgery_protection!
+            @skip_forgery_protection = true
+          end
+
           # DSL
           # Speficies the Rails layout (under `app/views/layouts`) that should be used to render this component.
           # Defaults to Rails' default (`layouts/application`) if the method is never called.

data/lib/compony/components/form.rb

@@ -36,7 +36,8 @@ module Compony
         end
 
         content do
-          form_html = simple_form_for(data, method: @comp_opts[:submit_verb], url: @submit_path) do |f|
+          form_params = { method: @comp_opts[:submit_verb], url: @submit_path }.merge(@form_params || {})
+          form_html = simple_form_for(data, **form_params) do |f|
             component.with_simpleform(f, controller) do
               instance_exec(&form_fields)
               div class: 'compony-form-buttons' do
@@ -95,32 +96,38 @@ module Compony
 
       # Called inside the form_fields block. This makes the method `field` available in the block.
       # See also notes for `with_simpleform`.
-      def field(name, **input_opts)
+      # If multilang is true, a suffixed field is generated for every available locale (useful with gem "mobility"). Render the array as you wish.
+      def field(name, multilang: false, **input_opts)
         fail("The `field` method may only be called inside `form_fields` for #{inspect}.") unless @simpleform
-        name = name.to_sym
 
-        input_opts.merge!(disabled: true) if @form_disabled
+        if multilang
+          I18n.available_locales.map { |locale| field("#{name}_#{locale}", **input_opts) }
+        else
+          name = name.to_sym
 
-        # Check per-field authorization
-        if @cancancan_action.present? && @controller.current_ability.permitted_attributes(@cancancan_action, @simpleform.object).exclude?(name)
-          Rails.logger.debug do
-            "Skipping form field #{name.inspect} because the current user is not allowed to perform #{@cancancan_action.inspect} on #{@simpleform.object}."
+          input_opts.merge!(disabled: true) if @form_disabled
+
+          # Check per-field authorization
+          if @cancancan_action.present? && @controller.current_ability.permitted_attributes(@cancancan_action, @simpleform.object).exclude?(name)
+            Rails.logger.debug do
+              "Skipping form field #{name.inspect} because the current user is not allowed to perform #{@cancancan_action.inspect} on #{@simpleform.object}."
+            end
+            return
           end
-          return
-        end
 
-        hidden = input_opts.delete(:hidden)
-        model_field = @simpleform.object.fields[name]
-        fail("Field #{name.inspect} is not defined on #{@simpleform.object.inspect} but was requested in #{inspect}.") unless model_field
+          hidden = input_opts.delete(:hidden)
+          model_field = @simpleform.object.fields[name]
+          fail("Field #{name.inspect} is not defined on #{@simpleform.object.inspect} but was requested in #{inspect}.") unless model_field
 
-        if hidden
-          return model_field.simpleform_input_hidden(@simpleform, self, **input_opts)
-        else
-          unless @focus_given || @skip_autofocus
-            input_opts[:autofocus] = true unless input_opts.key? :autofocus
-            @focus_given = true
+          if hidden
+            return model_field.simpleform_input_hidden(@simpleform, self, **input_opts)
+          else
+            unless @focus_given || @skip_autofocus
+              input_opts[:autofocus] = true unless input_opts.key? :autofocus
+              @focus_given = true
+            end
+            return model_field.simpleform_input(@simpleform, self, **input_opts)
           end
-          return model_field.simpleform_input(@simpleform, self, **input_opts)
         end
       end
 
@@ -163,6 +170,11 @@ module Compony
         @form_disabled = true
       end
 
+      # DSL method, allows to customize parameters given to simple_form_for
+      def form_params(**new_form_params)
+        @form_params = new_form_params
+      end
+
       protected
 
       # DSL method, adds a new line to the schema whitelisting a single param inside the schema's wrapper
@@ -173,19 +185,24 @@ module Compony
 
       # DSL method, adds a new field to the schema whitelisting a single field of data_class
       # This auto-generates the correct schema line for the field.
-      def schema_field(field_name)
-        # This runs upon component setup.
-        @schema_lines_for_data << proc do |data, controller|
-          # This runs within a request context.
-          field = data.class.fields[field_name.to_sym] || fail("No field #{field_name.to_sym.inspect} found for #{data.inspect} in #{inspect}.")
-          # Check per-field authorization
-          if @cancancan_action.present? && controller.current_ability.permitted_attributes(@cancancan_action.to_sym, data).exclude?(field.name.to_sym)
-            Rails.logger.debug do
-              "Skipping form schema_field #{field_name.inspect} because the current user is not allowed to perform #{@cancancan_action.inspect} on #{data}."
+      # If multilang is true, a suffixed field is generated for every available locale (useful with gem "mobility")
+      def schema_field(field_name, multilang: false)
+        if multilang
+          I18n.available_locales.each { |locale| schema_field("#{field_name}_#{locale}") }
+        else
+          # This runs upon component setup.
+          @schema_lines_for_data << proc do |data, controller|
+            # This runs within a request context.
+            field = data.class.fields[field_name.to_sym] || fail("No field #{field_name.to_sym.inspect} found for #{data.inspect} in #{inspect}.")
+            # Check per-field authorization
+            if @cancancan_action.present? && controller.current_ability.permitted_attributes(@cancancan_action.to_sym, data).exclude?(field.name.to_sym)
+              Rails.logger.debug do
+                "Skipping form schema_field #{field_name.inspect} because the current user is not allowed to perform #{@cancancan_action.inspect} on #{data}."
+              end
+              next nil
             end
-            next nil
+            next field.schema_line
           end
-          next field.schema_line
         end
       end
 
@@ -198,7 +215,7 @@ module Compony
           # Check per-field authorization
           unless @cancancan_action.nil? || controller.current_ability.can?(:set_password, data)
             Rails.logger.debug do
-              "Skipping form schema_pw_field #{name.inspect} because the current user is not allowed to perform :set_password on #{data}."
+              "Skipping form schema_pw_field #{field_name.inspect} because the current user is not allowed to perform :set_password on #{data}."
             end
             next nil
           end

data/lib/compony/model_mixin.rb

@@ -19,21 +19,27 @@ module Compony
       end
 
       # DSL method, defines a new field which will be translated and can be added to field groups
-      def field(name, type, **extra_attrs)
-        name = name.to_sym
-        self.fields = fields.dup
-        field = Compony.model_field_class_for(type.to_s.camelize).new(name, self, **extra_attrs)
-        # Handle the case where ActiveType would interfere with attribute registration
-        if defined?(ActiveType) && self <= ActiveType::Object && !include?(ActiveModel::Attributes)
-          fail "Please add `include ActiveModel::Attributes` at the top of the class #{self}, as attributes cannot be registered otherwise with ActiveType."
-        end
-        # Register the field as an attribute
-        if defined?(ActiveType) && self <= ActiveType::Object
-          ar_attribute(name)
+      # If multilang is true, a suffixed field is generated for every available locale, along with a non-suffixed virtual field (useful with gem "mobility")
+      def field(name, type, multilang: false, **extra_attrs)
+        if multilang
+          field(name, type, virtual: true, **extra_attrs)
+          I18n.available_locales.each { |locale| field("#{name}_#{locale}", type, **extra_attrs) }
         else
-          attribute(name)
+          name = name.to_sym
+          self.fields = fields.dup
+          field = Compony.model_field_class_for(type.to_s.camelize).new(name, self, **extra_attrs)
+          # Handle the case where ActiveType would interfere with attribute registration
+          if defined?(ActiveType) && self <= ActiveType::Object && !include?(ActiveModel::Attributes)
+            fail "Please add `include ActiveModel::Attributes` at the top of the class #{self}, as attributes cannot be registered otherwise with ActiveType."
+          end
+          # Register the field as an attribute
+          if defined?(ActiveType) && self <= ActiveType::Object
+            ar_attribute(name)
+          else
+            attribute(name)
+          end
+          fields[name] = field
         end
-        fields[name] = field
       end
 
       # DSL method, sets the containing model.

data/lib/compony.rb

@@ -79,13 +79,13 @@ module Compony
   end
 
   # Getter for content_before_root_comp_block
-  # @see Compony#content_before_root_comp
+  # @see Compony#content_before_root_comp=
   def self.content_before_root_comp_block
     @content_before_root_comp_block
   end
 
   # Getter for content_after_root_comp_block
-  # @see Compony#content_after_root_comp
+  # @see Compony#content_after_root_comp=
   def self.content_after_root_comp_block
     @content_after_root_comp_block
   end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compony
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Sandro Kalbermatter
 - contributors
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-20 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -165,8 +164,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.6.1
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -312,10 +309,8 @@ files:
 - lib/generators/components/USAGE
 - lib/generators/components/components_generator.rb
 - logo.svg
-homepage:
 licenses: []
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -330,8 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Compony is a Gem that allows you to write your Rails application in component-style
   fashion. It combines a controller action and route along \ with its view into a