htx 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94e1883a59d09cce6170061c9e0602a3430da8ca800163ba2fe8cc9d10b316b4
-  data.tar.gz: a26e6aa3a874e40569cd62204aa698a6bdec5b02a78dc35ea993d0a11ff8f0f2
+  metadata.gz: 32fe6cdd2942dae5d197592bc9dbe2248b93bebcfe0d0fb5a82b463b9e953c28
+  data.tar.gz: 36496d0d5395836bb8196f6a1fe2b02af7634c97c2028536e149b7a69d1603d9
 SHA512:
-  metadata.gz: 004dca83de5a65ba167eb345d21a1a8c1d771efbe946fc746cfb470d4ca783bad57830ced8ba6f1a7ce47e9e04abc3ee06a6ebf02fc9d5a0eee2892983dbf136
-  data.tar.gz: ab814533c1f9ead9fa8daa2ef46959a2a8893c21e3705ee9863fbcaeed90ec0e70f835d36420fe1ade8c1a0bf9c33478987e76d07cbb20c154a4da26d3ef7492
+  metadata.gz: e9c9bf24ca54886e6f4b9ad8e2bd8796436f299b2c0af7a0d742ac1b6ade2e55a30e477e4e5bb5b6d17a766641cd20cac8b3a0140e1fbfa48dda234664bf9c95
+  data.tar.gz: 85640a72d956e08d1f1467b8b3ef609e91f9bbc918e15b5c1faaf9065410b3b1f9324d30f82b65f9b12deae5417132f0aa6fa8fb081b8ccd7cb173f5f5af9360

data/lib/htx.rb

@@ -6,7 +6,9 @@ require('nokogiri')
 # A Ruby compiler for HTX templates.
 #
 class HTX
-  VERSION = '0.0.1'
+  class MalformedTemplateError < StandardError; end
+
+  VERSION = '0.0.2'
 
   CHILDLESS = 0b01
   TEXT_NODE = 0b10
@@ -33,29 +35,57 @@ class HTX
   CLOSE_STATEMENT = /;?\s*htx\.close\((\d*)\);?(\s*)\z/.freeze
 
   ##
-  # Compiles an HTX template and assigns it the given name (conventionally the path of the template file is
-  # used, but it can be anything).
+  # Convenience method to create a new instance and immediately call compile on it.
   #
   def self.compile(name, template)
-    doc = Nokogiri::HTML::DocumentFragment.parse(template)
-    js = ''.dup
+    new(name, template).compile
+  end
+
+  ##
+  # Creates a new HTX instance. Conventionally the path of the template file is used for the name, but it
+  # can be anything.
+  #
+  def initialize(name, template)
+    @name = name
+    @template = template
+  end
 
-    process(doc, js, static_key: 0)
-    js.rstrip!
+  ##
+  # Compiles the HTX template.
+  #
+  def compile
+    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'))
+    elsif root_nodes.size == 0
+      raise(MalformedTemplateError.new('Template does not have a root node'))
+    elsif root_nodes.size > 1
+      raise(MalformedTemplateError.new('Template has more than one node at its root level'))
+    end
+
+    @compiled = ''.dup
+    @static_key = 0
+
+    process(doc)
+    @compiled.rstrip!
 
     <<~EOS
-      window['#{name}'] = function(htx) {
-        #{js}
+      window['#{@name}'] = function(htx) {
+        #{@compiled}
       }
     EOS
   end
 
+  private
+
   ##
-  # Processes a DOM node.
+  # Processes a DOM node's descendents.
   #
-  def self.process(base, js, options = {})
+  def process(base)
     base.children.each do |node|
-      next if node.comment?
+      next unless node.element? || node.text?
 
       dynamic_key = process_value(node.attr(DYNAMIC_KEY_ATTR), :attr)
 
@@ -63,17 +93,17 @@ class HTX
         text = (node.text? ? node : node.children).text
 
         if (value = process_value(text))
-          append(js,
+          append(
             "#{indent(text[LEADING_WHITESPACE])}"\
             "htx.node(#{[
               value,
               dynamic_key,
-              ((options[:static_key] += 1) << FLAG_BITS) | TEXT_NODE,
+              ((@static_key += 1) << FLAG_BITS) | TEXT_NODE,
             ].compact.join(', ')})"\
             "#{indent(text[TRAILING_WHITESPACE])}"
           )
         else
-          append(js, indent(text))
+          append(indent(text))
         end
       else
         attrs = node.attributes.inject([]) do |attrs, (_, attr)|
@@ -83,50 +113,50 @@ class HTX
           attrs << process_value(attr.value, :attr)
         end
 
-        append(js, "htx.node(#{[
+        append("htx.node(#{[
           "'#{TAG_MAP[node.name] || node.name}'",
           attrs,
           dynamic_key,
-          ((options[:static_key] += 1) << FLAG_BITS) | (node.children.empty? ? CHILDLESS : 0),
+          ((@static_key += 1) << FLAG_BITS) | (node.children.empty? ? CHILDLESS : 0),
         ].compact.flatten.join(', ')})")
 
         unless node.children.empty?
-          process(node, js, options)
+          process(node)
 
           count = ''
-          js.sub!(CLOSE_STATEMENT) do
+          @compiled.sub!(CLOSE_STATEMENT) do
             count = $1 == '' ? 2 : $1.to_i + 1
             $2
           end
 
-          append(js, "htx.close(#{count})")
+          append("htx.close(#{count})")
         end
       end
     end
   end
 
   ##
-  # Appends a string to the compiled template function string with appropriate punctuation and/or
-  # whitespace inserted.
+  # Appends a string to the compiled template function string with appropriate punctuation and/or whitespace
+  # inserted.
   #
-  def self.append(js, text)
-    if js == ''
+  def append(text)
+    if @compiled == ''
       # Do nothing.
-    elsif js !~ END_STATEMENT_END && text !~ BEGIN_STATEMENT_END
-      js << '; '
-    elsif js !~ END_WHITESPACE && text !~ BEGIN_WHITESPACE
-      js << ' '
-    elsif js[-1] == "\n"
-      js << '  '
+    elsif @compiled !~ END_STATEMENT_END && text !~ BEGIN_STATEMENT_END
+      @compiled << '; '
+    elsif @compiled !~ END_WHITESPACE && text !~ BEGIN_WHITESPACE
+      @compiled << ' '
+    elsif @compiled[-1] == "\n"
+      @compiled << '  '
     end
 
-    js << text
+    @compiled << text
   end
 
   ##
   # Indents each line of a string (except the first).
   #
-  def self.indent(text)
+  def indent(text)
     return '' unless text
 
     text.gsub!(NEWLINE_NON_BLANK, "\n  ")
@@ -137,7 +167,7 @@ class HTX
   # Processes, formats, and encodes an attribute or text node value. Returns nil if the value is determined
   # to be a control statement.
   #
-  def self.process_value(text, is_attr = false)
+  def process_value(text, is_attr = false)
     return nil if text.nil? || (!is_attr && text.strip == '')
 
     if (value = text[RAW_VALUE, 1])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: htx
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nate Pickens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2019-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri