opulent 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d6fdf705335f29c2162e3b2868398f4015ba29c
-  data.tar.gz: be920ffc6c6349e76d76ef802425146e5ed734e8
+  metadata.gz: a41bc661663219aac5c2cbdbc6def8eedbe6abeb
+  data.tar.gz: 68d65112e22329817b60acdf1aa6aad48ad68653
 SHA512:
-  metadata.gz: 5ff789a689f140eccd4f853322bef8bec37747e52187a62d8c87a59d799944732451d419cd534fd7fc06ab216a55ac48db0a027db98200b86ce912d85c89ad3f
-  data.tar.gz: bfcb9e0566c3081bb99f2fe9f30ec697b7f78d35af9924e0fe0fd2835e04176007a62e90a072da4dc0361b23c902213d679d33cc24d486f085155176db67c21a
+  metadata.gz: fd1a7efd68cd841e5085ffc2b14f5158f8e8a4a4b0ca07ace88f400857797fc0cd7ba695822b33ad1638c884cf93c8816a70f2dd15021356c88e2d83db2f9446
+  data.tar.gz: 07249aab1bf67424862905d9f643b4dd1f80a95c4d59423bb61b9c09ee925d87ca91da6f5f54f80cf0edfc7c054254cbc35b1ede2fc888f2c321e003de1546d5

data/lib/opulent/compiler.rb

@@ -5,6 +5,7 @@ require_relative 'compiler/define.rb'
 require_relative 'compiler/eval.rb'
 require_relative 'compiler/filter.rb'
 require_relative 'compiler/node.rb'
+require_relative 'compiler/require.rb'
 require_relative 'compiler/root.rb'
 require_relative 'compiler/text.rb'
 
@@ -19,7 +20,9 @@ module Opulent
     #
     # [:node_type, :value, :attributes, :children, :indent]
     #
-    def initialize
+    # @param path [String] Current file path needed for require nodes
+    #
+    def initialize(settings = {})
       # Setup convention accessors
       @type = 0
       @value = 1
@@ -27,6 +30,12 @@ module Opulent
       @children = 3
       @indent = 4
 
+      # Set current compiled file
+      @path = File.dirname settings.delete :path
+
+      # Extract definitions for require directives
+      @definitions = settings.delete :definitions
+
       # Create the HTML Entities encoder/decoder
       @entities = HTMLEntities.new
 
@@ -52,7 +61,7 @@ module Opulent
 
     # Compile input nodes, replace them with their definitions and
     #
-    # @param root [Array] Root node containing all document nodes
+    # @param root_node [Array] Root node containing all document nodes
     # @param context [Context] Context holding environment variables
     #
     def compile(root_node, context)
@@ -121,6 +130,8 @@ module Opulent
         "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]}"
+      when :require
+        "The required file #{data[0]} does not exist or an incorrect path has been specified."
       end
 
       # Reconstruct lines to display where errors occur

data/lib/opulent/compiler/require.rb

@@ -0,0 +1,24 @@
+# @Opulent
+module Opulent
+  # @Compiler
+  class Compiler
+    # Compile a new Opulent file using the current page context data
+    #
+    # @param node [Array] Node code generation data
+    # @param indent [Fixnum] Size of the indentation to be added
+    # @param context [Context] Processing environment data
+    #
+    def require_node(node, indent, context)
+      require_file = File.expand_path context.evaluate(node[@value]), @path
+      error :require, node[@value] unless File.file? require_file
+
+      data = {
+        definitions: @definitions,
+        overwrite: true
+      }
+      rendered = Engine.new(data).render_file require_file, &context.block
+
+      @code += indent_lines rendered, " " * indent
+    end
+  end
+end

data/lib/opulent/context.rb

@@ -7,7 +7,7 @@ module Opulent
   # has its own context
   #
   class Context
-    attr_accessor :binding, :name, :parent
+    attr_accessor :block, :binding, :name, :parent
 
     # Create a context from the environment binding, extended with the locals
     # given as arguments
@@ -15,10 +15,10 @@ module Opulent
     # @param locals [Hash] Binding extension
     # @param bind [Binding] Call environment binding
     #
-    def initialize(locals = {}, &block)
+    def initialize(locals = {}, override = false, &block)
       @block = block || Proc.new
       @binding = if @block
-        @block.binding.clone
+        override ? @block.binding : @block.binding.clone
       else
         Binding.new
       end

data/lib/opulent/engine.rb

@@ -2,7 +2,7 @@
 module Opulent
   # Module method wrapper for creating a new engine instance
   #
-  def Opulent.new(settings = nil)
+  def Opulent.new(settings = {})
     return Engine.new settings
   end
 
@@ -10,9 +10,17 @@ module Opulent
   class Engine
     attr_reader :nodes, :preamble, :buffer
 
-    def initialize(settings = nil)
-      # Update render settings
-      Settings.update_settings settings if settings
+    # Update render settings
+    #
+    # @param settings [Hash] Opulent settings override
+    # @param definitions [Hash] Definitions from previously parsed files
+    # @param overwrite [Boolean] Write changes directly to the parent binding
+    #
+    def initialize(settings = {})
+      @definitions = settings.delete(:definitions) || {}
+      @overwrite = settings.delete :overwrite
+
+      Settings.update_settings settings unless settings.empty?
     end
 
     # Analyze the input code and check for matching tokens. In case no match was
@@ -23,8 +31,9 @@ module Opulent
     # @param block [Proc] Processing environment data
     #
     def render_file(file, locals = {}, &block)
-      # Render the file
-      render File.read(file), locals, &block
+      @mode = :file
+
+      render file, locals, &block
     end
 
     # Analyze the input code and check for matching tokens. In case no match was
@@ -34,19 +43,22 @@ module Opulent
     # @param locals [Hash] Render call local variables
     # @param block [Proc] Processing environment data
     #
-    def render(code, locals = {}, &block)
+    def render(input, locals = {}, &block)
+      # Get input code
+      @code = read input
+
       # Get the nodes tree
-      @nodes = Parser.new.parse code
+      @nodes, @definitions = Parser.new(@definitions).parse @code
 
       # @TODO
       # Implement precompiled template handling
       @preamble = @nodes.inspect.inspect
 
       # Create a new context based on our rendering environment
-      @context = Context.new locals, &block
+      @context = Context.new locals, @overwrite, &block
 
       # Compile our syntax tree using input context
-      @output = Compiler.new.compile @nodes, @context
+      @output = Compiler.new({path: @file, definitions: @definitions}).compile @nodes, @context
 
       # puts "Nodes\n---\n"
       # pp @nodes
@@ -56,5 +68,21 @@ module Opulent
 
       return @output
     end
+
+    # Read input parameter based on opening mode. If we have a file mode, we
+    # get its path and read the code. We need to reset the mode in case the next
+    # render call is on code, not on a file.
+    #
+    # @param input [String] Input file or code
+    #
+    def read(input)
+      if @mode == :file
+        @file = File.expand_path input; @mode = nil
+        return File.read @file
+      else
+        @file = File.expand_path __FILE__
+        return input
+      end
+    end
   end
 end

data/lib/opulent/parser.rb

@@ -6,6 +6,7 @@ require_relative 'parser/eval.rb'
 require_relative 'parser/expression.rb'
 require_relative 'parser/filter.rb'
 require_relative 'parser/node.rb'
+require_relative 'parser/require.rb'
 require_relative 'parser/root.rb'
 require_relative 'parser/text.rb'
 
@@ -13,19 +14,23 @@ require_relative 'parser/text.rb'
 module Opulent
   # @Parser
   class Parser
-    attr_reader :type, :value, :options, :children, :indent
+    attr_reader :type, :value, :options, :children, :indent, :definitions
 
     # All node Objects (Array) must follow the next convention in order
     # to make parsing faster
     #
     # [:node_type, :value, :attributes, :children, :indent]
     #
-    def initialize
+    def initialize(definitions = {})
+      # Convention accessors
       @type = 0
       @value = 1
       @options = 2
       @children = 3
       @indent = 4
+
+      # Node definitions encountered up to the current point
+      @definitions = definitions
     end
 
     # Initialize the parsing process by splitting the code into lines and
@@ -39,17 +44,15 @@ module Opulent
       # Split the code into lines and parse them one by one
       @code = code.lines
 
-      # Node definitions encountered up to the current point
-      @definitions = {}
-
       # Current line index
       @i = -1
 
       # Initialize root node
       @root = [:root, nil, {}, [], -1]
 
-      # Get all nodes starting from the root element
-      root @root
+      # Get all nodes starting from the root element and return output
+      # nodes and definitions
+      [root(@root), @definitions]
     end
 
     # Check and accept or reject a given token as long as we have tokens

data/lib/opulent/parser/require.rb

@@ -0,0 +1,29 @@
+# @Opulent
+module Opulent
+  # @Parser
+  class Parser
+    # Check if we match a new node definition to use within our page.
+    #
+    # Definitions will not be recursive because, by the time we parse
+    # the definition children, the definition itself is not in the
+    # knowledgebase yet.
+    #
+    # However, we may use previously defined nodes inside new definitions,
+    # due to the fact that they are known at parse time.
+    #
+    # @param nodes [Array] Parent node to which we append to
+    #
+    def require_file(parent, indent)
+      if(match = accept :require)
+        # Process data
+        name = accept(:exp_string, :*)
+
+        # Create node
+        require_node = [:require, name, {}, [], indent]
+
+        # Add to parent
+        parent[@children] << require_node
+      end
+    end
+  end
+end

data/lib/opulent/parser/root.rb

@@ -36,7 +36,8 @@ module Opulent
                         evaluate(parent, indent)    ||
                         filter(parent, indent)      ||
                         block_yield(parent, indent) ||
-                        block(parent, indent)
+                        block(parent, indent)       ||
+                        require_file(parent, indent)
 
         # Throw an error if we couldn't find a valid node
         error :unknown_node_type unless current_node

data/lib/opulent/tokens.rb

@@ -1,6 +1,6 @@
 module Opulent
   # Opulent Keywords
-  Keywords = %i(def block yield if else elsif unless case when each while until)
+  Keywords = %i(def block yield require if else elsif unless case when each while until)
 
   # @Tokens
   class Tokens
@@ -29,6 +29,9 @@ module Opulent
       # Definition
       def: /\Adef +/,
 
+      # Require file
+      require: /\Arequire +/,
+
       # Node Attributes
       attributes_bracket: /\A\(\[\{/,
       extend_attributes: /\A(\+)/,

data/lib/opulent/version.rb

@@ -1,4 +1,4 @@
 # @Opulent
 module Opulent
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opulent
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Alex Grozav
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,6 +147,7 @@ files:
 - lib/opulent/compiler/eval.rb
 - lib/opulent/compiler/filter.rb
 - lib/opulent/compiler/node.rb
+- lib/opulent/compiler/require.rb
 - lib/opulent/compiler/root.rb
 - lib/opulent/compiler/text.rb
 - lib/opulent/context.rb
@@ -162,6 +163,7 @@ files:
 - lib/opulent/parser/expression.rb
 - lib/opulent/parser/filter.rb
 - lib/opulent/parser/node.rb
+- lib/opulent/parser/require.rb
 - lib/opulent/parser/root.rb
 - lib/opulent/parser/text.rb
 - lib/opulent/settings.rb