compony 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fa06e0cecacc05de1b6567e29594a44fcbfed063d0268e08de239432c51a7f2
-  data.tar.gz: 24ec1426a6259b2cc3b1ddbd0127d8878a46701a0d7b2003bf5668eddf1eb8a0
+  metadata.gz: 5e3590a5ce07d22e7d483af2c98c972e9c64403e43084560e193bb6382215844
+  data.tar.gz: 054e3c2ef26650cdf404b0615f74dc12f0a610728e9b9b1446a90a4c91952365
 SHA512:
-  metadata.gz: 66fc9fe7beb64285bc2f21a945d1596c24206072b0fd64172a3eea2130754363f11d980b9159b0ebc1702be72526eb2ce8e613d17ece625ac377eeb0698ee876
-  data.tar.gz: fce5758f4f812d6ba053cf085c807ffecbce5163ed676d529d00aaa36257478a3887f60d3d6bc1ec0294151144edb6d63dc415f82c8fa6b7727fc4f84be34a97
+  metadata.gz: 90139644b0d2f3dd9adbff42e42bcdecae69d93676e5c4527795bd89a81103f5eabab4fd846fb3ad5e32b3463b0303b5e860f65d31939c0438f2e211bd28b4f6
+  data.tar.gz: a9c0714b201b1df42f0996e1a965de71ed6c6738cf8a6e0e332883a1b97f9dcdb876d89a138965c63db957e6b99bf54bdba7cbfc6a977b68c94f0b98dba496f5

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# 0.0.7
+
+- Fix `standalone_access_permitted_for?` check for buttons pointing to non-get verbs
+
+# 0.0.6
+
+- Fix a bug that breaks hidden fields of type reference
+- Add dynamic method "field" to model mixin
+- Tolerate and skip actions that do not define buttons, allows for dynamic action skipping
+- Fix `value_for` for boolean fields when they are nil
+- BREAKING: Rename `on_created` to `on_created_respond`, `on_updated` to `on_updated_respond`, and `on_destroyed` to `on_destroyed_respond`
+  - New hooks `on_created`, `on_updated`, and `on_destroyed` are called before their `_respond` counterpart
+- Fix a bug in Attachment Field
+- Support overriding simpleform name by providing `name:` as an argument to field.simpleform_input
+- In ModelField Anchormodel, tolerate "value" as input_html key and infer correct constant, allow form.object to be missing
+
 # 0.0.5
 
 - Fix row bug for Email field type
@@ -8,6 +24,10 @@
 - Make fields point to the correct `model_class` in case of STI
 - Support hidden Anchormodel fields
 
+## KNOWN BUGS
+
+- Breaks hidden fields of type reference
+
 # 0.0.4
 
 - Unscope the namespace of resourceful components

data/compony.gemspec

@@ -2,19 +2,19 @@
 # This file is auto-generated via: 'rake gemspec'.
 
 # -*- encoding: utf-8 -*-
-# stub: compony 0.0.5 ruby lib
+# stub: compony 0.0.7 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "compony".freeze
-  s.version = "0.0.5"
+  s.version = "0.0.7"
 
   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-06-20"
+  s.date = "2023-09-18"
   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/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/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.13".freeze
+  s.rubygems_version = "3.4.19".freeze
   s.summary = "Needs summary".freeze
 
   s.specification_version = 4

data/lib/compony/component.rb

@@ -206,7 +206,9 @@ module Compony
         button_htmls = @actions.map do |action|
           next if @skipped_actions.include?(action.name)
           Compony.with_button_defaults(feasibility_action: action.name.to_sym) do
-            h.content_tag(:div, action.block.call.render(controller), class: action_class)
+            action_button = action.block.call
+            next unless action_button
+            h.content_tag(:div, action_button.render(controller), class: action_class)
           end
         end
         next h.safe_join button_htmls

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

@@ -75,7 +75,8 @@ module Compony
         # - when called standalone (via request to the component), the load data step must be completed
         # - when called to check for permission only, e.g. to display a button to it, initialize the component by passing the :data keyword to `new`
         # By default, this checks the authorization to access the main standalone entrypoint (with name `nil`) and HTTP verb GET.
-        def standalone_access_permitted_for?(controller, standalone_name: nil, verb: :get)
+        def standalone_access_permitted_for?(controller, standalone_name: nil, verb: nil)
+          verb ||= :get
           standalone_name = standalone_name&.to_sym
           verb = verb.to_sym
           standalone_config = standalone_configs[standalone_name] || fail("#{inspect} does not provide the standalone config #{standalone_config.inspect}.")

data/lib/compony/components/destroy.rb

@@ -15,7 +15,8 @@ module Compony
             authorize { can?(:destroy, @data) }
             store_data # This enables the global store_data block defined below for this path and verb.
             respond do
