compony 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0925cbc177ea6e36fd56db15cb41227efcb66b7ea5896a2dd76cc13fc7974a5
-  data.tar.gz: 517baac0f2d25bb94857c5796d6ae41a94c291628edda7e453736488c2616036
+  metadata.gz: 8fa06e0cecacc05de1b6567e29594a44fcbfed063d0268e08de239432c51a7f2
+  data.tar.gz: 24ec1426a6259b2cc3b1ddbd0127d8878a46701a0d7b2003bf5668eddf1eb8a0
 SHA512:
-  metadata.gz: 2a6ef1cb3327c852d2f544c376f22f34d8bac2eb56ff7c29e13fb887d0b4fcd91aa3de4dcfa3f16393ec386abbbefae593379c87e848518f00978d566250064a
-  data.tar.gz: d3a985885dc53f7a4556c338038342f17b65991cea8ac0f993ff2ab0b638984d59b9a09b78ec7e9bec08eea4795debe1892a212875262629ff371295d771021c
+  metadata.gz: 66fc9fe7beb64285bc2f21a945d1596c24206072b0fd64172a3eea2130754363f11d980b9159b0ebc1702be72526eb2ce8e613d17ece625ac377eeb0698ee876
+  data.tar.gz: fce5758f4f812d6ba053cf085c807ffecbce5163ed676d529d00aaa36257478a3887f60d3d6bc1ec0294151144edb6d63dc415f82c8fa6b7727fc4f84be34a97

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# 0.0.5
+
+- Fix row bug for Email field type
+- Auto-focus first non-hidden element in forms
+- Add field type :url
+- Automatically set the correct class when generating known components
+- Add generator `components` that is able to mass-produce the most used components
+- Make fields point to the correct `model_class` in case of STI
+- Support hidden Anchormodel fields
+
+# 0.0.4
+
+- Unscope the namespace of resourceful components
+- Add field type :email
+
+## Steps to take
+
+- When inheriting from components, replace `Components::Resourceful::...` by `Components::...`
+
 # 0.0.3
 
 - Tolerate nil anchormodels

data/compony.gemspec

@@ -2,31 +2,31 @@
 # This file is auto-generated via: 'rake gemspec'.
 
 # -*- encoding: utf-8 -*-
-# stub: compony 0.0.3 ruby lib
+# stub: compony 0.0.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "compony".freeze
-  s.version = "0.0.3".freeze
+  s.version = "0.0.5"
 
   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 = "2024-03-25"
-  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/form.rb".freeze, "lib/compony/components/resourceful/destroy.rb".freeze, "lib/compony/components/resourceful/edit.rb".freeze, "lib/compony/components/resourceful/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/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_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]
+  s.date = "2023-06-20"
+  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.5.6".freeze
+  s.rubygems_version = "3.4.13".freeze
   s.summary = "Needs summary".freeze
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<yard>.freeze, [">= 0.9.28".freeze])
-  s.add_development_dependency(%q<rubocop>.freeze, [">= 1.48".freeze])
-  s.add_development_dependency(%q<rubocop-rails>.freeze, [">= 2.18.0".freeze])
-  s.add_runtime_dependency(%q<request_store>.freeze, [">= 1.5".freeze])
-  s.add_runtime_dependency(%q<dyny>.freeze, [">= 0.0.3".freeze])
-  s.add_runtime_dependency(%q<schemacop>.freeze, [">= 3.0.17".freeze])
-  s.add_runtime_dependency(%q<simple_form>.freeze, [">= 5.1.0".freeze])
-  s.add_runtime_dependency(%q<dslblend>.freeze, [">= 0.0.3".freeze])
-  s.add_runtime_dependency(%q<anchormodel>.freeze, ["~> 0.1.2".freeze])
-  s.add_runtime_dependency(%q<cancancan>.freeze, ["~> 3.4.0".freeze])
+  s.add_development_dependency(%q<yard>.freeze, [">= 0.9.28"])
+  s.add_development_dependency(%q<rubocop>.freeze, [">= 1.48"])
+  s.add_development_dependency(%q<rubocop-rails>.freeze, [">= 2.18.0"])
+  s.add_runtime_dependency(%q<request_store>.freeze, [">= 1.5"])
+  s.add_runtime_dependency(%q<dyny>.freeze, [">= 0.0.3"])
+  s.add_runtime_dependency(%q<schemacop>.freeze, [">= 3.0.17"])
+  s.add_runtime_dependency(%q<simple_form>.freeze, [">= 5.1.0"])
+  s.add_runtime_dependency(%q<dslblend>.freeze, [">= 0.0.3"])
+  s.add_runtime_dependency(%q<anchormodel>.freeze, ["~> 0.1.2"])
+  s.add_runtime_dependency(%q<cancancan>.freeze, ["~> 3.4.0"])
 end

data/lib/compony/components/destroy.rb

@@ -0,0 +1,75 @@
+module Compony
+  module Components
+    # @api description
+    # This component is used for the Rails destroy paradigm. Asks for confirm when queried using GET.
+    class Destroy < Compony::Component
+      include Compony::ComponentMixins::Resourceful
+
+      setup do
+        standalone path: "#{family_name}/:id/destroy" do
+          verb :get do
+            authorize { can?(:destroy, @data) }
+          end
+
+          verb :delete do
+            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)
+            end
+          end
+        end
+
+        label(:long) { |data| I18n.t('compony.components.destroy.label.long', data_label: data.label) }
+        label(:short) { |_| I18n.t('compony.components.destroy.label.short') }
+        icon { :trash }
+        color { :danger }
+
+        content do
+          div I18n.t('compony.components.destroy.confirm_question', data_label: @data.label)
+          div do
+            concat compony_button(comp_cst,
+                                  @data,
+                                  label:  I18n.t('compony.components.destroy.confirm_button'),
+                                  method: :delete)
+          end
+        end
+
+        store_data do
+          # Validate params against the form's schema
+          local_data = @data # Capture data for usage in the Schemacop call
+          schema = Schemacop::Schema3.new :hash, additional_properties: true do
+            if local_data.class.primary_key_type_key == :string
+              str! :id
+            else
+              int! :id, cast_str: true
+            end
+          end
+          schema.validate!(controller.request.params)
+
+          # Perform destroy
+          @data.destroy!
+        end
+
+        on_destroyed 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
+
+        on_destroyed_redirect_path do
+          Compony.path(:index, family_cst)
+        end
+      end
+
+      # DSL method
+      def on_destroyed(&block)
+        @on_destroyed_block = block
+      end
+
+      # DSL method
+      def on_destroyed_redirect_path(&block)
+        @on_destroyed_redirect_path_block = block
+      end
+    end
+  end
+end

data/lib/compony/components/edit.rb

@@ -0,0 +1,94 @@
+module Compony
+  module Components
+    # @api description
+    # This component is used for the Rails edit and update paradigm. Performs update when the form is submitted.
+    class Edit < Compony::Components::WithForm
+      include Compony::ComponentMixins::Resourceful
+      setup do
+        submit_verb :patch
+        standalone path: "#{family_name}/:id/edit" do
+          verb :get do
+            authorize { can?(:edit, @data) }
+            assign_attributes # This enables the global assign_attributes block defined below for this path and verb.
+          end
+          verb submit_verb do
+            authorize { can?(:update, @data) }
+            assign_attributes # This enables the global assign_attributes block defined below for this path and verb.
+            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)
+              else
+                evaluate_with_backfire(&@on_update_failed_block)
+              end
+            end
+          end
+        end
+
+        label(:long) { |data| I18n.t('compony.components.edit.label.long', data_label: data.label) }
+        label(:short) { |_| I18n.t('compony.components.edit.label.short') }
+        icon { :pencil }
+
+        content do
+          concat form_comp.render(controller, data: @data)
+        end
+
+        assign_attributes do
+          # Validate params against the form's schema
+          local_form_comp = form_comp # Capture form_comp for usage in the Schemacop call
+          local_data = @data # Capture data for usage in the Schemacop call
+          schema = Schemacop::Schema3.new :hash, additional_properties: true do
+            if local_data.class.primary_key_type_key == :string
+              str! :id
+            else
+              int! :id, cast_str: true
+            end
+            hsh? local_form_comp.schema_wrapper_key_for(local_data), &local_form_comp.schema_block_for(local_data)
+          end
+          schema.validate!(controller.request.params)
+
+          # TODO: Why are we not saving the validated params?
+          attrs_to_assign = controller.request.params[form_comp.schema_wrapper_key_for(@data)]
+          @data.assign_attributes(attrs_to_assign) if attrs_to_assign
+        end
+
+        store_data do
+          @update_succeeded = @data.save
+        end
+
+        on_updated 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
+
+        on_updated_redirect_path do
+          if Compony.comp_class_for(:show, @data)
+            Compony.path(:show, @data)
+          else
+            Compony.path(:index, @data)
+          end
+        end
+
+        on_update_failed do
+          Rails.logger.warn(@data&.errors&.full_messages)
+          render_standalone(controller, status: :unprocessable_entity)
+        end
+      end
+
+      # DSL method
+      def on_updated(&block)
+        @on_updated_block = block
+      end
+
+      # DSL method
+      def on_updated_redirect_path(&block)
+        @on_updated_redirect_path_block = block
+      end
+
+      # DSL method
+      def on_update_failed(&block)
+        @on_update_failed_block = block
+      end
+    end
+  end
+end

data/lib/compony/components/form.rb

@@ -71,6 +71,7 @@ module Compony
       # @todo Refactor? Could this be greatly simplified by having `form_field to |f|` ?
       def with_simpleform(simpleform)
         @simpleform = simpleform
+        @focus_given = false
         yield
         @simpleform = nil
       end
@@ -85,8 +86,12 @@ module Compony
         fail("Field #{name.to_sym.inspect} is not defined on #{@simpleform.object.inspect} but was requested in #{inspect}.") unless model_field
 
         if hidden
-          return @simpleform.input model_field.schema_key, as: :hidden, **input_opts
+          return model_field.simpleform_input_hidden(@simpleform, self, **input_opts)
         else
+          unless @focus_given
+            input_opts[:autofocus] = true unless input_opts.key? :autofocus
+            @focus_given = true
+          end
           return model_field.simpleform_input(@simpleform, self, **input_opts)
         end
       end

data/lib/compony/components/new.rb

@@ -0,0 +1,93 @@
+module Compony
+  module Components
+    # @api description
+    # This component is used for the Rails new and create paradigm. Performs update when the form is submitted.
+    class New < Compony::Components::WithForm
+      include Compony::ComponentMixins::Resourceful
+
+      setup do
+        submit_verb :post
+        load_data { @data = data_class.new }
+        standalone path: "#{family_name}/new" do
+          verb :get do
+            authorize { can?(:create, data_class) }
+            assign_attributes # This enables the global assign_attributes block defined below for this path and verb.
+          end
+          verb submit_verb do
+            authorize { can?(:create, data_class) }
+            assign_attributes # This enables the global assign_attributes block defined below for this path and verb.
+            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)
+              else
+                evaluate_with_backfire(&@on_create_failed_block)
+              end
+            end
+          end
+        end
+
+        label(:long) { I18n.t('compony.components.new.label.long', data_class: data_class.model_name.human) }
+        label(:short) { I18n.t('compony.components.new.label.short') }
+        icon { :plus }
+
+        add_content do
+          h2 component.label
+        end
+        add_content do
+          concat form_comp.render(controller, data: @data)
+        end
+
+        assign_attributes do
+          local_form_comp = form_comp # Capture form_comp for usage in the Schemacop call
+          local_data = @data # Capture data for usage in the Schemacop call
+          schema = Schemacop::Schema3.new :hash, additional_properties: true do
+            hsh? local_form_comp.schema_wrapper_key_for(local_data), &local_form_comp.schema_block_for(local_data)
+          end
+          schema.validate!(controller.request.params)
+
+          # TODO: Why are we not saving the validated params?
+          attrs_to_assign = controller.request.params[form_comp.schema_wrapper_key_for(@data)]
+          @data.assign_attributes(attrs_to_assign) if attrs_to_assign
+        end
+
+        store_data do
+          @create_succeeded = @data.save
+        end
+
+        on_created 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
+
+        on_created_redirect_path do
+          if Compony.comp_class_for(:show, @data)
+            Compony.path(:show, @data)
+          else
+            Compony.path(:index, @data)
+          end
+        end
+
+        on_create_failed do
+          Rails.logger.warn(@data&.errors&.full_messages)
+          render_standalone(controller, status: :unprocessable_entity)
+        end
+      end
+
+      # DSL method
+      def on_created(&block)
+        @on_created_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
+      end
+    end
+  end
+end

data/lib/compony/model_fields/anchormodel.rb

@@ -23,6 +23,13 @@ module Compony
         }.merge(input_opts)
         return form.input @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
+      end
     end
   end
 end

data/lib/compony/model_fields/base.rb

@@ -46,6 +46,12 @@ module Compony
         return form.input @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
+      end
+
       protected
 
       # If given a scalar, calls the block on the scalar. If given a list, calls the block on every member and joins the result with ",".

data/lib/compony/model_fields/email.rb

@@ -0,0 +1,13 @@
+module Compony
+  module ModelFields
+    class Email < Base
+      def value_for(data, controller: nil, **_)
+        return transform_and_join(data.send(@name), controller:) do |el|
+          fail('Must pass controller to generate the link to the email.') unless controller
+          return nil unless el
+          return controller.helpers.mail_to(el)
+        end
+      end
+    end
+  end
+end

data/lib/compony/model_fields/url.rb

@@ -0,0 +1,13 @@
+module Compony
+  module ModelFields
+    class Url < Base
+      def value_for(data, controller: nil, **_)
+        return transform_and_join(data.send(@name), controller:) do |el|
+          fail('Must pass controller to generate the link to the link.') unless controller
+          return nil unless el
+          return controller.helpers.link_to(el, el, target: '_blank', rel: 'noopener')
+        end
+      end
+    end
+  end
+end

data/lib/compony/model_mixin.rb

@@ -11,6 +11,13 @@ module Compony
     end
 
     class_methods do
+      # This hook updates all fields from a subclass, making sure that fields point to correct model classes even in STI
+      # e.g. in Parent: field :foo, ... omitted in child -> child.fields[:foo] should point to Child and not Parent.
+      def inherited(subclass)
+        super
+        subclass.fields = subclass.fields.transform_values { |f| f.class.new(f.name, subclass, **f.extra_attrs) }
+      end
+
       # DSL method, defines a new field which will be translated and can be added to field groups
       # For virtual attributes, you must pass a type explicitely, otherwise it's auto-infered.
       def field(name, type, **extra_attrs)

data/lib/compony/version.rb

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

data/lib/compony.rb

@@ -247,6 +247,7 @@ require 'compony/model_fields/currency'
 require 'compony/model_fields/date'
 require 'compony/model_fields/datetime'
 require 'compony/model_fields/decimal'
+require 'compony/model_fields/email'
 require 'compony/model_fields/float'
 require 'compony/model_fields/integer'
 require 'compony/model_fields/phone'
@@ -254,6 +255,7 @@ require 'compony/model_fields/rich_text'
 require 'compony/model_fields/string'
 require 'compony/model_fields/text'
 require 'compony/model_fields/time'
+require 'compony/model_fields/url'
 require 'compony/component_mixins/default/standalone'
 require 'compony/component_mixins/default/standalone/standalone_dsl'
 require 'compony/component_mixins/default/standalone/verb_dsl'
@@ -264,9 +266,9 @@ require 'compony/component'
 require 'compony/components/button'
 require 'compony/components/form'
 require 'compony/components/with_form'
-require 'compony/components/resourceful/new'
-require 'compony/components/resourceful/edit'
-require 'compony/components/resourceful/destroy'
+require 'compony/components/new'
+require 'compony/components/edit'
+require 'compony/components/destroy'
 require 'compony/method_accessible_hash'
 require 'compony/model_mixin'
 require 'compony/request_context'

