streamlined 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28c0d44d7cf42201f5c0e9b0b422ddfe9df80ad6f21f2312be0fe33a487b6ddd
-  data.tar.gz: abb694a7eaa29ca21c6681f4f51590e83f0831fbe1fdf257435bcbe733420a88
+  metadata.gz: 2f6d5e0e63a6f2acc9944f0b703943dc3481e6430cfd19c89df6bd3b68e84a2b
+  data.tar.gz: 1b9c27c5af0cd0cf0dde74aaae73c6cb1add9ebd32a510ca3b2b119749b84994
 SHA512:
-  metadata.gz: 36a0cf9af8a3595d35fb970887ad1ddcfa8ca4a90d052c3f32bc17aee00ab1893365529c20c3f928be87c18cb67fa451fe0f18a1e6540e109681b00849b7f8aa
-  data.tar.gz: c35f3f75ea443343cc1a4d5c763d4e4be861f8cbdeb95a7b87ddd79818ad1a5929249874684e3953682b5b59b1d6525f2f1a06347cb14146d5114648b08b99fa
+  metadata.gz: 662a0b51ff471acb258b6529c6a9a9b64d1de6062d082301e030f03e4821b82537b050ccdf2ba690426c5441e717f7ba70f6e41e42fa0a28fefd090d4f00b9f6
+  data.tar.gz: 13978e66cd60115cacfeed50d7397c016a04343bad73c862eb6fbd6bd9c21bdd90e1eb3cb292b2b73c73b68822cf90a4f818957e0b33c6cfdf7f855f11912360

data/.rubocop.yml

@@ -48,6 +48,9 @@ Metrics/MethodLength:
 Naming/BlockForwarding:
   Enabled: false
 
+Style/ArgumentsForwarding:
+  Enabled: false
+
 # Disabled to aid in template readability
 Style/NestedParenthesizedCalls:
   Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+## [0.5.0 - 2024-04-06
+
+- Simplify syntax of pipe procs for text & html
+
+## [0.4.0] — 2024-04-04
+
+- Provide Roda plugin to mix in Streamlined helpers.
+
 ## [0.3.1] - 2023-11-10
 
 - Ensure false or nil values for attributes avoid rendering attributes at all

data/Gemfile

@@ -13,7 +13,7 @@ gem "minitest-reporters", "~> 1.5"
 gem "rubocop", "~> 1.21"
 gem "rubocop-bridgetown", "~> 0.4"
 
-gem "solargraph", "~> 0.49.0"
+gem "solargraph", "~> 0.50"
 
 gem "rails-dom-testing", "~> 2.0"
 

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    streamlined (0.3.1)
+    streamlined (0.5.0)
       serbea (>= 2.1)
       zeitwerk (~> 2.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.1)
+    activesupport (7.1.3.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -21,39 +21,38 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     backport (1.2.0)
-    base64 (0.1.1)
-    benchmark (0.2.1)
-    bigdecimal (3.1.4)
+    base64 (0.2.0)
+    benchmark (0.3.0)
+    bigdecimal (3.1.7)
     builder (3.2.4)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
-    diff-lcs (1.5.0)
-    drb (2.1.1)
-      ruby2_keywords
+    diff-lcs (1.5.1)
+    drb (2.2.1)
     e2mmap (0.1.0)
     erubi (1.12.0)
-    i18n (1.14.1)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.6)
-    json (2.6.3)
+    json (2.7.2)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     language_server-protocol (3.17.0.3)
-    minitest (5.20.0)
+    minitest (5.22.3)
     minitest-reporters (1.6.1)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    mutex_m (0.1.2)
-    nokogiri (1.15.4-arm64-darwin)
+    mutex_m (0.2.0)
+    nokogiri (1.16.3-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.4-x86_64-linux)
+    nokogiri (1.16.3-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     racc (1.7.3)
@@ -62,41 +61,40 @@ GEM
       minitest
       nokogiri (>= 1.6)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.0)
     rbs (2.8.4)
