bob-compiler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61eb15e3c30c2bc86d29a782bdb6252ad1bde448
+  data.tar.gz: 2bac9022339fd3d22528a49f5211243304b7de1f
+SHA512:
+  metadata.gz: d5eaaa22cfbd87d1b0c2c4a606cbeb18d0b08af6e9f984c3092d68aa6f45f0dc7431ca2d1c86eabeb370cff220f78ac45fab4902e1a6c6889d9fd4ea59c58543
+  data.tar.gz: ba8f418b9f47e9e8096866b145508a22914cef9a8fe8b9900ce71e63597a42c8c8c84a492c92bfa568944ea28d21a1efdfe60784afc4c62785161fa4702c80ff

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+*.tmp
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bob-compiler.gemspec
+gemspec
+
+gem 'activesupport', "~> 3.2.0"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    bob-compiler (0.0.1)
+      activesupport (>= 3.2.0)
+      nokogiri (~> 1.6.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.21)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    coderay (1.1.0)
+    i18n (0.6.11)
+    method_source (0.8.2)
+    mini_portile (0.6.1)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.2.0)
+  bob-compiler!
+  bundler (~> 1.7)
+  minitest (~> 5.4.0)
+  pry (~> 0.10.1)
+  rake (~> 10.0)

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Brewhouse
+
+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 limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,8 @@
+Bob Compiler
+============
+
+The [Bob][bob] builder requires a [JavaScript template](bob-js) to function. In order to simplify the workflow, a designer could simply create and annotate templates with [Bob-flavored HTML](bob-html) and let the Bob compiler generate the corresponding JavaScript template.
+
+[bob]: https://github.com/BrewhouseTeam/bob
+[bob-js]: https://some/where/
+[bob-html]: https://some/where/

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: ["test"]
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/*_test.rb"
+end

data/bob-compiler.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bob/compiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bob-compiler"
+  spec.version       = Bob::Compiler::VERSION
+  spec.authors       = ["Godfrey Chan", "Gabe Scholz"]
+  spec.email         = ["godfreykfc@gmail.com", "gabe@brewhouse.io"]
+  spec.summary       = "A compiler for Bob templates"
+  spec.homepage      = "https://github.com/BrewhouseTeam/bob-compiler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", "~> 1.6.4"
+  spec.add_dependency "activesupport", ">= 3.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4.0"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+end

data/lib/bob/compiler.rb

@@ -0,0 +1,8 @@
+require "active_support"
+require "bob/compiler/version"
+require "bob/compiler/template"
+
+module Bob
+  module Compiler
+  end
+end

data/lib/bob/compiler/base.rb

@@ -0,0 +1,132 @@
+require 'active_support/core_ext/object/blank'
+require 'bob/compiler/message'
+require 'bob/compiler/buffer'
+require 'json'
+
+module Bob
+  module Compiler
+    class Base
+      def initialize
+        @buffer = Buffer.new
+        @warnings = []
+        @errors = []
+        @compiled = false
+      end
+
+      def warnings
+        ensure_compiled { @warnings }
+      end
+
+      def errors
+        ensure_compiled { @errors }
+      end
+
+      def warnings?
+        ensure_compiled { @warnings.present? }
+      end
+
+      def well_formed?
+        ensure_compiled { valid? && @warnings.blank? }
+      end
+
+      def errors?
+        ensure_compiled { @errors.present? }
+      end
+
+      def valid?
+        ensure_compiled { @errors.blank? }
+      end
+
+      def result
+        ensure_compiled { @buffer.string }
+      end
+
+      alias_method :to_s, :result
+
+      protected
+        def buffer
+          ensure_compiled { @buffer }
+        end
+
+      private
+        def ensure_compiled
+          compile! unless compiled?
+          yield
+        end
+
+        def compiled?
+          @compiled
+        end
+
+        def compile!
+          @compiled = true
+          compile
+        end
+
+        def compile
+        end
+
+        def warn(message, node = nil)
+          @warnings << Message.new(message, node)
+        end
+
+        def error(message, node = nil)
+          @errors << Message.new(message, node)
+        end
+
+        def identifier_from_attribute(node, attribute, required = true)
+          sanitize = nil
+
+          if node.has_attribute?(attribute)
+            identifier = node[attribute]
+            sanitized  = identifier && sanitize_identifier(identifier)
+
+            if required && identifier.blank?
+              error "Required attribute `#{attribute}` cannot be blank", node
+            elsif required && sanitized.blank?
+              error "Attribute `#{attribute}` does not contain a valid identifier", node
+            elsif sanitized != identifier
+              warn "Attribute `#{attribute}` does not contain a valid identifier, assuming you meant #{sanitized.inspect}", node
+            end
+
+          elsif required
+            error "Missing required attribute `#{attribute}`", node
+          end
+
+          sanitized
+        end
+
+        def sanitize_identifier(identifier)
+          sanitized = identifier.downcase
+
+          # Replace all disallowed characters with a hyphen
+          sanitized.gsub! /[^a-z0-9\-\/]+/, '-'
+
+          # Each part must begin with a letter
+          sanitized.gsub! /(?<=\A|\/)[^a-z]+/, ''
+
+          # Remove any trailing hyphens
+          sanitized.gsub! /-+(?=\z|\/)/, ''
+
+          # Collapse multiple hyphens into one
+          sanitized.gsub! /-+/, '-'
+
+          # Collapse multiple slashes into one
+          sanitized.gsub! /\/+/, '/'
+
+          # Remove leading or trailing slashes
+          sanitized.gsub! /\A\/|\/\z/, ''
+
+          sanitized
+        end
+
+        def quote(arg)
+          JSON.generate(arg, quirks_mode: true)
+        end
+
+        def pretty_quote(arg)
+          JSON.pretty_generate(arg, quirks_mode: true)
+        end
+    end
+  end
+end

data/lib/bob/compiler/block.rb

@@ -0,0 +1,21 @@
+require "bob/compiler/walker"
+require "bob/compiler/editable"
+
+module Bob
+  module Compiler
+    class Block < Walker
+      include Editable
+
+      attr_reader :name
+
+      private
+        def compile
+          super if @name = identifier_from_attribute(@node, "bob-block")
+        end
+
+        def descriptor
+          {type: name}.merge(super)
+        end
+    end
+  end
+end

data/lib/bob/compiler/buffer.rb

@@ -0,0 +1,79 @@
+require 'active_support/core_ext/string'
+
+module Bob
+  module Compiler
+    class Buffer
+      class SameLineProxy
+        def initialize(buffer)
+          @buffer = buffer
+        end
+
+        def <<(string)
+          @buffer.<< string, true
+          self
+        end
+      end
+
+      attr_reader :string
+      alias_method :to_s, :string
+
+      def initialize(indent_level = 0)
+        @string = ''
+        @indent_level = indent_level
+        @same_line_proxy = SameLineProxy.new(self)
+      end
+
+      def <<(string, same_line = false)
+        newline! unless first_line? || same_line
+
+        if indented?
+          string = indent(string, @indent_level)
+        end
+
+        if same_line
+          string = string.lstrip
+        end
+
+        @string << string
+
+        @same_line_proxy
+      end
+
+      def merge(buffer)
+        buffer.string.each_line.with_index do |line, i|
+          self.<<(line.chomp, i == 0)
+        end
+
+        @same_line_proxy
+      end
+
+      def newline!
+        @string << "\n"
+      end
+
+      alias_method :blankline!, :newline!
+
+      def indented(increment = 2)
+        indent_level_was = @indent_level
+        @indent_level += increment
+        yield
+      ensure
+        @indent_level = indent_level_was
+      end
+
+      private
+        def first_line?
+          @string.empty?
+        end
+
+        def indented?
+          @indent_level > 0
+        end
+
+        def indent(str, multiplier = 2)
+          spaces = " " * multiplier
+          str.each_line.map { |line| line.blank? ? line : "#{spaces}#{line}" }.join
+        end
+    end
+  end
+end

data/lib/bob/compiler/editable.rb

@@ -0,0 +1,86 @@
+require "json"
+require "bob/compiler/buffer"
+
+module Bob
+  module Compiler
+    module Editable
+      def initialize(*)
+        super
+        @next_editable_id = Hash.new(0)
+      end
+
+      private
+        def after_element(node, root)
+          push_editable(node) if is_editable?(node)
+          super
+        end
+
+        def is_editable?(node)
+          node.has_attribute?("bob-editable") || node.has_attribute?("bob-editable-type")
+        end
+
+        def push_editable(node)
+          type = editable_type_for(node)
+
+          if type
+            name = editable_name_for(node, type)
+
+            options = editable_options_for(node)
+
+            @buffer << "descriptor.editables.push({"
+            @buffer << "  type: #{quote type},"
+            @buffer << "  name: #{quote name},"
+            @buffer << "  element: dom.getElement(),"
+            @buffer << "  options: " << quote_options(options, node)
+            @buffer << "});"
+          end
+        end
+
+        def editable_type_for(node)
+          identifier_from_attribute(node, "bob-editable-type", false) || identifier_from_attribute(node, "bob-editable")
+        end
+
+        def editable_name_for(node, type)
+          identifier_from_attribute(node, "bob-editable-name", false) || generate_editable_name(type)
+        end
+
+        def editable_options_for(node)
+          node.attribute_nodes.each_with_object({}) do |attr, options|
+            if attr.name.start_with?("bob-option-")
+              options[ attr.name[11..-1] ] = parse_option_value( attr.value )
+            end
+          end
+        end
+
+        def generate_editable_name(type)
+          "#{type}#{generate_editable_id(type)}"
+        end
+
+        def generate_editable_id(type)
+          id = @next_editable_id[type]
+          @next_editable_id[type] += 1
+          id
+        end
+
+        def parse_option_value(value)
+          JSON.parse(value, quirks_mode: true) rescue value
+        end
+
+        def quote_options(options, node)
+          buffer = Buffer.new(2)
+
+          buffer << "{"
+
+          buffer.indented do
+            options.each do |(k, v)|
+              buffer << quote(k) << ": " << (String === v ? quote_and_substitute(v, node) : quote(v)) << ","
+            end
+          end
+
+          buffer << "}"
+
+          buffer.to_s
+        end
+    end
+  end
+end