opulent 0.0.9 → 1.0.2

data/.libold/opulent/version.rb

@@ -0,0 +1,5 @@
+module Opulent
+  # Opulent version string
+  # @api public
+  VERSION = '0.0.1'
+end

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Pixevil
+
+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,102 @@
+# Opulent
+
+Opulent is an __Intelligent Web Templating Engine__ created for extremly fast, efficient and DRY Web Development. Based on the idea of creating lightweight __Web Component__ definitions, Opulent greatly speeds up the development process of any project.
+
+## Syntax
+
+Opulent is as beautiful as it gets: no tags, indentation based, optional brackets, inline text, inline children and in page definitions.
+
+__Page Markup__
+```
+html
+  head
+    title Opulent is Awesome
+  body
+    #content
+      ul.list-inline
+        li > a href="http://opulent.io" Opulent
+        li > a href="http://github.com" GitHub
+
+    footer |
+      With Opulent, you can do anything.
+```
+
+__Web Component__
+```
+def hello(place)
+  p Hello #{place}
+
+hello place="World"
+```
+
+__Control Structures__
+```
+ul.navbar
+  if @user.logged_in?
+    li Hello #{@user.name}
+  else
+    li > a href=link_to_register Sign Up
+```
+
+__Starting to feel it?__ There's so much more you can do with Opulent.
+
+[Read the Documentation](docs/syntax.md)
+
+
+
+## Installation
+
+Install it yourself using the ruby gem:
+
+    $ gem install opulent
+
+---
+
+Or add this line to your application's Gemfile:
+
+```ruby
+gem 'opulent'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Using Opulent to render a file is as easy as including it in your application and using the render method.
+
+[Read the Documentation](docs/usage.md)
+
+```ruby
+require 'opulent'
+
+Opulent.new.render_file 'file.op'
+```
+
+<!--
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+-->
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/opulent/opulent. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+#### Under Development
+Opulent is currently in the Beta Phase. It has serious potential to becoming the next generation of Templating Engines for Ruby, therefore any contribution is more than welcome.
+
+It still has development going on the following subjects:
+
+* Template amble (preamble, cache, postamble) generation
+* More block yielding tests
+* Multiple page layouts
+* More to come
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/benchmark/benchmark.rb

@@ -0,0 +1,46 @@
+require 'benchmark'
+require_relative '../lib/opulent'
+require 'slim'
+require 'haml'
+
+# Choose the benchmark you want to run
+BENCHMARK = :node
+
+# How many times each command should be run
+N = 1000
+
+# Templating engine initialization
+puts "BENCHMARK"
+case BENCHMARK
+when :node
+  case_folder = 'cases/node/'
+  opulent = Tilt.new("#{case_folder}node.op")
+  slim = Tilt.new("#{case_folder}node.slim")
+  haml = Tilt.new("#{case_folder}node.haml")
+
+  locals = {
+    a: 3,
+    b: 4,
+    c: 5
+  }
+
+  scope = Object.new
+
+  Benchmark.bm do |x|
+    x.report("haml") do
+      N.times do
+        haml.render(scope, locals) do end
+      end
+    end
+    x.report("opulent") do
+      N.times do
+        opulent.render(scope, locals) do end
+      end
+    end
+    x.report("slim") do
+      N.times do
+        slim.render(scope, locals) do end
+      end
+    end
+  end
+end

data/benchmark/cases/node/node.haml

@@ -0,0 +1,17 @@
+%html
+  %head
+    %title Hello world
+    %meta(name="description" content="Node benchmark")
+  %body
+    %nav.navbar
+      %ul.nav.left
+        %li Home
+        %li About
+        %li Contact
+    #content
+      .container
+        .row
+          .col-md-12
+            | Hello world, this is a dummy text used for the speed benchmark in Opulent
+    %footer
+      | Copyright © Hello world!

data/benchmark/cases/node/node.op

@@ -0,0 +1,14 @@
+html
+  head
+    title
+    meta
+  body
+    nav
+      ul
+        li
+        li
+        li
+    content
+      container
+        row
+          col-md-12

data/benchmark/cases/node/node.slim

@@ -0,0 +1,19 @@
+html
+  head
+    - a = 3
+    title =a
+    meta name="description" content="Node benchmark"
+  body
+    nav.navbar
+      ul.nav.left
+        li Home
+        li About
+        li Contact
+    #content
+      .container
+        .row
+          .col-md-12
+            | Hello world, this is a dummy text used for
+              the speed benchmark in Opulent
+    footer
+      | Copyright © Hello world!

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "opulent"
+
+# 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/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/docs/syntax.md

@@ -0,0 +1,3 @@
+#Opulent Syntax
+
+@TODO

data/docs/usage.md

@@ -0,0 +1,3 @@
+# Opulent Usage
+
+@TODO

data/lib/opulent.rb

@@ -1,64 +1,11 @@
-require 'pp'
-require 'json'
-require_relative 'opulent/engine'
-require_relative 'opulent/logger'
-require_relative 'opulent/preprocessor'
-require_relative 'opulent/tokens'
-require_relative 'opulent/nodes'
-require_relative 'opulent/parser'
-require_relative 'opulent/runtime'
-
-module Opulent
-  class << self
-    # Analyze the input code and check for matching tokens. In case no match was
-    # found, throw an exception. In special cases, modify the token hash.
-    #
-    # @param file [String] The file that needs to be analyzed
-    # @param context [Hash | String] Processing environment data
-    #
-    def render(file, context = nil)
-      # Get the code from the input file
-      @code = PreProcessor.process(file)
-
-      # Accept both ruby hashes and JSON files as database environments
-      @context = Runtime.apply context
-
-      # Instantiate required language components
-      @syntax = Parser.parse code
-
-      pretty = Proc.new do |elements, indent|
-        if elements.is_a? Nodes::Text
-          puts " " * indent + "text: " + elements.value
-        else
-          elements.each do |element|
-            text = " " * indent + element.name.to_s
-            if element.respond_to? :attributes
-              text += " " + element.attributes.to_s
-            elsif element.respond_to? :value
-              text += " -> " + element.value.to_s
-            end
-            puts text
-
-            if element.is_a?(Nodes::Text) || element.is_a?(Nodes::Print) || element.is_a?(Nodes::Comment) || element.children.empty?
-            elsif [Nodes::CnditionalControl, Nodes::CaseControl].any? do |node| element.is_a? node end
-              element.children.each do |c| pretty[c, indent+2] end
-            else
-              pretty[element.children, indent + 2]
-            end
-          end
-        end
-      end
-
-      puts "Definitions\n---"
-      @syntax.themes.each do |theme, theme_value|
-        puts theme.to_s
-        theme_value.each do |key, value|
-          puts "  " + key.to_s + " " + value.attributes.to_s
-          pretty[value.children, 4]
-        end
-      end
-      puts "\n\nNodes\n---"
-      pretty[@syntax.children, 0]
-    end
-  end
-end
+require 'tilt'
+require 'htmlentities'
+require_relative 'opulent/compiler.rb'
+require_relative 'opulent/context.rb'
+require_relative 'opulent/engine.rb'
+require_relative 'opulent/filters.rb'
+require_relative 'opulent/logger.rb'
+require_relative 'opulent/parser.rb'
+require_relative 'opulent/settings.rb'
+require_relative 'opulent/template.rb'
+require_relative 'opulent/tokens.rb'

data/lib/opulent/compiler.rb

@@ -0,0 +1,132 @@
+require_relative 'compiler/block.rb'
+require_relative 'compiler/comment.rb'
+require_relative 'compiler/control.rb'
+require_relative 'compiler/define.rb'
+require_relative 'compiler/eval.rb'
+require_relative 'compiler/filter.rb'
+require_relative 'compiler/node.rb'
+require_relative 'compiler/root.rb'
+require_relative 'compiler/text.rb'
+
+# @Opulent
+module Opulent
+  # @Compiler
+  class Compiler
+    Buffer = :_buffer
+
+    # All node Objects (Array) must follow the next convention in order
+    # to make parsing faster
+    #
+    # [:node_type, :value, :attributes, :children, :indent]
+    #
+    def initialize
+      # Setup convention accessors
+      @type = 0
+      @value = 1
+      @options = 2
+      @children = 3
+      @indent = 4
+
+      # Create the HTML Entities encoder/decoder
+      @entities = HTMLEntities.new
+
+      # Get special node types from the settings
+      @multi_node = Settings::MultiNode
+      @inline_node = Settings::InlineNode
+
+      # Quick accessor for default yield constant
+      @default_yield = Settings::DefaultYield
+
+      # The node stack is needed to keep track of all the visited nodes
+      # from the current branch level
+      @node_stack = []
+
+      # The sibling stack keeps track of the sibling count from the current
+      # branch level being generated
+      @sibling_stack = []
+
+      # Whenever we enter a definition compilation, add the provided blocks to
+      # the current block stack. When exiting a definition, remove blocks.
+      @block_stack = []
+    end
+
+    # Compile input nodes, replace them with their definitions and
+    #
+    # @param root [Array] Root node containing all document nodes
+    # @param context [Context] Context holding environment variables
+    #
+    def compile(root_node, context)
+      # Compiler generated code
+      @code = ""
+      @generator = ""
+
+      # Set initial parent, from which we start generating code
+      @sibling_stack << root_node[@children].size
+
+      # Start building up the code from the root node
+      root_node[@children].each do |child|
+        root child, 0, context
+      end
+
+      return @code
+    end
+
+    # Escape a given input value using htmlentities
+    #
+    # @param value [String] String to be escaped
+    #
+    def escape(value)
+      @entities.encode value
+    end
+
+    # Remove the last newline from the current code buffer
+    #
+    def remove_trailing_newline
+      @code.chop! if @code[-1] == "\n"
+    end
+
+    # Indent all lines of the input text using give indentation
+    #
+    # @param text [String] Input text to be indented
+    # @param indent [String] Indentation string to be appended
+    #
+    def indent_lines text, indent
+      text ||= ""
+      text.lines.inject("") do |result, line|
+        result += indent + line
+      end
+    end
+
+    # Give an explicit error report where an unexpected sequence of tokens
+    # appears and give indications on how to solve it
+    #
+    # @param context [Symbol] Context name in which the error happens
+    # @param data [Array] Additional error information
+    #
+    def error(context, *data)
+      message = case context
+      when :enumerable
+        "The provided each structure iteration input \"#{data[0]}\" is not Enumerable."
+      when :binding
+        data[0] = data[0].to_s.match(/\`(.*)\'/)
+        data[0] = data[0][1] if data[0]
+        "Found an undefined local variable or method \"#{data[0]}\" at \"#{data[1]}\"."
+      when :variable_name
+        data[0] = data[0].to_s.match(/\`(.*)\'/)[1]
+        "Found an undefined local variable or method \"#{data[0]}\" in locals."
+      when :extension
+        "The extension sequence \"#{data[0]}\" is not a valid attributes extension. " +
+        "Please use a Hash to extend attributes."
+      when :filter_registered
+        "The \"#{data[0]}\" filter could not be recognized by Opulent."
+      when :filter_load
+        "The gem required for the \"#{data[0]}\" filter is not installed. You can install it by running:\n\n#{data[1]}"
+      end
+
+      # Reconstruct lines to display where errors occur
+      fail "\n\nOpulent " + Logger.red("[Runtime Error]") + "\n---\n" +
+      "A runtime error has been encountered when building the compiled node tree.\n" +
+      "#{message}\n\n\n"
+    end
+  end
+end