walrus 0.1

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# 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$
+
+# Individual spec files that require this helper file can be run individually from the commandline.
+
+require 'pathname'
+require 'rubygems'
+require 'spec'
+
+module Walrus
+  module SpecHelper
+    
+    if not const_defined? "LIBDIR"
+      # will append the local "lib" and "ext" directories to search path if not already present
+      base    = File.join(File.dirname(__FILE__), '..')
+      LIBDIR  = Pathname.new(File.join(base, 'lib')).realpath
+      EXTDIR  = Pathname.new(File.join(base, 'ext')).realpath
+      TOOL    = Pathname.new(File.join(base, 'bin', 'walrus')).realpath
+      # normalize all paths in the load path (use "rescue" because "realpath" will raise if lstat(2) fails for the path: non-existent paths, relative paths etc)
+      normalized = $:.collect { |path| Pathname.new(path).realpath rescue path }
+      
+      # only add the directories if they do not appear to be present already
+      [LIBDIR, EXTDIR].each { |path| $:.push(path) unless normalized.include?(path) }    
+    end
+    
+  end # module SpecHelper
+end # module Walrus
+
+require 'walrus'

data/spec/walrus_grammar/comment_spec.rb

@@ -0,0 +1,39 @@
+# 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/walrus_grammar/comment_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 'compiling a comment instance' do
+      
+      it 'comments should produce no meaningful output' do
+        eval(Comment.new(' hello world').compile).should == nil
+      end
+      
+    end
+    
+    describe 'producing a Document containing Comment' do
+      
+      setup do
+        @parser = Parser.new
+      end
+      
+      it 'should produce no output' do
+        comment = @parser.compile('## hello world', :class_name => :CommentSpec)
+        self.class.class_eval(comment)
+        self.class::Walrus::WalrusGrammar::CommentSpec.new.fill.should == ''
+      end
+      
+    end
+    
+  end # class WalrusGrammar
+end # module Walrus
+

data/spec/walrus_grammar/echo_directive_spec.rb

@@ -0,0 +1,63 @@
+# 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/walrus_grammar/echo_directive_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
+    
+    class EchoDirectiveAccumulator
+      attr_reader :content
+      def initialize
+        @content = ''
+      end
+      def accumulate(string)
+        @content << string
+      end
+    end
+    
+    describe 'compiling an EchoDirective instance' do
+      
+      it 'should be able to round trip' do
+        string              = StringResult.new('hello world')
+        string.source_text  = "'hello world'"
+        @accumulator        = EchoDirectiveAccumulator.new
+        @accumulator.instance_eval(EchoDirective.new(SingleQuotedStringLiteral.new(string)).compile)
+        @accumulator.content.should == 'hello world'
+      end
+      
+      # regression test for inputs that previously raised
+      it 'should be able to recognize the short form' do
+        @parser = Parser.new
+        lambda { @parser.parse('#= Walrus::VERSION #') }.should_not raise_error
+        lambda { @parser.parse('<meta name="generator" content="Walrus #= Walrus::VERSION #">') }.should_not raise_error
+      end
+      
+    end
+    
+    describe 'producing a Document containing an EchoDirective' do
+      
+      setup do
+        @parser = Parser.new
+      end
+      
+      it 'should be able to round trip' do
+        
+        # simple example
+        compiled = @parser.compile("#echo 'foo'", :class_name => :EchoDirectiveSpecAlpha)
+        self.class.class_eval(compiled)
+        self.class::Walrus::WalrusGrammar::EchoDirectiveSpecAlpha.new.fill.should == 'foo'
+        
+      end
+      
+    end
+    
+  end # class WalrusGrammar
+end # module Walrus
+

data/spec/walrus_grammar/escape_sequence_spec.rb

@@ -0,0 +1,85 @@
+# 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/walrus_grammar/escape_sequence_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
+    
+    class EscapeSequenceAccumulator
+      attr_reader :content
+      def initialize
+        @content = ''
+      end
+      def accumulate(string)
+        @content << string
+      end
+    end
+    
+    describe 'compiling an EscapeSequence instance' do
+      
+      setup do
+        @accumulator  = EscapeSequenceAccumulator.new
+      end
+      
+      it 'should be able to round trip ($)' do
+        sequence = EscapeSequence.new('$')
+        @accumulator.instance_eval(sequence.compile)
+        @accumulator.content.should == '$'
+      end
+      
+      it 'should be able to round trip (#)' do
+        sequence = EscapeSequence.new('#')
+        @accumulator.instance_eval(sequence.compile)
+        @accumulator.content.should == '#'
+      end
+      
+      it 'should be able to round trip (\\)' do
+        sequence = EscapeSequence.new('\\')
+        @accumulator.instance_eval(sequence.compile)
+        @accumulator.content.should == '\\'
+      end
+      
+    end
+    
+    describe 'producing a Document containing an EscapeSequence' do
+      
+      setup do
+        @parser = Parser.new
+      end
+      
+      it 'should be able to round trip' do
+        
+        # single $
+        sequence = @parser.compile('\\$', :class_name => :EscapeSequenceSpecAlpha)
+        self.class.class_eval(sequence)
+        self.class::Walrus::WalrusGrammar::EscapeSequenceSpecAlpha.new.fill.should == '$'
+        
+        # single #
+        sequence = @parser.compile('\\#', :class_name => :EscapeSequenceSpecBeta)
+        self.class.class_eval(sequence)
+        self.class::Walrus::WalrusGrammar::EscapeSequenceSpecBeta.new.fill.should == '#'
+        
+        # single \
+        sequence = @parser.compile('\\\\', :class_name => :EscapeSequenceSpecDelta)
+        self.class.class_eval(sequence)
+        self.class::Walrus::WalrusGrammar::EscapeSequenceSpecDelta.new.fill.should == '\\'
+        
+        # multiple escape markers
+        sequence = @parser.compile('\\\\\\#\\$', :class_name => :EscapeSequenceSpecGamma)
+        self.class.class_eval(sequence)
+        self.class::Walrus::WalrusGrammar::EscapeSequenceSpecGamma.new.fill.should == '\\#$'
+        
+      end
+      
+    end
+    
+  end # class WalrusGrammar
+end # module Walrus
+

data/spec/walrus_grammar/literal_spec.rb

@@ -0,0 +1,41 @@
+# 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/walrus_grammar/literal_spec.rb 6702 2007-04-09T15:04:40.448669Z 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 'compiling a double-quoted string literal instance' do
+      
+      it 'should produce a string literal' do
+        string = StringResult.new('hello world')                  # construct the string result the same way the parser does
+        string.source_text = '"hello world"'                      # the original source text includes the quotes
+        compiled = DoubleQuotedStringLiteral.new(string).compile  # but the inner lexeme is just the contents
+        compiled.should == '"hello world"'
+        eval(compiled).should == 'hello world'
+      end
+      
+    end
+    
+    describe 'compiling a single-quoted string literal instance' do
+      
+      it 'should produce a string literal' do
+        string = StringResult.new('hello world')                  # construct the string result the same way the parser does
+        string.source_text = "'hello world'"                      # the original source text includes the quotes
+        compiled = SingleQuotedStringLiteral.new(string).compile  # but the inner lexeme is just the contents
+        compiled.should == "'hello world'"
+        eval(compiled).should == 'hello world'
+      end
+      
+    end
+    
+  end # class WalrusGrammar
+end # module Walrus
+

data/spec/walrus_grammar/message_expression_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/walrus_grammar/message_expression_spec.rb 6704 2007-04-09T18:30:00.421185Z 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 'calling source_text on a message expression inside an echo directive' do
+      
+      setup do
+        @parser = Parser.new
+      end
+      
+      it 'should return the text of the expression only' do
+        
+        directive = @parser.parse '#echo string.downcase'
+        directive.column_start.should == 0
+        directive.expression.target.column_start.should == 6
+        directive.expression.message.column_start.should == 13
+        
+        # ideally we'd report 6 here, but there is no way for Walrus to know that we don't want to count the skipped whitespace
+        directive.expression.column_start.should == 5
+        directive.expression.source_text.should == ' string.downcase'
+        
+      end
+    end
+    
+  end # class WalrusGrammar
+end # module Walrus
+

data/spec/walrus_grammar/multiline_comment_spec.rb

@@ -0,0 +1,58 @@
+# 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/walrus_grammar/multiline_comment_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 'compiling a comment instance' do
+      
+      it 'comments should produce no meaningful output' do
+        self.class.class_eval(MultilineComment.new(" hello\n   world ").compile).should == nil
+      end
+      
+    end
+    
+    describe 'producing a Document containing Comment' do
+      
+      setup do
+        @parser = Parser.new
+      end
+      
+      it 'should produce no output' do
+        
+        # simple multiline comment
+        comment = @parser.compile("#* hello\n   world *#", :class_name => :MultilineCommentSpecAlpha)
+        self.class.class_eval(comment)
+        self.class::Walrus::WalrusGrammar::MultilineCommentSpecAlpha.new.fill.should == ''
+        
+        # nested singleline comment
+        comment = @parser.compile("#* hello ## <-- first line\n   world *#", :class_name => :MultilineCommentSpecBeta)
+        self.class.class_eval(comment)
+        self.class::Walrus::WalrusGrammar::MultilineCommentSpecBeta.new.fill.should == ''
+        
+        # nested multiline comment
+        comment = @parser.compile("#* hello ## <-- first line\n   world #* <-- second line *# *#", :class_name => :MultilineCommentSpecDelta)
+        self.class.class_eval(comment)
+        self.class::Walrus::WalrusGrammar::MultilineCommentSpecDelta.new.fill.should == ''
+        
+        # multiple comments
+        comment = @parser.compile("#* hello *##* world *#", :class_name => :MultilineCommentSpecGamma)
+        self.class.class_eval(comment)
+        self.class::Walrus::WalrusGrammar::MultilineCommentSpecGamma.new.fill.should == ''
+        
+      end
+      
+    end
+    
+  end # class WalrusGrammar
+end # module Walrus
+

data/spec/walrus_grammar/placeholder_spec.rb

@@ -0,0 +1,48 @@
+# 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/walrus_grammar/placeholder_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 'a placeholder with no parameters' do
+    
+      setup do
+        @parser = Parser.new
+      end
+      
+      it 'should be substituted into the output' do
+        placeholder = @parser.compile("#set $foo = 'bar'\n$foo", :class_name => :PlaceholderSpecAlpha)
+        self.class.class_eval(placeholder)
+        self.class::Walrus::WalrusGrammar::PlaceholderSpecAlpha.new.fill.should == 'bar'
+      end
+            
+    end
+    
+    describe 'a placeholder that accepts one parameter' do
+      
+      setup do
+        @parser = Parser.new
+      end
+      
+      it 'should be substituted into the output' do
+        placeholder = @parser.compile( %q{#def foo(string)
+#echo string.downcase
+#end
+$foo("HELLO WORLD")}, :class_name => :PlaceholderSpecBeta)
+        self.class.class_eval(placeholder)
+        self.class::Walrus::WalrusGrammar::PlaceholderSpecBeta.new.fill.should == "hello world"
+      end
+      
+    end
+    
+  end # class WalrusGrammar
+end # module Walrus
+

data/spec/walrus_grammar/raw_directive_spec.rb

@@ -0,0 +1,81 @@
+# 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/walrus_grammar/raw_directive_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
+    
+    class RawDirectiveAccumulator
+      attr_reader :content
+      def initialize
+        @content = ''
+      end
+      def accumulate(string)
+        @content << string
+      end
+    end
+    
+    describe 'compiling a RawDirective instance' do
+      
+      it 'should be able to round trip' do
+        @accumulator  = RawDirectiveAccumulator.new
+        @raw          = RawDirective.new('hello \'world\'\\... € #raw, $raw, \\raw')
+        @accumulator.instance_eval(@raw.compile)
+        @accumulator.content.should == 'hello \'world\'\\... € #raw, $raw, \\raw'
+      end
+      
+    end
+    
+    describe 'producing a Document containing RawText' do
+      
+      setup do
+        @parser = Parser.new
+      end
+      
+      it 'should be able to round trip' do
+        
+        # simple example
+        raw = @parser.compile("#raw\nhello world\n#end", :class_name => :RawDirectiveSpecAlpha)
+        self.class.class_eval(raw)
+        self.class::Walrus::WalrusGrammar::RawDirectiveSpecAlpha.new.fill.should == "hello world\n"
+        
+        # containing single quotes
+        raw = @parser.compile("#raw\nhello 'world'\n#end", :class_name => :RawDirectiveSpecBeta)
+        self.class.class_eval(raw)
+        self.class::Walrus::WalrusGrammar::RawDirectiveSpecBeta.new.fill.should == "hello 'world'\n"
+        
+        # containing a newline
+        raw = @parser.compile("#raw\nhello\nworld\n#end", :class_name => :RawDirectiveSpecDelta)
+        self.class.class_eval(raw)
+        self.class::Walrus::WalrusGrammar::RawDirectiveSpecDelta.new.fill.should == "hello\nworld\n"
+        
+        # using a "here document"
+        raw = @parser.compile("#raw <<HERE
+hello world
+literal #end with no effect
+HERE", :class_name => :RawDirectiveSpecGamma)
+        self.class.class_eval(raw)
+        self.class::Walrus::WalrusGrammar::RawDirectiveSpecGamma.new.fill.should == "hello world\nliteral #end with no effect\n"
+        
+        # "here document", alternative syntax
+        raw = @parser.compile("#raw <<-HERE
+hello world
+literal #end with no effect
+        HERE", :class_name => :RawDirectiveSpecIota)
+        self.class.class_eval(raw)
+        self.class::Walrus::WalrusGrammar::RawDirectiveSpecIota.new.fill.should == "hello world\nliteral #end with no effect\n"
+        
+      end
+      
+    end
+    
+  end # class WalrusGrammar
+end # module Walrus
+

data/spec/walrus_grammar/raw_text_spec.rb

@@ -0,0 +1,65 @@
+# 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/walrus_grammar/raw_text_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
+    
+    class RawTextAccumulator
+      attr_reader :content
+      def initialize
+        @content = ''
+      end
+      def accumulate(string)
+        @content << string
+      end
+    end
+    
+    describe 'compiling a RawText instance' do
+      
+      it 'should be able to round trip' do
+        @accumulator  = RawTextAccumulator.new
+        @raw_text     = RawText.new('hello \'world\'\\... €')
+        @accumulator.instance_eval(@raw_text.compile)
+        @accumulator.content.should == 'hello \'world\'\\... €'
+      end
+      
+    end
+    
+    describe 'producing a Document containing RawText' do
+      
+      setup do
+        @parser = Parser.new
+      end
+      
+      it 'should be able to round trip' do
+        
+        # simple example
+        raw_text = @parser.compile('hello world', :class_name => :RawTextSpecAlpha)
+        self.class.class_eval(raw_text)
+        self.class::Walrus::WalrusGrammar::RawTextSpecAlpha.new.fill.should == 'hello world'
+        
+        # containing single quotes
+        raw_text = @parser.compile("hello 'world'", :class_name => :RawTextSpecBeta)
+        self.class.class_eval(raw_text)
+        self.class::Walrus::WalrusGrammar::RawTextSpecBeta.new.fill.should == "hello 'world'"
+        
+        # containing a newline
+        raw_text = @parser.compile("hello\nworld", :class_name => :RawTextSpecDelta)
+        self.class.class_eval(raw_text)
+        self.class::Walrus::WalrusGrammar::RawTextSpecDelta.new.fill.should == "hello\nworld"
+        
+      end
+      
+    end
+    
+  end # class WalrusGrammar
+end # module Walrus
+

data/spec/walrus_grammar/silent_directive_spec.rb

@@ -0,0 +1,34 @@
+# 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/walrus_grammar/silent_directive_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 'producing a Document containing a SilentDirective' do
+      
+      setup do
+        @parser = Parser.new
+      end
+      
+      it 'should produce no output' do
+        
+        # simple example
+        compiled = @parser.compile("#silent 'foo'", :class_name => :SilentDirectiveSpecAlpha)
+        self.class.class_eval(compiled)
+        self.class::Walrus::WalrusGrammar::SilentDirectiveSpecAlpha.new.fill.should == ''
+        
+      end
+      
+    end
+    
+  end # class WalrusGrammar
+end # module Walrus
+