papercraft 0.25 → 0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f23902f7431dcbd6c1180e26f612ae5099d4e7f2ba468dd0e0e5e9a76e324ef4
-  data.tar.gz: 5bf38e4faea0ab6c6145d769b24b416e467836b29c6d8856bb96442f86b43bfe
+  metadata.gz: bd2f4f4d1ebc2cfc5718079d68c9393b3d95def9c02b057107425ddd5b45eaf3
+  data.tar.gz: f3f82f29227e22e5e31b0d685bcab211ebbef0ecf8a4433d251cb1f204875cf7
 SHA512:
-  metadata.gz: 69ed90f079f1db073bbc18b1b631c13cbcd2db5dae9e512781046fb7fa5ab0a164653137b28c201f48671d77e4d08ff1da3818381aca5d3686d61eb185f8a586
-  data.tar.gz: 85681c583e3e145ca27a52638e0d3370fa94462d5baaae8cccb477a1a2938ad56f3040ee4f6cceb2757b49019890bcae505bcdc008e2ff0931987f09ab9eb91a
+  metadata.gz: 7389861bea04a92e06ce1a53a682ef3b4db1bf975bb7f5e63cef0ed6c1a4ebb4b92920a0bb4ea04eba24dc72b41c70ba8fac0d8aa605a2b5a720d7860198b7e0
+  data.tar.gz: 2a617260deef291c56cd0c3fc1b275d47dd1dc95bdeeafc69289d630260480e49126c29f0ec77c177fd6c1032c633ba2568be1ffb767e13f91e51b5a9c298831

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.27 2023-01-19
+
+- Fix rendering of HTML void element tags
+
+## 0.26 2023-01-13
+
+- Add support for namespaced local extensions using `#extend`
+
 ## 0.25 2023-01-12
 
 - Implement `#def_tag` for defining custom tags inline

data/README.md

@@ -86,6 +86,7 @@ hello.render('world')
 - [XML Templates](#xml-templates)
 - [JSON Templates](#json-templates)
 - [Papercraft Extensions](#papercraft-extensions)
+  - [Extending Specific Templates](#extending-specific-templates)
   - [Inline Helper Methods](#inline-helper-methods)
   - [Bundled Extensions](#bundled-extensions)
 - [API Reference](#api-reference)
@@ -682,7 +683,40 @@ Papercraft.html {
 }
 ```
 
-## Inline Helper Methods
+### Extending Specific Templates
+
+Sometimes you wish to extend a specific template locally, without the extension
+API being available to other templates. To do this you can use `#extend`:
+
+```ruby
+module CustomTags
+  def label(text)
+    span text, class: 'label'
+  end
+end
+
+Papercraft.html {
+  extend CustomTags
+
+  label 'foo'
+}
+```
+
+The extension is in effect as long as the template is processing, so it is also
+accessible to any sub templates that are emitted.
+
+Local extensions can also be namespaced by passing `#extend` a hash mapping
+namespaces to modules:
+
+```ruby
+Papercraft.html {
+  extend custom: CustomTags
+
+  custom.label 'foo'
+}
+```
+
+### Inline Helper Methods
 
 In addition to proper extensions defined in modules, you can also define
 individual extension methods inline in your Papercraft templates. You can do
@@ -733,7 +767,7 @@ def_tag(:section) do |title, &inner|
 end
 ```
 
-## Bundled Extensions
+### Bundled Extensions
 
 Papercraft comes bundled with a few extensions that address common use cases.
 All bundled extensions are namespaced under `Papercraft::Extensions`, and must
@@ -742,7 +776,7 @@ be specifically required in order to be available to templates.
 For all bundled Papercraft extensions, there's no need to call
 `Papercraft.extension`, requiring the extension is sufficient.
 
-### SOAP Extension
+#### SOAP Extension
 
 > The SOAP extension was contributed by [@aemadrid](https://github.com/aemadrid).
 

data/lib/papercraft/html.rb

@@ -88,6 +88,21 @@ module Papercraft
 
     private
 
+    # Returns true if the given tag is a void element, in order to render a self
+    # closing tag. See spec: https://html.spec.whatwg.org/multipage/syntax.html#void-elements.
+    #
+    # @param text [String] tag
+    # @return [Bool] is it a void element
+    def is_void_element_tag?(tag)
+      case tag
+      # 
+      when 'area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'source', 'track', 'wbr'
+        true
+      else
+        false
+      end
+    end
+
     # Escapes the given text using HTML entities.
     #
     # @param text [String] text

data/lib/papercraft/tags.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative './extension_proxy'
+
 module Papercraft  
   # Markup (HTML/XML) extensions
   module Tags
@@ -8,6 +10,7 @@ module Papercraft
     S_LT_SLASH        = '</'
     S_SPACE_LT_SLASH  = ' </'
     S_SLASH_GT        = '/>'
+    S_GT_LT_SLASH     = '></'
     S_SPACE           = ' '
     S_EQUAL_QUOTE     = '="'
     S_QUOTE           = '"'
@@ -19,6 +22,36 @@ module Papercraft
       S_TAG_%<TAG>s_PRE = %<tag_pre>s
       S_TAG_%<TAG>s_CLOSE = %<tag_close>s
 
+      def %<tag>s(text = nil, **props, &block)
+        if text.is_a?(Hash) && props.empty?
+          props = text
+          text = nil
+        end
+
+        @buffer << S_TAG_%<TAG>s_PRE
+        emit_props(props) unless props.empty?
+
+        if block
+          @buffer << S_GT
+          instance_eval(&block)
+          @buffer << S_TAG_%<TAG>s_CLOSE
+        elsif Proc === text
+          @buffer << S_GT
+          emit(text)
+          @buffer << S_TAG_%<TAG>s_CLOSE
+        elsif text
+          @buffer << S_GT << escape_text(text.to_s) << S_TAG_%<TAG>s_CLOSE
+        else
+          @buffer << S_GT << S_TAG_%<TAG>s_CLOSE
+        end
+      end
+    EOF
+
+    S_VOID_TAG_METHOD_LINE = __LINE__ + 2
+    S_VOID_TAG_METHOD = <<~EOF
+      S_TAG_%<TAG>s_PRE = %<tag_pre>s
+      S_TAG_%<TAG>s_CLOSE = %<tag_close>s
+
       def %<tag>s(text = nil, **props, &block)
         if text.is_a?(Hash) && props.empty?
           props = text
@@ -147,8 +180,10 @@ module Papercraft
         @buffer << S_LT_SLASH << tag << S_GT
       elsif text
         @buffer << S_GT << escape_text(text.to_s) << S_LT_SLASH << tag << S_GT
-      else
+      elsif is_void_element_tag?(sym)
         @buffer << S_SLASH_GT
+      else
+        @buffer << S_GT_LT_SLASH << tag << S_GT
       end
     end
 
@@ -203,6 +238,43 @@ module Papercraft
       self.class.define_method(sym, &block)
     end
 
+    alias_method :orig_extend, :extend
+
+    # Extends the template with the provided module or map of modules. When
+    # given a module, the template body will be extended with the module,
+    # and will have access to all the module's methods:
+    #
+    #   module CustomTags
+    #     def label(text)
+    #       span text, class: 'label'
+    #     end
+    #   end
+    #
+    #   Papercraft.html {
+    #     extend CustomTags
+    #     label('foo')
+    #   }
+    #
+    # When given a hash, each module in the hash is namespaced, and can be
+    # accessed using its key:
+    #
+    #   Papercraft.html {
+    #     extend custom: CustomTags
+    #     custom.label('foo')
+    #   }
+    #
+    # @param ext [Module, Hash] extension module or hash mapping symbols to modules
+    # @return [Object] self
+    def extend(ext)
+      if ext.is_a?(Module)
+        orig_extend(ext)
+      else
+        ext.each do |sym, mod|
+          define_extension_method(sym, mod)
+        end
+      end
+    end
+
     private
 
     # Defines a method that emits the given tag based on a constant. The
@@ -223,13 +295,31 @@ module Papercraft
     # @return [void]
     def define_tag_method(tag)
       repr = tag_repr(tag)
-      code = S_TAG_METHOD % {
+      if is_void_element_tag?(tag)
+        tmpl = S_VOID_TAG_METHOD
+        line = S_VOID_TAG_METHOD_LINE
+      else
+        tmpl = S_TAG_METHOD
+        line = S_TAG_METHOD_LINE
+      end
+      code = tmpl % {
         tag: tag,
         TAG: tag.upcase,
         tag_pre: "<#{repr}".inspect,
         tag_close: "</#{repr}>".inspect
       }
-      self.class.class_eval(code, __FILE__, S_TAG_METHOD_LINE)
+      self.class.class_eval(code, __FILE__, line)
+    end
+
+    # Defines a namespace referring to the given module.
+    #
+    # @param sym [Symbol] namespace
+    # @param mod [Module] module
+    # @return [void]
+    def define_extension_method(sym, mod)
+      self.singleton_class.define_method(sym) do
+        (@extension_proxies ||= {})[mod] ||= ExtensionProxy.new(self, mod)
+      end
     end
 
     # Emits an arbitrary object by converting it to string, then adding it to

data/lib/papercraft/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Papercraft
-  VERSION = '0.25'
+  VERSION = '0.27'
 end

data/lib/papercraft/xml.rb

@@ -10,7 +10,15 @@ module Papercraft
 
     private
 
-    # Converts a tag to its string representation. Underscores will be converted
+    # Returns false (no void elements in XML)
+    #
+    # @param tag [String] tag
+    # @return [false] false
+    def is_void_element_tag?(tag)
+      false
+    end
+
+      # Converts a tag to its string representation. Underscores will be converted
     # to dashes, double underscores will be converted to colon.
     #
     # @param tag [Symbol, String] tag

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papercraft
 version: !ruby/object:Gem::Version
-  version: '0.25'
+  version: '0.27'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils