builder 3.2.3

data/rakelib/publish.rake

@@ -0,0 +1,20 @@
+# Optional publish task for Rake
+
+begin
+require 'rake/contrib/sshpublisher'
+require 'rake/contrib/rubyforgepublisher'
+
+publisher = Rake::CompositePublisher.new
+publisher.add Rake::RubyForgePublisher.new('builder', 'jimweirich')
+publisher.add Rake::SshFilePublisher.new(
+  'linode',
+  'htdocs/software/builder',
+  '.',
+  'builder.blurb')
+
+desc "Publish the Documentation to RubyForge."
+task :publish => [:rdoc] do
+  publisher.upload
+end
+rescue LoadError
+end

data/rakelib/tags.rake

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+module Tags
+  extend Rake::DSL if defined?(Rake::DSL)
+
+  PROG = ENV['TAGS'] || 'ctags'
+
+  RAKEFILES = FileList['Rakefile', '**/*.rake']
+
+  FILES = FileList['**/*.rb', '**/*.js'] + RAKEFILES
+  FILES.exclude('pkg', 'dist')
+
+  PROJECT_DIR = ['.']
+
+  RVM_GEMDIR = File.join(`rvm gemdir`.strip, "gems") rescue nil
+  SYSTEM_DIRS = RVM_GEMDIR && File.exists?(RVM_GEMDIR) ? RVM_GEMDIR : []
+
+  module_function
+
+  # Convert key_word to --key-word.
+  def keyword(key)
+    k = key.to_s.gsub(/_/, '-')
+    (k.length == 1) ? "-#{k}" : "--#{k}"
+  end
+
+  # Run ctags command
+  def run(*args)
+    opts = {
+      :e => true,
+      :totals => true,
+      :recurse => true,
+    }
+    opts = opts.merge(args.pop) if args.last.is_a?(Hash)
+    command_args = opts.map { |k, v|
+      (v == true) ? keyword(k) : "#{keyword(k)}=#{v}"
+    }.join(" ")
+    sh %{#{Tags::PROG} #{command_args} #{args.join(' ')}}
+  end
+end
+
+namespace "tags" do
+  desc "Generate an Emacs TAGS file"
+   task :emacs, [:all] => Tags::FILES do |t, args|
+    puts "Making Emacs TAGS file"
+    verbose(true) do
+      Tags.run(Tags::PROJECT_DIR)
+      Tags.run(Tags::RAKEFILES,
+        :language_force => "ruby",
+        :append => true)
+      if args.all
+        Tags::SYSTEM_DIRS.each do |dir|
+          Tags.run(dir,
+            :language_force => "ruby",
+            :append => true)
+        end
+      end
+    end
+  end
+end
+
+desc "Generate the TAGS file"
+task :tags, [:all] => ["tags:emacs"]

data/rakelib/testing.rake

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+
+module Builder
+  class Test < Minitest::Test
+    alias :assert_raise :assert_raises
+    alias :assert_not_nil :refute_nil
+
+    def assert_nothing_raised
+      yield
+    end
+  end
+end

data/test/performance.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# encoding: iso-8859-1
+
+#--
+# Portions copyright 2004 by Jim Weirich (jim@weirichhouse.org).
+# Portions copyright 2005 by Sam Ruby (rubys@intertwingly.net).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#++
+
+require 'builder/xmlmarkup'
+require 'benchmark'
+
+text = "This is a test of the new xml markup. I�t�rn�ti�n�liz�ti�n\n" * 10000
+
+include Benchmark          # we need the CAPTION and FMTSTR constants
+include Builder
+n = 50
+Benchmark.benchmark do |bm|
+  tf = bm.report("base")   {
+    n.times do
+      x = XmlMarkup.new
+      x.text(text)
+      x.target!
+    end
+  }
+  def XmlMarkup._escape(text)
+    text.to_xs
+  end
+  tf = bm.report("to_xs")   {
+    n.times do
+      x = XmlMarkup.new
+      x.text(text)
+      x.target!
+    end
+  }
+end
+

data/test/preload.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+#--
+# Portions copyright 2004 by Jim Weirich (jim@weirichhouse.org).
+# Portions copyright 2005 by Sam Ruby (rubys@intertwingly.net).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#++
+
+# We are defining method_added in Kernel and Object so that when
+# BlankSlate overrides them later, we can verify that it correctly
+# calls the older hooks.
+
+module Kernel
+  class << self
+    attr_reader :k_added_names
+    alias_method :preload_method_added, :method_added
+    def method_added(name)
+      preload_method_added(name)
+      @k_added_names ||= []
+      @k_added_names << name
+    end
+  end
+end
+
+class Object
+  class << self
+    attr_reader :o_added_names
+    alias_method :preload_method_added, :method_added
+    def method_added(name)
+      preload_method_added(name)
+      @o_added_names ||= []
+      @o_added_names << name
+    end
+  end
+end

data/test/test_blankslate.rb

@@ -0,0 +1,213 @@
+#!/usr/bin/env ruby
+
+#--
+# Portions copyright 2004 by Jim Weirich (jim@weirichhouse.org).
+# Portions copyright 2005 by Sam Ruby (rubys@intertwingly.net).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#++
+
+require 'helper'
+require 'preload'
+require 'blankslate'
+require 'stringio'
+
+# Methods to be introduced into the Object class late.
+module LateObject
+  def late_object
+    33
+  end
+  def LateObject.included(mod)
+    # Modules defining an included method should not prevent blank
+    # slate erasure!
+  end
+end
+
+# Methods to be introduced into the Kernel module late.
+module LateKernel
+  def late_kernel
+    44
+  end
+  def LateKernel.included(mod)
+    # Modules defining an included method should not prevent blank
+    # slate erasure!
+  end
+end
+
+# Introduce some late methods (both module and direct) into the Kernel
+# module.
+module Kernel
+  include LateKernel
+
+  def late_addition
+    1234
+  end
+
+  def double_late_addition
+    22
+  end
+end
+
+
+# Introduce some late methods (both module and direct) into the Object
+# class.
+class Object
+  include LateObject
+  def another_late_addition
+    4321
+  end
+end
+
+# Introduce some late methods by inclusion.
+module GlobalModule
+ def global_inclusion
+   42
+ end
+end
+include GlobalModule
+
+def direct_global
+  43
+end
+
+######################################################################
+# Test case for blank slate.
+#
+class TestBlankSlate < Builder::Test
+  def setup
+    @bs = BlankSlate.new
+  end
+
+  def test_undefined_methods_remain_undefined
+    assert_raise(NoMethodError) { @bs.no_such_method }
+    assert_raise(NoMethodError) { @bs.nil? }
+  end
+
+
+  # NOTE: NameError is acceptable because the lack of a '.' means that
+  # Ruby can't tell if it is a method or a local variable.
+  def test_undefined_methods_remain_undefined_during_instance_eval
+    assert_raise(NoMethodError, NameError)  do
+      @bs.instance_eval do nil? end
+    end
+    assert_raise(NoMethodError, NameError)  do
+      @bs.instance_eval do no_such_method end
+    end
+  end
+
+  def test_private_methods_are_undefined
+    assert_raise(NoMethodError) do
+      @bs.puts "HI"
+    end
+  end
+
+  def test_targetted_private_methods_are_undefined_during_instance_eval
+    assert_raise(NoMethodError, NameError) do
+      @bs.instance_eval do self.puts "HI" end
+    end
+  end
+
+  def test_untargetted_private_methods_are_defined_during_instance_eval
+    oldstdout = $stdout
+    $stdout = StringIO.new
+    @bs.instance_eval do
+      puts "HI"
+    end
+  ensure
+    $stdout = oldstdout
+  end
+
+  def test_methods_added_late_to_kernel_remain_undefined
+    assert_equal 1234, nil.late_addition
+    assert_raise(NoMethodError) { @bs.late_addition }
+  end
+
+  def test_methods_added_late_to_object_remain_undefined
+    assert_equal 4321, nil.another_late_addition
+    assert_raise(NoMethodError) { @bs.another_late_addition }
+  end
+
+  def test_methods_added_late_to_global_remain_undefined
+    assert_equal 42, global_inclusion
+    assert_raise(NoMethodError) { @bs.global_inclusion }
+  end
+
+  def test_preload_method_added
+    assert Kernel.k_added_names.include?(:late_addition)
+    assert Object.o_added_names.include?(:another_late_addition)
+  end
+
+  def test_method_defined_late_multiple_times_remain_undefined
+    assert_equal 22, nil.double_late_addition
+    assert_raise(NoMethodError) { @bs.double_late_addition }
+  end
+
+  def test_late_included_module_in_object_is_ok
+    assert_equal 33, 1.late_object
+    assert_raise(NoMethodError) { @bs.late_object }
+  end
+
+  def test_late_included_module_in_kernel_is_ok
+    assert_raise(NoMethodError) { @bs.late_kernel }
+  end
+
+  def test_revealing_previously_hidden_methods_are_callable
+    with_to_s = Class.new(BlankSlate) do
+      reveal :to_s
+    end
+    assert_match(/^#<.*>$/, with_to_s.new.to_s)
+  end
+
+  def test_revealing_previously_hidden_methods_are_callable_with_block
+    Object.class_eval <<-EOS
+      def given_block(&block)
+        block
+      end
+    EOS
+
+    with_given_block = Class.new(BlankSlate) do
+      reveal :given_block
+    end
+    assert_not_nil with_given_block.new.given_block {}
+  end
+
+  def test_revealing_a_hidden_method_twice_is_ok
+    with_to_s = Class.new(BlankSlate) do
+      reveal :to_s
+      reveal :to_s
+    end
+    assert_match(/^#<.*>$/, with_to_s.new.to_s)
+  end
+
+  def test_revealing_unknown_hidden_method_is_an_error
+    assert_raises(RuntimeError) do
+      Class.new(BlankSlate) do
+        reveal :xyz
+      end
+    end
+  end
+
+  def test_global_includes_still_work
+    assert_nothing_raised do
+      assert_equal 42, global_inclusion
+      assert_equal 42, Object.new.global_inclusion
+      assert_equal 42, "magic number".global_inclusion
+      assert_equal 43, direct_global
+    end
+  end
+
+  def test_reveal_should_not_bind_to_an_instance
+    with_object_id = Class.new(BlankSlate) do
+      reveal(:object_id)
+    end
+
+    obj1 = with_object_id.new
+    obj2 = with_object_id.new
+
+    assert obj1.object_id != obj2.object_id,
+       "Revealed methods should not be bound to a particular instance"
+  end
+end

data/test/test_eventbuilder.rb

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+
+#--
+# Portions copyright 2004 by Jim Weirich (jim@weirichhouse.org).
+# Portions copyright 2005 by Sam Ruby (rubys@intertwingly.net).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#++
+
+require 'helper'
+require 'preload'
+require 'builder'
+require 'builder/xmlevents'
+
+class TestEvents < Builder::Test
+
+  class Target
+    attr_reader :events
+
+    def initialize
+      @events = []
+    end
+
+    def start_tag(tag, attrs)
+      @events << [:start_tag, tag, attrs]
+    end
+
+    def end_tag(tag)
+      @events << [:end_tag, tag]
+    end
+    
+    def text(string)
+      @events << [:text, string]
+    end
+    
+  end
+
+
+  def setup
+    @target = Target.new
+    @xml = Builder::XmlEvents.new(:target=>@target)
+  end
+
+  def test_simple
+    @xml.one
+    expect [:start_tag, :one, nil]
+    expect [:end_tag, :one]
+    expect_done
+  end
+
+  def test_nested
+    @xml.one { @xml.two }
+    expect [:start_tag, :one, nil]
+    expect [:start_tag, :two, nil]
+    expect [:end_tag, :two]
+    expect [:end_tag, :one]
+    expect_done
+  end
+
+  def test_text
+    @xml.one("a")
+    expect [:start_tag, :one, nil]
+    expect [:text, "a"]
+    expect [:end_tag, :one]
+    expect_done
+  end
+
+  def test_special_text
+    @xml.one("H&R")
+    expect [:start_tag, :one, nil]
+    expect [:text, "H&R"]
+    expect [:end_tag, :one]
+    expect_done
+  end
+
+  def test_text_with_entity
+    @xml.one("H&amp;R")
+    expect [:start_tag, :one, nil]
+    expect [:text, "H&amp;R"]
+    expect [:end_tag, :one]
+    expect_done
+  end
+
+  def test_attributes
+    @xml.a(:b=>"c", :x=>"y")
+    expect [:start_tag, :a, {:x => "y", :b => "c"}]
+    expect [:end_tag, :a]
+    expect_done
+  end
+
+  def test_moderately_complex
+    @xml.tag! "address-book" do |x|
+      x.entry :id=>"1" do
+	x.name {
+	  x.first "Bill"
+	  x.last "Smith"
+	}
+	x.address "Cincinnati"
+      end
+      x.entry :id=>"2" do
+	x.name {
+	  x.first "John"
+	  x.last "Doe"
+	}
+	x.address "Columbus"
+      end
+    end
+    expect [:start_tag, "address-book".intern, nil]
+    expect [:start_tag, :entry, {:id => "1"}]
+    expect [:start_tag, :name, nil]
+    expect [:start_tag, :first, nil]
+    expect [:text, "Bill"]
+    expect [:end_tag, :first]
+    expect [:start_tag, :last, nil]
+    expect [:text, "Smith"]
+    expect [:end_tag, :last]
+    expect [:end_tag, :name]
+    expect [:start_tag, :address, nil]
+    expect [:text, "Cincinnati"]
+    expect [:end_tag, :address]
+    expect [:end_tag, :entry]
+    expect [:start_tag, :entry, {:id => "2"}]
+    expect [:start_tag, :name, nil]
+    expect [:start_tag, :first, nil]
+    expect [:text, "John"]
+    expect [:end_tag, :first]
+    expect [:start_tag, :last, nil]
+    expect [:text, "Doe"]
+    expect [:end_tag, :last]
+    expect [:end_tag, :name]
+    expect [:start_tag, :address, nil]
+    expect [:text, "Columbus"]
+    expect [:end_tag, :address]
+    expect [:end_tag, :entry]
+    expect [:end_tag, "address-book".intern]
+    expect_done
+  end
+
+  def expect(value)
+    assert_equal value, @target.events.shift
+  end
+
+  def expect_done
+    assert_nil @target.events.shift
+  end
+
+end