erbal 1.0 → 1.1

data/README.rdoc

@@ -14,8 +14,8 @@ Erbal is a lightweight ERB parser that uses the Ragel State Machine Compiler (ht
 
 Erbal.new takes an optional 2nd argument which is a hash of options, available options are:
 
-    * `:buffer`   The name of the output buffer, default is '@output_buffer'
-    * `:buffer_initial_value`   The initial value of the output buffer, defaults to a blank string.
+* :buffer                   The name of the output buffer, default is '@output_buffer'
+* :buffer_initial_value     The initial value of the output buffer, defaults to a blank string.
 
 == Rails 2.3
 
@@ -28,6 +28,50 @@ Create the file 'config/initializers/erbal.rb' containing:
 
 I've not looked into yet.. patches are welcome! ;)
 
+== Benchmarks
+
+These benchmarks were run on a Mac OS X 10.6.4, 2.66 Ghx Intel Core i5 with 8 GB of 1067 MHz DDR3 RAM.
+
+Ruby: 1.8.7 (2010-04-19 patchlevel 253) [i686-darwin10.4.0], MBARI 0x6770, Ruby Enterprise Edition 2010.02
+Erubis: 2.6.6
+Erbal: 1.1
+
+    => Parsing Benchmark
+
+    => Erb
+    0.851 0.853 0.848 0.847 0.849 0.847
+    => Average: 0.849
+
+    => Erubis (using FastEruby engine)
+    0.442 0.442 0.444 0.442 0.441 0.442
+    => Average: 0.442
+
+    => Erubis (using default Eruby engine)
+    0.451 0.424 0.446 0.425 0.445 0.446
+    => Average: 0.439
+
+    => Erbal
+    0.036 0.039 0.066 0.038 0.067 0.039
+    => Average: 0.047
+
+    => eval() Benchmark
+
+    => Erb
+    0.203 0.192 0.180 0.180 0.179 0.191
+    => Average: 0.187
+
+    => Erubis (using FastEruby engine)
+    0.129 0.127 0.128 0.128 0.114 0.128
+    => Average: 0.125
+
+    => Erubis (using default Eruby engine)
+    0.178 0.176 0.165 0.176 0.175 0.164
+    => Average: 0.172
+
+    => Erbal
+    0.111 0.125 0.124 0.110 0.133 0.124
+    => Average: 0.121
+
 == Contributing
 
 * Fork the project.

data/benchmark/bench.rb

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 require 'erb'
 require 'rubygems'
 require 'erubis'
@@ -5,31 +7,46 @@ require File.expand_path(File.dirname(__FILE__)) + '/../lib/erbal'
 
 RUNS = 3000
 REPEAT = 6
-SRC = File.read('sample.erb')
+SRC = File.read(File.expand_path(File.dirname(__FILE__)) + '/sample.erb')
 
 class Benchmark
-  def self.run(runs, repeat, warmup=false)
-    puts "\n=> #{self.name.split('Benchmark').first}:" unless warmup
+  def self.run(what, runs, repeat, warmup=false)
+    puts "\n=> #{canonical_name}" unless warmup
     times = []
     repeat.times do |i|
       total = 0
-      runs.times do
+      runs.times do |n|
         start = Time.now
-        parse
+        send(what)
         total += Time.now-start
       end
       times << total
-      puts " #{i+1}) #{sprintf("%.3f", total)}" unless warmup
+      unless warmup
+        $stdout.write(sprintf("%.3f ", total))
+        $stdout.flush
+      end
     end
     unless warmup
-      puts "=> Average: #{sprintf("%.3f", times.inject(0){|c, n| c += n} / times.size)}"
+      puts "\n=> Average: #{sprintf("%.3f", times.inject(0){|c, n| c += n} / times.size)}"
     end
   end
+
+  def self.prep_for_eval
+    @src = parse
+  end
+
+  def self.eval_src
+    eval(@src)
+  end
+
+  def self.canonical_name
+    name.split('Benchmark').first
+  end
 end
 
 class ErbalBenchmark < Benchmark
   def self.parse
-    Erbal.new(SRC, "@output").parse
+    Erbal.new(SRC).parse
   end
 end
 
@@ -37,21 +54,45 @@ class ErbBenchmark < Benchmark
   def self.parse
     ::ERB.new(SRC, nil, '-', '@output')
   end
+
+  def self.prep_for_eval
+    @src = parse.src
+  end
 end
 
-class ErubisBenchmark < Benchmark
+class ErubisFastBenchmark < Benchmark
   def self.parse
     Erubis::FastEruby.new.convert(SRC)
   end
+
+  def self.canonical_name
+    "Erubis (using FastEruby engine)"
+  end
+end
+
+class ErubisBenchmark < Benchmark
+  def self.parse
+    Erubis::Eruby.new.convert(SRC)
+  end
+
+  def self.canonical_name
+    "Erubis (using default Eruby engine)"
+  end
 end
 
-parsers = [ErbBenchmark, ErbalBenchmark, ErubisBenchmark]
+parsers = [ErbBenchmark, ErubisFastBenchmark, ErubisBenchmark, ErbalBenchmark]
 
 $stdout.write("=> Warming up.... ")
 $stdout.flush
 parsers.each do |b|
-  b.run(RUNS, 1, true)
+  b.run(:parse, 10, 2, true)
 end
 puts "done"
-puts "=> #{RUNS} runs repeated #{REPEAT} times"
-parsers.map {|b| b.run(RUNS, REPEAT)}
+puts
+puts "=> Parsing Benchmark"
+parsers.map {|b| b.run(:parse, RUNS, REPEAT)}
+
+puts
+puts "=> eval() Benchmark"
+parsers.map {|b| b.prep_for_eval}
+parsers.map {|b| b.run(:eval_src, RUNS, REPEAT)}

data/benchmark/mem_leak_detect.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/erbal'
+
+SRC = File.read(File.expand_path(File.dirname(__FILE__)) + '/sample.erb')
+GC.enable_stats
+
+i = 0
+while true do
+  i += 1
+  5000.times do
+    e = Erbal.new(SRC)
+    e.parse
+  end
+  GC.start
+  rss = `ps -orss #{Process.pid}`.split("\n").last.strip
+  puts
+  puts "Run #{i}"
+  puts "RSS #{rss}"
+  puts "Live objects #{ObjectSpace.live_objects}"
+  GC.dump
+end

data/benchmark/sample.erb

@@ -1,24 +1,20 @@
-Lorem ipsum dolor sit amet, <% consectetur adipisicing elit -%>, sed do eiusmod tempor incididunt ut labore et dolore magna <%= aliqua -%>.
-<%= Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in
-reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. %>
-<% Excepteur sint occaecat -%> cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est <%= laborum -%>.
-
-<% Lorem %> ipsum dolor sit amet, <% consectetur %> adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
-Ut enim ad minim veniam, <%# quis nostrud exercitation ullamco laboris nisi ut aliquip ex -%> ea commodo consequat. Duis aute irure dolor in
-<%= reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur -%>.
-Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim <%= id est laborum -%>.
-
-<%= Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -%>
-<% Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. %>
-<%= Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. %>
-<%#= Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. -%>
-
-Lorem ipsum dolor sit amet, consectetur adipisicing elit, <% sed do eiusmod tempor incididunt ut -%> labore et dolore magna aliqua.
-Ut enim ad minim veniam, quis nostrud <%=%> exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
-Duis aute irure dolor in reprehenderit in -%> <% voluptate velit esse cillum dolore eu fugiat nulla pariatur.
-Excepteur sint occaecat cupidatat non proident, sunt -%> in culpa qui officia deserunt mollit <%= anim id est laborum -%>.
-
-Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
-Ut enim ad minim veniam, <% quis -%> nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
-Duis aute irure dolor in reprehenderit in <%= voluptate velit -%> esse cillum dolore eu fugiat nulla pariatur.
-Excepteur sint occaecat cupidatat non proident, sunt in culpa <%= qui -%> <%= officia -%> <%= deserunt -%> <%= mollit -%> <%= anim -%> <%= id est laborum. -%>
+Hello! I'm the sample Erbal template.
+
+The time now is: <%= Time.now -%>
+
+<% if true %>
+  Once upon a time there was a small pig called Pinki. He died.
+<% end -%>
+
+1 + 1 is: <%= 1 + 1 %>
+<%= "2 + 2 is :#{2 + 2}" %>
+
+<%= %><%= %><%= "hi mom" %><%= %><%= -%><% true || false %>
+
+#{exit 1}
+
+`exit 1`
+
+<%# almost the end %>
+
+"The end."

data/ext/erbal/erbal.c

@@ -3,15 +3,9 @@
 
 static VALUE cErbal;
 
-void rb_erbal_free(void *data) {
-  if(data) {
-    free(data);
-  }
-}
-
 VALUE rb_erbal_alloc(VALUE klass) {
-  erbal_parser *parser = ALLOC_N(erbal_parser, 1);
-  VALUE obj = Data_Wrap_Struct(klass, NULL, rb_erbal_free, parser);
+  erbal_parser *parser = ALLOC(erbal_parser);
+  VALUE obj = Data_Wrap_Struct(klass, 0, free, parser);
   return obj;
 }
 
@@ -22,7 +16,7 @@ VALUE rb_erbal_initialize(int argc, VALUE *argv, VALUE self) {
 
   Check_Type(str, T_STRING);
 
-  erbal_parser *parser = NULL;
+  erbal_parser *parser;
   Data_Get_Struct(self, erbal_parser, parser);
   parser->str = str;
 
@@ -33,13 +27,32 @@ VALUE rb_erbal_initialize(int argc, VALUE *argv, VALUE self) {
     parser->options = options;
   }
 
+  rb_iv_set(self, "@options", parser->options);
+
+  if (rb_hash_aref(parser->options, ID2SYM(rb_intern("debug"))) == Qtrue) {
+    parser->debug = 1;
+  } else {
+    parser->debug = 0;
+  }
+
+  VALUE buffer_name_val = rb_hash_aref(parser->options, ID2SYM(rb_intern("buffer")));
+
+  if (!NIL_P(buffer_name_val)) {
+    Check_Type(buffer_name_val, T_STRING);
+    parser->buffer_name = buffer_name_val;
+  } else {
+    parser->buffer_name = rb_str_new2("@output_buffer");
+  }
+
+  rb_iv_set(self, "@buffer_name", parser->buffer_name);
+
   return self;
 }
 
 VALUE rb_erbal_parse(VALUE self) {
-  erbal_parser *parser = NULL;
+  erbal_parser *parser;
   Data_Get_Struct(self, erbal_parser, parser);
-  erbal_parser_init(parser);
+  erbal_parser_init(self, parser);
   erbal_parser_exec(parser);
   return parser->src;
 }

data/ext/erbal/parser.c

@@ -164,28 +164,14 @@ inline void erbal_parser_finish(erbal_parser *parser) {
   }
 }
 
-void erbal_parser_init(erbal_parser *parser) {
+void erbal_parser_init(VALUE self, erbal_parser *parser) {
   parser->chars_seen = 0;
   parser->in_buffer_shift = 0;
 	parser->state = OUTSIDE_TAG;
-
-  if (rb_hash_aref(parser->options, ID2SYM(rb_intern("debug"))) == Qtrue) {
-    parser->debug = 1;
-  } else {
-    parser->debug = 0;
-  }
-
-  VALUE buffer_name_val = rb_hash_aref(parser->options, ID2SYM(rb_intern("buffer")));
-
-  if (!NIL_P(buffer_name_val)) {
-    Check_Type(buffer_name_val, T_STRING);
-    parser->buffer_name = buffer_name_val;
-  } else {
-    parser->buffer_name = rb_str_new2("@output_buffer");
-  }
-
   parser->src = rb_str_dup(parser->buffer_name);
 
+  rb_iv_set(self, "@src", parser->src);
+
   VALUE buffer_init_val = rb_hash_aref(parser->options, ID2SYM(rb_intern("buffer_initial_value")));
 
   if (!NIL_P(buffer_init_val)) {
@@ -198,7 +184,7 @@ void erbal_parser_init(erbal_parser *parser) {
   }
 
   
-#line 202 "parser.c"
+#line 188 "parser.c"
 	{
 	cs = erbal_parser_start;
 	ts = 0;
@@ -206,14 +192,14 @@ void erbal_parser_init(erbal_parser *parser) {
 	act = 0;
 	}
 
-#line 200 "parser.rl"
+#line 186 "parser.rl"
 }
 
 void erbal_parser_exec(erbal_parser *parser) {
   p = RSTRING(parser->str)->ptr;
   pe = p + strlen(p);
   
-#line 217 "parser.c"
+#line 203 "parser.c"
 	{
 	if ( p == pe )
 		goto _test_eof;
@@ -263,7 +249,7 @@ st1:
 case 1:
 #line 1 "NONE"
 	{ts = p;}
-#line 267 "parser.c"
+#line 253 "parser.c"
 	switch( (*p) ) {
 		case 37: goto st2;
 		case 45: goto tr4;
@@ -285,7 +271,7 @@ st3:
 	if ( ++p == pe )
 		goto _test_eof3;
 case 3:
-#line 289 "parser.c"
+#line 275 "parser.c"
 	if ( (*p) == 37 )
 		goto st0;
 	goto tr6;
@@ -335,6 +321,6 @@ case 5:
 
 	}
 
-#line 206 "parser.rl"
+#line 192 "parser.rl"
   erbal_parser_finish(parser);
 }

data/ext/erbal/parser.rl

@@ -163,28 +163,14 @@ inline void erbal_parser_finish(erbal_parser *parser) {
   }
 }
 
-void erbal_parser_init(erbal_parser *parser) {
+void erbal_parser_init(VALUE self, erbal_parser *parser) {
   parser->chars_seen = 0;
   parser->in_buffer_shift = 0;
 	parser->state = OUTSIDE_TAG;
-
-  if (rb_hash_aref(parser->options, ID2SYM(rb_intern("debug"))) == Qtrue) {
-    parser->debug = 1;
-  } else {
-    parser->debug = 0;
-  }
-
-  VALUE buffer_name_val = rb_hash_aref(parser->options, ID2SYM(rb_intern("buffer")));
-
-  if (!NIL_P(buffer_name_val)) {
-    Check_Type(buffer_name_val, T_STRING);
-    parser->buffer_name = buffer_name_val;
-  } else {
-    parser->buffer_name = rb_str_new2("@output_buffer");
-  }
-
   parser->src = rb_str_dup(parser->buffer_name);
 
+  rb_iv_set(self, "@src", parser->src);
+
   VALUE buffer_init_val = rb_hash_aref(parser->options, ID2SYM(rb_intern("buffer_initial_value")));
 
   if (!NIL_P(buffer_init_val)) {

data/tasks/gem.rake

@@ -2,7 +2,7 @@ require 'rake/gempackagetask'
 require 'yaml'
 
 WIN_SUFFIX = ENV['WIN_SUFFIX'] || 'i386-mswin32'
-ERBAL_VERSION = '1.0'
+ERBAL_VERSION = '1.1'
 
 task :clean => :clobber_package
 

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: erbal
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 1
-  - 0
-  version: "1.0"
+  - 1
+  version: "1.1"
 platform: ruby
 authors: 
 - Ian Leitch
@@ -38,6 +38,7 @@ files:
 - tasks/gem.rake
 - tasks/spec.rake
 - benchmark/bench.rb
+- benchmark/mem_leak_detect.rb
 - benchmark/sample.erb
 - ext/erbal/parser.h
 - ext/erbal/erbal.c