compony 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85db41ccf7cece62891a703bb4e79c1e4e4a5a14fd87cc5ea0955df633184d60
-  data.tar.gz: 15bbcb498d877f9b9932c77b867f3ae28215f21b37db213a05e6073752674f8a
+  metadata.gz: 9c333fb952f7e7d0014f3a8b076f8f902bb253ca2696b0fe8bec7a59b6f9b2eb
+  data.tar.gz: 816afcdeeba74972d758eef0b93824b605925b4e9e8f07bb140dac2621c94df2
 SHA512:
-  metadata.gz: b84a06879a6e6c85682f92bfdfd0afd3243614312231e12b3c8f201b75799eb4b077a953b945f3da8c581011e9d0a3e9a27721b5ffe3087a4d6aca1831940e9a
-  data.tar.gz: 403aaad21bb3853be4cfd8ed19c571910e6fac0a1e27193fc4e9177f48d9a313d6adac2339dd8e4ec530e064f8262e1de75283117583e8ef83292bdc0c1188bf
+  metadata.gz: bcf8622372086feb57f31c5e9024576a7c7e27ece17f42d4a225aba8051a9f500730cc2eb872305e02b2189651817ffddd9bf8fd6c618cd3d56b482917d80239
+  data.tar.gz: ebd6da5daf161538e755dc0a1c7bd59d8d14db81cd7253c419e719665e40f4a276909a4c2546977b6371dd5f61841eeafebdba8ece3f3162671fbb0fe734b18b

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 0.0.2
+
+- Add new model field `Attachment`
+- Slightly extend documentation
+- Update `Gemfile.lock`
+
+# 0.0.1
+
+First version

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    compony (0.0.1.edge)
+    compony (0.0.1)
       anchormodel (~> 0.1.2)
       cancancan (~> 3.4.0)
       dslblend (>= 0.0.3)
