walrus 0.1

data/spec/acceptance/raw/complicated_raw_example.tmpl

@@ -0,0 +1,79 @@
+This example demonstrates a number of different uses of the \#raw directive.
+In this paragraph if I want to use characters that have a special meaning for
+Walrus then I have to escape them (example, a \$placeholder, a \#directive, an
+\\\$ escape sequence).
+
+#raw
+But this paragraph is different, it is inside a #raw block.
+I can do anything at all in the #raw block without having to escape it.
+For example, use Walrus directives:
+	#super, #set a = b
+Use placeholders:
+	$a, $b, $c
+Use backslashes:
+	\n, \t, \m, \n, \o
+#end
+
+#raw
+This paragraph is another example where the closing marker is not
+on a new line of it's own...#end
+
+#raw#This is an example where I use an explicit directive-closing marker (#) so that
+I can start my #raw content on the same line as the opening directive. I can do the
+same trick with the closing directive so that my text can continue on on the same
+line...#end# See?
+
+#raw <<HERE
+This paragraph uses a "here document". That means I can include a literal #end directive
+in it without it causing the block to come to an end. Here we see the block continuing
+and I can still use $placeholders and #directives without them having any special meaning.
+The end marker (in this case "HERE") must be the first and last thing on the line in order
+for it to be detected. All other uses of the end marker go through literally with no
+special meaning.
+HERE
+
+#raw
+There is no way to include a literal end directive in a #raw block without the help of
+a "here document". You can't escape the end directive for example, because the escape
+character (\) has no special meaning in a #raw block. Notice that if I try it it won't
+work:\#end
+
+I am now outside the \#raw block because the \#end directive was interpreted as an end marker
+despite my attempt to escape it.
+
+#raw <<-THERE
+This is an example of an alternative "here document" syntax. The hyphen means that you can
+precede the end marker with whitespace. Note that if the marker (in this case "THERE") is
+preceded by non-whitespace characters on the same line then it has no special meaning: THERE
+Likewise, if it is followed by such characters then it has no meaning either....
+THERE... we keep going because "THERE" wasn't the last thing on the line.
+   THERE
+
+#raw <<ANOTHER
+Trailing whitespace is acceptable after the end marker, but it is not included in the output.
+ANOTHER            
+
+#raw <<-YET_ANOTHER
+The same is true when using the alternative syntax.
+   YET_ANOTHER       
+
+#raw <<BAZ     
+In fact, trailing whitespace is acceptable when first opening the here document too, but it
+is ignored
+BAZ
+
+#raw <<-BAZ     
+THe same is true for the alternate syntax.
+   BAZ
+
+#raw <<-FOOBAR
+Note that when using the alternative "here document" syntax the optional whitespace before the
+end marker truly is optional; that is, the end marker can be the first thing on the line if
+you want it to. (Although if that's the case you may as well use the first syntax.)
+FOOBAR
+
+#raw
+In this example I am going to use some multi-byte characters:
+€áéíóú
+àèìòù
+#end

data/spec/acceptance/raw-text/UTF_8.expected

@@ -0,0 +1,12 @@
+This is a simple template that contains some non-ASCII characters.
+
+Cañon, información, pengüino, Alcalá, élite, ícono, €, ©, ¿?, ¡!, ªº
+
+áéíúó
+ ÁÉÍÓÚ
+  äëïöü
+   ÄËÏÖÜ
+  àèìòù
+ ÀÈÌÙÒ
+  âêîôû
+   ÂÊÎÔÛ

data/spec/acceptance/raw-text/UTF_8.tmpl

@@ -0,0 +1,12 @@
+This is a simple template that contains some non-ASCII characters.
+
+Cañon, información, pengüino, Alcalá, élite, ícono, €, ©, ¿?, ¡!, ªº
+
+áéíúó
+ ÁÉÍÓÚ
+  äëïöü
+   ÄËÏÖÜ
+  àèìòù
+ ÀÈÌÙÒ
+  âêîôû
+   ÂÊÎÔÛ

data/spec/acceptance/raw-text/multi_line.expected

@@ -0,0 +1,4 @@
+This is a basic template containing a number of lines.
+Second line.
+   Third line.
+      Fourth line with trailing whitespace...       

data/spec/acceptance/raw-text/multi_line.tmpl

@@ -0,0 +1,4 @@
+This is a basic template containing a number of lines.
+Second line.
+   Third line.
+      Fourth line with trailing whitespace...       

data/spec/acceptance/raw-text/single_line.expected

@@ -0,0 +1 @@
+This is a basic template containing only a single line.

data/spec/acceptance/raw-text/single_line.tmpl

@@ -0,0 +1 @@
+This is a basic template containing only a single line.

data/spec/acceptance/raw-text/single_line_whitespace.expected

@@ -0,0 +1 @@
+    This is a single-line template with whitespace on the left and right; this is a tab:	

data/spec/acceptance/raw-text/single_line_whitespace.tmpl

@@ -0,0 +1 @@
+    This is a single-line template with whitespace on the left and right; this is a tab:	

data/spec/acceptance/ruby/ruby_directive_is_just_like_silent.expected

@@ -0,0 +1 @@
+the secret ivar is foo

data/spec/acceptance/ruby/ruby_directive_is_just_like_silent.tmpl

@@ -0,0 +1,4 @@
+#ruby
+  @secret_ivar = 'foo'
+#end
+#echo 'the secret ivar is '; @secret_ivar

data/spec/acceptance/ruby/ruby_directive_using_here_doc.expected

@@ -0,0 +1 @@
+I can use a literal #end in this one

data/spec/acceptance/ruby/ruby_directive_using_here_doc.tmpl

@@ -0,0 +1,4 @@
+#ruby <<HERE
+  accumulate 'I can use a literal #end in this one'
+  #end, #end, and #end again...
+HERE

data/spec/acceptance/ruby/ruby_directive_using_here_doc_alt_syntax.expected

@@ -0,0 +1 @@
+I can use a literal #end in this one

data/spec/acceptance/ruby/ruby_directive_using_here_doc_alt_syntax.tmpl

@@ -0,0 +1,4 @@
+#ruby <<-HERE
+  accumulate 'I can use a literal #end in this one'
+  #end, #end, and #end again...
+		HERE

data/spec/acceptance/ruby/ruby_directive_with_accumulate.expected

@@ -0,0 +1 @@
+Hello, world!

data/spec/acceptance/ruby/ruby_directive_with_accumulate.tmpl

@@ -0,0 +1,4 @@
+#ruby
+  # You can explicitly use the accumulate method if you want to produce output from inside a #ruby block
+  accumulate 'Hello, world!'
+#end

data/spec/acceptance/ruby/ruby_directive_with_accumulate_and_block.expected

@@ -0,0 +1 @@
+Hello, world!

data/spec/acceptance/ruby/ruby_directive_with_accumulate_and_block.tmpl

@@ -0,0 +1,6 @@
+#ruby
+  # You can explicitly use the accumulate method if you want to produce output from inside a #ruby block
+  accumulate do
+    'Hello, world!'
+  end
+#end

data/spec/acceptance/set/unused_set.tmpl

@@ -0,0 +1 @@
+#set $foo = 'bar'

data/spec/acceptance/set/used_set.expected

@@ -0,0 +1 @@
+bar

data/spec/acceptance/set/used_set.tmpl

@@ -0,0 +1,2 @@
+#set $foo = 'bar'
+$foo

data/spec/acceptance/silent/silent_and_echo_combined.expected

@@ -0,0 +1 @@
+the secret ivar is foo

data/spec/acceptance/silent/silent_and_echo_combined.tmpl

@@ -0,0 +1,2 @@
+#silent @secret_ivar = 'foo'
+#echo 'the secret ivar is '; @secret_ivar

data/spec/acceptance/silent/silent_short_notation.expected

@@ -0,0 +1 @@
+the secret ivar is foo

data/spec/acceptance/silent/silent_short_notation.tmpl

@@ -0,0 +1 @@
+# @secret_ivar = 'foo' ##echo 'the secret ivar is '; @secret_ivar

data/spec/acceptance/silent/simple_silent_directive.tmpl

@@ -0,0 +1 @@
+#silent 'foo'

data/spec/acceptance/slurp/basic_slurp_demo.expected

@@ -0,0 +1 @@
+The #slurp directive can be used to gobble up a trailing newline. This template consists of several lines of text, but thanks to the use of the #slurp directive the newlines are all gobbled up and the final output appears all on one line.

data/spec/acceptance/slurp/basic_slurp_demo.tmpl

@@ -0,0 +1,4 @@
+The \#slurp directive can be used to gobble up a trailing newline. #slurp
+This template consists of several lines of text, but thanks to the #slurp
+use of the \#slurp directive the newlines are all gobbled up and #slurp
+the final output appears all on one line.

data/spec/acceptance/super/super_with_no_effect.expected

@@ -0,0 +1,4 @@
+By default, text which appears in a template is considered to be part of the "template_body" block.
+In the Document superclass from which all compiled templates ultimately inherit, the "template_body"
+block is empty (it emits nothing). So, if I call #super from within the top-level of this template
+it will have no effect on the output.

data/spec/acceptance/super/super_with_no_effect.tmpl

@@ -0,0 +1,5 @@
+By default, text which appears in a template is considered to be part of the "template_body" block.
+In the Document superclass from which all compiled templates ultimately inherit, the "template_body"
+block is empty (it emits nothing). So, if I call \#super from within the top-level of this template
+it will have no effect on the output.
+#super

data/spec/additions/module_spec.rb

@@ -0,0 +1,126 @@
+# Copyright 2007 Wincent Colaiuta
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# in the accompanying file, "LICENSE.txt", for more details.
+#
+# $Id: /mirrors/Walrus/trunk/walrus/spec/additions/module_spec.rb 6702 2007-04-09T15:04:40.448669Z wincent  $
+
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
+module Walrus
+  
+  class ByCopyAccessDemo
+    attr_bycopy           :foo
+    attr_bycopy           :bar, false
+    attr_bycopy           :baz, true
+    attr_writer_bycopy    :beta
+    attr_accessor_bycopy  :gamma
+    attr_writer_bycopy    :beta2, :beta3
+    attr_accessor_bycopy  :gamma2, :gamma3
+  end
+  
+  describe 'using "by copy" accessors' do
+    
+    setup do
+      @instance = ByCopyAccessDemo.new
+    end
+    
+    it 'those accessors should be "private"' do
+      lambda { ByCopyAccessDemo.attr_bycopy :hello }.should raise_error(NoMethodError)
+      lambda { ByCopyAccessDemo.attr_writer_bycopy :hello }.should raise_error(NoMethodError)
+      lambda { ByCopyAccessDemo.attr_accessor_bycopy :hello }.should raise_error(NoMethodError)
+    end
+    
+    it 'should accept "normal" objects like String, making copies of them' do
+      
+      # original values
+      foo     = "hello"
+      bar     = "world"
+      baz     = "..."
+      beta    = "abc"
+      gamma   = "def"
+      beta2   = "ghi"
+      beta3   = "jkl"
+      gamma2  = "mno"
+      gamma3  = "pqr"
+      
+      # assignments
+      lambda { @instance.foo = foo }.should raise_error(NoMethodError) # no writer defined
+      lambda { @instance.bar = bar }.should raise_error(NoMethodError) # no writer defined
+      @instance.baz     = baz
+      @instance.beta    = beta
+      @instance.gamma   = gamma
+      @instance.beta2   = beta2
+      @instance.beta3   = beta3
+      @instance.gamma2  = gamma2
+      @instance.gamma3  = gamma3
+      
+      # check equality
+      @instance.baz.should == baz
+      @instance.instance_eval { @beta }.should  == beta   # no reader defined
+      @instance.gamma.should == gamma
+      @instance.instance_eval { @beta2 }.should == beta2  # no reader defined
+      @instance.instance_eval { @beta3 }.should == beta3  # no reader defined
+      @instance.gamma2.should == gamma2
+      @instance.gamma3.should == gamma3
+      
+      # check that copies were made
+      @instance.baz.object_id.should_not == baz.object_id
+      @instance.instance_eval { @beta }.object_id.should_not == beta.object_id    # no reader defined
+      @instance.gamma.object_id.should_not == gamma.object_id
+      @instance.instance_eval { @beta2 }.object_id.should_not == beta2.object_id  # no reader defined
+      @instance.instance_eval { @beta3 }.object_id.should_not == beta3.object_id  # no reader defined
+      @instance.gamma2.object_id.should_not == gamma2.object_id
+      @instance.gamma3.object_id.should_not == gamma3.object_id
+      
+    end
+    
+    it 'should accept non-copyable objects like instances of Nil, Symbol and Fixnum' do
+      
+      # original values
+      foo     = nil
+      bar     = 1
+      baz     = 2
+      beta    = 3
+      gamma   = 4
+      beta2   = nil
+      beta3   = 5
+      gamma2  = nil
+      gamma3  = :symbol
+      
+      # assignments
+      lambda { @instance.foo = foo }.should raise_error(NoMethodError) # no writer defined
+      lambda { @instance.bar = bar }.should raise_error(NoMethodError) # no writer defined
+      @instance.baz     = baz
+      @instance.beta    = beta
+      @instance.gamma   = gamma
+      @instance.beta2   = beta2
+      @instance.beta3   = beta3
+      @instance.gamma2  = gamma2
+      @instance.gamma3  = gamma3
+      
+      # check equality
+      @instance.baz.should == baz
+      @instance.instance_eval { @beta }.should == beta    # no reader defined
+      @instance.gamma.should == gamma
+      @instance.instance_eval { @beta2 }.should == beta2  # no reader defined
+      @instance.instance_eval { @beta3 }.should == beta3  # no reader defined
+      @instance.gamma2.should == gamma2
+      @instance.gamma3.should == gamma3
+      
+      # check that copies were not made
+      @instance.baz.object_id.should == baz.object_id
+      @instance.instance_eval { @beta }.object_id.should == beta.object_id    # no reader defined
+      @instance.gamma.object_id.should == gamma.object_id
+      @instance.instance_eval { @beta2 }.object_id.should == beta2.object_id  # no reader defined
+      @instance.instance_eval { @beta3 }.object_id.should == beta3.object_id  # no reader defined
+      @instance.gamma2.object_id.should == gamma2.object_id
+      @instance.gamma3.object_id.should == gamma3.object_id
+      
+    end
+    
+  end
+  
+end
+

data/spec/additions/string_spec.rb

@@ -0,0 +1,99 @@
+# Copyright 2007 Wincent Colaiuta
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# in the accompanying file, "LICENSE.txt", for more details.
+#
+# $Id: /mirrors/Walrus/trunk/walrus/spec/additions/string_spec.rb 6702 2007-04-09T15:04:40.448669Z wincent  $
+
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
+describe 'converting from class names to require names' do
+  
+  it 'should work with single letters' do
+    'A'.to_require_name.should == 'a'
+  end
+  
+  it 'should work with runs of capitals' do
+    'EOLToken'.to_require_name.should == 'eol_token'
+  end
+  
+  it 'should work with consecutive underscores' do
+    'EOL__Token'.to_require_name.should == 'eol__token'
+    'EOL__token'.to_require_name.should == 'eol__token'
+    'Eol__Token'.to_require_name.should == 'eol__token'
+    'Eol__token'.to_require_name.should == 'eol__token'
+  end
+  
+  it 'should work with trailing underscores' do
+    'EOL__'.to_require_name.should == 'eol__'
+    'Eol__'.to_require_name.should == 'eol__'
+  end
+  
+  it 'should work with standard classnames' do
+    'Foo'.to_require_name.should == 'foo'
+    'MyURLHandler'.to_require_name.should == 'my_url_handler'
+    'Signals37'.to_require_name.should == 'signals_37'
+    'MyClass'.to_require_name.should == 'my_class'
+    'Foo_bar'.to_require_name.should == 'foo_bar'
+    'C99case'.to_require_name.should == 'c_99_case'
+    'EOL99doFun'.to_require_name.should == 'eol_99_do_fun'
+    'Foo_Bar'.to_require_name.should == 'foo_bar'
+  end
+  
+end
+
+describe 'converting from require names to class names' do
+  
+  it 'should work with standard case' do
+    'foo_bar'.to_class_name.should == 'FooBar'
+  end
+  
+  it 'should work with single-letter' do
+    'f'.to_class_name.should == 'F'
+  end
+  
+  it 'should work with double-underscores' do
+    'foo__bar'.to_class_name.should == 'FooBar'
+  end
+  
+  it 'should work with terminating double-underscores' do
+    'foo__'.to_class_name.should == 'Foo'
+  end
+  
+  it "shouldn't preserve uppercase acronym information lost on the conversion from class name to require name" do
+    'eol_token'.to_class_name.should == 'EolToken'
+  end
+  
+end
+
+describe 'converting to source strings' do
+  
+  it 'standard strings should be unchanged' do
+    ''.to_source_string.should == ''
+    'hello world'.to_source_string.should == 'hello world'
+    "hello\nworld".to_source_string.should == "hello\nworld"
+  end
+  
+  it 'single quotes should be escaped' do
+    "'foo'".to_source_string.should == "\\'foo\\'"
+  end
+  
+  it 'backslashes should be escaped' do
+    'hello\\nworld'.to_source_string.should == "hello\\\\nworld"
+  end
+  
+  it 'should work with Unicode characters' do
+    '€ información…'.to_source_string.should == '€ información…'
+  end
+  
+  it 'should be able to round trip' do
+    eval("'" + ''.to_source_string + "'").should == ''
+    eval("'" + 'hello world'.to_source_string + "'").should == 'hello world'
+    eval("'" + "hello\nworld".to_source_string + "'").should == "hello\nworld"
+    eval("'" + "'foo'".to_source_string + "'").should == '\'foo\''
+    eval("'" + 'hello\\nworld'.to_source_string + "'").should == 'hello\\nworld'
+    eval("'" + '€ información…'.to_source_string + "'").should == '€ información…'
+  end
+  
+end

data/spec/compiler_spec.rb

@@ -0,0 +1,55 @@
+# Copyright 2007 Wincent Colaiuta
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# in the accompanying file, "LICENSE.txt", for more details.
+#
+# $Id: /mirrors/Walrus/trunk/walrus/spec/compiler_spec.rb 6720 2007-04-10T15:33:38.497892Z wincent  $
+
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+require 'walrus/parser' # ensure that WalrusGrammar is defined before continuing
+
+module Walrus
+  
+  class WalrusGrammar
+    
+    describe 'using the Compiler class' do
+      
+      context_setup do
+        @parser = Parser.new
+      end
+      
+      it 'should be able to compile a comment followed by raw text' do
+        
+        # note that trailing newline is eaten when the comment is the only thing on the newline
+        compiled = @parser.compile("## hello world\nhere's some raw text", :class_name => :CompilerSpecAlpha)
+        self.class.module_eval(compiled)
+        self.class::Walrus::WalrusGrammar::CompilerSpecAlpha.new.fill.should == "here's some raw text"
+        
+      end
+      
+      it 'should be able to compile raw text followed by a comment' do
+        
+        # on the same line (note that trailing newline is not eaten)
+        compiled = @parser.compile("here's some raw text## hello world\n", :class_name => :CompilerSpecBeta)
+        self.class.module_eval(compiled)
+        self.class::Walrus::WalrusGrammar::CompilerSpecBeta.new.fill.should == "here's some raw text\n"
+        
+        # on two separate lines (note that second trailing newline gets eaten)
+        compiled = @parser.compile("here's some raw text\n## hello world\n", :class_name => :CompilerSpecDelta)
+        self.class.module_eval(compiled)
+        self.class::Walrus::WalrusGrammar::CompilerSpecDelta.new.fill.should == "here's some raw text\n"
+        
+        # same but with no trailing newline
+        compiled = @parser.compile("here's some raw text\n## hello world", :class_name => :CompilerSpecGamma)
+        self.class.module_eval(compiled)
+        self.class::Walrus::WalrusGrammar::CompilerSpecGamma.new.fill.should == "here's some raw text\n"
+        
+      end
+      
+    end
+    
+  end
+  
+end # module Walrus
+

data/spec/grammar/additions/proc_spec.rb

@@ -0,0 +1,25 @@
+# Copyright 2007 Wincent Colaiuta
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# in the accompanying file, "LICENSE.txt", for more details.
+#
+# $Id: /mirrors/Walrus/trunk/walrus/spec/grammar/additions/proc_spec.rb 6702 2007-04-09T15:04:40.448669Z wincent  $
+
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper.rb')
+
+module Walrus
+  class Grammar
+    
+    describe 'work with Proc instances' do
+      
+      it 'should respond to "to_parseable", "parse" and "memoizing_parse"' do
+        proc = lambda { |string, options| 'foo' }.to_parseable
+        proc.parse('bar').should == 'foo'
+        proc.memoizing_parse('bar').should == 'foo'
+      end
+      
+    end
+    
+  end # class Grammar
+end # module Walrus

data/spec/grammar/additions/regexp_spec.rb

@@ -0,0 +1,37 @@
+# Copyright 2007 Wincent Colaiuta
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# in the accompanying file, "LICENSE.txt", for more details.
+#
+# $Id: /mirrors/Walrus/trunk/walrus/spec/grammar/additions/regexp_spec.rb 6702 2007-04-09T15:04:40.448669Z wincent  $
+
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper.rb')
+
+module Walrus
+  class Grammar
+    
+    # For more detailed specification of the RegexpParslet behaviour see regexp_parslet_spec.rb.
+    describe 'using shorthand to get RegexpParslets from Regexp instances' do
+      
+      it 'chaining two Regexps with the "&" operator should yield a two-element sequence' do
+        sequence = /foo/ & /bar/
+        sequence.parse('foobar').collect { |each| each.to_s }.should == ['foo', 'bar']
+      end
+      
+      it 'chaining three Regexps with the "&" operator should yield a three-element sequence' do
+        sequence = /foo/ & /bar/ & /\.\.\./
+        sequence.parse('foobar...').collect { |each| each.to_s }.should == ['foo', 'bar', '...']
+      end
+      
+      it 'alternating two Regexps with the "|" operator should yield a MatchDataWrapper' do
+        sequence = /foo/ | /bar/
+        sequence.parse('foobar').to_s.should == 'foo'
+        sequence.parse('bar...').to_s.should == 'bar'
+        lambda { sequence.parse('no match') }.should raise_error(ParseError)
+      end
+      
+    end
+    
+  end # class Grammar
+end # module Walrus