bob-compiler 0.0.1

data/lib/bob/compiler/layout.rb

@@ -0,0 +1,51 @@
+require "bob/compiler/walker"
+require "bob/compiler/editable"
+
+module Bob
+  module Compiler
+    class Layout < Walker
+      include Editable
+
+      attr_reader :container
+
+      private
+        def compile
+          super
+
+          if container.nil?
+            error("No container defined", @node.children.try(:last) || @node)
+          end
+        end
+
+        def after_element(node, root)
+          if is_container?(node)
+            if container
+              warn "Multiple containers found, extra contains are ignored", node
+            else
+              assign_container(node)
+            end
+          end
+
+          super
+        end
+
+        def filtered_children(node)
+          is_container?(node) ? [] : super
+        end
+
+        def is_container?(node)
+          node.has_attribute?("bob-container")
+        end
+
+        def assign_container(node)
+          @container = node
+
+          @buffer << <<-JS.strip_heredoc.chomp
+            descriptor.container = {
+              element: dom.getElement()
+            };
+          JS
+        end
+    end
+  end
+end

data/lib/bob/compiler/message.rb

@@ -0,0 +1,21 @@
+module Bob
+  module Compiler
+    class Message
+      attr_reader :message, :line
+
+      def initialize(message, node_or_line_number)
+        @message = message
+        @line    = extract_line_number(node_or_line_number)
+      end
+
+      def <=>(other)
+        line <=> other.line
+      end
+
+      private
+        def extract_line_number(node_or_line_number)
+          node_or_line_number.line rescue node_or_line_number
+        end
+    end
+  end
+end

data/lib/bob/compiler/substitution.rb

@@ -0,0 +1,57 @@
+module Bob
+  module Compiler
+    module Substitution
+      SUBSTITUTION_SCANNER = /(\\?{{.+?}})/
+
+      SUBSTITUTION_PARSER  = /
+        \A
+          {{
+            [[:blank:]]*
+            (?<path> [0-9a-z_]+ (?:\.[0-9a-z_]+)* )
+            [[:blank:]]*
+            (?:
+              \|\|
+              [[:blank:]]*
+              (?:
+                (?: ' (?<fallback> (?:[^'\\{}]|\\.)*) ' ) |
+                (?: " (?<fallback> (?:[^"\\{}]|\\.)*) " )
+              )
+              [[:blank:]]*
+            )?
+          }}
+        \z
+      /xi
+
+      def quote_and_substitute(arg, node)
+        parts = arg.split(SUBSTITUTION_SCANNER).reject(&:empty?)
+
+        if parts.empty?
+          %{""}
+        else
+          parts.map { |str|
+
+            if SUBSTITUTION_SCANNER =~ str && str[0] != "/"
+              if (parsed = SUBSTITUTION_PARSER.match(str))
+                if parsed[:fallback]
+                  "env.get(#{quote parsed[:path]}, #{quote unescape parsed[:fallback]})"
+                else
+                  "env.get(#{quote parsed[:path]})"
+                end
+              else
+                warn "Treating invalid substitution as string: #{str.inspect}", node.parent.line
+                quote str
+              end
+            else
+              quote str
+            end
+
+          }.join(" + ")
+        end
+      end
+
+      def unescape(str)
+        str.gsub(/\\(.)/, "\\1")
+      end
+    end
+  end
+end

data/lib/bob/compiler/template.rb

@@ -0,0 +1,90 @@
+require "nokogiri"
+require "bob/compiler/base"
+require "bob/compiler/layout"
+require "bob/compiler/block"
+require "bob/compiler/editable"
+
+module Bob
+  module Compiler
+    class Template < Base
+      def initialize(name, template_string)
+        super()
+        @name = name
+        @template_string = template_string
+      end
+
+      private
+        def compile
+          doc = Nokogiri::HTML(@template_string)
+          key = sanitize_identifier(@name)
+
+          doc.errors.each do |error|
+            warn(error.message, error.line)
+          end
+
+          unless doc.root
+            error("Parse error", 0)
+            return
+          end
+
+          @buffer << 'Bob.registerTemplate(' << quote(key) << ', {'
+
+          @buffer.indented do
+            if @template_string =~ /<!DOCTYPE/i
+              @buffer.blankline!
+              @buffer << "doctype: " << quote(doc.internal_subset.to_xhtml) << ","
+            end
+
+            @buffer.blankline!
+
+            @buffer << "name: " << quote(@name) << ","
+
+            @buffer.blankline!
+
+            @buffer << "layout: "
+
+            compiled_layout = Layout.new(doc.root)
+
+            @warnings += compiled_layout.warnings
+            @errors   += compiled_layout.errors
+
+            @buffer.merge(compiled_layout.buffer) << ","
+
+            @buffer.blankline!
+
+            @buffer << "blocks: {"
+
+            if compiled_layout.container
+              @buffer.indented do
+
+                compiled_layout.container.children.each do |block_element|
+                  next unless block_element.element?
+
+                  compiled_block = Block.new(block_element)
+
+                  @warnings += compiled_block.warnings
+                  @errors   += compiled_block.errors
+
+                  next unless compiled_block.name
+
+                  @buffer.blankline!
+
+                  @buffer << quote(compiled_block.name) << ": "
+
+                  @buffer.merge(compiled_block.buffer) << ","
+                end
+
+                @buffer.blankline!
+              end
+            end
+
+            @buffer << "}"
+          end
+
+          @buffer.blankline!
+
+          @buffer << "});"
+        end
+    end
+  end
+end

data/lib/bob/compiler/version.rb

@@ -0,0 +1,5 @@
+module Bob
+  module Compiler
+    VERSION = "0.0.1"
+  end
+end

data/lib/bob/compiler/walker.rb

@@ -0,0 +1,112 @@
+require 'bob/compiler/base'
+require 'bob/compiler/buffer'
+require 'bob/compiler/editable'
+require 'bob/compiler/substitution'
+
+module Bob
+  module Compiler
+    class Walker < Base
+      include Substitution
+
+      def initialize(node)
+        super()
+        @node = node
+      end
+
+      private
+        def compile
+          @buffer << "function(dom, env) {"
+
+          @buffer.indented do
+            @buffer << "var descriptor = #{pretty_quote descriptor};"
+
+            @buffer.blankline!
+
+            walk(@node, true)
+
+            @buffer.blankline!
+
+            @buffer << "descriptor.element = dom.getElement();"
+
+            @buffer.blankline!
+
+            @buffer << "return descriptor;"
+          end
+
+          @buffer << "}"
+        end
+
+        def descriptor
+          {
+            element: nil,
+            editables: []
+          }
+        end
+
+        def walk(node, root = false)
+          if node.element?
+            visit_element(node, root)
+          elsif node.text? || node.cdata?
+            visit_text_node(node)
+          elsif node.comment?
+            visit_comment_node(node)
+          else
+            raise TypeError, "Unsupported node type #{node.type}"
+          end
+
+          if node.element?
+            filtered_children(node).each do |child|
+              walk(child)
+            end
+
+            after_element(node, root)
+          end
+        end
+
+        def filtered_children(node)
+          node.children.select { |child| child.element? || child.text? || child.cdata? || child.comment? }
+        end
+
+        def filtered_attributes(node)
+          # TODO: switch to a whitelist
+          node.attribute_nodes.reject { |attr| attr.name.start_with?('bob-') }
+        end
+
+        def visit_element(node, root)
+          build_element(node, root)
+        end
+
+        def after_element(node, root)
+          append_element(node) unless root
+        end
+
+        def visit_text_node(node)
+          build_text_node(node)
+        end
+
+        def visit_comment_node(node)
+          build_comment_node(node)
+        end
+
+        def build_element(node, root)
+          @buffer << "dom.createElement(#{quote node.node_name});"
+
+          filtered_attributes(node).each do |attr|
+            @buffer << "dom.setAttribute(#{quote attr.name}, #{quote_and_substitute attr.value, node});"
+          end
+        end
+
+        def append_element(node)
+          @buffer << "dom.appendElement();"
+        end
+
+        def build_text_node(node)
+          @buffer << "dom.appendTextNode(#{quote_and_substitute node.text, node});"
+        end
+
+        def build_comment_node(node)
+          @buffer << "dom.appendComment(#{quote_and_substitute node.text, node});"
+        end
+    end
+  end
+end

data/test/blocks_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+require 'nokogiri'
+
+require 'bob/compiler/block'
+
+class BlocksTest < Minitest::Test
+  include FixtureHelpers
+
+  self.fixture_path << '/blocks'
+
+  fixtures.each do |name|
+    test "Fixture #{name}" do
+      input    = fixture "#{name}.html"
+      expected = fixture "#{name}.js"
+
+      assert_equal expected, compile(input)
+      assert_predicate @compiled, :valid?
+    end
+  end
+
+  [" abc ", " !@#abc^& ", "AbC", "&quot;abc&quot;"].each do |identifier|
+    test "Invalid identifier: #{identifier.inspect}" do
+      compile %{<div bob-block="#{identifier}"></div>}
+
+      assert_predicate @compiled, :valid?
+      refute_predicate @compiled, :well_formed?
+      assert_predicate @compiled, :warnings?
+      refute_predicate @compiled, :errors?
+
+      assert_includes @compiled.warnings.first.message, "does not contain a valid identifier"
+      assert_includes @compiled.warnings.first.message, "assuming you meant"
+      assert_equal 1, @compiled.warnings.first.line
+    end
+  end
+
+  ["!@#^& ", "&quot;&quot;"].each do |identifier|
+    test "Invalid identifier: #{identifier.inspect}" do
+      compile %{<div bob-block="#{identifier}"></div>}
+
+      refute_predicate @compiled, :valid?
+      refute_predicate @compiled, :well_formed?
+      refute_predicate @compiled, :warnings?
+      assert_predicate @compiled, :errors?
+
+      assert_includes @compiled.errors.first.message, "does not contain a valid identifier"
+      assert_equal 1, @compiled.errors.first.line
+    end
+  end
+
+  ["", "  \t "].each do |identifier|
+    test "Blank identifier: #{identifier.inspect}" do
+      compile %{<div bob-block="#{identifier}"></div>}
+
+      refute_predicate @compiled, :valid?
+      refute_predicate @compiled, :well_formed?
+      refute_predicate @compiled, :warnings?
+      assert_predicate @compiled, :errors?
+
+      assert_includes @compiled.errors.first.message, "cannot be blank"
+      assert_equal 1, @compiled.errors.first.line
+    end
+  end
+
+  test "Illegal substitution" do
+    compile %[<div bob-block="zomg">{{ not valid }}</div>]
+
+    assert_predicate @compiled, :valid?
+    refute_predicate @compiled, :well_formed?
+    assert_predicate @compiled, :warnings?
+    refute_predicate @compiled, :errors?
+
+    assert_includes @compiled.warnings.first.message, "invalid substitution"
+    assert_equal 1, @compiled.warnings.first.line
+  end
+
+  private
+    def compile(str)
+      fragment = Nokogiri::HTML::DocumentFragment.parse(str)
+      @compiled = Bob::Compiler::Block.new(fragment.children.first)
+      @compiled.result
+    end
+end

data/test/fixtures/blocks/bar.html

@@ -0,0 +1,10 @@
+<div bob-block="bar" class="bar">
+  <!-- BEGIN HEADER -->
+  <div class="header" style="line-height: 2" data-rick>
+    <h2 bob-editable="plaintext">Foo</h2>
+    <div bob-editable="html"></div>
+  </div>
+  <!-- END HEADER -->
+  <hr />
+  <div style="font-size: 11pt" bob-editable="html"></div>
+</div>

data/test/fixtures/blocks/bar.js

@@ -0,0 +1,63 @@
+function(dom, env) {
+  var descriptor = {
+    "type": "bar",
+    "element": null,
+    "editables": [
+
+    ]
+  };
+
+  dom.createElement("div");
+  dom.setAttribute("class", "bar");
+  dom.appendTextNode("\n  ");
+  dom.appendComment(" BEGIN HEADER ");
+  dom.appendTextNode("\n  ");
+  dom.createElement("div");
+  dom.setAttribute("class", "header");
+  dom.setAttribute("style", "line-height: 2");
+  dom.setAttribute("data-rick", "");
+  dom.appendTextNode("\n    ");
+  dom.createElement("h2");
+  dom.appendTextNode("Foo");
+  descriptor.editables.push({
+    type: "plaintext",
+    name: "plaintext0",
+    element: dom.getElement(),
+    options: {
+    }
+  });
+  dom.appendElement();
+  dom.appendTextNode("\n    ");
+  dom.createElement("div");
+  descriptor.editables.push({
+    type: "html",
+    name: "html0",
+    element: dom.getElement(),
+    options: {
+    }
+  });
+  dom.appendElement();
+  dom.appendTextNode("\n  ");
+  dom.appendElement();
+  dom.appendTextNode("\n  ");
+  dom.appendComment(" END HEADER ");
+  dom.appendTextNode("\n  ");
+  dom.createElement("hr");
+  dom.appendElement();
+  dom.appendTextNode("\n  ");
+  dom.createElement("div");
+  dom.setAttribute("style", "font-size: 11pt");
+  descriptor.editables.push({
+    type: "html",
+    name: "html1",
+    element: dom.getElement(),
+    options: {
+    }
+  });
+  dom.appendElement();
+  dom.appendTextNode("\n");
+
+  descriptor.element = dom.getElement();
+
+  return descriptor;
+}