emerald-lang 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b98b2000688c656f6b8d50dc7ca337140c0ce108
+  data.tar.gz: 56ed522869ab837b945e2859bdfbeedef6f5d1c9
+SHA512:
+  metadata.gz: 4f86668e7bdcf4cb162b4b199fb0bd8881e11c675e014df62cbb119f06f25a963a024b8683fa0f8a064fb6ec6f3fa630c43098299fbf9e5768a6ac6e0e021c28
+  data.tar.gz: a11b96888f15fb9017427ecffef1a232cce785ad066c7e2c11faf42ce280d23a59d4c4e07c30edce6d2728c51e84f1c765c311d066125ab75b1e7d029ca29729

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+bin/pre-commit

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,17 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 30
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in emerald.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andrew McBurney, Dave Pagurek, Yu Chen Hu
+
+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,18 @@
+<img src='emerald-logo.png' alt='Drawing' width='600px' />
+- A language agnostic templating engine designed with event driven applications in mind.
+
+# Usage
+```
+bin/emerald process some_html_file --beautify
+```
+
+# Setup
+```
+bundle install
+bundle exec rake setup
+```
+
+# Running tests
+```
+bundle exec rake test
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'pre-commit'
+
+RSpec::Core::RakeTask.new(:test)
+
+task :setup do
+  sh 'pre-commit install'
+  sh 'git config pre-commit.checks "[rubocop]"'
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "emerald"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/emerald

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'emerald'
+
+Emerald::CLI.start(ARGV)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,13 @@
+machine:
+  ruby:
+    version:
+      2.3.2
+
+dependencies:
+  override:
+    - bundle install:
+        timeout: 240
+  
+test:
+  override:
+    - bundle exec rake test

data/config/pre_commit.yml

@@ -0,0 +1,5 @@
+---
+:checks_add:
+- :rubocop
+:checks_remove:
+- :rails

data/emerald.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'emerald/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'emerald-lang'
+  spec.version       = Emerald::VERSION
+  spec.authors       = ['Andrew McBurney', 'Dave Pagurek', 'Yu Chen Hu']
+  spec.email         = ['andrewrobertmcburney@gmail.com', 'davepagurek@gmail.com', 'me@yuchenhou.com']
+
+  spec.summary       = 'A language agnostic templating engine designed with event driven applications in mind.'
+  spec.description   = 'A language agnostic templating engine designed with event driven applications in mind.' # TODO: make better description
+  spec.homepage      = 'https://github.com/emerald-lang/emerald' # TODO: replace with website once created
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['emerald']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pre-commit'
+
+  spec.add_runtime_dependency 'htmlentities'
+  spec.add_runtime_dependency 'treetop'
+  spec.add_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'htmlbeautifier', '~> 1.1', '>= 1.1.1'
+end

data/lib/emerald.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Emerald, the language agnostic templating engine.
+# Copyright 2016, Emerald Language (MIT)
+#
+require 'emerald/version'
+
+require 'json'
+require 'thor'
+require 'htmlbeautifier'
+
+require_relative 'emerald/grammar'
+require_relative 'emerald/preprocessor'
+
+# Parses a context free grammar from the preprocessed emerald and generates
+# html associated with corresponding abstract syntax tree.
+module Emerald
+  # The Emerald CLI
+  class CLI < Thor
+    class_option :beautify, :type => :boolean, :aliases => 'b'
+
+    def self.exit_on_failure?
+      true
+    end
+
+    # Main emerald option, processes the emerald file, generates an abstract
+    # syntax tree based on the output from the preprocessing.
+    desc 'process', 'Process a file or folder (recursively) and converts it to emerald.'
+    option :output, aliases: 'o'
+    def process(file_name, context_file_name = nil)
+      begin
+        output_name = options[:output] || file_name
+        context =
+          if context_file_name
+            JSON.parse(IO.read(context_file_name))
+          else
+            {}
+          end
+
+        input = IO.read(file_name)
+
+        Emerald.write_html(
+          Emerald.convert(input, context),
+          output_name,
+          options['beautify']
+        )
+      rescue Grammar::PreProcessorError, Grammar::ParserError => e
+        raise Thor::Error, e.message
+      end
+    end
+  end
+
+  def self.convert(input, context = {})
+    preprocessed_emerald, source_map = PreProcessor.new.process_emerald(input)
+    abstract_syntax_tree = Grammar.parse_grammar(
+      preprocessed_emerald,
+      input,
+      source_map
+    )
+
+    return abstract_syntax_tree.to_html(context)
+  end
+
+  # Write html to file and beautify it if the beautify global option is set to
+  # true.
+  def self.write_html(html_output, file_name, beautify)
+    File.open(file_name + '.html', 'w') do |emerald_file|
+      html_output = HtmlBeautifier.beautify(html_output) if beautify
+      emerald_file.write(html_output)
+    end
+    puts "Wrote #{file_name + '.html'}"
+  end
+end

data/lib/emerald/grammar.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'polyglot'
+require 'treetop'
+
+# Require all treetop nodes for grammar
+Dir[File.dirname(__FILE__) + '/nodes/*.rb'].each { |f| require f }
+
+Treetop.load __dir__ + '/grammar/tokens'
+Treetop.load __dir__ + '/grammar/variables'
+Treetop.load __dir__ + '/grammar/scopes'
+Treetop.load __dir__ + '/grammar/emerald'
+
+#
+# Interface which interacts with emerald context free grammar. Parses the
+# preprocessed Emerald and prints out success if the parser was successful and
+# failure if there was an error when parsing. Returns an abstract syntax tree.
+#
+module Grammar
+  # When the parser fails on a line from user input
+  class ParserError < StandardError
+    LINES_BEFORE = 3
+    LINES_AFTER = 1
+
+    def initialize(line_number, reason, source)
+      @line_number = line_number
+      @reason = reason
+      @source = source
+    end
+
+    def message
+      messages = []
+      if match = @reason.match(/(Expected .+?) at line/)
+        messages << match[1]
+      else
+        messages << @reason
+      end
+
+      lines = @source.split(/\n/)
+      LINES_BEFORE.downto(1).each do |i|
+        messages << '    ' + lines[@line_number - i - 1] if lines[@line_number - i - 1]
+      end
+      messages << '>>> ' + lines[@line_number - 1]
+      1.upto(LINES_AFTER).each do |i|
+        messages << '    ' + lines[@line_number + i - 1] if lines[@line_number + i - 1]
+      end
+
+      messages.join("\n")
+    end
+  end
+
+  # When the parser fails on a line added only in preprocessing
+  class PreProcessorError < ParserError
+    def say
+      messages = []
+      messages << "Error parsing in pre-processed Emerald. This is likely a bug."
+      messages << @reason
+      messages.concat(@source.lines.with_index { |line, i| puts "#{i + 1} #{line}" })
+
+      messages.join("\n")
+    end
+  end
+
+  @parser = EmeraldParser.new
+
+  # Parse the preprocessed emerald text and print failure if it fails the
+  # parsing stage
+  def self.parse_grammar(text, original, source_map)
+    parsed = @parser.parse(text)
+
+    if parsed.nil?
+      source_line = source_map[@parser.failure_line][:source_line]
+      if source_line.nil?
+        raise PreProcessorError.new(
+          @parser.failure_line,
+          @parser.failure_reason,
+          text
+        )
+      end
+      raise ParserError.new(
+        source_line,
+        @parser.failure_reason,
+        original
+      )
+    end
+
+    parsed
+  end
+end

data/lib/emerald/grammar/emerald.tt

@@ -0,0 +1,93 @@
+#
+# Context free grammar for the Emerald language.
+# Emerald: a preprocessor for html5.
+#
+grammar Emerald
+  include Tokens
+  include Scopes
+  include Variables
+
+  rule main
+    (scope / pair_list / value_list / nested / line / comment)+ <Root>
+  end
+
+  rule nested
+    tag_statement newline lbrace newline main rbrace newline <Nested>
+  end
+
+  rule scope
+    fn:scope_fn lbrace newline body:main rbrace newline <Scope>
+  end
+
+  rule line
+    (tag_statement / comment) newline <Line>
+  end
+
+  rule value_list
+    keyword:special_keyword newline lbrace newline
+    list_items:(literal:inline_literal_string newline)+
+    rbrace newline <ValueList>
+  end
+
+  rule pair_list
+    keyword:base_keyword newline lbrace newline
+    list_items:(pairs:(attr:attr space+ literal:inline_literal_string space*)+ newline)+
+    rbrace newline <PairList>
+  end
+
+  rule comment
+    space* '*' space* text_content <Comment>
+  end
+
+  rule text_content
+    multiline_literal / multiline_templateless_literal / inline_literal
+  end
+
+  rule multiline_literal
+    "->" space* newline
+    body:(variable / escaped / !'$' .)*
+    "$" <TextLiteral>
+  end
+
+  rule multiline_templateless_literal
+    ("=>" / "~>") space* newline
+    body:(escaped / !'$' .)*
+    "$" <TextLiteral>
+  end
+
+  rule inline_literal
+    body:( variable / escaped / !lparen !newline . )* <TextLiteral>
+  end
+
+  rule inline_literal_string
+    '"' body:( variable / escaped / !'"' . )* '"' <TextLiteral>
+  end
+
+  rule escaped
+    "\\" .
+  end
+
+  rule tag_statement
+    tag identifier:id_name? classes:class_name* space* body:text_content? attributes:attr_list? <TagStatement>
+  end
+
+  rule id_name
+    '#' name:([a-zA-Z_\-]+)
+  end
+
+  rule class_name
+    '.' name:([a-zA-Z_\-]+)
+  end
+
+  rule attr_list
+    lparen newline lbrace newline attributes rbrace newline rparen <AttributeList>
+  end
+
+  rule attributes
+    attribute* <Attributes>
+  end
+
+  rule attribute
+    attr space* inline_literal_string newline
+  end
+end