RubyGems - crafty - Versions diffs - 0.1.0 - Mend

crafty 0.1.0

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 (16) hide show

data/LICENSE +19 -0
data/README.md +175 -0
data/Rakefile +103 -0
data/VERSION +1 -0
data/crafty.gemspec +55 -0
data/lib/crafty/safety.rb +34 -0
data/lib/crafty/tools.rb +108 -0
data/lib/crafty/toolset.rb +49 -0
data/lib/crafty/toolsets/html4.rb +32 -0
data/lib/crafty/toolsets/html5.rb +34 -0
data/lib/crafty.rb +11 -0
data/test/test_helper.rb +21 -0
data/test/unit/html_test.rb +126 -0
data/test/unit/tools_test.rb +239 -0
data/test/unit/toolset_test.rb +52 -0
metadata +74 -0

data/LICENSE ADDED Viewed

@@ -0,0 +1,19 @@
+Copyright (c) 2010-2011 Voormedia B.V.
+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 ADDED Viewed

@@ -0,0 +1,175 @@
+Crafty – handcrafted HTML in pure Ruby
+======================================
+Crafty allows you to easily and flexibly craft HTML output with pure Ruby
+code. It is inspired by Builder and Markaby, but is simpler and more flexible.
+Its goal is to provide simple helpers that allow you to build HTML markup in
+any class.
+Crafty can be used in builder classes that construct complex HTML markup, such
+as form builders or pagination builders. Whenever you need to programmatically
+construct HTML, consider including a Crafty helper module.
+Features
+--------
+* Crafty is simple and fast.
+* HTML element sets are predefined and provided as mix-ins.
+* Automatic HTML output escaping, 100% compatible with Rails.
+* No `instance_eval` or `method_missing` tricks, just helper methods.
+Synopsis
+--------
+A very simple example:
+    require "crafty"
+    include Crafty::HTML::Basic
+    div class: "green" do
+      h1 "Crafty crafts HTML"
+    end
+    #=> "<div class=\"green\"><h1>Crafty crafts HTML</h1></div>"
+Another example:
+    require "crafty"
+    class Widget
+      include Crafty::HTML::Basic
+      def initialize(target)
+        @target = target
+      end
+      def render
+        # The first helper method that is called will collect all HTML.
+        html do
+          head do
+            title "Hello"
+          end
+          body do
+            # Continue building in another method.
+            render_content
+          end
+        end
+      end
+      def render_content
+        div class: ["main", "content"] do
+          p "Hello, #{@target}!"
+        end
+      end
+    end
+    Widget.new("world").render
+    #=> "<html><head><title>Hello</title></head><body><div class=\"main content\"><p>Hello, world!</p></div></body></html>"
+Helper modules
+--------------
+You can choose from one of the following helper modules:
+* `Crafty::HTML::Basic`: A simple subset of all HTML elements, enough
+  for most HTML layouts.
+* `Crafty::HTML::Forms`: All HTML elements that are related to forms. If you
+  use Rails, note that the names of some of these elements conflict with Rails
+  helpers (such as `label` and `input`).
+* `Crafty::HTML::Semantic`: Juicy new HTML5 elements such as `header`,
+  `footer`, `nav`, etc.
+* `Crafty::HTML::All`: All HTML5 elements that are defined in the HTML5 draft
+  spec. If you use Rails, note that some elements might conflict with Rails
+  helpers.
+You can also choose to use `Crafty::HTML4::Basic`, `Crafty::HTML4::Forms` and
+`Crafty::HTML4::All` instead. These modules provide helpers for HTML4/XHTML
+elements. For a complete reference of which elements are included in which
+module, [see the source](https://github.com/voormedia/crafty/tree/master/lib/crafty/toolsets).
+Output streaming
+----------------
+Crafty helpers return strings by default. However, if the object you use the
+helpers in responds to `<<`, Crafty will push any output directly onto the
+current object. This allows you to create builder classes that can stream
+output. Observe how it works with this contrived example:
+    class StreamingWidget < Array   # Subclass Array to demonstrate '<<'
+      include Crafty::HTML::Basic
+      def render(target)
+        html do
+          head do
+            title %Q(Hello "#{target}")
+          end
+        end
+      end
+    end
+    widget = StreamingWidget.new
+    widget.render("world")
+    #=> nil
+    widget
+    #=> ["<html>", "<head>", "<title>", "Hello &quot;world&quot;", "</title>", "</head>", "</html>"]
+Benchmarks
+----------
+Benchmarks do not necessarily give a complete picture of real-world
+performance. Nevertheless, we wish to demonstrate that Crafty is fast enough
+for daily use. These benchmarks were performed with Ruby 1.9.2.
+    Number of iterations = 50000
+                              user     system      total        real
+    crafty                7.630000   0.140000   7.770000 (  7.750502)
+    builder              17.420000   0.110000  17.530000 ( 17.513536)
+    haml                 17.450000   0.180000  17.630000 ( 17.600038)
+    erector              15.400000   0.110000  15.510000 ( 15.491134)
+    tagz                 32.860000   0.650000  33.510000 ( 33.461828)
+    nokogiri             27.450000   0.210000  27.660000 ( 27.608287)
+Requirements
+------------
+Crafty has no requirements other than Ruby (tested with 1.8.7+).
+Installation
+------------
+Install as a gem:
+    gem install crafty
+Or add to your project's `Gemfile`:
+    gem "crafty"
+About Crafty
+-------------
+Crafty was created by Rolf Timmermans (r.timmermans *at* voormedia.com)
+Copyright 2010-2011 Voormedia - [www.voormedia.com](http://www.voormedia.com/)
+License
+-------
+Crafty is released under the MIT license.

data/Rakefile ADDED Viewed

@@ -0,0 +1,103 @@
+# encoding: utf-8
+require "jeweler"
+require "rake/testtask"
+Jeweler::Tasks.new do |spec|
+  spec.name = "crafty"
+  spec.summary = "Build HTML like a master craftsman."
+  spec.description = "Crafty provides you the tools to easily and flexibly create HTML output with pure Ruby."
+  spec.authors = ["Rolf Timmermans"]
+  spec.email = "r.timmermans@voormedia.com"
+  spec.files -= Dir["{benchmark,src}/**/*"]
+end
+Jeweler::GemcutterTasks.new
+Rake::TestTask.new do |test|
+  test.pattern = "test/unit/**/*_test.rb"
+end
+task :default => [:generate, :test]
+desc "Benchmark Crafty against various other HTML builders"
+task :bench do
+  require File.expand_path("benchmark/bench", File.dirname(__FILE__))
+end
+desc "Profile Crafty"
+task :profile do
+  require File.expand_path("benchmark/profile", File.dirname(__FILE__))
+end
+desc "Regenerate toolsets"
+task :generate do
+  require File.expand_path("src/elements", File.dirname(__FILE__))
+  def simple_format(text, len = 73, indent = 6)
+    sentences = [[]]
+    text.split.each do |word|
+      if (sentences.last + [word]).join(' ').length > len
+        sentences << [word]
+      else
+        sentences.last << word
+      end
+    end
+    sentences.map { |sentence|
+      "#{" " * indent}#{sentence.join(' ')}"
+    }.join "\n"
+  end
+  def define(set, regular, empty)
+    simple_format("Toolset.define(self, %w{#{regular * " "}}" + (empty.any? ? ", %w{#{empty * " "}}" : "") + ")")
+  end
+  autoloading = ["  # Generated HTML toolsets."]
+  Versions.each do |version|
+    path = "crafty/toolsets/#{version.to_s.downcase}"
+    file = File.open("lib/#{path}.rb", "w+")
+    file.puts "module Crafty"
+    file.puts "  # This toolset has been automatically generated."
+    file.puts "  module #{version}"
+    version_elements = Object.const_get(version)
+    Sets.each do |set|
+      set_elements = Object.const_get(set)
+      broken = set_elements - (HTML4 + HTML5)
+      raise "Incorrect elements in set: #{broken}" if broken.any?
+      all = version_elements & set_elements
+      file.puts "    module #{set}"
+      file.puts define(set, all - Childless, all & Childless)
+      file.puts "    end"
+      file.puts
+    end
+    file.puts "    module All"
+    file.puts define(:All, version_elements - Childless, version_elements & Childless)
+    file.puts "    end"
+    file.puts "  end"
+    aliases = []
+    Aliases.each { |alt, orig| aliases << alt if orig == version }
+    file.puts "\n  #{aliases * " = "} = #{version}" if aliases.any?
+    file.puts "end"
+    file.close
+    ([version] + aliases).each do |mod|
+      autoloading << %Q(  autoload #{mod.inspect}, #{path.inspect})
+    end
+    autoloading << ""
+  end
+  lib = File.read("lib/crafty.rb")
+  lib.gsub!(/^\s*#\s*Generated.*\nend/m, "\n" + autoloading.join("\n") + "end")
+  File.open "lib/crafty.rb", "w+" do |file|
+    file.write lib
+  end
+end

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.1.0

data/crafty.gemspec ADDED Viewed

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{crafty}
+  s.version = "0.1.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rolf Timmermans"]
+  s.date = %q{2011-04-01}
+  s.description = %q{Crafty provides you the tools to easily and flexibly create HTML output with pure Ruby.}
+  s.email = %q{r.timmermans@voormedia.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "crafty.gemspec",
+    "lib/crafty.rb",
+    "lib/crafty/safety.rb",
+    "lib/crafty/tools.rb",
+    "lib/crafty/toolset.rb",
+    "lib/crafty/toolsets/html4.rb",
+    "lib/crafty/toolsets/html5.rb",
+    "test/test_helper.rb",
+    "test/unit/html_test.rb",
+    "test/unit/tools_test.rb",
+    "test/unit/toolset_test.rb"
+  ]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Build HTML like a master craftsman.}
+  s.test_files = [
+    "test/test_helper.rb",
+    "test/unit/html_test.rb",
+    "test/unit/tools_test.rb",
+    "test/unit/toolset_test.rb"
+  ]
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/crafty/safety.rb ADDED Viewed

@@ -0,0 +1,34 @@
+class Object
+  def html_safe?
+    false
+  end
+end
+module Crafty
+  class SafeString < String
+    def html_safe?
+      true
+    end
+    def html_safe
+      self
+    end
+    alias_method :to_s, :html_safe
+    alias_method :render, :html_safe
+  end
+  class SafeWrapper
+    def initialize(base)
+      @base = base
+    end
+    def <<(data)
+      @base << SafeString.new(data)
+    end
+    def render
+      nil
+    end
+  end
+end

data/lib/crafty/tools.rb ADDED Viewed

@@ -0,0 +1,108 @@
+require "crafty/safety"
+module Crafty
+  module Tools
+    class << self
+      ESCAPE_SEQUENCE = { "&" => "&amp;", ">" => "&gt;", "<" => "&lt;", '"' => "&quot;" }
+      def escape(content)
+        return content if content.html_safe?
+        content.gsub(/[&><"]/) { |char| ESCAPE_SEQUENCE[char] }
+      end
+      def format_attributes(attributes)
+        return if attributes.nil?
+        attributes.collect do |name, value|
+          value = if value.kind_of? Array
+            value.flatten.compact * " "
+          else
+            value.to_s
+          end
+          next if value == ""
+          %Q{ #{name}="#{escape(value)}"}
+        end.join
+      end
+      def format_parameters(parameters)
+        return if parameters.nil?
+        parameters.collect do |name|
+          name = name.inspect if name.kind_of? String
+          %Q{ #{name}}
+        end.join
+      end
+      def create_stream(base)
+        if base.respond_to? :<<
+          SafeWrapper.new(base)
+        else
+          SafeString.new
+        end
+      end
+    end
+    def element!(name, content = nil, attributes = nil)
+      build! do
+        if content or block_given?
+          @_crafted << "<#{name}#{Tools.format_attributes(attributes)}>"
+          if block_given?
+            value = yield
+            content = value if !@_appended or value.kind_of? String
+          end
+          content = content.to_s
+          @_crafted << Tools.escape(content) if content != ""
+          @_crafted << "</#{name}>"
+        else
+          @_crafted << "<#{name}#{Tools.format_attributes(attributes)}/>"
+        end
+      end
+    end
+    def comment!(content)
+      build! do
+        @_crafted << "<!-- "
+        @_crafted << Tools.escape(content.to_s)
+        @_crafted << " -->"
+      end
+    end
+    def instruct!(name = nil, attributes = {})
+      unless name
+        name = "xml"
+        attributes = { :version => "1.0", :encoding => "UTF-8" }
+      end
+      build! do
+        @_crafted << "<?#{name}#{Tools.format_attributes(attributes)}?>"
+      end
+    end
+    def declare!(name, *parameters)
+      build! do
+        @_crafted << "<!#{name}#{Tools.format_parameters(parameters)}>"
+      end
+    end
+    def text!(content)
+      build! do
+        @_crafted << Tools.escape(content.to_s)
+      end
+    end
+    alias_method :write!, :text!
+    def build!
+      @_appended = false
+      if @_crafted
+        yield
+        @_appended = true
+        nil
+      else
+        begin
+          @_crafted = Tools.create_stream(self)
+          yield
+          @_crafted.render
+        ensure
+          @_crafted = nil
+        end
+      end
+    end
+  end
+end

data/lib/crafty/toolset.rb ADDED Viewed

@@ -0,0 +1,49 @@
+module Crafty
+  module Toolset
+    class << self
+      def define(mod, elements = [], empty_elements = [])
+        define_elements(mod, elements)
+        define_empty_elements(mod, empty_elements)
+        mod.module_eval do
+          include Tools
+          def self.append_features(mod)
+            redefined = mod.instance_methods & self.instance_methods(false)
+            if redefined.any?
+              dup.tap do |safe|
+                redefined.each do |method|
+                  safe.send :remove_method, method
+                end
+              end.append_features(mod)
+            else
+              super
+            end
+          end
+        end
+      end
+      def define_elements(mod, elements)
+        elements.each do |element|
+          mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{element}(*arguments, &block)
+              attributes = arguments.pop if arguments.last.kind_of? Hash
+              content = arguments.first || ""
+              element!("#{element}", content, attributes, &block)
+            end
+          RUBY
+        end
+      end
+      def define_empty_elements(mod, elements)
+        elements.each do |element|
+          mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{element}(attributes = nil)
+              element!("#{element}", nil, attributes)
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/crafty/toolsets/html4.rb ADDED Viewed

@@ -0,0 +1,32 @@
+module Crafty
+  # This toolset has been automatically generated.
+  module HTML4
+    module Basic
+      Toolset.define(self, %w{a blockquote body div em h1 h2 h3 h4 h5 h6 head
+      html li p pre small span strong table td th title tr ul}, %w{br img
+      link})
+    end
+    module Forms
+      Toolset.define(self, %w{button fieldset form label object option select
+      textarea}, %w{input})
+    end
+    module Semantic
+      Toolset.define(self, %w{abbr acronym address cite code legend menu})
+    end
+    module All
+      Toolset.define(self, %w{a abbr acronym address applet b bdo big
+      blockquote body button caption center cite code colgroup dd del dfn dir
+      div dl dt em fieldset font form frameset h1 h2 h3 h4 h5 h6 head html i
+      iframe ins kbd label legend li map menu noframes noscript object ol
+      optgroup option p pre q s samp script select small span strike strong
+      style sub sup table tbody td textarea tfoot th thead title tr tt u ul
+      var}, %w{area base basefont br col frame hr img input isindex link meta
+      param})
+    end
+  end
+  XHTML = HTML4
+end

data/lib/crafty/toolsets/html5.rb ADDED Viewed

@@ -0,0 +1,34 @@
+module Crafty
+  # This toolset has been automatically generated.
+  module HTML5
+    module Basic
+      Toolset.define(self, %w{a blockquote body div em h1 h2 h3 h4 h5 h6 head
+      html li p pre small span strong table td th title tr ul}, %w{br img
+      link})
+    end
+    module Forms
+      Toolset.define(self, %w{button datalist fieldset form label meter object
+      option output progress select textarea}, %w{input keygen})
+    end
+    module Semantic
+      Toolset.define(self, %w{abbr address article cite code details figcaption
+      figure footer header legend menu nav section}, %w{command})
+    end
+    module All
+      Toolset.define(self, %w{a abbr address article aside audio b bdi bdo
+      blockquote body button canvas caption cite code colgroup datalist dd del
+      details dfn div dl dt em fieldset figcaption figure footer form h1 h2 h3
+      h4 h5 h6 head header hgroup html i iframe ins kbd label legend li map
+      mark menu meter nav noscript object ol optgroup option output p pre
+      progress q rp rt ruby s samp script section select small span strong
+      style sub summary sup table tbody td textarea tfoot th thead time title
+      tr ul var video}, %w{area base br col command embed hr img input keygen
+      link meta param source track wbr})
+    end
+  end
+  HTML = HTML5
+end

data/lib/crafty.rb ADDED Viewed

@@ -0,0 +1,11 @@
+module Crafty
+  autoload :Tools, "crafty/tools"
+  autoload :Toolset, "crafty/toolset"
+  # Generated HTML toolsets.
+  autoload :HTML4, "crafty/toolsets/html4"
+  autoload :XHTML, "crafty/toolsets/html4"
+  autoload :HTML5, "crafty/toolsets/html5"
+  autoload :HTML, "crafty/toolsets/html5"
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,21 @@
+require "rubygems"
+require "bundler/setup"
+require "test/unit"
+require "crafty"
+class Test::Unit::TestCase
+  class << self
+    # Support declarative specification of test methods.
+    def test(name)
+      define_method "test_#{name.gsub(/\s+/,'_')}".to_sym, &Proc.new
+    end
+  end
+end
+if RUBY_VERSION < "1.9"
+  class Hash
+    def each
+      to_a.sort_by { |k, v| k.to_s }.each &Proc.new
+    end
+  end
+end

data/test/unit/html_test.rb ADDED Viewed

@@ -0,0 +1,126 @@
+require File.expand_path("../test_helper", File.dirname(__FILE__))
+class HTMLBase < Test::Unit::TestCase
+  def test_dummy; end
+  def self.behaves_as_basic_html
+    # Simple methods =========================================================
+    test "div should return content with given attributes" do
+      assert_equal %Q{<div class="green">Hello</div>}, @object.div("Hello", :class => "green")
+    end
+    test "div should return content in block with given attributes" do
+      assert_equal %Q{<div class="green">Hello</div>}, @object.div(:class => "green") { "Hello" }
+    end
+    test "div should return non string content" do
+      assert_equal %Q{<div>1234</div>}, @object.div(1234)
+    end
+    test "div should not be self closing" do
+      assert_equal %Q{<div></div>}, @object.div
+    end
+    test "div should not be self closing with nil block" do
+      assert_equal %Q{<div></div>}, @object.div { nil }
+    end
+    test "div should return closing tag without content" do
+      assert_equal %Q{<div class="green"></div>}, @object.div(:class => "green")
+    end
+    test "a should return anchor with given attributes" do
+      assert_equal %Q{<a href="http://example.org">link</a>}, @object.a("link", :href => "http://example.org")
+    end
+    test "title should return title with content" do
+      assert_equal %Q{<title>Hello</title>}, @object.title("Hello")
+    end
+    test "h1 should return h1 header" do
+      assert_equal %Q{<h1>Title</h1>}, @object.h1("Title")
+    end
+    test "br should be self closing" do
+      assert_equal %Q{<br/>}, @object.br
+    end
+    test "br should not accept block content" do
+      assert_equal %Q{<br/>}, @object.br { "foo" }
+    end
+    # Streaming ==============================================================
+    test "html should product stream of strings if object responds to arrows" do
+      @streaming_object.instance_eval do
+        html do
+          head do
+            title "Hi"
+          end
+        end
+      end
+      assert_equal ["<html>", "<head>", "<title>", "Hi", "</title>", "</head>", "</html>"], @streaming_object
+    end
+    # Examples ===============================================================
+    test "complex nested build calls should render correctly" do
+      assert_equal %Q{<html>} +
+        %Q{<head><title>my document</title><link href="style.css" rel="stylesheet" type="text/css"/></head>} +
+        %Q{<body class="awesome"><div><div><table cellspacing="0">} +
+        %Q{<tr><th>Col 1</th><th>Col 2</th></tr>} +
+        %Q{<tr><td>10000</td><td>content</td></tr>} +
+        %Q{</table></div></div></body>} +
+        %Q{</html>}, @object.instance_eval {
+        html do
+          head do
+            title "my document"
+            link :href => "style.css", :rel => :stylesheet, :type => "text/css"
+          end
+          body :class => :awesome do
+            div {
+              div {
+                table :cellspacing => 0 do
+                  tr {
+                    th "Col 1"
+                    th "Col 2"
+                  }
+                  tr {
+                    td 10_000
+                    td "content"
+                  }
+                end
+              }
+            }
+          end
+        end
+      }
+    end
+  end
+end
+class HTML5Test < HTMLBase
+  def setup
+    @object = Class.new { include Crafty::HTML5::Basic }.new
+    @streaming_object = Class.new(Array) { include Crafty::HTML5::Basic }.new
+  end
+  behaves_as_basic_html
+end
+class HTML4Test < HTMLBase
+  def setup
+    @object = Class.new { include Crafty::HTML4::Basic }.new
+    @streaming_object = Class.new(Array) { include Crafty::HTML4::Basic }.new
+  end
+  behaves_as_basic_html
+end
+class HTMLAliasTest < Test::Unit::TestCase
+  test "html should equal html5" do
+    assert_equal Crafty::HTML, Crafty::HTML5
+  end
+  test "xhtml should equal html4" do
+    assert_equal Crafty::XHTML, Crafty::HTML4
+  end
+end

data/test/unit/tools_test.rb ADDED Viewed

@@ -0,0 +1,239 @@
+require File.expand_path("../test_helper", File.dirname(__FILE__))
+class ToolsTest < Test::Unit::TestCase
+  def setup
+    @object = Class.new { include Crafty::Tools }.new
+  end
+  # Basic element functionality ==============================================
+  test "element should return element with given name" do
+    assert_equal %Q{<el/>}, @object.element!("el")
+  end
+  test "element should return element with given name and content" do
+    assert_equal %Q{<el>content</el>}, @object.element!("el", "content")
+  end
+  test "element should return element with given name and non string content" do
+    assert_equal %Q{<el>1234</el>}, @object.element!("el", 1234)
+  end
+  test "element should return element with given name and content in block" do
+    assert_equal %Q{<el>content</el>}, @object.element!("el") { "content" }
+  end
+  test "element should return element with given name and non string content in block" do
+    assert_equal %Q{<el>1234</el>}, @object.element!("el") { 1234 }
+  end
+  test "element should return element with given name and built content without non string block return value" do
+    assert_equal %Q{<el><el>content</el><el>content</el></el>}, @object.element!("el") {
+      2.times { @object.element!("el") { "content" } }
+    }
+  end
+  test "element should return element with given name and built content with string block return value" do
+    assert_equal %Q{<el><el>content</el>foo</el>}, @object.element!("el") {
+      @object.element!("el") { "content" }
+      "foo"
+    }
+  end
+  test "element should return element with given name and no content" do
+    assert_equal %Q{<el></el>}, @object.element!("el") { nil }
+  end
+  test "element should return element with given name and blank content" do
+    assert_equal %Q{<el></el>}, @object.element!("el") { "" }
+  end
+  test "element should return element with given name and attributes" do
+    assert_equal %Q{<el attr="val" prop="value"/>},
+      @object.element!("el", nil, :attr => "val", :prop => "value")
+  end
+  test "element should return element with given name and attributes and content" do
+    assert_equal %Q{<el attr="val" prop="value">content</el>},
+      @object.element!("el", "content", :attr => "val", :prop => "value")
+  end
+  test "element should return element with given name and attributes and content in block" do
+    assert_equal %Q{<el attr="val" prop="value">content</el>},
+      @object.element!("el", nil, :attr => "val", :prop => "value") { "content" }
+  end
+  test "element should return element with given name and attributes with symbol values" do
+    assert_equal %Q{<el attr="val"/>}, @object.element!("el", nil, :attr => :val)
+  end
+  # Advanced functionality ===================================================
+  test "comment should return comment" do
+    assert_equal "<!-- commented -->", @object.comment!("commented")
+  end
+  test "instruct should return xml processing instruction" do
+    if RUBY_VERSION < "1.9"
+      assert_equal %Q{<?xml encoding="UTF-8" version="1.0"?>}, @object.instruct!
+    else
+      assert_equal %Q{<?xml version="1.0" encoding="UTF-8"?>}, @object.instruct!
+    end
+  end
+  test "instruct should return custom processing instruction" do
+    assert_equal %Q{<?foo attr="instr"?>}, @object.instruct!("foo", :attr => "instr")
+  end
+  test "declare should return declaration" do
+    assert_equal %Q{<!ENTITY greeting "Hello world">}, @object.declare!(:ENTITY, :greeting, "Hello world")
+  end
+  test "declare should return empty declaration if there are no parameters" do
+    assert_equal %Q{<!ENTITY>}, @object.declare!("ENTITY")
+  end
+  test "text should append directly to output stream" do
+    assert_equal %Q{foobar}, @object.text!("foobar")
+  end
+  test "write should append directly to output stream" do
+    assert_equal %Q{foobar}, @object.write!("foobar")
+  end
+  test "build should collect output" do
+    assert_equal %Q{<el/><el/>}, @object.build! {
+      @object.element!("el")
+      @object.element!("el")
+    }
+  end
+  test "attribute values as array should be joined with spaces" do
+    assert_equal %Q{<el attr="val1 val2 val3">content</el>},
+      @object.element!("el", "content", :attr => ["val1", "val2", "val3"])
+  end
+  test "attribute values as array should be flattened and compacted and joined with spaces" do
+    assert_equal %Q{<el attr="val1 val2 val3">content</el>},
+      @object.element!("el", "content", :attr => ["val1", [[nil, "val2"], "val3"]])
+  end
+  test "attribute values as empty array should be omitted" do
+    assert_equal %Q{<el>content</el>}, @object.element!("el", "content", :attr => [])
+  end
+  # Escaping =================================================================
+  test "element should return element with given name and escaped content" do
+    assert_equal %Q{<el>content &amp; &quot;info&quot; &lt; &gt;</el>},
+      @object.element!("el") { @object.write! %Q{content & "info" < >} }
+  end
+  test "element should return element with given name and escaped attributes" do
+    assert_equal %Q{<el attr="&quot;attrib&quot;" prop="a &gt; 1 &amp; b &lt; 4"/>},
+      @object.element!("el", nil, :attr => %Q{"attrib"}, :prop => "a > 1 & b < 4")
+  end
+  test "comment should return escaped comment" do
+    assert_equal "<!-- remarked &amp; commented -->", @object.comment!("remarked & commented")
+  end
+  test "instruct should return instruction with escaped attributes" do
+    assert_equal %Q{<?foo comment="1 &lt; 2"?>}, @object.instruct!("foo", :comment => "1 < 2")
+  end
+  test "write should escape output" do
+    assert_equal %Q{foo &amp; bar}, @object.write!("foo & bar")
+  end
+  test "element should not escape content that has been marked as html safe" do
+    html = Crafty::SafeString.new("<safe></safe>")
+    assert_equal %Q{<el><safe></safe></el>}, @object.element!("el") { html }
+  end
+  test "element should not escape attributes that have been marked as html safe" do
+    html = Crafty::SafeString.new("http://example.org/?q=example&amp;a=search")
+    assert_equal %Q{<el attr="http://example.org/?q=example&amp;a=search"/>}, @object.element!("el", nil, :attr => html)
+  end
+  test "write should not escape output that has been marked as html safe" do
+    assert_equal %Q{foo &amp; bar}, @object.write!(Crafty::SafeString.new("foo &amp; bar"))
+  end
+  test "element should return html safe string" do
+    assert_equal true, @object.element!("el").html_safe?
+  end
+  test "element should return string that reamins html safe when calling to_s" do
+    assert_equal true, @object.element!("el").to_s.html_safe?
+  end
+  # Building =================================================================
+  test "element should be nestable" do
+    assert_equal %Q{<el><nested>content</nested></el>},
+      @object.element!("el") { @object.element!("nested") { "content" } }
+  end
+  test "element should be nestable and chainable without concatenation" do
+    assert_equal %Q{<el><nest>content</nest><nested>more &amp; content</nested></el>},
+      @object.element!("el") {
+        @object.element!("nest") { "content" }
+        @object.element!("nested") { "more & content" }
+      }
+  end
+  test "element should be reset state of buffer after being called" do
+    assert_equal %Q{<el/><el/>}, @object.element!("el") + @object.element!("el")
+  end
+  test "element should append to object that responds to arrows" do
+    object = Class.new(Array) { include Crafty::Tools }.new
+    object.element!("el") {
+      object.element!("nest") { "content" }
+      object.element!("nested") { "more & content" }
+    }
+    assert_equal ["<el>", "<nest>", "content", "</nest>", "<nested>", "more &amp; content", "</nested>", "</el>"], object
+  end
+  test "element should escape content if appending to object that responds to arrows" do
+    object = Class.new(Array) { include Crafty::Tools }.new
+    content = "foo & bar"
+    object.element!("el", content)
+    assert_equal ["<el>", "foo &amp; bar",  "</el>"], object
+  end
+  test "element should return nil if appending to object that responds to arrows" do
+    object = Class.new(Array) { include Crafty::Tools }.new
+    assert_nil object.element!("el")
+  end
+  test "element should append html safe strings to object that responds to arrows if html safe exists" do
+    begin
+      String.class_eval do
+        def html_safe
+          obj = dup
+          class << obj
+            def html_safe?; true end
+          end
+          obj
+        end
+      end
+      object = Class.new(Array) { include Crafty::Tools }.new
+      object.element!("el") {
+        object.element!("nest") { "content" }
+        object.element!("nested") { "more & content" }
+      }
+      assert_equal [true] * object.length, object.map(&:html_safe?)
+    ensure
+      String.class_eval do
+        undef_method :html_safe
+      end
+    end
+  end
+  test "element should append html safe strings to object that responds to arrows if html safe does not exist" do
+    object = Class.new(Array) { include Crafty::Tools }.new
+    object.element!("el") {
+      object.element!("nest") { "content" }
+      object.element!("nested") { "more & content" }
+    }
+    assert_equal [true] * object.length, object.map(&:html_safe?)
+  end
+end

data/test/unit/toolset_test.rb ADDED Viewed

@@ -0,0 +1,52 @@
+require File.expand_path("../test_helper", File.dirname(__FILE__))
+class ToolsetTest < Test::Unit::TestCase
+  def setup
+    @toolset = Module.new { Crafty::Toolset.define(self, %w{a b c d}) }
+  end
+  # Basic functionality ======================================================
+  test "toolset should include methods" do
+    toolset = @toolset
+    object = Class.new { include toolset }.new
+    assert_equal "<a></a>", object.a
+  end
+  test "toolset should include elements" do
+    toolset = @toolset
+    object = Class.new { include toolset }.new
+    assert_equal "<x/>", object.element!("x")
+  end
+  # No conflicts =============================================================
+  test "toolset should not override existing method" do
+    toolset = @toolset
+    object = Class.new do
+      def b; end
+      include toolset
+    end.new
+    assert_equal nil, object.b {}
+  end
+  test "toolset should not override existing method when included twice" do
+    toolset = @toolset
+    object = Class.new do
+      def b; end
+      include toolset
+      include toolset
+    end.new
+    assert_equal nil, object.b {}
+  end
+  test "toolset should not override existing method from ancestor" do
+    toolset = @toolset
+    conflict = Module.new do
+      def b; end
+    end
+    object = Class.new do
+      include conflict
+      include toolset
+    end.new
+    assert_equal nil, object.b {}
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: crafty
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.1.0
+platform: ruby
+authors:
+- Rolf Timmermans
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-04-01 00:00:00 +02:00
+default_executable:
+dependencies: []
+description: Crafty provides you the tools to easily and flexibly create HTML output with pure Ruby.
+email: r.timmermans@voormedia.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- crafty.gemspec
+- lib/crafty.rb
+- lib/crafty/safety.rb
+- lib/crafty/tools.rb
+- lib/crafty/toolset.rb
+- lib/crafty/toolsets/html4.rb
+- lib/crafty/toolsets/html5.rb
+- test/test_helper.rb
+- test/unit/html_test.rb
+- test/unit/tools_test.rb
+- test/unit/toolset_test.rb
+has_rdoc: true
+homepage:
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.5.2
+signing_key:
+specification_version: 3
+summary: Build HTML like a master craftsman.
+test_files:
+- test/test_helper.rb
+- test/unit/html_test.rb
+- test/unit/tools_test.rb
+- test/unit/toolset_test.rb