lifeform 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1a951565aa5729c703d08032dc10a135d57f39be110ea7a77f1daea226ea7b5
-  data.tar.gz: b6411dc03979e7e69b30c51f99861565323ec39a7687148a3b4705a5ef4040f9
+  metadata.gz: 9dbdb103263edf279b32445d6faa8d4b0cbb6cacf21fe7b8f520af8a5896d0e0
+  data.tar.gz: 01fe12ea7c14e7b488ea1a383e7158c8d63adce6346a4c869613419046d5ec58
 SHA512:
-  metadata.gz: fb6e4f3177e0cc95c89ed7fe898ce977abbdfd755e53e6706edaf3c362508b56944f779f49bb0f82f4ce3f4f79817e4056352e15c2fbe7382defee52b2568037
-  data.tar.gz: 2fd2aa7715782c21847cbaa5fac8ac6e692711a944ad6fe627c2df378380677d5ddd6b62429c7f073103a8750d5af7093ef2b6664b490f8f67d6594ecc1e82d6
+  metadata.gz: 7272ba2e8224d31ed4b8313bec9056dcef6f82c995119ca43f8381d55aa304eff8119e1055bc7a838a17b61225efdb09200485d79edf30d4c5c616551f52a453
+  data.tar.gz: 788fe1a1ec8ea8d70d10b7e90f3993443a2f71040dc68e547095c07c3688d9afd41b16afe1c33456a63dffe8273a2fc2f833c87201b10553c1d5cede1d8b5842

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lifeform (0.2.0)
+    lifeform (0.4.1)
       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>
 ```
 
@@ -51,6 +57,16 @@ Nested names based on models (aka `profile[name]`) and inferred action paths are
 
 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.
 
+### Automatic Field Rendering
+
+For simple forms, you can avoid the need to render fields individually in your template. Given the form example above, you could write in your template:
+
+```erb
+<%= render TestForm.new(url: "/path") %>
+```
+
+And the fields defined in `TestForm` would render out automatically (since no block was provided to the `render` method).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

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
@@ -127,11 +127,17 @@ module Lifeform
       )
     end
 
-    def render_in(view_context, &block) # rubocop:disable Metrics/AbcSize
+    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 = view_context.capture(self, &block)
+      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
 

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/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.2.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifeform
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-31 00:00:00.000000000 Z
+date: 2022-06-08 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