lifeform 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db20cd6cdb2581c3943d46e325a07a30ac89581cb6d29c1fd8297aab9663f202
-  data.tar.gz: ccd569f076822e5df6eecee26021b4a2f7044d5d91721f6b3523c6944bb64bfa
+  metadata.gz: c1a951565aa5729c703d08032dc10a135d57f39be110ea7a77f1daea226ea7b5
+  data.tar.gz: b6411dc03979e7e69b30c51f99861565323ec39a7687148a3b4705a5ef4040f9
 SHA512:
-  metadata.gz: 6d71ebf92fb482bdb9d34bb8ace8f1fae6625a191d6595fc73c0b144b11ab94f8d3352b2c03d43b9f4de64c9c67bace0ba6f40898d8165592132786dd25757b5
-  data.tar.gz: 800dbc481b4860d53c71b420cdb28da5b32d9781aecbe901ed75e1b8bfc36d1c6b626d504bfa377b68ceaff58158b47cead59406be31a1beb3a88fafd1cfbe17
+  metadata.gz: fb6e4f3177e0cc95c89ed7fe898ce977abbdfd755e53e6706edaf3c362508b56944f779f49bb0f82f4ce3f4f79817e4056352e15c2fbe7382defee52b2568037
+  data.tar.gz: 2fd2aa7715782c21847cbaa5fac8ac6e692711a944ad6fe627c2df378380677d5ddd6b62429c7f073103a8750d5af7093ef2b6664b490f8f67d6594ecc1e82d6

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.2.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,44 @@ $ 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"
+end
+```
+
+And a template rendering of:
+
+```erb
+<%= render TestForm.new(url: "/path") do %>
+  <%= render f.field(:occupation) %>
+  <%= render f.field(:age, value: 47) %>
+<% 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>
+```
+
+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.
 
 ## 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,8 +118,11 @@ 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

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.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.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifeform
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-30 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport