papercraft 0.19 → 0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0f4910bd26625ca0349b1c471338fb4d13e8055e88367b5cad16f91cdee7531
-  data.tar.gz: 38e43978278ba069e3767abd94d83c676f42692f5eb55f1be4b4067fae2f935e
+  metadata.gz: 2eaf6ba31b9300176af0bf55b76f7bbdc16508d0e495ed1d76f9f273ea88f250
+  data.tar.gz: 90e132928ebfe78e577e71c8dc498f0ce1b1f2c58f453fbedaad96121c448a48
 SHA512:
-  metadata.gz: b096452cebe7b6bb34a428f4920a5940e5b745c86b54188a984a77df6175145cf6645753e6ae58b3df89813919920a17a96610e010724bc50077c6f9accc7293
-  data.tar.gz: 8d1cd5b2d6b70ee9ef0a748a064bbd6d1630cfa926663aded95a01c26ce289a159e2548068bf8210c5e8d37ba26c9671eb4a00fe4790a47bec6dd822b4de5d5d
+  metadata.gz: fcada325a3f8cd1c4cbe38674efaf6a86d0eb947ad5815d07778e2a09a54bee2c7d6b731e87d110390e9c87abc0a61f81cbc4cb30fdce11a4fc8a8cd322466a0
+  data.tar.gz: 031c86f7dade95af3dca979b4543fcb26e1fab2eb98c5642746d6efcf8b4bd56fe30b70f2f5aa8309352f421cae9f116a901f464216f54a0be50630dcc52815f

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.20 2022-02-13
+
+- Add support for XML namespaced tags and attributes (#9)
+- Move and refactor HTML/XML common code to Tags module
+
 ## 0.19 2022-02-05
 
 - Rename `Papercraft::Component` to `Papercraft::Template`

data/lib/papercraft/html.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+require_relative './tags'
+
 module Papercraft  
   # HTML Markup extensions
   module HTML
+    include Tags
+
     # Emits the p tag (overrides Object#p)
     #
     # @param text [String] text content of tag
@@ -81,5 +85,12 @@ module Papercraft
     def emit_markdown(markdown, **opts)
       emit Papercraft.markdown(markdown, **opts)
     end
+
+    private
+
+    # Escapes the given text using XML entities.
+    def escape_text(text)
+      EscapeUtils.escape_html(text.to_s)
+    end
   end
 end

data/lib/papercraft/renderer.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require 'escape_utils'
-
 require_relative './html'
+require_relative './xml'
 require_relative './json'
 require_relative './extension_proxy'
 
@@ -10,7 +9,7 @@ module Papercraft
   
   # A Renderer renders a Papercraft template into a string
   class Renderer
-  
+
     class << self
 
       # Verifies that the given template proc can be called with the given
@@ -45,7 +44,7 @@ module Papercraft
       # methods to extension modules. The methods will be available to all
       # Papercraft templates. Extension methods are executed in the context of
       # the the renderer instance, so they can look just like normal proc
-      # components. In cases where method names in the module clash with HTML
+      # components. In cases where method names in the module clash with XML
       # tag names, you can use the `#tag` method to emit the relevant tag.
       # 
       # module ComponentLibrary
@@ -113,99 +112,6 @@ module Papercraft
       @buffer
     end
 
-    # The tag method template below is optimized for performance. Do not touch!
-
-    S_TAG_METHOD_LINE = __LINE__ + 2
-    S_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
-          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_SLASH_GT
-        end
-      end
-    EOF
-
-    # Emits an HTML tag with the given content, properties and optional block.
-    # This method is an alternative to emitting HTML tags using dynamically
-    # created methods. This is particularly useful when using extensions that
-    # have method names that clash with HTML tags, such as `button` or `a`, or
-    # when you need to override the behaviour of a particular HTML tag.
-    #
-    # The following two method calls have the same effect:
-    #
-    # button 'text', id: 'button1'
-    # tag :button, 'text', id: 'button1'
-    #
-    # @param sym [Symbol, String] HTML tag
-    # @param text [String, nil] tag content
-    # @param **props [Hash] tag attributes
-    # @param &block [Proc] optional inner HTML
-    # @return [void]
-    def tag(sym, text = nil, **props, &block)
-      if text.is_a?(Hash) && props.empty?
-        props = text
-        text = nil
-      end
-
-      tag = sym.to_s.tr('_', '-')
-
-      @buffer << S_LT << tag
-      emit_props(props) unless props.empty?
-
-      if block
-        @buffer << S_GT
-        instance_eval(&block)
-        @buffer << S_LT_SLASH << tag << S_GT
-      elsif Proc === text
-        @buffer << S_GT
-        emit(text)
-        @buffer << S_LT_SLASH << tag << S_GT
-      elsif text
-        @buffer << S_GT << escape_text(text.to_s) << S_LT_SLASH << tag << S_GT
-      else
-        @buffer << S_SLASH_GT
-      end
-    end
-
-    # Catches undefined tag method call and handles it by defining the method.
-    #
-    # @param sym [Symbol] HTML tag or component identifier
-    # @param args [Array] method arguments
-    # @param opts [Hash] named method arguments
-    # @param &block [Proc] block passed to method
-    # @return [void]
-    def method_missing(sym, *args, **opts, &block)
-      tag = sym.to_s
-      code = S_TAG_METHOD % {
-        tag: tag,
-        TAG: tag.upcase,
-        tag_pre: "<#{tag.tr('_', '-')}".inspect,
-        tag_close: "</#{tag.tr('_', '-')}>".inspect
-      }
-      self.class.class_eval(code, __FILE__, S_TAG_METHOD_LINE)
-      send(sym, *args, **opts, &block)
-    end
-
     # Emits the given object into the rendering buffer. If the given object is a
     # proc or a component, `emit` will passes any additional arguments and named
     # arguments to the object when rendering it. If the given object is nil,
@@ -256,7 +162,7 @@ module Papercraft
     # Papercraft templates to inject state into sibling components, regardless
     # of the component's order in the container component. For example, a nested
     # component may set an instance variable used by another component. This is
-    # an elegant solution to the problem of setting the HTML page's title, or
+    # an elegant solution to the problem of setting the XML page's title, or
     # adding elements to the `<head>` section. Here's how a title can be
     # controlled from a nested component:
     #
@@ -288,24 +194,6 @@ module Papercraft
       @buffer = String.new(capacity: INITIAL_BUFFER_CAPACITY)
     end
     
-    S_LT              = '<'
-    S_GT              = '>'
-    S_LT_SLASH        = '</'
-    S_SPACE_LT_SLASH  = ' </'
-    S_SLASH_GT        = '/>'
-    S_SPACE           = ' '
-    S_EQUAL_QUOTE     = '="'
-    S_QUOTE           = '"'
-
-    # Emits text into the rendering buffer, escaping any special characters to
-    # the respective HTML entities.
-    #
-    # @param data [String] text
-    # @return [void]
-    def text(data)
-      @buffer << escape_text(data)
-    end
-
     private
 
     # Escapes text. This method must be overriden in descendant classes.
@@ -322,29 +210,6 @@ module Papercraft
       (@emit_yield_stack ||= []) << block
     end
 
-    # Emits tag attributes into the rendering buffer
-    # @param props [Hash] tag attributes
-    # @return [void]
-    def emit_props(props)
-      props.each { |k, v|
-        case k
-        when :src, :href
-          @buffer << S_SPACE << k.to_s << S_EQUAL_QUOTE <<
-            EscapeUtils.escape_uri(v) << S_QUOTE
-        else
-          case v
-          when true
-            @buffer << S_SPACE << k.to_s.tr('_', '-')
-          when false, nil
-            # emit nothing
-          else
-            @buffer << S_SPACE << k.to_s.tr('_', '-') <<
-              S_EQUAL_QUOTE << v << S_QUOTE
-          end
-        end
-      }
-    end
-
     # Renders a deferred proc by evaluating it, then adding the rendered result
     # to the buffer.
     #
@@ -366,23 +231,11 @@ module Papercraft
   # Implements an HTML renderer
   class HTMLRenderer < Renderer
     include HTML
-
-    private
-
-    # Escapes the given text using HTML entities.
-    def escape_text(text)
-      EscapeUtils.escape_html(text.to_s)
-    end
   end
 
   # Implements an XML renderer
   class XMLRenderer < Renderer
-    private
-
-    # Escapes the given text using XML entities.
-    def escape_text(text)
-      EscapeUtils.escape_xml(text.to_s)
-    end
+    include XML
   end
 
   class JSONRenderer < Renderer

data/lib/papercraft/tags.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Papercraft  
+  # Markup (HTML/XML) extensions
+  module Tags
+    S_LT              = '<'
+    S_GT              = '>'
+    S_LT_SLASH        = '</'
+    S_SPACE_LT_SLASH  = ' </'
+    S_SLASH_GT        = '/>'
+    S_SPACE           = ' '
+    S_EQUAL_QUOTE     = '="'
+    S_QUOTE           = '"'
+
+    # The tag method template below is optimized for performance. Do not touch!
+
+    S_TAG_METHOD_LINE = __LINE__ + 2
+    S_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
+          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_SLASH_GT
+        end
+      end
+    EOF
+
+    # Emits an XML tag with the given content, properties and optional block.
+    # This method is an alternative to emitting XML tags using dynamically
+    # created methods. This is particularly useful when using extensions that
+    # have method names that clash with XML tags, such as `button` or `a`, or
+    # when you need to override the behaviour of a particular XML tag.
+    #
+    # The following two method calls have the same effect:
+    #
+    # button 'text', id: 'button1'
+    # tag :button, 'text', id: 'button1'
+    #
+    # @param sym [Symbol, String] XML tag
+    # @param text [String, nil] tag content
+    # @param **props [Hash] tag attributes
+    # @param &block [Proc] optional inner XML
+    # @return [void]
+    def tag(sym, text = nil, **props, &block)
+      if text.is_a?(Hash) && props.empty?
+        props = text
+        text = nil
+      end
+
+      tag = tag_repr(sym)
+
+      @buffer << S_LT << tag
+      emit_props(props) unless props.empty?
+
+      if block
+        @buffer << S_GT
+        instance_eval(&block)
+        @buffer << S_LT_SLASH << tag << S_GT
+      elsif Proc === text
+        @buffer << S_GT
+        emit(text)
+        @buffer << S_LT_SLASH << tag << S_GT
+      elsif text
+        @buffer << S_GT << escape_text(text.to_s) << S_LT_SLASH << tag << S_GT
+      else
+        @buffer << S_SLASH_GT
+      end
+    end
+
+    # Catches undefined tag method call and handles it by defining the method.
+    #
+    # @param sym [Symbol] XML tag or component identifier
+    # @param args [Array] method arguments
+    # @param opts [Hash] named method arguments
+    # @param &block [Proc] block passed to method
+    # @return [void]
+    def method_missing(sym, *args, **opts, &block)
+      # p method_missing: sym, self: self
+      tag = sym.to_s
+      repr = tag_repr(tag)
+      code = S_TAG_METHOD % {
+        tag: tag,
+        TAG: tag.upcase,
+        tag_pre: "<#{repr}".inspect,
+        tag_close: "</#{repr}>".inspect
+      }
+      self.class.class_eval(code, __FILE__, S_TAG_METHOD_LINE)
+      send(sym, *args, **opts, &block)
+    end
+
+    # Emits text into the rendering buffer, escaping any special characters to
+    # the respective XML entities.
+    #
+    # @param data [String] text
+    # @return [void]
+    def text(data)
+      @buffer << escape_text(data)
+    end
+
+    private
+
+    def tag_repr(tag)
+      tag.to_s.tr('_', '-')
+    end
+
+    def att_repr(att)
+      att.to_s.tr('_', '-')
+    end
+
+    # Emits tag attributes into the rendering buffer
+    # @param props [Hash] tag attributes
+    # @return [void]
+    def emit_props(props)
+      props.each { |k, v|
+        case k
+        when :src, :href
+          @buffer << S_SPACE << k.to_s << S_EQUAL_QUOTE <<
+            EscapeUtils.escape_uri(v) << S_QUOTE
+        else
+          case v
+          when true
+            @buffer << S_SPACE << att_repr(k)
+          when false, nil
+            # emit nothing
+          else
+            @buffer << S_SPACE << att_repr(k) <<
+              S_EQUAL_QUOTE << v << S_QUOTE
+          end
+        end
+      }
+    end
+  end
+end

data/lib/papercraft/version.rb

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

data/lib/papercraft/xml.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'escape_utils'
+require_relative './tags'
+
+module Papercraft  
+  # XML renderer extensions
+  module XML
+    include Tags
+
+    private
+
+    def tag_repr(tag)
+      tag.to_s.gsub('__', ':').tr('_', '-')
+    end
+
+    def att_repr(att)
+      att.to_s.gsub('__', ':').tr('_', '-')
+    end
+
+    # Escapes the given text using XML entities.
+    def escape_text(text)
+      EscapeUtils.escape_xml(text.to_s)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papercraft
 version: !ruby/object:Gem::Version
-  version: '0.19'
+  version: '0.20'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -139,8 +139,10 @@ files:
 - lib/papercraft/html.rb
 - lib/papercraft/json.rb
 - lib/papercraft/renderer.rb
+- lib/papercraft/tags.rb
 - lib/papercraft/template.rb
 - lib/papercraft/version.rb
+- lib/papercraft/xml.rb
 - papercraft.png
 homepage: http://github.com/digital-fabric/papercraft
 licenses: