RubyGems - shaven - Versions diffs - 0.0.1 - Mend

shaven 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

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/.gitignore ADDED Viewed

@@ -0,0 +1,12 @@
+*.log
+\#*
+.\#*
+build
+pkg
+tmp
+eproject.cfg
+.eproject
+*.bundle
+.DS_Store
+*.gem
+*.rbc

data/.rspec ADDED Viewed

	@@ -0,0 +1 @@
1	+ --color

data/Isolate ADDED Viewed

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+gem "nokogiri"
+env :development do
+  gem "rspec", "~> 2.5"
+  gem "mocha", "~> 0.9"
+  # For benchmarks...
+  gem "mustache"
+  gem "haml"
+end

data/README.md ADDED Viewed

@@ -0,0 +1,183 @@
+# Shaven - Templating without mustaches!
+Hey guys, look at present fasion... mustaches are not fashionable anymore =P.
+Take a look how nice looking are shaven templates.
+## Motivation
+I'm not a designer, usualy all templates in my work are prepared by external
+design studios or freelancers... But of course they are always pure xhtml.
+So still we have to deal with them, convert to haml, fill in with mustaches or
+erb sh**t! Now, my patience is over. Shaven will readmit some MVPC's fresh
+air to your web apps and allow you to get rid of stupid logic from your views.
+## Installation
+Installation with rubygems should go without quirks. Shaven depends on Nokogiri - if
+you don't have it installed yet then i recommend you to check out its documentation
+to avoid problems.
+    $ gem install shaven
+## How it works?
+Shaven views are splited into two layers (similar to defunk's mustache) - Template
+and Presenter. Templates are pure html files, Presenters are ruby classes
+which provides data for templates. Depending on the data type provided by
+presenter's methods you can freely and easily manipulate all contents within
+your templates. Ok, lets finish talking and take a look at examples...
+### Simple usage
+    class SimplePresenter < Shaven::Presenter
+      def title
+      	"Hello world!"
+      end
+      def description
+        "Yeah, hello beautiful code..."
+      end
+    end
+    html = <<-HTML
+    <!DOCTYPE html>
+    <html>
+    <head>
+      <title rb="title">Example title!</title>
+    </head>
+    <body>
+      <h1 rb="title">Example title</h1>
+      <p rb="description">Example description...</p>
+    </body>
+    </html>
+    HTML
+    SimplePresenter.feed(html).to_html
+This code produces following html:
+    <!DOCTYPE html>
+    <html>
+    <head>
+      <title>Hello World!</title>
+    </head>
+    <body>
+      <h1>Hello World!</h1>
+      <p>Yeah, hello beautiful code...</p>
+    </body>
+    </html>
+### DOM manipulation
+    class ManipulationPresenter < Shaven::Presenter
+      # If you add parameter to the presenter method, original node will
+      # passed to it. Given element is an Nokogiri::XML::Node with some
+      # extra helpers for content manipulation.
+      def login_link(orig)
+        orig.update!(:method => "delete", :href => logout_path)
+      end
+      # You can use extra html helpers to create new dom elements...
+      def home_page_link
+        a(:href => root_path, :class => "home-page-link") { "Go home!" }
+      end
+      # ... or to replace current.
+      def title
+        tag(:h1, :id => "header") { "This is Sparta! "}.replace!
+      end
+    end
+    html = <<-HTML
+    <!DOCTYPE html>
+    <html>
+    <body>
+      <div rb="title">Example title</div>
+      <a href="#" rb="logout_link">Logout!</a>
+      <div rb="home_page_link">Home page link will go here...</div>
+    </body>
+    </html>
+    HTML
+    ManipulationPresenter.feed(html).to_html
+Result:
+    <!DOCTYPE html>
+    <html>
+    <body>
+      <h1 id="header">This is Sparta!</h1>
+      <a href="/logout" data-method="delete">Logout!</a>
+      <div><a href="/" class="home-page-link">Go Home!</a></div>
+    </body>
+    </html>
+### Hash scopes and lists
+Now, the true power of Shaven. Suport for lists and scopes.
+    class ComplexPresenter < Shaven::Presenter
+      # As scopes are treaded all hashes and objects responding to `#to_shaven`
+      # method (which returns hash with attributes).
+      def user
+        { :name => "John Doe",
+          :email => "john@doe.com",
+        }
+      end
+      def users_list
+        [ { :name => tag(:strong) { "Emmet Brown" }, :email => "emmet@brown.com"},
+          { :name => proc { |orig| orig.update!(:class => "marty") { "Marty Macfly" }, :email => "marty@macfly.com" },
+          { :name => "Biff Tannen", :email => "biff@tannen.com" }
+        ]
+      end
+    end
+    html = <<-HTML
+    <!DOCTYPE html>
+    <html>
+    <body>
+      <h1>Single user here!</h1>
+      <div rb="user">
+        <h2 rb="name">Sample name</h2>
+        <p rb="email">sapmle@email.com</p>
+      </div>
+      <h1>More users</h1>
+      <ul id="users">
+        <li rb="users_list">
+          <span rb="name">Sample name</span>
+          <span rb="email">sample@email.com</span>
+        <li>
+      </ul>
+    </body>
+    </html>
+    HTML
+And the awesome result is:
+    <!DOCTYPE html>
+    <html>
+    <body>
+      <h1>Single user here!</h1>
+      <div rb="user">
+        <h2>Adam Smith</h2>
+        <p>adam@smith.com</p>
+      </div>
+      <h1>More users</h1>
+      <ul id="users">
+        <li>
+          <span><strong>Emmet Brown</strong></span>
+          <span>brown@brown.com</span>
+        <li>
+        <li class="marty">
+          <span>Marty Macfly</span>
+          <span>marty@macfly.com</span>
+        <li>
+        <li>
+          <span>Biff Tannen</span>
+          <span>biff@tannen.com</span>
+        <li>
+      </ul>
+    </body>
+    </html>

data/Rakefile ADDED Viewed

@@ -0,0 +1,47 @@
+# -*- ruby -*-
+begin
+  require 'isolate/now'
+rescue LoadError
+  STDERR.puts "Run `gem install isolate` to install 'isolate'."
+end
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ENV['RSPEC_OPTS']
+  end
+rescue LoadError
+  task :spec do
+    abort 'Run `gem install rspec` to install RSpec'
+  end
+end
+task :test => :spec
+task :default => :test
+begin
+  require 'metric_fu'
+rescue LoadError
+end
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Shaven - ruby templating without mustaches"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+desc "Opens console with loaded RAE env."
+task :console do
+  require 'shaven'
+  require 'irb'
+  ARGV.clear
+  IRB.start
+end
+desc "Run benchmarks to compare Shaven's speed with other templating systems."
+task :benchmark do
+  require File.dirname(__FILE__) + "/spec/benchmarks"
+end

data/lib/shaven.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require "nokogiri"
+module Shaven
+  unless {}.respond_to?(:stringify_keys)
+    require 'shaven/core_ext/hash'
+  end
+  require 'shaven/core_ext/object'
+  require 'shaven/nokogiri_ext/node'
+  require 'shaven/presenter'
+  require 'shaven/version'
+  if defined?(Rails)
+    require 'shaven/railtie'
+  end
+  class << self
+    # You can specify what caller attribute names should be used in your
+    # templates to define transformations. By default <tt>rb</tt>/<tt>rb:*</tt>
+    # attributes are in use.
+    attr_writer :caller_key
+    def caller_key
+      @template_key ||= 'rb'
+    end
+  end # self
+end # Shaven

data/lib/shaven/core_ext/hash.rb ADDED Viewed

@@ -0,0 +1,22 @@
+module Shaven
+  module CoreExt
+    # Contains helpers for keys stringifying. Implementation borrowed from activesupport.
+    module Hash
+      def stringify_keys
+        inject({}) { |options, (key, value)|
+          options[key.to_s] = value
+          options
+        }
+      end
+      def stringify_keys!
+        keys.each { |key| self[key.to_s] = delete(key) }
+        self
+      end
+    end # Hash
+  end # CoreExt
+end # Shaven
+class Hash
+  include Shaven::CoreExt::Hash
+end

data/lib/shaven/core_ext/object.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module Shaven
+  module CoreExt
+    module Object
+      def nokogiri_node?
+        kind_of?(Nokogiri::XML::Node)
+      end
+      def to_shaven
+        self
+      end
+    end # Object
+  end # CoreExt
+end # Shaven
+class Object
+  include Shaven::CoreExt::Object
+end

data/lib/shaven/document.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module Shaven
+  class Document < Nokogiri::HTML::Document
+    class << self
+      def new(thing, encoding=nil, &block)
+        parse(thing, nil, encoding, Nokogiri::XML::ParseOptions::DEFAULT_HTML, &block)
+      end
+    end # self
+  end # Document
+end # Shaven

data/lib/shaven/helpers/html.rb ADDED Viewed

@@ -0,0 +1,68 @@
+module Shaven
+  module Helpers
+    module HTML
+      # Generates document's element node with given attributes and content.
+      #
+      # ==== Example
+      #
+      #   tag(:h1, :id => "title") { "Hello world!" }
+      #   tag(:p, :class => "description") { "Lorem ipsum dolor..." }
+      #
+      # produces:
+      #
+      #   <h1 id="title">Hello world!</h1>
+      #   <p class="description">Lorem ipsum dolor...</p>
+      #
+      def tag(tag, attrs={}, &content)
+        node = Nokogiri::XML::Node.new(tag.to_s, @document)
+        node.update!(attrs, &content)
+      end
+      # Shortcut for generating link node.
+      #
+      # ==== Example
+      #
+      #   a(:href => "/users", :id => "users_link") { "Users" }
+      #   a(:href => "/users/1", :method => "delete", :remote => true, :confirm => "Are you sure?") { "Delete" }
+      #
+      # produces:
+      #
+      #   <a href="/users" id="users_link">Users</a>
+      #   <a href="/users/1" data-method="delete" data-remote="data-remote" data-confirm="Are you sure?">Delete</a>
+      #
+      def a(attrs={}, &label)
+        tag(:a, attrs, &label)
+      end
+      # Shortcut for generating image node.
+      #
+      # ==== Example
+      #
+      #   img(:src => "avatar.jpg" :class => "avatar")
+      #
+      # produces:
+      #
+      #   <img src="avatar.jpg" class="avatar" />
+      #
+      def img(attrs={})
+        tag(:img, attrs)
+      end
+      # Shortcut for generating div element node.
+      #
+      # ==== Example
+      #
+      #   div(:id => "name") { "Marty Macfly" }
+      #   div(:id => "email") { "marty@macfly.com" }
+      #
+      # produces:
+      #
+      #   <div id="name">Marty Macfly</div>
+      #   <div id="email">marty@macfly.com</div>
+      #
+      def div(attrs={}, &content)
+        tag(:div, attrs, &content)
+      end
+    end # HTML
+  end # Helpers
+end # Shaven

data/lib/shaven/nokogiri_ext/node.rb ADDED Viewed

@@ -0,0 +1,86 @@
+module Shaven
+  module NokogiriExt
+    module Node
+      # List of extra <tt>data-*</tt> attributes for dealing with unobtrusive javascript
+      # stuff. Following attributes will be converted to html compilant attrs. The <tt>true</tt>
+      # and <tt>false</tt> values here means if attribute is boolean or not.
+      UJS_DATA_ATTRIBUTES = {
+        'remote'  => true,
+        'confirm' => false,
+        'method'  => false
+      }
+      # Helper for easy updating node's attributes and content.
+      #
+      # ==== Example
+      #
+      #   node.update!(:id => "hello-world").to_html # => <div id="hello-world"></div>
+      #   node.update!(nil, "Foo!").to_html          # => <div id="hello-world">Foo!</div>
+      #   node.update! { "Foobar!" }                 # => <div id="hello-world">Foobar!</div>
+      #   node.update!(:id => false)                 # => <div>Foobar!</div>
+      #
+      def update!(attrs={}, content=nil, &block)
+        attrs = {} unless attrs
+        attrs = apply_ujs_data_attributes(attrs.stringify_keys)
+        # Applying attributes...
+        attrs.each { |key,value|
+          if value === false
+            delete(key.to_s)
+          else
+            self[key.to_s] = value.to_s
+          end
+        }
+        content = block.call if block_given?
+        # Applying content...
+        if content.is_a?(Nokogiri::XML::Node)
+          self.inner_html = content
+        elsif !content.nil?
+          self.content = content.to_s
+        end
+        return self
+      end
+      # Helper for replacing current node with other text or node.
+      #
+      # ==== Example
+      #
+      #   node.replace!(other_node)
+      #   node.replace!("Text")
+      #   node.replace! { "Something new" }
+      #
+      # XXX: replace/replace_node method failed with segfault so this is some workaround...
+      #
+      def replace!(text_or_node=nil, &block)
+        text_or_node = block.call if block_given?
+        unless text_or_node.nokogiri_node?
+          content, text_or_node = text_or_node.to_s, Nokogiri::XML::Text.new("dummy", document)
+          text_or_node.content = content
+        end
+        node = add_previous_sibling(text_or_node)
+        remove
+      end
+      private
+      def apply_ujs_data_attributes(attrs)
+        UJS_DATA_ATTRIBUTES.each { |key, bool|
+          if attrs.key?(key)
+            value = attrs.delete(key)
+            attrs["data-#{key}"] = value ? (bool ? "data-#{key}" : value) : false
+          end
+        }
+        return attrs
+      end
+    end # Node
+  end # NokogiriExt
+end # Shaven
+class Nokogiri::XML::Node
+  include Shaven::NokogiriExt::Node
+end