papercraft 0.26 → 0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b64cff374a2d8fdf50de978d3a4b0ceb6fb939741c00ed7cf63154af7cf6732
-  data.tar.gz: 67c0fc2aa65a1056f04c378ebe50a0a433bb1cabba75a1fbd522d60604ddcd1d
+  metadata.gz: eccca55a3b242b80413bad0c851619062d66c1b68eaa9f2e4a13ca9e4beefddf
+  data.tar.gz: a5cf234c36fe286a94d6607bc30e13a24568396f6fe78b2f0e22870618e97941
 SHA512:
-  metadata.gz: 690eaec575b4ad635fc913609197d166841536811b1e1d4314d763c6c37fb520b9fc8f2f19d50f4a0cfd242a98b69d59aebf16eaa16f4298bfc74ac0040b516a
-  data.tar.gz: 66a468eeee29e5c2b9b9e7a2f3adc605fa2f9648ade7a0aa444a798d896de3eb8c5aa02c2e79bf27780769f86d2b1960b8a111be1d8ed6604af739cab5931adb
+  metadata.gz: 003a30933c7d7557a346ce02bcc54169427389db2e488ee5516b68b9e99d74f2b5f0464db4e327c1c3064bc7cbfe0df9c4ef0df6322b61a467f14f30a83b415c
+  data.tar.gz: cc8d7e819fdefc04a5ffb1966d707d6fb7e533bc0c8f6d3fc39191749c4733593850a4cb046648c010c2ae4daae6fbaa6980b806a1ab61d9746481dc63fd8ecf

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.28 2023-03-11
+
+- Add `HTML#import_map`, `HTML#js_module` methods
+
+## 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`

data/lib/papercraft/html.rb

@@ -71,7 +71,47 @@ module Papercraft
         @buffer << '></script>'
       end
     end
+
+    # Returns a versioned URL for the given file spec.
+    #
+    # @param href [String] relative file path
+    # @param root_path [String] root path for file
+    # @param root_url [String] root URL
+    # @return [String] versioned URL
+    def versioned_file_href(href, root_path, root_url = '')
+      fn = File.join(root_path, href)
+      version = File.stat(fn).mtime.to_i rescue 0
+      "#{root_url}/#{href}?v=#{version}"
+    end  
   
+    # Emits an import map scrit tag. If a hash is given, emits the hash as is.
+    # If a string is given, searches for all *.js files under the given path,
+    # and emits an import map including all found files, with versioned URLs.
+    #
+    # @param root_path [String, Hash] root path or hash
+    # @param root_url [String] root URL to construct URLs against
+    # @return [void]
+    def import_map(root_path, root_url = '')
+      if root_path.is_a?(Hash)
+        script(root_path.to_json, type: 'importmap')
+      else
+        map = Dir["#{root_path}/*.js"].sort.each_with_object({}) do |fn, h|
+          name = File.basename(fn)
+          m = fn.match(/\/([^\/]+)\.js$/)
+          h[m[1]] = versioned_file_href(name, root_path, root_url)
+        end
+        script(map.to_json, type: 'importmap')
+      end
+    end
+
+    # Emits a script tag with type attribute set to module.
+    #
+    # @param code [String] JS code
+    # @return [void]
+    def js_module(code)
+      script code, type: 'module'
+    end
+
     # Converts and emits the given markdown. Papercraft uses
     # [Kramdown](https://github.com/gettalong/kramdown/) to do the Markdown to
     # HTML conversion. Optional Kramdown settings can be provided in order to
@@ -88,6 +128,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

@@ -10,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           = '"'
@@ -21,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
@@ -149,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
 
@@ -165,7 +198,6 @@ module Papercraft
       tag = sym.to_s
       if tag =~ /^[A-Z]/ && (Object.const_defined?(tag))
         define_const_tag_method(tag)
-        # return send(tag, *args, **opts)
       else
         define_tag_method(tag)
       end
@@ -262,13 +294,20 @@ 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.

data/lib/papercraft/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Papercraft
-  VERSION = '0.26'
+  VERSION = '0.28'
 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.26'
+  version: '0.28'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2023-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils