citrus 1.2.2 → 1.3.0

data/citrus.gemspec

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

data/examples/calc.citrus

@@ -3,11 +3,7 @@
 # ignoring whitespace.
 grammar Calc
   rule term
-    (additive | factor) {
-      def value
-        first.value
-      end
-    }
+    additive | factor
   end
 
   rule additive
@@ -19,11 +15,7 @@ grammar Calc
   end
 
   rule factor
-    (multiplicative | primary) {
-      def value
-        first.value
-      end
-    }
+    multiplicative | primary
   end
 
   rule multiplicative
@@ -35,11 +27,7 @@ grammar Calc
   end
 
   rule primary
-    (term_paren | number) {
-      def value
-        first.value
-      end
-    }
+    term_paren | number
   end
 
   rule term_paren
@@ -67,11 +55,7 @@ grammar Calc
   end
 
   rule number
-    (float | integer) {
-      def value
-        first.value
-      end
-    }
+    float | integer
   end
 
   rule float

data/examples/calc.rb

@@ -6,14 +6,8 @@ require 'citrus'
 module Calc
   include Citrus::Grammar
 
-  module FirstValue
-    def value
-      first.value
-    end
-  end
-
   rule :term do
-    ext(any(:additive, :factor), FirstValue)
+    any(:additive, :factor)
   end
 
   rule :additive do
@@ -25,7 +19,7 @@ module Calc
   end
 
   rule :factor do
-    ext(any(:multiplicative, :primary), FirstValue)
+    any(:multiplicative, :primary)
   end
 
   rule :multiplicative do
@@ -37,7 +31,7 @@ module Calc
   end
 
   rule :primary do
-    ext(any(:term_paren, :number), FirstValue)
+    any(:term_paren, :number)
   end
 
   rule :term_paren do
@@ -65,7 +59,7 @@ module Calc
   end
 
   rule :number do
-    ext(any(:float, :integer), FirstValue)
+    any(:float, :integer)
   end
 
   rule :float do

data/examples/calc_sugar.rb

@@ -4,14 +4,8 @@ require 'citrus/sugar'
 # non-negative numbers (integers and floats), respecting operator precedence and
 # ignoring whitespace.
 Calc = Citrus::Grammar.new {
-  module FirstValue
-    def value
-      first.value
-    end
-  end
-
   rule term do
-    ext(any(additive, factor), FirstValue)
+    any(additive, factor)
   end
 
   rule additive do
@@ -23,7 +17,7 @@ Calc = Citrus::Grammar.new {
   end
 
   rule factor do
-    ext(any(multiplicative, primary), FirstValue)
+    any(multiplicative, primary)
   end
 
   rule multiplicative do
@@ -35,7 +29,7 @@ Calc = Citrus::Grammar.new {
   end
 
   rule primary do
-    ext(any(term_paren, number), FirstValue)
+    any(term_paren, number)
   end
 
   rule term_paren do
@@ -63,7 +57,7 @@ Calc = Citrus::Grammar.new {
   end
 
   rule number do
-    ext(any(float, integer), FirstValue)
+    any(float, integer)
   end
 
   rule float do

data/lib/citrus.rb

@@ -4,7 +4,7 @@
 #
 # http://mjijackson.com/citrus
 module Citrus
-  VERSION = [1, 2, 2]
+  VERSION = [1, 3, 0]
 
   Infinity = 1.0 / 0
 
@@ -419,13 +419,13 @@ module Citrus
   private
 
     def extend_match(match)
-      match.ext = ext if ext
+      match.extend(ext) if ext
     end
 
     def create_match(data, offset)
       match = Match.new(data, offset)
       extend_match(match)
-      match.name = name
+      match.names << name if name
       match
     end
   end
@@ -437,13 +437,13 @@ module Citrus
   module Proxy
     include Rule
 
-    def initialize(name='<proxy>')
-      self.rule_name = name
+    def initialize(rule_name='<proxy>')
+      self.rule_name = rule_name
     end
 
     # Sets the name of the rule this rule is proxy for.
-    def rule_name=(name)
-      @rule_name = name.to_sym
+    def rule_name=(rule_name)
+      @rule_name = rule_name.to_sym
     end
 
     # The name of this proxy's rule.
@@ -460,8 +460,8 @@ module Citrus
       m = input.match(rule, offset)
       if m
         extend_match(m)
-        # If this Proxy has a name then it should rename all of its matches.
-        m.name = name if name
+        # This proxy's name should be added to the names of the match.
+        m.names << name if name
         m
       end
     end
@@ -675,13 +675,18 @@ module Citrus
   class Label
     include Predicate
 
-    def initialize(label='<label>', rule='')
-      @label = label.to_sym
+    def initialize(label_name='<label>', rule='')
       super(rule)
+      self.label_name = label_name
     end
 
-    # The symbol this rule uses to re-name all its matches.
-    attr_reader :label
+    # Sets the name of this label.
+    def label_name=(label_name)
+      @label_name = label_name.to_sym
+    end
+
+    # The name this rule adds to all its matches.
+    attr_reader :label_name
 
     # Returns the Match for this rule on +input+ at the given +offset+, +nil+ if
     # no match can be made. When a Label makes a match, it re-names the match to
@@ -690,14 +695,15 @@ module Citrus
       m = rule.match(input, offset)
       if m
         extend_match(m)
-        m.name = label
+        # This label's name should be added to the names of the match.
+        m.names << label_name
         m
       end
     end
 
     # Returns the Citrus notation of this rule as a string.
     def to_s
-      label.to_s + ':' + rule.embed
+      label_name.to_s + ':' + rule.embed
     end
   end
 
@@ -794,7 +800,12 @@ module Citrus
     def match(input, offset=0)
       rules.each do |rule|
         m = input.match(rule, offset)
-        return create_match([m], offset) if m
+        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
       end
       nil
     end
@@ -851,18 +862,26 @@ module Citrus
       @offset = offset
     end
 
-    # The name by which this match can be accessed from a parent match. This
-    # will be the name of the rule that generated the match in most cases.
-    # However, if the match is the result of a Label this will be the value of
-    # the label.
-    attr_accessor :name
-
-    # A module that will be used to extend this match.
-    attr_accessor :ext
-
     # The offset in the input at which this match occurred.
     attr_reader :offset
 
+    # An array of all names of this match. A name is added to a match object
+    # for each rule that returns that object when matching. These names can then
+    # be used to determine which rules were satisfied by a given match.
+    def names
+      @names ||= []
+    end
+
+    # The name of the lowest level rule that originally created this match.
+    def name
+      names.first
+    end
+
+    # Returns +true+ if this match has the given +name+.
+    def has_name?(name)
+      names.include?(name)
+    end
+
     # An array of all sub-matches of this match.
     def matches
       @matches ||= []
@@ -897,7 +916,7 @@ module Citrus
     # match.
     def find(name, deep=true)
       sym = name.to_sym
-      ms = matches.select {|m| sym == m.name }
+      ms = matches.select {|m| m.has_name?(sym) }
       ms.concat(matches.map {|m| m.find(name, deep) }.flatten) if deep
       ms
     end
@@ -925,23 +944,9 @@ module Citrus
     # Uses #match to allow sub-matches of this match to be called by name as
     # instance methods.
     def method_missing(sym, *args)
-      # Extend this object only when needed and immediately redefine
-      # #method_missing so that the new version is used on all future calls.
-      extend(ext) if ext
-      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
+      m = first(sym)
+      return m if m
+      raise 'No match named "%s" in %s (%s)' % [sym, self, name]
     end
   end
 end

data/lib/citrus/debug.rb

@@ -13,10 +13,12 @@ module Citrus
         xml.instruct!
       end
 
+      attrs = { "names" => names.join(','), "text" => text, "offset" => offset }
+
       if matches.empty?
-        xml.match("name" => name, "text" => text, "offset" => offset)
+        xml.match(attrs)
       else
-        xml.match("name" => name, "text" => text, "offset" => offset) do
+        xml.match(attrs) do
           matches.each {|m| m.to_markup(xml) }
         end
       end

data/lib/citrus/file.rb

@@ -74,7 +74,7 @@ module Citrus
         end
 
         def values
-          choices.map {|s| s.value }
+          choices.map {|c| c.value }
         end
 
         def value
@@ -137,11 +137,7 @@ module Citrus
     end
 
     rule :primary do
-      any(:super, :alias, :rule_body_paren, :terminal) {
-        def value
-          first.value
-        end
-      }
+      any(:super, :alias, :rule_body_paren, :terminal)
     end
 
     rule :rule_body_paren do
@@ -205,7 +201,7 @@ module Citrus
     rule :terminal do
       any(:quoted_string, :character_class, :anything_symbol, :regular_expression) {
         def value
-          Rule.create(first.value)
+          Rule.create(super)
         end
       }
     end
@@ -243,11 +239,7 @@ module Citrus
     end
 
     rule :qualifier do
-      any(:and, :not, :label) {
-        def wrap(rule)
-          first.wrap(rule)
-        end
-      }
+      any(:and, :not, :label)
     end
 
     rule :and do
@@ -281,7 +273,7 @@ module Citrus
     rule :extension do
       any(:tag, :block) {
         def wrap(rule)
-          rule.ext = first.value
+          rule.ext = value
           rule
         end
       }
@@ -305,9 +297,6 @@ module Citrus
 
     rule :quantifier do
       any(:question, :plus, :repeat) {
-        def min; first.min end
-        def max; first.max end
-
         def wrap(rule)
           Repeat.new(min, max, rule)
         end

data/test/calc_file_test.rb

@@ -7,5 +7,5 @@ end
 Citrus.load(File.dirname(__FILE__) + '/../examples/calc')
 
 class CalcFileTest < Test::Unit::TestCase
-  include CalcTests
+  include CalcTestMethods
 end

data/test/calc_sugar_test.rb

@@ -7,5 +7,5 @@ end
 require File.dirname(__FILE__) + '/../examples/calc_sugar'
 
 class CalcSugarTest < Test::Unit::TestCase
-  include CalcTests
+  include CalcTestMethods
 end

data/test/calc_test.rb

@@ -7,5 +7,5 @@ end
 require File.dirname(__FILE__) + '/../examples/calc'
 
 class CalcTest < Test::Unit::TestCase
-  include CalcTests
+  include CalcTestMethods
 end

data/test/helper.rb

@@ -43,7 +43,7 @@ class Test::Unit::TestCase
     end
   end
 
-  module CalcTests
+  module CalcTestMethods
     def test_int
       match = Calc.parse('3')
       assert(match)

data/test/super_test.rb

@@ -51,11 +51,11 @@ class SuperTest < Test::Unit::TestCase
 
     match = grammar2.parse('a')
     assert(match)
-    assert_equal(:a, match.first.name)
+    assert_equal(:a, match.name)
 
     match = grammar2.parse('b')
     assert(match)
-    assert_equal(:b, match.first.name)
+    assert_equal(:b, match.name)
   end
 
   def test_to_s

metadata

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