json_builder 1.1.2 → 2.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Garrett Bjerkhoel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# JSON Builder
+Rails provides an excellent XML Builder by default to build RSS and ATOM feeds, but nothing to help you build complex and custom JSON data structures. The standard `to_json` works well, but can get very verbose when you need full control of what is generated. JSON Builder hopes to solve that problem.
+
+## Using JSON Builder with Rails
+First, make sure to add the gem to your `Gemfile`.
+
+    gem 'json_builder'
+
+Not required, but if you'd like to run the generated JSON through a prettifier for debugging reasons, just set `config.action_view.pretty_print_json` to `true` in your environment config. It defaults to false for speed.
+
+    Your::Application.configure do
+      config.action_view.pretty_print_json = true
+    end
+
+Second, make sure your controller responds to `json`:
+
+    class PostsController < ApplicationController
+      respond_to :json
+      
+      def index
+        @posts = Post.all
+        respond_with @posts
+      end
+    end
+
+Lastly, create `app/views/posts/index.json.builder` which could look something like:
+    
+    json.posts do
+      json.array! @posts do
+        @posts.each do |user|
+          json.array_item! do
+            render :partial => 'post', :locals => { :json => json, :post => post }
+          end
+        end
+      end
+    end
+
+You will get something like:
+
+    {
+      "posts": [
+        {
+          "id": 1,
+          "name": "Garrett Bjerkhoel",
+          "body": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
+        }, {
+          "id": 2,
+          "name": "John Doe",
+          "body": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
+        }
+      ]
+    }
+
+## Sample Usage
+
+    require 'json_builder'
+    json = JSONBuilder::Generator.new
+
+    json.name "Garrett Bjerkhoel"
+    json.address do
+      json.street "1143 1st Ave"
+      json.street2 "Apt 1"
+      json.city "New York"
+      json.state "NY"
+      json.zip 10065
+    end
+    json.skills do
+      json.ruby true
+      json.asp false
+    end
+    
+    puts json.compile!
+
+## Speed
+JSON Builder is very fast, it's roughly 6 times faster than the core XML Builder based on the [speed benchmark](http://github.com/dewski/json_builder/blob/master/test/benchmarks/speed.rb).
+
+                            user       system     total     real
+    JSON Builder            0.700000   0.030000   0.730000  (0.724748)
+    JSON Builder Pretty     1.080000   0.060000   1.140000  (1.149416)
+    XML Builder             4.700000   0.110000   4.810000  (4.822932)
+
+## Examples
+See the [examples](http://github.com/dewski/json_builder/tree/master/examples) directory.
+
+## Copyright
+Copyright © 2010 Garrett Bjerkhoel. See [MIT-LICENSE](http://github.com/dewski/json_builder/blob/master/MIT-LICENSE) for details.

data/lib/blankslate.rb

@@ -16,7 +16,7 @@
 #
 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)
@@ -41,7 +41,7 @@ class BlankSlate
       define_method(name, hidden_method)
     end
   end
-  
+
   instance_methods.each { |m| hide(m) }
 end
 
@@ -106,4 +106,4 @@ class Module
     end
     result
   end
-end
+end

data/lib/json_builder.rb

@@ -1,7 +1,6 @@
-require 'json_builder/jsonmarkup'
-require 'json_builder/jsonevents'
+require 'json_builder/version'
+require 'json_builder/generator'
 
-unless defined?(Rails)
-  require 'rubygems'
-  require 'json'
-end
+if defined? Rails
+  require 'json_builder/template'
+end

data/lib/json_builder/generator.rb

@@ -0,0 +1,105 @@
+require 'rubygems'
+require 'blankslate' unless defined?(BlankSlate)
+require 'json'
+
+module JSONBuilder
+  class Generator < BlankSlate
+    def initialize(options=nil)
+      @pretty_print ||= options.delete(:pretty) if !options.nil? && options[:pretty] # don't want nil
+      @compiled = []
+      @indent = 0
+      @passed_items = 0
+      @indent_next = false
+      @is_array = false
+    end
+
+    def inspect
+      compile!
+    end
+
+    def tag!(sym, *args, &block)
+      method_missing(sym.to_sym, *args, &block)
+    end
+
+    def array!(set, &block)
+      @array_length = set.length if set.is_a?(Array)
+      @is_array = true
+      method_missing(nil, nil, &block)
+    end
+
+    def array_item!(&block)
+      method_missing(nil, nil, &block)
+
+      @passed_items += 1
+      @compiled << '},{' if @passed_items < @array_length
+    end
+
+    def method_missing(sym, *args, &block)
+      text = type_cast(args.first)
+
+      if block
+        start_block(sym) unless sym.nil?
+        block.call(self)
+        end_block unless sym.nil?
+      else
+        if @indent_next
+          @compiled[@compiled.length-1] = @compiled.last + "\"#{sym}\":#{text}"
+          @indent_next = false
+        else
+          @compiled << "\"#{sym}\":#{text}"
+        end
+      end
+    end
+
+    def compile!
+      if @is_array
+        compiled = ('[{' + @compiled.join(',') + '}]').gsub(',},{,', '},{')
+      else
+        compiled = '{' + @compiled.join(', ') + '}'
+      end
+
+      if @pretty_print
+        JSON.pretty_generate(JSON[compiled])
+      else
+        compiled
+      end
+    end
+
+    # Since most methods here are public facing,
+    private
+      def type_cast(text)
+        case text
+          when Array then '['+ text.map! { |j| type_cast(j) }.join(', ') +']'
+          when Hash then 'teheh'
+          when String then "\"#{text}\""
+          when TrueClass then 'true'
+          when FalseClass then 'false'
+          when NilClass then 'null'
+          when DateTime, Time, Date then "\"#{text.strftime("%Y-%m-%dT%H:%M:%S")}\""
+          when Fixnum then text
+        end
+      end
+
+      def start_indent
+        @indent += 1
+      end
+
+      def end_indent
+        @indent -= 1
+      end
+
+      def start_block(sym)
+        start_indent
+        @indent_next = true
+        @compiled << "\"#{sym}\":{"
+      end
+
+      def end_block
+        if @indent > 0
+          @compiled[@compiled.length-1] = @compiled.last + '}'
+        else
+          @compiled << '}'
+        end
+      end
+    end
+end

data/lib/json_builder/template.rb

@@ -0,0 +1,27 @@
+require 'action_view/base'
+require 'action_view/template'
+
+module ActionView #:nodoc:
+  class Base
+    cattr_accessor :pretty_print_json
+    @@pretty_print_json = false
+  end
+end
+
+module ActionView
+  module Template::Handlers
+    class JSONBuilder < Template::Handler
+      include Compilable
+
+      self.default_format = Mime::JSON
+
+      def compile(template)
+        "json = ::JSONBuilder::Generator.new(:pretty => #{ActionView::Base.pretty_print_json});" +
+          template.source +
+        ";json.compile!;"
+      end
+    end
+  end
+end
+
+ActionView::Template.register_template_handler :'json.builder', ActionView::Template::Handlers::JSONBuilder

data/lib/json_builder/version.rb

@@ -0,0 +1,3 @@
+module JSONBuilder
+  VERSION = '2.0.0'
+end

data/test/benchmarks/speed.rb

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'benchmark'
+require 'builder'
+require 'json_builder'
+
+Benchmark.bm do |b|
+  b.report('JSON') do
+    15000.times {
+      j = JSONBuilder::Generator.new
+      j.name "Garrett Bjerkhoel"
+      j.birthday Time.local(1991, 9, 14)
+      j.street do
+        j.address "1143 1st Ave"
+        j.address2 "Apt 200"
+        j.city "New York"
+        j.state "New York"
+        j.zip 10065
+      end
+      j.skills do
+        j.ruby true
+        j.asp false
+        j.php true
+        j.mysql true
+        j.mongodb true
+        j.haproxy true
+        j.marathon false
+      end
+      j.single_skills ['ruby', 'php', 'mysql', 'mongodb', 'haproxy']
+      j.booleans [true, true, false, nil]
+      j.compile!
+    }
+  end
+  b.report('JSON Pretty') do
+    15000.times {
+      j = JSONBuilder::Generator.new(:pretty => true)
+      j.name "Garrett Bjerkhoel"
+      j.birthday Time.local(1991, 9, 14)
+      j.street do
+        j.address "1143 1st Ave"
+        j.address2 "Apt 200"
+        j.city "New York"
+        j.state "New York"
+        j.zip 10065
+      end
+      j.skills do
+        j.ruby true
+        j.asp false
+        j.php true
+        j.mysql true
+        j.mongodb true
+        j.haproxy true
+        j.marathon false
+      end
+      j.single_skills ['ruby', 'php', 'mysql', 'mongodb', 'haproxy']
+      j.booleans [true, true, false, nil]
+      j.compile!
+    }
+  end
+  b.report('Builder') do
+    15000.times {
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      xml.name "Garrett Bjerkhoel"
+      xml.birthday Time.local(1991, 9, 14)
+      xml.street do
+        xml.address "1143 1st Ave"
+        xml.address2 "Apt 200"
+        xml.city "New York"
+        xml.state "New York"
+        xml.zip 10065
+      end
+      xml.skills do
+        xml.ruby true
+        xml.asp false
+        xml.php true
+        xml.mysql true
+        xml.mongodb true
+        xml.haproxy true
+        xml.marathon false
+      end
+      xml.single_skills ['ruby', 'php', 'mysql', 'mongodb', 'haproxy']
+      xml.booleans [true, true, false, nil]
+      xml.target!
+    }
+  end
+end

data/test/fixtures/simple.rb

@@ -0,0 +1,28 @@
+require 'json_builder'
+j = JSONBuilder::Generator.new
+
+j.name "Garrett Bjerkhoel"
+j.birthday Time.local(1991, 9, 14)
+j.street do
+  j.address "1143 1st Ave"
+  j.address2 "Apt 200"
+  j.city "New York"
+  j.state "New York"
+  j.zip 10065
+end
+j.hashed {
+  :my_name => "Garrett Bjerkhoel".split('')
+}
+j.skills do
+  j.ruby true
+  j.asp false
+  j.php true
+  j.mysql true
+  j.mongodb true
+  j.haproxy true
+  j.marathon false
+end
+j.single_skills ['ruby', 'php', 'mysql', 'mongodb', 'haproxy']
+j.booleans [true, true, false, nil]
+
+puts j.compile!

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+ROOT = File.join(File.dirname(__FILE__), '..')
+$:.unshift File.join(ROOT, 'lib')
+$:.unshift File.join(ROOT, 'lib', 'json_builder')
+require 'json_builder'

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: json_builder
 version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: false
   segments: 
-  - 1
-  - 1
   - 2
-  version: 1.1.2
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Garrett Bjerkhoel
@@ -14,71 +15,110 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-25 00:00:00 -04:00
+date: 2010-08-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
-        - 1
-        - 4
         - 3
-        version: 1.4.3
+        - 0
+        - 0
+        version: 3.0.0
   type: :runtime
   version_requirements: *id001
-description: JSON Builder
-email: garrett@clientend.com
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: JSON Builder for Rails
+email: me@garrettbjerkhoel.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.md
 files: 
+- MIT-LICENSE
+- README.md
 - lib/blankslate.rb
-- lib/json_builder/blankslate.rb
-- lib/json_builder/jsonbase.rb
-- lib/json_builder/jsonevents.rb
-- lib/json_builder/jsonmarkup.rb
-- lib/json_builder/xchar.rb
 - lib/json_builder.rb
-- lib/test.rb
+- lib/json_builder/generator.rb
+- lib/json_builder/template.rb
+- lib/json_builder/version.rb
+- test/benchmarks/speed.rb
+- test/fixtures/simple.rb
+- test/test_helper.rb
 has_rdoc: true
-homepage: http://www.clientend.com
+homepage: http://github.com/dewski/json_builder
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
-      - 1
-      - 8
-      - 7
-      version: 1.8.7
+      - 0
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
-requirements: 
-- none
+requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A JSON Builder for Rails
-test_files: []
-
+summary: JSON Builder
+test_files: 
+- test/benchmarks/speed.rb
+- test/fixtures/simple.rb
+- test/test_helper.rb

data/lib/json_builder/blankslate.rb

@@ -1,22 +0,0 @@
-#!/usr/bin/env ruby
-#--
-# Copyright 2004, 2006 by Jim Weirich (jim@weirichhouse.org).
-# 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 'blankslate'
-
-######################################################################
-# BlankSlate has been promoted to a top level name and is now
-# available as a standalone gem.  We make the name available in the
-# Builder namespace for compatibility.
-#
-unless defined?(Builder)
-  module JsonBuilder
-    BlankSlate = ::BlankSlate
-  end
-end

data/lib/json_builder/jsonbase.rb

@@ -1,131 +0,0 @@
-require 'json_builder/blankslate'
-
-module JsonBuilder
-
-  # Generic error for builder
-  class IllegalBlockError < RuntimeError; end
-
-  # JsonBase is a base class for building XML builders.  See
-  # JsonBuilder::JsonMarkup and JsonBuilder::JsonEvents for examples.
-  class JsonBase < BlankSlate
-
-    # 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.
-    def initialize(encoding='utf-8')
-      @encoding = encoding.downcase
-    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>.
-    def tag!(sym, *args, &block)
-      method_missing(sym.to_sym, args, &block)
-    end
-
-    # Create XML markup based on the name of the method.  This method
-    # is never invoked directly, but is called for each markup method
-    # in the markup block.
-    def method_missing(sym, *args, &block)
-      text = nil
-      sym = "#{sym}:#{args.shift}" if args.first.kind_of?(Symbol)
-      
-      @target = '{' if @target.length == 0
-      @target.chop! if @target.last == '}'
-      
-      args.each do |arg|
-        case arg
-        when Hash
-          attrs ||= {}
-          attrs.merge!(arg)
-        else
-          text = arg
-        end
-      end
-      
-      if block
-        raise ArgumentError, "JsonMarkup cannot mix a text argument with a block" unless text.nil?
-        
-        _start_tag(sym)
-        block.call(self)
-        _end_tag
-      elsif text.nil?
-        _start_tag(sym)
-      else
-        _start_attr(sym)
-        text! text
-        _end_tag
-      end
-      
-      @target
-    end
-
-    # Append text to the output target.  Escape any markup.  May be
-    # used within the markup brackets as:
-    #
-    #   builder.p { |b| b.br; b.text! "HI" }   #=>  <p><br/>HI</p>
-    def text!(text)
-      value = case text
-        when TrueClass then 'true'
-        when FalseClass then 'false'
-        when NilClass then 'undefined'
-        when Float then text.to_s
-        when Fixnum then text.to_s
-        else "\"#{_escape(text)}\""
-      end
-      
-      _text(value)
-    end
-    
-    # Append text to the output target without escaping any markup.
-    # May be used within the markup brackets as:
-    #
-    #   builder.p { |x| x << "<br/>HI" }   #=>  <p><br/>HI</p>
-    #
-    # This is useful when using non-builder enabled software that
-    # generates strings.  Just insert the string directly into the
-    # builder without changing the inserted markup.
-    #
-    # It is also useful for stacking builder objects.  Builders only
-    # use <tt><<</tt> to append to the target, so by supporting this
-    # method/operation builders can use other builders as their
-    # targets.
-    def <<(text)
-      _text(text)
-    end
-    
-    # For some reason, nil? is sent to the JsonMarkup object.  If nil?
-    # is not defined and method_missing is invoked, some strange kind
-    # of recursion happens.  Since nil? won't ever be an XML tag, it
-    # is pretty safe to define it here. (Note: this is an example of
-    # cargo cult programming,
-    # cf. http://fishbowl.pastiche.org/2004/10/13/cargo_cult_programming).
-    def nil?
-      false
-    end
-
-    private
-    
-    require 'json_builder/xchar'
-    def _escape(text)
-      text.to_xs((@encoding != 'utf-8' or $KCODE != 'UTF8'))
-    rescue NoMethodError
-      text
-    end
-
-    def _escape_quote(text)
-      _escape(text).gsub(%r{"}, '&quot;')  # " WART
-    end
-
-    def _newline
-      text! "\n"
-    end
-  end
-end

data/lib/json_builder/jsonevents.rb

@@ -1,52 +0,0 @@
-require 'json_builder/jsonmarkup'
-
-module JsonBuilder
-
-  # Create a series of SAX-like XML events (e.g. start_tag, end_tag)
-  # from the markup code.  XmlEvent objects are used in a way similar
-  # to JsonMarkup objects, except that a series of events are generated
-  # and passed to a handler rather than generating character-based
-  # markup.
-  #
-  # Usage:
-  #   xe = JsonBuilder::JsonEvents.new(hander)
-  #   xe.title("HI")    # Sends start_tag/end_tag/text messages to the handler.
-  #
-  # Indentation may also be selected by providing value for the
-  # indentation size and initial indentation level.
-  #
-  #   xe = JsonBuilder::JsonEvents.new(handler, indent_size, initial_indent_level)
-  #
-  # == XML Event Handler
-  #
-  # The handler object must expect the following events.
-  #
-  # [<tt>start_tag(tag, attrs)</tt>]
-  #     Announces that a new tag has been found.  +tag+ is the name of
-  #     the tag and +attrs+ is a hash of attributes for the tag.
-  #
-  # [<tt>end_tag(tag)</tt>]
-  #     Announces that an end tag for +tag+ has been found.
-  #
-  # [<tt>text(text)</tt>]
-  #     Announces that a string of characters (+text+) has been found.
-  #     A series of characters may be broken up into more than one
-  #     +text+ call, so the client cannot assume that a single
-  #     callback contains all the text data.
-  #
-  class JsonEvents < JsonMarkup
-    def text!(text)
-      @target.text(text)
-    end
-
-    def _start_tag(sym, attrs)
-      @target.start_tag(sym, attrs)
-      _end_tag
-    end
-
-    def _end_tag
-      @target.end_tag
-    end
-  end
-
-end

data/lib/json_builder/jsonmarkup.rb

@@ -1,229 +0,0 @@
-require 'json_builder/jsonbase'
-
-module JsonBuilder
-
-  # Create XML markup easily.  All (well, almost all) methods sent to
-  # an JsonMarkup object will be translated to the equivalent XML
-  # markup.  Any method with a block will be treated as an XML markup
-  # tag with nested markup in the block.
-  #
-  # Examples will demonstrate this easier than words.  In the
-  # following, +xm+ is an +JsonMarkup+ object.
-  #
-  #   xm.em("emphasized")            # => <em>emphasized</em>
-  #   xm.em { xm.b("emp & bold") }   # => <em><b>emph &amp; bold</b></em>
-  #   xm.a("A Link", "href"=>"http://onestepback.org")
-  #                                  # => <a href="http://onestepback.org">A Link</a>
-  #   xm.div { xm.br }               # => <div><br/></div>
-  #   xm.target("name"=>"compile", "option"=>"fast")
-  #                                  # => <target option="fast" name="compile"\>
-  #                                  # NOTE: order of attributes is not specified.
-  #
-  #   xm.instruct!                   # <?xml version="1.0" encoding="UTF-8"?>
-  #   xm.html {                      # <html>
-  #     xm.head {                    #   <head>
-  #       xm.title("History")        #     <title>History</title>
-  #     }                            #   </head>
-  #     xm.body {                    #   <body>
-  #       xm.comment! "HI"           #     <!-- HI -->
-  #       xm.h1("Header")            #     <h1>Header</h1>
-  #       xm.p("paragraph")          #     <p>paragraph</p>
-  #     }                            #   </body>
-  #   }                              # </html>
-  #
-  # == Notes:
-  #
-  # * The order that attributes are inserted in markup tags is
-  #   undefined. 
-  #
-  # * Sometimes you wish to insert text without enclosing tags.  Use
-  #   the <tt>text!</tt> method to accomplish this.
-  #
-  #   Example:
-  #
-  #     xm.div {                          # <div>
-  #       xm.text! "line"; xm.br          #   line<br/>
-  #       xm.text! "another line"; xmbr   #    another line<br/>
-  #     }                                 # </div>
-  #
-  # * The special XML characters <, >, and & are converted to &lt;,
-  #   &gt; and &amp; automatically.  Use the <tt><<</tt> operation to
-  #   insert text without modification.
-  #
-  # * Sometimes tags use special characters not allowed in ruby
-  #   identifiers.  Use the <tt>tag!</tt> method to handle these
-  #   cases.
-  #
-  #   Example:
-  #
-  #     xml.tag!("SOAP:Envelope") { ... }
-  #
-  #   will produce ...
-  #
-  #     <SOAP:Envelope> ... </SOAP:Envelope>"
-  #
-  #   <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
-  #   show this than describe it.
-  #
-  #     xml.SOAP :Envelope do ... end
-  #
-  #   Just put a space before the colon in a namespace to produce the
-  #   right form for builder (e.g. "<tt>SOAP:Envelope</tt>" =>
-  #   "<tt>xml.SOAP :Envelope</tt>")
-  #
-  # * JsonMarkup builds the markup in any object (called a _target_)
-  #   that accepts the <tt><<</tt> method.  If no target is given,
-  #   then JsonMarkup defaults to a string target.
-  # 
-  #   Examples:
-  #
-  #     xm = JsonBuilder::JsonMarkup.new
-  #     result = xm.title("yada")
-  #     # result is a string containing the markup.
-  #
-  #     buffer = ""
-  #     xm = JsonBuilder::JsonMarkup.new(buffer)
-  #     # The markup is appended to buffer (using <<)
-  #
-  #     xm = JsonBuilder::JsonMarkup.new(STDOUT)
-  #     # The markup is written to STDOUT (using <<)
-  #
-  #     xm = JsonBuilder::JsonMarkup.new
-  #     x2 = JsonBuilder::JsonMarkup.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.
-  #
-  #   Example:
-  #
-  #     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.
-  #
-  #     builder = JsonBuilder::JsonMarkup.new(:target=>$stdout, :indent=>2)
-  #     builder.name { |b| b.first("Jim"); b.last("Weirich) }
-  #     # prints:
-  #     #     <name>
-  #     #       <first>Jim</first>
-  #     #       <last>Weirich</last>
-  #     #     </name>
-  #
-  # * The instance_eval implementation which forces self to refer to
-  #   the message receiver as self is now obsolete.  We now use normal
-  #   block calls to execute the markup block.  This means that all
-  #   markup methods must now be explicitly send to the xml builder.
-  #   For instance, instead of
-  #
-  #      xml.div { strong("text") }
-  #
-  #   you need to write:
-  #
-  #      xml.div { xml.strong("text") }
-  #
-  #   Although more verbose, the subtle change in semantics within the
-  #   block was found to be prone to error.  To make this change a
-  #   little less cumbersome, the markup block now gets the markup
-  #   object sent as an argument, allowing you to use a shorter alias
-  #   within the block.
-  #
-  #   For example:
-  #
-  #     xml_builder = JsonBuilder::JsonMarkup.new
-  #     xml_builder.div { |xml|
-  #       xml.stong("text")
-  #     }
-  #
-  class JsonMarkup < JsonBase
-
-    # Create an XML markup builder.  Parameters are specified by an
-    # option hash.
-    #
-    # :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>::
-    #    Number of spaces used for indentation.  The default is no
-    #    indentation and no line breaks.
-    #    
-    # :margin=><em>initial_indentation_level</em>::
-    #    Amount of initial indentation (specified in levels, not
-    #    spaces).
-    #    
-    # :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={})
-      super()
-      @target = options[:target] || ''
-    end
-    
-    # Return the target of the builder.
-    def target!
-      @target.gsub!(/,(\}|\}+)$/, '\1')
-    end
-
-    private
-
-    # NOTE: All private methods of a builder object are prefixed when
-    # a "_" character to avoid possible conflict with XML tag names.
-
-    # Insert text directly in to the builder's target.
-    def _text(text)
-      @target << "#{text},"
-    end
-
-    # Start an JSON object.  If <tt>end_too</tt> is true, then the start
-    # tag is also the end tag (e.g.  <br/>
-    def _start_tag(sym)
-      case @target.last
-        when ['}',','] then @target << '{'
-      end
-      
-      @target << "\"#{sym}\":{"
-    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_attr(sym)
-      @target << "\"#{sym}\":"
-    end
-    
-    # Insert an ending tag.
-    def _end_tag
-      @target << '}'
-    end
-
-    def _ensure_no_block(got_block)
-      if got_block
-        fail IllegalBlockError,
-        "Blocks are not allowed on JSON instructions"
-      end
-    end
-
-  end
-
-end
-
-class String    
-  def last
-    self.split('')[self.length-1]
-  end
-end

data/lib/json_builder/xchar.rb

@@ -1,105 +0,0 @@
-#!/usr/bin/env ruby
-
-# The XChar library is provided courtesy of Sam Ruby (See
-# http://intertwingly.net/stories/2005/09/28/xchar.rb)
-
-# --------------------------------------------------------------------
-
-# If the JsonBuilder::XChar module is not currently defined, fail on any
-# name clashes in standard library classes.
-
-######################################################################
-module JsonBuilder
-
-  ####################################################################
-  # XML Character converter, from Sam Ruby:
-  # (see http://intertwingly.net/stories/2005/09/28/xchar.rb). 
-  #
-  module XChar # :nodoc:
-
-    # See
-    # http://intertwingly.net/stories/2004/04/14/i18n.html#CleaningWindows
-    # for details.
-    CP1252 = {			# :nodoc:
-      128 => 8364,		# euro sign
-      130 => 8218,		# single low-9 quotation mark
-      131 =>  402,		# latin small letter f with hook
-      132 => 8222,		# double low-9 quotation mark
-      133 => 8230,		# horizontal ellipsis
-      134 => 8224,		# dagger
-      135 => 8225,		# double dagger
-      136 =>  710,		# modifier letter circumflex accent
-      137 => 8240,		# per mille sign
-      138 =>  352,		# latin capital letter s with caron
-      139 => 8249,		# single left-pointing angle quotation mark
-      140 =>  338,		# latin capital ligature oe
-      142 =>  381,		# latin capital letter z with caron
-      145 => 8216,		# left single quotation mark
-      146 => 8217,		# right single quotation mark
-      147 => 8220,		# left double quotation mark
-      148 => 8221,		# right double quotation mark
-      149 => 8226,		# bullet
-      150 => 8211,		# en dash
-      151 => 8212,		# em dash
-      152 =>  732,		# small tilde
-      153 => 8482,		# trade mark sign
-      154 =>  353,		# latin small letter s with caron
-      155 => 8250,		# single right-pointing angle quotation mark
-      156 =>  339,		# latin small ligature oe
-      158 =>  382,		# latin small letter z with caron
-      159 =>  376,		# latin capital letter y with diaeresis
-    }
-
-    # See http://www.w3.org/TR/REC-xml/#dt-chardata for details.
-    PREDEFINED = {
-      38 => '&',		# ampersand
-      60 => '<',		# left angle bracket
-      62 => '>',		# right angle bracket
-    }
-
-    # See http://www.w3.org/TR/REC-xml/#charsets for details.
-    VALID = [
-      0x9, 0xA, 0xD,
-      (0x20..0xD7FF), 
-      (0xE000..0xFFFD),
-      (0x10000..0x10FFFF)
-    ]
-  end
-
-end
-
-
-######################################################################
-# Enhance the Fixnum class with a XML escaped character conversion.
-#
-class Fixnum
-  XChar = JsonBuilder::XChar if !defined?(XChar)
-
-  # XML escaped version of chr. When <tt>escape</tt> is set to false
-  # the CP1252 fix is still applied but utf-8 characters are not
-  # converted to character entities.
-  def xchr(escape=true)
-    n = XChar::CP1252[self] || self
-    case n when *XChar::VALID
-      XChar::PREDEFINED[n] or (n<128 ? n.chr : (escape ? "&##{n};" : [n].pack('U*')))
-    else
-      '*'
-    end
-  end
-end
-
-
-######################################################################
-# Enhance the String class with a XML escaped character version of
-# to_s.
-#
-class String
-  # XML escaped version of to_s. When <tt>escape</tt> is set to false
-  # the CP1252 fix is still applied but utf-8 characters are not
-  # converted to character entities.
-  def to_xs(escape=true)
-    unpack('U*').map {|n| n.xchr(escape)}.join # ASCII, UTF-8
-  rescue
-    unpack('C*').map {|n| n.xchr}.join # ISO-8859-1, WIN-1252
-  end
-end

data/lib/test.rb

@@ -1,35 +0,0 @@
-require 'rubygems'
-require 'json_builder'
-@json = JsonBuilder::JsonMarkup.new
-string = @json.user do
-   @json.name "Garrett"
-   @json.email "xhtmlthis@me.com"
-   @json.avatar do
-      @json.url "http://url.com"
-      @json.sizes do
-        @json.bool true
-        @json.sizes 123123123123
-        @json.floats 13.37
-        @json.small "small"
-        @json.tiny "tiny"
-        @json.large "large"
-      end
-   end
-end
-
-puts string
-
-@json2 = JsonBuilder::JsonMarkup.new
-@json2.id 1
-@json2.name "Client End"
-@json2.slug "client-end"
-@json2.subdomain "clientend"
-@json2.hosted_domain "127.0.0.1"
-@json2.clients_count 15
-@json2.total_file_size 13123123
-@json2.last_billed_on Time.now.getutc.iso8601
-@json2.logo_url "http://google.com/logo.gif"
-@json2.created_at Time.now.getutc.iso8601
-@json2.updated_at Time.now.getutc.iso8601
-
-puts @json2.target!