lifeform 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a757ed6ce30cf3a892760a6b9c3c9ba3699475cc8502a90e9de07b56a7a3fb2a
-  data.tar.gz: e17f65492dbc44c4a1e874f56b3a336941db2b914986cecce64006119ff71383
+  metadata.gz: 283c7f42b6108a032fe1ba52472eeaedac36cc0b07e70eb061f23b931724b729
+  data.tar.gz: 8640ba714e28cf0a0eb0a5dd7c7f48aaac37e75d2b0c6170a135983570abb4ee
 SHA512:
-  metadata.gz: 3a607e2b89f5c52e5ae900b60b53009e5b59f8591ab1ff08b27378eff829cc3eaaa0436561d39caaa0d69583501919132b50856098747f979389c5125d3d2316
-  data.tar.gz: badaefd5cd10695da7730f2441cbccaa5e439c6be23e3e77a3d0121dc6be12aecaa0fca28710b65d5990c4359d8c1033f9f56ef7daf3bb44cace089b7958552f
+  metadata.gz: 05eb1d7fbc094ae6e3450906da2671e4f4604f7f0fd8da0acdf734a9e445d129c7796c1cb8cb0a703787cbd4d7f43589dbdf56c0af7f4f4ce73076d561eaeb27
+  data.tar.gz: f6a208d9430d77c6bb8087f7331b197fc76bdb0d7f88d3ef72f9406d8e00823a7bb36c49838c682961aee50934e40b795389086655221fba2bb70b870a0941d8

data/.rubocop.yml

@@ -7,7 +7,7 @@ inherit_gem:
   rubocop-bridgetown: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.2
   NewCops: enable
 
   Exclude:
@@ -28,10 +28,20 @@ AllCops:
 Layout/MultilineBlockLayout:
   Enabled: false
 
+Layout/SpaceBeforeFirstArg:
+  Enabled: false
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+
 Metrics/AbcSize:
   Exclude:
   - test/**/*.rb
 
+Metrics/BlockLength:
+  Exclude:
+  - test/**/*.rb
+
 Metrics/ClassLength:
   Exclude:
   - test/**/*.rb
@@ -42,3 +52,7 @@ Metrics/MethodLength:
 
 Layout/LineLength:
   Max: 120
+
+Lint/Void:
+  Exclude:
+  - test/**/*.rb

data/.ruby-version

@@ -1 +1 @@
-ruby-3.1.4
+ruby-3.2.6

data/.solargraph.yml

@@ -0,0 +1,13 @@
+include:
+- "**/*.rb"
+exclude:
+- vendor/**/*
+- ".bundle/**/*"
+require:
+- "bridgetown-foundation"
+- "streamlined"
+domains: []
+reporters:
+- rubocop
+- require_not_found
+max_files: 5000

data/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+.
+
+## [0.17.0] - 2025-12-16
+
+- Add `fragment` "field" type for adding arbitrary HTML sections to forms
+- Allow disabling csrf protection
+- Convert tests to spec style and add "Intuitive Expectations"
+  - remove rails-dom-testing
+  - bump minimum Ruby to 3.2
+
 ## [0.16.0] - 2025-09-11
 
 - Migrate repo to Codeberg

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source "https://gem.coop"
 
 # Specify your gem's dependencies in lifeform.gemspec
 gemspec
@@ -12,10 +12,10 @@ gem "minitest-reporters", "~> 1.5"
 
 gem "rubocop", "~> 1.21"
 gem "rubocop-bridgetown", "~> 0.4"
-
-gem "solargraph", "~> 0.45.0"
-
-gem "rails-dom-testing", "~> 2.0"
-
 gem "rubocop-minitest", "~> 0.20.0"
 gem "rubocop-rake", "~> 0.6.0"
+
+gem "solargraph", "~> 0.50"
+
+gem "bridgetown-foundation", "~> 2.0.4"
+gem "nokolexbor", "~> 0.6.2"

data/Gemfile.lock

@@ -1,144 +1,148 @@
 PATH
   remote: .
   specs:
-    lifeform (0.16.0)
+    lifeform (0.17.0)
       hash_with_dot_access (>= 1.2)
       sequel (>= 5.72)
       streamlined (>= 0.2.0)
       zeitwerk (~> 2.5)
 
 GEM
-  remote: https://rubygems.org/
+  remote: https://gem.coop/
   specs:
-    activesupport (7.1.3.2)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
     ansi (1.5.0)
-    ast (2.4.2)
+    ast (2.4.3)
     backport (1.2.0)
-    base64 (0.2.0)
-    benchmark (0.3.0)
-    bigdecimal (3.1.7)
-    builder (3.2.4)
-    concurrent-ruby (1.2.3)
-    connection_pool (2.4.1)
-    diff-lcs (1.5.1)
-    drb (2.2.1)
-    e2mmap (0.1.0)
+    benchmark (0.5.0)
+    bigdecimal (3.3.1)
+    bridgetown-foundation (2.0.4)
+      hash_with_dot_access (~> 2.0)
+      inclusive (~> 1.0)
+      zeitwerk (~> 2.5)
+    builder (3.3.0)
+    diff-lcs (1.6.2)
     erubi (1.13.1)
     hash_with_dot_access (2.2.0)
