lifeform 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db20cd6cdb2581c3943d46e325a07a30ac89581cb6d29c1fd8297aab9663f202
-  data.tar.gz: ccd569f076822e5df6eecee26021b4a2f7044d5d91721f6b3523c6944bb64bfa
+  metadata.gz: 6f1e91a0e3977e9c1ee9bf2fadc00d427efa8f7fcf720ba0670905832e89e41c
+  data.tar.gz: 458c2edd232353260115c6eb794ebfcc7298696723e3ec5f49518ed8ccb68e19
 SHA512:
-  metadata.gz: 6d71ebf92fb482bdb9d34bb8ace8f1fae6625a191d6595fc73c0b144b11ab94f8d3352b2c03d43b9f4de64c9c67bace0ba6f40898d8165592132786dd25757b5
-  data.tar.gz: 800dbc481b4860d53c71b420cdb28da5b32d9781aecbe901ed75e1b8bfc36d1c6b626d504bfa377b68ceaff58158b47cead59406be31a1beb3a88fafd1cfbe17
+  metadata.gz: f8c0c7b398b5375cc50f0fb9d59ad5f759dcd05cd355fba4ed8c24c6c1e3e11c2447d888592f0c2ccb799a596bdfc23902fd822bd397cbf731c2ef77f453effc
+  data.tar.gz: e96679b59c1abae814f740ba190659eb29a4bae5c1fcc8809bff3336b138b13aded6f87d5bf0a2522ec86de80f8c98c1586eb8fcb81986edd242093294c0d1b0

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 
+## [0.2.0] - 2022-05-31
+
+- Fields now support content blocks, conditional rendering
+- Form subclass will now inherit parent form library
+
 ## [0.1.0] - 2022-05-29
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lifeform (0.1.0)
+    lifeform (0.4.0)
       activesupport (>= 6.0)
       papercraft (~> 0.24)
       zeitwerk (~> 2.5)
@@ -31,6 +31,8 @@ GEM
     minitest (5.15.0)
     nokogiri (1.13.6-arm64-darwin)
       racc (~> 1.4)
+    nokogiri (1.13.6-x86_64-linux)
+      racc (~> 1.4)
     papercraft (0.24)
       escape_utils (~> 1.2.1)
       kramdown (~> 2.3.1)
@@ -93,6 +95,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   lifeform!

data/README.md

@@ -12,7 +12,60 @@ $ bundle add lifeform
 
 ## Usage
 
-TODO: Write usage instructions here
+Full documentation coming as the library begins to mature. TL;DR:
+
+Given a form object of:
+
+```rb
+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
+```
+
+And a template rendering of:
+
+```erb
+<%= render TestForm.new(url: "/path") do %>
+  <%= render f.field(:occupation) %>
+  <%= render f.field(:age, value: 47) %>
+  <%= render f.field(:submit) %>
+<% end %>
+```
+
+You get the following HTML output:
+
+```html
+<form method="post" accept-charset="UTF-8" action="/path">
+  <input type="hidden" name="authenticity_token" value="[token]" />
+  <form-field name="occupation">
+    <label for="your-occupation">Your Job</label>
+    <input type="text" id="your-occupation" required name="occupation" />
+  </form-field>
+  <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>
+```
+
+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.
+
+### 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
 

data/lib/lifeform/form.rb

@@ -10,6 +10,11 @@ module Lifeform
     MODEL_PATH_HELPER = :polymorphic_path
 
     class << self
+      def inherited(subclass)
+        super
+        subclass.library library
+      end
+
       # Helper to point to `I18n.t` method
       def t(...)
         I18n.t(...)
@@ -26,7 +31,8 @@ module Lifeform
       end
 
       def library(library_name = nil)
-        @library ||= library_name || :default
+        @library = library_name if library_name
+        @library ||= :default
       end
 
       def escape_value(value)
@@ -112,17 +118,24 @@ module Lifeform
     end
 
     def field(name, **field_parameters)
+      # @type [FieldDefinition]
       field_definition = self.class.fields[name]
-      field_definition.library.object_for_field_definition(
+      # @type [Class<Libraries::Default>]
+      field_library = field_definition.library
+      field_library.object_for_field_definition(
         self, field_definition, self.class.parameters_to_attributes(field_parameters)
       )
     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
+                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

@@ -22,6 +22,7 @@ module Lifeform
           @model = attributes.delete(:model)
           @model = form.model if form.model && @model.nil?
 
+          @if = attributes.delete(:if)
           attributes[:value] ||= value_for_model if form.model
           attributes[:name] = "#{model_name}[#{attributes[:name]}]" if @model
           attributes[:id] ||= attributes[:name].parameterize(separator: "_")
@@ -50,16 +51,20 @@ module Lifeform
           end
         end
 
-        def render_in(view_context)
+        def render_in(view_context, &block)
           @view_context = view_context
+          @content = block
+          return "" if !@if.nil? && !@if
+
           template
         end
 
-        def template
-          Papercraft.html do |wrapper_tag:, input_tag:, attributes:, field_type:, field_label:|
+        def template # rubocop:disable Metrics/AbcSize
+          Papercraft.html do |wrapper_tag:, input_tag:, attributes:, field_data:|
             field_body = proc {
-              emit(field_label) if field_label
-              send input_tag, type: field_type, **attributes
+              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
 
@@ -68,8 +73,11 @@ module Lifeform
             wrapper_tag: self.class.const_get(:WRAPPER_TAG),
             input_tag: self.class.const_get(:INPUT_TAG),
             attributes: attributes,
-            field_type: @field_type,
-            field_label: @label
+            field_data: {
+              type: @field_type,
+              label: @label,
+              content: @content && @view_context.capture(&@content)
+            }
           )
         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/libraries/default.rb

@@ -5,6 +5,9 @@ module Lifeform
     class Default
       FORM_TAG = :form
 
+      # @param form [LifeForm::Form]
+      # @param field_definition [LifeForm::FieldDefinition]
+      # @param attributes [Hash]
       # @return [Input]
       def self.object_for_field_definition(form, field_definition, attributes)
         type_classname = field_definition[:type].to_s.classify

data/lib/lifeform/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifeform
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-30 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