walrus 0.2 → 0.3

data/lib/walrus/template.rb

@@ -1,29 +1,38 @@
-# Copyright 2007 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.
+# Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
 #
-# 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.
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
 #
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
 
 require 'walrus'
+require 'walrat/additions/string.rb'
 
 module Walrus
   class Template
-    
     attr_reader   :base_text
-    
-    # If initialized using a Pathname or File, returns the pathname. Otherwise returns nil.
+
+    # If initialized using a Pathname or File, returns the pathname.
+    # Otherwise returns nil.
     attr_reader   :origin
-    
+
     # Accepts input of class String, Pathname or File
-    def initialize(input)
+    def initialize input
       raise ArgumentError if input.nil?
       if input.respond_to? :read # should work with Pathname or File
         @base_text  = input.read
@@ -32,32 +41,33 @@ module Walrus
         @base_text  = input.to_s.clone
       end
     end
-    
-    # The fill method returns a string containing the output produced when executing the compiled template.
+
+    # The fill method returns a string containing the output produced when
+    # executing the compiled template.
     def fill
       @filled ||= instance_eval(compiled)
     end
-    
+
     def filled
       fill
     end
-    
+
     # Parses template, returning compiled input (suitable for writing to disk).
     def compile
       @parser   ||= Parser.new
       @compiled ||= @parser.compile(@base_text, :class_name => class_name, :origin => @origin)
     end
-    
+
     # Returns the compiled text of the receiver
     def compiled
       compile
     end
-    
+
     # Prints output obtained by running the compiled template.
     def run
       p fill
     end
-    
+
     def class_name
       if @class_name
         @class_name
@@ -69,7 +79,7 @@ module Walrus
         end
       end
     end
-    
+
     def strip_extensions(path)
       extension = File.extname(path)
       if extension != ""  # recurse
@@ -78,6 +88,5 @@ module Walrus
         path
       end
     end
-    
   end # class Template
 end # module Walrus

data/lib/walrus/version.rb

@@ -1,3 +1,26 @@
+# Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
 module Walrus
-  VERSION = '0.2'
+  VERSION   = '0.3'
+  COPYRIGHT = 'Copyright 2007-2010 Wincent Colaiuta'
 end # module Walrus

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Wincent Colaiuta
@@ -13,13 +13,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-14 00:00:00 +02:00
+date: 2010-08-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: wopen3
+  name: walrat
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: wopen3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -28,11 +40,11 @@ dependencies:
         - 1
         version: "0.1"
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mkdtemp
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -41,11 +53,11 @@ dependencies:
         - 0
         version: "1.0"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
@@ -55,13 +67,25 @@ dependencies:
         - 0
         version: 1.3.0
   type: :development
-  version_requirements: *id003
-description: "    Walrus is an object-oriented templating system inspired by and similar\n    to the Cheetah Python-powered template engine. It includes a Parser\n    Expression Grammar (PEG) parser generator capable of generating an\n    integrated lexer, \"packrat\" parser, and Abstract Syntax Tree (AST)\n    builder.\n"
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: "    Walrus is an object-oriented templating system inspired by and similar\n    to the Cheetah Python-powered template engine.\n"
 email: win@wincent.com
 executables: 
 - walrus
-extensions: 
-- ext/extconf.rb
+extensions: []
+
 extra_rdoc_files: []
 
 files: 
@@ -71,71 +95,34 @@ files:
 - lib/walrus/compiler.rb
 - lib/walrus/contrib/spec/walruscloth_spec.rb
 - lib/walrus/contrib/walruscloth.rb
-- lib/walrus/diff.rb
 - lib/walrus/document.rb