data/lib/generators/component/component_generator.rb

@@ -3,12 +3,23 @@ class ComponentGenerator < Rails::Generators::NamedBase
 
   def add_component
     segments = name.underscore.split('/')
-    fail('NAME must be of the form Family::ComponentName or family/component_name') if segments.size != 2
+    fail("NAME must be of the form Family::ComponentName or family/component_name but got #{name.inspect}") if segments.size != 2
     @family, @comp = segments
     @family = @family.pluralize # Force plural
     @family_cst = @family.camelize.pluralize # Force plural
     @comp_cst = @comp.camelize # Tolerate singular and plural
 
-    template 'component.rb.erb', "app/components/#{@family}/#{@comp}.rb"
+    case @comp_cst
+    when 'Destroy'
+      template 'destroy.rb.erb', "app/components/#{@family}/#{@comp}.rb"
+    when 'Edit'
+      template 'edit.rb.erb', "app/components/#{@family}/#{@comp}.rb"
+    when 'Form'
+      template 'form.rb.erb', "app/components/#{@family}/#{@comp}.rb"
+    when 'New'
+      template 'new.rb.erb', "app/components/#{@family}/#{@comp}.rb"
+    else
+      template 'component.rb.erb', "app/components/#{@family}/#{@comp}.rb"
+    end
   end
 end

data/lib/generators/component/templates/component.rb.erb

@@ -1,4 +1,4 @@
 class Components::<%= @family_cst %>::<%= @comp_cst %> < Compony::Component
   setup do
   end
-end
+end

data/lib/generators/component/templates/destroy.rb.erb

@@ -0,0 +1,2 @@
+class Components::<%= @family_cst %>::<%= @comp_cst %> < Compony::Components::Destroy
+end

data/lib/generators/component/templates/edit.rb.erb

@@ -0,0 +1,2 @@
+class Components::<%= @family_cst %>::<%= @comp_cst %> < Compony::Components::Edit
+end

data/lib/generators/component/templates/form.rb.erb

@@ -0,0 +1,8 @@
+class Components::<%= @family_cst %>::<%= @comp_cst %> < Compony::Components::Form
+  setup do
+    form_fields do
+    end
+
+    schema_fields
+  end
+end

data/lib/generators/component/templates/new.rb.erb

@@ -0,0 +1,2 @@
+class Components::<%= @family_cst %>::<%= @comp_cst %> < Compony::Components::New
+end

data/lib/generators/components/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate the most used components for a family
+
+Example:
+    bin/rails generate components Users
+
+    This will create and fill with the usual components:
+        app/components/users/

data/lib/generators/components/components_generator.rb

@@ -0,0 +1,12 @@
+class ComponentsGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def add_component
+    @family = name.underscore.pluralize # Force plural
+    @family_cst = @family.camelize.pluralize # Force plural
+
+    %w[Destroy Edit Form New].each do |comp_cst|
+      generate "component #{name}::#{comp_cst}"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compony
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Sandro Kalbermatter
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-25 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -182,10 +182,10 @@ files:
 - lib/compony/component_mixins/default/standalone/verb_dsl.rb
 - lib/compony/component_mixins/resourceful.rb
 - lib/compony/components/button.rb
+- lib/compony/components/destroy.rb
+- lib/compony/components/edit.rb
 - lib/compony/components/form.rb
-- lib/compony/components/resourceful/destroy.rb
-- lib/compony/components/resourceful/edit.rb
-- lib/compony/components/resourceful/new.rb
+- lib/compony/components/new.rb
 - lib/compony/components/with_form.rb
 - lib/compony/controller_mixin.rb
 - lib/compony/engine.rb
@@ -199,6 +199,7 @@ files:
 - lib/compony/model_fields/date.rb
 - lib/compony/model_fields/datetime.rb
 - lib/compony/model_fields/decimal.rb
+- lib/compony/model_fields/email.rb
 - lib/compony/model_fields/float.rb
 - lib/compony/model_fields/integer.rb
 - lib/compony/model_fields/phone.rb
