builder 3.1.4 → 3.2.4

data/lib/blankslate.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #--
 # Copyright 2004, 2006 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.

data/lib/builder.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 #--
 # Copyright 2004 by Jim Weirich (jim@weirichhouse.org).

data/lib/builder/blankslate.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #--
 # Copyright 2004, 2006 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.

data/lib/builder/version.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module Builder
   VERSION_NUMBERS = [
     VERSION_MAJOR = 3,
-    VERSION_MINOR = 1,
+    VERSION_MINOR = 2,
     VERSION_BUILD = 4,
   ]
   VERSION = VERSION_NUMBERS.join(".")

data/lib/builder/xchar.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # The XChar library is provided courtesy of Sam Ruby (See
 # http://intertwingly.net/stories/2005/09/28/xchar.rb)
@@ -19,7 +20,7 @@ end
 
 if ! defined?(Builder::XChar) and ! String.method_defined?(:encode)
   Builder.check_for_name_collision(String, "to_xs")
-  Builder.check_for_name_collision(Fixnum, "xchr")
+  Builder.check_for_name_collision(Integer, "xchr")
 end
 
 ######################################################################
@@ -108,7 +109,7 @@ if String.method_defined?(:encode)
       INVALID_XML_CHAR = Regexp.new('[^'+
         Builder::XChar::VALID.map { |item|
           case item
-          when Fixnum
+          when Integer
             [item].pack('U').force_encoding('utf-8')
           when Range
             [item.first, '-'.ord, item.last].pack('UUU').force_encoding('utf-8')
@@ -160,9 +161,9 @@ if String.method_defined?(:encode)
 else
 
   ######################################################################
-  # Enhance the Fixnum class with a XML escaped character conversion.
+  # Enhance the Integer class with a XML escaped character conversion.
   #
-  class Fixnum
+  class Integer
     XChar = Builder::XChar if ! defined?(XChar)
   
     # XML escaped version of chr. When <tt>escape</tt> is set to false

data/lib/builder/xmlbase.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'builder/blankslate'
 
@@ -17,20 +18,24 @@ module Builder
 
     # Create an XML markup builder.
     #
-    # out::      Object receiving the markup.  +out+ must respond to
-    #            <tt><<</tt>.
-    # indent::   Number of spaces used for indentation (0 implies no
-    #            indentation and no line breaks).
-    # initial::  Level of initial indentation.
-    # encoding:: When <tt>encoding</tt> and $KCODE are set to 'utf-8'
-    #            characters aren't converted to character entities in
-    #            the output stream.
+    # out      :: Object receiving the markup.  +out+ must respond to
+    #             <tt><<</tt>.
+    # indent   :: Number of spaces used for indentation (0 implies no
+    #             indentation and no line breaks).
+    # initial  :: Level of initial indentation.
+    # encoding :: When <tt>encoding</tt> and $KCODE are set to 'utf-8'
+    #             characters aren't converted to character entities in
+    #             the output stream.
     def initialize(indent=0, initial=0, encoding='utf-8')
       @indent = indent
       @level  = initial
       @encoding = encoding.downcase
     end
 
+    def explicit_nil_handling?
+      @explicit_nil_handling
+    end
+
     # Create a tag named +sym+.  Other than the first argument which
     # is the tag name, the arguments are the same as the tags
     # implemented via <tt>method_missing</tt>.
@@ -45,9 +50,10 @@ module Builder
           attrs ||= {}
           attrs.merge!(arg)
         when nil
-          # do nothing
+          attrs ||= {}
+          attrs.merge!({:nil => true}) if explicit_nil_handling?
         else
-          text ||= ''
+          text ||= ''.dup
           text << arg.to_s
         end
       end
@@ -180,8 +186,10 @@ module Builder
     # significantly.
     def cache_method_call(sym)
       class << self; self; end.class_eval do
-        define_method(sym) do |*args, &block|
-          tag!(sym, *args, &block)
+        unless method_defined?(sym)
+          define_method(sym) do |*args, &block|
+            tag!(sym, *args, &block)
+          end
         end
       end
     end

data/lib/builder/xmlevents.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 #--
 # Copyright 2004 by Jim Weirich (jim@weirichhouse.org).

data/lib/builder/xmlmarkup.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #--
 # Copyright 2004, 2005 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
@@ -47,7 +48,7 @@ module Builder
   # == Notes:
   #
   # * The order that attributes are inserted in markup tags is
-  #   undefined. 
+  #   undefined.
   #
   # * Sometimes you wish to insert text without enclosing tags.  Use
   #   the <tt>text!</tt> method to accomplish this.
@@ -78,7 +79,7 @@ module Builder
   #   <tt>tag!</tt> will also take text and attribute arguments (after
   #   the tag name) like normal markup methods.  (But see the next
   #   bullet item for a better way to handle XML namespaces).
-  #   
+  #
   # * Direct support for XML namespaces is now available.  If the
   #   first argument to a tag call is a symbol, it will be joined to
   #   the tag to produce a namespace:tag combination.  It is easier to
@@ -93,7 +94,7 @@ module Builder
   # * XmlMarkup builds the markup in any object (called a _target_)
   #   that accepts the <tt><<</tt> method.  If no target is given,
   #   then XmlMarkup defaults to a string target.
-  # 
+  #
   #   Examples:
   #
   #     xm = Builder::XmlMarkup.new
@@ -110,7 +111,7 @@ module Builder
   #     xm = Builder::XmlMarkup.new
   #     x2 = Builder::XmlMarkup.new(:target=>xm)
   #     # Markup written to +x2+ will be send to +xm+.
-  #   
+  #
   # * Indentation is enabled by providing the number of spaces to
   #   indent for each level as a second argument to XmlBuilder.new.
   #   Initial indentation may be specified using a third parameter.
@@ -119,7 +120,7 @@ module Builder
   #
   #     xm = Builder.new(:indent=>2)
   #     # xm will produce nicely formatted and indented XML.
-  #  
+  #
   #     xm = Builder.new(:indent=>2, :margin=>4)
   #     # xm will produce nicely formatted and indented XML with 2
   #     # spaces per indent and an over all indentation level of 4.
@@ -162,34 +163,39 @@ module Builder
     # Create an XML markup builder.  Parameters are specified by an
     # option hash.
     #
-    # :target=><em>target_object</em>::
+    # :target => <em>target_object</em>::
     #    Object receiving the markup.  +target_object+ must respond to
     #    the <tt><<(<em>a_string</em>)</tt> operator and return
     #    itself.  The default target is a plain string target.
-    #    
-    # :indent=><em>indentation</em>::
+    #
+    # :indent => <em>indentation</em>::
     #    Number of spaces used for indentation.  The default is no
     #    indentation and no line breaks.
-    #    
-    # :margin=><em>initial_indentation_level</em>::
+    #
+    # :margin => <em>initial_indentation_level</em>::
     #    Amount of initial indentation (specified in levels, not
     #    spaces).
-    #    
-    # :escape_attrs=><em>OBSOLETE</em>::
+    #
+    # :quote => <em>:single</em>::
+    #    Use single quotes for attributes rather than double quotes.
+    #
+    # :escape_attrs => <em>OBSOLETE</em>::
     #    The :escape_attrs option is no longer supported by builder
     #    (and will be quietly ignored).  String attribute values are
     #    now automatically escaped.  If you need unescaped attribute
     #    values (perhaps you are using entities in the attribute
     #    values), then give the value as a Symbol.  This allows much
     #    finer control over escaping attribute values.
-    #    
+    #
     def initialize(options={})
       indent = options[:indent] || 0
       margin = options[:margin] || 0
+      @quote = (options[:quote] == :single) ? "'" : '"'
+      @explicit_nil_handling = options[:explicit_nil_handling]
       super(indent, margin)
-      @target = options[:target] || ""
+      @target = options[:target] || "".dup
     end
-    
+
     # Return the target of the builder.
     def target!
       @target
@@ -265,7 +271,12 @@ module Builder
       _ensure_no_block ::Kernel::block_given?
       _special("<![CDATA[", "]]>", text.gsub(']]>', ']]]]><![CDATA[>'), nil)
     end
-    
+
+    def cdata_value!(open, text)
+      _ensure_no_block ::Kernel::block_given?
+      _special("<#{open}>", "</#{open}>", "<![CDATA[#{text.gsub(']]>', ']]]]><![CDATA[>')}]]>", nil)
+    end
+
     private
 
     # NOTE: All private methods of a builder object are prefixed when
@@ -275,8 +286,8 @@ module Builder
     def _text(text)
       @target << text
     end
-    
-    # Insert special instruction. 
+
+    # Insert special instruction.
     def _special(open, close, data=nil, attrs=nil, order=[])
       _indent
       @target << open
@@ -294,7 +305,7 @@ module Builder
       @target << "/" if end_too
       @target << ">"
     end
-    
+
     # Insert an ending tag.
     def _end_tag(sym)
       @target << "</#{sym}>"
@@ -305,10 +316,10 @@ module Builder
       return if attrs.nil?
       order.each do |k|
         v = attrs[k]
-        @target << %{ #{k}="#{_attr_value(v)}"} if v # " WART
+        @target << %{ #{k}=#{@quote}#{_attr_value(v)}#{@quote}} if v
       end
       attrs.each do |k, v|
-        @target << %{ #{k}="#{_attr_value(v)}"} unless order.member?(k) # " WART
+        @target << %{ #{k}=#{@quote}#{_attr_value(v)}#{@quote}} unless order.member?(k) # " WART
       end
     end
 

data/rakelib/publish.rake

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+# 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,63 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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,8 @@
+# frozen_string_literal: true
+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,13 @@
+# frozen_string_literal: true
+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

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+# encoding: iso-8859-1
 
 #--
 # Portions copyright 2004 by Jim Weirich (jim@weirichhouse.org).
@@ -13,7 +15,7 @@
 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
+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

data/test/preload.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 #--
 # Portions copyright 2004 by Jim Weirich (jim@weirichhouse.org).

data/test/test_blankslate.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 #--
 # Portions copyright 2004 by Jim Weirich (jim@weirichhouse.org).
@@ -10,8 +11,8 @@
 # above copyright notice is included.
 #++
 
-require 'test/unit'
-require 'test/preload'
+require 'helper'
+require 'preload'
 require 'blankslate'
 require 'stringio'
 
@@ -46,10 +47,6 @@ module Kernel
     1234
   end
 
-  def double_late_addition
-    11
-  end
-
   def double_late_addition
     22
   end
@@ -80,7 +77,7 @@ end
 ######################################################################
 # Test case for blank slate.
 #
-class TestBlankSlate < Test::Unit::TestCase
+class TestBlankSlate < Builder::Test
   def setup
     @bs = BlankSlate.new
   end
@@ -108,12 +105,6 @@ class TestBlankSlate < Test::Unit::TestCase
     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