melbourne 1.0.0 → 1.0.1

data/HISTORY.md

@@ -0,0 +1,9 @@
+1.0.1
+-----
+ 
+* fixed the `require` statements
+
+1.0.0
+-----
+ 
+* initial release

data/README.md

@@ -0,0 +1,43 @@
+Melbourne
+=========
+
+Melbourne is [Rubinius](http://rubini.us)' parser component. The +melbourne+ gem extracts
+this parser component for stand-alone use under MRI and other environments.
+
+For Melbourne's full RDoc, see [rdoc.info](http://rdoc.info/projects/simplabs/melbourne).
+
+Usage
+-----
+
+Melbourne generates abstract syntax trees (ASTs) from Ruby source code:
+
+    require 'melbourne'
+
+    'class Test; end'.to_ast # => <AST::Class:0x1017800f8
+                                    @line=1,
+                                    @body=#<AST::EmptyBody:0x101780058 @line=1>,
+                                    @name=#<AST::ClassName:0x101780080 @line=1, @superclass=#<AST::Nil:0x1017800a8 @line=1>, @name=:Test>,
+                                    @superclass=#<AST::Nil:0x1017800a8 @line=1>>
+
+Abstract Syntax Trees
+---------------------
+
+Abstract syntax trees allow for deep introspection of Ruby source code and are far
+easier to handle than e.g. S-expressions as provided by [ParseTree](http://parsetree.rubyforge.org/)
+and other gems.
+
+For more information on abstract syntax trees, see [Wikipedia](http://en.wikipedia.org/wiki/Abstract_syntax_trees).
+
+Authors
+-------
+
+The original code of Melbourne is part of the [Rubinius project](http://rubini.us/) and
+was written by and is &copy; [Evan Phoenix](http://github.com/evanphx/).
+
+Melbourne was extracted from Rubinius into this gem by [Marco Otte-Witte](http://simplabs.com).
+
+Bugs/ Feature Requests
+----------------------
+
+the +melbourne+ gem is <b>not</b> maintained by the [Rubinius](http://rubini.us) team! If you encounter
+bugs or have feature requests, refer to the [Github repository](http://simplabs.github.com/melbourne).

data/Rakefile

@@ -1,6 +1,12 @@
-require 'rake'
-require 'rake/rdoctask'
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup
+Bundler.require
+
 require 'spec/rake/spectask'
+require 'simplabs/excellent/rake'
+require 'rake/extensiontask'
 
 desc 'Default: run specs.'
 task :default => :spec
@@ -17,22 +23,19 @@ Spec::Rake::SpecTask.new(:spec) do |t|
 end
 
 desc 'Generate documentation for the Melbourne gem.'
-Rake::RDocTask.new(:rdoc) do |t|
-  t.rdoc_dir = 'doc'
-  t.title    = 'Melbourne'
-  t.options << '--line-numbers' << '--inline-source'
-  t.rdoc_files.include('README.rdoc')
-  t.rdoc_files.include('lib/**/*.rb')
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files   = ['lib/**/*.rb', '-', 'HISTORY.md']
+  t.options = ['--no-private', '--title', 'Melbourne Documentation']
 end
 
-begin
-  require 'simplabs/excellent/rake'
+desc 'compile the C extension'
+Rake::ExtensionTask.new('melbourne') do |ext|
+  ext.lib_dir = File.join('lib', 'ext')
+end
+Rake::Task[:spec].prerequisites << :compile
 
-  desc 'Analyse the Melbourne source with Excellent.'
-  Simplabs::Excellent::Rake::ExcellentTask.new(:excellent) do |t|
-    t.html  = 'doc/excellent.html'
-    t.paths = ['lib']
-  end
-rescue LoadError
-  puts "Install the excellent gem for source code analysis."
+desc 'Analyse the Melbourne source with Excellent.'
+Simplabs::Excellent::Rake::ExcellentTask.new(:excellent) do |t|
+  t.html  = 'doc/excellent.html'
+  t.paths = ['lib']
 end

data/lib/melbourne.rb

@@ -1,24 +1,22 @@
-base = File.dirname(__FILE__)
+require 'ext/melbourne'
+require 'melbourne/parser'
+require 'melbourne/processor'
 
-require File.join(base, 'ext/melbourne')
-require File.join(base, 'melbourne/parser')
-require File.join(base, 'melbourne/processor')
-
-module Melbourne #:nodoc:
+module Melbourne
 end
 
 class String
 
   # Creates an AST for a +String+ containing Ruby source code.
   #
-  # === Example
-  #
-  #   'class Test; end'.to_ast # => <AST::Class:0x1017800f8...
+  # @param [String] name+
+  #   the name of the source (this is usuall the name of the file the code was read from); defaults to +(eval)+
+  # @param [Fixnum] line
+  #   the starting line (if it's not 1 for some reason); defaults to +1+
   #
-  # === Arguments
+  # @example Converting Ruby code in a string to an AST
   #
-  # * +name+: the name of the source (this is usuall the name of the file the code was read from); defaults to <tt>(eval)</tt>
-  # * +line+: the starting line (if it's not 1 for some reason); defaults to <tt>1</tt>
+  #   'class Test; end'.to_ast # => <AST::Class:0x1017800f8...
   #
   def to_ast(name = '(eval)', line = 1)
     Melbourne::Parser.parse_string(self, name, line)
@@ -30,14 +28,14 @@ class File
 
   # Creates an AST for Ruby source code read from a file.
   #
-  # === Example
+  # @param [String] name
+  #   the name of the file to read the source code from.
+  # @param [Fixnum] line
+  #   the starting line (if it's not 1 for some reason); defaults to +1+
   #
-  #   File.to_ast('user.rb') # => <AST::Class:0x1017800f8...
-  #
-  # === Arguments
+  # @example Converting Ruby code from a file to an AST
   #
-  # * +name+: the name of the file to read the source code from.
-  # * +line+: the starting line (if it's not 1 for some reason); defaults to <tt>1</tt>
+  #   File.to_ast('user.rb') # => <AST::Class:0x1017800f8...
   #
   def self.to_ast(name, line = 1)
     Melbourne::Parser.parse_file(name, line)

data/lib/melbourne/ast.rb

@@ -1,22 +1,20 @@
-base = File.dirname(__FILE__)
-
 module Melbourne
 
-  module AST #:nodoc:
+  module AST
   end
 
 end
 
-require File.join(base, 'ast/node')
-require File.join(base, 'ast/self')
-require File.join(base, 'ast/constants')
-require File.join(base, 'ast/control_flow')
-require File.join(base, 'ast/definitions')
-require File.join(base, 'ast/exceptions')
-require File.join(base, 'ast/file')
-require File.join(base, 'ast/grapher')
-require File.join(base, 'ast/literals')
-require File.join(base, 'ast/operators')
-require File.join(base, 'ast/sends')
-require File.join(base, 'ast/values')
-require File.join(base, 'ast/variables')
+require 'melbourne/ast/node'
+require 'melbourne/ast/self'
+require 'melbourne/ast/constants'
+require 'melbourne/ast/control_flow'
+require 'melbourne/ast/definitions'
+require 'melbourne/ast/exceptions'
+require 'melbourne/ast/file'
+require 'melbourne/ast/grapher'
+require 'melbourne/ast/literals'
+require 'melbourne/ast/operators'
+require 'melbourne/ast/sends'
+require 'melbourne/ast/values'
+require 'melbourne/ast/variables'

data/lib/melbourne/ast/constants.rb

@@ -16,7 +16,7 @@ module Melbourne
       #
       attr_accessor :name
 
-      def initialize(line, parent, name) #:nodoc:
+      def initialize(line, parent, name)
         @line = line
         @parent = parent
         @name = name
@@ -38,7 +38,7 @@ module Melbourne
       #
       attr_accessor :name
 
-      def initialize(line, name) #:nodoc:
+      def initialize(line, name)
         @line = line
         @name = name
         @parent = TopLevel.new line
@@ -66,7 +66,7 @@ module Melbourne
       #
       attr_accessor :name
 
-      def initialize(line, name) #:nodoc:
+      def initialize(line, name)
         @line = line
         @name = name
       end
@@ -91,7 +91,7 @@ module Melbourne
       #
       attr_accessor :name
 
-      def initialize(line, name, value) #:nodoc:
+      def initialize(line, name, value)
         @line = line
         @value = value
         @parent = nil
@@ -116,7 +116,7 @@ module Melbourne
       #
       attr_accessor :name
 
-      def initialize(line, name) #:nodoc:
+      def initialize(line, name)
         @line = line
         @name = name
       end

data/lib/melbourne/ast/control_flow.rb

@@ -21,7 +21,7 @@ module Melbourne
       #
       attr_accessor :else
 
-      def initialize(line, whens, else_body) #:nodoc:
+      def initialize(line, whens, else_body)
         @line = line
         @whens = whens
         @else = else_body || Nil.new(line)
@@ -44,7 +44,7 @@ module Melbourne
       #
       attr_accessor :receiver
 
-      def initialize(line, receiver, whens, else_body) #:nodoc:
+      def initialize(line, receiver, whens, else_body)
         @line = line
         @receiver = receiver
         @whens = whens
@@ -76,11 +76,11 @@ module Melbourne
       #
       attr_accessor :single
 
-      # Any splat (<tt>*something</tt>) that is specified as a condition for the +when+ statement or +nil+ of no splat is specified
+      # Any splat (+*something+) that is specified as a condition for the +when+ statement or +nil+ of no splat is specified
       #
       attr_accessor :splat
 
-      def initialize(line, conditions, body) #:nodoc:
+      def initialize(line, conditions, body)
         @line = line
         @body = body || Nil.new(line)
         @splat = nil
@@ -110,7 +110,7 @@ module Melbourne
 
     end
 
-    # A splat (<tt>*something</tt>) inside a condition of a +when+ statement as in:
+    # A splat (+*something+) inside a condition of a +when+ statement as in:
     #
     #   case a
     #     when *c then
@@ -123,7 +123,7 @@ module Melbourne
       #
       attr_accessor :condition
 
-      def initialize(line, condition) #:nodoc:
+      def initialize(line, condition)
         @line = line
         @condition = condition
       end
@@ -136,7 +136,7 @@ module Melbourne
     #
     class Flip2 < Node
 
-      def initialize(line, start, finish) #:nodoc:
+      def initialize(line, start, finish)
         @line = line
         @start = start
         @finish = finish
@@ -150,7 +150,7 @@ module Melbourne
     #
     class Flip3 < Node
 
-      def initialize(line, start, finish) #:nodoc:
+      def initialize(line, start, finish)
         @line = line
         @start = start
         @finish = finish
@@ -176,7 +176,7 @@ module Melbourne
       #
       attr_accessor :else
 
-      def initialize(line, condition, body, else_body) #:nodoc:
+      def initialize(line, condition, body, else_body)
         @line = line
         @condition = condition
         @body = body || Nil.new(line)
@@ -203,7 +203,7 @@ module Melbourne
       #
       attr_accessor :check_first
 
-      def initialize(line, condition, body, check_first) #:nodoc:
+      def initialize(line, condition, body, check_first)
         @line = line
         @condition = condition
         @body = body || Nil.new(line)
@@ -230,7 +230,7 @@ module Melbourne
       #
       attr_accessor :pattern
 
-      def initialize(line, pattern, flags) #:nodoc:
+      def initialize(line, pattern, flags)
         @line = line
         @pattern = RegexLiteral.new line, pattern, flags
       end
@@ -251,7 +251,7 @@ module Melbourne
       #
       attr_accessor :value
 
-      def initialize(line, pattern, value) #:nodoc:
+      def initialize(line, pattern, value)
         @line = line
         @pattern = pattern
         @value = value
@@ -273,7 +273,7 @@ module Melbourne
       #
       attr_accessor :value
 
-      def initialize(line, pattern, value) #:nodoc:
+      def initialize(line, pattern, value)
         @line = line
         @pattern = pattern
         @value = value
@@ -297,7 +297,7 @@ module Melbourne
       #
       attr_accessor :value
 
-      def initialize(line, expr) #:nodoc:
+      def initialize(line, expr)
         @line = line
         @value = expr || Nil.new(line)
       end
@@ -313,7 +313,7 @@ module Melbourne
     #
     class Next < Break
 
-      def initialize(line, value) #:nodoc:
+      def initialize(line, value)
         @line = line
         @value = value
       end
@@ -332,7 +332,7 @@ module Melbourne
     #
     class Redo < Break
 
-      def initialize(line) #:nodoc:
+      def initialize(line)
         @line = line
       end
 
@@ -351,7 +351,7 @@ module Melbourne
     #
     class Retry < Break
 
-      def initialize(line) #:nodoc:
+      def initialize(line)
         @line = line
       end
 
@@ -369,7 +369,7 @@ module Melbourne
       #
       attr_accessor :value
 
-      def initialize(line, expr) #:nodoc:
+      def initialize(line, expr)
         @line = line
         @value = expr
         @splat = nil

data/lib/melbourne/ast/data.rb

@@ -3,7 +3,7 @@ module Melbourne
   module AST
 
     # TODO: document!
-    class EndData < Node #:nodoc:
+    class EndData < Node
 
       attr_accessor :data