citrus 2.3.4 → 2.3.5

data/lib/citrus.rb

@@ -19,8 +19,6 @@ module Citrus
 
   CLOSE = -1
 
-  @cache = {}
-
   # Returns a map of paths of files that have been loaded via #load to the
   # result of #eval on the code in that file.
   #
@@ -29,7 +27,7 @@ module Citrus
   # #require the same file with a different relative path, it will be loaded
   # twice.
   def self.cache
-    @cache
+    @cache ||= {}
   end
 
   # Evaluates the given Citrus parsing expression grammar +code+ and returns an
@@ -71,22 +69,22 @@ module Citrus
   #     # => [MyGrammar]
   #
   def self.load(file, options={})
-    file += '.citrus' unless file =~ /\.citrus$/
+    file += '.citrus' unless /\.citrus$/ === file
     force = options.delete(:force)
 
-    if force || !@cache[file]
+    if force || !cache[file]
       raise LoadError, "Cannot find file #{file}" unless ::File.file?(file)
       raise LoadError, "Cannot read file #{file}" unless ::File.readable?(file)
 
       begin
-        @cache[file] = eval(::File.read(file), options)
+        cache[file] = eval(::File.read(file), options)
       rescue SyntaxError => e
         e.message.replace("#{::File.expand_path(file)}: #{e.message}")
         raise e
       end
     end
 
-    @cache[file]
+    cache[file]
   end
 
   # Searches the <tt>$LOAD_PATH</tt> for a +file+ with the .citrus suffix and
@@ -99,11 +97,13 @@ module Citrus
   #     # => [MyGrammar]
   #
   def self.require(file, options={})
-    file += '.citrus' unless file =~ /\.citrus$/
+    file += '.citrus' unless /\.citrus$/ === file
     found = nil
 
-    (Pathname.new(file).absolute? ? [''] : $LOAD_PATH).each do |dir|
-      found = Dir[::File.join(dir, file)].first
+    paths = ['']
+    paths += $LOAD_PATH unless Pathname.new(file).absolute?
+    paths.each do |path|
+      found = Dir[::File.join(path, file)].first
       break if found
     end
 
@@ -670,6 +670,11 @@ module Citrus
       end
     end
 
+    # This alias allows strings to be compared to the string representation of
+    # Rule objects. It is most useful in assertions in unit tests, e.g.:
+    #
+    #     assert_equal('"a" | "b"', rule)
+    #
     alias_method :to_str, :to_s
 
     # Returns the Citrus notation of this rule as a string that is suitable to
@@ -1287,6 +1292,11 @@ module Citrus
       @string
     end
 
+    # This alias allows strings to be compared to the string value of Match
+    # objects. It is most useful in assertions in unit tests, e.g.:
+    #
+    #     assert_equal("a string", match)
+    #
     alias_method :to_str, :to_s
 
     # The default value for a match is its string value. This method is
@@ -1296,11 +1306,9 @@ module Citrus
 
     # Returns this match plus all sub #matches in an array.
     def to_a
-      [captures[0]] + matches
+      [self] + matches
     end
 
-    alias_method :to_ary, :to_a
-
     # Returns the capture at the given +key+. If it is an Integer (and an
     # optional length) or a Range, the result of #to_a with the same arguments
     # is returned. Otherwise, the value at +key+ in #captures is returned.
@@ -1313,8 +1321,6 @@ module Citrus
       end
     end
 
-    alias_method :fetch, :[]
-
     def ==(other)
       case other
       when String
@@ -1382,6 +1388,7 @@ module Citrus
       @matches = []
 
       capture!(@events[0], self)
+      @captures[0] = self
 
       stack = []
       offset = 0
@@ -1404,7 +1411,10 @@ module Citrus
             match = Match.new(@string.slice(os, event), @events[start..index])
             capture!(rule, match)
 
-            @matches << match if stack.size == 1
+            if stack.size == 1
+              @matches << match
+              @captures[@matches.size] = match
+            end
 
             capture = true
           end
@@ -1437,13 +1447,6 @@ module Citrus
 
         index += 1
       end
-
-      # Add numeric indices to @captures.
-      @captures[0] = self
-
-      @matches.each_with_index do |match, index|
-        @captures[index + 1] = match
-      end
     end
 
     def capture!(rule, match)

data/lib/citrus/file.rb

@@ -21,7 +21,7 @@ module Citrus
     end
   end
 
-  # A grammar for Citrus grammar files. This grammar is used in Citrus#eval to
+  # A grammar for Citrus grammar files. This grammar is used in Citrus.eval to
   # parse and evaluate Citrus grammars and serves as a prime example of how to
   # create a complex grammar complete with semantic interpretation in pure Ruby.
   File = Grammar.new do #:nodoc:
@@ -316,12 +316,12 @@ module Citrus
       }
     end
 
-    rule :require_keyword,  [ 'require', :space ]
-    rule :include_keyword,  [ 'include', :space ]
-    rule :grammar_keyword,  [ 'grammar', :space ]
-    rule :root_keyword,     [ 'root', :space ]
-    rule :rule_keyword,     [ 'rule', :space ]
-    rule :end_keyword,      [ 'end', :space ]
+    rule :require_keyword,  [ /\brequire\b/, :space ]
+    rule :include_keyword,  [ /\binclude\b/, :space ]
+    rule :grammar_keyword,  [ /\bgrammar\b/, :space ]
+    rule :root_keyword,     [ /\broot\b/, :space ]
+    rule :rule_keyword,     [ /\brule\b/, :space ]
+    rule :end_keyword,      [ /\bend\b/, :space ]
     rule :lparen,           [ '(', :space ]
     rule :rparen,           [ ')', :space ]
     rule :lcurly,           [ '{', :space ]
@@ -336,7 +336,7 @@ module Citrus
     rule :space,            zero_or_more(any(:white, :comment))
   end
 
-  def File.parse(*args) # :nodoc:
+  def File.parse(*) # :nodoc:
     super
   rescue ParseError => e
     # Raise SyntaxError when a parse fails.

data/lib/citrus/version.rb

@@ -1,6 +1,6 @@
 module Citrus
   # The current version of Citrus as [major, minor, patch].
-  VERSION = [2, 3, 4]
+  VERSION = [2, 3, 5]
 
   # Returns the current version of Citrus as a string.
   def self.version

data/test/_files/grammar3.citrus

@@ -0,0 +1,8 @@
+grammar EndTagGrammar
+  rule end_tag
+    /*./
+  end
+  rule number
+    end_tag
+  end
+end

data/test/alias_test.rbc

@@ -0,0 +1,1491 @@
+!RBIX
+0
+x
+M
+1
+n
+n
+x
+10
+__script__
+i
+54
+5
+45
+0
+1
+7
+2
+64
+65
+49
+3
+0
+49
+4
+2
+47
+49
+5
+1
+15
+99
+7
+6
+45
+7
+8
+43
+9
+43
+10
+65
+49
+11
+3
+13
+99
+12
+7
+12
+12
+7
+13
+12
+65
+12
+49
+14
+4
+15
+49
+12
+0
+15
+2
+11
+I
+6
+I
+0
+I
+0
+I
+0
+n
+p
+15
+x
+4
+File
+n
+s
+9
+../helper
+x
+11
+active_path
+x
+11
+expand_path
+x
+7
+require
+x
+9
+AliasTest
+x
+4
+Test
+n
+x
+4
+Unit
+x
+8
+TestCase
+x
+10
+open_class
+x
+14
+__class_init__
+M
+1
+n
+n
+x
+9
+AliasTest
+i
+86
+5
+66
+99
+7
+0
+7
+1
+65
+67
+49
+2
+0
+49
+3
+4
+15
+99
+7
+4
+7
+5
+65
+67
+49
+2
+0
+49
+3
+4
+15
+99
+7
+6
+7
+7
+65
+67
+49
+2
+0
+49
+3
+4
+15
+99
+7
+8
+7
+9
+65
+67
+49
+2
+0
+49
+3
+4
+15
+99
+7
+10
+7
+11
+65
+67
+49
+2
+0
+49
+3
+4
+15
+99
+7
+12
+7
+13
+65
+67
+49
+2
+0
+49
+3
+4
+11
+I
+5
+I
+0
+I
+0
+I
+0
+n
+p
+14
+x
+14
+test_terminal?
+M
+1
+n
+n
+x
+14
+test_terminal?
+i
+39
+45
+0
+1
+13
+71
+2
+47
+9
+21
+47
+49
+3
+0
+13
+47
+49
+4
+0
+15
+8
+24
+49
+2
+0
+19
+0
+15
+5
+3
+20
+0
+49
+5
+0
+47
+49
+6
+2
+11
+I
+4
+I
+1
+I
+0
+I
+0
+n
+p
+7
+x
+5
+Alias
+n
+x
+3
+new
+x
+8
+allocate
+x
+10
+initialize
+x
+9
+terminal?
+x
+12
+assert_equal
+p
+7
+I
+-1
+I
+4
+I
+0
+I
+5
+I
+1b
+I
+6
+I
+27
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+1
+x
+4
+rule
+x
+17
+method_visibility
+x
+15
+add_defn_method
+x
+9
+test_exec
+M
+1
+n
+n
+x
+9
+test_exec
+i
+86
+45
+0
+1
+56
+2
+50
+3
+0
+19
+0
+15
+20
+0
+7
+4
+49
+5
+1
+19
+1
+15
+20
+0
+7
+6
+49
+5
+1
+19
+2
+15
+20
+1
+45
+7
+8
+13
+71
+3
+47
+9
+57
+47
+49
+9
+0
+13
+7
+10
+64
+47
+49
+11
+1
+15
+8
+63
+7
+10
+64
+49
+3
+1
+49
+12
+1
+19
+3
+15
+5
+20
+1
+45
+13
+14
+4
+3
+35
+3
+20
+3
+47
+49
+15
+2
+11
+I
+8
+I
+4
+I
+0
+I
+0
+n
+p
+16
+x
+7
+Grammar
+n
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+test_exec
+i
+21
+5
+7
+0
+7
+1
+47
+49
+2
+2
+15
+5
+7
+1
+7
+3
+64
+47
+49
+2
+2
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+4
+x
+1
+a
+x
+1
+b
+x
+4
+rule
+s
+3
+abc
+p
+5
+I
+0
+I
+b
+I
+a
+I
+c
+I
+15
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+0
+x
+3
+new
+x
+1
+a
+x
+4
+rule
+x
+1
+b
+x
+5
+Input
+n
+x
+8
+allocate
+s
+3
+abc
+x
+10
+initialize
+x
+4
+exec
+x
+5
+CLOSE
+n
+x
+12
+assert_equal
+p
+13
+I
+-1
+I
+9
+I
+0
+I
+a
+I
+b
+I
+e
+I
+15
+I
+f
+I
+1f
+I
+10
+I
+45
+I
+11
+I
+56
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+4
+x
+7
+grammar
+x
+6
+rule_a
+x
+6
+rule_b
+x
+6
+events
+x
+14
+test_exec_miss
+M
+1
+n
+n
+x
+14
+test_exec_miss
+i
+69
+45
+0
+1
+56
+2
+50
+3
+0
+19
+0
+15
+20
+0
+7
+4
+49
+5
+1
+19
+1
+15
+20
+1
+45
+6
+7
+13
+71
+3
+47
+9
+47
+47
+49
+8
+0
+13
+7
+9
+64
+47
+49
+10
+1
+15
+8
+53
+7
+9
+64
+49
+3
+1
+49
+11
+1
+19
+2
+15
+5
+35
+0
+20
+2
+47
+49
+12
+2
+11
+I
+7
+I
+3
+I
+0
+I
+0
+n
+p
+13
+x
+7
+Grammar
+n
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+14
+test_exec_miss
+i
+21
+5
+7
+0
+7
+1
+47
+49
+2
+2
+15
+5
+7
+1
+7
+3
+64
+47
+49
+2
+2
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+4
+x
+1
+a
+x
+1
+b
+x
+4
+rule
+s
+3
+abc
+p
+5
+I
+0
+I
+16
+I
+a
+I
+17
+I
+15
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+0
+x
+3
+new
+x
+1
+a
+x
+4
+rule
+x
+5
+Input
+n
+x
+8
+allocate
+s
+3
+def
+x
+10
+initialize
+x
+4
+exec
+x
+12
+assert_equal
+p
+11
+I
+-1
+I
+14
+I
+0
+I
+15
+I
+b
+I
+19
+I
+15
+I
+1a
+I
+3b
+I
+1b
+I
+45
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+3
+x
+7
+grammar
+x
+4
+rule
+x
+6
+events
+x
+18
+test_exec_included
+M
+1
+n
+n
+x
+18
+test_exec_included
+i
+97
+45
+0
+1
+56
+2
+50
+3
+0
+19
+0
+15
+45
+0
+4
+56
+5
+50
+3
+0
+19
+1
+15
+20
+1
+7
+6
+49
+7
+1
+19
+2
+15
+20
+0
+7
+8
+49
+7
+1
+19
+3
+15
+20
+2
+45
+9
+10
+13
+71
+3
+47
+9
+68
+47
+49
+11
+0
+13
+7
+12
+64
+47
+49
+13
+1
+15
+8
+74
+7
+12
+64
+49
+3
+1
+49
+14
+1
+19
+4
+15
+5
+20
+2
+45
+15
+16
+4
+3
+35
+3
+20
+4
+47
+49
+17
+2
+11
+I
+9
+I
+5
+I
+0
+I
+0
+n
+p
+18
+x
+7
+Grammar
+n
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+18
+test_exec_included
+i
+11
+5
+7
+0
+7
+1
+64
+47
+49
+2
+2
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+3
+x
+1
+a
+s
+3
+abc
+x
+4
+rule
+p
+3
+I
+0
+I
+20
+I
+b
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+0
+x
+3
+new
+n
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+18
+test_exec_included
+i
+19
+5
+21
+1
+0
+47
+49
+0
+1
+15
+5
+7
+1
+7
+2
+47
+49
+3
+2
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+4
+x
+7
+include
+x
+1
+b
+x
+1
+a
+x
+4
+rule
+p
+5
+I
+0
+I
+23
+I
+9
+I
+24
+I
+13
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+0
+x
+1
+b
+x
+4
+rule
+x
+1
+a
+x
+5
+Input
+n
+x
+8
+allocate
+s
+3
+abc
+x
+10
+initialize
+x
+4
+exec
+x
+5
+CLOSE
+n
+x
+12
+assert_equal
+p
+15
+I
+-1
+I
+1e
+I
+0
+I
+1f
+I
+b
+I
+22
+I
+16
+I
+26
+I
+20
+I
+27
+I
+2a
+I
+28
+I
+50
+I
+29
+I
+61
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+5
+x
+8
+grammar1
+x
+8
+grammar2
+x
+7
+rule_b2
+x
+7
+rule_a1
+x
+6
+events
+x
+9
+test_to_s
+M
+1
+n
+n
+x
+9
+test_to_s
+i
+45
+45
+0
+1
+13
+71
+2
+47
+9
+23
+47
+49
+3
+0
+13
+7
+4
+47
+49
+5
+1
+15
+8
+28
+7
+4
+49
+2
+1
+19
+0
+15
+5
+7
+6
+64
+20
+0
+49
+7
+0
+47
+49
+8
+2
+11
+I
+4
+I
+1
+I
+0
+I
+0
+n
+p
+9
+x
+5
+Alias
+n
+x
+3
+new
+x
+8
+allocate
+x
+5
+alpha
+x
+10
+initialize
+s
+5
+alpha
+x
+4
+to_s
+x
+12
+assert_equal
+p
+7
+I
+-1
+I
+2c
+I
+0
+I
+2d
+I
+1f
+I
+2e
+I
+2d
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+1
+x
+4
+rule
+x
+20
+test_to_s_with_label
+M
+1
+n
+n
+x
+20
+test_to_s_with_label
+i
+58
+45
+0
+1
+13
+71
+2
+47
+9
+23
+47
+49
+3
+0
+13
+7
+4
+47
+49
+5
+1
+15
+8
+28
+7
+4
+49
+2
+1
+19
+0
+15
+20
+0
+7
+6
+64
+13
+18
+2
+49
+7
+1
+15
+15
+5
+7
+8
+64
+20
+0
+49
+9
+0
+47
+49
+10
+2
+11
+I
+4
+I
+1
+I
+0
+I
+0
+n
+p
+11
+x
+5
+Alias
+n
+x
+3
+new
+x
+8
+allocate
+x
+5
+alpha
+x
+10
+initialize
+s
+7
+a_label
+x
+6
+label=
+s
+13
+a_label:alpha
+x
+4
+to_s
+x
+12
+assert_equal
+p
+9
+I
+-1
+I
+31
+I
+0
+I
+32
+I
+1f
+I
+33
+I
+2c
+I
+34
+I
+3a
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+1
+x
+4
+rule
+p
+13
+I
+2
+I
+4
+I
+10
+I
+9
+I
+1e
+I
+14
+I
+2c
+I
+1e
+I
+3a
+I
+2c
+I
+48
+I
+31
+I
+56
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+0
+x
+13
+attach_method
+p
+5
+I
+0
+I
+1
+I
+13
+I
+3
+I
+36
+x
+49
+/Users/michael/Projects/citrus/test/alias_test.rb
+p
+0