RubyGems - shaven - Versions diffs - 0.0.1 - Mend

Files changed (43) hide show

data/.gitignore +12 -0
data/.rspec +1 -0
data/Isolate +12 -0
data/README.md +183 -0
data/Rakefile +47 -0
data/lib/shaven.rb +27 -0
data/lib/shaven/core_ext/hash.rb +22 -0
data/lib/shaven/core_ext/object.rb +17 -0
data/lib/shaven/document.rb +9 -0
data/lib/shaven/helpers/html.rb +68 -0
data/lib/shaven/nokogiri_ext/node.rb +86 -0
data/lib/shaven/presenter.rb +90 -0
data/lib/shaven/scope.rb +50 -0
data/lib/shaven/transformer.rb +109 -0
data/lib/shaven/transformers/auto.rb +17 -0
data/lib/shaven/transformers/condition.rb +25 -0
data/lib/shaven/transformers/context.rb +35 -0
data/lib/shaven/transformers/dummy.rb +22 -0
data/lib/shaven/transformers/list.rb +51 -0
data/lib/shaven/transformers/reverse_condition.rb +25 -0
data/lib/shaven/transformers/text_or_node.rb +42 -0
data/lib/shaven/version.rb +13 -0
data/shaven.gemspec +20 -0
data/spec/benchmarks.rb +189 -0
data/spec/fixtures/condition.html +5 -0
data/spec/fixtures/context.html +7 -0
data/spec/fixtures/dummy.html +4 -0
data/spec/fixtures/list.html +6 -0
data/spec/fixtures/list_of_contexts.html +6 -0
data/spec/fixtures/reverse_condition.html +5 -0
data/spec/fixtures/text_or_node.html +4 -0
data/spec/helpers_html_spec.rb +54 -0
data/spec/nokogiri_node_spec.rb +55 -0
data/spec/presenter_spec.rb +36 -0
data/spec/spec_helper.rb +11 -0
data/spec/transformers/auto_spec.rb +34 -0
data/spec/transformers/condition_spec.rb +28 -0
data/spec/transformers/context_spec.rb +25 -0
data/spec/transformers/dummy_spec.rb +18 -0
data/spec/transformers/list_spec.rb +41 -0
data/spec/transformers/reverse_condition_spec.rb +28 -0
data/spec/transformers/text_or_node_spec.rb +65 -0
metadata +123 -0

data/lib/shaven/version.rb ADDED Viewed

@@ -0,0 +1,13 @@
+module Shaven
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+    def self.to_s
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end # Version
+  VERSION = Version.to_s
+end # Shaven

data/shaven.gemspec ADDED Viewed

@@ -0,0 +1,20 @@
+# -*- ruby -*-
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require 'shaven/version'
+Gem::Specification.new do |s|
+  s.name              = "shaven"
+  s.rubyforge_project = "shaven"
+  s.version           = Shaven::VERSION
+  s.authors           = ["Chris Kowalik"]
+  s.email             = ["chris@nu7hat.ch"]
+  s.homepage          = "http://github.com/nu7hatch/shaven"
+  s.summary           = "Shaven - templating without mustaches!"
+  s.description       = "Shaven is templating system for logic less, and extra markup free templates."
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths     = ['lib']
+  s.add_dependency 'nokogiri', '~> 1.4'
+end

data/spec/benchmarks.rb ADDED Viewed

@@ -0,0 +1,189 @@
+$LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
+require 'benchmark'
+require 'shaven'
+require 'erb'
+require 'haml'
+require 'mustache'
+$erb = <<-HTML
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= @title %></div>
+</head>
+<body>
+  <% if @condition %>
+    Something conditional!
+  <% else %>
+    Something else
+  <% end %>
+  <div id="user">
+    <div class="name"><%= @user[:name] %></div>
+    <div class="email"><%= @user[:email] %></div>
+  </div>
+  <ul id="items">
+    <% @items.each do |item| %>
+      <li class="item">
+        <div class="name"><%= item[:name] %></div>
+        <div class="price"><%= item[:price] %></div>
+      </li>
+    <% end %>
+  </ul>
+</body>
+</html>
+HTML
+$mustache = <<-HTML
+<!DOCTYPE html>
+<html>
+<head>
+  <title>{{title}}</div>
+</head>
+<body>
+  {{#condition}}
+    Something conditional!
+  {{/condition}}
+  {{^condition}}
+    Something else
+  {{/condition}}
+  {{#user}}
+  <div id="user">
+    <div class="user">{{name}}</div>
+    <div class="email">{{email}}</div>
+  </div>
+  {{/user}}
+  <ul id="items">
+    {{#items}}
+      <li class="item">
+        <div class="name">{{name}}</div>
+        <div class="price">{{price}}</div>
+      </li>
+    {{/items}}
+  </ul>
+</body>
+</html>
+HTML
+$haml = <<-HAML
+!!!
+%html
+  %head
+    %title= title
+  %body
+    - if condition
+      Something conditional!
+    - else
+      Something else
+    #user
+      .name= user[:name]
+      .email= user[:email]
+    %ul#items
+      - items.each do |item|
+        %li.item
+          .name= item[:name]
+          .price= item[:price]
+HAML
+$doc = <<-HTML
+<!DOCTYPE html>
+<html>
+<head>
+  <title rb="page_title">Sample title</title>
+</head>
+<body>
+  <div rb:if="condition">
+    Something conditional!
+  </div>
+  <div rb:unless="condition">
+    Something else
+  </div>
+  <div rb="user">
+    <div rb="name">Name</div>
+    <div rb="email">email@mail.com</div>
+  </div>
+  <ul id="items">
+    <li rb="items">
+      <div rb="name">Foobar</div>
+      <div rb="price">$250</div>
+    </li>
+  </ul>
+</body>
+</html>
+HTML
+$user = {
+  :name => "Marty Macfly",
+  :email => "marty@macfly.com"
+}
+$items = [
+  { :name => "First", :price => "$250" },
+  { :name => "Second", :price => "$300" },
+  { :name => "Third", :price => "$500" }
+]
+$title = "Hello world!"
+class MyPresenter < Shaven::Presenter
+  def user
+    $user
+  end
+  def items
+    $items
+  end
+  def condition
+    false
+  end
+  def page_title
+    $title
+  end
+end
+class ErbView
+  def initialize
+    @condition = false
+    @title = $title
+    @items = $items
+    @user = $user
+  end
+  def render
+    ERB.new($erb).result(binding)
+  end
+end
+def render_shaven
+  MyPresenter.feed($doc).to_html
+end
+def render_erb
+  ErbView.new.render
+end
+def render_haml
+  Haml::Engine.new($haml).render(self, { :user => $user, :items => $items, :title => $title, :condition => false})
+end
+def render_mustache
+  Mustache.render($mustache, { :user => $user, :items => $items, :title => $title, :condition => false})
+end
+n = 1500
+Benchmark.bm do |x|
+  x.report("Shaven  ") { n.times { render_shaven } }
+  x.report("Mustache") { n.times { render_mustache } }
+  x.report("ERB     ") { n.times { render_erb } }
+  x.report("HAML    ") { n.times { render_haml } }
+end

data/spec/fixtures/condition.html ADDED Viewed

@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<html><body>
+<div rb:if="false?">This shouldn't appear!</div>
+<div rb:if="true?">This should appear!</div>
+</body></html>

data/spec/fixtures/context.html ADDED Viewed

@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html><body>
+<div rb="user">
+<h2 rb="name">John Doe</h2>
+<p rb="email">email@example.com</p>
+</div>
+</body></html>

data/spec/fixtures/dummy.html ADDED Viewed

@@ -0,0 +1,4 @@
+<!DOCTYPE html>
+<html><body>
+<div rb:dummy="yes">This is dummy...</div>
+</body></html>

data/spec/fixtures/list.html ADDED Viewed

@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<html><body>
+<ul>
+<li rb="users">John Doe</li>
+</ul>
+</body></html>

data/spec/fixtures/list_of_contexts.html ADDED Viewed

@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<html><body>
+<ul>
+<li rb="users"><strong rb="name">John Doe</strong></li>
+</ul>
+</body></html>

data/spec/fixtures/reverse_condition.html ADDED Viewed

@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<html><body>
+<div rb:unless="true?">This shouldn't appear!</div>
+<div rb:unless="false?">This should appear!</div>
+</body></html>

data/spec/fixtures/text_or_node.html ADDED Viewed

@@ -0,0 +1,4 @@
+<!DOCTYPE html>
+<html><body>
+<div rb="value">Example...</div>
+</body></html>

data/spec/helpers_html_spec.rb ADDED Viewed

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + "/spec_helper"
+describe Shaven::Presenter do
+  subject do
+    Shaven::Presenter.feed("<html><body></body></html>")
+  end
+  describe "#tag" do
+    it "creates element within current doc" do
+      div = subject.tag(:div, :id => "foo") { "Hello!" }
+      div.to_html.should == '<div id="foo">Hello!</div>'
+    end
+    it "creates element without attributes when not given" do
+      div = subject.tag(:div) { "Hello!" }
+      div.to_html.should == '<div>Hello!</div>'
+    end
+  end
+  describe "#div" do
+    it "creates new div element within current doc" do
+      div = subject.div(:id => "foo") { "Hello!" }
+      div.to_html.should == '<div id="foo">Hello!</div>'
+    end
+    it "creates new div element without arguments when not given" do
+      div = subject.div { "Hello!" }
+      div.to_html.should == '<div>Hello!</div>'
+    end
+  end
+  describe "#img" do
+    it "creates new img element within current doc" do
+      img = subject.img(:src => "foo.jpg")
+      img.to_html.should == '<img src="foo.jpg">'
+    end
+    it "creates new img element without arguments when not given" do
+      subject.img.to_html.should == '<img>'
+    end
+  end
+  describe "#a" do
+    it "creates new a element within current doc" do
+      a = subject.a(:href => "foo.html") { "Hello!" }
+      a.to_html.should == '<a href="foo.html">Hello!</a>'
+    end
+    it "creates new a element without arguments when not given" do
+      a = subject.a { "Hello!"}
+      a.to_html.should == '<a>Hello!</a>'
+    end
+  end
+end

data/spec/nokogiri_node_spec.rb ADDED Viewed

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + "/spec_helper"
+describe Nokogiri::XML::Node do
+  let(:doc) do
+    Nokogiri::HTML("<html><body></body></html>")
+  end
+  let(:node) do
+    Nokogiri::XML::Node.new("div", doc)
+  end
+  describe "#update!" do
+    it "updates attributes and content" do
+      node.update!({:id => "test"}, "Foobar!")
+      node.content.should == "Foobar!"
+      node['id'].should == "test"
+    end
+    context "when attribute is set to false" do
+      it "removes it" do
+        node['id'] = "test"
+        node.update! :id => false
+        node['id'].should_not be
+      end
+    end
+    context "when block given" do
+      it "treats it as content" do
+        node.update! { "Hello world!" }
+        node.content.should == "Hello world!"
+      end
+    end
+    context "when UJS attrs given" do
+      it "converts them properly to html attributes" do
+        node.update! :method => 'post', :remote => 'true', :confirm => "Are you sure?"
+        node['data-method'].should == 'post'
+        node['data-remote'].should == 'data-remote'
+        node['data-confirm'].should == 'Are you sure?'
+      end
+    end
+  end
+  describe "#replace!" do
+    let(:other_node) do
+      other_node = Nokogiri::XML::Node.new("p", doc)
+      other_node.content = "Other node!"
+      other_node
+    end
+    it "replaces node with given text or other node" do
+      # tested in other place...
+    end
+  end
+end

data/spec/presenter_spec.rb ADDED Viewed

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + "/spec_helper"
+describe Shaven::Presenter do
+  describe ".feed" do
+    it "creates instance of given presenter for given html" do
+      p = Shaven::Presenter.feed("<!DOCTYPE html><html><body>Hello!</body></html>")
+      p.to_html.should == "<!DOCTYPE html>\n<html><body>Hello!</body></html>\n"
+    end
+  end
+  describe "#to_html" do
+    it "generates html code from presenter data" do
+      # tested in `.feed` examples
+    end
+    context "when context given" do
+      it "combines it with current scope" do
+        p = make_presenter("text_or_node.html")
+        p.to_html(:value => "Hello Context!").should == "<!DOCTYPE html>\n<html><body>\n<div>Hello Context!</div>\n</body></html>\n"
+      end
+    end
+  end
+  describe "#compiled" do
+    it "returns false before first render" do
+      p = make_presenter("text_or_node.html")
+      p.should_not be_compiled
+    end
+    it "returns true after first render" do
+      p = make_presenter("text_or_node.html")
+      p.to_html(:value => "Hello!")
+      p.should be_compiled
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'shaven'
+RSpec.configure do |conf|
+  conf.mock_with :mocha
+end
+def make_presenter(file, presenter=Shaven::Presenter)
+  html = File.read(File.expand_path("../fixtures/#{file}", __FILE__))
+  presenter.feed(html)
+end

data/spec/transformers/auto_spec.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+describe Shaven::Transformer::Auto do
+  subject do
+    Shaven::Transformer::Auto
+  end
+  it "always can be transformed" do
+    subject.can_be_transformed?(nil).should be_true
+  end
+  describe ".new" do
+    context "when value is an array" do
+      it "returns list transformer object" do
+        t = Shaven::Transformer::Auto.new("value", [1,2,3], Shaven::Scope.new({}))
+        t.should be_kind_of(Shaven::Transformer::List)
+      end
+    end
+    context "when value is an hash" do
+      it "returns context transformer object" do
+        t = Shaven::Transformer::Auto.new("value", {:foo => "bar"}, Shaven::Scope.new({}))
+        t.should be_kind_of(Shaven::Transformer::Context)
+      end
+    end
+    context "otherwise" do
+      it "returns `text or node` transformer object" do
+        t = Shaven::Transformer::Auto.new("value", "Foo!", Shaven::Scope.new({}))
+        t.should be_kind_of(Shaven::Transformer::TextOrNode)
+      end
+    end
+  end
+end

shaven 0.0.1