RubyGems - p2 - Versions diffs - 2.8 → 2.9 - Mend

p2 2.8 → 2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a84949b86e99acbe131d37cb624dbf60010fe720ce27081d5e5652b33f2de004
-  data.tar.gz: c03bef8c358bae1536c04739c2fa67bd3ce6e879fd036f2e7352c6291677b888
+  metadata.gz: bda78e0c4b37c895274b5d357022f3f491bf6b1fdab4d52cdc4e7aa7660f2f6a
+  data.tar.gz: f9e1295f3208cb6b734d65d20afa41fcb46803b37b51b7d801ab56715fe24db8
 SHA512:
-  metadata.gz: 2993a42368846048e02ca7cb01d2ba6f7be013870a5f39597478442d16659b730356443b1b77ee8bb36c6b9a3942bde7d8ef19e66ad087d2a69d9b686d5cc706
-  data.tar.gz: 7739be72dd3bdf195188339509a21e24bccbae6ac8efb140a16780445f71b60fea12ab0a87831f117422b620102c277391f33db944b94b7945088f16cf099d73
+  metadata.gz: 80891d65d533e7fabac367d342c3884c0da607e5c815821ace691fe62e5ae393983e89c60cc226b69627b0ebb66bf7f1d91ae89f8be6d8baca9620498364c756
+  data.tar.gz: 3e969bb24fbc9ec1668757e5ac152baf0052928937bd18d8c708a2031c416d8752cf8b85f3047427de82eafd008abd6126d212e3265fcfbfd9275b6ed4bc0b95

data/CHANGELOG.md CHANGED Viewed

@@ -1,7 +1,14 @@
+# 2.9 2025-09-02
+- Tweak generated code to incorporate @byroot's
+  [recommendations](https://www.reddit.com/r/ruby/comments/1mtj7bx/comment/n9ckbvt/):
+  - Remove call to to_s coercion before calling html_escape
+  - Chain calls to `#<<` with emitted HTML parts
 # 2.8 2025-08-17
-- Add render_children builtin
-- Rename emit_yield to render_yield
+- Add `#render_children` builtin
+- Rename `#emit_yield` to `#render_yield`
 - Add `Proc#render_cached` for caching render result
 # 2.7 2025-08-17
@@ -12,13 +19,13 @@
 # 2.6 2025-08-16
-- Add support for block invocation.
+- Add support for block invocation
 # 2.5 2025-08-15
-- Translate backtrace for exceptions raised in `#render_to_buffer`.
-- Improve display of backtrace when source map is missing entries.
-- Improve handling of ArgumentError raised on calling the template.
+- Translate backtrace for exceptions raised in `#render_to_buffer`
+- Improve display of backtrace when source map is missing entries
+- Improve handling of ArgumentError raised on calling the template
 - Add `Template#apply`, `Template#compiled_proc` methods
 # 2.4 2025-08-10

data/README.md CHANGED Viewed

@@ -10,8 +10,8 @@
   <a href="http://rubygems.org/gems/p2">
     <img src="https://badge.fury.io/rb/p2.svg" alt="Ruby gem">
   </a>
-  <a href="https://github.com/digital-fabric/p2/actions?query=workflow%3ATests">
-    <img src="https://github.com/digital-fabric/p2/workflows/Tests/badge.svg" alt="Tests">
+  <a href="https://github.com/digital-fabric/p2/actions/workflows/test.yml">
+    <img src="https://github.com/digital-fabric/p2/actions/workflows/test.yml/badge.svg" alt="Tests">
   </a>
   <a href="https://github.com/digital-fabric/p2/blob/master/LICENSE">
     <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License">
@@ -39,7 +39,6 @@ page.render {
 #=> "<html><head><title>Title</title></head><body><p>foo</p></body></html>"
 ```
 P2 is a templating engine for dynamically producing HTML in Ruby apps. P2
 templates are expressed as Ruby procs, leading to easier debugging, better
 protection against HTML injection attacks, and better code reuse.
@@ -90,7 +89,7 @@ P2 features:
 ## Table of Content
 - [Getting Started](#getting-started)
-- [Basic Markup](#markup)
+- [Basic Markup](#basic-markup)
 - [Builtin Methods](#builtin-methods)
 - [Template Parameters](#template-parameters)
 - [Template Logic](#template-logic)
@@ -99,11 +98,12 @@ P2 features:
 - [Parameter and Block Application](#parameter-and-block-application)
 - [Higher-Order Templates](#higher-order-templates)
 - [Layout Template Composition](#layout-template-composition)
-- [Emitting Raw HTML](#emitting-raw-html)
-- [Emitting a String with HTML Escaping](#emitting-a-string-with-html-escaping)
 - [Emitting Markdown](#emitting-markdown)
 - [Deferred Evaluation](#deferred-evaluation)
-- [API Reference](#api-reference)
+- [Cached Rendering](#cached-rendering)
+A typical example for a dashboard-type app markup can be found here:
+https://github.com/digital-fabric/p2/blob/master/examples/dashboard.rb
 ## Getting Started
@@ -123,7 +123,7 @@ require 'p2'
 html.render #=> "<div id="greeter"><p>Hello!</p></div>"
 ```
-## Markup
+## Basic Markup
 Tags are added using unqualified method calls, and can be nested using blocks:
@@ -511,24 +511,6 @@ article_layout.render(
 )
 ```
-## Emitting Raw HTML
-Raw HTML can be emitted using `#raw`:
-```ruby
-wrapped = -> { |html| div { raw html } }
-wrapped.render("<h1>hi</h1>") #=> "<div><h1>hi</h1></div>"
-```
-## Emitting a String with HTML Escaping
-To emit a string with proper HTML escaping, without wrapping it in an HTML
-element, use `#text`:
-```ruby
--> { text 'hi&lo' }.render #=> "hi&amp;lo"
-```
 ## Emitting Markdown
 Markdown is rendered using the
@@ -626,18 +608,17 @@ page = default_layout.apply {
 }
 ```
-## HTML Utility methods
+## Cached Rendering
-HTML templates include a few HTML-specific methods to facilitate writing modern
-HTML:
+P2 provides a simple API for caching the result of a rendering. The cache stores
+renderings of a template respective to the given arguments. To automatically
+retrieve the cached rendered HTML, or generate it for the first time, use
+`Proc#render_cached`:
-- `html5 { ... }` - emits an HTML 5 DOCTYPE (`<!DOCTYPE html>`)
-- `import_map(root_path, root_url)` - emits an import map including all files
-  matching `<root_path>/*.js`, based on the given `root_url`
-- `js_module(js)` - emits a `<script type="module">` element
-- `link_stylesheet(href, **attributes)` - emits a `<link rel="stylesheet" ...>`
-  element
-- `script(js, **attributes)` - emits an inline `<script>` element
-- `style(css, **attributes)` - emits an inline `<style>` element
-- `versioned_file_href(href, root_path, root_url)` - calculates a versioned href
-  for the given file
+```ruby
+template = ->(title) { div { h1 title } }
+template.render_cached('foo') #=> <div><h1>foo</h1></div>
+template.render_cached('foo') #=> <div><h1>foo</h1></div> (from cache)
+template.render_cached('bar') #=> <div><h1>bar</h1></div>
+template.render_cached('bar') #=> <div><h1>bar</h1></div> (from cache)
+```

data/lib/p2/compiler.rb CHANGED Viewed

@@ -168,9 +168,7 @@ module P2
         if is_static_node?(node.inner_text)
           emit_html(node.location, ERB::Escape.html_escape(format_literal(node.inner_text)))
         else
-          to_s = is_string_type_node?(node.inner_text) ? '' : '.to_s'
-          emit_html(node.location, interpolated("ERB::Escape.html_escape((#{format_code(node.inner_text)})#{to_s})"))
+          emit_html(node.location, interpolated("ERB::Escape.html_escape((#{format_code(node.inner_text)}))"))
         end
       end
       emit_html(node.location, format_html_tag_close(tag))
@@ -230,7 +228,7 @@ module P2
         if is_static_node?(first_arg)
           emit_html(node.location, ERB::Escape.html_escape(format_literal(first_arg)))
         else
-          emit_html(node.location, interpolated("ERB::Escape.html_escape(#{format_code(first_arg)}.to_s)"))
+          emit_html(node.location, interpolated("ERB::Escape.html_escape(#{format_code(first_arg)})"))
         end
       else
         raise "Don't know how to compile #{node}"
@@ -597,14 +595,15 @@ module P2
       return if @pending_html_parts.empty?
       adjust_whitespace(@html_loc_start, advance_to_end: false)
+      emit('; __buffer__')
       concatenated = +''
       last_loc = @html_loc_start
       @pending_html_parts.each do |(loc, part)|
         if (m = part.match(/^#\{(.+)\}$/m))
           emit_html_buffer_push(concatenated, quotes: true) if !concatenated.empty?
-          adjust_whitespace(loc, advance_to_end: false)
-          emit_html_buffer_push(m[1])
+          # adjust_whitespace(loc, advance_to_end: false)
+          emit_html_buffer_push(m[1], loc:)
         else
           concatenated << part
         end
@@ -628,11 +627,18 @@ module P2
     # @param part [String] HTML part
     # @param quotes [bool] whether to wrap emitted HTML in double quotes
     # @return [void]
-    def emit_html_buffer_push(part, quotes: false)
+    def emit_html_buffer_push(part, quotes: false, loc: nil)
       return if part.empty?
       q = quotes ? '"' : ''
-      emit("; __buffer__ << #{q}#{part}#{q}")
+      if loc
+        emit(".<<(")
+        adjust_whitespace(loc, advance_to_end: false)
+        emit("#{q}#{part}#{q}")
+        emit(")")
+      else
+        emit(".<<(#{q}#{part}#{q})")
+      end
       part.clear
     end

data/lib/p2/proc_ext.rb CHANGED Viewed

@@ -92,9 +92,9 @@ class ::Proc
   end
   # Caches and returns
-  def render_cached(*args, **kargs)
+  def render_cached(*args, **kargs, &block)
     @render_cache ||= {}
-    key = args.empty? && kargs.empty? ? nil : [args, kargs]
-    @render_cache[key] ||= render(*args, **kargs)
+    key = args.empty? && kargs.empty? && !block ? nil : [args, kargs, block&.source_location]
+    @render_cache[key] ||= render(*args, **kargs, &block)
   end
 end

data/lib/p2/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module P2
-  VERSION = '2.8'
+  VERSION = '2.9'
 end

data/lib/p2.rb CHANGED Viewed

@@ -101,10 +101,11 @@ module P2
   # @param opts [Hash] Kramdown option overrides
   # @return [String] HTML
   def markdown(markdown, **opts)
-    # require relevant deps on use
-    require 'kramdown'
-    require 'rouge'
-    require 'kramdown-parser-gfm'
+    @markdown_deps_loaded ||= true.tap do
+      require 'kramdown'
+      require 'rouge'
+      require 'kramdown-parser-gfm'
+    end
     opts = default_kramdown_options.merge(opts)
     Kramdown::Document.new(markdown, **opts).to_html

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: p2
 version: !ruby/object:Gem::Version
-  version: '2.8'
+  version: '2.9'
 platform: ruby
 authors:
 - Sharon Rosner