erubis-cached-text 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGQyZGM1YzMzNmE4ODcxYmYzZGZiMjEwNTM1Njg5OGVlZjEzNzgxNg==
+  data.tar.gz: !binary |-
+    ZjU1ZDg2ZDY5MTM5OTc2NmFjZTNhNDQwNjBlYzI3N2EwMTZhYzQ5Mw==
+SHA512:
+  metadata.gz: !binary |-
+    OWMyYWY2YzEzNTAyYWNiNjYwMjc4NzViZmQ5NTkzZDIxN2Q2YmQ5ZDIwNjVh
+    Yjg1ZDMwNTY3NDkxZmIzMzQ4OGFhZTIxODQ5ZDNhZWRjZjg1OWMzZjY2OTJi
+    MWNiZDAwNjYxOGM4MjYwZjc1ZTA4NzYwNGMzMDFkZTMxNGYwYmI=
+  data.tar.gz: !binary |-
+    OWM2ZjU4MTUwYjk3MzlmNjFiMDU5YzA2ZTE2YmFmN2RlZjc1MDg0OGNjMzI3
+    MGM1OWVmMDdhMjRlM2VlYTI4M2FjMWMxODUwYmIwZDE5MjAyZDBjYzZkMzA2
+    YTAyYjEyNzQ2MjFmNzc3OTU4OTMxMWU3YmY5YTgxMGNiNThkMDg=

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,24 @@
+Files in /benchmark copyright kuwata-lab.com (see benchmark/MIT-LICENSE)
+
+Files in /lib are under the following license:
+
+Copyright (c) 2014 by Luke Gruber
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+Erubis Cached Text: All ur HTML are belong 2 MEMRY
+==================================================
+
+What is it?
+-----------
+
+It's an Eruby engine (using Erubis) that caches static text in memory instead
+of instantiating these String objects every time the Eruby template is rendered.
+Basically, this means a bit more memory is consumed by your Ruby process, but
+rendering time is reduced (and how!).
+
+How much faster is it?
+----------------------
+
+This depends entirely on how much static text you have in your templates. If
+your template is entirely code, it won't save you any time at all. However,
+for templates with lots of static text (such as HTML, JavaScript, etc), the
+speed difference is quite substantial. I plan on benchmarking it a lot more
+in the near future, but right now I just have a 600 line HTML template with a
+few lines of code and in THIS situation it's 3x faster than normal Erubis
+rendering.
+
+Also, less allocations means less time spent in GC :)
+
+How can I use it?
+-----------------
+
+    gem 'erubis-cached-text'
+    require 'erubis_cached_text'
+
+The rest is the same, just use the class Erubis::ErubyCachedText instead of
+the engine you used to use (such as Erubis::Eruby).
+
+How can I use it with Rails?
+----------------------------
+
+I'll be coming out with a gem soon for use with Rails.

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/benchmark/MIT-LICENSE

@@ -0,0 +1,20 @@
+copyright(c) 2006-2011 kuwata-lab.com all rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/benchmark/Makefile

@@ -0,0 +1,6 @@
+
+bench:
+	ruby bench.rb -n 10000
+
+clean:
+	rm -rf bench_*.rhtml*

data/benchmark/bench.rb

