lifeform 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84cc7c165874ab122f164fe3edae5c7e7f68d7ba4936f115151f5fec3ecdd217
-  data.tar.gz: 690ab60f63f813cfedf830416d1fe3761ad4dfd090344dc227e598e62c5bb497
+  metadata.gz: fef99043fb289f536c1a3b6986a48675dc741854ffef6e99c596c5d9abca303a
+  data.tar.gz: 61821150d087888c5b243e2c52916534f7fc8b4fb8a14ced79692d3bb1ed1f45
 SHA512:
-  metadata.gz: aec711376fecf90651b305a8a8f3a7044dcbdb022a4c17713e0433f8e90590f9502668794143183bc0c71d8d3a0de1dbe85cc3e989b764552190367234a10bed
-  data.tar.gz: f057b69cbf5d7f43f5cba4a30f79df5d0f3735af41fb363bf7147853d327b07315e730708c8feaae2063993a477ee39c9e9d22f0f1385f4c3c9991d9360a4a98
+  metadata.gz: 8b64f7550a79f0e7667ac422a9cecb364943c544e9583f724842326d4cb9b28b74ae0dee19427be1121fcfd4e9b1a9e5e7878ff1cc8a2e22ee65dd734a0c69e1
+  data.tar.gz: adec1d8e7d8a800f667953ef4e91f90935878a9e1dc6095a82536625bf675ee9f1be74ee3ed31f1857807c9ee75dcd3b36f95a42c32ba79aa10cca0395240dc8

data/.rubocop.yml

@@ -5,6 +5,8 @@ require:
 AllCops:
   TargetRubyVersion: 2.7
   NewCops: enable
+  Exclude:
+    - lib/lifeform/phlex_renderable.rb
 
 Lint/MissingSuper:
   Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## [Unreleased]
 
+## [0.10.0] - 2022-12-23
+
+- Support Phlex 1.0 and conditional `render_in` support for Bridgetown
+
+## [0.9.0] - 2022-11-06
+
+- Add button & submit button support for Shoelace
+
+## [0.8.0] - 2022-10-09
+
+- Add initializer for Bridgetown 1.2+
+- Fix for Roda csrf
+
 ## [0.7.0] - 2022-09-30
 
 - Rearchitect library to be built on top of the Phlex view library

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    lifeform (0.8.0)
+    lifeform (0.10.0)
       activesupport (>= 6.0)
-      phlex (~> 0.3)
+      phlex (~> 1.0)
       zeitwerk (~> 2.5)
 
 GEM
@@ -17,7 +17,7 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     backport (1.2.0)
-    benchmark (0.2.0)
+    benchmark (0.2.1)
     builder (3.2.4)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
