citrus 1.0.0 → 1.1.0

data/citrus.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'citrus'
-  s.version = '1.0.0'
-  s.date = '2010-05-13'
+  s.version = '1.1.0'
+  s.date = '2010-05-18'
 
   s.summary = 'Parsing Expressions for Ruby'
   s.description = 'Parsing Expressions for Ruby'
@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
 
   s.files = Dir['lib/**/*.rb'] +
     Dir['examples/**/*'] +
+    Dir['extras/**/*'] +
     Dir['test/*.rb'] +
     %w< citrus.gemspec Rakefile README >
 

data/examples/calc_sugar.rb

@@ -4,7 +4,6 @@ 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

data/extras/citrus.vim

@@ -0,0 +1,92 @@
+" Vim syntax file for Citrus grammars.
+"
+" Language: Citrus
+" Author: Michael Jackson
+
+if version < 600
+  syntax clear
+elseif exists("b:current_syntax")
+  finish
+endif
+
+syn include @rubyTop syntax/ruby.vim
+
+syn case match
+
+syn match ctDoubleColon "::" contained
+syn match ctConstant "\u\w*" contained
+syn match ctVariable "\l\w*" contained
+syn match ctModule "\(\(::\)\?\u\w*\)\+" contains=ctDoubleColon,ctConstant contained
+
+" Comments
+syn match ctComment "#.*" contains=@Spell
+
+" Keywords
+syn match ctKeyword "\<super\>" contained
+
+" Terminals
+syn region ctString matchgroup=ctStringDelimiter start="\"" end="\"" skip="\\\\\|\\\"" contains=@ctStringSpecial
+syn region ctString matchgroup=ctStringDelimiter start="'" end="'" skip="\\\\\|\\'"
+syn region ctRegexp matchgroup=ctRegexpDelimiter start="/" end="/[iomxneus]*" skip="\\\\\|\\/" contains=@ctRegexpSpecial contained display
+syn region ctCharClass matchgroup=ctRegexpDelimiter start="\[" end="\]" skip="\\\\\|\\\[" contains=@ctRegexpSpecial contained display
+syn match ctAnything "\." contained display
+
+syn cluster ctStringSpecial contains=rubyStringEscape
+syn cluster ctRegexpSpecial contains=rubyStringEscape,rubyRegexpSpecial,rubyRegexpEscape,rubyRegexpBrackets,rubyRegexpCharClass,rubyRegexpDot,rubyRegexpQuantifier,rubyRegexpAnchor,rubyRegexpParens,rubyRegexpComment
+
+" Quantifiers
+syn match ctQuantifier "+" contained display
+syn match ctQuantifier "?" contained display
+syn match ctQuantifier "\d*\*\d*" contained display
+
+" Operators
+syn match ctOperator "|" contained
+syn match ctOperator "\l\w*:"me=e-1 contained
+
+" Extensions
+syn region ctRubyBlock start="{"ms=e+1 end="}"me=s-1 contains=@rubyTop contained
+syn match ctTag "<\s*\(\(::\)\?\u\w*\)\+\s*>" contains=ctModule contained
+
+" Declarations
+syn match ctRequire "\<require\>" nextgroup=ctString skipwhite skipnl
+syn match ctGrammar "\<grammar\>" nextgroup=ctModule skipwhite skipnl
+syn match ctInclude "\<include\>" nextgroup=ctModule skipwhite skipnl contained
+syn match ctRoot    "\<root\>"    nextgroup=ctVariable skipwhite skipnl contained
+syn match ctRule    "\<rule\>"    nextgroup=ctVariable skipwhite skipnl contained
+
+" Blocks
+syn region ctGrammarBlock start="\<grammar\>" matchgroup=ctGrammar end="\<end\>" contains=ctComment,ctGrammar,ctInclude,ctRoot,ctRuleBlock fold
+syn region ctRuleBlock start="\<rule\>" matchgroup=ctRule end="\<end\>" contains=ALLBUT,ctRequire,ctGrammar,ctInclude,ctRoot,ctConstant,ctVariable fold
+
+" Groups
+hi def link ctComment       Comment
+
+hi def link ctRequire       Include
+hi def link ctInclude       Include
+hi def link ctGrammar       ctDefine
+hi def link ctRoot          ctDefine
+hi def link ctRule          ctDefine
+hi def link ctDefine        Define
+
+hi def link ctConstant      Type
+hi def link ctVariable      Function
+hi def link ctKeyword       Keyword
+
+hi def link ctString        ctTerminal
+hi def link ctRegexp        ctTerminal
+hi def link ctCharClass     ctTerminal
+hi def link ctAnything      ctTerminal
+hi def link ctTerminal      String
+
+hi def link ctRegexpDelimiter ctStringDelimiter
+hi def link ctStringDelimiter Delimiter
+
+hi def link ctRegexpSpecial  ctStringSpecial
+hi def link ctStringSpecial  Special
+
+hi def link ctQuantifier    ctOperator
+hi def link ctOperator      Operator
+
+let b:current_syntax = "citrus"
+
+" vim: nowrap:

data/lib/citrus.rb

@@ -4,29 +4,31 @@
 #
 # http://github.com/mjijackson/citrus
 module Citrus
-  VERSION = [1, 0, 0]
+  VERSION = [1, 1, 0]
 
   Infinity = 1.0 / 0
 
-  autoload 'PEG', 'citrus/peg'
+  autoload 'File', 'citrus/file'
 
   # Returns the current version of Citrus as a string.
   def self.version
     VERSION.join('.')
   end
 
+  F = ::File
+
   # Loads the grammar from the given +file+ into the global scope using #eval.
   def self.load(file)
-    file << '.citrus' unless File.file?(file)
-    raise "Cannot find file #{file}" unless File.file?(file)
-    raise "Cannot read file #{file}" unless File.readable?(file)
-    self.eval(File.read(file))
+    file << '.citrus' unless F.file?(file)
+    raise "Cannot find file #{file}" unless F.file?(file)
+    raise "Cannot read file #{file}" unless F.readable?(file)
+    self.eval(F.read(file))
   end
 
   # Evaluates the given Citrus parsing expression grammar +code+ in the global
   # scope. Returns an array of any grammar modules that were created.
   def self.eval(code)
-    file = PEG.parse(code)
+    file = File.parse(code)
     file.value
   end
 
@@ -63,19 +65,15 @@ module Citrus
   # module is in fact a grammar.
   module Grammar
     # Creates a new anonymous module that includes Grammar. If a +block+ is
-    # provided, it will be called with the new module as its first argument if
-    # its +arity+ is 1 or +instance_eval+'d in the context of the new module
-    # otherwise. See http://blog.grayproductions.net/articles/dsl_block_styles
-    # for the rationale behind this decision.
-    #
-    # Grammars created with this method may be assigned a name by being assigned
-    # to some constant, e.g.:
+    # provided, it is +module_eval+'d in the context of the new module. Grammars
+    # created with this method may be assigned a name by being assigned to some
+    # constant, e.g.:
     #
     #     Calc = Grammar.new {}
     #
     def self.new(&block)
       mod = Module.new { include Grammar }
-      block.arity == 1 ? block[mod] : mod.instance_eval(&block) if block
+      mod.module_eval(&block) if block
       mod
     end
 
@@ -888,7 +886,7 @@ module Citrus
 
     # Checks equality by comparing this match's #text value to +obj+.
     def ==(obj)
-      text == obj
+      obj == text
     end
 
     alias eql? ==

data/lib/citrus/{peg.rb → file.rb}

@@ -1,11 +1,10 @@
 require 'citrus'
 
 module Citrus
-  # A grammar for Citrus-flavored parsing expression grammars. This module is
-  # used in Citrus#eval to parse and evaluate Citrus PEG's and serves as a prime
-  # example of how to create a complex grammar complete with semantic
-  # interpretation in pure Ruby.
-  module PEG
+  # A grammar for Citrus grammar files. This module 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.
+  module File
     include Grammar
 
     ## Hierarchical syntax
@@ -356,7 +355,6 @@ module Citrus
     rule :require_keyword,  [ 'require', :space ]
     rule :include_keyword,  [ 'include', :space ]
     rule :grammar_keyword,  [ 'grammar', :space ]
-    rule :super_keyword,    [ 'super', :space ]
     rule :root_keyword,     [ 'root', :space ]
     rule :rule_keyword,     [ 'rule', :space ]
     rule :end_keyword,      [ 'end', :space ]

data/test/calc_peg_test.rb

@@ -1,4 +1,9 @@
 require File.dirname(__FILE__) + '/helper'
+
+if defined?(Calc)
+  Object.__send__(:remove_const, :Calc)
+end
+
 Citrus.load(File.dirname(__FILE__) + '/../examples/calc')
 
 class CalcPEGTest < Test::Unit::TestCase

data/test/calc_sugar_test.rb

@@ -1,4 +1,9 @@
 require File.dirname(__FILE__) + '/helper'
+
+if defined?(Calc)
+  Object.__send__(:remove_const, :Calc)
+end
+
 require File.dirname(__FILE__) + '/../examples/calc_sugar'
 
 class CalcSugarTest < Test::Unit::TestCase

data/test/calc_test.rb

@@ -1,4 +1,9 @@
 require File.dirname(__FILE__) + '/helper'
+
+if defined?(Calc)
+  Object.__send__(:remove_const, :Calc)
+end
+
 require File.dirname(__FILE__) + '/../examples/calc'
 
 class CalcTest < Test::Unit::TestCase

data/test/{peg_test.rb → file_test.rb}

@@ -1,42 +1,40 @@
 require File.dirname(__FILE__) + '/helper'
-require 'citrus/peg'
+require 'citrus/file'
 
-class PEGTest < Test::Unit::TestCase
+class CitrusFileTest < Test::Unit::TestCase
 
   # A shortcut for creating a grammar that includes Citrus::PEG but uses a
   # different root.
   def peg(root_rule)
     Grammar.new {
-      include Citrus::PEG
+      include Citrus::File
       root root_rule
     }
   end
 
-
   ## File tests
 
+  F = ::File
 
   def run_file_test(file, root)
     grammar = peg(root)
-    code = File.read(file)
+    code = F.read(file)
     match = grammar.parse(code)
     assert(match)
   end
 
   %w< rule grammar >.each do |type|
-    Dir[File.dirname(__FILE__) + "/_files/#{type}*.citrus"].each do |path|
+    Dir[F.dirname(__FILE__) + "/_files/#{type}*.citrus"].each do |path|
       module_eval(<<-RUBY.gsub(/^        /, ''), __FILE__, __LINE__ + 1)
-        def test_#{File.basename(path, '.citrus')}
+        def test_#{F.basename(path, '.citrus')}
           run_file_test("#{path}", :#{type})
         end
       RUBY
     end
   end
 
-
   ## Hierarchical syntax
 
-
   def test_rule_body
     grammar = peg(:rule_body)
 

data/test/grammar_test.rb

@@ -3,9 +3,9 @@ require File.dirname(__FILE__) + '/helper'
 class GrammarTest < Test::Unit::TestCase
 
   def test_new
-    Grammar.new do |g|
-      assert_kind_of(Module, g)
-      assert(g.include?(Grammar))
+    Grammar.new do
+      assert_kind_of(Module, self)
+      assert(include?(Grammar))
     end
   end
 

data/test/match_test.rb

@@ -49,6 +49,18 @@ class MatchTest < Test::Unit::TestCase
     assert_equal(11, match.length)
   end
 
+  def test_equality
+    match1 = Match.new('a')
+    match2 = Match.new('a')
+    assert(match1 == 'a')
+    assert(match1 == match2)
+    assert(match2 == match1)
+
+    match3 = Match.new('b')
+    assert_equal(false, match1 == match3)
+    assert_equal(false, match3 == match1)
+  end
+
   def test_matches
     match = Double.parse('123')
     assert(match)

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Michael Jackson
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-13 00:00:00 -06:00
+date: 2010-05-18 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,12 +51,13 @@ extra_rdoc_files:
 - README
 files: 
 - lib/citrus/debug.rb
-- lib/citrus/peg.rb
+- lib/citrus/file.rb
 - lib/citrus/sugar.rb
 - lib/citrus.rb
 - examples/calc.citrus
 - examples/calc.rb
 - examples/calc_sugar.rb
+- extras/citrus.vim
 - test/alias_test.rb
 - test/and_predicate_test.rb
 - test/calc_peg_test.rb
@@ -64,13 +65,13 @@ files:
 - test/calc_test.rb
 - test/choice_test.rb
 - test/expression_test.rb
+- test/file_test.rb
 - test/fixed_width_test.rb
 - test/grammar_test.rb
 - test/helper.rb
 - test/label_test.rb
 - test/match_test.rb
 - test/not_predicate_test.rb
-- test/peg_test.rb
 - test/repeat_test.rb
 - test/rule_test.rb
 - test/sequence_test.rb
@@ -121,12 +122,12 @@ test_files:
 - test/calc_test.rb
 - test/choice_test.rb
 - test/expression_test.rb
+- test/file_test.rb
 - test/fixed_width_test.rb
 - test/grammar_test.rb
 - test/label_test.rb
 - test/match_test.rb
 - test/not_predicate_test.rb
-- test/peg_test.rb
 - test/repeat_test.rb
 - test/rule_test.rb
 - test/sequence_test.rb