compony 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 328b6b6671f93fa0575bf4224a5da90fecde74a0c00430346d36ca45a675cf24
-  data.tar.gz: a92107d9f9cf7b270d57059ad10bdec614d269615fd2eabfe58caeb0e44300bc
+  metadata.gz: 8157d970b7bb216a92e5ff27931775e1744063efcb91bd8c2c094d998bc0d74d
+  data.tar.gz: 1a10cfd007f6c94f2bd71076bd90688bd6761a597962414f56f31570cb4b6c31
 SHA512:
-  metadata.gz: 1ae81390416e9f14dcfb1a1d2723fbd3714e4f271afe9dc9e2a3ee2f27012a1ee82cb846fb8b80be14b6fac73451477b9b8e00a960b8f88777670a10e4dcec13
-  data.tar.gz: d318c0bdc852f4ff1fcf1aef638eac97356a03621f70bb4bac7957bece7050ba5e152a4114d165c79200d3e2eefe6d61af69ac4fec10371da354f908164ab929
+  metadata.gz: 37fdaa0c7e0c6e905fbf5239d79dc9df15bb27e3cf805953fc9daf75e421f04dc14b087165e2049c5e4ff87a13464d197a837cea24517467d591ff115c7f2cd3
+  data.tar.gz: 3f59823928a888c4bb5f501f4e1440ff4e3a1f83f627d23117af9c5b5e7afba65db48168a70685010c9c251f4b7331a232843a6209634ad004c3a15a0ee6653a

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 0.0.9
+
+- Support forms with references to tables with uuid type primary key
+- Support for `owned_by` in model:
+  - Smart redirect
+  - Auto-generate a back / cancel button
+- Add `clear_standalone!` to components
+- Allow passing an array to `prevent` to prevent multiple actions at once
+- Add features `Compony.content_before_root_comp` and `Compony.content_after_root_comp`
+- Add new field kind percentage
+
 # 0.0.8
 
 - Support selecting anchormodel inputs via radio buttons

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    compony (0.0.1)
+    compony (0.0.9.edge)
       anchormodel (~> 0.1.2)
       cancancan (~> 3.4.0)
       dslblend (>= 0.0.3)
@@ -203,4 +203,4 @@ DEPENDENCIES
   yard (>= 0.9.28)
 
 BUNDLED WITH
-   2.4.13
+   2.4.19

data/compony.gemspec

@@ -2,17 +2,17 @@
 # This file is auto-generated via: 'rake gemspec'.
 
 # -*- encoding: utf-8 -*-
-# stub: compony 0.0.8 ruby lib
+# stub: compony 0.0.9 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "compony".freeze
-  s.version = "0.0.8"
+  s.version = "0.0.9"
 
   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-10-03"
-  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/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 = "2023-11-03"
+  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.required_ruby_version = Gem::Requirement.new(">= 3.0.0".freeze)
   s.rubygems_version = "3.4.19".freeze
   s.summary = "Needs summary".freeze

data/config/locales/de.yml

@@ -1,5 +1,6 @@
 de:
   compony:
+    cancel: 'Abbrechen'
     filtered: '[Filtered]' # Not translated as this appears in log
     boolean:
       true: 'Ja'

data/config/locales/en.yml

@@ -1,5 +1,6 @@
 en:
   compony:
+    cancel: 'Cancel'
     filtered: '[Filtered]'
     boolean:
       yes: 'Yes'

data/lib/compony/component.rb

@@ -146,8 +146,9 @@ module Compony
     end
 
     # Renders the component using the controller passsed to it and returns it as a string.
+    # @param standalone: pass true iff `render` is called from `render_standalone`
     # Do not overwrite.
-    def render(controller, **locals)
+    def render(controller, standalone: false, **locals)
       # Call before_render hook if any and backfire instance variables back to the component
       RequestContext.new(self, controller, locals:).request_context.evaluate_with_backfire(&@before_render_block) if @before_render_block
       # Render, unless before_render has already issued a body (e.g. through redirecting).
