walrus 0.1

data/spec/acceptance/comments/comments_and_text.tmpl

@@ -0,0 +1,6 @@
+This file contains comments ## like this one!
+which should not appear in the template output...
+## This line should be completely missing from the output
+## and this one two, because the comments are the first
+## (and only) thing on the lines
+In the final output, this should be the third line...

data/spec/acceptance/comments/single_comment.tmpl

@@ -0,0 +1 @@
+## This template contains only a comment; the output file should be empty.

data/spec/acceptance/def/alternative_def_calling_conventions.expected

@@ -0,0 +1,3 @@
+This is block 1. It will be injected using the #silent directive.
+This is block 2. It will be injected using the #ruby directive.
+This is block 3. It will be referenced using a placeholder.

data/spec/acceptance/def/alternative_def_calling_conventions.tmpl

@@ -0,0 +1,18 @@
+## This example shows some alternative ways of causing #def content to appear in the output
+## (by default #def content is not automatically injected into the output)
+#def block1
+This is block 1. It will be injected using the \#silent directive.
+#end
+#def block2
+This is block 2. It will be injected using the \#ruby directive.
+#end
+#def block3
+This is block 3. It will be referenced using a placeholder.
+#end
+## no need to call "accumulate" here because the block already does that.
+#silent block1
+#ruby
+# no need to call "accumulate" here because the block already does that.
+block2
+#end
+$block3

data/spec/acceptance/def/basic_def_block_no_output.tmpl

@@ -0,0 +1,17 @@
+#def body
+The key distinction between the \#block and \#def directives is that
+the former automatically produces output in the template whereas the
+latter only produces output if explicitly caused to do so (via a
+placeholder).
+
+Basically, a \#def directive defines a chunk of material that can be
+used in a template or overridden or customized in an inheriting
+template. The chunk is defined but no output is included by default.
+
+A \#block directive, on the other hand, both defines a chunk and
+automatically emits its contents in the template at the point it was
+defined.
+
+As such, this sample file will produce no output, although it will
+cause a method to be added to the compiled version of the template.
+#end

data/spec/acceptance/def/defs_can_be_called_multiple_times.expected

@@ -0,0 +1,3 @@
+The body will appear multiple times...
+The body will appear multiple times...
+The body will appear multiple times...

data/spec/acceptance/def/defs_can_be_called_multiple_times.tmpl

@@ -0,0 +1,6 @@
+#def body
+The body will appear multiple times...
+#end
+#silent body
+#silent body
+#silent body

data/spec/acceptance/def/defs_can_be_dynamic.expected

@@ -0,0 +1,4 @@
+1
+2
+3
+4

data/spec/acceptance/def/defs_can_be_dynamic.tmpl

@@ -0,0 +1,12 @@
+#def counter
+#ruby
+@counter ||= 0 # initialize counter
+@counter += 1  # increment counter
+#end
+#end
+## Note how in the first three cases below I use an explicit end-of-directive marker;
+## this is to ensure that Walrus "sees" (and emits) a newline after each number.
+#echo counter#
+#echo counter#
+#echo counter#
+#echo counter

data/spec/acceptance/echo/echo_directive_with_numeric_literal.expected

@@ -0,0 +1 @@
+42

data/spec/acceptance/echo/echo_directive_with_numeric_literal.tmpl

@@ -0,0 +1 @@
+#echo 42

data/spec/acceptance/echo/echo_expression_list.expected

@@ -0,0 +1 @@
+It doesn't get much simpler than this...

data/spec/acceptance/echo/echo_expression_list.tmpl

@@ -0,0 +1 @@
+#echo "It doesn't get much simpler than this"; "..."

data/spec/acceptance/echo/echo_short_notation.expected

@@ -0,0 +1 @@
+42

data/spec/acceptance/echo/echo_short_notation.tmpl

@@ -0,0 +1 @@
+#= 42 #

data/spec/acceptance/echo/echo_simple_expression.expected

