riml 0.3.6 → 0.3.7

data/Rakefile

@@ -1,3 +1,7 @@
+if RUBY_VERSION < '1.9'
+  require 'rubygems'
+end
+
 require File.expand_path('../lib/riml/environment', __FILE__)
 require 'rake/testtask'
 require 'bundler/setup'

data/bin/riml

@@ -20,6 +20,7 @@ module Riml
       options.check_syntax_files = []
       options.repl = false
       options.vi_readline = false
+      options.debug = false
       options.allow_undefined_global_classes = DEFAULT_PARSE_OPTIONS[:allow_undefined_global_classes]
       options.include_reordering = DEFAULT_PARSE_OPTIONS[:include_reordering]
       options.readable = DEFAULT_COMPILE_OPTIONS[:readable]
@@ -82,6 +83,10 @@ module Riml
           options.vi_readline = options.repl =  true
         end
 
+        opts.on("-D", "--debug", "Run in debug mode. Full stacktraces are shown on error.") do
+          options.debug = true
+        end
+
         opts.on_tail("-v", "--version", "Show riml version.") do
           puts VERSION.join('.')
           exit
@@ -130,11 +135,12 @@ module Riml
         compile_files_options = compile_options.merge(
           :output_dir => options.output_dir
         )
+        Riml.debug = options.debug
         if options.stdio
           puts Riml.compile($stdin.read, compile_options)
         elsif options.compile_files.any?
           FileRollback.trap(:INT, :QUIT, :KILL) { print("\n"); exit 1 }
-          Riml.compile_files(*options.compile_files, compile_files_options)
+          Riml.compile_files(*(options.compile_files + [compile_files_options]))
         elsif options.check_syntax_files.any?
           files = options.check_syntax_files.uniq
           Riml.check_syntax_files(*files)
@@ -153,6 +159,10 @@ module Riml
   begin
     Runner.start
   rescue RimlError => e
-    abort e.message
+    if Riml.debug
+      raise
+    else
+      abort e.verbose_message
+    end
   end
 end

data/lib/riml.rb

@@ -1,9 +1,13 @@
 require 'pathname'
 require 'fileutils'
 
+if RUBY_VERSION < '1.9'
+  require 'thread'
+end
+
 require File.expand_path('../riml/environment', __FILE__)
-require 'riml/nodes'
 require 'riml/lexer'
+require 'riml/nodes'
 require 'riml/parser'
 require 'riml/compiler'
 require 'riml/warning_buffer'
@@ -43,8 +47,8 @@ module Riml
   end
 
   def self.compile(input, options = {})
-    parse_options = options.select(&EXTRACT_PARSE_OPTIONS)
-    compile_options = options.select(&EXTRACT_COMPILE_OPTIONS)
+    parse_options = Hash[options.select(&EXTRACT_PARSE_OPTIONS)]
+    compile_options = Hash[options.select(&EXTRACT_COMPILE_OPTIONS)]
     parser = Parser.new
     parser.options = DEFAULT_PARSE_OPTIONS.merge(parse_options)
     compiler = Compiler.new
@@ -98,8 +102,8 @@ module Riml
     # options
     if filenames.last.is_a?(Hash)
       options = filenames.pop
-      compile_options = options.select(&EXTRACT_COMPILE_FILES_OPTIONS)
-      parse_options = options.select(&EXTRACT_PARSE_OPTIONS)
+      compile_options = Hash[options.select(&EXTRACT_COMPILE_FILES_OPTIONS)]
+      parse_options = Hash[options.select(&EXTRACT_PARSE_OPTIONS)]
       compiler.options = DEFAULT_COMPILE_FILES_OPTIONS.merge(compile_options)
       parser.options = DEFAULT_PARSE_OPTIONS.merge(parse_options)
     else
@@ -195,6 +199,7 @@ module Riml
     @include_cache.clear
     @path_cache.clear
     @rewritten_ast_cache.clear
+    Parser.ast_cache.clear
   end
 
   # if error is thrown, all files that were created will be rolled back
@@ -205,11 +210,11 @@ module Riml
     FileRollback.guard(&block)
   end
 
-  # turn warnings on/off
   class << self
-    attr_accessor :warnings
+    attr_accessor :warnings, :debug
   end
   self.warnings = true
+  self.debug = false
 
   private
 
@@ -232,7 +237,7 @@ module Riml
     return instance_variable_set("@#{name}", nil) if path.nil?
     path = path.split(':') if path.is_a?(String)
     path.each do |dir|
-      unless Dir.exists?(dir)
+      unless File.directory?(dir)
         raise UserArgumentError, "Error trying to set #{name.to_s}. " \
           "Directory #{dir.inspect} doesn't exist"
       end
@@ -283,7 +288,7 @@ module Riml
     else
       # absolute path for filename sent from cmdline or from riml_sourced files,
       # output to that same directory if no --output-dir option is set
-      if fname[0] == File::SEPARATOR && !compiler.output_dir
+      if fname[0, 1] == File::SEPARATOR && !compiler.output_dir
         Pathname.new(fname).parent.to_s
       # relative path
       else
@@ -304,4 +309,5 @@ module Riml
     end
   end
 
-end
+# ruby-1.8.7 guard condition
+end unless defined?(Riml) && defined?(Riml::DEFAULT_COMPILE_OPTIONS)

data/lib/riml/ast_rewriter.rb

@@ -9,7 +9,7 @@ module Riml
     include Riml::Constants
 
     attr_accessor :ast, :options
-    attr_reader :classes, :rewritten_included_and_sourced_files
+    attr_reader :classes
 
     def initialize(ast = nil, classes = nil, class_dependency_graph = nil)
       @ast = ast
@@ -31,16 +31,15 @@ module Riml
 
     def rewrite(filename = nil, included = false)
       if filename && (rewritten_ast = Riml.rewritten_ast_cache[filename])
-        rewrite_included_and_sourced_files!(filename)
         return rewritten_ast
       end
+
       establish_parents(ast)
       if @options && @options[:allow_undefined_global_classes] && !@classes.has_global_import?
         @classes.globbed_imports.unshift(ImportedClass.new('*'))
-      else
-        class_imports = RegisterImportedClasses.new(ast, classes)
-        class_imports.rewrite_on_match
       end
+      class_imports = RegisterImportedClasses.new(ast, classes)
+      class_imports.rewrite_on_match
       if resolve_class_dependencies?
         resolve_class_dependencies!(filename)
         return if @resolving_class_dependencies == true
@@ -67,6 +66,25 @@ module Riml
       ast
     end
 
+    def establish_parents(node)
+      Walker.walk_node(node, method(:do_establish_parents))
+    end
+    alias reestablish_parents establish_parents
+
+    def do_establish_parents(node)
+      node.children.each do |child|
+        child.parent_node = node if child.respond_to?(:parent_node=)
+      end if node.respond_to?(:children)
+    end
+
+    def rewrite_on_match(node = ast)
+      Walker.walk_node(node, method(:do_rewrite_on_match), max_recursion_lvl)
+    end
+
+    def do_rewrite_on_match(node)
+      replace node if match?(node)
+    end
+
     def resolve_class_dependencies?
       @resolving_class_dependencies = false if @options[:include_reordering] != true
       @resolving_class_dependencies != false
@@ -85,9 +103,11 @@ module Riml
           if filename && @included_and_sourced_file_refs[file].include?(filename)
             msg = "#{filename.inspect} can't include #{file.inspect}, as " \
                   " #{file.inspect} already included #{filename.inspect}"
-            raise IncludeFileLoop, msg
+            error = IncludeFileLoop.new(msg, node)
+            raise error
           elsif filename == file
-            raise UserArgumentError, "#{file.inspect} can't include itself"
+            error = UserArgumentError.new("#{file.inspect} can't include itself", node)
+            raise error
           end
           @included_and_sourced_file_refs[filename] << file
           riml_src = File.read(fullpath)
@@ -167,7 +187,7 @@ module Riml
 
       def class_name_full_name(class_name)
         return nil if class_name.nil?
-        if class_name[1] == ':'
+        if class_name[1..1] == ':'
           class_name
         else
           ClassDefinitionNode::DEFAULT_SCOPE_MODIFIER + class_name
@@ -175,25 +195,6 @@ module Riml
       end
     end
 
-    def establish_parents(node)
-      Walker.walk_node(node, method(:do_establish_parents))
-    end
-    alias reestablish_parents establish_parents
-
-    def do_establish_parents(node)
-      node.children.each do |child|
-        child.parent_node = node if child.respond_to?(:parent_node=)
-      end if node.respond_to?(:children)
-    end
-
-    def rewrite_on_match(node = ast)
-      Walker.walk_node(node, method(:do_rewrite_on_match), max_recursion_lvl)
-    end
-
-    def do_rewrite_on_match(node)
-      replace node if match?(node)
-    end
-
     # We need to rewrite the included/sourced files before anything else. This is in
     # order to keep track of any classes defined in the included and sourced files (and
     # files included/sourced in those, etc...). We keep a cache of rewritten asts
@@ -210,9 +211,11 @@ module Riml
             msg = "#{filename.inspect} can't #{action} #{file.inspect}, as " \
                   " #{file.inspect} already included/sourced #{filename.inspect}"
             # IncludeFileLoop/SourceFileLoop
-            raise Riml.const_get("#{action.capitalize}FileLoop"), msg
+            error = Riml.const_get("#{action.capitalize}FileLoop").new(msg, node)
+            raise error
           elsif filename == file
-            raise UserArgumentError, "#{file.inspect} can't #{action} itself"
+            error = UserArgumentError.new("#{file.inspect} can't #{action} itself", node)
+            raise error
           end
           @included_and_sourced_file_refs[filename] << file
           # recursively parse included files with this ast_rewriter in order
@@ -697,9 +700,9 @@ module Riml
                         ]
                       ),
                       StringNode.new("_s:#{def_node.name}", :s)
-                    ],
+                    ]
                   )
-                ],
+                ]
               )
             )
           constructor.expressions << extension
@@ -779,9 +782,10 @@ module Riml
 
         def replace(constructor)
           unless class_node.superclass?
-            # TODO: raise error instead of aborting
-            abort "class #{class_node.full_name.inspect} called super in its " \
+            error_msg "class #{class_node.full_name.inspect} called super in its " \
               " initialize function, but it has no superclass."
+            error = InvalidSuper.new(error_msg, constructor)
+            raise error
           end
 
           superclass = classes.superclass(class_node.full_name)
@@ -841,10 +845,11 @@ module Riml
           end
           superclass_function = superclass.find_function(func_scope, superclass_func_name(superclass))
           if superclass.nil? || !superclass_function
-            raise Riml::UserFunctionNotFoundError,
-              "super was called in class #{ast.full_name} in " \
+            error_msg = "super was called in class #{ast.full_name} in " \
               "function #{@function_node.original_name}, but there are no " \
               "functions with this name in that class's superclass hierarchy."
+            error = Riml::InvalidSuper.new(error_msg, node)
+            raise error
           end
           node_args = if node.arguments.empty? && !node.with_parens && superclass_function.splat
             [SplatNode.new('*a:000')]
@@ -910,9 +915,9 @@ module Riml
                       ]
                     ),
                     StringNode.new("_s:#{super_func_name}", :s)
-                  ],
+                  ]
                 )
-              ],
+              ]
             )
           )
           ast.constructor.expressions << assign_node
@@ -964,7 +969,9 @@ module Riml
 
         while param = def_node.parameters[param_idx += 1]
           unless param == def_node.splat || DefaultParamNode === param
-            raise UserArgumentError, "can't have regular parameter after default parameter in function #{def_node.name.inspect}"
+            error_msg = "can't have regular parameter after default parameter in function #{def_node.name.inspect}"
+            error = UserArgumentError.new(error_msg, def_node)
+            raise error
           end
         end
 
@@ -1043,5 +1050,5 @@ module Riml
       end
     end
 
-  end
+  end unless defined?(Riml::AST_Rewriter)
 end

data/lib/riml/backtrace_filter.rb

@@ -20,7 +20,7 @@ module Riml
         raise ArgumentError, "first index must come before (or be equal to) last index"
       end
 
-      unless $DEBUG
+      unless Riml.debug
         add_to_head = @error.backtrace[0...first_i] || []
         add_to_tail = @error.backtrace[last_i...-1] || []
         backtrace = @error.backtrace[first_i..last_i] || []

data/lib/riml/compiler.rb

@@ -31,7 +31,7 @@ module Riml
 
       def visit(node)
         output = compile(node)
-        output << "\n" if node.force_newline and output[-1] != "\n"
+        output << "\n" if node.force_newline and output[-1, 1] != "\n"
         propagate_up_tree(node, output)
       end
 
@@ -44,7 +44,8 @@ module Riml
       def visitor_for_node(node, params={})
         Compiler.const_get("#{node.class.name.split('::').last}Visitor").new(params)
       rescue NameError
-        raise CompileError, "unexpected construct at #{node.location_info}"
+        error = CompileError.new('unexpected construct', node)
+        raise error
       end
 
       def root_node(node)
@@ -78,7 +79,7 @@ module Riml
             node.compiled_output << node.indent + line
           end
         end
-        node.compiled_output << "\n" unless node.compiled_output[-1] == "\n"
+        node.compiled_output << "\n" unless node.compiled_output[-1..-1] == "\n"
         node.compiled_output << "endif\n"
       end
     end
@@ -169,20 +170,21 @@ module Riml
         when String
           StringNode === node ? string_surround(node) : node.value
         when Array
-          node.value.each {|n| n.parent_node = node}
-          '[' <<
-          node.value.map do |n|
-            n.accept(visitor_for_node(n))
-            n.compiled_output
-          end.join(', ') << ']'
-        when Hash
-          node.value.each {|k_n, v_n| k_n.parent_node, v_n.parent_node = node, node}
-          '{' <<
-          node.value.map do |k,v|
-            k.accept(visitor_for_node(k))
-            v.accept(visitor_for_node(v))
-            k.compiled_output << ': ' << v.compiled_output
-          end.join(', ') << '}'
+          if ListNode === node
+            node.value.each {|n| n.parent_node = node}
+            '[' <<
+            node.value.map do |n|
+              n.accept(visitor_for_node(n))
+              n.compiled_output
+            end.join(', ') << ']'
+          elsif DictionaryNode === node
+            '{' <<
+            node.value.map do |(k, v)|
+              k.accept(visitor_for_node(k))
+              v.accept(visitor_for_node(v))
+              k.compiled_output << ': ' << v.compiled_output
+            end.join(', ') << '}'
+          end
         end.to_s
 
         node.compiled_output = value
@@ -607,7 +609,8 @@ module Riml
           # riml_include has to be top-level
           unless node.parent == root_node(node)
             error_msg = %Q(riml_include error, has to be called at top-level)
-            raise IncludeNotTopLevel, error_msg
+            error = IncludeNotTopLevel.new(error_msg, node)
+            raise error
           end
           node.each_existing_file! do |basename, full_path|
             output = current_compiler(node).compile_include(basename, full_path)

data/lib/riml/constants.rb

@@ -51,8 +51,12 @@ module Riml
     ].flatten
 
     # For when showing source location (file:lineno) during error
-    # and no file was given
+    # and no file was given, only a string to compile.
+    # Ex: # Riml.compile(source_code) would raise an error like
+    # '<String>:14 riml_include must be top-level'
     COMPILED_STRING_LOCATION = '<String>'
+    # For when there is no location info associated with a node
+    UNKNOWN_LOCATION_INFO = '<unknown>'
 
     # :help function-list
     BUILTIN_FUNCTIONS =

data/lib/riml/errors.rb

@@ -1,19 +1,64 @@
+require File.expand_path('../constants', __FILE__)
+
 module Riml
-  RimlError = Class.new(StandardError) do
+  class RimlError < StandardError
     attr_accessor :node
+    def initialize(msg = nil, node = nil)
+      super(msg)
+      @node = node
+    end
+
+    def verbose_message
+      "#{self.class}\n" <<
+      "location: #{location_info}\n" <<
+      "message: #{message.to_s.sub(/\A\n/, '')}"
+    end
+
+    def location_info
+      if @node
+        @node.location_info
+      else
+        Constants::UNKNOWN_LOCATION_INFO
+      end
+    end
+  end
+
+  module ErrorWithoutNodeAvailable
+    attr_accessor :filename, :lineno
+    def initialize(msg = nil, filename = nil, lineno = nil)
+      super(msg, nil)
+      @filename = filename
+      @lineno = lineno
+    end
+
+    def location_info
+      if @filename || @lineno
+        "#{@filename}:#{@lineno}"
+      else
+        Constants::UNKNOWN_LOCATION_INFO
+      end
+    end
+  end
+
+  class SyntaxError < RimlError
+    include ErrorWithoutNodeAvailable
+  end
+  class ParseError < RimlError
+    include ErrorWithoutNodeAvailable
   end
 
-  SyntaxError  = Class.new(RimlError)
-  ParseError   = Class.new(RimlError)
   CompileError = Class.new(RimlError)
 
   FileNotFound = Class.new(RimlError)
   IncludeFileLoop = Class.new(RimlError)
   SourceFileLoop = Class.new(RimlError)
   IncludeNotTopLevel = Class.new(RimlError)
+
   # bad user arguments to Riml functions
   UserArgumentError = Class.new(RimlError)
-  UserFunctionNotFoundError = Class.new(RimlError)
+
+  # super is called in invalid context
+  InvalidSuper = Class.new(RimlError)
 
   ClassNotFound = Class.new(RimlError)
   ClassRedefinitionError = Class.new(RimlError)