@@ -206,6 +207,7 @@ files:
 - lib/compony/model_fields/string.rb
 - lib/compony/model_fields/text.rb
 - lib/compony/model_fields/time.rb
+- lib/compony/model_fields/url.rb
 - lib/compony/model_mixin.rb
 - lib/compony/request_context.rb
 - lib/compony/version.rb
@@ -213,6 +215,12 @@ files:
 - lib/generators/component/USAGE
 - lib/generators/component/component_generator.rb
 - lib/generators/component/templates/component.rb.erb
+- lib/generators/component/templates/destroy.rb.erb
+- lib/generators/component/templates/edit.rb.erb
+- lib/generators/component/templates/form.rb.erb
+- lib/generators/component/templates/new.rb.erb
+- lib/generators/components/USAGE
+- lib/generators/components/components_generator.rb
 homepage:
 licenses: []
 metadata: {}

data/lib/compony/components/resourceful/destroy.rb

@@ -1,77 +0,0 @@
-module Compony
-  module Components
-    module Resourceful
-      # @api description
-      # This component is used for the Rails destroy paradigm. Asks for confirm when queried using GET.
-      class Destroy < Compony::Component
-        include Compony::ComponentMixins::Resourceful
-
-        setup do
-          standalone path: "#{family_name}/:id/destroy" do
-            verb :get do
-              authorize { can?(:destroy, @data) }
-            end
-
-            verb :delete do
-              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)
-              end
-            end
-          end
-
-          label(:long) { |data| I18n.t('compony.components.destroy.label.long', data_label: data.label) }
-          label(:short) { |_| I18n.t('compony.components.destroy.label.short') }
-          icon { :trash }
-          color { :danger }
-
-          content do
-            div I18n.t('compony.components.destroy.confirm_question', data_label: @data.label)
-            div do
-              concat compony_button(comp_cst,
-                                    @data,
-                                    label:  I18n.t('compony.components.destroy.confirm_button'),
-                                    method: :delete)
-            end
-          end
-
-          store_data do
-            # Validate params against the form's schema
-            local_data = @data # Capture data for usage in the Schemacop call
-            schema = Schemacop::Schema3.new :hash, additional_properties: true do
-              if local_data.class.primary_key_type_key == :string
-                str! :id
-              else
-                int! :id, cast_str: true
-              end
-            end
-            schema.validate!(controller.request.params)
-
-            # Perform destroy
-            @data.destroy!
-          end
-
-          on_destroyed 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
-
-          on_destroyed_redirect_path do
-            Compony.path(:index, family_cst)
-          end
-        end
-
-        # DSL method
-        def on_destroyed(&block)
-          @on_destroyed_block = block
-        end
-
-        # DSL method
-        def on_destroyed_redirect_path(&block)
-          @on_destroyed_redirect_path_block = block
-        end
-      end
-    end
-  end
-end

data/lib/compony/components/resourceful/edit.rb