@@ -0,0 +1 @@
+It doesn't get much simpler than this

data/spec/acceptance/echo/echo_simple_expression.tmpl

@@ -0,0 +1 @@
+#echo "It doesn't get much simpler than this"

data/spec/acceptance/echo/echo_single_quoted_string_literal.expected

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

data/spec/acceptance/echo/echo_single_quoted_string_literal.tmpl

@@ -0,0 +1 @@
+#echo 'Hello, world!'

data/spec/acceptance/echo/multiple_echo_statements.expected

@@ -0,0 +1 @@
+foobar

data/spec/acceptance/echo/multiple_echo_statements.tmpl

@@ -0,0 +1,2 @@
+#echo 'foo'
+#echo "bar"

data/spec/acceptance/includes/basic_included_file.txt

@@ -0,0 +1 @@
+Paragraph 2

data/spec/acceptance/includes/basic_includer.complex

@@ -0,0 +1,3 @@
+Paragraph 1
+#include 'basic_included_file.txt'
+Paragraph 3

data/spec/acceptance/includes/basic_includer.expected

@@ -0,0 +1,3 @@
+Paragraph 1
+Paragraph 2
+Paragraph 3

data/spec/acceptance/includes/basic_includer.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# Generated Fri Apr 13 16:10:49 +0200 2007 by Walrus version 0.1
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # installing Walrus via RubyGems is recommended
+  # otherwise Walrus must be installed in the RUBYLIB load path
+end
+
+require 'walrus/document'
+
+module Walrus
+
+  class WalrusGrammar
+
+    class BasicIncluder < Document
+
+      def template_body
+
+        accumulate('Paragraph 1' + "\n") # RawText
+        # Include (start): basic_included_file.txt:
+                accumulate('Paragraph 2' + "\n") # RawText
+        accumulate('Paragraph 3') # RawText
+
+      end
+
+    
+      if __FILE__ == $0   # when run from the command line the default action is to call 'run'
+        new.run
+      end
+
+    end # BasicIncluder
+
+  end # WalrusGrammar
+
+end # Walrus
+

data/spec/acceptance/includes/complicated_included_file.txt

@@ -0,0 +1,3 @@
+This is the included file.
+## It features comments which won't appear in the final output.
+#silent @my_ivar = 'hello, world!'

data/spec/acceptance/includes/complicated_includer.complex

@@ -0,0 +1,3 @@
+This example features an include file which itself contains a variety of directives.
+#include 'complicated_included_file.txt'
+Final paragraph, referencing an instance variable defined in the included file: #= @my_ivar #

data/spec/acceptance/includes/complicated_includer.expected

@@ -0,0 +1,3 @@
+This example features an include file which itself contains a variety of directives.
+This is the included file.
+Final paragraph, referencing an instance variable defined in the included file: hello, world!

data/spec/acceptance/includes/complicated_includer.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# Generated Fri Apr 13 16:10:50 +0200 2007 by Walrus version 0.1
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # installing Walrus via RubyGems is recommended
+  # otherwise Walrus must be installed in the RUBYLIB load path
+end
+
+require 'walrus/document'
+
+module Walrus
+
+  class WalrusGrammar
+
+    class ComplicatedIncluder < Document
+
+      def template_body
+
+        accumulate('This example features an include file which itself contains a variety of directives.' + "\n") # RawText
+        # Include (start): complicated_included_file.txt:
+                accumulate('This is the included file.' + "\n") # RawText
+                # Comment: It features comments which won't appear in the final output.
+                instance_eval { @my_ivar='hello, world!' } # Silent directive
+        accumulate('Final paragraph, referencing an instance variable defined in the included file: ') # RawText
+        accumulate(instance_eval { @my_ivar }) # Echo directive
+
+      end
+
+    
+      if __FILE__ == $0   # when run from the command line the default action is to call 'run'
+        new.run
+      end
+
+    end # ComplicatedIncluder
+
+  end # WalrusGrammar
+
+end # Walrus
+

data/spec/acceptance/includes/nested_include_1.txt

@@ -0,0 +1,3 @@
+Paragraph 2
+## This next include will add "Paragraph 3":
+#include 'nested_include_2.txt'

data/spec/acceptance/includes/nested_include_2.txt

@@ -0,0 +1 @@
+Paragraph 3

data/spec/acceptance/includes/nested_includer.complex

@@ -0,0 +1,3 @@
+Paragraph 1
+#include 'nested_include_1.txt'
+Paragraph 4

data/spec/acceptance/includes/nested_includer.expected

@@ -0,0 +1,4 @@
+Paragraph 1
+Paragraph 2
+Paragraph 3
+Paragraph 4

data/spec/acceptance/includes/nested_includer.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# Generated Fri Apr 13 16:10:50 +0200 2007 by Walrus version 0.1
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # installing Walrus via RubyGems is recommended
+  # otherwise Walrus must be installed in the RUBYLIB load path
+end
+
+require 'walrus/document'
+
+module Walrus
+
+  class WalrusGrammar
+
+    class NestedIncluder < Document
+
+      def template_body
+
+        accumulate('Paragraph 1' + "\n") # RawText
+        # Include (start): nested_include_1.txt:
+                accumulate('Paragraph 2' + "\n") # RawText
+                # Comment: This next include will add "Paragraph 3":
+                # Include (start): nested_include_2.txt:
+                        accumulate('Paragraph 3' + "\n") # RawText
+        accumulate('Paragraph 4') # RawText
+
+      end
+
+    
+      if __FILE__ == $0   # when run from the command line the default action is to call 'run'
+        new.run
+      end
+
+    end # NestedIncluder
+
+  end # WalrusGrammar
+
+end # Walrus
+

data/spec/acceptance/inheritance/basic_child.complex

@@ -0,0 +1,10 @@
+#extends 'basic_parent'
+#def footer
+This is the overridden footer. Note that in the overridden version of the footer
+I'm using a \#def block rather than a \#block like in the parent template. The
+reason for this is that \#block calls automatically in-line their contents at
+the point where they are declared.
+
+Given that this template \#extends the parent, the parent will *already* be
+in-lining the footer, so there is no need to in-line it again.
+#end

data/spec/acceptance/inheritance/basic_child.expected

@@ -0,0 +1,9 @@
+This is the base template which subclasses will inherit.
+
+This is the overridden footer. Note that in the overridden version of the footer
+I'm using a #def block rather than a #block like in the parent template. The
+reason for this is that #block calls automatically in-line their contents at
+the point where they are declared.
+
+Given that this template #extends the parent, the parent will *already* be
+in-lining the footer, so there is no need to in-line it again.

data/spec/acceptance/inheritance/basic_child.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# Generated Fri Apr 13 16:10:51 +0200 2007 by Walrus version 0.1
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # installing Walrus via RubyGems is recommended
+  # otherwise Walrus must be installed in the RUBYLIB load path
+end
+
+require 'walrus/document'
+require File.join(File.dirname(__FILE__), 'basic_parent').to_s
+
+module Walrus
+
+  class WalrusGrammar
+
+    class BasicChild < BasicParent
+
+      def template_body
+
+        super # (invoked automatically due to Extends directive)
+
+      end
+
+      def footer
+        accumulate('This is the overridden footer. Note that in the overridden version of the footer' + "\n") # RawText
+        accumulate('I\'m using a ') # RawText (continued)
+        accumulate("#") # EscapeSequence
+        accumulate('def block rather than a ') # RawText
+        accumulate("#") # EscapeSequence
+        accumulate('block like in the parent template. The' + "\n") # RawText
+        accumulate('reason for this is that ') # RawText (continued)
+        accumulate("#") # EscapeSequence
+        accumulate('block calls automatically in-line their contents at' + "\n") # RawText
+        accumulate('the point where they are declared.' + "\n") # RawText (continued)
+        accumulate('' + "\n") # RawText (continued)
+        accumulate('Given that this template ') # RawText (continued)
+        accumulate("#") # EscapeSequence
+        accumulate('extends the parent, the parent will *already* be' + "\n") # RawText
+        accumulate('in-lining the footer, so there is no need to in-line it again.' + "\n") # RawText (continued)
+      end
+      
+    
+      if __FILE__ == $0   # when run from the command line the default action is to call 'run'
+        new.run
+      end
+
+    end # BasicChild
+
+  end # WalrusGrammar
+
+end # Walrus
+

data/spec/acceptance/inheritance/basic_parent.complex

@@ -0,0 +1,5 @@
+This is the base template which subclasses will inherit.
+
+#block footer
+This is the footer for the base template.
+#end

data/spec/acceptance/inheritance/basic_parent.expected

@@ -0,0 +1,3 @@
+This is the base template which subclasses will inherit.
+
+This is the footer for the base template.

data/spec/acceptance/inheritance/basic_parent.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# Generated Fri Apr 13 16:10:51 +0200 2007 by Walrus version 0.1
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # installing Walrus via RubyGems is recommended
+  # otherwise Walrus must be installed in the RUBYLIB load path
+end
+
+require 'walrus/document'
+
+module Walrus
+
+  class WalrusGrammar
+
+    class BasicParent < Document
+
+      def template_body
+
+        accumulate('This is the base template which subclasses will inherit.' + "\n") # RawText
+        accumulate('' + "\n") # RawText (continued)
+        lookup_and_accumulate_placeholder(:footer)
+
+      end
+
+      def footer
+        accumulate('This is the footer for the base template.' + "\n") # RawText
+      end
+      
+    
+      if __FILE__ == $0   # when run from the command line the default action is to call 'run'
+        new.run
+      end
+
+    end # BasicParent
+
+  end # WalrusGrammar
+
+end # Walrus
+

data/spec/acceptance/inheritance/importing_child.complex

@@ -0,0 +1,8 @@
+#import 'basic_parent'
+This time we use an \#import directive rather than an \#extends.
+
+This means that we have access to all of the methods defined in the parent,
+but the main "template_body" is not explicitly called.
+
+Here we'll call in the parent's footer:
+$footer

data/spec/acceptance/inheritance/importing_child.expected

@@ -0,0 +1,7 @@
+This time we use an #import directive rather than an #extends.
+
+This means that we have access to all of the methods defined in the parent,
+but the main "template_body" is not explicitly called.
+
+Here we'll call in the parent's footer:
+This is the footer for the base template.

data/spec/acceptance/inheritance/importing_child.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# Generated Fri Apr 13 16:10:52 +0200 2007 by Walrus version 0.1
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # installing Walrus via RubyGems is recommended
+  # otherwise Walrus must be installed in the RUBYLIB load path
+end
+
+require 'walrus/document'
+require File.join(File.dirname(__FILE__), 'basic_parent').to_s
+
+module Walrus
+
+  class WalrusGrammar
+
+    class ImportingChild < BasicParent
+
+      def template_body
+
+        accumulate('This time we use an ') # RawText
+        accumulate("#") # EscapeSequence
+        accumulate('import directive rather than an ') # RawText
+        accumulate("#") # EscapeSequence
+        accumulate('extends.' + "\n") # RawText
+        accumulate('' + "\n") # RawText (continued)
+        accumulate('This means that we have access to all of the methods defined in the parent,' + "\n") # RawText (continued)
+        accumulate('but the main "template_body" is not explicitly called.' + "\n") # RawText (continued)
+        accumulate('' + "\n") # RawText (continued)
+        accumulate('Here we\'ll call in the parent\'s footer:' + "\n") # RawText (continued)
+        lookup_and_accumulate_placeholder(:footer)
+
+      end
+
+    
+      if __FILE__ == $0   # when run from the command line the default action is to call 'run'
+        new.run
+      end
+
+    end # ImportingChild
+
+  end # WalrusGrammar
+
+end # Walrus
+

data/spec/acceptance/inheritance/subdirectory/importing_child_in_subdirectory.complex

@@ -0,0 +1,8 @@
+#import '../basic_parent'
+We have to use a different form of the \#import directive when working
+within a subdirectory. Instead of providing a class name we pass a
+quoted string literal with relative path information. In this way Walrus
+knows where to find the parent template.
+
+Here we'll call in the parent's footer:
+$footer

data/spec/acceptance/inheritance/subdirectory/importing_child_in_subdirectory.expected

@@ -0,0 +1,7 @@
+We have to use a different form of the #import directive when working
+within a subdirectory. Instead of providing a class name we pass a
+quoted string literal with relative path information. In this way Walrus
+knows where to find the parent template.
+
+Here we'll call in the parent's footer:
+This is the footer for the base template.

data/spec/acceptance/inheritance/subdirectory/importing_child_in_subdirectory.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# Generated Fri Apr 13 16:10:52 +0200 2007 by Walrus version 0.1
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # installing Walrus via RubyGems is recommended
+  # otherwise Walrus must be installed in the RUBYLIB load path
+end
+
+require 'walrus/document'
+require File.join(File.dirname(__FILE__), '..', 'basic_parent').to_s
+
+module Walrus
+
+  class WalrusGrammar
+
+    class ImportingChildInSubdirectory < BasicParent
+
+      def template_body
+
+        accumulate('We have to use a different form of the ') # RawText
+        accumulate("#") # EscapeSequence
+        accumulate('import directive when working' + "\n") # RawText
+        accumulate('within a subdirectory. Instead of providing a class name we pass a' + "\n") # RawText (continued)
+        accumulate('quoted string literal with relative path information. In this way Walrus' + "\n") # RawText (continued)
+        accumulate('knows where to find the parent template.' + "\n") # RawText (continued)
+        accumulate('' + "\n") # RawText (continued)
+        accumulate('Here we\'ll call in the parent\'s footer:' + "\n") # RawText (continued)
+        lookup_and_accumulate_placeholder(:footer)
+
+      end
+
+    
+      if __FILE__ == $0   # when run from the command line the default action is to call 'run'
+        new.run
+      end
+
+    end # ImportingChildInSubdirectory
+
+  end # WalrusGrammar
+
+end # Walrus
+

data/spec/acceptance/multiline_comments/multiline_comment_with_directives_inside.tmpl

@@ -0,0 +1,15 @@
+#*
+
+Another multiline comment
+
+Note that I can use anything I want inside comments:
+
+	* Tabs
+	* Non-existent #directives
+	* Real directives like #raw, #set, #super, #def and #import
+	* Placeholders: $hello("world")
+	* Escape sequences: \n\r
+	* Nested comments: ## here is a single-line one
+	* Nested comments: #* here is a multi-line one *#
+
+*#

data/spec/acceptance/multiline_comments/simple_multiline_comment.expected

@@ -0,0 +1,2 @@
+Text before the comment... 
+Text after the comment.

data/spec/acceptance/multiline_comments/simple_multiline_comment.tmpl

@@ -0,0 +1,4 @@
+Text before the comment... #* This
+is a multiline 
+comment *#
+Text after the comment.

data/spec/acceptance/raw/complicated_raw_example.expected

@@ -0,0 +1,57 @@
+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).
+
+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
+
+This paragraph is another example where the closing marker is not
+on a new line of it's own...
+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... See?
+
+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.
+
+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:\
+I am now outside the #raw block because the #end directive was interpreted as an end marker
+despite my attempt to escape it.
+
+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.
+
+Trailing whitespace is acceptable after the end marker, but it is not included in the output.
+
+The same is true when using the alternative syntax.
+
+In fact, trailing whitespace is acceptable when first opening the here document too, but it
+is ignored
+
+THe same is true for the alternate syntax.
+
+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.)
+
+In this example I am going to use some multi-byte characters:
+€áéíóú
+àèìòù