-    regexp_parser (2.8.2)
+    regexp_parser (2.9.0)
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.6)
-    rubocop (1.57.2)
+    rubocop (1.62.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      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.28.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
     rubocop-bridgetown (0.4.1)
       rubocop (~> 1.23)
       rubocop-performance (~> 1.12)
     rubocop-minitest (0.20.1)
       rubocop (>= 0.90, < 2.0)
-    rubocop-performance (1.19.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
     serbea (2.1.0)
       erubi (>= 1.10)
       tilt (~> 2.0)
-    solargraph (0.49.0)
+    solargraph (0.50.0)
       backport (~> 1.2)
       benchmark
       bundler (~> 2.0)
@@ -112,13 +110,13 @@ GEM
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
-    thor (1.3.0)
+    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.34)
-    zeitwerk (2.6.12)
+    yard (0.9.36)
+    zeitwerk (2.6.13)
 
 PLATFORMS
   arm64-darwin-21
@@ -133,7 +131,7 @@ DEPENDENCIES
   rubocop-bridgetown (~> 0.4)
   rubocop-minitest (~> 0.20.0)
   rubocop-rake (~> 0.6.0)
-  solargraph (~> 0.49.0)
+  solargraph (~> 0.50)
   streamlined!
 
 BUNDLED WITH

data/README.md

@@ -1,6 +1,6 @@
 # Streamlined
 
-Component rendering for Ruby using streamlined procs & heredocs. Rails and Bridgetown both supported.
+HTML fragment and component rendering for Ruby using streamlined procs & heredocs with safety checks via RuboCop. Bridgetown, Roda, and Rails all supported.
 
 ## Installation
 
@@ -10,7 +10,7 @@ Add Streamlined to your application's Gemfile by running:
 bundle add streamlined
 ```
 
-(If you're using Bridgetown, it's bundled in for Bridgetown 1.4…coming soon)
+(If you're using Bridgetown, it's bundled in for Bridgetown 2.0…coming soon)
 
 ## Usage
 

data/lib/roda/plugins/streamlined.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Roda
+  module RodaPlugins
+    module Streamlined
+      module CheckForStreamlined
+        def self.===(other)
+          other.is_a?(Proc) && other.respond_to?(:touched) && other.touched
+        end
+      end
+
+      module InstanceMethods
+        include ::Streamlined::Helpers
+      end
+
+      def self.load_dependencies(app, _opts = OPTS)
+        app.plugin :custom_block_results
+      end
+
+      def self.configure(app, _opts = OPTS)
+        app.handle_block_result CheckForStreamlined, &:to_s
+      end
+    end
+
+    register_plugin :streamlined, Streamlined
+  end
+end

data/lib/streamlined/helpers.rb

@@ -1,19 +1,15 @@
 # frozen_string_literal: true
 
+require "tilt/erubi"
+
 module Streamlined
   module Helpers
-    module PipeableProc
-      include Serbea::Pipeline::Helper
-
-      attr_accessor :pipe_block, :touched
-
-      def pipe(&block)
-        return super(self.(), &pipe_block) if pipe_block && !block
+    module TouchableProc
+      attr_accessor :touched
 
+      def touch
         self.touched = true
-        return self unless block
-
-        tap { _1.pipe_block = block }
+        self
       end
 
       def html_safe
@@ -36,7 +32,7 @@ module Streamlined
       end
     end
 
-    ::Proc.prepend(PipeableProc)
+    ::Proc.prepend(TouchableProc)
 
     # Create a set of attributes from a hash.
     #
@@ -82,16 +78,20 @@ module Streamlined
       "#{attr}=#{value.to_s.encode(xml: :attr)}"
     end
 
-    def text(callback)
-      (callback.is_a?(Proc) ? callback.pipe : callback).to_s.then do |str|
+    def text(callback, piping = nil)
+      callback = Serbea::Pipeline.new(binding, callback).tap { _1.instance_exec(&piping) } if piping
+
+      (callback.is_a?(Proc) ? callback.touch : callback).to_s.then do |str|
         next str if str.html_safe?
 
         str.encode(xml: :attr).gsub(%r{\A"|"\Z}, "")
       end
     end
 
-    def html(callback)
-      callback.html_safe.pipe
+    def html(callback, piping = nil)
+      callback = Serbea::Pipeline.new(binding, callback).tap { _1.instance_exec(&piping) } if piping
+
+      callback.html_safe.touch
     end
 
     def html_map(input, &callback)

data/lib/streamlined/renderable.rb

@@ -45,10 +45,8 @@ module Streamlined
       @_view_context
     end
 
-    # rubocop:disable Style/ArgumentsForwarding
     def capture(*args, &block)
       helpers ? helpers.capture(*args, &block) : yield(*args)
     end
-    # rubocop:enable Style/ArgumentsForwarding
   end
 end

data/lib/streamlined/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Streamlined
-  VERSION = "0.3.1"
+  VERSION = "0.5.0"
 end

data/lib/streamlined.rb

@@ -4,6 +4,7 @@ require "serbea/helpers" # primarily just for HTML safety polyfill
 require "serbea/pipeline"
 require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/roda")
 loader.setup
 
 module Streamlined
@@ -11,6 +12,9 @@ module Streamlined
 end
 
 if defined?(Bridgetown)
-  Bridgetown.initializer :streamlined do # |config|
+  Bridgetown.initializer :streamlined do |config|
+    config.roda do |app|
+      app.plugin :streamlined
+    end
   end
 end

data/streamlined.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |spec|
   spec.author = "Bridgetown Team"
   spec.email = "maintainers@bridgetownrb.com"
 
-  spec.summary = "Component rendering for Ruby using streamlined procs & heredocs."
+  spec.summary = "HTML fragment & component rendering for Ruby using streamlined procs & heredocs."
   spec.homepage = "https://github.com/bridgetownrb/streamlined"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0"
+  spec.required_ruby_version = ">= 3.1"
   spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: streamlined
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-11 00:00:00.000000000 Z
+date: 2024-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serbea
@@ -57,6 +57,7 @@ files:
 - bin/rake
 - bin/rubocop
 - bin/setup
+- lib/roda/plugins/streamlined.rb
 - lib/streamlined.rb
 - lib/streamlined/helpers.rb
 - lib/streamlined/renderable.rb
@@ -75,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -85,5 +86,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: Component rendering for Ruby using streamlined procs & heredocs.
+summary: HTML fragment & component rendering for Ruby using streamlined procs & heredocs.
 test_files: []