@@ -1,96 +0,0 @@
-module Compony
-  module Components
-    module Resourceful
-      # @api description
-      # This component is used for the Rails edit and update paradigm. Performs update when the form is submitted.
-      class Edit < Compony::Components::WithForm
-        include Compony::ComponentMixins::Resourceful
-        setup do
-          submit_verb :patch
-          standalone path: "#{family_name}/:id/edit" do
-            verb :get do
-              authorize { can?(:edit, @data) }
-              assign_attributes # This enables the global assign_attributes block defined below for this path and verb.
-            end
-            verb submit_verb do
-              authorize { can?(:update, @data) }
-              assign_attributes # This enables the global assign_attributes block defined below for this path and verb.
-              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)
-                else
-                  evaluate_with_backfire(&@on_update_failed_block)
-                end
-              end
-            end
-          end
-
-          label(:long) { |data| I18n.t('compony.components.edit.label.long', data_label: data.label) }
-          label(:short) { |_| I18n.t('compony.components.edit.label.short') }
-          icon { :pencil }
-
-          content do
-            concat form_comp.render(controller, data: @data)
-          end
-
-          assign_attributes do
-            # Validate params against the form's schema
-            local_form_comp = form_comp # Capture form_comp for usage in the Schemacop call
-            local_data = @data # Capture data for usage in the Schemacop call
-            schema = Schemacop::Schema3.new :hash, additional_properties: true do
-              if local_data.class.primary_key_type_key == :string
-                str! :id
-              else
-                int! :id, cast_str: true
-              end
-              hsh? local_form_comp.schema_wrapper_key_for(local_data), &local_form_comp.schema_block_for(local_data)
-            end
-            schema.validate!(controller.request.params)
-
-            # TODO: Why are we not saving the validated params?
-            attrs_to_assign = controller.request.params[form_comp.schema_wrapper_key_for(@data)]
-            @data.assign_attributes(attrs_to_assign) if attrs_to_assign
-          end
-
-          store_data do
-            @update_succeeded = @data.save
-          end
-
-          on_updated 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
-
-          on_updated_redirect_path do
-            if Compony.comp_class_for(:show, @data)
-              Compony.path(:show, @data)
-            else
-              Compony.path(:index, @data)
-            end
-          end
-
-          on_update_failed do
-            Rails.logger.warn(@data&.errors&.full_messages)
-            render_standalone(controller, status: :unprocessable_entity)
-          end
-        end
-
-        # DSL method
-        def on_updated(&block)
-          @on_updated_block = block
-        end
-
-        # DSL method
-        def on_updated_redirect_path(&block)
-          @on_updated_redirect_path_block = block
-        end
-
-        # DSL method
-        def on_update_failed(&block)
-          @on_update_failed_block = block
-        end
-      end
-    end
-  end
-end

data/lib/compony/components/resourceful/new.rb

@@ -1,95 +0,0 @@
-module Compony
-  module Components
-    module Resourceful
-      # @api description
-      # This component is used for the Rails new and create paradigm. Performs update when the form is submitted.
-      class New < Compony::Components::WithForm
-        include Compony::ComponentMixins::Resourceful
-
-        setup do
-          submit_verb :post
-          load_data { @data = data_class.new }
-          standalone path: "#{family_name}/new" do
-            verb :get do
-              authorize { can?(:create, data_class) }
-              assign_attributes # This enables the global assign_attributes block defined below for this path and verb.
-            end
-            verb submit_verb do
-              authorize { can?(:create, data_class) }
-              assign_attributes # This enables the global assign_attributes block defined below for this path and verb.
-              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)
-                else
-                  evaluate_with_backfire(&@on_create_failed_block)
-                end
-              end
-            end
-          end
-
-          label(:long) { I18n.t('compony.components.new.label.long', data_class: data_class.model_name.human) }
-          label(:short) { I18n.t('compony.components.new.label.short') }
-          icon { :plus }
-
-          add_content do
-            h2 component.label
-          end
-          add_content do
-            concat form_comp.render(controller, data: @data)
-          end
-
-          assign_attributes do
-            local_form_comp = form_comp # Capture form_comp for usage in the Schemacop call
-            local_data = @data # Capture data for usage in the Schemacop call
-            schema = Schemacop::Schema3.new :hash, additional_properties: true do
-              hsh? local_form_comp.schema_wrapper_key_for(local_data), &local_form_comp.schema_block_for(local_data)
-            end
-            schema.validate!(controller.request.params)
-
-            # TODO: Why are we not saving the validated params?
-            attrs_to_assign = controller.request.params[form_comp.schema_wrapper_key_for(@data)]
-            @data.assign_attributes(attrs_to_assign) if attrs_to_assign
-          end
-
-          store_data do
-            @create_succeeded = @data.save
-          end
-
-          on_created 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
-
-          on_created_redirect_path do
-            if Compony.comp_class_for(:show, @data)
-              Compony.path(:show, @data)
-            else
-              Compony.path(:index, @data)
-            end
-          end
-
-          on_create_failed do
-            Rails.logger.warn(@data&.errors&.full_messages)
-            render_standalone(controller, status: :unprocessable_entity)
-          end
-        end
-
-        # DSL method
-        def on_created(&block)
-          @on_created_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
-        end
-      end
-    end
-  end
-end