@@ -155,12 +156,18 @@ module Compony
         fail "#{self.class.inspect} must define `content` or set a response body in `before_render`" if @content_blocks.none?
         return controller.render_to_string(
           type:   :dyny,
-          locals: { content_blocks: @content_blocks, component: self, render_locals: locals },
+          locals: { content_blocks: @content_blocks, standalone:, component: self, render_locals: locals },
           inline: <<~RUBY
+            if Compony.content_before_root_comp_block && standalone
+              Compony::RequestContext.new(component, controller, helpers: self, locals: render_locals).evaluate(&Compony.content_before_root_comp_block)
+            end
             content_blocks.each do |block|
               # Instanciate and evaluate a fresh RequestContext in order to use the buffer allocated by the ActionView (needed for `concat` calls)
               Compony::RequestContext.new(component, controller, helpers: self, locals: render_locals).evaluate(&block)
             end
+            if Compony.content_after_root_comp_block && standalone
+              Compony::RequestContext.new(component, controller, helpers: self, locals: render_locals).evaluate(&Compony.content_after_root_comp_block)
+            end
           RUBY
         )
       else

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

@@ -88,7 +88,7 @@ module Compony
         # Do not overwrite
         def render_standalone(controller, status: nil, standalone_name: nil)
           # Start the render process. This produces a nil value if before_render has already produced a response, e.g. a redirect.
-          rendered_html = render(controller)
+          rendered_html = render(controller, standalone: true)
           if rendered_html.present? # If nil, a response body was already produced in the controller and we take no action here (would have DoubleRenderError)
             opts = { html: rendered_html, layout: @standalone_configs[standalone_name].layout }
             opts[:status] = status if status.present?
@@ -111,6 +111,11 @@ module Compony
           @standalone_configs[name].deep_merge! StandaloneDsl.new(self, name, *args, **nargs).to_conf(&block)
         end
 
+        # Undoes previous standalone calls
+        def clear_standalone!
+          @standalone_configs = {}
+        end
+
         private
 
         def init_standalone

data/lib/compony/components/destroy.rb

@@ -36,6 +36,11 @@ module Compony
           end
         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'))
+        end
+
         store_data do
           # Validate params against the form's schema
           local_data = @data # Capture data for usage in the Schemacop call
@@ -58,7 +63,11 @@ module Compony
         end
 
         on_destroyed_redirect_path do
-          Compony.path(:index, family_cst)
+          if data_class.owner_model_attr.present?
+            Compony.path(:show, @data.send(data_class.owner_model_attr))
+          else
+            Compony.path(:index, family_cst)
+          end
         end
       end
 

data/lib/compony/components/edit.rb

@@ -30,6 +30,11 @@ module Compony
         label(:short) { |_| I18n.t('compony.components.edit.label.short') }
         icon { :pencil }
 
+        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'))
+        end
+
         content do
           concat form_comp.render(controller, data: @data)
         end
@@ -65,6 +70,8 @@ module Compony
         on_updated_redirect_path do
           if Compony.comp_class_for(:show, @data)
             Compony.path(:show, @data)
+          elsif data_class.owner_model_attr.present?
+            Compony.path(:show, @data.send(data_class.owner_model_attr))
           else
             Compony.path(:index, @data)
           end

data/lib/compony/components/new.rb

@@ -64,6 +64,8 @@ module Compony
         on_created_redirect_path do
           if Compony.comp_class_for(:show, @data)
             Compony.path(:show, @data)
+          elsif data_class.owner_model_attr.present?
+            Compony.path(:show, @data.send(data_class.owner_model_attr))
           else
             Compony.path(:index, @data)
           end

data/lib/compony/model_fields/association.rb

@@ -24,15 +24,28 @@ module Compony
 
       def schema_line
         local_schema_key = @schema_key # Capture schema_key as it will not be available within the lambda
+        target_primary_key_type = @target_class.primary_key_type_key
         if multi?
           return proc do
             ary? local_schema_key do
-              list :integer, cast_str: true
+              if target_primary_key_type == :integer
+                list :integer, cast_str: true
+              elsif target_primary_key_type == :string
+                list :string
+              else
+                fail("Unsupported target primary_key_type_key #{target_primary_key_type}")
+              end
             end
           end
         else
           return proc do
-            int? local_schema_key, cast_str: true
+            if target_primary_key_type == :integer
+              int? local_schema_key, cast_str: true
+            elsif target_primary_key_type == :string
+              str? local_schema_key
+            else
+              fail("Unsupported target primary_key_type_key #{target_primary_key_type}")
+            end
           end
         end
       end
@@ -53,6 +66,7 @@ module Compony
         @association = true
         association_info = @model_class.reflect_on_association(@name) || fail("Association #{@name.inspect} does not exist for #{@model_class.inspect}.")
         @multi = association_info.macro == :has_many
+        @target_class = association_info.klass
         id_name = "#{@name.to_s.singularize}_id"
         @schema_key = @multi ? id_name.pluralize.to_sym : id_name.to_sym
       rescue ActiveRecord::NoDatabaseError

data/lib/compony/model_fields/percentage.rb

@@ -0,0 +1,9 @@
+module Compony
+  module ModelFields
+    class Percentage < Base
+      def value_for(data, controller: nil, **_)
+        return transform_and_join(data.send(@name), controller:) { |el| controller.helpers.sanitize "#{(el * 100.0).round(2)}%" }
+      end
+    end
+  end
+end

data/lib/compony/model_mixin.rb

@@ -6,6 +6,7 @@ module Compony
       class_attribute :fields, default: {}
       class_attribute :feasibility_preventions, default: {}
       class_attribute :primary_key_type_key, default: :integer
+      class_attribute :owner_model_attr
 
       class_attribute :autodetect_feasibilities_completed, default: false
     end
@@ -34,12 +35,23 @@ module Compony
         self.primary_key_type_key = new_type.to_sym
       end
 
+      # DSL method, sets the containing model.
+      # Use this when a model only makes sense within the context of another model and typically has no own index page.
+      # For instance, a model LineItem that belongs_to :invoice would typically be owned_by :invoice.
+      # Compony will automatically adjust Redirects and top actions.
+      def owned_by(attribute_name)
+        self.owner_model_attr = attribute_name.to_sym
+      end
+
       # DSL method, part of the Feasibility feature
       # Block must return `false` if the action should be prevented.
-      def prevent(action_name, message, &block)
-        self.feasibility_preventions = feasibility_preventions.dup # Prevent cross-class contamination
-        feasibility_preventions[action_name.to_sym] ||= []
-        feasibility_preventions[action_name.to_sym] << MethodAccessibleHash.new(action_name:, message:, block:)
+      def prevent(action_names, message, &block)
+        action_names = [action_names] unless action_names.is_a? Enumerable
+        action_names.each do |action_name|
+          self.feasibility_preventions = feasibility_preventions.dup # Prevent cross-class contamination
+          feasibility_preventions[action_name.to_sym] ||= []
+          feasibility_preventions[action_name.to_sym] << MethodAccessibleHash.new(action_name:, message:, block:)
+        end
       end
 
       # DSL method, part of the Feasibility feature

data/lib/compony/version.rb

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

data/lib/compony.rb

@@ -40,6 +40,20 @@ module Compony
     @authentication_before_action = authentication_before_action.to_sym
   end
 
+  # Setter for a content block that runs before the root component gets rendered (standalone only). Usage is the same as `content`.
+  # The block runs between `before_render` and `render`, i.e. before the first `content` block.
+  def self.content_before_root_comp(&block)
+    fail('`Compony.content_before` requires a block.') unless block_given?
+    @content_before_root_comp_block = block
+  end
+
+  # Setter for a content block that runs after the root component gets rendered (standalone only). Usage is the same as `content`.
+  # The block runs after `render`, i.e. after the last `content` block.
+  def self.content_after_root_comp(&block)
+    fail('`Compony.content_after` requires a block.') unless block_given?
+    @content_after_root_comp_block = block
+  end
+
   ##########=====-------
   # Configuration readers
   ##########=====-------
@@ -64,6 +78,18 @@ module Compony
     @authentication_before_action
   end
 
+  # Getter for content_before_root_comp_block
+  # @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
+  def self.content_after_root_comp_block
+    @content_after_root_comp_block
+  end
+
   ##########=====-------
   # Application-wide available pure helpers
   ##########=====-------
@@ -253,6 +279,7 @@ require 'compony/model_fields/decimal'
 require 'compony/model_fields/email'
 require 'compony/model_fields/float'
 require 'compony/model_fields/integer'
+require 'compony/model_fields/percentage'
 require 'compony/model_fields/phone'
 require 'compony/model_fields/rich_text'
 require 'compony/model_fields/string'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compony
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Sandro Kalbermatter
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -203,6 +203,7 @@ files:
 - lib/compony/model_fields/email.rb
 - lib/compony/model_fields/float.rb
 - lib/compony/model_fields/integer.rb
+- lib/compony/model_fields/percentage.rb
 - lib/compony/model_fields/phone.rb
 - lib/compony/model_fields/rich_text.rb
 - lib/compony/model_fields/string.rb