-    i18n (1.14.4)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.6)
-    json (2.7.2)
-    kramdown (2.4.0)
-      rexml
+    inclusive (1.1.0)
+    jaro_winkler (1.6.1)
+    json (2.16.0)
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    language_server-protocol (3.17.0.3)
-    minitest (5.22.3)
-    minitest-reporters (1.6.1)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.26.0)
+    minitest-reporters (1.7.1)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    mutex_m (0.2.0)
-    nokogiri (1.16.4-arm64-darwin)
+    nokogiri (1.18.10-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.4-x86_64-linux)
+    nokogiri (1.18.10-x86_64-linux-gnu)
       racc (~> 1.4)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    nokolexbor (0.6.2-x86_64-linux)
+    observer (0.1.2)
+    ostruct (0.6.3)
+    parallel (1.27.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
-    rails-dom-testing (2.2.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
+    prism (1.6.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.9.0)
-    reverse_markdown (2.1.1)
+    rake (13.3.1)
+    rbs (3.9.5)
+      logger
+    regexp_parser (2.11.3)
+    reverse_markdown (3.0.0)
       nokogiri
-    rexml (3.2.6)
-    rubocop (1.63.2)
+    rexml (3.4.4)
+    rubocop (1.81.7)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
-    rubocop-bridgetown (0.5.0)
-      rubocop (~> 1.23)
-      rubocop-performance (~> 1.12)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-bridgetown (0.7.0)
+      rubocop (~> 1.72)
+      rubocop-performance (~> 1.24)
     rubocop-minitest (0.20.1)
       rubocop (>= 0.90, < 2.0)
-    rubocop-performance (1.21.0)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
-    sequel (5.96.0)
+    sequel (5.98.0)
       bigdecimal
-    serbea (2.3.0)
-      erubi (>= 1.11)
-      tilt (>= 2.1)
-    solargraph (0.45.0)
+    serbea (2.4.0)
+      erubi (>= 1.13)
+      tilt (>= 2.6)
+    solargraph (0.57.0)
       backport (~> 1.2)
-      benchmark
-      bundler (>= 1.17.2)
+      benchmark (~> 0.4)
+      bundler (~> 2.0)
       diff-lcs (~> 1.4)
-      e2mmap
-      jaro_winkler (~> 1.5)
+      jaro_winkler (~> 1.6, >= 1.6.1)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.1)
+      logger (~> 1.6)
+      observer (~> 0.1)
+      ostruct (~> 0.6)
       parser (~> 3.0)
-      reverse_markdown (>= 1.0.5, < 3)
-      rubocop (>= 0.52)
+      prism (~> 1.4)
+      rbs (>= 3.6.1, <= 4.0.0.dev.4)
+      reverse_markdown (~> 3.0)
+      rubocop (~> 1.76)
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
-    streamlined (0.6.1)
+      yard-activesupport-concern (~> 0.0)
+      yard-solargraph (~> 0.1)
+    streamlined (0.6.2)
       serbea (>= 2.1)
       zeitwerk (~> 2.5)
-    thor (1.3.1)
-    tilt (2.3.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-    yard (0.9.36)
-    zeitwerk (2.6.18)
+    thor (1.4.0)
+    tilt (2.6.1)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    yard (0.9.37)
+    yard-activesupport-concern (0.0.1)
+      yard (>= 0.8)
+    yard-solargraph (0.1.0)
+      yard (~> 0.9)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
+  bridgetown-foundation (~> 2.0.4)
   lifeform!
   minitest (~> 5.0)
   minitest-reporters (~> 1.5)
-  rails-dom-testing (~> 2.0)
+  nokolexbor (~> 0.6.2)
   rake (~> 13.0)
   rubocop (~> 1.21)
   rubocop-bridgetown (~> 0.4)
   rubocop-minitest (~> 0.20.0)
   rubocop-rake (~> 0.6.0)
-  solargraph (~> 0.45.0)
+  solargraph (~> 0.50)
 
 BUNDLED WITH
    2.3.3

data/Rakefile

@@ -14,4 +14,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[test rubocop]
+task default: %i[rubocop test]

data/lib/lifeform/form.rb

@@ -9,8 +9,9 @@ module Lifeform
 
   # A form object which stores field definitions and can be rendered as a component
   class Form
-    include Streamlined::Renderable
+    extend Streamlined::Helpers
     extend Sequel::Inflections
+    include Streamlined::Renderable
 
     MODEL_PATH_HELPER = :polymorphic_path
 
@@ -30,6 +31,8 @@ module Lifeform
 
       def configuration = @configuration ||= HashWithDotAccess::Hash.new
 
+      def disable_csrf_protection! = configuration.disable_csrf_protection = true
+
       # @param block [Proc, nil]
       # @return [Hash<Symbol, FieldDefinition>]
       def fields(&block)
@@ -52,6 +55,26 @@ module Lifeform
         fields[name] = FieldDefinition.new(type, Libraries.const_get(camelize(library)), parameters)
       end
 
+      # Add an HTML fragment which will be auto-rendered or manually rendered like any field.
+      # Use Streamlined helpers inside a squiggly heredoc passed via the block which will be
+      # executed within the view context (requires it have `include Streamlined::Helpers`)
+      #
+      # @example
+      #   fragment :footer do |form| <<~HTML
+      #     <form-footer>
+      #       <p>
+      #         <img src="#{text->{ asset_path("thanks.png") }} />
+      #         Thanks for filling out our form!
+      #       </p>
+      #       #{render form.field(:submit, label: t("users.sign_up"))}
+      #     </form-footer>
+      #   HTML
+      #   end
+      #
+      # @param name [Symbol]
+      # @yieldparam form [Lifeform::Form] - instance of the form being rendered
+      def fragment(name, &block) = field(:"__#{name}", library: :default, type: :html, body: block)
+
       def subform(name, klass, parent_name: nil)
         subforms[name.to_sym] = { class: klass, parent_name: parent_name }
       end
@@ -130,12 +153,19 @@ module Lifeform
     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 = nil,
+      url: nil,
+      library: self.class.library,
+      emit_form_tag: true,
+      parent_name: nil,
+      view_context: 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(self.class.send(:camelize, @library_name))
       @subform_instances = {}
+      @_view_context = view_context
 
       self.class.initialize_field_definitions!
 
@@ -144,6 +174,8 @@ module Lifeform
       verify_method
     end
 
+    def configuration = self.class.configuration
+
     def verify_method
       return if %w[get post].include?(parameters[:method].to_s.downcase)
 
@@ -171,6 +203,8 @@ module Lifeform
       end
     end
 
+    def include_authenticity_token? = !configuration.disable_csrf_protection
+
     def attributes
       @attributes ||= self.class.parameters_to_attributes(parameters)
     end
@@ -185,21 +219,25 @@ module Lifeform
       )
     end
 
+    def fragment(name, **) = field(:"__#{name}", **)
+
     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)
+        parent_name: self.class.subforms[name.to_sym][:parent_name] || self.class.name_of_model(self.model),
+        view_context: helpers
       )
     end
 
-    def template(&block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    def template(&block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       form_tag = library::FORM_TAG
       parameters[:action] ||= url || (model ? helpers.send(self.class.const_get(:MODEL_PATH_HELPER), model) : nil)
+      output_token = include_authenticity_token? && parameters[:method].to_s.casecmp("get").zero?.!
 
       html -> { <<~HTML # rubocop:disable Bridgetown/InsecureHeredoc
         <#{form_tag} #{html_attributes attributes}>
-          #{add_authenticity_token unless parameters[:method].to_s.casecmp("get").zero?}
+          #{add_authenticity_token if output_token}
           #{@method_tag&.() || ""}
           #{block ? capture(self, &block) : auto_render_fields}
         </#{form_tag}>
@@ -210,7 +248,7 @@ module Lifeform
     def auto_render_fields = html_map(self.class.fields) { |k, _v| render(field(k)) }
 
     def render(field_object)
-      field_object.render_in(helpers || self)
+      field_object.render_in(helpers)
     end
   end
 end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Lifeform
+  module Libraries
+    class Default
+      class Html
+        include Streamlined::Renderable
+
+        attr_reader :form, :field_definition, :body
+
+        def initialize(form, field_definition, **attributes)
+          @form = form
+          @field_definition = field_definition
+
+          @attributes =
+            Lifeform::Form.parameters_to_attributes(field_definition.parameters).merge(attributes)
+          @body = @attributes[:body]
+        end
+
+        def template
+          html->{ helpers.instance_exec(form, &body) }
+        end
+      end
+    end
+  end
+end

data/lib/lifeform/version.rb

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

data/lib/lifeform.rb

@@ -9,7 +9,7 @@ module Lifeform
   class Error < StandardError; end
 end
 
-if defined?(Bridgetown)
+if defined?(Bridgetown) && Bridgetown.respond_to?(:initializer)
   Bridgetown.initializer :lifeform do |config|
     config.hook :authtown, :initialized do |rodauth|
       Lifeform::Form.rodauth = rodauth

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifeform
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-12 00:00:00.000000000 Z
+date: 2025-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hash_with_dot_access
@@ -74,6 +74,7 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - ".ruby-version"
+- ".solargraph.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -89,6 +90,7 @@ files:
 - lib/lifeform/form.rb
 - lib/lifeform/libraries/default.rb
 - lib/lifeform/libraries/default/button.rb
+- lib/lifeform/libraries/default/html.rb
 - lib/lifeform/libraries/default/input.rb
 - lib/lifeform/libraries/default/submit_button.rb
 - lib/lifeform/libraries/shoelace.rb
@@ -117,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Component-centric form object rendering for Ruby