htx 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32fe6cdd2942dae5d197592bc9dbe2248b93bebcfe0d0fb5a82b463b9e953c28
-  data.tar.gz: 36496d0d5395836bb8196f6a1fe2b02af7634c97c2028536e149b7a69d1603d9
+  metadata.gz: ad1aaabd0904124ebc249af10fd5e8e93c11009f0fc0f7cb31f2f8656d4bb47d
+  data.tar.gz: 44e8808f07d173efc4830f07e0732822715e9837764518b780efe300ff08f2e6
 SHA512:
-  metadata.gz: e9c9bf24ca54886e6f4b9ad8e2bd8796436f299b2c0af7a0d742ac1b6ade2e55a30e477e4e5bb5b6d17a766641cd20cac8b3a0140e1fbfa48dda234664bf9c95
-  data.tar.gz: 85640a72d956e08d1f1467b8b3ef609e91f9bbc918e15b5c1faaf9065410b3b1f9324d30f82b65f9b12deae5417132f0aa6fa8fb081b8ccd7cb173f5f5af9360
+  metadata.gz: 5c7533d1b88bfc3365794cd18b8f26083364a060d4fdc1d4d1b3cef6dcb13af87e2ce4beb06553846da8add2481bda8fae5666a614b1c0ffff8b97d2b5aadd9d
+  data.tar.gz: ef37756cd45b5e7c58ababb1b9350467748816b998f50976055f2541356d282bd15bad20d47325f4ba4a32af1256b7ca407293b45ec496ba23fab494fd4c9f31

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019 Nate Pickens
+Copyright 2019-2020 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,11 +29,20 @@ template = File.read(File.join('some/asset/dir', path))
 
 HTX.compile(path, template)
 
+# Or to attach to a custom object instead of `window`:
+HTX.compile(path, template, assign_to: 'myTemplates')
+
 # Result:
 #
 #   window['/my/hot/template.htx'] = function(htx) {
 #     ...
 #   }
