blankslate 2.1.2.4 → 3.1.2

data/doc/releases/builder-1.2.4.rdoc

@@ -0,0 +1,31 @@
+= Builder 1.2.4 Released.
+
+Added a "CDATA" method to the XML Markup builder (from Josh Knowles).
+
+== What is Builder?
+
+Builder::XmlMarkup allows easy programmatic creation of XML markup.
+For example:
+
+  builder = Builder::XmlMarkup.new(:target=>STDOUT, :indent=>2)
+  builder.person { |b| b.name("Jim"); b.phone("555-1234") }
+  puts builder.target!
+
+will generate:
+
+  <person>
+    <name>Jim</name>
+    <phone>555-1234</phone>
+  </person>
+
+== Availability
+
+The easiest way to get and install builder is via RubyGems ...
+
+  gem install builder    (you may need root/admin privileges)
+
+== Thanks
+
+* Josh Knowles for the cdata! patch.
+
+-- Jim Weirich

data/doc/releases/builder-2.0.0.rdoc

@@ -0,0 +1,46 @@
+= Builder 2.0.0 Released.
+
+== Changes in 2.0.0
+
+* UTF-8 characters in data are now correctly translated to their XML
+  equivalents. (Thanks to Sam Ruby)
+
+* Attribute values are now escaped by default.  See the README
+  file for details.
+
+<b>NOTE:</b> The escaping attribute values by default is different
+than in previous releases of Builder.  This makes version 2.0.0
+somewhat incompatible with the 1.x series of Builder.  If you use "&",
+"<", or ">" in attributes values, you may have to change your
+code. (Essentially you remove the manual escaping.  The new way is
+easier, believe me).
+
+== What is Builder?
+
+Builder::XmlMarkup is a library that allows easy programmatic creation
+of XML markup.  For example:
+
+  builder = Builder::XmlMarkup.new(:target=>STDOUT, :indent=>2)
+  builder.person { |b| b.name("Jim"); b.phone("555-1234") }
+
+will generate:
+
+  <person>
+    <name>Jim</name>
+    <phone>555-1234</phone>
+  </person>
+
+== Availability
+
+The easiest way to get and install builder is via RubyGems ...
+
+  gem install builder    (you may need root/admin privileges)
+
+== Thanks
+
+* Sam Ruby for the XChar module and the related UTF-8 translation
+  tools.
+* Also to Sam Ruby for gently persuading me to start quoting attribute
+  values.
+
+-- Jim Weirich

data/doc/releases/builder-2.1.1.rdoc

@@ -0,0 +1,58 @@
+= Builder 2.1.1 Released.
+
+Release 2.1.1 of Builder is mainly a bug fix release.
+
+== Changes in 2.1.1
+
+* Added <tt>reveal</tt> capability to BlankSlate.
+
+* Fixed a bug in BlankSlate where including a module into Object could
+  cause methods to leak into BlankSlate.
+
+* Fixed typo in XmlMarkup class docs (from Martin Fowler).
+
+* Fixed test on private methods to differentiate between targetted and
+  untargetted private methods.
+
+* Removed legacy capture of @self in XmlBase (@self was used back when
+  we used instance eval).
+
+* Added additional tests for global functions (both direct and
+  included).
+
+* Several misc internal cleanups, including rearranging the source
+  code tree.
+
+<b>NOTE:</b> The escaping attribute values by default is different
+than in previous releases of Builder.  This makes version 2.0.x
+somewhat incompatible with the 1.x series of Builder.  If you use "&",
+"<", or ">" in attributes values, you may have to change your
+code. (Essentially you remove the manual escaping.  The new way is
+easier, believe me).
+
+== What is Builder?
+
+Builder::XmlMarkup is a library that allows easy programmatic creation
+of XML markup.  For example:
+
+  builder = Builder::XmlMarkup.new(:target=>STDOUT, :indent=>2)
+  builder.person { |b| b.name("Jim"); b.phone("555-1234") }
+
+will generate:
+
+  <person>
+    <name>Jim</name>
+    <phone>555-1234</phone>
+  </person>
+
+== Availability
+
+The easiest way to get and install builder is via RubyGems ...
+
+  gem install builder    (you may need root/admin privileges)
+
+== Thanks
+
+* Martin Fowler for spotting some typos in the documentation.
+
+-- Jim Weirich

data/lib/blankslate.rb

@@ -8,6 +8,30 @@
 # above copyright notice is included.
 #++
 
+class String
+  if instance_methods.first.is_a?(Symbol)
+    def _blankslate_as_name
+      to_sym
+    end
+  else
+    def _blankslate_as_name
+      self
+    end
+  end
+end
+
+class Symbol
+  if instance_methods.first.is_a?(Symbol)
+    def _blankslate_as_name
+      self
+    end
+  else
+    def _blankslate_as_name
+      to_s
+    end
+  end
+end
+
 ######################################################################
 # BlankSlate provides an abstract base class with no predefined
 # methods (except for <tt>\_\_send__</tt> and <tt>\_\_id__</tt>).
@@ -16,12 +40,12 @@
 #
 class BlankSlate
   class << self
-    
+
     # Hide the method named +name+ in the BlankSlate class.  Don't
     # hide +instance_eval+ or any method beginning with "__".
     def hide(name)
-      if instance_methods.map(&:to_sym).include?(name.to_sym) and
-        name !~ /^(__|instance_eval|object_id)/
+      if instance_methods.include?(name._blankslate_as_name) and
+        name !~ /^(__|instance_eval$)/
         @hidden_methods ||= {}
         @hidden_methods[name.to_sym] = instance_method(name)
         undef_method name
@@ -41,7 +65,7 @@ class BlankSlate
       define_method(name, hidden_method)
     end
   end
-  
+
   instance_methods.each { |m| hide(m) }
 end
 
@@ -106,4 +130,4 @@ class Module
     end
     result
   end
-end
+end

data/test/test_blankslate.rb

@@ -0,0 +1,217 @@
+#!/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 'test/unit'
+require 'test/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
+    11
+  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 < Test::Unit::TestCase
+  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 'test/unit'
+require 'test/preload'
+require 'builder'
+require 'builder/xmlevents'
+
+class TestEvents < Test::Unit::TestCase
+
+  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