antlr3 1.6.0 → 1.6.3

data/lib/antlr3/tree/wizard.rb

@@ -4,7 +4,7 @@
 =begin LICENSE
 
 [The "BSD licence"]
-Copyright (c) 2009 Kyle Yetter
+Copyright (c) 2009-2010 Kyle Yetter
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/lib/antlr3/util.rb

@@ -6,10 +6,10 @@ module Util
 
 module_function
   
-  def snake_case(str)
-    str = str.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-    str.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-    str.tr!("-", "_")
+  def snake_case( str )
+    str = str.to_s.gsub( /([A-Z]+)([A-Z][a-z])/,'\1_\2' )
+    str.gsub!( /([a-z\d])([A-Z])/,'\1_\2' )
+    str.tr!( "-", "_" )
     str.downcase!
     str
   end
@@ -21,10 +21,10 @@ module_function
   end
   
   def tidy( here_doc, flow = false )
-    here_doc.gsub!(/^ *\| ?/, '')
+    here_doc.gsub!( /^ *\| ?/, '' )
     if flow
       here_doc.strip!
-      here_doc.gsub!(/\s+/, ' ')
+      here_doc.gsub!( /\s+/, ' ' )
     end
     return here_doc
   end
@@ -45,37 +45,37 @@ private
   def shared_attribute( name, *additional_members )
     attr_reader name
     
-    additional_writers = additional_members.inject('') do |src, attr|
-      src << "@#{attr} = value if @#{attr}\n"
+    additional_writers = additional_members.inject( '' ) do |src, attr|
+      src << "@#{ attr } = value if @#{ attr }\n"
     end
     
-    file, line, = caller[1].split(':', 3)
-    class_eval(<<-END, file, line.to_i)
-      def #{name}= value
-        @#{name} = value
+    file, line, = caller[ 1 ].split( ':', 3 )
+    class_eval( <<-END, file, line.to_i )
+      def #{ name }= value
+        @#{ name } = value
         
         each_delegate do |del|
-          del.#{name} = value
+          del.#{ name } = value
         end
         
-        #{additional_writers}
+        #{ additional_writers }
       end
     END
   end
   
   def abstract( name, message = nil )
-    message ||= "abstract method -- #{self.class}::#{name} has not been implemented"
-    file, line, = caller[1].split(':', 3)
-    class_eval(<<-END, file, line.to_i)
-      def #{name}( * )
-        raise TypeError, #{message.to_s.inspect}
+    message ||= "abstract method -- #{ self.class }::#{ name } has not been implemented"
+    file, line, = caller[ 1 ].split( ':', 3 )
+    class_eval( <<-END, file, line.to_i )
+      def #{ name }( * )
+        raise TypeError, #{ message.to_s.inspect }
       end
     END
   end
   
   def alias_accessor( alias_name, attr_name )
     alias_method( alias_name, attr_name )
-    alias_method( :"#{alias_name}=", :"#{attr_name}=" )
+    alias_method( :"#{ alias_name }=", :"#{ attr_name }=" )
   end
 
 end
@@ -91,8 +91,8 @@ class Integer
   #
   #   CREDIT Florian Gross
 
-  def at_least(x)
-    (self >= x) ? self : x
+  def at_least( x )
+    ( self >= x ) ? self : x
   end
 
   # Returns the greater of self or x.
@@ -102,8 +102,8 @@ class Integer
   #
   #   CREDIT Florian Gross
 
-  def at_most(x)
-    (self <= x) ? self : x
+  def at_most( x )
+    ( self <= x ) ? self : x
   end
 
   # Returns self if above the given lower bound, or
@@ -119,7 +119,7 @@ class Integer
   #
   #   CREDIT Trans
 
-  def bound(lower, upper=nil)
+  def bound( lower, upper=nil )
     return lower if self < lower
     return self unless upper
     return upper if self > upper
@@ -130,7 +130,7 @@ end
 
 
 class Range
-  def covers?(range)
+  def covers?( range )
     range.first >= first or return false
     if exclude_end?
       range.exclude_end? ? last >= range.last : last > range.last
@@ -139,17 +139,16 @@ class Range
     end
   end
   
-  def covered_by?(range)
-    range.covers?(self)
+  def covered_by?( range )
+    range.covers?( self )
   end
   
-  def overlaps?(range)
-    range.include?(first) or include?(range.first)
+  def overlaps?( range )
+    range.include?( first ) or include?( range.first )
   end
   
-  def disjoint?(range)
-    not overlaps?(range)
+  def disjoint?( range )
+    not overlaps?( range )
   end
   
 end
-

data/lib/antlr3/version.rb

@@ -11,7 +11,7 @@ module ANTLR3
   ANTLR_MINOR_VERSION = 2
   ANTLR_PATCH_VERSION = 1
   ANTLR_VERSION = [ ANTLR_MAJOR_VERSION, ANTLR_MINOR_VERSION, ANTLR_PATCH_VERSION ].freeze
-  ANTLR_VERSION_STRING = ANTLR_VERSION.join('.')
+  ANTLR_VERSION_STRING = ANTLR_VERSION.join( '.' )
   ANTLR_VERSION_STRING.chomp!( '.0' )   # versioning drops minor version at 0
   ANTLR_VERSION_STRING.freeze
   
@@ -20,8 +20,8 @@ module ANTLR3
   # 
   MAJOR_VERSION = 1
   MINOR_VERSION = 6
-  PATCH_VERSION = 0
+  PATCH_VERSION = 3
   VERSION = [ MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION ]
-  VERSION_STRING = VERSION.join('.').freeze
+  VERSION_STRING = VERSION.join( '.' ).freeze
   
 end

data/templates/Ruby.stg

@@ -1491,4 +1491,4 @@ placeAction(scope, name) ::= <<
 <endif>
 >>
 
-runtimeLibraryVersion() ::= "1.6.0"
+runtimeLibraryVersion() ::= "1.6.3"

data/test/unit/test-streams.rb

@@ -10,7 +10,7 @@ include ANTLR3
 
 class TestStringStream < Test::Unit::TestCase
   def setup
-    @stream = StringStream.new("oh\nhey!\n")
+    @stream = StringStream.new( "oh\nhey!\n" )
   end
   
   def test_size
@@ -202,6 +202,7 @@ class TestFileStream < Test::Unit::TestCase
   
   
   def test_no_encoding
+    
     path = File.join(File.dirname(__FILE__), 'sample-input/file-stream-1')
     @stream = FileStream.new(path)
     
@@ -253,23 +254,23 @@ class TestCommonTokenStream < Test::Unit::TestCase
   # vvvvvvvv tests vvvvvvvvv
   def test_init
     @source = MockSource.new
-    @stream = CommonTokenStream.new(@source)
+    @stream = CommonTokenStream.new( @source )
     @stream.position.should == 0
   end
   
   def test_rebuild
     @source1 = MockSource.new
     @source2 = MockSource.new
-    @source2.tokens << new_token(10, :channel => ANTLR3::HIDDEN) << new_token(11)
-    @stream = CommonTokenStream.new(@source1)
+    @source2.tokens << new_token( 10, :channel => ANTLR3::HIDDEN ) << new_token( 11 )
+    @stream = CommonTokenStream.new( @source1 )
     
     @stream.position.should == 0
-    @stream.tokens.should be_empty
+    @stream.tokens.length.should == 0
     
-    @stream.rebuild(@source2)
+    @stream.rebuild( @source2 )
     @stream.token_source.should == @source2
     @stream.position.should == 1
-    @stream.tokens.should have(2).things
+    @stream.tokens.should have( 2 ).things
   end
   
   def test_look_empty_source
@@ -326,7 +327,7 @@ class TestCommonTokenStream < Test::Unit::TestCase
     @source = MockSource.new
     @source.tokens << new_token(12) << new_token(13)
     @stream = CommonTokenStream.new(@source)
-    @stream.look(0).should be_nil
+    @stream.look(0).should == nil
   end
   
   def test_lb_beyond_begin
@@ -337,9 +338,9 @@ class TestCommonTokenStream < Test::Unit::TestCase
       new_token(13)
     @stream = CommonTokenStream.new(@source)
     
-    @stream.look(-1).should be_nil
+    @stream.look(-1).should == nil
     2.times { @stream.consume }
-    @stream.look(-3).should be_nil
+    @stream.look(-3).should == nil
   end
   
   def test_fill_buffer

data/test/unit/test-template.rb

@@ -12,237 +12,239 @@ SAMPLE_GROUP_FILE = File.join(
   File.dirname( __FILE__ ), 'sample-input', 'template-group'
 )
 
-describe Template do
+describe Template::Context do
+  example "creating an empty context" do
+    context = Template::Context.new
+    context.instance_variables.should be_empty
+  end
   
-  describe Template::Context do
-    example "creating an empty context" do
-      context = Template::Context.new
-      context.instance_variables.should be_empty
-    end
-    
-    example "creating a context with a variable map" do
-      context = Template::Context.new(
-        :a => 1, :b => 2
-      )
-      
-      vars = context.instance_variables.map { | i | i.to_s }
-      vars.should include( '@a' )
-      vars.should include( '@b' )
-      
-      context.instance_variable_get( '@a' ).should == 1
-      context.instance_variable_get( '@b' ).should == 2
-    end
+  example "creating a context with a variable map" do
+    context = Template::Context.new(
+      :a => 1, :b => 2
+    )
     
-    example "fetching variable values from []" do
-      context = Template::Context.new(
-        :a => 1, :b => 2
-      )
-      
-      context[ :a ].should == 1
-      context[ 'a' ].should == 1
-      context[ :b ].should == 2
-      context[ 'b' ].should == 2
-    end
+    vars = context.instance_variables.map { | i | i.to_s }
+    vars.should include( '@a' )
+    vars.should include( '@b' )
     
-    example "defining variables with []=" do
-      context = Template::Context.new( :a => 3 )
-      context[ :a ] = 1
-      context[ 'b' ] = 2
-      
-      context.instance_variable_get( '@a' ).should == 1
-      context.instance_variable_get( '@b' ).should == 2
-    end
+    context.instance_variable_get( '@a' ).should == 1
+    context.instance_variable_get( '@b' ).should == 2
+  end
+  
+  example "fetching variable values from []" do
+    context = Template::Context.new(
+      :a => 1, :b => 2
+    )
+    
+    context[ :a ].should == 1
+    context[ 'a' ].should == 1
+    context[ :b ].should == 2
+    context[ 'b' ].should == 2
+  end
+  
+  example "defining variables with []=" do
+    context = Template::Context.new( :a => 3 )
+    context[ :a ] = 1
+    context[ 'b' ] = 2
     
-    example "using method missing to assign values" do
-      context = Template::Context.new( :a => 3 )
-      context.a = 1
-      context.b = 2
-      
-      context.instance_variable_get( '@a' ).should == 1
-      context.instance_variable_get( '@b' ).should == 2
-    end
+    context.instance_variable_get( '@a' ).should == 1
+    context.instance_variable_get( '@b' ).should == 2
+  end
+  
+  example "using method missing to assign values" do
+    context = Template::Context.new( :a => 3 )
+    context.a = 1
+    context.b = 2
     
-    example "using method missing to get variable values" do
-      context = Template::Context.new( :a => 1, :b => 2)
-      
-      context.a.should == 1
-      context.b.should == 2
-    end
+    context.instance_variable_get( '@a' ).should == 1
+    context.instance_variable_get( '@b' ).should == 2
+  end
+  
+  example "using method missing to get variable values" do
+    context = Template::Context.new( :a => 1, :b => 2)
     
+    context.a.should == 1
+    context.b.should == 2
   end
   
+end
+
+
+shared_examples_for "template groups" do
+  include ANTLR3::Util
   
-  shared_examples_for "template groups" do
-    include ANTLR3::Util
-    
-    example "template definitions" do
-      templates = @group.templates
-      templates.should_not be_empty
-      templates.should equal @group::TEMPLATES
-      
-      names = templates.keys
-      
-      names.should have(3).things
-      for template_name in TEMPLATE_NAMES
-        names.should include template_name
-        template_class = templates[ template_name ]
-        template_class.should be_a_kind_of Class
-        template_class.superclass.should equal Template::Context
-        template_class.should be < @group # it should include the group module
-      end
+  example "template definitions" do
+    templates = @group.templates
+    templates.should_not be_empty
+    templates.should equal @group::TEMPLATES
+    
+    names = templates.keys
+    
+    names.should have(3).things
+    for template_name in TEMPLATE_NAMES
+      names.should include template_name
+      template_class = templates[ template_name ]
+      template_class.should be_a_kind_of Class
+      template_class.superclass.should equal Template::Context
+      template_class.should be < @group # it should include the group module
     end
-    
-    example "template_defined?( name ) should verify whether a template is defined in a group" do
-      for name in TEMPLATE_NAMES
-        @group.template_defined?( name ).should be_true
-        @group.template_defined?( name.to_s ).should be_true
-      end
-      
-      @group.template_defined?( :somethign_else ).should be_false
+  end
+  
+  example "template_defined?( name ) should verify whether a template is defined in a group" do
+    for name in TEMPLATE_NAMES
+      @group.template_defined?( name ).should be_true
+      @group.template_defined?( name.to_s ).should be_true
     end
     
-    example "template method definitions" do
-      for name in TEMPLATE_NAMES
-        @group.should respond_to( name )
-        @group.should respond_to( "#{ name }!" )
+    @group.template_defined?( :something_else ).should be_false
+  end
+  
+  example "template method definitions" do
+    for name in TEMPLATE_NAMES
+      @group.should respond_to( name )
+      @group.should respond_to( "#{ name }!" )
+      if RUBY_VERSION =~ /^1\.9/
+        @group.private_instance_methods.should include name.to_sym
+        @group.private_instance_methods.should include :"#{ name }!"
+      else
         @group.private_instance_methods.should include name.to_s
         @group.private_instance_methods.should include "#{ name }!"
       end
     end
-    
-    example "template method operation" do
-      value = @group.class_definition
-      value.should be_a_kind_of Template::Context
-      
-      value = @group.class_definition!
-      value.should be_a_kind_of String
-      
-      value = @group.attribute( :name => 'a' )
-      value.should be_a_kind_of Template::Context
-    end
   end
   
-  describe Template::Group, "dynamic template definition" do
-    include ANTLR3::Util
-    
-    before :each do
-      @group = Template::Group.new do
-        extend ANTLR3::Util
-        define_template( :class_definition, tidy( <<-'END'.chomp ) )
-        | class <%= @name %><% if @superclass %> < <%= @superclass %><% end %>
-        | % if @attributes
-        | 
-        | % for attr, access in @attributes 
-        | <%= attribute( :name => attr, :access => ( access || 'rw' ) ).to_s.chomp %>
-        | % end
-        | % end
-        | % if @methods
-        | % for method in ( @methods || [] )
-        | <%= method( method ) %>
-        | % end
-        | % end
-        | end
-        END
-        
-        define_template( :attribute, tidy( <<-'END'.chomp ) )
-        | % case @access.to_s.downcase
-        | % when 'r'
-        |   attr_reader :<%= @name %>
-        | % when 'w'
-        |   attr_writer :<%= @name %>
-        | % else
-        |   attr_accessor :<%= @name %>
-        | % end
-        END
-        
-        define_template( :method, tidy( <<-'END'.chomp ) )
-        |   
-        |   def <%= @name %><% if @arguments and not @arguments.empty? %>( <%= @arguments.join( ', ' ) %> )<% end %>
-        | <%= @body.gsub( /^/, '    ' ) %>
-        |   end
-        END
-      end
-    end
+  example "template method operation" do
+    value = @group.class_definition
+    value.should be_a_kind_of Template::Context
     
-    it_should_behave_like "template groups"
+    value = @group.class_definition!
+    value.should be_a_kind_of String
     
-    example "template object string rendering" do
-      attributes = [
-        %w( family ),
-        %w( name r )
-      ]
-            
-      methods = [
-        MethodDescription.new( 'eat', %q[puts( "ate %s %s" % [ number, @name ] )], %w( number ) ),
-        MethodDescription.new( :to_s, '@name.to_s.dup' )
-      ]
-      
-      vegetable = @group.class_definition(
-        :name => 'Vegetable',
-        :superclass => 'Food',
-        :attributes => attributes,
-        :methods => methods
-      )
-      
-      vegetable.to_s.should == tidy( <<-END.chomp )
-      | class Vegetable < Food
-      |
-      |   attr_accessor :family
-      |   attr_reader :name
-      |   
-      |   def eat( number )
-      |     puts( "ate %s %s" % [ number, @name ] )
-      |   end
-      |   
-      |   def to_s
-      |     @name.to_s.dup
-      |   end
-      | end
-      END
-    end
+    value = @group.attribute( :name => 'a' )
+    value.should be_a_kind_of Template::Context
   end
+end
+
+describe Template::Group, "dynamic template definition" do
+  include ANTLR3::Util
   
-  describe Template::Group, "loading a template definition file" do
-    before :each do
-      @group = Template::Group.load( SAMPLE_GROUP_FILE )
-    end
-    
-    it_should_behave_like "template groups"
-    
-    example "template object string rendering" do
-      attributes = [
-        %w( family ),
-        %w( name r )
-      ]
-            
-      methods = [
-        MethodDescription.new( 'eat', %q[puts( "ate %s %s" % [ number, @name ] )], %w( number ) ),
-        MethodDescription.new( :to_s, '@name.to_s.dup' )
-      ]
+  before :each do
+    @group = Template::Group.new do
+      extend ANTLR3::Util
+      define_template( :class_definition, tidy( <<-'END'.chomp ) )
+      | class <%= @name %><% if @superclass %> < <%= @superclass %><% end %>
+      | % if @attributes
+      | 
+      | % for attr, access in @attributes 
+      | <%= attribute( :name => attr, :access => ( access || 'rw' ) ).to_s.chomp %>
+      | % end
+      | % end
+      | % if @methods
+      | % for method in ( @methods || [] )
+      | <%= method( method ) %>
+      | % end
+      | % end
+      | end
+      END
       
-      vegetable = @group.class_definition(
-        :name => 'Vegetable',
-        :superclass => 'Food',
-        :attributes => attributes,
-        :methods => methods
-      )
+      define_template( :attribute, tidy( <<-'END'.chomp ) )
+      | % case @access.to_s.downcase
+      | % when 'r'
+      |   attr_reader :<%= @name %>
+      | % when 'w'
+      |   attr_writer :<%= @name %>
+      | % else
+      |   attr_accessor :<%= @name %>
+      | % end
+      END
       
-      vegetable.to_s.should == tidy( <<-END.chomp )
-      | class Vegetable < Food
-      |
-      |   attr_accessor :family
-      |   attr_reader :name
+      define_template( :method, tidy( <<-'END'.chomp ) )
       |   
-      |   def eat( number )
-      |     puts( "ate %s %s" % [ number, @name ] )
+      |   def <%= @name %><% if @arguments and not @arguments.empty? %>( <%= @arguments.join( ', ' ) %> )<% end %>
+      | <%= @body.gsub( /^/, '    ' ) %>
       |   end
-      |   
-      |   def to_s
-      |     @name.to_s.dup
-      |   end
-      | end
       END
     end
-    
   end
+  
+  it_should_behave_like "template groups"
+  
+  example "template object string rendering" do
+    attributes = [
+      %w( family ),
+      %w( name r )
+    ]
+          
+    methods = [
+      MethodDescription.new( 'eat', %q[puts( "ate %s %s" % [ number, @name ] )], %w( number ) ),
+      MethodDescription.new( :to_s, '@name.to_s.dup' )
+    ]
+    
+    vegetable = @group.class_definition(
+      :name => 'Vegetable',
+      :superclass => 'Food',
+      :attributes => attributes,
+      :methods => methods
+    )
+    
+    vegetable.to_s.should == tidy( <<-END.chomp )
+    | class Vegetable < Food
+    |
+    |   attr_accessor :family
+    |   attr_reader :name
+    |   
+    |   def eat( number )
+    |     puts( "ate %s %s" % [ number, @name ] )
+    |   end
+    |   
+    |   def to_s
+    |     @name.to_s.dup
+    |   end
+    | end
+    END
+  end
+end
+
+describe Template::Group, "loading a template definition file" do
+  before :each do
+    @group = Template::Group.load( SAMPLE_GROUP_FILE )
+  end
+  
+  it_should_behave_like "template groups"
+  
+  example "template object string rendering" do
+    attributes = [
+      %w( family ),
+      %w( name r )
+    ]
+          
+    methods = [
+      MethodDescription.new( 'eat', %q[puts( "ate %s %s" % [ number, @name ] )], %w( number ) ),
+      MethodDescription.new( :to_s, '@name.to_s.dup' )
+    ]
+    
+    vegetable = @group.class_definition(
+      :name => 'Vegetable',
+      :superclass => 'Food',
+      :attributes => attributes,
+      :methods => methods
+    )
+    
+    vegetable.to_s.should == tidy( <<-END.chomp )
+    | class Vegetable < Food
+    |
+    |   attr_accessor :family
+    |   attr_reader :name
+    |   
+    |   def eat( number )
+    |     puts( "ate %s %s" % [ number, @name ] )
+    |   end
+    |   
+    |   def to_s
+    |     @name.to_s.dup
+    |   end
+    | end
+    END
+  end
+
 end