lifeform 0.3.0 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43833cf5f9112ae7e24d2f14e24f41629e7a728740ee768383c7072e9484eb69
-  data.tar.gz: db8424032dc11a96dc91ac8bb653e317bca8215de44c15664fed68c8b91f97de
+  metadata.gz: b554a393fe6d14365108e97b9da374e73da67f0d6728b8605f6d2ddea2f3e3f5
+  data.tar.gz: 5749f82de0a38dd41d7fd75245ed1cab66b0b2550bdabc722620e70c2345bf37
 SHA512:
-  metadata.gz: edd2ea3eabdad15d8dc27d2da4cf07b04bc0d00302761ecef5562a0dd999ffa5badf9f7c9eb53a322a309dee7d75cf1475aa952f1f1944cb5ff065517f0f0120
-  data.tar.gz: 33fb2e8b4276da626de9736cd568a6c34be23cade8eed0a0672cb1e909b5b911aca8136334d61e07d5b04937b450b7126066dfa1ebfb7c46d8af719d518147ec
+  metadata.gz: 86f68d5c0673570a0e549c2f68afb731b749ab305fb9a3a2f2013820389985cd3468b56263ec738ee113a90c49889cc755efd93427c985788af84e37b83b2d56
+  data.tar.gz: d6f72691ee444c44f78a8b8c1bfb7f93c10105398d77f4be6c593e96d85bf58ee031c7fe30f572a133ebeffdd3791aaed2b99438848e27e51431e4da048690a5

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## [Unreleased]
 
+## [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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lifeform (0.3.0)
+    lifeform (0.5)
       activesupport (>= 6.0)
       papercraft (~> 0.24)
       zeitwerk (~> 2.5)

data/README.md

@@ -20,6 +20,8 @@ Given a form object of:
 class TestForm < Lifeform::Form
   field :occupation, label: "Your Job", id: "your-occupation", required: true
   field :age, library: :shoelace, label: "Your Age"
+
+  field :submit, type: :submit_button, label: "Save", class: "font-bold"
 end
 ```
 
@@ -29,6 +31,7 @@ And a template rendering of:
 <%= render TestForm.new(url: "/path") do %>
   <%= render f.field(:occupation) %>
   <%= render f.field(:age, value: 47) %>
+  <%= render f.field(:submit) %>
 <% end %>
 ```
 
@@ -44,6 +47,9 @@ You get the following HTML output:
   <form-field name="age">
     <sl-input type="text" label="Your Age" name="age" value="47" id="age"></sl-input>
   </form-field>
+  <form-button name="commit">
+    <button class="font-bold" name="commit" type="submit">Save</button>
+  </form-button>
 </form>
 ```
 

data/lib/lifeform/form.rb

@@ -6,7 +6,7 @@ module Lifeform
   FieldDefinition = Struct.new(:type, :library, :parameters)
 
   # A form object which stores field definitions and can be rendered as a component
-  class Form
+  class Form # rubocop:todo Metrics/ClassLength
     MODEL_PATH_HELPER = :polymorphic_path
 
     class << self
@@ -25,13 +25,21 @@ 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
 
@@ -65,6 +73,17 @@ module Lifeform
 
         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 +101,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"
@@ -119,7 +145,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,6 +153,14 @@ module Lifeform
       )
     end
 
+    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
+
     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)
@@ -134,7 +168,9 @@ module Lifeform
       content = if block
                   view_context.capture(self, &block)
                 else
-                  self.class.fields.map { |k, _v| field(k).render_in(self) }.join
+                  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

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Lifeform
+  module Libraries
+    class Default
+      class Button
+        attr_reader :form, :field_definition, :attributes
+
+        WRAPPER_TAG = :form_button
+        BUTTON_TAG = :button
+
+        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
+        end
+
+        def render_in(view_context, &block)
+          @view_context = view_context
+          @content = block
+          return "" if !@if.nil? && !@if
+
+          template
+        end
+
+        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)
+            }
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -30,10 +30,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

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lifeform
+  module Libraries
+    class Default
+      class SubmitButton < Button
+        def initialize(form, field_definition, **attributes)
+          attributes[:name] ||= "commit"
+          attributes[:type] = :submit
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/lifeform/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifeform
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: '0.5'
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -74,7 +74,9 @@ files:
 - lib/lifeform.rb
 - lib/lifeform/form.rb
 - lib/lifeform/libraries/default.rb
+- lib/lifeform/libraries/default/button.rb
 - lib/lifeform/libraries/default/input.rb
+- lib/lifeform/libraries/default/submit_button.rb
 - lib/lifeform/libraries/shoelace.rb
 - lib/lifeform/libraries/shoelace/input.rb
 - lib/lifeform/version.rb