citrus 1.3.0 → 1.4.0

data/README

@@ -236,21 +236,13 @@ interpret them. The following example shows one way to do this.
 
   grammar Addition
     rule additive
-      (number plus term) {
+      (number plus term:(additive | number)) {
         def value
           number.value + term.value
         end
       }
     end
 
-    rule term
-      (additive | number) {
-        def value
-          first.value
-        end
-      }
-    end
-
     rule number
       ([0-9]+ space) {
         def value
@@ -268,26 +260,21 @@ interpret them. The following example shows one way to do this.
     end
   end
 
-In this version of the grammar the additive rule has been refactored to use the
-term rule. This makes it a little cleaner to define our semantic blocks. It's
+In this version of the grammar we have added two semantic blocks, one each for
+the additive and number rules. These blocks contain methods that will be present
+on all match objects that result from matches of those particular rules. It's
 easiest to explain what is going on here by starting with the lowest level
 block, which is defined within the number rule.
 
 The semantic block associated with the number rule defines one method, value.
-This method will be present on all matches that result from this rule. Inside
-this method, we can see that the value of a number match is determined to be
-its text value, stripped of white space and converted to an integer.
-
-Similarly, the block that is applied to term matches also defines a value
-method. However, this method works a bit differently. Since a term matches an
-additive or a number a term match will contain one submatch, the match that
-resulted from either additive or number. The first method retrieves the first
-submatch. So, the value of a term is determined to be the value of its first
-submatch.
-
-Finally, the additive rule also extends its matches with a value method. Here,
-the value of an additive is determined to be the values of its number and term
-matches added together using Ruby's addition operator.
+Inside this method, we can see that the value of a number match is determined to
+be its text value, stripped of white space and converted to an integer.
+
+The additive rule also extends its matches with a value method. Notice the use
+of the "term" label within the rule definition. This label allows the match that
+is created by either the additive or the number rule to be retrieved using the
+"term" label. The value of an additive is determined to be the values of its
+number and term matches added together using Ruby's addition operator.
 
 Since additive is the first rule defined in the grammar, any match that results
 from parsing a string with this grammar will have a value method that can be

data/citrus.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'citrus'
-  s.version = '1.3.0'
-  s.date = '2010-06-21'
+  s.version = '1.4.0'
+  s.date = '2010-06-22'
 
   s.summary = 'Parsing Expressions for Ruby'
   s.description = 'Parsing Expressions for Ruby'

data/doc/example.rdoc

@@ -51,21 +51,13 @@ interpret them. The following example shows one way to do this.
 
   grammar Addition
     rule additive
-      (number plus term) {
+      (number plus term:(additive | number)) {
         def value
           number.value + term.value
         end
       }
     end
 
-    rule term
-      (additive | number) {
-        def value
-          first.value
-        end
-      }
-    end
-
     rule number
       ([0-9]+ space) {
         def value
@@ -83,26 +75,21 @@ interpret them. The following example shows one way to do this.
     end
   end
 
-In this version of the grammar the additive rule has been refactored to use the
-term rule. This makes it a little cleaner to define our semantic blocks. It's
+In this version of the grammar we have added two semantic blocks, one each for
+the +additive+ and +number+ rules. These blocks contain methods that will be present
+on all match objects that result from matches of those particular rules. It's
 easiest to explain what is going on here by starting with the lowest level
-block, which is defined within the number rule.
-
-The semantic block associated with the number rule defines one method, value.
-This method will be present on all matches that result from this rule. Inside
-this method, we can see that the value of a number match is determined to be
-its text value, stripped of white space and converted to an integer.
-
-Similarly, the block that is applied to term matches also defines a value
-method. However, this method works a bit differently. Since a term matches an
-additive or a number a term match will contain one submatch, the match that
-resulted from either additive or number. The first method retrieves the first
-submatch. So, the value of a term is determined to be the value of its first
-submatch.
-
-Finally, the additive rule also extends its matches with a value method. Here,
-the value of an additive is determined to be the values of its number and term
-matches added together using Ruby's addition operator.
+block, which is defined within the +number+ rule.
+
+The semantic block associated with the +number+ rule defines one method, +value+.
+Inside this method, we can see that the value of a number match is determined to
+be its text value, stripped of white space and converted to an integer.
+
+The +additive+ rule also extends its matches with a +value+ method. Notice the use
+of the "term" label within the rule definition. This label allows the match that
+is created by either the +additive+ or the +number+ rule to be retrieved using the
+"term" label. The value of an additive is determined to be the values of its
+number and term matches added together using Ruby's addition operator.
 
 Since additive is the first rule defined in the grammar, any match that results
 from parsing a string with this grammar will have a value method that can be

data/lib/citrus.rb

@@ -4,7 +4,7 @@
 #
 # http://mjijackson.com/citrus
 module Citrus
-  VERSION = [1, 3, 0]
+  VERSION = [1, 4, 0]
 
   Infinity = 1.0 / 0
 
@@ -418,15 +418,15 @@ module Citrus
 
   private
 
-    def extend_match(match)
-      match.extend(ext) if ext
+    def extend_match(match, name)
+      match.extensions << ext if ext
+      match.names << name if name
+      match
     end
 
     def create_match(data, offset)
       match = Match.new(data, offset)
-      extend_match(match)
-      match.names << name if name
-      match
+      extend_match(match, name)
     end
   end
 
@@ -458,12 +458,7 @@ module Citrus
     # +nil+ if no match can be made.
     def match(input, offset=0)
       m = input.match(rule, offset)
-      if m
-        extend_match(m)
-        # This proxy's name should be added to the names of the match.
-        m.names << name if name
-        m
-      end
+      extend_match(m, name) if m
     end
   end
 
@@ -584,8 +579,8 @@ module Citrus
     # Returns the Match for this rule on +input+ at the given +offset+, +nil+ if
     # no match can be made.
     def match(input, offset=0)
-      result = input[offset, input.length - offset].match(rule)
-      create_match(result, offset) if result && result.begin(0) == 0
+      m = input[offset, input.length - offset].match(rule)
+      create_match(m, offset) if m && m.begin(0) == 0
     end
   end
 
@@ -693,12 +688,7 @@ module Citrus
     # the value of its label.
     def match(input, offset=0)
       m = rule.match(input, offset)
-      if m
-        extend_match(m)
-        # This label's name should be added to the names of the match.
-        m.names << label_name
-        m
-      end
+      extend_match(m, label_name) if m
     end
 
     # Returns the Citrus notation of this rule as a string.
@@ -800,12 +790,7 @@ module Citrus
     def match(input, offset=0)
       rules.each do |rule|
         m = input.match(rule, offset)
-        if m
-          extend_match(m)
-          # This choice's name should be added to the names of the match.
-          m.names << name if name
-          return m
-        end
+        return extend_match(m, name) if m
       end
       nil
     end
@@ -882,6 +867,11 @@ module Citrus
       names.include?(name)
     end
 
+    # An array of all extension modules of this match.
+    def extensions
+      @extensions ||= []
+    end
+
     # An array of all sub-matches of this match.
     def matches
       @matches ||= []
@@ -944,9 +934,23 @@ module Citrus
     # Uses #match to allow sub-matches of this match to be called by name as
     # instance methods.
     def method_missing(sym, *args)
-      m = first(sym)
-      return m if m
-      raise 'No match named "%s" in %s (%s)' % [sym, self, name]
+      # Extend this object only when needed and immediately redefine
+      # #method_missing so that the new version is used on all future calls.
+      extensions.each {|e| extend(e) } if @extensions
+      redefine_method_missing!
+      __send__(sym, *args)
+    end
+
+  private
+
+    def redefine_method_missing! # :nodoc:
+      instance_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+        def method_missing(sym, *args)
+          m = first(sym)
+          return m if m
+          raise 'No match named "%s" in %s (%s)' % [sym, self, name]
+        end
+      RUBY
     end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 3
+  - 4
   - 0
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Michael Jackson
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-21 00:00:00 -06:00
+date: 2010-06-22 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency