compony 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f23cc54f00a7ceb09e6e5ce344ac957dfd22863ae54fbb8bfee47663aface5a9
-  data.tar.gz: 78ab3342c2ab352d18e841696324497b0c7891f06d74dda0ad28e8998c5e18ac
+  metadata.gz: d8c73b93a2181fc65daa7d813741776da0426bb8f17bdfee660d8e94626f1676
+  data.tar.gz: 70715489017a96b9fd638a75c48666fc8157971af5b6f15f80a202ce774c14e2
 SHA512:
-  metadata.gz: 6e2d696881f150e9f6b3c43522412670eecd87aae908a9bcd4be9184de74cc4e444df32c4b0965623c61065a38f483e4a9db5e4d26920cb54d8aaeaf393ad714
-  data.tar.gz: 79bdb5b40c32265f2c6ab6eb2ab421ad0ca48b13d1eb6dd5b64d8217e60e7b9fb9a424fe34c33896f8cc32ce6d1cd88d2ad0d532f40422370f40e0cd0440256f
+  metadata.gz: 3f18b01d899380afbcba59880d0ef3bf827228ca410f67bcd2a8d70900cf32004442e4ae60cce6a6a2ca00801225cc8f760e0988e3a1903bda7969263ded700d
+  data.tar.gz: 0f9896f5d968a90f20c4c2323a41b205915a57f05b10cdb80d3968192b4af9c700635f22ed1057c5ba4850449c8d6f6c796c61f6f774418c2620a13e5fda0505

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 0.2.1
+
+- Fix a bug where the app crashed on HEAD verb
+- Show more details about failing authorization block
+- Implement `submit_path` DSL call for WithForm
+- Add French translation
+- Implement `skip_autofocus` in Form
+- Allow partial override of standalone verb configs. Example:
+  ```ruby
+    verb :get do
+      authorize { true }
+    end
+    verb :post do
+      authorize { true }
+      # Parent class implements more logic here, which will no longer be overwritten by calling `verb :post`.
+    end
+  ```
+
 # 0.2.0
 
 - Cleanup old code

data/app/controllers/compony_controller.rb

@@ -15,7 +15,9 @@ class ComponyController < ApplicationController
 
         # Define controller action for each standalone config
         define_method(standalone_config.rails_action_name) do
-          verb_config = standalone_config.verbs[request.raw_request_method.downcase.to_sym]
+          translated_verb = request.raw_request_method.downcase.to_sym
+          translated_verb = :get if translated_verb == :head # Rails transparently converts HEAD to GET, so we must do the same for fetching the config.
+          verb_config = standalone_config.verbs[translated_verb]
           Compony.comp_class_for!(comp_cst, family_cst).new.on_standalone_access(verb_config, self)
         end
 

data/compony.gemspec

@@ -2,17 +2,17 @@
 # This file is auto-generated via: 'rake gemspec'.
 
 # -*- encoding: utf-8 -*-
-# stub: compony 0.2.0 ruby lib
+# stub: compony 0.2.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "compony".freeze
-  s.version = "0.2.0".freeze
+  s.version = "0.2.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sandro Kalbermatter".freeze, "contributors".freeze]
-  s.date = "2023-12-05"
-  s.files = [".gitignore".freeze, ".ruby-version".freeze, ".yardopts".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "Gemfile.lock".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "app/controllers/compony_controller.rb".freeze, "compony.gemspec".freeze, "config/locales/de.yml".freeze, "config/locales/en.yml".freeze, "config/routes.rb".freeze, "doc/resourceful_lifecycle.graphml".freeze, "doc/resourceful_lifecycle.pdf".freeze, "lib/compony.rb".freeze, "lib/compony/component.rb".freeze, "lib/compony/component_mixins/default/labelling.rb".freeze, "lib/compony/component_mixins/default/standalone.rb".freeze, "lib/compony/component_mixins/default/standalone/resourceful_verb_dsl.rb".freeze, "lib/compony/component_mixins/default/standalone/standalone_dsl.rb".freeze, "lib/compony/component_mixins/default/standalone/verb_dsl.rb".freeze, "lib/compony/component_mixins/resourceful.rb".freeze, "lib/compony/components/button.rb".freeze, "lib/compony/components/destroy.rb".freeze, "lib/compony/components/edit.rb".freeze, "lib/compony/components/form.rb".freeze, "lib/compony/components/new.rb".freeze, "lib/compony/components/with_form.rb".freeze, "lib/compony/controller_mixin.rb".freeze, "lib/compony/engine.rb".freeze, "lib/compony/method_accessible_hash.rb".freeze, "lib/compony/model_fields/anchormodel.rb".freeze, "lib/compony/model_fields/association.rb".freeze, "lib/compony/model_fields/attachment.rb".freeze, "lib/compony/model_fields/base.rb".freeze, "lib/compony/model_fields/boolean.rb".freeze, "lib/compony/model_fields/color.rb".freeze, "lib/compony/model_fields/currency.rb".freeze, "lib/compony/model_fields/date.rb".freeze, "lib/compony/model_fields/datetime.rb".freeze, "lib/compony/model_fields/decimal.rb".freeze, "lib/compony/model_fields/email.rb".freeze, "lib/compony/model_fields/float.rb".freeze, "lib/compony/model_fields/integer.rb".freeze, "lib/compony/model_fields/percentage.rb".freeze, "lib/compony/model_fields/phone.rb".freeze, "lib/compony/model_fields/rich_text.rb".freeze, "lib/compony/model_fields/string.rb".freeze, "lib/compony/model_fields/text.rb".freeze, "lib/compony/model_fields/time.rb".freeze, "lib/compony/model_fields/url.rb".freeze, "lib/compony/model_mixin.rb".freeze, "lib/compony/request_context.rb".freeze, "lib/compony/version.rb".freeze, "lib/compony/view_helpers.rb".freeze, "lib/generators/component/USAGE".freeze, "lib/generators/component/component_generator.rb".freeze, "lib/generators/component/templates/component.rb.erb".freeze, "lib/generators/component/templates/destroy.rb.erb".freeze, "lib/generators/component/templates/edit.rb.erb".freeze, "lib/generators/component/templates/form.rb.erb".freeze, "lib/generators/component/templates/new.rb.erb".freeze, "lib/generators/components/USAGE".freeze, "lib/generators/components/components_generator.rb".freeze]
+  s.date = "2024-01-22"
+  s.files = [".gitignore".freeze, ".ruby-version".freeze, ".yardopts".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "Gemfile.lock".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "app/controllers/compony_controller.rb".freeze, "compony.gemspec".freeze, "config/locales/de.yml".freeze, "config/locales/en.yml".freeze, "config/locales/fr.yml".freeze, "config/routes.rb".freeze, "doc/resourceful_lifecycle.graphml".freeze, "doc/resourceful_lifecycle.pdf".freeze, "lib/compony.rb".freeze, "lib/compony/component.rb".freeze, "lib/compony/component_mixins/default/labelling.rb".freeze, "lib/compony/component_mixins/default/standalone.rb".freeze, "lib/compony/component_mixins/default/standalone/resourceful_verb_dsl.rb".freeze, "lib/compony/component_mixins/default/standalone/standalone_dsl.rb".freeze, "lib/compony/component_mixins/default/standalone/verb_dsl.rb".freeze, "lib/compony/component_mixins/resourceful.rb".freeze, "lib/compony/components/button.rb".freeze, "lib/compony/components/destroy.rb".freeze, "lib/compony/components/edit.rb".freeze, "lib/compony/components/form.rb".freeze, "lib/compony/components/new.rb".freeze, "lib/compony/components/with_form.rb".freeze, "lib/compony/controller_mixin.rb".freeze, "lib/compony/engine.rb".freeze, "lib/compony/method_accessible_hash.rb".freeze, "lib/compony/model_fields/anchormodel.rb".freeze, "lib/compony/model_fields/association.rb".freeze, "lib/compony/model_fields/attachment.rb".freeze, "lib/compony/model_fields/base.rb".freeze, "lib/compony/model_fields/boolean.rb".freeze, "lib/compony/model_fields/color.rb".freeze, "lib/compony/model_fields/currency.rb".freeze, "lib/compony/model_fields/date.rb".freeze, "lib/compony/model_fields/datetime.rb".freeze, "lib/compony/model_fields/decimal.rb".freeze, "lib/compony/model_fields/email.rb".freeze, "lib/compony/model_fields/float.rb".freeze, "lib/compony/model_fields/integer.rb".freeze, "lib/compony/model_fields/percentage.rb".freeze, "lib/compony/model_fields/phone.rb".freeze, "lib/compony/model_fields/rich_text.rb".freeze, "lib/compony/model_fields/string.rb".freeze, "lib/compony/model_fields/text.rb".freeze, "lib/compony/model_fields/time.rb".freeze, "lib/compony/model_fields/url.rb".freeze, "lib/compony/model_mixin.rb".freeze, "lib/compony/request_context.rb".freeze, "lib/compony/version.rb".freeze, "lib/compony/view_helpers.rb".freeze, "lib/generators/component/USAGE".freeze, "lib/generators/component/component_generator.rb".freeze, "lib/generators/component/templates/component.rb.erb".freeze, "lib/generators/component/templates/destroy.rb.erb".freeze, "lib/generators/component/templates/edit.rb.erb".freeze, "lib/generators/component/templates/form.rb.erb".freeze, "lib/generators/component/templates/new.rb.erb".freeze, "lib/generators/components/USAGE".freeze, "lib/generators/components/components_generator.rb".freeze]
   s.required_ruby_version = Gem::Requirement.new(">= 3.0.0".freeze)
   s.rubygems_version = "3.4.22".freeze
   s.summary = "Needs summary".freeze

