htx 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b83c07872c223b61b939883d9f2f6bc45a1cecc380c4b21701d04a606e7ae381
-  data.tar.gz: bfbf43071b20b13be3895bf4e358617765f39f276ed1d37c91c93f09c024b48a
+  metadata.gz: 83c2b45f8852d11b5faa35989c0552a4135c3270d20aaaa2af8d170e696ad840
+  data.tar.gz: dcbbb3aac2484f55b445a029c9916e282dc75b93197f630b40227110aba02c28
 SHA512:
-  metadata.gz: 0dc4f9f8fad2b18266ca93a562fa1565361b330744e8f02134341c1a5982f0821a9b008975adcff7840626d85f05bca223dd433705799c227217584dab1f970c
-  data.tar.gz: 58756df107105643831511c4faff3f7ccdc96fdcd318d7f65833cb642b4c08be60ab2e2f9cc6ffb999a9980a63a8a15a9b0b8b94c0aab8a4f8447ee61909c5a4
+  metadata.gz: 8a26b13b0f0cdddf7d9338f1876c23e59adaef4abd2d706cae4a984bd74ca207465e93d6c1d1f0877adf5f27999ddbfd59d93c703ffe098ea7cfc239bc8f391d
+  data.tar.gz: e6ace0fd8c2289e1b2062e6f9e976e017b3e639cfd0eb0777bf5e4bd9ded53d8774c843cfcb1cc55a1c491d0fe6d4f81e337455897ec471bebc0d333db202ba5

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019-2022 Nate Pickens
+Copyright 2019-2023 Nate Pickens
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without

data/README.md

@@ -29,7 +29,7 @@ template = File.read(File.join('some/asset/dir', path))
 
 HTX.compile(path, template)
 
-# window['/components/crew.htx'] = function(htx) {
+# globalThis['/components/crew.htx'] = function(htx) {
 #   // ...
 # }
 

data/VERSION

@@ -1 +1 @@
-0.0.8
+0.1.0

data/lib/htx/template.rb

@@ -17,7 +17,6 @@ module HTX
       'svg' => 'http://www.w3.org/2000/svg',
     }.freeze
 
-    INDENT_VALID = /^( +|\t+)$/.freeze
     INDENT_GUESS = /^( +|\t+)(?=\S)/.freeze
     INDENT_REGEX = /\n(?=[^\n])/.freeze
 
@@ -32,17 +31,14 @@ module HTX
     NON_WHITESPACE = /\S/.freeze
 
     ##
-    # Returns false. In the near future when support for the <:> tag has been dropped (in favor of
-    # <htx-content>), will return true if Nokogiri's HTML5 parser is available. To use it now, monkey patch
-    # this method to return true.
+    # Returns true if Nokogiri's HTML5 parser is available.
     #
     def self.html5_parser?
-      false # !!defined?(Nokogiri::HTML5)
+      defined?(Nokogiri::HTML5)
     end
 
     ##
-    # Returns Nokogiri's HTML5 parser if available and enabled, and Nokogiri's regular HTML parser
-    # otherwise.
+    # Returns Nokogiri's HTML5 parser if available or Nokogiri's default HTML (4) parser otherwise.
     #
     def self.nokogiri_parser
       html5_parser? ? Nokogiri::HTML5 : Nokogiri::HTML
@@ -62,24 +58,11 @@ module HTX
     ##
     # Compiles the HTX template.
     #
-    # * +assign_to+ - JavaScript object to assign the template function to (default: <tt>window</tt>).
-    # * +indent+ - DEPRECATED. Indentation amount (number) or string (must be only spaces or tabs but not
-    #   both) to use for indentation of compiled output (default: indentation of first indented line of
-    #   uncompiled template).
-    #
-    def compile(assign_to: nil, indent: (indent_omitted = true; nil))
-      @assign_to = assign_to || 'window'
-      @indent =
-        if indent.kind_of?(Numeric)
-          ' ' * indent
-        elsif indent && !indent.match?(INDENT_VALID)
-          raise("Invalid indent value #{indent.inspect}: only spaces and tabs (but not both) are allowed")
-        else
-          indent || @content[INDENT_GUESS] || INDENT_DEFAULT
-        end
-
-      warn('The indent: option for HTX template compilation is deprecated.') unless indent_omitted
-
+    # * +assign_to+ - JavaScript object to assign the template function to (default: +globalThis+).
+    #
+    def compile(assign_to: nil)
+      @assign_to = assign_to || 'globalThis'
+      @base_indent = @indent = @content[INDENT_GUESS] || INDENT_DEFAULT
       @static_key = 0
       @close_count = 0
       @whitespace_buff = nil
@@ -158,14 +141,35 @@ module HTX
     # * +node+ - Nokogiri node to process.
     #
     def process_fragment_node(node)
-      append("#{@assign_to}['#{@name}'] = function(htx) {")
-      @whitespace_buff = "\n"
+      append(
+        <<~JS
+          #{@assign_to}['#{@name}'] = ((HTX) => {
+          #{@indent}function render($rndr) {
+        JS
+      )
+
+      @indent = @base_indent * 2
 
       node.children.each do |child|
         process(child)
       end
 
-      append("\n}\n",)
+      append("\n\n#{@indent}return $rndr.rootNode")
+
+      @indent = @base_indent
+
+      append(
+        +<<~JS
+
+          #{@indent}}
+
+          #{@indent}return function Template(context) {
+          #{@indent * 2}this.render = render.bind(context, new HTX.Renderer)
+          #{@indent}}
+          })(globalThis.HTX ||= {});
+        JS
+      )
+
       flush
     end
 
@@ -173,21 +177,16 @@ module HTX
     # Processes an element node.
     #
     # * +node+ - Nokogiri node to process.
-    # * +xmlns+ - True if node is the descendent of a node with an xmlns attribute.
+    # * +xmlns+ - True if node is the descendant of a node with an xmlns attribute.
     #
     def process_element_node(node, xmlns: false)
       children = node.children
       childless = children.empty? || (children.size == 1 && self.class.formatting_node?(children.first))
       dynamic_key = self.class.attribute_value(node.attr(DYNAMIC_KEY_ATTR))
-      attributes = self.class.process_attributes(node)
+      attributes = self.class.process_attributes(node, xmlns: xmlns)
       xmlns ||= !!self.class.namespace(node)
 
       if self.class.htx_content_node?(node)
-        if node.name != CONTENT_TAG
-          warn("#{@name}:#{node.line}: The <#{node.name}> tag has been deprecated. Use <#{CONTENT_TAG}> "\
-            "for identical functionality.")
-        end
-
         if attributes.size > 0
           raise(MalformedTemplateError.new("<#{node.name}> tags may not have attributes other than "\
             "#{DYNAMIC_KEY_ATTR}", @name, node))
@@ -263,13 +262,13 @@ module HTX
     # * +text+ - String to append to the compiled template string.
     #
     def append(text)
-      return @compiled if text.nil? || text.empty?
+      return if text.nil? || text.empty?
 
       if @close_count > 0
         close_count = @close_count
         @close_count = 0
 
-        append("htx.close(#{close_count unless close_count == 1})")
+        append("$rndr.close(#{close_count unless close_count == 1})")
       end
 
       if @whitespace_buff
@@ -286,8 +285,6 @@ module HTX
 
       flush if text.match?(NON_WHITESPACE)
       @statement_buff << text
-
-      @compiled
     end
 
     ##
@@ -302,7 +299,7 @@ module HTX
       args << 0 unless args.last.kind_of?(Integer)
       args[-1] |= (@static_key += 1) << FLAG_BITS
 
-      append("htx.node(#{args.join(', ')})")
+      append("$rndr.node(#{args.join(', ')})")
     end
 
     ##
@@ -311,8 +308,6 @@ module HTX
     def flush
       @compiled << @statement_buff
       @statement_buff.clear
-
-      @compiled
     end
 
     ##
@@ -340,7 +335,7 @@ module HTX
     # * +node+ - Nokogiri node to check.
     #
     def self.htx_content_node?(node)
-      node && (node.name == CONTENT_TAG || node.name == 'htx-text' || node.name == ':')
+      node&.name == CONTENT_TAG
     end
 
     ##
@@ -348,10 +343,10 @@ module HTX
     #
     # * +node+ - Nokogiri node to process the attributes of.
     #
-    def self.process_attributes(node)
+    def self.process_attributes(node, xmlns:)
       attributes = []
 
-      if !node.attribute('xmlns') && (xmlns = namespace(node))
+      if !xmlns && !node.attribute('xmlns') && (xmlns = namespace(node))
         attributes.push(
           attribute_name('xmlns'),
           attribute_value(xmlns)
@@ -369,7 +364,9 @@ module HTX
     end
 
     ##
+    # Returns namespace URL of a Nokogiri node.
     #
+    # * +node+ - Nokogiri node to get the namespace of.
     #
     def self.namespace(node)
       node.namespace&.href || DEFAULT_XMLNS[node.name]
@@ -404,15 +401,10 @@ module HTX
       text ? TextParser.new(text, statement_allowed: false).parse : nil
     end
 
-    # The Nokogiri HTML parser downcases all tag and attribute names, but SVG tags and attributes are case
-    # sensitive and often mix cased. These maps are used to restore the correct case of such tags and
-    # attributes.
-    #
-    # Note: Nokogiri's newer HTML5 parser resulting from the Nokogumbo merge fixes this issue, but it is
-    # currently not available for JRuby. It also does not parse <:> as a tag, which is why it's been
-    # deprecated in favor of <htx-content>. Once support for <:> has been completely removed, the HTML5
-    # parser will be used for regular Ruby and this tag and attribute mapping hack reserved for JRuby (and
-    # any other potential environments where the HTML5 parser is not available).
+    # The Nokogiri::HTML5 parser is used whenever possible, which correctly handles mix-cased SVG tag and
+    # attribute names. But when falling back to the Nokogiri::HTML parser (e.g. in JRuby environments where
+    # Nokogiri::HTML5 is not available), all tag and attribute names get downcased. These maps are used to
+    # restore the correct case.
 
     # Source: https://developer.mozilla.org/en-US/docs/Web/SVG/Element
     TAG_MAP = %w[

data/lib/htx/text_parser.rb

@@ -216,6 +216,8 @@ module HTX
     ##
     # Flushes buffer during parsing and performs statement detection if appropriate.
     #
+    # * +state+ - Last state that was parsed.
+    #
     def flush(state = nil)
       return if @buffer.empty?
 

data/lib/htx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTX
-  VERSION = '0.0.8'
+  VERSION = '0.1.0'
 end

data/lib/htx.rb

@@ -21,18 +21,4 @@ module HTX
   def self.compile(name, content, options = EMPTY_HASH)
     Template.new(name, content).compile(**options)
   end
-
-  ##
-  # DEPRECATED. Use HTX::Template.new instead. HTX was formerly a class that would be instantiated for
-  # compilation. This method allows HTX.new calls to continue working (but support will be removed in the
-  # near future).
-  #
-  # * +name+ - Template name. Conventionally the path of the template file.
-  # * +content+ - Template content.
-  #
-  def self.new(name, content)
-    warn('HTX.new is deprecated. Please use HTX::Template.new instead.')
-
-    Template.new(name, content)
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: htx
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Nate Pickens
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: A Ruby compiler for HTX templates.