json_builder 3.0.7 → 3.1.0

data/.gitignore

@@ -1,3 +1,5 @@
 pkg/*
+doc/*
 .DS_Store
-*.log
+*.log
+/.rbenv-version

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-head

data/Gemfile

@@ -1,9 +1,10 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gemspec
 
 gem 'rake'
 
 group :test do
-	gem 'i18n'
-end
+  gem 'i18n'
+  gem 'tzinfo'
+end

data/Gemfile.lock

@@ -1,17 +1,19 @@
 PATH
   remote: .
   specs:
-    json_builder (3.0.7)
+    json_builder (3.1.0)
       activesupport (>= 2.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.1.3)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
       multi_json (~> 1.0)
-    i18n (0.5.0)
-    multi_json (1.0.4)
+    i18n (0.6.0)
+    multi_json (1.1.0)
     rake (0.9.2.2)
+    tzinfo (0.3.31)
 
 PLATFORMS
   ruby
@@ -20,3 +22,4 @@ DEPENDENCIES
   i18n
   json_builder!
   rake
+  tzinfo

data/README.md

@@ -8,24 +8,24 @@ Rails provides an excellent XML Builder by default to build RSS and ATOM feeds,
 require 'json_builder'
 
 json = JSONBuilder::Compiler.generate do
-  name "Garrett Bjerkhoel"
-  email "spam@garrettbjerkhoel.com"
+  name 'Garrett Bjerkhoel'
+  email 'spam@garrettbjerkhoel.com'
   url root_path
   address do
-    street "1234 1st Ave"
-    street2 "Apt 1"
-    city "New York"
-    state "NY"
+    street '1234 1st Ave'
+    street2 'Apt 1'
+    city 'New York'
+    state 'NY'
     zip 10065
   end
-  key :nil, "testing a custom key name"
+  key :nil, 'testing a custom key name'
   skills do
     ruby true
     asp false
   end
   longstring do
     # Could be a highly intensive process that only returns a string
-    "12345" * 25
+    '12345' * 25
   end
 end
 ```
@@ -56,7 +56,7 @@ Which will generate:
 If you'd like to just generate an array:
 
 ```ruby
-array ["Garrett Bjerkhoel", "John Doe"] do |name|
+array ['Garrett Bjerkhoel', 'John Doe'] do |name|
   first, last = name.split(' ')
   first first
   last last
@@ -100,13 +100,13 @@ class UsersController < ApplicationController
 end
 ```
 
-Lastly, create `app/views/users/index.json_builder` which could look something like:
+Lastly, create `app/views/users/index.json.json_builder` which could look something like:
     
 ```ruby
 count @users.count
-current_page @users.current_page
+page @users.current_page
 per_page @users.per_page
-num_pages @users.num_pages
+pages_count @users.num_pages
 results @users do |user|
   id user.id
   name user.name
@@ -124,10 +124,10 @@ You will get something like:
 
 ```json
 {
-  "total": 10,
+  "count": 10,
   "page": 1,
   "per_page": 2,
-  "total_pages": 5,
+  "pages_count": 5,
   "results": [
     {
       "id": 1,
@@ -170,7 +170,7 @@ You will get something like:
 
 ### Including JSONP callbacks
 
-Out of the box JSON Builder supports JSONP callbacks when used within a Rails project just by using the callback parameter. For instance, if you requested `/users.json?callback=myjscallback`, you'll get a callback wrapping the response:
+Out of the box JSON Builder supports JSONP callbacks when used within a Rails project just by using the `callback` parameter. For instance, if you requested `/users.json?callback=myjscallback`, you'll get a callback wrapping the response:
 
 ```json
 myjscallback([
@@ -183,25 +183,26 @@ myjscallback([
 ])
 ```
 
-To be able to turn off this functionality, you can do it per-environment, or globally:
+To turn off JSONP callbacks globally or just per-environment:
 
-#### Per Environment
+
+#### Globally
 
 ```ruby
-Spyder::Application.configure do
-  config.action_view.json_callback = false
-end
+ActionView::Base.json_callback = false
 ```
 
-#### Globally
+#### Per Environment
 
 ```ruby
-ActionView::Base.json_callback = false
+Sample::Application.configure do
+  config.action_view.json_callback = false
+end
 ```
 
 ### Pretty Print Output
 
-Out of the box JSON Builder supports pretty printing the JSON for the development environment, the rest have it turned off for performance reasons. If you'd like to enable or disable pretty printing you can do it within your environment file or you can do it globally.
+Out of the box JSON Builder supports pretty printing only during development, it's disabled by default in other environments for performance. If you'd like to enable or disable pretty printing you can do it within your environment file or you can do it globally.
 
 With pretty print on:
 
@@ -221,7 +222,7 @@ Without:
 #### Per Environment
 
 ```ruby
-Spyder::Application.configure do
+Sample::Application.configure do
   config.action_view.pretty_print_json = false
 end
 ```
@@ -239,9 +240,9 @@ JSON Builder is very fast, it's roughly 3.6 times faster than the core XML Build
     JSONBuilder  2.950000   0.010000    2.960000    (2.968790)
         Builder  10.820000  0.040000    10.860000   (10.930497)
 
-## Other JSON Builders
+## Alternative libraries
 
-There are quite a few other alternatives to JSON Builder, each good in their own way with different DSL's and design approaches that are worth checking out:
+There are alternatives to JSON Builder, each good in their own way with different API's and design approaches that are worth checking out. Although, I would love to hear why JSON Builder didn't fit your needs, by [message or issue.
 
  * [jbuilder](https://github.com/rails/jbuilder)
  * [RABL](https://github.com/nesquena/rabl)

data/Rakefile

@@ -17,4 +17,4 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.test_files = FileList['test/*_test.rb']
   t.verbose = true
-end
+end

data/json_builder.gemspec

@@ -16,4 +16,5 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_dependency 'activesupport', '>= 2.0.0'
+  s.add_development_dependency 'tzinfo'
 end

data/lib/json_builder.rb

@@ -5,4 +5,4 @@ require 'json_builder/template' if defined? Rails
 module JSONBuilder
   class InvalidArgument < StandardError; end
   class MissingKeyError < StandardError; end
-end
+end

data/lib/json_builder/extensions.rb

@@ -2,25 +2,25 @@ require 'active_support/all'
 
 class FalseClass
   def to_builder
-    self.inspect
+    'false'
   end
 end
 
 class TrueClass
   def to_builder
-    self.inspect
+    'true'
   end
 end
 
 class String
   def to_builder
-    self.inspect
+    "\"#{self}\""
   end
 end
 
 class Hash
   def to_builder
-    self.to_json
+    to_json
   end
 end
 
@@ -30,28 +30,36 @@ class NilClass
   end
 end
 
+module ActiveSupport
+  class TimeWithZone
+    def to_builder
+      "\"#{iso8601}\""
+    end
+  end
+end
+
 class Time
   def to_builder
-    iso8601.inspect
+    "\"#{iso8601}\""
   end
 end
 
 class Date
   def to_builder
-    to_time.iso8601.inspect
+    "\"#{to_time.iso8601}\""
   end
 end
 
 class DateTime
   def to_builder
-    to_time.iso8601.inspect
+    "\"#{to_time.iso8601}\""
   end
 end
 
 module BSON
   class ObjectId
     def to_builder
-      self.to_s.inspect
+      "\"#{self}\""
     end
   end
 end

data/lib/json_builder/template.rb

@@ -47,7 +47,7 @@ if defined?(Rails) && Rails.version =~ /^3/
 
           %{
             ::JSONBuilder::Compiler.generate(:scope => self, :pretty => ActionView::Base.pretty_print_json, :callback => ActionView::Base.json_callback) {
-              #{template.source}
+              #{source}
             }
           }
         end

data/lib/json_builder/version.rb

@@ -1,3 +1,3 @@
 module JSONBuilder
-  VERSION = '3.0.7'
+  VERSION = '3.1.0'
 end

data/test/compiler_test.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'test_helper'
 require 'active_support/ordered_hash'
 
@@ -11,7 +13,7 @@ class TestCompiler < Test::Unit::TestCase
       def valid?
         true
       end
-      
+
       name 'Garrett Bjerkhoel'
       valid valid?
     end
@@ -22,11 +24,13 @@ class TestCompiler < Test::Unit::TestCase
       date Date.new(2011, 11, 23)
       date_time DateTime.new(2001, 2, 3, 4, 5, 6)
       timed Time.utc(2012)
+      Time.zone = "CET"
+      zoned Time.zone.local(2012)
     end
     # The date will have the local time zone offset, hence the wildcard.
-    assert_match(%r{\{"date": "2011-11-23T00:00:00.*", "date_time": "2001-02-03T04:05:06Z", "timed": "2012-01-01T00:00:00Z"\}}, actual)
+    assert_match(%r{\{"date": "2011-11-23T00:00:00.*", "date_time": "2001-02-03T04:05:06Z", "timed": "2012-01-01T00:00:00Z", "zoned": "2012-01-01T00:00:00\+01:00"\}}, actual)
   end
-  
+
   def test_should_support_all_datatypes
     assert_builder_json('{"integer": 1, "mega_integer": 100000000, "float": 13.37, "true_class": true, "false_class": false, "missing_nil": null}') do
       integer 1
@@ -37,7 +41,7 @@ class TestCompiler < Test::Unit::TestCase
       missing_nil
     end
   end
-  
+
   def test_should_support_multiple_nestings
     assert_builder_json('{"u": [{"id": 1, "l": [{"l": 1, "d": "t"}, {"l": 2, "d": "tt"}]}, {"id": 2, "l": [{"l": 2, "d": "t"}, {"l": 4, "d": "tt"}]}]}') do
       u [1, 2] do |i|
@@ -51,13 +55,13 @@ class TestCompiler < Test::Unit::TestCase
       end
     end
   end
-  
+
   def test_support_custom_key_names
     assert_builder_json('{"custom_key": 1, "with_method": "nope", "as_string": true, "nested": {"deep_down": -1, "custom": true}, "nope": "chuck"}') do
       def with_method
         "nope"
       end
-      
+
       key :custom_key, 1
       key :with_method, with_method
       key 'as_string', true
@@ -65,14 +69,14 @@ class TestCompiler < Test::Unit::TestCase
         def custom
           'custom'
         end
-        
+
         key 'deep_down', -1
         key custom, true
       end
       key with_method, 'chuck'
     end
   end
-  
+
   def test_support_custom_classes
     assert_builder_json('{"hello": "olleh"}') do
       hello Dozer.new('hello')
@@ -84,4 +88,10 @@ class TestCompiler < Test::Unit::TestCase
       hash_test :garrett => true
     end
   end
+
+  def test_adding_unicoded_key
+    assert_builder_json('{"é": "json"}') do
+      key 'é', 'json'
+    end
+  end
 end

data/test/elements_test.rb

@@ -4,18 +4,18 @@ class TestElements < Test::Unit::TestCase
   def assert_elements_equal(value, array)
     assert_equal value, JSONBuilder::Elements.new(nil, array).to_s
   end
-  
+
   def test_array_hash
     assert_elements_equal '[{"woot":true}]', [{ :woot => true }]
   end
-  
+
   def test_custom_class_objects
     assert_elements_equal '["olleh", "eybdoog"]', [Dozer.new('hello'), Dozer.new('goodbye')]
   end
-  
+
   def test_raises_invalid_argument
     assert_raises(JSONBuilder::InvalidArgument) {
       JSONBuilder::Elements.new(nil, false).to_s
     }
   end
-end
+end

data/test/extensions_test.rb

@@ -4,44 +4,48 @@ class TestExtensions < Test::Unit::TestCase
   def test_string_respond_to
     assert_respond_to 'json_builder', :to_builder
   end
-  
+
   def test_ordered_hash
     assert_respond_to ActiveSupport::OrderedHash.new(:json_builder => true), :to_builder
   end
-  
+
   def test_true_value
     assert_respond_to true, :to_builder
   end
-  
+
   def test_false_value
     assert_respond_to false, :to_builder
   end
-  
+
   def test_hash_value
     assert_respond_to({ :json_builder => true }, :to_builder)
   end
-  
+
   def test_nil_value
     assert_respond_to nil, :to_builder
   end
-  
+
+  def test_time_with_zone_value
+    assert_respond_to Time.zone.now, :to_builder
+  end
+
   def test_time_value
     assert_respond_to Time.utc(2012), :to_builder
   end
-  
+
   def test_date_value
     assert_respond_to Date.parse('2012-01-01'), :to_builder
   end
-  
+
   def test_datetime_value
     assert_respond_to DateTime.parse('2012-01-01'), :to_builder
   end
-  
+
   def test_bson_objectid_value
     assert_respond_to BSON::ObjectId.new, :to_builder
   end
-  
+
   def test_custom_class
     assert_respond_to Dozer.new('hello'), :to_builder
   end
-end
+end

data/test/member_test.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'test_helper'
 
 class TestMember < Test::Unit::TestCase
@@ -8,31 +10,35 @@ class TestMember < Test::Unit::TestCase
   def test_is_a_builder_value
     assert_equal JSONBuilder::Member, member(:hello, true).class
   end
-  
+
   def test_key_as_symbol
     assert_equal '"hello": true', member(:hello, true).to_s
   end
-  
+
+  def test_key_as_unicoded_symbol
+    assert_equal '"hellyé": true', member('hellyé', true).to_s
+  end
+
   def test_key_as_string
     assert_equal '"hello": true', member('hello', true).to_s
   end
-  
+
   def test_value_as_array
     assert_equal '"hello": [{"ruby":true}]', member('hello', [{ :ruby => true }]).to_s
   end
-  
+
   def test_value_as_block
-    assert_equal '"hello": "hi"', member('hello') { "hi" }.to_s
+    assert_equal '"hello": "hi"', member('hello') { 'hi' }.to_s
   end
-  
+
   def test_value_as_block_with_hash
     assert_equal '"hello": {"ruby":true}', member('hello') { { :ruby => true } }.to_s
   end
-  
+
   def test_custom_class
     assert_equal '"hello": "olleh"', member('hello', Dozer.new('hello')).to_s
   end
-  
+
   def test_without_key
     assert_raises(JSONBuilder::MissingKeyError) { member(nil, true).to_s }
   end

data/test/test_helper.rb

@@ -8,14 +8,15 @@ $LOAD_PATH.unshift dir + '/../lib'
 $TESTING = true
 require 'test/unit'
 require 'json_builder'
+require 'tzinfo'
 
 class Dozer
   attr_accessor :value
-  
+
   def initialize(value)
     @value = value
   end
-  
+
   def to_builder
     @value.reverse.inspect
   end

data/test/value_test.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'test_helper'
 
 class TestValue < Test::Unit::TestCase
@@ -5,10 +7,6 @@ class TestValue < Test::Unit::TestCase
     JSONBuilder::Value.new(nil, value).to_s
   end
 
-  def test_is_a_builder_value
-    assert_equal JSONBuilder::Value, JSONBuilder::Value.new(nil, true).class
-  end
-
   def test_positive_value
     assert_equal '1', value(1)
   end
@@ -37,12 +35,21 @@ class TestValue < Test::Unit::TestCase
     assert_equal 'test', value(:test)
   end
 
+  def test_unicode_char_value
+    assert_equal '"hellyé"', value('hellyé')
+  end
+
   def test_time_value
     assert_equal '"2012-01-01T00:00:00Z"', value(Time.utc(2012))
   end
 
+  def test_time_with_zone_value
+    Time.zone = 'CET'
+    assert_equal '"2012-01-01T00:00:00+01:00"', value(Time.zone.local(2012))
+  end
+
+  # This will be the local time zone offset, hence the wildcard.
   def test_date_value
-    # This will be the local time zone offset, hence the wildcard.
     assert_match /"2012-01-01T00:00:00.*/, value(Date.parse('2012-01-01'))
   end
 

metadata

@@ -1,38 +1,62 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: json_builder
-version: !ruby/object:Gem::Version
-  version: 3.0.7
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 3
+  - 1
+  - 0
+  version: 3.1.0
 platform: ruby
-authors:
+authors: 
 - Garrett Bjerkhoel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-08 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-02-27 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: activesupport
-  requirement: &70277572004620 !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70277572004620
-description: 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.
-email:
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: tzinfo
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: 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.
+email: 
 - me@garrettbjerkhoel.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -54,40 +78,41 @@ files:
 - test/member_test.rb
 - test/test_helper.rb
 - test/value_test.rb
+has_rdoc: true
 homepage: 
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1289439851901198119
+      segments: 
       - 0
-      hash: -1301567226691013722
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1289439851901198119
+      segments: 
       - 0
-      hash: -1301567226691013722
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: 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.
-test_files:
+summary: 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.
+test_files: 
 - test/benchmarks/builder.rb
 - test/compiler_test.rb
 - test/elements_test.rb