kpeg 0.9.0 → 0.10.0

data/test/test_kpeg_code_generator.rb

@@ -14,6 +14,7 @@ class TestKPegCodeGenerator < MiniTest::Unit::TestCase
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = .
   def _root
@@ -24,6 +25,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", ".")
+  # :startdoc:
 end
     STR
 
@@ -43,6 +45,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = "hello"
   def _root
@@ -53,6 +56,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "\\\"hello\\\"")
+  # :startdoc:
 end
     STR
 
@@ -72,6 +76,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = /[0-9]/
   def _root
@@ -82,6 +87,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "/[0-9]/")
+  # :startdoc:
 end
     STR
 
@@ -104,6 +110,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = /./
   def _root
@@ -114,6 +121,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "/./")
+  # :startdoc:
 end
     STR
     else
@@ -121,6 +129,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = /./u
   def _root
@@ -131,6 +140,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "/./u")
+  # :startdoc:
 end
     STR
     end
@@ -151,6 +161,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = [a-z]
   def _root
@@ -168,6 +179,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "[a-z]")
+  # :startdoc:
 end
     STR
 
@@ -189,6 +201,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = [a-z] "hello"
   def _root
@@ -220,6 +233,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "[a-z] \\\"hello\\\"")
+  # :startdoc:
 end
     STR
 
@@ -242,6 +256,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = ("hello" | "world")
   def _root
@@ -263,6 +278,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "(\\\"hello\\\" | \\\"world\\\")")
+  # :startdoc:
 end
     STR
 
@@ -298,6 +314,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = "hello"?
   def _root
@@ -313,6 +330,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "\\\"hello\\\"?")
+  # :startdoc:
 end
     STR
 
@@ -347,6 +365,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = "hello"*
   def _root
@@ -361,6 +380,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "\\\"hello\\\"*")
+  # :startdoc:
 end
     STR
 
@@ -398,6 +418,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = "hello"+
   def _root
@@ -418,6 +439,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "\\\"hello\\\"+")
+  # :startdoc:
 end
     STR
 
@@ -462,6 +484,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = "hello"[5, 9]
   def _root
@@ -488,6 +511,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "\\\"hello\\\"[5, 9]")
+  # :startdoc:
 end
     STR
 
@@ -505,6 +529,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = "hello" "world"
   def _root
@@ -529,6 +554,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "\\\"hello\\\" \\\"world\\\"")
+  # :startdoc:
 end
     STR
 
@@ -561,6 +587,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = &"hello"
   def _root
@@ -573,6 +600,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "&\\\"hello\\\"")
+  # :startdoc:
 end
     STR
 
@@ -598,6 +626,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = &{ !defined? @fail }
   def _root
@@ -610,6 +639,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "&{ !defined? @fail }")
+  # :startdoc:
 end
     STR
 
@@ -636,6 +666,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = !"hello"
   def _root
@@ -649,6 +680,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "!\\\"hello\\\"")
+  # :startdoc:
 end
     STR
 
@@ -674,6 +706,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = !{ defined? @fail }
   def _root
@@ -687,6 +720,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "!{ defined? @fail }")
+  # :startdoc:
 end
     STR
 
@@ -715,6 +749,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # greeting = "hello"
   def _greeting
@@ -733,6 +768,7 @@ class Test < KPeg::CompiledParser
   Rules = {}
   Rules[:_greeting] = rule_info("greeting", "\\\"hello\\\"")
   Rules[:_root] = rule_info("root", "greeting")
+  # :startdoc:
 end
     STR
 
@@ -753,6 +789,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # greeting = "hello"
   def _greeting
@@ -771,6 +808,7 @@ class Test < KPeg::CompiledParser
   Rules = {}
   Rules[:_greeting] = rule_info("greeting", "\\\"hello\\\"")
   Rules[:_root] = rule_info("root", "@greeting")
+  # :startdoc:
 end
     STR
 
@@ -791,6 +829,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # greeting = "hello"
   def _greeting(a,b)
@@ -809,6 +848,7 @@ class Test < KPeg::CompiledParser
   Rules = {}
   Rules[:_greeting] = rule_info("greeting", "\\\"hello\\\"")
   Rules[:_root] = rule_info("root", "@greeting(1,2)")
+  # :startdoc:
 end
     STR
 
@@ -836,6 +876,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
   def setup_foreign_grammar
     @_grammar_blah = TestKPegCodeGenerator::TestParser.new(nil)
   end
@@ -849,6 +890,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "%blah.greeting")
+  # :startdoc:
 end
     STR
 
@@ -869,6 +911,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
   def setup_foreign_grammar
     @_grammar_blah = TestKPegCodeGenerator::TestParser.new(nil)
   end
@@ -882,6 +925,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "%blah.greeting2(1,2)")
+  # :startdoc:
 end
     STR
 
@@ -901,6 +945,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = "hello":t
   def _root
@@ -912,6 +957,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "\\\"hello\\\":t")
+  # :startdoc:
 end
     STR
 
@@ -929,6 +975,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = "hello"
   def _root
@@ -939,6 +986,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "\\\"hello\\\"")
+  # :startdoc:
 end
     STR
 
@@ -957,6 +1005,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # hello = < "hello" > {text}
   def _hello
@@ -1016,6 +1065,7 @@ class Test < KPeg::CompiledParser
   Rules = {}
   Rules[:_hello] = rule_info("hello", "< \\\"hello\\\" > {text}")
   Rules[:_root] = rule_info("root", "hello?:lots {lots}")
+  # :startdoc:
 end
     STR
 
@@ -1043,6 +1093,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # hello = < "hello" > {text}
   def _hello
@@ -1103,6 +1154,7 @@ class Test < KPeg::CompiledParser
   Rules = {}
   Rules[:_hello] = rule_info("hello", "< \\\"hello\\\" > {text}")
   Rules[:_root] = rule_info("root", "hello*:lots {lots}")
+  # :startdoc:
 end
     STR
 
@@ -1133,6 +1185,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # hello = < "hello" > {text}
   def _hello
@@ -1200,6 +1253,7 @@ class Test < KPeg::CompiledParser
   Rules = {}
   Rules[:_hello] = rule_info("hello", "< \\\"hello\\\" > {text}")
   Rules[:_root] = rule_info("root", "hello+:lots {lots}")
+  # :startdoc:
 end
     STR
 
@@ -1228,6 +1282,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = {3 + 4}
   def _root
@@ -1239,6 +1294,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "{3 + 4}")
+  # :startdoc:
 end
     STR
 
@@ -1260,6 +1316,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = < "hello" > { text }
   def _root
@@ -1289,6 +1346,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "< \\\"hello\\\" > { text }")
+  # :startdoc:
 end
     STR
 
@@ -1310,6 +1368,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = @< "hello" > { bounds }
   def _root
@@ -1339,6 +1398,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", "@< \\\"hello\\\" > { bounds }")
+  # :startdoc:
 end
     STR
 
@@ -1351,6 +1411,28 @@ end
     assert_equal [0,5], code.result
   end
 
+  def test_standalone_region
+    gram = KPeg.grammar do |g|
+      g.root = g.dot
+    end
+
+    cg = KPeg::CodeGenerator.new "Test", gram
+
+    expected = <<-EXPECTED
+
+    # This is distinct from setup_parser so that a standalone parser
+    # can redefine #initialize and still have access to the proper
+    # parser setup code.
+    def initialize(str, debug=false)
+      setup_parser(str, debug)
+    end
+
+    EXPECTED
+
+    assert_equal expected,
+                 cg.standalone_region('compiled_parser.rb', 'INITIALIZE')
+  end
+
   def test_parse_error
     gram = KPeg.grammar do |g|
       g.world = "world"
@@ -1380,6 +1462,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = .
   def _root
@@ -1390,6 +1473,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", ".")
+  # :startdoc:
 end
 
 # require 'some/subclass'
@@ -1413,6 +1497,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   # root = .
   def _root
@@ -1423,6 +1508,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", ".")
+  # :startdoc:
 end
     STR
 
@@ -1433,6 +1519,51 @@ end
     assert cg.parse("hello")
   end
 
+  def test_directive_pre_class
+    gram = KPeg.grammar do |g|
+      g.root = g.dot
+      g.directives['pre-class'] = g.action("\n# some comment\n")
+    end
+
+    str = <<-STR
+require 'kpeg/compiled_parser'
+
+# some comment
+class Test < KPeg::CompiledParser
+  # :stopdoc:
+
+  # root = .
+  def _root
+    _tmp = get_byte
+    set_failed_rule :_root unless _tmp
+    return _tmp
+  end
+
+  Rules = {}
+  Rules[:_root] = rule_info("root", ".")
+  # :startdoc:
+end
+    STR
+
+    cg = KPeg::CodeGenerator.new "Test", gram
+
+    assert_equal str, cg.output
+
+    assert cg.parse("hello")
+  end
+
+  def test_directive_pre_class_standalone
+    gram = KPeg.grammar do |g|
+      g.root = g.dot
+      g.directives['pre-class'] = g.action("\n# some comment\n")
+    end
+
+    cg = KPeg::CodeGenerator.new "Test", gram
+    cg.standalone = true
+
+    assert_match %r%^# some comment%, cg.output
+  end
+
   def test_setup_actions
     gram = KPeg.grammar do |g|
       g.root = g.dot
@@ -1446,6 +1577,7 @@ class Test < KPeg::CompiledParser
 
  attr_reader :foo 
 
+  # :stopdoc:
 
   # root = .
   def _root
@@ -1456,6 +1588,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", ".")
+  # :startdoc:
 end
     STR
 
@@ -1466,6 +1599,35 @@ end
     assert cg.parse("hello")
   end
 
+  def test_output_standalone
+    gram = KPeg.grammar do |g|
+      g.root = g.dot
+    end
+
+    cg = KPeg::CodeGenerator.new "Test", gram
+    cg.standalone = true
+
+    # if this fails, also change test_variable_custom_initialize
+    assert_match 'def initialize(str, debug=false)', cg.output
+
+    assert_match '# :stopdoc:', cg.output
+    assert_match '# :startdoc:', cg.output
+
+    assert cg.parse("hello")
+  end
+
+  def test_variable_custom_initialize
+    gram = KPeg.grammar do |g|
+      g.root = g.dot
+      g.variables['custom_initialize'] = 'whatever'
+    end
+
+    cg = KPeg::CodeGenerator.new "Test", gram
+    cg.standalone = true
+
+    refute_match 'def initialize(str, debug=false)', cg.output
+  end
+
   def test_ast_generation
     gram = KPeg.grammar do |g|
       g.root = g.dot
@@ -1478,6 +1640,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   module AST
     class Node; end
@@ -1517,6 +1680,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", ".")
+  # :startdoc:
 end
     STR
 
@@ -1538,6 +1702,7 @@ end
 require 'kpeg/compiled_parser'
 
 class Test < KPeg::CompiledParser
+  # :stopdoc:
 
   module MegaAST
     class Node; end
@@ -1563,6 +1728,7 @@ class Test < KPeg::CompiledParser
 
   Rules = {}
   Rules[:_root] = rule_info("root", ".")
+  # :startdoc:
 end
     STR