lifeform 0.4.1 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dbdb103263edf279b32445d6faa8d4b0cbb6cacf21fe7b8f520af8a5896d0e0
-  data.tar.gz: 01fe12ea7c14e7b488ea1a383e7158c8d63adce6346a4c869613419046d5ec58
+  metadata.gz: 0bd913233e25c58ae11c6e356383384f4fd995a35a530f62525524abbb3902f2
+  data.tar.gz: a9cbb5ec298a1e291486fe993f14c69a6aff0ef35baf1ec061d9e9bc93e87b78
 SHA512:
-  metadata.gz: 7272ba2e8224d31ed4b8313bec9056dcef6f82c995119ca43f8381d55aa304eff8119e1055bc7a838a17b61225efdb09200485d79edf30d4c5c616551f52a453
-  data.tar.gz: 788fe1a1ec8ea8d70d10b7e90f3993443a2f71040dc68e547095c07c3688d9afd41b16afe1c33456a63dffe8273a2fc2f833c87201b10553c1d5cede1d8b5842
+  metadata.gz: 144a5f5b14116f6471acd45c66fb369119d2256a6da724a83df428819d694d3ff017f539c0a2fd7b0ff9f94237d57216116efdd60aac8524e11b3fdb93f801b2
+  data.tar.gz: 892413ee58661eb72851f2fbd0ffc1b4a831cbab406eac8f61d17a03ced7c06e59c5b5716659d5e0df5b90c15ab65569e2819fbf3ccd3be30dcf0a2607a09751

data/.rubocop.yml

@@ -1,11 +1,22 @@
+require:
+ - rubocop-minitest
+ - rubocop-rake
+
 AllCops:
   TargetRubyVersion: 2.7
   NewCops: enable
 
+Lint/MissingSuper:
+  Enabled: false
+
 Metrics/AbcSize:
   Exclude:
   - test/**/*.rb
 
+Metrics/ClassLength:
+  Exclude:
+  - test/**/*.rb
+
 Metrics/MethodLength:
   Max: 20
   Exclude:

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## [Unreleased]
 
+## [0.7.0] - 2022-09-30
+
+- Rearchitect library to be built on top of the Phlex view library
+
+## [0.5.0] - 2022-06-10
+
+## [0.4.0] - 2022-06-08
+
+- Add support for submit buttons
+
+## [0.3.0] - 2022-06-08
+
+- Add automatic field rendering
+
 ## [0.2.0] - 2022-05-31
 
 - Fields now support content blocks, conditional rendering

data/Gemfile

@@ -8,6 +8,7 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+gem "minitest-reporters", "~> 1.5"
 
 gem "rubocop", "~> 1.21"
 

data/Gemfile.lock

@@ -1,69 +1,75 @@
 PATH
   remote: .
   specs:
-    lifeform (0.4.1)
+    lifeform (0.7)
       activesupport (>= 6.0)
-      papercraft (~> 0.24)
+      phlex (~> 0.3)
       zeitwerk (~> 2.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    ansi (1.5.0)
     ast (2.4.2)
     backport (1.2.0)
     benchmark (0.2.0)
+    builder (3.2.4)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     e2mmap (0.1.0)
-    escape_utils (1.2.1)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    kramdown (2.3.2)
+    json (2.6.2)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    minitest (5.15.0)
-    nokogiri (1.13.6-arm64-darwin)
+    minitest (5.16.3)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    nokogiri (1.13.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.6-x86_64-linux)
+    nokogiri (1.13.8-x86_64-linux)
       racc (~> 1.4)
-    papercraft (0.24)
-      escape_utils (~> 1.2.1)
-      kramdown (~> 2.3.1)
-      kramdown-parser-gfm (~> 1.1.0)
-      rouge (~> 3.27.0)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
+    phlex (0.3.1)
+      syntax_tree (~> 3.6)
+      zeitwerk (~> 2.6)
+    prettier_print (0.1.0)
     racc (1.6.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    regexp_parser (2.6.0)
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
-    rouge (3.27.0)
-    rubocop (1.30.0)
+    rubocop (1.36.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
+    rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
-    rubocop-minitest (0.20.0)
+    rubocop-minitest (0.20.1)
       rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
@@ -83,15 +89,17 @@ GEM
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
+    syntax_tree (3.6.1)
+      prettier_print
     thor (1.2.1)
-    tilt (2.0.10)
-    tzinfo (2.0.4)
+    tilt (2.0.11)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.3.0)
     webrick (1.7.0)
-    yard (0.9.27)
+    yard (0.9.28)
       webrick (~> 1.7.0)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   arm64-darwin-21
@@ -100,6 +108,7 @@ PLATFORMS
 DEPENDENCIES
   lifeform!
   minitest (~> 5.0)
+  minitest-reporters (~> 1.5)
   rails-dom-testing (~> 2.0)
   rake (~> 13.0)
   rubocop (~> 1.21)

data/README.md

@@ -55,7 +55,7 @@ You get the following HTML output:
 
 Nested names based on models (aka `profile[name]`) and inferred action paths are supported as well.
 
-Multiple component libraries and input types—and easy customizability via [Papercraft](https://github.com/digital-fabric/papercraft) templates—are a fundamental aspect of the architecture of Lifeform.
+Multiple component libraries and input types—and easy customizability via [Phlex](https://github.com/joeldrapper/phlex) templates—are a fundamental aspect of the architecture of Lifeform.
 
 ### Automatic Field Rendering
 

data/lib/lifeform/capturing_renderable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lifeform
+  module CapturingRenderable
+    # NOTE: the previous `with_output_buffer` stuff is for some reason incompatible with Serbea.
+    # So we'll use a simpler capture.
+    def render_in(view_context, &block)
+      if block
+        call(view_context: view_context) do |*args, **kwargs|
+          raw(view_context.capture(*args, **kwargs, &block))
+        end.html_safe
+      else
+        call(view_context: view_context).html_safe
+      end
+    end
+  end
+end

data/lib/lifeform/form.rb

@@ -6,7 +6,8 @@ module Lifeform
   FieldDefinition = Struct.new(:type, :library, :parameters)
 
   # A form object which stores field definitions and can be rendered as a component
-  class Form # rubocop:todo Metrics/ClassLength
+  class Form < Phlex::View # rubocop:todo Metrics/ClassLength
+    include CapturingRenderable
     MODEL_PATH_HELPER = :polymorphic_path
 
     class << self
@@ -25,46 +26,66 @@ module Lifeform
         @fields ||= {}
       end
 
+      def subforms
+        @subforms ||= {}
+      end
+
       def field(name, type: :text, library: self.library, **parameters)
-        parameters[:name] = name
+        parameters[:name] = name.to_sym
         fields[name] = FieldDefinition.new(type, Libraries.const_get(library.to_s.classify), parameters)
       end
 
+      def subform(name, klass, parent_name: nil)
+        subforms[name.to_sym] = { class: klass, parent_name: parent_name }
+      end
+
       def library(library_name = nil)
-        @library = library_name if library_name
+        @library = library_name.to_sym if library_name
         @library ||= :default
       end
 
-      def escape_value(value)
+      def process_value(key, value)
+        return value if key == :if
+
         case value
-        when TrueClass, FalseClass
-          value
+        when TrueClass
+          key.to_s
+        when FalseClass
+          nil
+        when Symbol, Integer
+          value.to_s
         else
-          EscapeUtils.escape_html(value.to_s)
+          value
         end
       end
 
       # @param kwargs [Hash]
       def parameters_to_attributes(kwargs)
-        previous_value = EscapeUtils.html_secure
-        EscapeUtils.html_secure = false
-
         attributes = {}
         kwargs.each do |key, value|
           case value
           when Hash
             value.each do |inner_key, inner_value|
-              attributes[:"#{key}_#{inner_key}"] = escape_value(inner_value)
+              attributes[:"#{key}_#{inner_key}"] = process_value(inner_key, inner_value)
             end
           else
-            attributes[key] = escape_value(value) unless value.nil?
+            attributes[key] = process_value(key, value) unless value.nil?
           end
         end
 
-        EscapeUtils.html_secure = previous_value
-
         attributes
       end
+
+      def name_of_model(model)
+        return "" if model.nil?
+
+        if model.respond_to?(:to_model)
+          model.to_model.model_name.param_key
+        else
+          # Or just use basic underscore
+          model.class.name.underscore.tr("/", "_")
+        end
+      end
     end
 
     # @return [Object]
@@ -82,9 +103,16 @@ module Lifeform
     # @return [Boolean]
     attr_reader :emit_form_tag
 
-    def initialize(model = nil, url: nil, library: self.class.library, emit_form_tag: true, **parameters)
-      @model, @url, @library_name, @parameters, @emit_form_tag = model, url, library, parameters, emit_form_tag
+    # @return [Boolean]
+    attr_reader :parent_name
+
+    def initialize( # rubocop:disable Metrics/ParameterLists
+      model = nil, url: nil, library: self.class.library, emit_form_tag: true, parent_name: nil, **parameters
+    )
+      @model, @url, @library_name, @parameters, @emit_form_tag, @parent_name =
+        model, url, library, parameters, emit_form_tag, parent_name
       @library = Libraries.const_get(@library_name.to_s.classify)
+      @subform_instances = {}
 
       parameters[:method] ||= model.respond_to?(:persisted?) && model.persisted? ? :patch : :post
       parameters[:accept_charset] ||= "UTF-8"
@@ -94,20 +122,27 @@ module Lifeform
     def verify_method
       return if %w[get post].include?(parameters[:method].to_s.downcase)
 
-      @method_tag = Papercraft.html do |method_name|
-        input type: "hidden", name: "_method", value: method_name, autocomplete: "off"
-      end.render(parameters[:method].to_s.downcase)
+      @method_tag = Class.new(Phlex::View) do # TODO: break this out into a real component
+        def initialize(method:)
+          @method = method
+        end
+
+        def template
+          input type: "hidden", name: "_method", value: @method, autocomplete: "off"
+        end
+      end.new(method: @parameters[:method].to_s.downcase)
+
       parameters[:method] = :post
     end
 
-    def add_authenticity_token(view_context) # rubocop:disable Metrics/AbcSize
-      if view_context.respond_to?(:token_tag, true) # Rails
-        view_context.send(:token_tag, nil, form_options: {
-                            action: parameters[:action].to_s,
-                            method: parameters[:method].to_s.downcase
-                          })
-      elsif view_context.respond_to?(:csrf_tag, true) # Roda
-        view_context.send(:csrf_tag, action: parameters[:action].to_s, method: parameters[:method].to_s)
+    def add_authenticity_token # rubocop:disable Metrics/AbcSize
+      if helpers.respond_to?(:token_tag, true) # Rails
+        helpers.send(:token_tag, nil, form_options: {
+                       action: parameters[:action].to_s,
+                       method: parameters[:method].to_s.downcase
+                     })
+      elsif helpers.respond_to?(:csrf_tag, true) # Roda
+        helpers.send(:csrf_tag, action: parameters[:action].to_s, method: parameters[:method].to_s)
       else
         raise Lifeform::Error, "Missing token tag helper. Override `add_authenticity_token' in your Form object"
       end
@@ -119,7 +154,7 @@ module Lifeform
 
     def field(name, **field_parameters)
       # @type [FieldDefinition]
-      field_definition = self.class.fields[name]
+      field_definition = self.class.fields[name.to_sym]
       # @type [Class<Libraries::Default>]
       field_library = field_definition.library
       field_library.object_for_field_definition(
@@ -127,30 +162,27 @@ module Lifeform
       )
     end
 
-    def render_in(view_context, &block) # rubocop:disable Metrics
-      form_tag = library::FORM_TAG
-      parameters[:action] ||= url || (model ? view_context.send(self.class.const_get(:MODEL_PATH_HELPER), model) : nil)
-
-      content = if block
-                  view_context.capture(self, &block)
-                else
-                  self.class.fields.map { |k, _v| field(k).render_in(self) }.join.then do |renderings|
-                    renderings.respond_to?(:html_safe) ? renderings.html_safe : renderings
-                  end
-                end
-
-      return content unless emit_form_tag
+    def subform(name, model = nil)
+      @subform_instances[name.to_sym] ||= self.class.subforms[name.to_sym][:class].new(
+        model,
+        emit_form_tag: false,
+        parent_name: self.class.subforms[name.to_sym][:parent_name] || self.class.name_of_model(self.model)
+      )
+    end
 
-      content = add_authenticity_token(view_context) + content.to_s unless parameters[:method].to_s.downcase == "get"
-      content = @method_tag + content.to_s if @method_tag
+    def template(&block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      form_tag = library::FORM_TAG
+      parameters[:action] ||= url || (model ? helpers.send(self.class.const_get(:MODEL_PATH_HELPER), model) : nil)
 
-      # if @hidden_submit_button
-      #   content += %(\n<button type="submit" style="position: absolute; left: -9999px"></button>).html_safe
-      # end
+      send(form_tag, **attributes) do
+        raw(add_authenticity_token) unless parameters[:method].to_s.downcase == "get"
+        raw @method_tag&.() || ""
+        block ? yield_content(&block) : auto_render_fields
+      end
+    end
 
-      Papercraft.html do |attr|
-        send(form_tag, **attr) { emit content }
-      end.render(attributes)
+    def auto_render_fields
+      self.class.fields.map { |k, _v| render(field(k)) }
     end
   end
 end

data/lib/lifeform/libraries/default/button.rb

@@ -3,48 +3,40 @@
 module Lifeform
   module Libraries
     class Default
-      class Button
+      class Button < Phlex::View
+        include CapturingRenderable
+
         attr_reader :form, :field_definition, :attributes
 
         WRAPPER_TAG = :form_button
         BUTTON_TAG = :button
 
+        register_element WRAPPER_TAG
+
         def initialize(form, field_definition, **attributes)
           @form = form
           @field_definition = field_definition
           @attributes = Lifeform::Form.parameters_to_attributes(field_definition.parameters).merge(attributes)
           @if = @attributes.delete(:if)
           @label = @attributes.delete(:label) || "Unlabeled Button"
-          @attributes[:type] ||= :button
+          @attributes[:type] ||= "button"
         end
 
-        def render_in(view_context, &block)
-          @view_context = view_context
-          @content = block
-          return "" if !@if.nil? && !@if
+        def template(&block)
+          return if !@if.nil? && !@if
 
-          template
-        end
+          wrapper_tag = self.class.const_get(:WRAPPER_TAG)
+          button_tag = self.class.const_get(:BUTTON_TAG)
+
+          field_body = proc {
+            send(button_tag, **@attributes) do
+              raw(@label.to_s) unless block
+              yield_content(&block)
+            end
+          }
+          return field_body.() unless wrapper_tag
 
-        def template # rubocop:disable Metrics/AbcSize
-          Papercraft.html do |wrapper_tag:, button_tag:, attributes:, field_data:|
-            field_body = proc {
-              send(button_tag, **attributes) do
-                emit field_data[:content] || field_data[:label]
-              end
-            }
-            next field_body.call unless wrapper_tag
-
-            send wrapper_tag, name: attributes[:name], &field_body
-          end.render(
-            wrapper_tag: self.class.const_get(:WRAPPER_TAG),
-            button_tag: self.class.const_get(:BUTTON_TAG),
-            attributes: attributes,
-            field_data: {
-              label: @label,
-              content: @content && @view_context.capture(&@content)
-            }
-          )
+          send wrapper_tag, name: @attributes[:name], &field_body
         end
       end
     end

data/lib/lifeform/libraries/default/input.rb

@@ -3,11 +3,15 @@
 module Lifeform
   module Libraries
     class Default
-      class Input
+      class Input < Phlex::View
+        include CapturingRenderable
+
         attr_reader :form, :field_definition, :attributes
 
-        INPUT_TAG = :input
         WRAPPER_TAG = :form_field
+        INPUT_TAG = :input
+
+        register_element WRAPPER_TAG
 
         def initialize(form, field_definition, **attributes)
           @form = form
@@ -30,10 +34,9 @@ module Lifeform
         end
 
         def model_name
-          return @model.to_model.model_name.param_key if @model.respond_to?(:to_model)
+          name_of_model = @form.class.name_of_model(@model)
 
-          # Or just use basic underscore
-          @model.class.name.underscore.tr("/", "_")
+          form.parent_name ? "#{form.parent_name}[#{name_of_model}]" : name_of_model
         end
 
         def value_for_model
@@ -41,44 +44,30 @@ module Lifeform
         end
 
         def handle_labels
-          Papercraft.html do |label_text, name|
-            label label_text, for: name
-          end.render(
-            attributes[:label].to_s,
-            (attributes[:id] || attributes[:name]).to_s
-          ).tap do
-            @attributes = attributes.filter_map { |k, v| [k, v] unless k == :label }.to_h
-          end
-        end
+          label_text = attributes[:label].to_s
+          label_name = (attributes[:id] || attributes[:name]).to_s
 
-        def render_in(view_context, &block)
-          @view_context = view_context
-          @content = block
-          return "" if !@if.nil? && !@if
+          @attributes = attributes.filter_map { |k, v| [k, v] unless k == :label }.to_h
 
-          template
+          proc {
+            label(for: label_name) { raw label_text }
+          }
         end
 
-        def template # rubocop:disable Metrics/AbcSize
-          Papercraft.html do |wrapper_tag:, input_tag:, attributes:, field_data:|
-            field_body = proc {
-              emit(field_data[:label]) if field_data[:label]
-              send input_tag, type: field_data[:type], **attributes
-              emit(field_data[:content]) if field_data[:content]
-            }
-            next field_body.call unless wrapper_tag
-
-            send wrapper_tag, name: attributes[:name], &field_body
-          end.render(
-            wrapper_tag: self.class.const_get(:WRAPPER_TAG),
-            input_tag: self.class.const_get(:INPUT_TAG),
-            attributes: attributes,
-            field_data: {
-              type: @field_type,
-              label: @label,
-              content: @content && @view_context.capture(&@content)
-            }
-          )
+        def template(&block)
+          return if !@if.nil? && !@if
+
+          wrapper_tag = self.class.const_get(:WRAPPER_TAG)
+          input_tag = self.class.const_get(:INPUT_TAG)
+
+          field_body = proc {
+            @label&.()
+            send input_tag, type: @field_type.to_s, **@attributes
+            yield_content(&block)
+          }
+          return field_body.() unless wrapper_tag
+
+          send wrapper_tag, name: @attributes[:name], &field_body
         end
       end
     end

data/lib/lifeform/libraries/default/submit_button.rb

@@ -6,7 +6,7 @@ module Lifeform
       class SubmitButton < Button
         def initialize(form, field_definition, **attributes)
           attributes[:name] ||= "commit"
-          attributes[:type] = :submit
+          attributes[:type] = "submit"
 
           super
         end

data/lib/lifeform/libraries/shoelace/input.rb

@@ -6,6 +6,8 @@ module Lifeform
       class Input < Default::Input
         INPUT_TAG = :sl_input
 
+        register_element :sl_input
+
         # no-op
         def handle_labels; end
       end

data/lib/lifeform/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lifeform
-  VERSION = "0.4.1"
+  VERSION = "0.7"
 end

data/lib/lifeform.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require "papercraft"
+require "phlex"
+require "active_support/core_ext/string/output_safety"
 
 require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem

data/lifeform.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "activesupport", ">= 6.0"
-  spec.add_dependency "papercraft", "~> 0.24"
+  spec.add_dependency "phlex", "~> 0.3"
   spec.add_dependency "zeitwerk", "~> 2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifeform
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: '0.7'
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: papercraft
+  name: phlex
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,7 @@ files:
 - bin/rubocop
 - bin/setup
 - lib/lifeform.rb
+- lib/lifeform/capturing_renderable.rb
 - lib/lifeform/form.rb
 - lib/lifeform/libraries/default.rb
 - lib/lifeform/libraries/default/button.rb