@@ -25,7 +25,7 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    json (2.6.2)
+    json (2.6.3)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -36,38 +36,36 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.13.8-arm64-darwin)
+    nokogiri (1.13.10-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.8-x86_64-linux)
+    nokogiri (1.13.10-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
-    phlex (0.3.2)
-      syntax_tree (~> 3.6)
+    phlex (1.0.0)
       zeitwerk (~> 2.6)
-    prettier_print (0.1.0)
-    racc (1.6.0)
+    racc (1.6.1)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
+    regexp_parser (2.6.1)
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
-    rubocop (1.36.0)
+    rubocop (1.40.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
+    rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
     rubocop-minitest (0.20.1)
       rubocop (>= 0.90, < 2.0)
@@ -89,8 +87,6 @@ GEM
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
-    syntax_tree (3.6.2)
-      prettier_print
     thor (1.2.1)
     tilt (2.0.11)
     tzinfo (2.0.5)
@@ -99,7 +95,7 @@ GEM
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
-    zeitwerk (2.6.1)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -7,9 +7,11 @@ Component-centric form object rendering for Ruby. Powered by [Phlex](https://www
 Add Lifeform to your application's Gemfile by running:
 
 ```sh
-$ bundle add lifeform
+bundle add lifeform
 ```
 
+If you're in a Rails app, you'll want to `bundle add phlex-rails` as well for Action View rendering support.
+
 ## Usage
 
 Full documentation coming as the library begins to mature. TL;DR:

data/lib/lifeform/capturing_renderable.rb

@@ -7,7 +7,7 @@ module Lifeform
     def render_in(view_context, &block)
       if block
         call(view_context: view_context) do |*args, **kwargs|
-          raw(view_context.capture(*args, **kwargs, &block))
+          unsafe_raw(view_context.capture(*args, **kwargs, &block))
         end.html_safe
       else
         call(view_context: view_context).html_safe

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 < Phlex::View # rubocop:todo Metrics/ClassLength
+  class Form < Phlex::HTML # rubocop:todo Metrics/ClassLength
     include CapturingRenderable
     MODEL_PATH_HELPER = :polymorphic_path
 
@@ -132,7 +132,7 @@ module Lifeform
     def verify_method
       return if %w[get post].include?(parameters[:method].to_s.downcase)
 
-      @method_tag = Class.new(Phlex::View) do # TODO: break this out into a real component
+      @method_tag = Class.new(Phlex::HTML) do # TODO: break this out into a real component
         def initialize(method:)
           @method = method
         end
@@ -185,8 +185,8 @@ module Lifeform
       parameters[:action] ||= url || (model ? helpers.send(self.class.const_get(:MODEL_PATH_HELPER), model) : nil)
 
       send(form_tag, **attributes) do
-        raw(add_authenticity_token) unless parameters[:method].to_s.downcase == "get"
-        raw @method_tag&.() || ""
+        unsafe_raw(add_authenticity_token) unless parameters[:method].to_s.downcase == "get"
+        unsafe_raw @method_tag&.() || ""
         block ? yield_content(&block) : auto_render_fields
       end
     end

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

@@ -3,7 +3,8 @@
 module Lifeform
   module Libraries
     class Default
-      class Button < Phlex::View
+      class Button < Phlex::HTML
+        using RefineProcToString
         include CapturingRenderable
 
         attr_reader :form, :field_definition, :attributes
@@ -30,7 +31,7 @@ module Lifeform
 
           field_body = proc {
             send(button_tag, **@attributes) do
-              raw(@label.to_s) unless block
+              unsafe_raw(@label.to_s) unless block
               yield_content(&block)
             end
           }

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

@@ -3,7 +3,8 @@
 module Lifeform
   module Libraries
     class Default
-      class Input < Phlex::View
+      class Input < Phlex::HTML
+        using RefineProcToString
         include CapturingRenderable
 
         attr_reader :form, :field_definition, :attributes
@@ -50,7 +51,7 @@ module Lifeform
           @attributes = attributes.filter_map { |k, v| [k, v] unless k == :label }.to_h
 
           proc {
-            label(for: label_name) { raw label_text }
+            label(for: label_name) { unsafe_raw label_text }
           }
         end
 

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Lifeform
+  module Libraries
+    class Shoelace
+      class Button < Default::Button
+        BUTTON_TAG = :sl_button
+
+        register_element BUTTON_TAG
+      end
+    end
+  end
+end

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

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

data/lib/lifeform/phlex_renderable.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Bridgetown-specific workaround that got copied over from the phlex-rails gem (for now)
+module Lifeform
+  module PhlexRenderable
+    def helpers
+      @_view_context
+    end
+
+    def render(renderable, *args, **kwargs, &block)
+      return super if renderable.is_a?(Phlex::HTML)
+      return super if renderable.is_a?(Class) && renderable < Phlex::HTML
+
+      @_target << @_view_context.render(renderable, *args, **kwargs, &block)
+
+      nil
+    end
+
+    def render_in(view_context, &block)
+      if block_given?
+        call(view_context: view_context) do |*args|
+          view_context.with_output_buffer(self) do
+            original_length = @_target.length
+            output = yield(*args)
+            unchanged = (original_length == @_target.length)
+
+            if unchanged
+              if output.is_a?(ActiveSupport::SafeBuffer)
+                unsafe_raw(output)
+              else
+                text(output)
+              end
+            end
+          end
+        end.html_safe
+      else
+        call(view_context: view_context).html_safe
+      end
+    end
+
+    def safe_append=(value)
+      return unless value
+
+      @_target << case value
+        when String then value
+        when Symbol then value.name
+        else value.to_s
+      end
+    end
+
+    def append=(value)
+      return unless value
+
+      if value.html_safe?
+        self.safe_append = value
+      else
+        @_target << case value
+          when String then ERB::Util.html_escape(value)
+          when Symbol then ERB::Util.html_escape(value.name)
+          else ERB::Util.html_escape(value.to_s)
+        end
+      end
+    end
+
+    def capture
+      super.html_safe
+    end
+
+    # Trick ViewComponent into thinking we're a ViewComponent to fix rendering output
+    def set_original_view_context(view_context)
+    end
+  end
+end
+
+Phlex::HTML.prepend(Lifeform::PhlexRenderable)

data/lib/lifeform/version.rb

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

data/lib/lifeform.rb

@@ -9,13 +9,21 @@ loader.setup
 
 module Lifeform
   class Error < StandardError; end
+
+  module RefineProcToString
+    refine Proc do
+      def to_s
+        call.to_s
+      end
+    end
+  end
 end
 
 if defined?(Bridgetown)
   # Check compatibility
   raise "The Lifeform support for Bridgetown requires v1.2 or newer" if Bridgetown::VERSION.to_f < 1.2
 
-  Bridgetown.initializer :lifeform do |config|
-    # no extra config at the moment
+  Bridgetown.initializer :lifeform do # |config|
+    require "lifeform/phlex_renderable" unless Phlex::HTML.instance_methods.include?(:render_in)
   end
 end

data/lifeform.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "activesupport", ">= 6.0"
-  spec.add_dependency "phlex", "~> 0.3"
+  spec.add_dependency "phlex", "~> 1.0"
   spec.add_dependency "zeitwerk", "~> 2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifeform
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-09 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +79,10 @@ files:
 - lib/lifeform/libraries/default/input.rb
 - lib/lifeform/libraries/default/submit_button.rb
 - lib/lifeform/libraries/shoelace.rb
+- lib/lifeform/libraries/shoelace/button.rb
 - lib/lifeform/libraries/shoelace/input.rb
+- lib/lifeform/libraries/shoelace/submit_button.rb
+- lib/lifeform/phlex_renderable.rb
 - lib/lifeform/version.rb
 - lifeform.gemspec
 homepage: https://github.com/bridgetownrb/lifeform