-              evaluate_with_backfire(&@on_destroyed_block)
+              evaluate_with_backfire(&@on_destroyed_block) if @on_destroyed_block
+              evaluate_with_backfire(&@on_destroyed_respond_block)
             end
           end
         end
@@ -51,7 +52,7 @@ module Compony
           @data.destroy!
         end
 
-        on_destroyed do
+        on_destroyed_respond do
           flash.notice = I18n.t('compony.components.destroy.data_was_destroyed', data_label: @data.label)
           redirect_to evaluate_with_backfire(&@on_destroyed_redirect_path_block), status: :see_other # 303: force GET
         end
@@ -62,10 +63,16 @@ module Compony
       end
 
       # DSL method
+      # Sets a block that is evaluated with backfire in the successful case after storing, but before responding.
       def on_destroyed(&block)
         @on_destroyed_block = block
       end
 
+      # DSL method
+      def on_destroyed_respond(&block)
+        @on_destroyed_respond_block = block
+      end
+
       # DSL method
       def on_destroyed_redirect_path(&block)
         @on_destroyed_redirect_path_block = block

data/lib/compony/components/edit.rb

@@ -17,7 +17,8 @@ module Compony
             store_data # This enables the global store_data block defined below for this path and verb.
             respond do
               if @update_succeeded
-                evaluate_with_backfire(&@on_updated_block)
+                evaluate_with_backfire(&@on_updated_block) if @on_updated_block
+                evaluate_with_backfire(&@on_updated_respond_block)
               else
                 evaluate_with_backfire(&@on_update_failed_block)
               end
@@ -56,7 +57,7 @@ module Compony
           @update_succeeded = @data.save
         end
 
-        on_updated do
+        on_updated_respond do
           flash.notice = I18n.t('compony.components.edit.data_was_updated', data_label: data.label)
           redirect_to evaluate_with_backfire(&@on_updated_redirect_path_block)
         end
@@ -76,10 +77,16 @@ module Compony
       end
 
       # DSL method
+      # Sets a block that is evaluated with backfire in the successful case after storing, but before responding.
       def on_updated(&block)
         @on_updated_block = block
       end
 
+      # DSL method
+      def on_updated_respond(&block)
+        @on_updated_respond_block = block
+      end
+
       # DSL method
       def on_updated_redirect_path(&block)
         @on_updated_redirect_path_block = block

data/lib/compony/components/new.rb

@@ -19,9 +19,10 @@ module Compony
             store_data # This enables the global store_data block defined below for this path and verb.
             respond do
               if @create_succeeded
-                evaluate_with_backfire(&@on_created_block)
+                evaluate_with_backfire(&@on_created_block) if @on_created_block
+                evaluate_with_backfire(&@on_created_respond_block)
               else
-                evaluate_with_backfire(&@on_create_failed_block)
+                evaluate_with_backfire(&@on_create_failed_respond_block)
               end
             end
           end
@@ -55,7 +56,7 @@ module Compony
           @create_succeeded = @data.save
         end
 
-        on_created do
+        on_created_respond do
           flash.notice = I18n.t('compony.components.new.data_was_created', data_label: data.label)
           redirect_to evaluate_with_backfire(&@on_created_redirect_path_block)
         end
@@ -68,25 +69,31 @@ module Compony
           end
         end
 
-        on_create_failed do
+        on_create_failed_respond do
           Rails.logger.warn(@data&.errors&.full_messages)
           render_standalone(controller, status: :unprocessable_entity)
         end
       end
 
       # DSL method
+      # Sets a block that is evaluated with backfire in the successful case after storing, but before responding.
       def on_created(&block)
         @on_created_block = block
       end
 
+      # DSL method
+      def on_created_respond(&block)
+        @on_created_respond_block = block
+      end
+
       # DSL method
       def on_created_redirect_path(&block)
         @on_created_redirect_path_block = block
       end
 
       # DSL method
-      def on_create_failed(&block)
-        @on_create_failed_block = block
+      def on_create_failed_respond(&block)
+        @on_create_failed_respond_block = block
       end
     end
   end

data/lib/compony/model_fields/anchormodel.rb

@@ -10,25 +10,34 @@ module Compony
         return transform_and_join(data.send(@name), controller:) { |el| el&.label }
       end
 
-      def simpleform_input(form, _component, **input_opts)
-        selected_cst = form.object.send(@name)
+      def simpleform_input(form, _component, name: nil, **input_opts)
         anchormodel_attribute = @model_class.anchormodel_attributes[@name]
         anchormodel_class = anchormodel_attribute.anchormodel_class
+        input_opts[:input_html] ||= {}
+        # Attempt to read selected key from html input options "value", as the caller might not know that this is a select.
+        selected_key = input_opts[:input_html].delete(:value) # can also be both nil or blank
+        if selected_key.blank? && form.object
+          # No selected key override present and a model is present, use the model to find out what to select
+          selected_cst = form.object.send(@name)
+          selected_key = selected_cst&.key || anchormodel_class.all.first
+        end
         opts = {
           collection:    self.class.collect(anchormodel_class.all),
           label_method:  :first,
           value_method:  :second,
-          selected:      selected_cst&.key || anchormodel_class.all.first,
+          selected:      selected_key,
           include_blank: anchormodel_attribute.optional
         }.merge(input_opts)
-        return form.input @name, **opts
+        return form.input name || @name, **opts
       end
 
-      def simpleform_input_hidden(form, _component, **input_opts)
-        selected_cst = form.object.send(@name)
-        input_opts[:input_html] ||= {}
-        input_opts[:input_html][:value] = selected_cst.is_a?(::Anchormodel) ? selected_cst.key : selected_cst
-        return form.input @name, as: :hidden, **input_opts
+      def simpleform_input_hidden(form, _component, name: nil, **input_opts)
+        if form.object
+          selected_cst = form.object.send(@name)
+          input_opts[:input_html] ||= {}
+          input_opts[:input_html][:value] = selected_cst.is_a?(::Anchormodel) ? selected_cst.key : selected_cst
+        end
+        return form.input name || @name, as: :hidden, **input_opts
       end
     end
   end

data/lib/compony/model_fields/association.rb

@@ -32,8 +32,12 @@ module Compony
         end
       end
 
-      def simpleform_input(form, _component, **input_opts)
-        return form.association @name, **input_opts
+      def simpleform_input(form, _component, name: nil, **input_opts)
+        return form.association name || @name, **input_opts
+      end
+
+      def simpleform_input_hidden(form, _component, name: nil, **input_opts)
+        return form.input name || @schema_key, as: :hidden, **input_opts
       end
 
       protected

data/lib/compony/model_fields/attachment.rb

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

data/lib/compony/model_fields/base.rb

@@ -17,7 +17,7 @@ module Compony
       def initialize(name, model_class, **extra_attrs)
         @name = name.to_sym
         @model_class = model_class
-        @schema_key = name
+        @schema_key = name.to_sym
         @extra_attrs = extra_attrs
       end
 
@@ -42,14 +42,14 @@ module Compony
 
       # Used in form helper.
       # Given a simpleform instance, returns the corresponding input to be supplied to the view.
-      def simpleform_input(form, _component, **input_opts)
-        return form.input @name, **input_opts
+      def simpleform_input(form, _component, name: nil, **input_opts)
+        return form.input name || @name, **input_opts
       end
 
       # Used in form helper
       # Given a simpleform instance, returns a suitable hidden input for thetype
-      def simpleform_input_hidden(form, _component, **input_opts)
-        return form.input @name, as: :hidden, **input_opts
+      def simpleform_input_hidden(form, _component, name: nil, **input_opts)
+        return form.input name || @name, as: :hidden, **input_opts
       end
 
       protected

data/lib/compony/model_fields/boolean.rb

@@ -2,7 +2,7 @@ module Compony
   module ModelFields
     class Boolean < Base
       def value_for(data, controller: nil, **_)
-        return transform_and_join(data.send(@name), controller:) { |el| I18n.t("compony.boolean.#{el}") }
+        return transform_and_join(data.send(@name), controller:) { |el| el.nil? ? nil : I18n.t("compony.boolean.#{el}") }
       end
     end
   end

data/lib/compony/model_fields/rich_text.rb

@@ -1,8 +1,8 @@
 module Compony
   module ModelFields
     class RichText < Base
-      def simpleform_input(form, _component, **input_opts)
-        return form.input @name, **input_opts.merge(as: :rich_text_area)
+      def simpleform_input(form, _component, name: nil, **input_opts)
+        return form.input name || @name, **input_opts.merge(as: :rich_text_area)
       end
     end
   end

data/lib/compony/model_mixin.rb

@@ -91,5 +91,10 @@ module Compony
       text += '.' if text.present?
       return text
     end
+
+    # Calls value_for on the desired field. Do not confuse with the static method field.
+    def field(field_name, controller)
+      fields[field_name.to_sym].value_for(self, controller:)
+    end
   end
 end

data/lib/compony/version.rb

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

data/lib/compony.rb

@@ -145,6 +145,7 @@ module Compony
                   params: nil,
                   feasibility_action: nil,
                   feasibility_target: nil,
+                  method: nil,
                   **override_kwargs)
     label_opts ||= button_defaults[:label_opts] || {}
     params ||= button_defaults[:params] || {}
@@ -157,7 +158,8 @@ module Compony
       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),
-      visible: ->(controller) { target_comp_instance.standalone_access_permitted_for?(controller) }
+      method:,
+      visible: ->(controller) { target_comp_instance.standalone_access_permitted_for?(controller, verb: method) }
     }
     if feasibility_target
       options.merge!({

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compony
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Sandro Kalbermatter
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-20 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard