citrus 2.3.7 → 2.4.0

data/CHANGES

@@ -1,3 +1,12 @@
+= 2.4.0 / 2011-05-11
+
+  * Fixed a bug that prevented parsing nested blocks correctly (issue #21).
+
+  * Added URI example.
+
+  * Moved example grammars inside lib/citrus/grammars and added
+    lib/citrus/grammars.rb for easily requiring Citrus example grammars.
+
 = 2.3.7 / 2011-02-20
 
   * Fixed a bug that prevented forward slashes from being used inside character

data/Rakefile

@@ -6,7 +6,7 @@ task :default => :test
 # TESTS #######################################################################
 
 Rake::TestTask.new(:test) do |t|
-  t.test_files = FileList['test/*_test.rb'] + FileList['examples/*_test.rb']
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 # DOCS ########################################################################

data/citrus.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |s|
 
   s.files = Dir['benchmark/**'] +
     Dir['doc/**'] +
-    Dir['examples/**'] +
     Dir['extras/**'] +
     Dir['lib/**/*.rb'] +
     Dir['test/**/*'] +

data/lib/citrus.rb

@@ -648,6 +648,11 @@ module Citrus
       nil
     end
 
+    # Tests the given +obj+ for case equality with this rule.
+    def ===(obj)
+      !test(obj).nil?
+    end
+
     # Returns +true+ if this rule is a Terminal.
     def terminal?
       false
@@ -700,6 +705,8 @@ module Citrus
       end
     end
 
+    alias_method :eql?, :==
+
     def inspect # :nodoc:
       to_s
     end
@@ -872,6 +879,8 @@ module Citrus
       end
     end
 
+    alias_method :eql?, :==
+
     # Returns +true+ if this rule is a Terminal.
     def terminal? # :nodoc:
       true
@@ -915,6 +924,8 @@ module Citrus
       end
     end
 
+    alias_method :eql?, :==
+
     # Returns the Citrus notation of this rule as a string.
     def to_citrus # :nodoc:
       if case_sensitive?
@@ -1336,6 +1347,8 @@ module Citrus
       end
     end
 
+    alias_method :eql?, :==
+
     def inspect
       @string.inspect
     end

data/lib/citrus/file.rb

@@ -73,7 +73,7 @@ module Citrus
     end
 
     rule :expression do
-      all(:sequence, zero_or_more([ :bar, :sequence ])) {
+      all(:sequence, zero_or_more([['|', zero_or_one(:space)], :sequence])) {
         rules = captures[:sequence].map {|s| s.value }
         rules.length > 1 ? Choice.new(rules) : rules.first
       }
@@ -123,7 +123,7 @@ module Citrus
     end
 
     rule :grouping do
-      all(:lparen, :expression, :rparen) {
+      all(['(', zero_or_one(:space)], :expression, [')', zero_or_one(:space)]) {
         expression.value
       }
     end
@@ -241,7 +241,11 @@ module Citrus
     end
 
     rule :tag do
-      mod all(:lt, :module_name, :gt) do
+      mod all(
+        ['<', zero_or_one(:space)],
+        :module_name,
+        ['>', zero_or_one(:space)]
+      ) do
         include ModuleNameHelpers
 
         def value
@@ -251,7 +255,11 @@ module Citrus
     end
 
     rule :block do
-      all(:lcurly, zero_or_more(any(:block, /[^{}]+/)), :rcurly) {
+      all(
+        '{',
+        zero_or_more(any(:block, /[^{}]+/)),
+        ['}', zero_or_one(:space)]
+      ) {
         proc = eval("Proc.new #{to_s}", TOPLEVEL_BINDING)
 
         # Attempt to detect if this is a module block using some
@@ -322,13 +330,6 @@ module Citrus
     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 ]
-    rule :rcurly,           [ '}', :space ]
-    rule :bar,              [ '|', :space ]
-    rule :lt,               [ '<', :space ]
-    rule :gt,               [ '>', :space ]
 
     rule :constant,         /[A-Z][a-zA-Z0-9_]*/
     rule :white,            /[ \t\n\r]/

data/lib/citrus/grammars.rb

@@ -0,0 +1,11 @@
+# Require this file to use any of the bundled Citrus grammars.
+#
+#     require 'citrus/grammars'
+#     Citrus.require 'uri'
+#
+#     match = UniformResourceIdentifier.parse(uri_string)
+#     # => #<Citrus::Match ... >
+
+require 'citrus'
+
+$LOAD_PATH.unshift(::File.expand_path('../grammars', __FILE__))

data/lib/citrus/version.rb

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

data/test/_files/rule4.citrus

@@ -0,0 +1,5 @@
+rule method
+  (def space method_name statements ends) {
+    "#{method_name.value} = function() { #{statements.value} }"
+  }
+end

data/test/grammar_test.rb

@@ -118,7 +118,8 @@ class GrammarTest < Test::Unit::TestCase
     assert_equal('((a))', match)
     assert_equal(5, match.length)
 
-    str = ('(' * 200) + 'a' + (')' * 200)
+    n = 100
+    str = ('(' * n) + 'a' + (')' * n)
     match = grammar.parse(str)
     assert(match)
     assert_equal(str, match)

data/{examples → test/grammars}/calc_test.rb

@@ -1,8 +1,7 @@
-# This file contains a suite of tests for the Calc grammar found in calc.citrus.
+require File.expand_path('../../helper', __FILE__)
+require 'citrus/grammars'
 
-require 'citrus'
-Citrus.require File.expand_path('../calc', __FILE__)
-require 'test/unit'
+Citrus.require 'calc'
 
 class CalcTest < Test::Unit::TestCase
   # A helper method that tests the successful parsing and evaluation of the

data/{examples → test/grammars}/email_test.rb

@@ -1,9 +1,7 @@
-# This file contains a suite of tests for the EmailAddress grammar
-# found in email.citrus.
+require File.expand_path('../../helper', __FILE__)
+require 'citrus/grammars'
 
-require 'citrus'
-Citrus.require File.expand_path('../email', __FILE__)
-require 'test/unit'
+Citrus.require 'email'
 
 class EmailAddressTest < Test::Unit::TestCase
   def test_addr_spec_valid

data/{examples → test/grammars}/ipaddress_test.rb

@@ -1,12 +1,7 @@
-examples = File.expand_path('..', __FILE__)
-$LOAD_PATH.unshift(examples) unless $LOAD_PATH.include?(examples)
+require File.expand_path('../../helper', __FILE__)
+require 'citrus/grammars'
 
-# This file contains a suite of tests for the IPAddress grammar found in
-# ipaddress.citrus.
-
-require 'citrus'
 Citrus.require 'ipaddress'
-require 'test/unit'
 
 class IPAddressTest < Test::Unit::TestCase
   def test_v4

data/{examples → test/grammars}/ipv4address_test.rb

@@ -1,12 +1,7 @@
-examples = File.expand_path('..', __FILE__)
-$LOAD_PATH.unshift(examples) unless $LOAD_PATH.include?(examples)
+require File.expand_path('../../helper', __FILE__)
+require 'citrus/grammars'
 
-# This file contains a suite of tests for the IPv4Address grammar found in
-# ipv4address.citrus.
-
-require 'citrus'
 Citrus.require 'ipv4address'
-require 'test/unit'
 
 class IPv4AddressTest < Test::Unit::TestCase
   def test_dec_octet

data/{examples → test/grammars}/ipv6address_test.rb

@@ -1,12 +1,7 @@
-examples = File.expand_path('..', __FILE__)
-$LOAD_PATH.unshift(examples) unless $LOAD_PATH.include?(examples)
+require File.expand_path('../../helper', __FILE__)
+require 'citrus/grammars'
 
-# This file contains a suite of tests for the IPv6Address grammar found in
-# ipv6address.citrus.
-
-require 'citrus'
 Citrus.require 'ipv6address'
-require 'test/unit'
 
 class IPv6AddressTest < Test::Unit::TestCase
   def test_hexdig

data/test/grammars/uri_test.rb

@@ -0,0 +1,53 @@
+require File.expand_path('../../helper', __FILE__)
+require 'citrus/grammars'
+
+Citrus.require 'uri'
+
+class UniformResourceIdentifierTest < Test::Unit::TestCase
+  U = UniformResourceIdentifier
+
+  def test_uri
+    match = U.parse('http://www.example.com')
+    assert(match)
+  end
+
+  def test_uri_with_query_string
+    match = U.parse('http://www.example.com/?q=some+query')
+    assert(match)
+  end
+
+  def test_authority
+    match = U.parse('michael@', :root => :authority)
+    assert(match)
+  end
+
+  def test_host
+    match = U.parse('127.0.0.1', :root => :host)
+    assert(match)
+
+    match = U.parse('[12AD:34FC:A453:1922::]', :root => :host)
+    assert(match)
+  end
+
+  def test_userinfo
+    match = U.parse('michael', :root => :userinfo)
+    assert(match)
+
+    assert_raise(Citrus::ParseError) do
+      U.parse('michael@', :root => :userinfo)
+    end
+  end
+
+  def test_ipliteral
+    match = U.parse('[12AD:34FC:A453:1922::]', :root => :'IP-literal')
+    assert(match)
+  end
+
+  def test_ipvfuture
+    match = U.parse('v1.123:456:789', :root => :IPvFuture)
+    assert(match)
+
+    match = U.parse('v5A.ABCD:1234', :root => :IPvFuture)
+    assert(match)
+  end
+end

data/test/memoized_input_test.rbc

@@ -118,7 +118,7 @@ x
 17
 MemoizedInputTest
 i
-68
+92
 5
 66
 99
@@ -186,6 +186,30 @@ i
 49
 3
 4
+15
+5
+7
+13
+56
+14
+47
+50
+6
+1
+15
+99
+7
+15
+7
+16
+65
+67
+49
+2
+0
+49
+3
+4
 11
 I
 5
@@ -197,7 +221,7 @@ I
 0
 n
 p
-13
+17
 x
 14
 test_memoized?
@@ -649,7 +673,7 @@ x
 16
 test_cache_hits1
 i
-59
+60
 45
 0
 1
@@ -698,7 +722,8 @@ i
 1
 15
 5
-80
+4
+3
 20
 0
 49
@@ -774,7 +799,7 @@ I
 I
 1d
 I
-3b
+3c
 x
 58
 /Users/michael/Projects/citrus/test/memoized_input_test.rb
@@ -1073,11 +1098,461 @@ p
 x
 5
 input
+x
+10
+LettersABC
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+17
+MemoizedInputTest
+i
+40
+5
+7
+0
+56
+1
+47
+50
+2
+1
+15
+5
+7
+3
+56
+4
+47
+50
+2
+1
+15
+5
+7
+5
+56
+6
+47
+50
+2
+1
+15
+5
+7
+7
+56
+8
+47
+50
+2
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+9
+x
+3
+top
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+17
+MemoizedInputTest
+i
+39
+5
+5
+7
+0
+7
+1
+7
+2
+47
+49
+3
+3
+5
+7
+1
+7
+0
+7
+2
+47
+49
+3
+3
+5
+7
+1
+7
+2
+7
+0
+47
+49
+3
+3
+47
+49
+4
+3
+11
+I
+8
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+5
+x
+1
+a
+x
+1
+b
+x
+1
+c
+x
+3
+all
+x
+3
+any
+p
+3
+I
+0
+I
+2e
+I
+27
+x
+58
+/Users/michael/Projects/citrus/test/memoized_input_test.rb
+p
+0
+x
+4
+rule
+x
+1
+a
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+17
+MemoizedInputTest
+i
+4
+7
+0
+64
+11
+I
+2
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+1
+s
+1
+a
 p
+3
+I
+0
+I
+31
+I
+4
+x
+58
+/Users/michael/Projects/citrus/test/memoized_input_test.rb
+p
+0
+x
+1
+b
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+17
+MemoizedInputTest
+i
+4
+7
+0
+64
+11
+I
+2
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+1
+s
+1
+b
+p
+3
+I
+0
+I
+34
+I
+4
+x
+58
+/Users/michael/Projects/citrus/test/memoized_input_test.rb
+p
+0
+x
+1
+c
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+17
+MemoizedInputTest
+i
+4
+7
+0
+64
 11
 I
 2
 I
+0
+I
+0
+I
+0
+I
+-2
+p
+1
+s
+1
+c
+p
+3
+I
+0
+I
+37
+I
+4
+x
+58
+/Users/michael/Projects/citrus/test/memoized_input_test.rb
+p
+0
+p
+9
+I
+0
+I
+2d
+I
+a
+I
+30
+I
+14
+I
+33
+I
+1e
+I
+36
+I
+28
+x
+58
+/Users/michael/Projects/citrus/test/memoized_input_test.rb
+p
+0
+x
+16
+test_memoization
+M
+1
+n
+n
+x
+16
+test_memoization
+i
+38
+45
+0
+1
+7
+2
+64
+44
+43
+3
+79
+49
+4
+1
+13
+7
+5
+2
+49
+6
+2
+15
+49
+7
+2
+19
+0
+15
+5
+7
+2
+64
+20
+0
+47
+49
+8
+2
+11
+I
+7
+I
+1
+I
+0
+I
+0
+n
+p
+9
+x
+10
+LettersABC
+n
+s
+3
+bca
+x
+4
+Hash
+x
+16
+new_from_literal
+x
+7
+memoize
+x
+3
+[]=
+x
+5
+parse
+x
+12
+assert_equal
+p
+7
+I
+-1
+I
+3b
+I
+0
+I
+3c
+I
+1b
+I
+3d
+I
+26
+x
+58
+/Users/michael/Projects/citrus/test/memoized_input_test.rb
+p
+1
+x
+5
+match
+p
+15
+I
+2
+I
 4
 I
 10
@@ -1097,6 +1572,14 @@ I
 26
 I
 44
+I
+2c
+I
+4e
+I
+3b
+I
+5c
 x
 58
 /Users/michael/Projects/citrus/test/memoized_input_test.rb