+#
+# If `assign_to` is specified:
+#
+#   myTemplates['/components/people.htx'] = function(htx) {
+#     // ...
+#   }
 ```
 
 ## Contributing

data/lib/htx.rb

@@ -6,9 +6,7 @@ require('nokogiri')
 # A Ruby compiler for HTX templates.
 #
 class HTX
-  class MalformedTemplateError < StandardError; end
-
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 
   CHILDLESS = 0b01
   TEXT_NODE = 0b10
@@ -34,11 +32,13 @@ class HTX
   CONTROL_STATEMENT = /[{}();]/.freeze
   CLOSE_STATEMENT = /;?\s*htx\.close\((\d*)\);?(\s*)\z/.freeze
 
+  EMPTY_HASH = {}.freeze
+
   ##
   # Convenience method to create a new instance and immediately call compile on it.
   #
-  def self.compile(name, template)
-    new(name, template).compile
+  def self.compile(name, template, options = EMPTY_HASH)
+    new(name, template).compile(options)
   end
 
   ##
@@ -53,16 +53,17 @@ class HTX
   ##
   # Compiles the HTX template.
   #
-  def compile
+  def compile(options = EMPTY_HASH)
     doc = Nokogiri::HTML::DocumentFragment.parse(@template)
     root_nodes = doc.children.select { |n| n.element? || (n.text? && n.text.strip != '') }
 
-    if root_nodes.any?(&:text?)
-      raise(MalformedTemplateError.new('Template contains text at its root level'))
+    if (text_node = root_nodes.find(&:text?))
+      raise(MalformedTemplateError.new('text nodes are not allowed at root level', @name, text_node))
     elsif root_nodes.size == 0
-      raise(MalformedTemplateError.new('Template does not have a root node'))
+      raise(MalformedTemplateError.new('a root node is required', @name))
     elsif root_nodes.size > 1
-      raise(MalformedTemplateError.new('Template has more than one node at its root level'))
+      raise(MalformedTemplateError.new("root node already defined on line #{root_nodes[0].line}", @name,
+          root_nodes[1]))
     end
 
     @compiled = ''.dup
@@ -72,7 +73,7 @@ class HTX
     @compiled.rstrip!
 
     <<~EOS
-      window['#{@name}'] = function(htx) {
+      #{options[:assign_to] || 'window'}['#{@name}'] = function(htx) {
         #{@compiled}
       }
     EOS
@@ -90,6 +91,10 @@ class HTX
       dynamic_key = process_value(node.attr(DYNAMIC_KEY_ATTR), :attr)
 
       if node.text? || node.name == ':'
+        if (non_text_node = node.children.find { |n| !n.text? })
+          raise(MalformedTemplateError.new('dummy tags may not contain child tags', @name, non_text_node))
+        end
+
         text = (node.text? ? node : node.children).text
 
         if (value = process_value(text))
@@ -113,14 +118,16 @@ class HTX
           attrs << process_value(attr.value, :attr)
         end
 
+        childless = node.children.empty? || (node.children.size == 1 && node.children[0].text.strip == '')
+
         append("htx.node(#{[
           "'#{TAG_MAP[node.name] || node.name}'",
           attrs,
           dynamic_key,
-          ((@static_key += 1) << FLAG_BITS) | (node.children.empty? ? CHILDLESS : 0),
+          ((@static_key += 1) << FLAG_BITS) | (childless ? CHILDLESS : 0),
         ].compact.flatten.join(', ')})")
 
-        unless node.children.empty?
+        unless childless
           process(node)
 
           count = ''
@@ -198,6 +205,18 @@ class HTX
     value.encode('ascii', fallback: ->(c) { "\\u#{c.ord.to_s(16).rjust(4, '0')}" })
   end
 
+  class MalformedTemplateError < StandardError
+    def initialize(message, name, node = nil)
+      if node
+        line = node.line
+        line = node.parent.line if line < 1
+        line = nil if line == -1
+      end
+
+      super("Malformed template #{name}#{":#{line}" if line}: #{message}")
+    end
+  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.
@@ -209,12 +228,14 @@ class HTX
   ].map { |tag| [tag.downcase, tag] }.to_h.freeze
 
   ATTR_MAP = %w[
-    attributeName baseFrequency calcMode clipPathUnits diffuseConstant edgeMode filterUnits
-    gradientTransform gradientUnits kernelMatrix kernelUnitLength keyPoints keySplines keyTimes lengthAdjust
-    limitingConeAngle markerHeight markerUnits markerWidth maskContentUnits maskUnits numOctaves pathLength
-    patternContentUnits patternTransform patternUnits pointsAtX pointsAtY pointsAtZ preserveAlpha
-    preserveAspectRatio primitiveUnits refX refY repeatCount repeatDur requiredExtensions specularConstant
-    specularExponent spreadMethod startOffset stdDeviation stitchTiles surfaceScale systemLanguage
-    tableValues targetX targetY textLength viewBox xChannelSelector yChannelSelector zoomAndPan
+    allowReorder attributeName attributeType autoReverse baseFrequency baseProfile calcMode clipPathUnits
+    contentScriptType contentStyleType diffuseConstant edgeMode externalResourcesRequired filterRes
+    filterUnits glyphRef gradientTransform gradientUnits kernelMatrix kernelUnitLength keyPoints keySplines
+    keyTimes lengthAdjust limitingConeAngle markerHeight markerUnits markerWidth maskContentUnits maskUnits
+    numOctaves pathLength patternContentUnits patternTransform patternUnits pointsAtX pointsAtY pointsAtZ
+    preserveAlpha preserveAspectRatio primitiveUnits refX refY referrerPolicy repeatCount repeatDur
+    requiredExtensions requiredFeatures specularConstant specularExponent spreadMethod startOffset
+    stdDeviation stitchTiles surfaceScale systemLanguage tableValues targetX targetY textLength viewBox
+    viewTarget xChannelSelector yChannelSelector zoomAndPan
   ].map { |attr| [attr.downcase, attr] }.to_h.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: htx
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Nate Pickens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A Ruby compiler for HTX templates.