walrus 0.1 → 0.2

data/lib/walrus/grammar.rb

@@ -1,10 +1,16 @@
 # 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.
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id: /mirrors/Walrus/trunk/walrus/lib/walrus/grammar.rb 6704 2007-04-09T18:30:00.421185Z wincent  $
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus'
 

data/lib/walrus/no_parameter_marker.rb

@@ -1,10 +1,16 @@
 # 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.
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id$
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus'
 

data/lib/walrus/parser.rb

@@ -1,10 +1,16 @@
 # 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.
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id: /mirrors/Walrus/trunk/walrus/lib/walrus/parser.rb 6755 2007-04-13T14:13:42.727911Z wincent  $
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus'
 require 'pathname'
@@ -188,7 +194,7 @@ module Walrus
           sub_result  = Parser.new.parse(content, sub_options)
         end
         
-        # want to insert a bunch of nodes (a subtree) into the parse tree without advance the location counters
+        # want to insert a bunch of nodes (a subtree) into the parse tree without advancing the location counters
         sub_tree = Grammar::ArrayResult.new [ file_name, sub_result ? sub_result : [] ]
         sub_tree.start  = file_name.start
         sub_tree.end    = file_name.end

data/lib/walrus/runner.rb

@@ -1,10 +1,16 @@
-# 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.
+# Copyright 2007-2009 Wincent Colaiuta
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id: /mirrors/Walrus/trunk/walrus/lib/walrus/runner.rb 6751 2007-04-12T16:56:29.067618Z wincent  $
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus'
 require 'fileutils'
@@ -15,15 +21,12 @@ require 'rubygems'
 require 'wopen3'
 
 module Walrus
-  
   class Runner
-    
     class Error < Exception ; end
 
     class ArgumentError < Error ; end
-    
+
     def initialize
-      
       @options = OpenStruct.new
       @options.output_dir         = nil
       @options.input_extension    = 'tmpl'
@@ -35,11 +38,10 @@ module Walrus
       @options.halt               = false
       @options.dry                = false
       @options.verbose            = false
-      
+
       @command  = nil # "compile", "fill" (saves to disk), "run" (prints to standard out)
       @inputs   = []  # list of input files and/or directories
       parser    = OptionParser.new do |o|
-        
         o.banner  = "Usage: #{o.program_name} command input-file(s)-or-directory/ies [options]"
         o.separator ''
         o.separator '   _____________'
@@ -55,82 +57,83 @@ module Walrus
         o.separator '          fill    -- runs compiled templates, writing output to disk'
         o.separator '          run     -- runs compiled templates, printing output to standard output'
         o.separator ''
-        
+
         o.on('-o', '--output-dir DIR', 'Output directory (when filling)', 'defaults to same directory as input file') do |opt|
           @options.output_dir = Pathname.new(opt)
         end
-        
+
         o.on('-i', '--input-extension EXT', 'Extension for input file(s)', 'default: tmpl') do |opt|
           @options.input_extension = opt
         end
-        
+
         o.on('-e', '--output-extension EXT', 'Extension for output file(s) (when filling)', 'default: html') do |opt|
           @options.output_extension = opt
         end
-        
+
         o.on('-R', 'Search subdirectories recursively for input files', 'default: on') do |opt|
           @options.recurse = opts
         end
-        
+
         o.on('-b', '--[no-]backup', 'Make backups before overwriting', 'default: on') do |opt|
           @options.backup = opt
         end
-        
+
         o.on('-f', '--force', 'Force a recompile (when filling)', 'default: off (files only recompiled if source newer than output)') do |opt|
           @options.force = opt
         end
-        
+
         o.on('--halt', 'Halts on encountering an error (even a non-fatal error)', 'default: off') do |opt|
           @options.halt = opt
         end
-        
+
         o.on('-t', '--test', 'Performs a "dry" (test) run', 'default: off') do |opt|
           @options.dry = opt
         end
-        
+
         o.on('-d', '--debug', 'Print debugging information to standard error', 'default: off') do |opt|
           @options.debug = opt
         end
-        
+
         o.on('-v', '--verbose', 'Run verbosely', 'default: off') do |opt|
           @options.verbose = opt
         end
-        
+
         o.separator ''
-        
+
         o.on_tail('-h', '--help', 'Show this message') do
           $stderr.puts o
           exit
         end
-        
+
         o.on_tail('--version', 'Show version') do
           $stderr.puts 'Walrus ' + Walrus::VERSION
           exit
         end
