opulent 1.7.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4725037738209f23895d883b56c94866adbb606
-  data.tar.gz: 33953652ff3ff0a690164bf426eb9f201ab7eeff
+  metadata.gz: 7441c9029694ce515a43f6ad45a35bab1b9b7044
+  data.tar.gz: 1886d078184cca281cf0cbaaed59b3fb0e5b54ec
 SHA512:
-  metadata.gz: eb6aecbe587a2507ed10b93e555d03e485d8b87b6aa9230d6950b46972fc6e0381b92ac0081df5c8714501f16b39da18c4ed4bc5bda6e115bf021c7347697dc4
-  data.tar.gz: e4250d20292067ce5688553822fce21421545108629786776ea10b0074094c1d45b53fb57a713dbf09ee7120b132a347776ccad53e74c340655146480872f1f9
+  metadata.gz: 7c4258afca739fd317c388dbae614368ed6ca1c31b37a6eeccffb05de13a07082251fc6322ff5c60cdbe27f856c49342b5213d835c3469fb50b8af7666052c0b
+  data.tar.gz: 98e93d68cf0f1c145836dc83ca8a47048ea23250b2778fc94f5a785e015172720e875c691d62a3a85c5b526e37a39ce16c45cf747d4d3c5b46182433fb18075e

data/Rakefile

@@ -1,6 +1,12 @@
 require "bundler/gem_tasks"
-#require "rspec/core/rake_task"
+require "rspec/core/rake_task"
 
-#RSpec::Core::RakeTask.new(:spec)
 
-#task :default => :spec
+# RSpec task
+RSpec::Core::RakeTask.new(:spec)
+task :test => :spec
+
+# Benchmarking task
+task :benchmark do
+  ruby 'benchmarks/run-benchmarks.rb'
+end

data/benchmarks/context.rb

@@ -0,0 +1,11 @@
+class Context
+  def header
+    'Colors'
+  end
+
+  def item
+    [ { name: 'red',   current: true,  url: '#red'   },
+      { name: 'green', current: false, url: '#green' },
+      { name: 'blue',  current: false, url: '#blue'  } ]
+  end
+end

data/benchmarks/run-benchmarks.rb

@@ -0,0 +1,134 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'), File.dirname(__FILE__))
+
+require 'benchmark/ips'
+
+require 'tilt'
+require 'opulent'
+require 'erubis'
+require 'erb'
+require 'haml'
+require 'slim'
+
+require_relative 'context'
+
+class Benchmarks
+  def initialize(slow)
+    @benches = Hash.new { |h, k| h[k] = [] }
+
+    @opulent_code  = File.read(File.dirname(__FILE__) + '/view.erb')
+    @erb_code  = File.read(File.dirname(__FILE__) + '/view.erb')
+    @haml_code = File.read(File.dirname(__FILE__) + '/view.haml')
+    @slim_code = File.read(File.dirname(__FILE__) + '/view.slim')
+
+    init_compiled_benches
+    init_tilt_benches
+    init_parsing_benches if slow
+  end
+
+  def init_compiled_benches
+    haml_pretty = Haml::Engine.new(@haml_code, format: :html5, escape_attrs: false)
+    haml_ugly   = Haml::Engine.new(@haml_code, format: :html5, ugly: true, escape_attrs: false)
+
+    context = Context.new
+
+    haml_pretty.def_method(context, :run_haml_pretty)
+    haml_ugly.def_method(context, :run_haml_ugly)
+    context.instance_eval %{
+      def run_opulent_ugly; #{Opulent.new(@opulent_code).template}; end
+      def run_erb; #{ERB.new(@erb_code).src}; end
+      def run_erubis; #{Erubis::Eruby.new(@erb_code).src}; end
+      def run_temple_erb; #{Temple::ERB::Engine.new.call @erb_code}; end
+      def run_fast_erubis; #{Erubis::FastEruby.new(@erb_code).src}; end
+      def run_slim_pretty; #{Slim::Engine.new(pretty: true).call @slim_code}; end
+      def run_slim_ugly; #{Slim::Engine.new.call @slim_code}; end
+    }
+
+    bench(:compiled, 'opulent')     { context.run_opulent_ugly }
+    bench(:compiled, 'erb')         { context.run_erb }
+    bench(:compiled, 'erubis')      { context.run_erubis }
+    bench(:compiled, 'fast erubis') { context.run_fast_erubis }
+    bench(:compiled, 'temple erb')  { context.run_temple_erb }
+    bench(:compiled, 'slim pretty') { context.run_slim_pretty }
+    bench(:compiled, 'slim ugly')   { context.run_slim_ugly }
+    bench(:compiled, 'haml pretty') { context.run_haml_pretty }
+    bench(:compiled, 'haml ugly')   { context.run_haml_ugly }
+  end
+
+  def init_tilt_benches
+    tilt_opulent     = Opulent::Template.new { @opulent_code }
+    tilt_erb         = Tilt::ERBTemplate.new { @erb_code }
+    tilt_erubis      = Tilt::ErubisTemplate.new { @erb_code }
+    tilt_temple_erb  = Temple::ERB::Template.new { @erb_code }
+    tilt_haml_pretty = Tilt::HamlTemplate.new(format: :html5) { @haml_code }
+    tilt_haml_ugly   = Tilt::HamlTemplate.new(format: :html5, ugly: true) { @haml_code }
+    tilt_slim_pretty = Slim::Template.new(pretty: true) { @slim_code }
+    tilt_slim_ugly   = Slim::Template.new { @slim_code }
+
+    context = Context.new
+
+    bench(:tilt, 'opulent')     { tilt_opulent.render(context) }
+    bench(:tilt, 'erb')         { tilt_erb.render(context) }
+    bench(:tilt, 'erubis')      { tilt_erubis.render(context) }
+    bench(:tilt, 'temple erb')  { tilt_temple_erb.render(context) }
+    bench(:tilt, 'slim pretty') { tilt_slim_pretty.render(context) }
+    bench(:tilt, 'slim ugly')   { tilt_slim_ugly.render(context) }
+    bench(:tilt, 'haml pretty') { tilt_haml_pretty.render(context) }
+    bench(:tilt, 'haml ugly')   { tilt_haml_ugly.render(context) }
+  end
+
+  def init_parsing_benches
+    context  = Context.new
+    context_binding = context.instance_eval { binding }
+
+    bench(:parsing, 'opulent')     { Opulent.new(@opulent_code).result(context_binding) }
+    bench(:parsing, 'erb')         { ERB.new(@erb_code).result(context_binding) }
+    bench(:parsing, 'erubis')      { Erubis::Eruby.new(@erb_code).result(context_binding) }
+    bench(:parsing, 'fast erubis') { Erubis::FastEruby.new(@erb_code).result(context_binding) }
+    bench(:parsing, 'temple erb')  { Temple::ERB::Template.new { @erb_code }.render(context) }
+    bench(:parsing, 'slim pretty') { Slim::Template.new(pretty: true) { @slim_code }.render(context) }
+    bench(:parsing, 'slim ugly')   { Slim::Template.new { @slim_code }.render(context) }
+    bench(:parsing, 'haml pretty') { Haml::Engine.new(@haml_code, format: :html5).render(context) }
+    bench(:parsing, 'haml ugly')   { Haml::Engine.new(@haml_code, format: :html5, ugly: true).render(context) }
+  end
+
+  def run
+    @benches.each do |group_name, group_benches|
+      puts "Running #{group_name} benchmarks:"
+
+      Benchmark.ips do |x|
+        group_benches.each do |name, block|
+          x.report("#{group_name} #{name}", &block)
+        end
+
+        x.compare!
+      end
+    end
+
+    puts "
+Compiled benchmark: Template is parsed before the benchmark and
+    generated ruby code is compiled into a method.
+    This is the fastest evaluation strategy because it benchmarks
+    pure execution speed of the generated ruby code.
+
+Compiled Tilt benchmark: Template is compiled with Tilt, which gives a more
+    accurate result of the performance in production mode in frameworks like
+    Sinatra, Ramaze and Camping. (Rails still uses its own template
+    compilation.)
+
+Parsing benchmark: Template is parsed every time.
+    This is not the recommended way to use the template engine
+    and Slim is not optimized for it. Activate this benchmark with 'rake bench slow=1'.
+
+Temple ERB is the ERB implementation using the Temple framework. It shows the
+overhead added by the Temple framework compared to ERB.
+"
+  end
+
+  def bench(group, name, &block)
+    @benches[group].push([name, block])
+  end
+end
+
+Benchmarks.new(ENV['slow']).run

data/benchmarks/view.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE HTML>
+
+<html>
+  <head>
+    <title>Simple Benchmark</title>
+  </head>
+  <body>
+    <h1><%= header %></h1>
+    <% unless item.empty? %>
+      <ul>
+      <% for i in item %>
+        <% if i[:current] %>
+          <li><strong><%= i[:name] %></strong></li>
+        <% else %>
+          <li><a href="<%= i[:url] %>"><%= i[:name] %></a></li>
+        <% end %>
+      <% end %>
+      </ul>
+    <% else %>
+      <p>The list is empty.</p>
+    <% end %>
+  </body>
+</html>

data/benchmarks/view.haml

@@ -0,0 +1,18 @@
+!!! html
+
+%html
+  %head
+    %title Simple Benchmark
+  %body
+    %h1= header
+    - unless item.empty?
+      %ul
+        - for i in item
+          - if i[:current]
+            %li
+              %strong= i[:name]
+          - else
+            %li
+              %a{:href => i[:url]}= i[:name]
+    - else
+      %p The list is empty.

data/benchmarks/view.op

@@ -0,0 +1,17 @@
+doctype html
+html
+  head
+    title Simple Benchmark
+  body
+    h1 == header
+    unless item.empty?
+      ul
+        - for i in item
+          if i[:current]
+            li
+              strong =~ i[:name]
+          else
+            li
+              a href=~i[:url] =~ i[:name]
+    else
+      p The list is empty.

data/benchmarks/view.slim

@@ -0,0 +1,17 @@
+doctype html
+html
+  head
+    title Simple Benchmark
+  body
+    h1 == header
+    - unless item.empty?
+      ul
+        - for i in item
+          - if i[:current]
+            li
+              strong == i[:name]
+          - else
+            li
+              a href==i[:url] == i[:name]
+    - else
+      p The list is empty.

data/lib/opulent/template.rb

@@ -1,7 +1,7 @@
 # @Opulent
 module Opulent
   # @OpulentTemplate
-  class OpulentTemplate < ::Tilt::Template
+  class Template < ::Tilt::Template
     # Allow accessing engine definitions
     attr_reader :def
 
@@ -47,5 +47,5 @@ module Opulent
   end
 
   # Register Opulent to Tilt
-  ::Tilt.register OpulentTemplate, 'opulent', 'op'
+  ::Tilt.register Template, 'opulent', 'op'
 end

data/lib/opulent/version.rb

@@ -1,4 +1,4 @@
 # @Opulent
 module Opulent
-  VERSION = '1.7.0'
+  VERSION = '1.7.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opulent
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Alex Grozav
@@ -96,6 +96,12 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- benchmarks/context.rb
+- benchmarks/run-benchmarks.rb
+- benchmarks/view.erb
+- benchmarks/view.haml
+- benchmarks/view.op
+- benchmarks/view.slim
 - bin/opulent
 - docs/attributes.md
 - docs/comments.md