data/config/locales/fr.yml

@@ -0,0 +1,33 @@
+fr:
+  compony:
+    cancel: 'Annuler'
+    filtered: '[Filtré]' # Not translated as this appears in log
+    boolean:
+      true: 'Oui'
+      false: 'Non'
+    feasibility:
+      has_dependent_models: 'il existe des %{dependent_class} dépendants'
+    model_fields:
+      attachment:
+        download: 'Télécharger'
+    components:
+      form:
+        submit: 'Envoyer'
+        cancel: 'Annuler'
+      edit:
+        label:
+          long: 'Modifier %{data_label}'
+          short: 'Modifier'
+        data_was_updated: '%{data_label} a été enregistré.'
+      new:
+        label:
+          long: 'Créer %{data_class}'
+          short: 'Nouveau'
+        data_was_created: '%{data_label} a été créé.'
+      destroy:
+        label:
+          long: 'Supprimer %{data_label}'
+          short: 'Supprimer'
+        confirm_question: 'Voulez-vous vraiment supprimer %{data_label} ?'
+        confirm_button: 'Oui, supprimer'
+        data_was_destroyed: '%{data_label} a été supprimé.'

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

@@ -14,7 +14,7 @@ module Compony
           end
 
           # For internal usage only, processes the block and returns a config hash.
-          def to_conf(&)
+          def to_conf(provide_defaults:, &)
             return super.deep_merge({
                                       load_data_block:         @load_data_block,
                                       assign_attributes_block: @assign_attributes_block,

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

@@ -4,11 +4,13 @@ module Compony
       module Standalone
         # @api description
         # Wrapper and DSL helper for component's standalone config
+        # Pass `provide_defaults` true if this is the first standalone DSL of a component. Pass false if it is a subsequent one (e.g. if subclassed comp)
         class StandaloneDsl < Dslblend::Base
-          def initialize(component, name = nil, path: nil)
+          def initialize(component, name = nil, provide_defaults:, path: nil)
             super()
             @component = component
             @name = name&.to_sym
+            @provide_defaults = provide_defaults
             @path = path
             @verbs = {}
             @skip_authentication = false
@@ -38,8 +40,17 @@ module Compony
           def verb(verb, *args, **nargs, &)
             verb = verb.to_sym
             verb_dsl_class = @component.resourceful? ? ResourcefulVerbDsl : VerbDsl
-            @verbs[verb] ||= Compony::MethodAccessibleHash.new
-            @verbs[verb].deep_merge! verb_dsl_class.new(@component, verb, *args, **nargs).to_conf(&)
+            if @verbs[verb]
+              @verbs[verb].deep_merge! verb_dsl_class.new(@component, verb, *args, **nargs).to_conf(provide_defaults: false, &)
+            else
+              # Note about provide_defaults:
+              # - We must pass false if this is the second time `standalone` was called for this component -> see @provide_defaults
+              # - We musst pass false if this is the second time `verb` was called for this component -> handled by the if statement (other branch)
+              # - We must pass true otherwise (handled by this branch)
+              @verbs[verb] = Compony::MethodAccessibleHash.new(
+                verb_dsl_class.new(@component, verb, *args, **nargs).to_conf(provide_defaults: @provide_defaults, &)
+              )
+            end
           end
 
           # DSL

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

@@ -17,18 +17,19 @@ module Compony
 
             @component = component
             @verb = verb
-            @respond_blocks = { nil => proc { render_standalone(controller) } } # default format
+            @respond_blocks = {}
             @authorize_block = nil
           end
 
           # For internal usage only, processes the block and returns a config hash.
-          def to_conf(&)
+          def to_conf(provide_defaults:, &)
             evaluate(&) if block_given?
-            return {
+            base_config = provide_defaults ? default_config : {}
+            return base_config.deep_merge({
               verb:            @verb,
-              authorize_block: @authorize_block || proc { can?(comp_name.to_sym, family_name.to_sym) },
+              authorize_block: @authorize_block,
               respond_blocks:  @respond_blocks
-            }.compact
+            }.compact)
           end
 
           protected
@@ -45,6 +46,14 @@ module Compony
           def respond(format = nil, &block)
             @respond_blocks[format&.to_sym] = block
           end
+
+          # Internal, do not use
+          def default_config
+            return {
+              authorize_block: proc { can?(comp_name.to_sym, family_name.to_sym) },
+              respond_blocks:  { nil => proc { render_standalone(controller) } }
+            }
+          end
         end
       end
     end

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

@@ -57,7 +57,7 @@ module Compony
           end
 
           # TODO: Make much prettier, providing message, action, subject and conditions
-          fail CanCan::AccessDenied, inspect unless request_context.evaluate(&verb_config.authorize_block)
+          fail CanCan::AccessDenied, [inspect, verb_config.authorize_block.inspect].join(', ') unless request_context.evaluate(&verb_config.authorize_block)
 
           if verb_config.store_data_block
             request_context.evaluate_with_backfire(&verb_config.store_data_block)
@@ -107,8 +107,11 @@ module Compony
         def standalone(name = nil, *args, **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
-          @standalone_configs[name] ||= Compony::MethodAccessibleHash.new
-          @standalone_configs[name].deep_merge! StandaloneDsl.new(self, name, *args, **nargs).to_conf(&block)
+          if @standalone_configs[name]
+            @standalone_configs[name].deep_merge! StandaloneDsl.new(self, name, *args, 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))
+          end
         end
 
         # Undoes previous standalone calls

data/lib/compony/components/form.rb

@@ -86,7 +86,7 @@ module Compony
         if hidden
           return model_field.simpleform_input_hidden(@simpleform, self, **input_opts)
         else
-          unless @focus_given
+          unless @focus_given || @skip_autofocus
             input_opts[:autofocus] = true unless input_opts.key? :autofocus
             @focus_given = true
           end
@@ -136,6 +136,11 @@ module Compony
           fail 'schema requires a block to be given'
         end
       end
+
+      # DSL method, skips adding autofocus to the first field
+      def skip_autofocus
+        @skip_autofocus = true
+      end
     end
   end
 end

data/lib/compony/components/with_form.rb

@@ -4,6 +4,11 @@ module Compony
     # This component is destined to take a sub-component that is a form component.
     # It can be called via :get or via `submit_verb` depending on whether its form should be shown or submitted.
     class WithForm < Component
+      def initialize(...)
+        @submit_path_block = ->(controller) { controller.helpers.send("#{Compony.path_helper_name(comp_name, family_name)}_path") }
+        super
+      end
+
       # Returns an instance of the form component responsible for rendering the form.
       # Feel free to override this in subclasses.
       def form_comp
@@ -11,7 +16,7 @@ module Compony
           self,
           submit_verb:,
           # If applicable, Rails adds the route keys automatically, thus, e.g. :id does not need to be passed here, as it comes from the request.
-          submit_path: ->(controller) { controller.helpers.send("#{Compony.path_helper_name(comp_name, family_name)}_path") }
+          submit_path: @submit_path_block
         )
       end
 
@@ -32,6 +37,13 @@ module Compony
       def form_comp_class(new_form_comp_class = nil)
         @form_comp_class ||= new_form_comp_class
       end
+
+      # DSL method
+      # Overrides the submit path which would otherwise default to this component
+      # This takes a block that will be called and given a controller
+      def submit_path(&new_submit_path_block)
+        @submit_path_block = new_submit_path_block
+      end
     end
   end
 end

data/lib/compony/version.rb

@@ -2,7 +2,7 @@ module Compony
   module Version
     MAJOR = 0
     MINOR = 2
-    PATCH = 0
+    PATCH = 1
 
     EDGE = false
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compony
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sandro Kalbermatter
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2024-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -184,6 +184,7 @@ files:
 - compony.gemspec
 - config/locales/de.yml
 - config/locales/en.yml
+- config/locales/fr.yml
 - config/routes.rb
 - doc/resourceful_lifecycle.graphml
 - doc/resourceful_lifecycle.pdf