-- lib/walrus/grammar/additions/proc.rb
-- lib/walrus/grammar/additions/regexp.rb
-- lib/walrus/grammar/additions/string.rb
-- lib/walrus/grammar/additions/symbol.rb
-- lib/walrus/grammar/and_predicate.rb
-- lib/walrus/grammar/array_result.rb
-- lib/walrus/grammar/continuation_wrapper_exception.rb
-- lib/walrus/grammar/left_recursion_exception.rb
-- lib/walrus/grammar/location_tracking.rb
-- lib/walrus/grammar/match_data_wrapper.rb
-- lib/walrus/grammar/memoizing.rb
-- lib/walrus/grammar/memoizing_cache.rb
-- lib/walrus/grammar/node.rb
-- lib/walrus/grammar/not_predicate.rb
-- lib/walrus/grammar/parse_error.rb
-- lib/walrus/grammar/parser_state.rb
-- lib/walrus/grammar/parslet.rb
-- lib/walrus/grammar/parslet_choice.rb
-- lib/walrus/grammar/parslet_combination.rb
-- lib/walrus/grammar/parslet_combining.rb
-- lib/walrus/grammar/parslet_merge.rb
-- lib/walrus/grammar/parslet_omission.rb
-- lib/walrus/grammar/parslet_repetition.rb
-- lib/walrus/grammar/parslet_repetition_default.rb
-- lib/walrus/grammar/parslet_sequence.rb
-- lib/walrus/grammar/predicate.rb
-- lib/walrus/grammar/proc_parslet.rb
-- lib/walrus/grammar/regexp_parslet.rb
-- lib/walrus/grammar/skipped_substring_exception.rb
-- lib/walrus/grammar/string_enumerator.rb
-- lib/walrus/grammar/string_parslet.rb
-- lib/walrus/grammar/string_result.rb
-- lib/walrus/grammar/symbol_parslet.rb
+- lib/walrus/grammar/assignment_expression.rb
+- lib/walrus/grammar/block_directive.rb
+- lib/walrus/grammar/comment.rb
+- lib/walrus/grammar/def_directive.rb
+- lib/walrus/grammar/echo_directive.rb
+- lib/walrus/grammar/escape_sequence.rb
+- lib/walrus/grammar/import_directive.rb
+- lib/walrus/grammar/include_directive.rb
+- lib/walrus/grammar/instance_variable.rb
+- lib/walrus/grammar/literal.rb
+- lib/walrus/grammar/message_expression.rb
+- lib/walrus/grammar/multiline_comment.rb
+- lib/walrus/grammar/placeholder.rb
+- lib/walrus/grammar/raw_directive.rb
+- lib/walrus/grammar/raw_text.rb
+- lib/walrus/grammar/ruby_directive.rb
+- lib/walrus/grammar/ruby_expression.rb
+- lib/walrus/grammar/set_directive.rb
+- lib/walrus/grammar/silent_directive.rb
+- lib/walrus/grammar/slurp_directive.rb
+- lib/walrus/grammar/super_directive.rb
 - lib/walrus/grammar.rb
-- lib/walrus/no_parameter_marker.rb
 - lib/walrus/parser.rb
 - lib/walrus/runner.rb
 - lib/walrus/template.rb
 - lib/walrus/version.rb
-- lib/walrus/walrus_grammar/assignment_expression.rb
-- lib/walrus/walrus_grammar/block_directive.rb
-- lib/walrus/walrus_grammar/comment.rb
-- lib/walrus/walrus_grammar/def_directive.rb
-- lib/walrus/walrus_grammar/echo_directive.rb
-- lib/walrus/walrus_grammar/escape_sequence.rb
-- lib/walrus/walrus_grammar/import_directive.rb
-- lib/walrus/walrus_grammar/include_directive.rb
-- lib/walrus/walrus_grammar/instance_variable.rb
-- lib/walrus/walrus_grammar/literal.rb
-- lib/walrus/walrus_grammar/message_expression.rb
-- lib/walrus/walrus_grammar/multiline_comment.rb
-- lib/walrus/walrus_grammar/placeholder.rb
-- lib/walrus/walrus_grammar/raw_directive.rb
-- lib/walrus/walrus_grammar/raw_text.rb
-- lib/walrus/walrus_grammar/ruby_directive.rb
-- lib/walrus/walrus_grammar/ruby_expression.rb
-- lib/walrus/walrus_grammar/set_directive.rb
-- lib/walrus/walrus_grammar/silent_directive.rb
-- lib/walrus/walrus_grammar/slurp_directive.rb
-- lib/walrus/walrus_grammar/super_directive.rb
 - lib/walrus.rb
-- ext/jindex.c
-- ext/extconf.rb
 has_rdoc: true
 homepage: https://wincent.com/products/walrus
 licenses: []
@@ -145,7 +132,6 @@ rdoc_options: []
 
 require_paths: 
 - lib
-- ext
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="

data/ext/extconf.rb

@@ -1,16 +0,0 @@
-# Copyright 2007-2010 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.
-#
-# 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 'mkmf'
-create_makefile('jindex')

data/ext/jindex.c

@@ -1,92 +0,0 @@
-/*
-Copyright 2007-2010 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.
-
-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/>.
-*/
-
-#include <ruby.h>
-
-/*
-
-Common code used by almost identical "jindex" and "jrindex" methods. A C
-extension is necessary here because with direct access to the rb_backref_get
-and rb_backref_set API there is no way to propagate $~ back to the caller after
-invoking the "index" and "rindex" methods. The code is basically equivalent to
-the following Ruby code:
-
-def index arg1, optional_arg
-  index = super                                     # plus code here for deciding whether or not to pass optional argument
-  match = ($~ ? $~.clone : nil)
-  index unpack('C*')[0...index].pack('C*').jlength  # jlength clobbers $~ as a side effect, should consider rewriting it
-  $~ = match                                        # in pure Ruby setting $~ here has only a local effect (not seen by caller)
-  index
-end
-
-*/
-static VALUE walrus_str_index_common(ID func, int argc, VALUE *argv, VALUE str)
-{
-    VALUE jindex                = Qnil;                                                                 /* default return value */
-    VALUE index                 = rb_funcall2(str, func, argc, argv);                                   /* call String#index or String#rindex*/
-    VALUE match                 = rb_backref_get();                                                     /* save $~ */
-    if (!NIL_P(index))
-    {
-        VALUE packing_format    = rb_str_new2("C*");
-        VALUE unpacked          = rb_funcall(str, rb_intern("unpack"), 1, packing_format);              /* unpack('C*') */
-        VALUE range             = rb_funcall(rb_cRange, rb_intern("new"), 3, INT2FIX(0), index, Qtrue);
-        VALUE slice             = rb_funcall(unpacked, rb_intern("slice"), 1, range);                   /* [0...idx] */
-        VALUE packed            = rb_funcall(slice, rb_intern("pack"), 1, packing_format);              /* pack('C*') */
-        jindex                  = rb_funcall(packed, rb_intern("jlength"), 0);                          /* jlength */
-    }
-    rb_backref_set(match);                                                                              /* restore $~ */
-    return jindex;
-}
-
-/*
-
-call-seq:
-    str.jindex(substring [, offset])    -> Fixnum or nil
-    str.jindex(fixnum [, offset])       -> Fixnum or nil
-    str.jindex(regexp [, offset])       -> Fixnum or nil
-
-Multibyte-friendly equivalent of the String#index method. If $KCODE is
-appropriately set will return an accurate index based on character count rather
-than byte counts.
-
-*/
-static VALUE walrus_str_jindex_m(int argc, VALUE *argv, VALUE str)
-{
-    return walrus_str_index_common(rb_intern("index"), argc, argv, str);
-}
-
-/*
-
-call-seq:
-    str.jrindex(substring [, offset])   -> Fixnum or nil
-    str.jrindex(fixnum [, offset])      -> Fixnum or nil
-    str.jrindex(regexp [, offset])      -> Fixnum or nil
-
-Multibyte-friendly equivalent of the String#rindex method. If $KCODE is
-appropriately set will return an accurate index based on character count rather
-than byte counts.
-
-*/
-static VALUE walrus_str_jrindex_m(int argc, VALUE *argv, VALUE str)
-{
-    return walrus_str_index_common(rb_intern("rindex"), argc, argv, str);
-}
-
-void Init_jindex()
-{
-    rb_define_method(rb_cString, "jindex", walrus_str_jindex_m, -1);
-    rb_define_method(rb_cString, "jrindex", walrus_str_jrindex_m, -1);
-}

data/lib/walrus/diff.rb

@@ -1,95 +0,0 @@
-# Copyright 2007 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.
-#
-# 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 'open3'
-require 'pathname'
-require 'tempfile'
-
-# Simple wrapper for diff(1).
-class Diff
-  
-  def initialize(left, right)
-    raise ArgumentError.new('left may not be nil') unless left
-    raise ArgumentError.new('right may not be nil') unless right
-    
-    # keep a copy of the parameters (used by the diff method)
-    @left   = left.clone
-    @right  = right.clone
-    
-    if left.kind_of? Pathname and right.kind_of? Pathname
-      @output = self.compare_pathname_with_pathname(left, right)
-    elsif left.kind_of? String and right.kind_of? Pathname
-      @output = self.compare_string_with_pathname(left, right)
-    elsif left.kind_of? Pathname and right.kind_of? String
-      @output = self.compare_pathname_with_string(left, right)
-    elsif left.kind_of? String and right.kind_of? String
-      @output = self.compare_string_with_string(left, right)
-    else
-      raise ArgumentError.new('unsupported argument types (%s, %s)' % [left.class.to_s, right.class.to_s])
-    end
-    
-  end
-  
-  def compare_pathname_with_pathname(left, right)
-    self.diff(left.realpath, right.realpath)
-  end
-  
-  def compare_string_with_pathname(left, right)
-    # will pipe left in over standard input
-    self.diff('-', right.realpath)
-  end
-  
-  def compare_pathname_with_string(left, right)
-    # will pipe right in over standard input
-    self.diff(left.realpath, '-')
-  end
-  
-  # This is the least secure comparison method because it requires the creation of a temporary file and Ruby's builtin Tempfile class is not secure.
-  def compare_string_with_string(left, right)
-    # incorporate a psuedo-random component to make race conditions more difficult to exploit
-    tempfile = Tempfile.new('walrus-%s' % rand(100000).to_s)
-    tempfile.unlink  # shut the race condition vulnerability window as soon as possible
-    tempfile.write(left)
-    tempfile.close
-    self.diff(tempfile.path, "-")
-  end
-  
-  # Actually runs diff(1) with the supplied arguments (pathnames). One but not both of the arguments may be "-" to indicate the standard input.
-  def self.diff(left, right)
-    raise ArgumentError.new('left may not be ni') unless left
-    raise ArgumentError.new('right may not be nil') unless right
-    raise ArgumentError.new('only one parameter may be "-"') if left == '-' and right == '-'
-    
-    # no shell involved, so no need to escape shell metacharacters
-    Open3.popen3('diff', '-u', left, right) do |stdin, stdout, stderr|
-      if left == '-'
-        stdin.write(@left)
-      elsif right == '-'
-        stdin.write(@right)
-      end
-      stdin.close_write
-      
-      # TODO: decide what to do with stderr output (if any)
-      stderr.read
-      return stdout.read
-    end
-    
-  end
-  
-  def to_s
-    @output
-  end
-  
-end