@@ -0,0 +1,289 @@
+#!/usr/bin/env ruby
+
+###
+### $Release: 2.7.0 $
+### copyright(c) 2006-2011 kuwata-lab.com all rights reserved.
+###
+#
+# Modifications made by luke-gru 2014
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+Dir.chdir File.expand_path('../', __FILE__)
+
+require 'erb'
+require 'erubis'
+require 'erubis/tiny'
+require 'erubis/engine/enhanced'
+require 'erubis_cached_text'
+require 'yaml'
+require 'cgi'
+include ERB::Util
+
+begin
+  require 'eruby'
+rescue LoadError
+  ERuby = nil
+end
+
+def File.write(filename, content)
+  File.open(filename, 'w') { |f| f.write(content) }
+end
+
+## change benchmark library to use $stderr instead of $stdout
+require 'benchmark'
+module Benchmark
+  class Report
+    def print(*args)
+      $stderr.print(*args)
+    end
+  end
+  module_function
+  def print(*args)
+    $stderr.print(*args)
+  end
+end
+
+
+class BenchmarkApplication
+
+  TARGETS = %w[
+               ERB(cached)
+               Erubis::Eruby(cached)
+               Erubis::ErubyCachedText(cached)
+               Erubis::FastEruby(cached)
+              ]
+
+  def initialize(ntimes, context, targets=nil, params={})
+    @ntimes      = ntimes
+    @context     = context
+    @targets     = targets && !targets.empty? ? targets : TARGETS.dup
+    @testmode    = params[:testmode]    || 'execute'
+    @erubyfile   = params[:erubyfile]   || 'erubybench.rhtml'
+    @printout    = params[:printout]    || false
+  end
+
+  attr_accessor :ntimes, :targets
+  attr_accessor :testmode, :erubyfile, :contextfile, :printout
+
+  def context2code(context, varname='context')
+    s = ''
+    context.each { |k, | s << "#{k} = #{varname}[#{k.inspect}]; " }
+    return s
+  end
+
+  def perform_benchmark
+    width = 30
+    $stderr.puts "*** ntimes=#{@ntimes}, testmode=#{@testmode}"
+    Benchmark.bm(width) do |job|
+      for target in @targets do
+        method = "#{@testmode}_#{target.gsub(/::|-|\(/, '_').gsub(/\)/, '').downcase}"
+        #$stderr.puts "*** debug: method=#{method.inspect}"
+        next unless self.respond_to?(method)
+        filename = "bench_#{(target =~ /^(\w+)/) && $1.downcase}.rhtml"
+        title = target
+        output = nil
+        job.report(title) do
+          output = self.__send__(method, filename, @context)
+        end
+        File.write("output.#{target.gsub(/[^\w]/,'')}", output) if @printout && output && !output.empty?
+      end
+    end
+  end
+
+  ##
+
+  def execute_eruby(filename, context)
+    return unless ERuby
+    list = context['list']
+    @ntimes.times do
+      ERuby.import(filename)
+    end
+    return nil
+  end
+
+  def execute_erb(filename, context)
+    list = context['list']
+    output = nil
+    @ntimes.times do
+      eruby = ERB.new(File.read(filename))
+      output = eruby.result(binding())
+      print output
+    end
+    return output
+  end
+
+  def execute_erb_cached(filename, context)
+    list = context['list']
+    output = nil
+    cachefile = filename + '.cache'
+    File.unlink(cachefile) if test(?f, cachefile)
+    if !test(?f, cachefile) || File.mtime(filename) > File.mtime(cachefile)
+      eruby = ERB.new(File.read(filename))
+      File.write(cachefile, eruby.src)
+    end
+    @ntimes.times do
+      eruby = ERB.new('')
+      eruby.instance_variable_set("@src", File.read(cachefile))
+      output = eruby.result(binding())
+      print output
+    end
+    return output
+  end
+
+  ## cached
+  for klass in %w[Eruby ErubyCachedText FastEruby] do
+    s = <<-END
+    def execute_erubis_#{klass.downcase}_cached(filename, context)
+      list = context['list']
+      cachefile = filename + '.cache'
+      File.unlink(cachefile) if test(?f, cachefile)
+      output = nil
+      @ntimes.times do
+        eruby = Erubis::#{klass}.load_file(filename)
+        output = eruby.result(binding())
+        print output
+      end
+      savefile = cachefile.sub(/\\.cache$/, '.#{klass.downcase}.cache')
+      File.rename(cachefile, savefile)
+      return output
+    end
+    END
+    eval s
+  end
+
+  ##
+
+  def convert_eruby(filename, context)
+    return unless ERuby
+    list = context['list']
+    output = nil
+    @ntimes.times do
+      output = ERuby::Compiler.new.compile_string(File.read(filename))
+    end
+    return output
+  end
+
+  def convert_erb(filename, context)
+    list = context['list']
+    output = nil
+    @ntimes.times do
+      eruby = ERB.new(File.read(filename))
+      output = eruby.src
+    end
+    return output
+  end
+
+  for klass in %w[Eruby ErubyCachedText FastEruby TinyEruby]
+    s = <<-END
+      def convert_erubis_#{klass.downcase}(filename, context)
+        list = context['list']
+        output = nil
+        @ntimes.times do
+          eruby = Erubis::#{klass}.new(File.read(filename))
+          output = eruby.src
+        end
+        return output
+      end
+    END
+    eval s
+  end
+
+end
+
+
+require 'optparse'
+
+class MainApplication
+
+  def parse_argv(argv=ARGV)
+    optparser = OptionParser.new
+    options = {}
+    ['-h', '-n N', '-t erubyfile', '-f contextfile', '-A', '-e',
+      '-x exclude', '-m testmode', '-X', '-p', '-D'].each do |opt|
+      optparser.on(opt) { |val| options[opt[1].chr] = val }
+    end
+    begin
+      targets = optparser.parse!(argv)
+    rescue => ex
+      $stderr.puts "#{@script}: #{ex.to_s}"
+      exit(1)
+    end
+    return options, targets
+  end
+
+  def execute
+    @script = File.basename($0)
+    ntimes = 1000
+    targets = BenchmarkApplication::TARGETS.dup
+    testmode = 'execute'
+    contextfile = 'bench_context.yaml'
+    #
+    options, args = parse_argv(ARGV)
+    ntimes      = options['n'].to_i if options['n']
+    targets     = args if args && !args.empty?
+    targets     = targets - options['x'].split(/,/) if options['x']
+    testmode    = options['m'] if options['m']
+    contextfile = options['f'] if options['f']
+    erubyfile   = options['t'] if options['t']
+    #
+    if options['h']
+      $stderr.puts "Usage: ruby #{@script} [..options..] [..targets..]"
+      $stderr.puts "  -h           :  help"
+      $stderr.puts "  -n N         :  loop N times"
+      $stderr.puts "  -f datafile  :  context data filename (*.yaml)"
+      $stderr.puts "  -x exclude   :  exclude target name"
+      $stdout.puts "  -m testmode  :  'execute' or 'convert' (default 'execute')"
+      $stderr.puts "  -p           :  print output to file (filename: 'output.TARGETNAME')"
+      return
+    end
+    #
+    #if ! options['t']
+    for item in %w[eruby erb erubis]
+      fname = "bench_#{item}.rhtml"
+      header = File.read("templates/_header.html")
+      #body   = File.read("templates/#{erubyfile}")
+      body   = File.read("templates/#{fname}")
+      footer = File.read("templates/_footer.html")
+      content = header + body + footer
+      File.write(fname, content)
+    end
+    #
+    if options['e']   # escape
+      tuples = [
+        [ 'bench_eruby.rhtml',  '<%= CGI.escapeHTML((\1).to_s) %>' ],
+        [ 'bench_erb.rhtml',    '<%=h \1 %>' ],
+        [ 'bench_erubis.rhtml', '<%== \1 %>' ],
+      ]
+      for fname, replace in tuples
+        content = File.read(fname).gsub(/<%= ?(.*?) ?%>/, replace)
+        File.write(fname, content)
+      end
+      targets.delete('Erubis::TinyEruby')   ## because TinyEruby doesn't support '<%== =>'
+    end
+    #
+    context = YAML.load_file(contextfile)
+    #
+    params = {
+      :printout=>options['p'],
+      :testmode=>testmode,
+    }
+    app = BenchmarkApplication.new(ntimes, context, targets, params)
+    app.perform_benchmark()
+  end
+
+end
+
+
+if __FILE__ == $0
+
+  ## open /dev/null
+  $stdout = File.open('/dev/null', 'w')
+  at_exit do
+    $stdout.close()
+  end
+
+  ## start benchmark
+  MainApplication.new().execute()
+
+end

data/benchmark/bench_context.yaml

@@ -0,0 +1,141 @@
+list:
+  - name:       Adobe Systems
+    name2:      Adobe Systems Inc.
+    url:        http://www.adobe.com
+    symbol:     ADBE
+    price:      39.26
+    change:     0.13
+    ratio:      0.33
+  - name:       Advanced Micro Devices
+    name2:      Advanced Micro Devices Inc.
+    url:        http://www.amd.com
+    symbol:     AMD
+    price:      16.22
+    change:     0.17
+    ratio:      1.06
+  - name:       Amazon.com
+    name2:      Amazon.com Inc
+    url:        http://www.amazon.com
+    symbol:     AMZN
+    price:      36.85
+    change:     -0.23
+    ratio:      -0.62
+  - name:       Apple
+    name2:      Apple Inc.
+    url:        http://www.apple.com
+    symbol:     AAPL
+    price:      85.38
+    change:     -0.87
+    ratio:      -1.01
+  - name:       BEA Systems
+    name2:      BEA Systems Inc.
+    url:        http://www.bea.com
+    symbol:     BEAS
+    price:      12.46
+    change:     0.09
+    ratio:      0.73
+  - name:       CA
+    name2:      CA, Inc.
+    url:        http://www.ca.com
+    symbol:     CA
+    price:      24.66
+    change:     0.38
+    ratio:      1.57
+  - name:       Cisco Systems
+    name2:      Cisco Systems Inc.
+    url:        http://www.cisco.com
+    symbol:     CSCO
+    price:      26.35
+    change:     0.13
+    ratio:      0.5
+  - name:       Dell
+    name2:      Dell Corp.
+    url:        http://www.dell.com/
+    symbol:     DELL
+    price:      23.73
+    change:     -0.42
+    ratio:      -1.74
+  - name:       eBay
+    name2:      eBay Inc.
+    url:        http://www.ebay.com
+    symbol:     EBAY
+    price:      31.65
+    change:     -0.8
+    ratio:      -2.47
+  - name:       Google
+    name2:      Google Inc.
+    url:        http://www.google.com
+    symbol:     GOOG
+    price:      495.84
+    change:     7.75
+    ratio:      1.59
+  - name:       Hewlett-Packard
+    name2:      Hewlett-Packard Co.
+    url:        http://www.hp.com
+    symbol:     HPQ
+    price:      41.69
+    change:     -0.02
+    ratio:      -0.05
+  - name:       IBM
+    name2:      International Business Machines Corp.
+    url:        http://www.ibm.com
+    symbol:     IBM
+    price:      97.45
+    change:     -0.06
+    ratio:      -0.06
+  - name:       Intel
+    name2:      Intel Corp.
+    url:        http://www.intel.com
+    symbol:     INTC
+    price:      20.53
+    change:     -0.07
+    ratio:      -0.34
+  - name:       Juniper Networks
+    name2:      Juniper Networks, Inc
+    url:        http://www.juniper.net/
+    symbol:     JNPR
+    price:      18.96
+    change:     0.5
+    ratio:      2.71
+  - name:       Microsoft
+    name2:      Microsoft Corp
+    url:        http://www.microsoft.com
+    symbol:     MSFT
+    price:      30.6
+    change:     0.15
+    ratio:      0.49
+  - name:       Oracle
+    name2:      Oracle Corp.
+    url:        http://www.oracle.com
+    symbol:     ORCL
+    price:      17.15
+    change:     0.17
+    ratio:      1.0
+  - name:       SAP
+    name2:      SAP AG
+    url:        http://www.sap.com
+    symbol:     SAP
+    price:      46.2
+    change:     -0.16
+    ratio:      -0.35
+  - name:       Seagate Technology
+    name2:      Seagate Technology
+    url:        http://www.seagate.com/
+    symbol:     STX
+    price:      27.35
+    change:     -0.36
+    ratio:      -1.3
+  - name:       Sun Microsystems
+    name2:      Sun Microsystems Inc.
+    url:        http://www.sun.com
+    symbol:     SUNW
+    price:      6.33
+    change:     -0.01
+    ratio:      -0.16
+  - name:       Yahoo
+    name2:      Yahoo! Inc.
+    url:        http://www.yahoo.com
+    symbol:     YHOO
+    price:      28.04
+    change:     -0.17
+    ratio:      -0.6