opulent 1.5.5 → 1.6.0

data/lib/opulent/compiler/root.rb

@@ -6,13 +6,12 @@ module Opulent
     #
     # @param current [Array] Current node data with options
     # @param indent [Fixnum] Indentation size for current node
-    # @param context [Context] Context holding environment variables
     #
-    def root(current, indent, context)
+    def root(current, indent)
       if KEYWORDS.include? current[@type]
-        send :"#{current[@type]}_node", current, indent, context
-      else 
-        send current[@type], current, indent, context
+        send :"#{current[@type]}_node", current, indent
+      else
+        send current[@type], current, indent
       end
     end
   end

data/lib/opulent/compiler/text.rb

@@ -6,11 +6,13 @@ module Opulent
     #
     # @param node [Array] Node code generation data
     # @param indent [Fixnum] Size of the indentation to be added
-    # @param context [Context] Processing environment data
     #
-    def plain(node, indent, context)
+    def plain(node, indent)
       value = node[@options][:value]
 
+      # Leading whitespace
+      buffer_freeze ' ' if node[@options][:leading_whitespace]
+
       # Evaluate text node if it's marked as such and print nodes in the
       # current context
       if node[@value] == :text
@@ -18,6 +20,9 @@ module Opulent
       else
         node[@options][:escaped] ? buffer_escape(value) : buffer(value)
       end
+
+      # Trailing whitespace
+      buffer_freeze ' ' if node[@options][:trailing_whitespace]
     end
   end
 end

data/lib/opulent/compiler/yield.rb

@@ -6,10 +6,9 @@ module Opulent
     #
     # @param node [Array] Node code generation data
     # @param indent [Fixnum] Size of the indentation to be added
-    # @param context [Context] Processing environment data
     #
-    def yield_node(node, indent, context)
-      buffer_eval "yield if block_given?"
+    def yield_node(node, indent)
+      buffer_eval 'yield if block_given?'
     end
   end
 end

data/lib/opulent/engine.rb

@@ -21,36 +21,23 @@ module Opulent
     # @param overwrite [Boolean] Write changes directly to the parent binding
     #
     def initialize(input, settings = {})
-      # Set def from other Opulent instances
-      @def = settings.delete(:def) || {}
-
       # Update default settings with user settings
-      Settings.update_settings settings unless settings.empty?
+      @settings = Settings.new
+      @settings.update_settings settings unless settings.empty?
 
       # 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.
       @code = read input
 
+      # Pass filename into settings for Parser and Compiler
+      @settings[:file] = @file
+
       # Get the nodes tree
-      @nodes, @def = Parser.new(@file, @def).parse @code
+      @nodes, @def = Parser.new(@settings).parse @code
 
       # Compile our syntax tree using input context
-      @template = Compiler.new.compile @nodes
-    end
-
-    # Read input as file or string input
-    #
-    # @param input [Object]
-    #
-    def read(input)
-      if input.is_a? Symbol
-        @file = File.expand_path get_eval_file input
-        File.read @file
-      else
-        @file = File.expand_path __FILE__
-        input
-      end
+      @template = Compiler.new(@settings).compile @nodes, @def
     end
 
     # Avoid code duplication when layouting is set. When we have a layout, look
@@ -96,6 +83,20 @@ module Opulent
 
     private
 
+    # Read input as file or string input
+    #
+    # @param input [Object]
+    #
+    def read(input)
+      if input.is_a? Symbol
+        @file = File.expand_path get_eval_file input
+        File.read @file
+      else
+        @file = File.expand_path __FILE__
+        input
+      end
+    end
+
     # Add .op extension to input file if it isn't already set.
     #
     # @param input [Symbol] Input file

data/lib/opulent/exec.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'yaml'
 require 'opulent/version'
+require 'opulent/logger'
 
 # @Opulent
 module Opulent
@@ -13,10 +14,6 @@ module Opulent
     def initialize(arguments)
       i = 0
 
-      layout_error = 'Missing input or incorrect file extension for ' \
-        'layout [-l] argument. '
-      layout_error += "Found #{arguments[i + 1]} instead." if arguments[i + 1]
-
       while arguments[i]
         case arguments[i]
 
@@ -33,20 +30,19 @@ module Opulent
           if arguments[i + 1] =~ EXTENSION
             @layout = arguments[(i += 1)]
           else
-            error layout_error
+            Logger.error :exec, arguments[i + 1], :layout_error
           end
 
         # opulent -v
         when '-v', 'version'
-          write "Version #{Opulent::VERSION} is currently installed."
+          Logger.log :version
           return
 
         # opulent -c
         when '-c', 'context', '-lc', 'locals'
           @locals_file = arguments[(i += 1)]
           unless File.file? @locals_file
-            error "Given context file #{@locals_file.inspect} does not exist" \
-            ' or an incorrect path has been specified.'
+            Logger.error :exec, @locals_file, :locals_file
           end
 
           if File.extname(@locals_file) == '.json'
@@ -54,16 +50,15 @@ module Opulent
           elsif File.extname(@locals_file) == '.yml'
             @locals = YAML.load_file @locals_file
           else
-            error "Unknown file extension #{@locals_file.inspect} given as" \
-            ' locals file. Please use JSON or YAML as input.'
+            Logger.error :exec, @locals_file, :locals_file_format
           end
 
         # opulent -h
         when '-h', 'help'
-          write help
+          Logger.log :help
           return
         else
-          error "Unknown input argument [#{arguments[i]}] has been encountered."
+          Logger.error :exec, arguments[i], :input_arguments
         end
 
         i += 1
@@ -72,72 +67,35 @@ module Opulent
       if @input
         @locals ||= {}
 
-        unless File.file? @input
-          error "Given input file #{@input.inspect} does not exist or " \
-          'an incorrect path has been specified.'
-        end
+        Logger.error :exec, @input, :input unless File.file? @input
+
+        opulent_layout = Opulent.new @layout
+        opulent_page = Opulent.new @input
+        scope = Object.new
 
-        message = ''
-        opulent = Opulent.new
         if @layout
           output = proc do
-            opulent.render_file(@layout, @locals) {
-              opulent.render_file(@input, @locals) {}
-            }
+            opulent_layout.render scope, @locals do
+              opulent_page.render scope, @locals do
+              end
+            end
           end[]
         else
           output = proc do
-            opulent.render_file(@input, @locals)
+            opulent_page.render scope, @locals do
+            end
           end[]
         end
 
         if @output
           File.open(@output, 'w') { |file| file.write output }
-          message += "Successfully rendered #{@input.inspect} " \
-          "to #{@output.inspect}."
+          Logger.log :successful_render, @input, @output
         else
-          message += "Successfully rendered #{@input.inspect}.\n\n"
-          message += 'No output file specified. Writing result to ' \
-          "terminal.\n\n#{output}"
+          Logger.log :successful_render_print, @input, output
         end
-
-        write message
       else
-        error "You haven't specified an input file."
+        Logger.error :exec, :no_input
       end
     end
-
-    def help(_extra = '')
-      <<-HELP #{_extra} You can use the following commands with the Opulent
-       Command  Line Interface: \n\n
-opulent input.op output.op      Render an input file and write the result to
-the output file.\n
-opulent layout [-l] layout.op   Render an input file using given input
-layout file.\n
-opulent help [-h]               Show available command line options.\n
-opulent version [-v]            Show installed version.\n"
-      HELP
-    end
-
-    # Give an explicit response for the given input arguments
-    #
-    # @param message [String] Response message to display to the user
-    #
-    def write(message)
-      # Reconstruct lines to display where errors occur
-      puts "\nOpulent " + Logger.green('[Engine]') +
-        "\n---\n#{message}\n\n\n"
-    end
-
-    # Give an explicit error report where an unexpected sequence of tokens
-    # appears and give indications on how to solve it
-    #
-    # @param message [String] Error message to display to the user
-    #
-    def error(message)
-      # Reconstruct lines to display where errors occur
-      fail "\nOpulent " + Logger.red('[Engine]') +
-        "\n---\n#{message}\n\n#{help}\n\n\n"
-    end
   end
 end

data/lib/opulent/logger.rb

@@ -55,17 +55,244 @@ module Opulent
       # Require windows libraries for ANSI Console output
       #
       def require_windows_libs
+        return unless RUBY_PLATFORM =~ /win32/
+
         begin
-          require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /win32/
+          require 'Win32/Console/ANSI'
         rescue LoadError
           raise 'You must run "gem install win32console" to use Opulent\'s
                 error reporting on Windows.'
         end
       end
 
-      # Pretty print Nodes with their important details
+
+      # Output an error message based on class context and input data
+      #
+      # @param message [Symbol] Message to be displayed
+      # @param data [Array] Data to be displayed with the message
+      #
+      def log(message, *data)
+        case error
+        when :version
+          title = 'Version'
+          message = <<-LOG
+Version #{Opulent::VERSION} is currently installed.
+          LOG
+        when :successful_render
+          title = 'Render Complete'
+          message = <<-LOG
+Successfully rendered #{data[0].inspect} to #{data[1].inspect}.
+          LOG
+        when :successful_render_print
+          title = 'Render Complete'
+          message = <<-LOG
+Successfully rendered #{data[0].inspect}.
+
+No output file specified. Writing result to terminal.
+
+#{data[1]}"
+
+          LOG
+        when :help
+          title = 'Help'
+          message = <<-LOG
+You can use the following commands with the Opulent Command  Line Interface:
+
+opulent input.op output.op      Render an input file and write the result to
+                                the output file.
+opulent layout [-l] layout.op   Render an input file using given input
+                                layout file.
+opulent help [-h]               Show available command line options.
+opulent version [-v]            Show installed version.
+          LOG
+        end
+
+        puts <<-OPULENT_LOG
+\n
+[Opulent Engine] #{title}
+
+#{message}
+
+        OPULENT_LOG
+      end
+
+      # Display an error message based on context
+      #
+      def error(type, *data)
+        case type
+        when :parse
+          parse_error data[0], data[1], data[2], data[3], data[4..-1]
+        when :compile
+          compile_error data[0], data[1], data[2..-1]
+        when :exec
+          exec_error data[0], data[1..-1]
+        end
+      end
+
+      # Output an error message based on class context and input data
+      #
+      # @param klass [Symbol] Class in which the error happens
+      # @param error [Symbol] Error identification symbol
+      # @param data [Array] Data to be displayed with the error
+      #
+      def exec_error(error, *data)
+        case error
+        when :input
+          message = <<-ERROR
+Given input file #{data[0].inspect} does not exist or an incorrect path
+has been specified.
+          ERROR
+        when :layout_error
+          message = <<-ERROR
+Missing input or incorrect file extension for layout [-l] argument.
+Found #{data[0]} instead.
+          ERROR
+        when :locals_file
+          message = <<-ERROR
+Given context file #{data[0].inspect} does not exist or
+an incorrect path has been specified.
+          ERROR
+        when :locals_file_format
+          message = <<-ERROR
+Unknown file extension #{data[0].inspect} given as locals file. Please use
+JSON or YAML as input.
+          ERROR
+        when :input_arguments
+          message = <<-ERROR
+Unknown input argument [#{data[0]}] has been encountered.
+          ERROR
+        when :no_input
+          message = <<-ERROR
+You haven't specified an input file.
+          ERROR
+        end
+
+        fail <<-OPULENT_ERROR
+\n
+[Opulent Engine] Runtime Error
+
+#{message}
+
+        OPULENT_ERROR
+      end
+
+      # Output an error message based on class context and input data
+      #
+      # @param klass [Symbol] Class in which the error happens
+      # @param error [Symbol] Error identification symbol
+      # @param data [Array] Data to be displayed with the error
+      #
+      def compile_error(template, error, *data)
+        case error
+        when :explicit_end
+          message = <<-ERROR
+Explicit "end" evaluation nodes are not allowed. End expressions are
+inserted automatically.
+          ERROR
+        end
+
+        fail <<-OPULENT_ERROR
+\n
+[Opulent Compiler] Runtime Error
+
+#{message}
+
+        OPULENT_ERROR
+      end
+
+      # Output an error message based on class context and input data
+      #
+      # @param klass [Symbol] Class in which the error happens
+      # @param error [Symbol] Error identification symbol
+      # @param data [Array] Data to be displayed with the error
       #
-      def pretty_print(_model, _indent = 0)
+      def parse_error(code, line, character, error, *data)
+        line += 1
+
+        case error
+        when :unknown_node_type
+          message = <<-ERROR
+An unknown node type has been encountered.
+          ERROR
+        when :expected
+          if [:'(', :'{', :'[', :'<'].include? data[0]
+            data[0] = "#{Tokens.bracket data[0]}"
+          end
+          message = <<-ERROR
+Expected to find a :#{data[0]} token on line #{line} of input.
+          ERROR
+        when :root
+          message = <<-ERROR
+Unknown node type encountered on line #{line} of input.
+          ERROR
+        when :assignments_colon
+          message = <<-ERROR
+Unexpected end of element attributes reached on line #{line}
+of input.
+          ERROR
+        when :assignments_comma
+          message = <<-ERROR
+Unexpected end of element attributes reached on line #{line}
+of input. Expected to find an attribute value.
+          ERROR
+        when :expression
+          message = <<-ERROR
+Unexpected end of expression reached on line #{line} of input.
+Expected to find another expression term.
+          ERROR
+        when :control_child
+          message = <<-ERROR
+Unexpected control structure child found on line #{line} of input.
+Expected to find a parent #{data[0]} structure.
+          ERROR
+        when :whitespace_expression
+          message = <<-ERROR
+Unexpected end of expression reached on line #{line} of input.
+Please use paranthesis for method parameters
+          ERROR
+        when :definition
+          message = <<-ERROR
+Unexpected start of definition on line #{line} of input.
+Found a definition inside another definition or element.
+          ERROR
+        when :self_enclosing
+          message = <<-ERROR
+Unexpected content found after self enclosing node on line
+#{line} of input.
+          ERROR
+        when :self_enclosing_children
+          message = <<-ERROR
+Unexpected child elements found for self enclosing node on line
+#{data[0] + 1} of input.
+          ERROR
+        when :include
+          message = <<-ERROR
+The included file #{data[0]} does not exist or an incorrect path
+has been specified.
+          ERROR
+        when :include_dir
+          message = <<-ERROR
+The included file path #{data[0]} is a directory.
+          ERROR
+        when :include_end
+          message = <<-ERROR
+Missing argument for include on line #{line} of input.
+          ERROR
+        else
+          message = <<-ERROR
+Unexpected syntax error on line #{line} of input.
+          ERROR
+        end
+
+        fail <<-OPULENT_ERROR
+\n
+[Opulent Parser] Runtime Error
+
+#{message}
+#{code[line - 1].chomp}
+#{' ' * character}^
+
+        OPULENT_ERROR
       end
     end
   end