undies 1.0.0 → 1.1.0

data/.gitignore

@@ -1,4 +1,5 @@
 pkg/*
 .bundle
 *.gem
-*.log
+*.log
+.rvmrc

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    undies (1.0.0)
+    undies (1.1.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
     leftright (0.9.1)
     rake (0.9.2)
-    test-belt (1.1.2)
+    test-belt (2.0.0)
       leftright (~> 0.9.0)
 
 PLATFORMS
@@ -17,5 +17,5 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0)
   rake (~> 0.9.2)
-  test-belt (~> 1.1.0)
+  test-belt (~> 2.0)
   undies!

data/README.rdoc

@@ -1,5 +1,5 @@
 = Undies
-A pure-Ruby DSL for writing HTML templates.  Named for its gratuitous use of the underscore.
+A pure-Ruby DSL for writing HTML or plain text templates.  Named for its gratuitous use of the underscore.
 == Installation
     $ gem install undies
 == Usage
@@ -32,9 +32,43 @@ Tag with class attributes
     _h1.header.awesome
     # => "<h1 class=\"header awesome\" />"
 
+== Rendering Templates
+
+* basic render:
+    
+    # render a block of markup
+    Undies::Template.new do
+      _div {
+        _ "Some Content"
+      }
+    end.to_s
+
+* streaming render
+
+    # render the template and push it to the output stream as it is being constructed
+    # just pass an IO to the template constructor
+    Undies::Template.new(output_io).new do
+      _div {
+        _ "Some Content"
+      }
+    end
+
+* render passing local vars in and pretty printing:
+
+    # render a file with markup
+    # make the local vars 'four' and 'name' available the the template markup
+    # pretty print the output with 2-space indentation
+    Undies::Template.new("path/to/file", {
+      :four => 2 + 2,
+      :name => "Awesome"
+    }).to_s(2)
+
+=== Pretty Printing
+If you want to pretty print the output, pass an integer specifying the number of spaces to indent to the `to_s` method.
+
 == License
 
-Copyright (c) 2011 Kelly D. Redding
+Copyright (c) 2011 Kelly Redding
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/lib/undies/element.rb

@@ -1,5 +1,6 @@
 require 'undies/node'
 require 'undies/node_list'
+require 'undies/element_stack'
 
 module Undies
   class Element < Node
@@ -8,6 +9,9 @@ module Undies
     attr_accessor :nodes
 
     def initialize(stack, name, attrs={}, &block)
+      if !stack.kind_of?(ElementStack)
+        raise ArgumentError, "stack must be an Undies::ElementStack"
+      end
       super(@nodes = NodeList.new)
       @stack = stack
       @name = name.to_s
@@ -104,4 +108,4 @@ module Undies
     end
 
   end
-end
+end

data/lib/undies/element_stack.rb

@@ -0,0 +1,35 @@
+require "undies/element"
+
+module Undies
+  class ElementStack < ::Array
+
+    # an element stack is used to manage which element is receiving content
+    # if an undies template is streaming io, then when an element is pushed,
+    # its start tag is added to the stream and its end tag is added when popped.
+
+    attr_reader :io
+
+    def initialize(first_item=nil, io=nil, *args)
+      @io = io
+      # always initialize empty
+      super()
+      self.send(:<<, first_item) if first_item
+    end
+
+    def push(item)
+      unless item.kind_of?(Element)
+        raise ArgumentError, 'you can only push element nodes to an ElementStack'
+      end
+      super
+      @io << item.start_tag if @io
+      item
+    end
+
+    def pop
+      item = super
+      @io << item.end_tag if @io
+      item
+    end
+
+  end
+end

data/lib/undies/node_list.rb

@@ -4,7 +4,7 @@ module Undies
   class NodeList < ::Array
 
     def initialize(*args)
-      #always initialize empty
+      # always initialize empty
       super()
     end
 
@@ -25,4 +25,4 @@ module Undies
     end
 
   end
-end
+end

data/lib/undies/partial.rb

@@ -4,16 +4,19 @@ require 'undies/template'
 module Undies
   class Partial < Template
 
-    def initialize(path, object=nil, locals={})
-      data = PartialData.new(path)
-      data.object, data.values = object_locals(object, locals)
-      super(path, data)
+    def initialize(path, *args)
+      locals = PartialData.new(path)
+      locals.values, io, locals.object = self.___partial_args(*args)
+      super(path, io, locals)
     end
 
-    private
+    protected
 
-    def object_locals(o, l)
-      o && o.kind_of?(::Hash) ? [nil, o] : [o, l || {}]
+    def ___partial_args(*args)
+      [ args.last.kind_of?(::Hash) ? args.pop : {},
+        self.___is_a_stream?(args.last) ? args.pop : nil,
+        args.first
+      ]
     end
 
   end

data/lib/undies/template.rb

@@ -8,34 +8,36 @@ module Undies
     attr_accessor :nodes
 
     def initialize(*args, &block)
-      @nodes = NodeList.new
-      @stack = [self]
-      self.data, @source = data_source(args, block)
+      self.___locals, self.___io, source = self.___template_args(args, block)
+      self.___stack = ElementStack.new(self, self.___io)
+      self.nodes = NodeList.new
 
-      if (@source).file?
-        instance_eval(@source.data, @source.source, 1)
+      if (source).file?
+        instance_eval(source.data, source.source, 1)
       else
-        instance_eval(&@source.data)
+        instance_eval(&source.data)
       end
     end
 
     def to_s(pp_indent=nil)
-      @nodes.collect{|n| n.to_s(0, pp_indent)}.join
+      self.nodes.collect{|n| n.to_s(0, pp_indent)}.join
     end
 
     # Add a text node (data escaped) to the nodes of the current node
-    def _(data)
-      @stack.last.nodes.append(Node.new(escape_html(data.to_s)))
+    def _(data="")
+      self.__ self.escape_html(data.to_s)
     end
 
     # Add a text node with the data un-escaped
-    def __(data)
-      @stack.last.nodes.append(Node.new(data.to_s))
+    def __(data="")
+      node = Node.new(data.to_s)
+      self.___io << node.to_s if self.___io
+      self.___add(node)
     end
 
     # Add an element to the nodes of the current node
     def element(name, attrs={}, &block)
-      @stack.last.nodes.append(Element.new(@stack, name, attrs, &block))
+      self.___add(Element.new(self.___stack, name, attrs, &block))
     end
     alias_method :tag, :element
 
@@ -59,56 +61,87 @@ module Undies
     end
     # ==============================================================
 
+    # Ripped from Rack v1.3.0 ======================================
+    # => ripped b/c I don't want a dependency on Rack for just this
+    ESCAPE_HTML = {
+      "&" => "&amp;",
+      "<" => "&lt;",
+      ">" => "&gt;",
+      "'" => "&#x27;",
+      '"' => "&quot;",
+      "/" => "&#x2F;"
+    }
+    ESCAPE_HTML_PATTERN = Regexp.union(*ESCAPE_HTML.keys)
+
+    # Escape ampersands, brackets and quotes to their HTML/XML entities.
+    def escape_html(string)
+      string.to_s.gsub(ESCAPE_HTML_PATTERN){|c| ESCAPE_HTML[c] }
+    end
+    # end Rip from Rack v1.3.0 =====================================
+
     protected
 
-    def data=(data)
-      raise ArgumentError if !data.kind_of?(::Hash)
+    # prefixing non-public methods with a triple underscore to not pollute
+    # metaclass locals scope
+
+    def ___locals=(data)
+      if !data.kind_of?(::Hash)
+        raise ArgumentError
+      end
+      if invalid_locals?(data.keys)
+        raise ArgumentError, "locals conflict with template's public methods."
+      end
       data.each do |key, value|
-        metaclass do
+        self.___metaclass do
           define_method(key) { value }
         end
       end
     end
 
-    def source
-      @source
+    def ___add(node)
+      self.___stack.last.nodes.append(node)
     end
 
-    def stack
+    def ___stack
       @stack
     end
 
-    private
+    def ___stack=(value)
+      raise ArgumentError if !value.respond_to?(:push) || !value.respond_to?(:pop)
+      @stack = value
+    end
 
-    def data_source(args, block)
+    def ___io
+      @io
+    end
+
+    def ___io=(value)
+      raise ArgumentError if value && !self.___is_a_stream?(value)
+      @io = value
+    end
+
+    def ___template_args(args, block)
       [ args.last.kind_of?(::Hash) ? args.pop : {},
+        self.___is_a_stream?(args.last) ? args.pop : nil,
         Source.new(block || args.first.to_s)
       ]
     end
 
-    def metaclass(&block)
+    def ___metaclass(&block)
       metaclass = class << self; self; end
       metaclass.class_eval(&block)
     end
 
-    # Ripped from Rack v1.3.0 ======================================
-    # => ripped b/c I don't want a dependency on Rack for just this
-    ESCAPE_HTML = {
-      "&" => "&amp;",
-      "<" => "&lt;",
-      ">" => "&gt;",
-      "'" => "&#x27;",
-      '"' => "&quot;",
-      "/" => "&#x2F;"
-    }
-    ESCAPE_HTML_PATTERN = Regexp.union(*ESCAPE_HTML.keys)
-
-    # Escape ampersands, brackets and quotes to their HTML/XML entities.
-    def escape_html(string)
-      string.to_s.gsub(ESCAPE_HTML_PATTERN){|c| ESCAPE_HTML[c] }
+    def ___is_a_stream?(thing)
+      !thing.kind_of?(::String) && thing.respond_to?(:<<)
     end
-    # end Rip from Rack v1.3.0 =====================================
 
+    private
+
+    # you can't define locals that conflict with the template's public methods
+    def invalid_locals?(keys)
+      (keys.collect(&:to_s) & self.public_methods.collect(&:to_s)).size > 0
+    end
 
   end
 end

data/lib/undies/version.rb

@@ -1,3 +1,3 @@
 module Undies
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/element_stack_test.rb

@@ -0,0 +1,77 @@
+require "test_belt"
+
+require "stringio"
+require "undies/element_stack"
+require "undies/node"
+
+class Undies::ElementStack
+
+  class BasicTest < Test::Unit::TestCase
+    include TestBelt
+
+    context 'an element stack'
+    before { @es = Undies::ElementStack.new }
+    subject { @es }
+
+    should have_instance_method :push, :pop
+    should have_reader :io
+
+    should "be an Array" do
+      assert_kind_of Array, subject
+    end
+
+    should "empty by default" do
+      assert subject.empty?
+    end
+
+    should "compain when trying to push non-elements" do
+      assert_raises ArgumentError do
+        subject.push Undies::Node.new
+      end
+
+      assert_nothing_raised do
+        subject << 1
+      end
+    end
+
+    should "initialize with a first item if one is given" do
+      stack = Undies::ElementStack.new(12)
+      assert_equal [12], stack
+    end
+
+  end
+
+  class StreamingTest < BasicTest
+    context "when streaming"
+    before do
+      @output = ""
+      @outstream = StringIO.new(@output)
+      @es = Undies::ElementStack.new(nil, @outstream)
+    end
+
+    should "know its stream" do
+      assert_same @outstream, subject.io
+    end
+
+    should "stream an elements start tag when that element is pushed" do
+      subject.push(Undies::Element.new(Undies::ElementStack.new, "div") {})
+      assert_equal "<div>", @output
+    end
+
+    should "stream an elements end tag when that element is popped" do
+      elem = Undies::Element.new(Undies::ElementStack.new, "div") {}
+      subject.push(elem)
+      popped_elem = subject.pop
+      assert_equal "<div></div>", @output
+      assert_same elem, popped_elem
+    end
+
+    should "stream an element with no content when pushed/popped" do
+      subject.push(Undies::Element.new(Undies::ElementStack.new, "span"))
+      subject.pop
+      assert_equal "<span />", @output
+    end
+
+  end
+
+end

data/test/element_test.rb

@@ -1,5 +1,8 @@
-require "test/helper"
+require "test_belt"
+
 require "undies/element"
+require "undies/element_stack"
+require "undies/template"
 
 class Undies::Element
 
@@ -9,7 +12,8 @@ class Undies::Element
     include TestBelt
 
     context 'an element'
-    subject { Undies::Element.new([], :div) }
+    before { @e = Undies::Element.new(Undies::ElementStack.new, :div) }
+    subject { @e }
     should have_readers :name, :attrs
     should have_accessor :nodes
 
@@ -29,6 +33,16 @@ class Undies::Element
       assert_equal subject.nodes.object_id, subject.content.object_id
     end
 
+    should "have an element stack as its stack" do
+      assert_kind_of Undies::ElementStack, subject.send(:instance_variable_get, "@stack")
+    end
+
+    should "complain is not created with an ElementStack" do
+      assert_raises ArgumentError do
+        Undies::Element.new([], :div)
+      end
+    end
+
   end
 
 
@@ -36,7 +50,8 @@ class Undies::Element
   class EmptyTest < Test::Unit::TestCase
     include TestBelt
     context 'an empty element'
-    subject { Undies::Element.new([], :br) }
+    before { @e = Undies::Element.new(Undies::ElementStack.new, :br) }
+    subject { @e }
 
     should "have no nodes" do
       assert_equal([], subject.nodes)
@@ -76,12 +91,12 @@ class Undies::Element
 
   class SerializeTest < BasicTest
     should "serialize with no child elements" do
-      element = Undies::Element.new([], :br)
+      element = Undies::Element.new(Undies::ElementStack.new, :br)
       assert_equal "<br />", element.to_s
     end
 
     should "serialize with attrs" do
-      element = Undies::Element.new([], :br, {:class => 'big'})
+      element = Undies::Element.new(Undies::ElementStack.new, :br, {:class => 'big'})
       assert_equal '<br class="big" />', element.to_s
     end
 

data/test/helper.rb

@@ -1,6 +1,2 @@
-require 'rubygems'
-require 'bundler'
-Bundler.setup
-
-require 'test_belt'
-require 'test/env'
+# this file is automatically required in when you require 'test_belt'
+# put test helpers here

data/test/irb.rb

@@ -0,0 +1,10 @@
+require 'test_belt'
+
+# this file is required in when the 'irb' rake test is run.
+# b/c 'test_belt' is required above, lib and test dirs will
+# be added to the LOAD_PATH and the test helper will be
+# required in.
+
+# put any IRB setup code here
+
+require 'undies'

data/test/node_list_test.rb

@@ -1,4 +1,4 @@
-require "test/helper"
+require "test_belt"
 require "undies/node_list"
 require "undies/node"
 

data/test/node_test.rb

@@ -1,4 +1,4 @@
-require "test/helper"
+require "test_belt"
 require "undies/node"
 
 class Undies::Node

data/test/partial_data_test.rb

@@ -1,4 +1,4 @@
-require "test/helper"
+require "test_belt"
 require "undies/partial_data"
 
 class Undies::PartialData

data/test/partial_test.rb

@@ -1,4 +1,6 @@
-require "test/helper"
+require "test_belt"
+
+require "stringio"
 require "undies/partial"
 
 class Undies::Partial
@@ -7,7 +9,11 @@ class Undies::Partial
     include TestBelt
 
     context 'partial'
-    subject { Undies::Partial.new 'test/templates/index.html.rb' }
+    before do
+      @path = 'test/templates/test.html.rb'
+      @p = Undies::Partial.new @path
+    end
+    subject { @p }
 
     should "be a kind of Template" do
       assert subject.kind_of?(Undies::Template)
@@ -38,4 +44,20 @@ class Undies::Partial
 
   end
 
+  class StreamTest < BasicTest
+    context "that is streaming"
+
+    before do
+      @output = ""
+      @outstream = StringIO.new(@output)
+    end
+
+
+    should "should write to the stream as its being constructed" do
+      Undies::Partial.new @path, @outstream
+      assert_equal "<html><head></head><body><div class=\"file\">FILE!!</div></body></html>", @output
+    end
+
+  end
+
 end

data/test/source_test.rb

@@ -1,4 +1,4 @@
-require "test/helper"
+require "test_belt"
 require "undies/source"
 
 class Undies::Source

data/test/template_test.rb

@@ -1,4 +1,6 @@
-require "test/helper"
+require "test_belt"
+
+require "stringio"
 require "undies/template"
 
 class Undies::Template
@@ -8,7 +10,7 @@ class Undies::Template
 
     context 'a template'
     subject { Undies::Template.new {} }
-    should have_instance_method :to_s
+    should have_instance_method :to_s, :escape_html
     should have_instance_methods :_, :__, :element, :tag
     should have_accessor :nodes
 
@@ -16,6 +18,10 @@ class Undies::Template
       assert_kind_of Undies::NodeList, subject.nodes
     end
 
+    should "have no io stream by default" do
+      assert_nil subject.send(:___io)
+    end
+
   end
 
 
@@ -46,6 +52,11 @@ class Undies::Template
       assert_equal subject.send(:escape_html, @data), subject._(@data).to_s
     end
 
+    should "add empty string nodes using '__' and '_' methods with no args" do
+      assert_equal "", subject._.to_s
+      assert_equal "", subject.__.to_s
+    end
+
   end
 
 
@@ -54,7 +65,7 @@ class Undies::Template
     context "using the 'element' helper"
 
     should "return an Element object" do
-      assert_equal Undies::Element.new([], :br), subject.element(:br)
+      assert_equal Undies::Element.new(Undies::ElementStack.new, :br), subject.element(:br)
     end
 
     should "alias it with 'tag'" do
@@ -64,7 +75,7 @@ class Undies::Template
     should "add a new Element object" do
       subject.element(:br)
       assert_equal 1, subject.nodes.size
-      assert_equal Undies::Element.new([], :br), subject.nodes.first
+      assert_equal Undies::Element.new(Undies::ElementStack.new, :br), subject.nodes.first
     end
 
     should "respond to underscore-prefix methods" do
@@ -86,7 +97,7 @@ class Undies::Template
 
 
 
-  class DataTest < BasicTest
+  class LocalsTest < BasicTest
 
     should "only accept the data if it is a Hash" do
       assert_raises NoMethodError do
@@ -105,7 +116,13 @@ class Undies::Template
       )
     end
 
-    should "respond to each data key with its value" do
+    should "complain if trying to set locals that conflict with public methods" do
+      assert_raises ArgumentError do
+        Undies::Template.new(:_ => "yay!") {}
+      end
+    end
+
+    should "respond to each locals key with its value" do
       templ = Undies::Template.new(:some => "data") {}
       assert_equal "data", templ.some
     end
@@ -127,7 +144,7 @@ class Undies::Template
       assert_equal "<div><div>#{templ.object_id}</div></div>", templ.to_s
     end
 
-    should "be able to access its data in the template definition" do
+    should "be able to access its locals in the template definition" do
       templ = Undies::Template.new(:name => "awesome") do
         _div {
           _div { _ name }
@@ -178,4 +195,28 @@ class Undies::Template
     end
   end
 
+
+
+  class StreamTest < BasicTest
+    context "that is streaming"
+
+    before do
+      @output = ""
+      @outstream = StringIO.new(@output)
+    end
+
+    should "should write to the stream as its being constructed" do
+      templ = Undies::Template.new(@outstream) do
+        _div {
+          _div.good.thing!(:type => "something") {
+            __ "good streaming action"
+          }
+        }
+      end
+      assert_equal "<div><div class=\"good\" id=\"thing\" type=\"something\">good streaming action</div></div>", @output
+    end
+
+  end
+
 end
+

data/undies.gemspec

@@ -6,11 +6,11 @@ Gem::Specification.new do |s|
   s.name        = "undies"
   s.version     = Undies::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Kelly D. Redding"]
+  s.authors     = ["Kelly Redding"]
   s.email       = ["kelly@kelredd.com"]
   s.homepage    = "http://github.com/kelredd/undies"
-  s.summary     = %q{A pure-Ruby HTML templating DSL.}
-  s.description = %q{A pure-Ruby HTML templating DSL.}
+  s.summary     = %q{A pure-Ruby HTML and plain text templating DSL.}
+  s.description = %q{A pure-Ruby HTML and plain text templating DSL.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency("bundler", ["~> 1.0"])
-  s.add_development_dependency("test-belt", ["~> 1.1.0"])
+  s.add_development_dependency("test-belt", ["~> 2.0"])
 
 end

metadata

@@ -1,23 +1,25 @@
 --- !ruby/object:Gem::Specification 
 name: undies
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
-- Kelly D. Redding
+- Kelly Redding
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-07-25 00:00:00 Z
+date: 2011-09-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -29,26 +31,23 @@ dependencies:
         - 0
         version: "1.0"
   version_requirements: *id001
-  prerelease: false
   name: bundler
-  type: :development
 - !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 3
         segments: 
-        - 1
-        - 1
+        - 2
         - 0
-        version: 1.1.0
+        version: "2.0"
   version_requirements: *id002
-  prerelease: false
   name: test-belt
-  type: :development
-description: A pure-Ruby HTML templating DSL.
+description: A pure-Ruby HTML and plain text templating DSL.
 email: 
 - kelly@kelredd.com
 executables: []
@@ -65,6 +64,7 @@ files:
 - Rakefile
 - lib/undies.rb
 - lib/undies/element.rb
+- lib/undies/element_stack.rb
 - lib/undies/node.rb
 - lib/undies/node_list.rb
 - lib/undies/partial.rb
@@ -72,9 +72,10 @@ files:
 - lib/undies/source.rb
 - lib/undies/template.rb
 - lib/undies/version.rb
+- test/element_stack_test.rb
 - test/element_test.rb
-- test/env.rb
 - test/helper.rb
+- test/irb.rb
 - test/node_list_test.rb
 - test/node_test.rb
 - test/partial_data_test.rb
@@ -113,14 +114,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A pure-Ruby HTML templating DSL.
+summary: A pure-Ruby HTML and plain text templating DSL.
 test_files: 
+- test/element_stack_test.rb
 - test/element_test.rb
-- test/env.rb
 - test/helper.rb
+- test/irb.rb
 - test/node_list_test.rb
 - test/node_test.rb
 - test/partial_data_test.rb

data/test/env.rb

@@ -1,10 +0,0 @@
-# Add test and lib paths to the $LOAD_PATH
-[ File.dirname(__FILE__),
-  File.join(File.dirname(__FILE__), '..', 'lib')
-].each do |path|
-  full_path = File.expand_path(path)
-  $LOAD_PATH.unshift(full_path) unless $LOAD_PATH.include?(full_path)
-end
-
-require 'undies'
-