-        
       end
-      
+
       begin
         parser.parse!
       rescue OptionParser::InvalidOption => e
         raise ArgumentError.new(e)
       end
-      
+
       parser.order! do |item|
-        if @command.nil? :  @command = item               # get command first ("compile", "fill" or "run")
-        else                @inputs << Pathname.new(item) # all others (and there must be at least one) are file or directory names
+        if @command.nil?
+          @command = item               # get command first ("compile", "fill" or "run")
+        else
+          @inputs << Pathname.new(item) # all others (and there must be at least one) are file or directory names
         end
       end
-      
+
       raise ArgumentError.new('no command specified') if @command.nil?
       raise ArgumentError.new('no inputs specified') unless @inputs.length > 0
     end
-    
+
     def run
       log "Beginning processing: #{Time.new.to_s}."
-      
+
       # TODO: flush memoizing cache after each file
-      
+
       expand(@inputs).each do |input|
         case @command
         when 'compile'
@@ -159,7 +162,7 @@ module Walrus
       end
       log "Processing complete: #{Time.new.to_s}."
     end
-    
+
     # Expects an array of Pathname objects.
     # Directory inputs are themselves recursively expanded if the "recurse" option is set to true; otherwise only their top-level entries are expanded.
     # Returns an expanded array of Pathname objects.
@@ -182,11 +185,11 @@ module Walrus
       end
       expanded
     end
-    
+
     def compile_if_needed(input)
       compile(input, false)
     end
-    
+
     def compiled_path_older_than_source_path(compiled_path, source_path)
       begin
         compiled  = File.mtime(compiled_path)
@@ -196,7 +199,7 @@ module Walrus
       end
       compiled < source
     end
-    
+
     def compile(input, force = true)
       template_source_path  = template_source_path_for_input(input)
       compiled_path         = compiled_source_path_for_input(input)
@@ -207,20 +210,18 @@ module Walrus
           handle_error("failed to read input template '#{template_source_path}' (#{e.to_s})")
           return
         end
-        
+
         begin
           compiled = template.compile
         rescue Grammar::ParseError => e
           handle_error("failed to compile input template '#{template_source_path}' (#{e.to_s})")
           return
         end
-        
+
         write_string_to_path(compiled, compiled_path, true)
-        
       end
-      
     end
-    
+
     def get_output(input)
       if @options.dry
         "(no output: dry run)\n"
@@ -235,20 +236,18 @@ module Walrus
           threads << Thread.new(stderr) do |err|
             err.each { |line| STDERR.puts line }
           end
-          threads.each { |thread| thread.join }      
+          threads.each { |thread| thread.join }
         end
         status = $?.exitstatus
         raise SystemCallError.new("non-zero exit status (#{status})") if status != 0
         output
       end
     end
-    
+
     def write_string_to_path(string, path, executable = false)
-      
       if @options.dry
         log "Would write '#{path}' (dry run)."
       else
-        
         unless path.dirname.exist?
           begin
             log "Creating directory '#{path.dirname}'."
@@ -258,7 +257,7 @@ module Walrus
             return
           end
         end
-        
+
         log "Writing '#{path}'."
         begin
           File.open(path, "a+") do |f|
@@ -277,7 +276,7 @@ module Walrus
         end
       end
     end
-    
+
     def adjusted_output_path(path)
       if @options.output_dir
         if path.absolute?
@@ -289,38 +288,36 @@ module Walrus
         path
       end
     end
-    
+
     # If "input" already has the right extension it is returned unchanged.
     # If the "input extension" is zero-length then "input" is returned unchanged.
     # Otherwise the "input extension" is added to "input" and returned.
     def template_source_path_for_input(input)
       return input if input.extname == ".#{@options.input_extension}" # input already has the right extension
       return input if @options.input_extension.length == 0            # zero-length extension, nothing to add
-      dir, base = input.split      
+      dir, base = input.split
       dir + "#{base.to_s}.#{@options.input_extension}"                # otherwise, add extension and return
     end
-    
+
     def compiled_source_path_for_input(input)
-      
       # remove input extension if present
       if input.extname == ".#{@options.input_extension}" and @options.input_extension.length > 0
         dir, base = input.split
         input = dir + base.basename(base.extname)
       end
-      
+
       # add rb as an extension
       dir, base = input.split
       dir + "#{base.to_s}.rb"
     end
-    
+
     def filled_output_path_for_input(input)
-      
       # remove input extension if present
       if input.extname == ".#{@options.input_extension}" and @options.input_extension.length > 0
         dir, base = input.split
         input = dir + base.basename(base.extname)
       end
-      
+
       # add output extension if appropriate
       if @options.output_extension.length > 0
         dir, base = input.split
@@ -328,29 +325,25 @@ module Walrus
       else
         adjusted_output_path(input)
       end
-      
     end
-    
+
   private
-    
+
     # Writes "message" to standard error if user supplied the "--verbose" switch.
     def log(message)
       if @options.verbose
         $stderr.puts message
       end
     end
-    
-    # If the user supplied the "--halt" switch raises an Runner::Error exception based on "message". Otherwise merely prints "message" to the standard error.
+
+    # If the user supplied the "--halt" switch raises an Runner::Error exception based on "message".
+    # Otherwise merely prints "message" to the standard error.
     def handle_error(message)
       if @options.halt
         raise Error.new(message)
       else
-        $stderr.puts message
+        $stderr.puts ":: error: #{message}"
       end
     end
-    
-    
   end # class Runner
-  
 end # module Walrus
-

data/lib/walrus/template.rb

@@ -1,10 +1,16 @@
 # 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.
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id: /mirrors/Walrus/trunk/walrus/lib/walrus/template.rb 6730 2007-04-11T13:48:51.166868Z wincent  $
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus'
 
@@ -56,8 +62,10 @@ module Walrus
       if @class_name
         @class_name
       else
-        if @origin.nil? : @class_name = Compiler::DEFAULT_CLASS # "DocumentSubclass"
-        else              @class_name = strip_extensions(@origin).to_class_name
+        if @origin.nil?
+          @class_name = Compiler::DEFAULT_CLASS # "DocumentSubclass"
+        else
+          @class_name = strip_extensions(@origin).to_class_name
         end
       end
     end

data/lib/walrus/version.rb

@@ -0,0 +1,3 @@
+module Walrus
+  VERSION = '0.2'
+end # module Walrus

data/lib/walrus/walrus_grammar/assignment_expression.rb

@@ -1,10 +1,16 @@
 # 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.
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id: /mirrors/Walrus/trunk/walrus/lib/walrus/walrus_grammar/assignment_expression.rb 6701 2007-04-09T14:55:55.352472Z wincent  $
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus/parser.rb' # make sure that RawText class has been defined prior to extending it
 

data/lib/walrus/walrus_grammar/block_directive.rb

@@ -1,10 +1,16 @@
 # 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.
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id$
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus/parser.rb' # make sure that RawText class has been defined prior to extending it
 

data/lib/walrus/walrus_grammar/comment.rb

@@ -1,10 +1,16 @@
 # 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.
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id$
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus/parser.rb' # make sure that RawText class has been defined prior to extending it
 

data/lib/walrus/walrus_grammar/def_directive.rb

@@ -1,10 +1,16 @@
-# 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.
+# Copyright 2007-2009 Wincent Colaiuta
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id: /mirrors/Walrus/trunk/walrus/lib/walrus/walrus_grammar/def_directive.rb 6719 2007-04-10T15:00:33.886928Z wincent  $
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus/parser.rb' # make sure that RawText class has been defined prior to extending it
 
@@ -28,8 +34,10 @@ module Walrus
         
         nested  = nil
         
-        if @content.respond_to? :each   : content = @content
-        else                              content = [@content]
+        if @content.respond_to? :each
+          content = @content
+        else
+          content = [@content]
         end
         
         content.each do |element|

data/lib/walrus/walrus_grammar/echo_directive.rb

@@ -1,10 +1,16 @@
 # 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.
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id: /mirrors/Walrus/trunk/walrus/lib/walrus/walrus_grammar/echo_directive.rb 6701 2007-04-09T14:55:55.352472Z wincent  $
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus/parser.rb' # make sure that RawText class has been defined prior to extending it
 

data/lib/walrus/walrus_grammar/escape_sequence.rb

@@ -1,10 +1,16 @@
 # 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.
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id$
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus/parser.rb' # make sure that RawText class has been defined prior to extending it
 

data/lib/walrus/walrus_grammar/import_directive.rb

@@ -1,10 +1,16 @@
 # 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.
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# $Id$
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'walrus/parser.rb' # make sure that the class has been defined prior to extending it
 require 'ostruct'