@@ -13,67 +13,67 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actioncable (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionmailbox (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionmailer (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.4.2)
-      actionview (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actiontext (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    activejob (7.0.4.3)
+      activesupport (= 7.0.4.3)
       globalid (>= 0.3.6)
-    activemodel (7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activerecord (7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activestorage (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activestorage (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.4.2)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -92,12 +92,12 @@ GEM
     erubi (1.12.0)
     globalid (1.1.0)
       activesupport (>= 5.0)
-    i18n (1.12.0)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    loofah (2.19.1)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
@@ -116,84 +116,82 @@ GEM
       timeout
     net-smtp (0.3.3)
       net-protocol
-    nio4r (2.5.8)
-    nokogiri (1.14.2-x86_64-linux)
+    nio4r (2.5.9)
+    nokogiri (1.15.0-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.2.1.1)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
     racc (1.6.2)
-    rack (2.2.6.3)
-    rack-test (2.0.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails (7.0.4.2)
-      actioncable (= 7.0.4.2)
-      actionmailbox (= 7.0.4.2)
-      actionmailer (= 7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actiontext (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    rails (7.0.4.3)
+      actioncable (= 7.0.4.3)
+      actionmailbox (= 7.0.4.3)
+      actionmailer (= 7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actiontext (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       bundler (>= 1.15.0)
-      railties (= 7.0.4.2)
+      railties (= 7.0.4.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.5.0)
       loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    railties (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
+    regexp_parser (2.8.0)
     request_store (1.5.1)
       rack (>= 1.4)
     rexml (3.2.5)
-    rubocop (1.48.0)
+    rubocop (1.51.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.27.0)
+    rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
-    rubocop-rails (2.18.0)
+    rubocop-rails (2.19.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.4)
-    schemacop (3.0.22)
+    schemacop (3.0.24)
       activesupport (>= 4.0)
       ruby2_keywords (= 0.0.4)
     simple_form (5.2.0)
       actionpack (>= 5.2)
       activemodel (>= 5.2)
-    thor (1.2.1)
+    thor (1.2.2)
     timeout (0.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
-    webrick (1.7.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-    zeitwerk (2.6.7)
+    yard (0.9.34)
+    zeitwerk (2.6.8)
 
 PLATFORMS
   x86_64-linux
@@ -205,4 +203,4 @@ DEPENDENCIES
   yard (>= 0.9.28)
 
 BUNDLED WITH
-   2.3.26
+   2.4.13

data/compony.gemspec

@@ -2,31 +2,31 @@
 # This file is auto-generated via: 'rake gemspec'.
 
 # -*- encoding: utf-8 -*-
-# stub: compony 0.0.1 ruby lib
+# stub: compony 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "compony".freeze
-  s.version = "0.0.1"
+  s.version = "0.0.2".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-05-12"
-  s.files = [".gitignore".freeze, ".ruby-version".freeze, ".yardopts".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/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 = "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.required_ruby_version = Gem::Requirement.new(">= 3.0.0".freeze)
-  s.rubygems_version = "3.4.10".freeze
+  s.rubygems_version = "3.5.6".freeze
   s.summary = "Needs summary".freeze
 
   s.specification_version = 4
 
-  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"])
+  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])
 end

data/config/locales/de.yml

@@ -6,6 +6,9 @@ de:
       false: 'Nein'
     feasibility:
       has_dependent_models: 'es gibt abhängige %{dependent_class}'
+    model_fields:
+      attachment:
+        download: 'Herunterladen'
     components:
       form:
         submit: 'Senden'

data/config/locales/en.yml

@@ -6,6 +6,9 @@ en:
       no: 'No'
     feasibility:
       has_dependent_models: 'there are dependent %{dependent_class}'
+    model_fields:
+      attachment:
+        download: 'Download'
     components:
       form:
         submit: 'Submit'

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

@@ -3,13 +3,24 @@ require 'active_support/concern'
 module Compony
   module ComponentMixins
     module Default
-      # This module contains all methods for Component that concern labelling and look
+      # api description
+      # This module contains all methods for Component that concern labelling and look.
       module Labelling
         extend ActiveSupport::Concern
 
-        # DSL method and accessor
-        # When assigning via DSL, pass format as first parameter.
-        # When accessing the value, pass foramt as named parameter
+        # DSL method and accessor When assigning via DSL, pass format as first
+        # parameter. When accessing the value, pass format as named parameter
+        # (e.g. `format: :short`). <br/> A component either generates labels
+        # without data (e.g. "New user") or with data (e.g. "Edit John Doe").
+        # This needs to be consistent across all formats. If the block generates
+        # labels with data, the label block must take exactly one argument,
+        # otherwise none. Label blocks with data are given the data as argument.
+        # The block is expected to return the label in the given format. <br/>
+        # Examples:
+        # - Setting a block with data: `label(:short){ |data| "Edit #{data.label}" }`
+        # - Setting a block without data: `label(:short){ 'New user' }`
+        # - Reading a component's label with data: `comp.label(User.first, format: :short)`
+        # - Reading a component's label without data: `comp.label(format: :short)`
         def label(data_or_format = nil, format: :long, &block)
           format = data_or_format if block_given?
           format ||= :long
@@ -42,7 +53,8 @@ module Compony
           end
         end
 
-        # DSL method and accessor
+        # DSL method and accessor for an icon.
+        # While this is not used in Compony directly, this is useful if your front-end uses an icon library such as fontawesome.
         def icon(&block)
           if block_given?
             @icon_block = block
@@ -52,6 +64,7 @@ module Compony
         end
 
         # DSL method and accessor
+        # While this is not used in Compony directly, this is useful if you use a custom button component class that supports colors.
         def color(&block)
           if block_given?
             @color_block = block

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

@@ -2,6 +2,10 @@ module Compony
   module ComponentMixins
     module Default
       module Standalone
+        # @api description
+        # Verb DSL override specifically for resourceful components
+        # @see Compony::ComponentMixins::Default::Standalone::VerbDsl
+        # @see Compony::ComponentMixins::Resourceful
         class ResourcefulVerbDsl < VerbDsl
           def initialize(...)
             # All resourceful components have a load_data_block, which defaults to the one defined in Resource, defaulting to finding the record.
@@ -9,6 +13,7 @@ module Compony
             super
           end
 
+          # For internal usage only, processes the block and returns a config hash.
           def to_conf(&)
             return super.deep_merge({
                                       load_data_block:         @load_data_block,

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

@@ -15,6 +15,7 @@ module Compony
             @layout = true # can be overriden by false or a string
           end
 
+          # For internal usage only, processes the block and returns a config hash.
           def to_conf(&block)
             evaluate(&block)
             @component = block.binding.eval('self') # Fetches the component holding this DSL call (via the block)
@@ -31,7 +32,9 @@ module Compony
 
           protected
 
-          # DSL
+          # DSL call for defining a config for a verb. The block runs within the verb DSL, positional and named arguments are passed to the verb DSL.
+          # @param verb [Symbol] The HTTP verb the config is for (e.g. :get, :post etc.)
+          # @see Compony::ComponentMixins::Default::Standalone::VerbDsl
           def verb(verb, *args, **nargs, &)
             verb = verb.to_sym
             verb_dsl_class = @component.resourceful? ? ResourcefulVerbDsl : VerbDsl
@@ -40,12 +43,15 @@ module Compony
           end
 
           # DSL
+          # Defines that for this component, no authentication should be performed.
           def skip_authentication!
             @skip_authentication = true
           end
 
           # DSL
-          # Defaults to Rails' default (layouts/application)
+          # Speficies the Rails layout (under `app/views/layouts`) that should be used to render this component.
+          # Defaults to Rails' default (`layouts/application`) if the method is never called.
+          # @param layout [String] name of the layout as you would give it to a Rails controller's `render` method
           def layout(layout)
             @layout = layout.to_s
           end

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

@@ -2,6 +2,10 @@ module Compony
   module ComponentMixins
     module Default
       module Standalone
+        # @api description
+        # DSL for speficying verb configs within a standalone config.
+        # @see Compony::ComponentMixins::Default::Standalone::VerbDsl for the verb DSL for resourceful components
+        # @see Compony::ComponentMixins::Default::Standalone::StandaloneDsl
         class VerbDsl < Dslblend::Base
           AVAILABLE_VERBS = %i[get head post put delete connect options trace patch].freeze
 
@@ -17,6 +21,7 @@ module Compony
             @authorize_block = nil
           end
 
+          # For internal usage only, processes the block and returns a config hash.
           def to_conf(&)
             evaluate(&) if block_given?
             return {

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

@@ -1,7 +1,8 @@
 module Compony
   module ComponentMixins
     module Default
-      # This contains all default component logic concerning standalone functionality
+      # @api description
+      # This contains all default component logic concerning standalone functionality. The module is included in every component.
       module Standalone
         extend ActiveSupport::Concern
 
@@ -12,8 +13,11 @@ module Compony
           attr_reader :standalone_configs
         end
 
-        # Called by fab_controller when a request is issued.
+        # Called by compony_controller when a request is issued.
         # This is the entrypoint where a request enters the Component world.
+        # @param verb_config [Hash] The config generated by Compony::ComponentMixins::Default::Standalone::VerbDsl#to_conf
+        # @param controller [ComponyController] The controller instance that calls this method.
+        # @see ComponyController
         def on_standalone_access(verb_config, controller)
           # Register as root comp
           if parent_comp.nil?

data/lib/compony/model_fields/association.rb

@@ -8,6 +8,7 @@ module Compony
 
       def value_for(data, link_to_component: nil, link_opts: {}, controller: nil)
         if link_to_component
+          fail('Must pass controller if link_to_component is given.') unless controller
           return transform_and_join(data.send(@name), controller:) do |el|
             el.nil? ? nil : controller.helpers.compony_link(link_to_component, el, **link_opts)
           end

data/lib/compony/model_fields/attachment.rb

@@ -0,0 +1,20 @@
+module Compony
+  module ModelFields
+    # @api description
+    # Model field type representing an ActiveStorage attachment.
+    class Attachment < 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 attachment.') unless controller
+          return nil unless el.attached?
+          return controller.helpers.link_to(I18n.t('compony.model_fields.attachment.download'), controller.helpers.rails_blob_path(el))
+        end
+      end
+
+      def simpleform_input(form, _component, accept: nil, **input_opts)
+        input_opts.merge!(input_html: { accept: }) if accept
+        return form.input(:proof_photo, **input_opts)
+      end
+    end
+  end
+end

data/lib/compony/version.rb

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

data/lib/compony.rb

@@ -11,7 +11,7 @@ module Compony
   # Setter for the global button component class. This allows you to implement a
   # custom button component and have all Compony button helpers use your custom
   # button component instead of {Compony::Components::Button}.
-  # @param button_component_class [Class] Your custom button component class (inherit from {Compony::Components::Button} or {Compony::Component})
+  # @param button_component_class [String] Name of your custom button component class (inherit from {Compony::Components::Button} or {Compony::Component})
   def self.button_component_class=(button_component_class)
     @button_component_class = button_component_class
   end
@@ -22,6 +22,7 @@ module Compony
   # the field type. The array is queried in order, if the first namespace does not
   # contain the class we're looking for, the next is considered and so on.
   # The classes defined in the namespace must inherit from Compony::ModelFields::Base
+  # @param model_field_namespaces [Array] Array of strings, the names of the namespaces in the order they should be searched
   def self.model_field_namespaces=(model_field_namespaces)
     @model_field_namespaces = model_field_namespaces
   end
@@ -34,6 +35,7 @@ module Compony
   # by {ComponyController} and the easiest way to achieve this is to implement
   # the action in your `ApplicationController`. If this is never called,
   # authentication is disabled.
+  # @param authentication_before_action [Symbol] Name of the method you want to call for authentication
   def self.authentication_before_action=(authentication_before_action)
     @authentication_before_action = authentication_before_action.to_sym
   end
@@ -98,7 +100,8 @@ module Compony
     return family_constant.const_get(comp_cst_str)
   end
 
-  # As above but fails if none found
+  # Same as Compony#comp_class_for but fails if none found
+  # @see Compony#comp_class_for
   def self.comp_class_for!(comp_name_or_cst, model_or_family_name_or_cst)
     comp_class_for(comp_name_or_cst, model_or_family_name_or_cst) || fail(
       "No component found for [#{comp_name_or_cst.inspect}, #{model_or_family_name_or_cst.inspect}]"
@@ -131,10 +134,11 @@ module Compony
   #                                    `Users`, `'Users'`, `:users`, `User.first`
   # @param label_opts [Hash] Options hash that will be passed to the label method (see {Compony::ComponentMixins::Default::Labelling#label})
   # @param params [Hash] GET parameters to be inclued into the path this button points to. Special case: e.g. format: :pdf -> some.url/foo/bar.pdf
+  # @param feasibility_action [Symbol] Name of the feasibility action that should be checked for this button, defaults to the component name
+  # @param feasibility_target [Symbol] Name of the feasibility target (subject) that the feasibility should be checked on, defaults to the model if given
   # @param override_kwargs [Hash] Override button options, see options for {Compony::Components::Button}
   # @see Compony::ViewHelpers#compony_button View helper providing a wrapper for this method that immediately renders a button.
   # @see Compony::Components::Button Compony::Components::Button: the default underlying implementation
-  # @todo add doc for feasibility
   def self.button(comp_name_or_cst,
                   model_or_family_name_or_cst,
                   label_opts: nil,
@@ -189,7 +193,9 @@ module Compony
   end
 
   # Overwrites the keys of the current button defaults by the ones provided during the execution of a given block and restores them afterwords.
-  # @todo document params
+  # This method is useful when the same set of options is to be given to a multitude of buttons.
+  # @param keys_to_overwrite [Hash] Options that should be given to the buttons within the block, with their values
+  # @param block [Block] Within this block, all omitted button options point to `keys_to_overwrite`
   def self.with_button_defaults(**keys_to_overwrite, &block)
     # Lazy initialize butto_defaults store if it hasn't been yet
     RequestStore.store[:button_defaults] ||= {}
@@ -233,8 +239,9 @@ require 'simple_form'
 
 require 'compony/engine'
 require 'compony/model_fields/base'
-require 'compony/model_fields/association'
 require 'compony/model_fields/anchormodel'
+require 'compony/model_fields/association'
+require 'compony/model_fields/attachment'
 require 'compony/model_fields/boolean'
 require 'compony/model_fields/currency'
 require 'compony/model_fields/date'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compony
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sandro Kalbermatter
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -160,6 +160,7 @@ files:
 - ".gitignore"
 - ".ruby-version"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -191,6 +192,7 @@ files:
 - lib/compony/method_accessible_hash.rb
 - lib/compony/model_fields/anchormodel.rb
 - lib/compony/model_fields/association.rb
+- lib/compony/model_fields/attachment.rb
 - lib/compony/model_fields/base.rb
 - lib/compony/model_fields/boolean.rb
 - lib/compony/model_fields/currency.rb