Remove the claim of 1.9.2 compatibility from guides.

Hi Santiago, it seems I'm not alone http://isitruby19.com/builder, this is a rather weird error likely to be caused by MRI Ruby. I haven't found any other way to get rid of it then use patched builder. I'm experiencing this with both Debian server and OS X desktop with freshly installed RFM and Ruby 1.9.2-p0.

Dusan, can you point us to your fix and give us a link where Jim refuses to fix the issue? Maybe we can convince him over it. Thanks.

I'm not able to reproduce this on OSX/1.9.2-p0 or on Ubuntu8.04/1.9.2-p0. I'm using rvm.

test was the same as Santiago's above.

Dusan, this obviously doesnt mean that this problem doesnt exist, but we need to determine the difference in the environments.

Jose: by refusing, I mean ignoring (http://goo.gl/MQNtV)
Aditya: the difference is that I'm not running my snippet in plain irb, but in Rails console.

Personally, it doesn't make any sense to me, that code in builder is perfectly fine.

Dusan, unless I am missing something, that ticket was opened less than 24h ago. I think that is a little bit too soon to express that he's ignoring it, no?

And people trying to reproduce the error, please try to reproduce the error inside a rails console than just irb. This is because Rails tweaks constant lookups a bit.

You're right, I totally missed the timestamp on that issue, my bad. In fact I don't know how does it behave in plain irb. I've seen this error in Rails logs and Rails console.

Couldn't reproduce this on Rails 3.0.1 with Ruby 1.9.2-p0:

$ rails c
Loading development environment (Rails 3.0.1)
ruby-1.9.2-p0 > require 'builder'
 => nil 
ruby-1.9.2-p0 > xml = Builder::XmlMarkup.new
 => #<Builder::XmlMarkup:0x00000103328b20 @indent=0, @level=0, @target=""> 
ruby-1.9.2-p0 >

I tried again with both 3.0.2 and edge Rails, and I don't see the bug anymore. Putting this into my "Strange Ruby issues resolved without intervention" bucket.

Jim just applied mysterious ::Symbol fix and bumped version to 3.0.0, would it be possible to use this one? Colleague of mine is still experiencing this issue and we couldn't find an explanation for it so far :(

What I've found so far.
Clean Rails 3.0.3 install with Ruby 1.9.2-p0 (using RVM) works fine:

rails c
require 'builder'; Builder::XmlMarkup.new
=> #<Builder::XmlMarkup:0x0000000229fa70 @indent=0, @level=0, @target="">
The problem occurs when you add "amqp" gem to the Gemfile (https://github.com/tmm1/amqp)

.... gem "amqp"
...

bundle install
rails c
require 'builder'; Builder::XmlMarkup.new
NameError: uninitialized constant Builder::XmlBase::Symbol


The problem is caused by this line in xmlbase.rb:

sym = "#{sym}:#{args.shift}" if args.first.kind_of?(Symbol)

which is fixed in Builder 3.0.0.

How do I deal with this problem now:
- add #{myapp}/lib dir to autorequire - clone Builder 3.0.0 from the repository
mkdir #{myapp}/lib/builder
cd #{cloned_builder_dir}/lib/bulder
cp blankslate.rb css.rb xchar.rb xmlbase.rb xmlmarkup.rb #{myapp}/lib/builder


Everything works fine now :)

I've bumped up the builder version

@Dusan,

Can you please list the gems you have in your application? From @valentine's comment above it seems amqp can trigger this problem, but there maybe others too that cause this problem. If we know which ones cause it, it will help those who are currently wondering about the failure relating to builder.

@santiago, we should possibly mark this ticket resolved instead of invalid now that you've updated builder version. ya?

Cheers,
Aditya

Aditya go ahead if you want ;)

I've seen this error when using Rails, the amqp gem and ruby 1.9.2 together. The problem comes from a change in ruby 1.9.x. Basically, builder 2.1.2 and amqp (I guess, among other things) are unusable together. Builder 3.0.x does not have this problem it seems. Unfortunately Rails 3.0.x together with lots of other gems depend on builder 2.1.2.

Please see:
https://github.com/ruby-amqp/amqp/issues/#issue/38
https://github.com/jimweirich/builder/issues/#issue/4

An example of this behavior, this code works:

require 'rubygems'
#require 'mq'
require 'rails'
require 'builder'

builder = Builder::XmlMarkup.new
xml = builder.person { |b| b.name("Jim"); b.phone("555-1234") }
puts xml

this code doesn't:

require 'rubygems'
require 'mq'
require 'rails'
require 'builder'

builder = Builder::XmlMarkup.new
xml = builder.person { |b| b.name("Jim"); b.phone("555-1234") }
puts xml

In Rails master it seems to depend on builder 3.0.0 but in Rails release 3.0.5 (latest) it depends on builder 2.1.2. Don't know why that is.

that seems like waiting for a release should do the trick, although, I've seen this problem, it wen't away after some time, and I don't remember what we did, we now use 3.0.3 with amqp without (builder related) issues

This is what I've done in a monkey-patch - don't even remember exactly what did the trick anymore (been using it on occasion when this problem manifests):

module Builder

  class CSS < BlankSlate

    def id!(arg, &block)
      _start_container('#'+arg.to_s, nil, ::Kernel.block_given?)
      _css_block(block) if block
      _unify_block
      self
    end

    def class!(arg, &block)
      _start_container('.'+arg.to_s, nil, ::Kernel.block_given?)
      _css_block(block) if block
      _unify_block
      self
    end

    def method_missing(sym, *args, &block)
      sym = "#{sym}:#{args.shift}" if args.first.kind_of?(::Symbol)
      if block
        _start_container(sym, args.first)
        _css_block(block)
        _unify_block
      elsif @in_block
        _indent
        _css_line(sym, *args)
        _newline
        return self
      else
        _start_container(sym, args.first, false)
        _unify_block
      end
      self
    end

  end

  class XmlBase < BlankSlate

    def method_missing(sym, *args, &block)
      text = nil
      attrs = nil
      sym = "#{sym}:#{args.shift}" if args.first.kind_of?(::Symbol)
      args.each do |arg|
        case arg
        when ::Hash
          attrs ||= {}
          attrs.merge!(arg)
        else
          text ||= ''
          text << arg.to_s
        end
      end
      if block
        unless text.nil?
          ::Kernel::raise ::ArgumentError,
            "XmlMarkup cannot mix a text argument with a block"
        end
        _indent
        _start_tag(sym, attrs)
        _newline
        begin
          _nested_structures(block)
        ensure
          _indent
          _end_tag(sym)
          _newline
        end
      elsif text.nil?
        _indent
        _start_tag(sym, attrs, true)
        _newline
      else
        _indent
        _start_tag(sym, attrs)
        text! text
        _end_tag(sym)
        _newline
      end
      @target
    end

  end

  class XmlMarkup < XmlBase
      def initialize(options={})
        indent = options[:indent] || 0
        margin = options[:margin] || 0
        super(indent, margin)
        @target = options[:target] || ""
      end

      def target!
        @target
      end

      def comment!(comment_text)
        _ensure_no_block ::Kernel::block_given?
        _special("<!-- ", " -->", comment_text, nil)
      end

      def declare!(inst, *args, &block)
        _indent
        @target << "<!#{inst}"
        args.each do |arg|
          case arg
          when ::String
            @target << %{ "#{arg}"} # " WART
          when ::Symbol
            @target << " #{arg}"
          end
        end
        if ::Kernel::block_given?
          @target << " ["
          _newline
          _nested_structures(block)
          @target << "]"
        end
        @target << ">"
        _newline
      end

      def instruct!(directive_tag=:xml, attrs={})
        _ensure_no_block ::Kernel::block_given?
        if directive_tag == :xml
          a = { :version=>"1.0", :encoding=>"UTF-8" }
          attrs = a.merge attrs
    @encoding = attrs[:encoding].downcase
        end
        _special(
          "<?#{directive_tag}",
          "?>",
          nil,
          attrs,
          [:version, :encoding, :standalone])
      end

      def cdata!(text)
        _ensure_no_block ::Kernel::block_given?
        _special("<![CDATA[", "]]>", text, nil)
      end

      private

      def _text(text)
        @target << text
      end

      # Insert special instruction. 
      def _special(open, close, data=nil, attrs=nil, order=[])
        _indent
        @target << open
        @target << data if data
        _insert_attributes(attrs, order) if attrs
        @target << close
        _newline
      end

      # Start an XML tag.  If <tt>end_too</tt> is true, then the start
      # tag is also the end tag (e.g.  <br/>
      def _start_tag(sym, attrs, end_too=false)
        @target << "<#{sym}"
        _insert_attributes(attrs)
        @target << "/" if end_too
        @target << ">"
      end

      # Insert an ending tag.
      def _end_tag(sym)
        @target << "</#{sym}>"
      end

      # Insert the attributes (given in the hash).
      def _insert_attributes(attrs, order=[])
        return if attrs.nil?
        order.each do |k|
          v = attrs[k]
          @target << %{ #{k}="#{_attr_value(v)}"} if v # " WART
        end
        attrs.each do |k, v|
          @target << %{ #{k}="#{_attr_value(v)}"} unless order.member?(k) # " WART
        end
      end

      def _attr_value(value)
        case value
        when ::Symbol
          value.to_s
        else
          _escape_quote(value.to_s)
        end
      end

      def _ensure_no_block(got_block)
        if got_block
          ::Kernel::raise IllegalBlockError.new(
            "Blocks are not allowed on XML instructions"
          )
        end
      end

    end

end

What we did is in my previous message (copied builder 3 files into /lib/builder).

The incompatibility between builder 2.1.2 and amqp has now been resolved and was actually (it seems) a problem with the amqp gem.

For more info see:
https://github.com/ruby-amqp/amqp/issues/38#comment_890160

(fixed in amqp 0.7.1)