json_builder 3.0.6 → 3.0.7

data/lib/json_builder/extensions.rb

@@ -32,19 +32,19 @@ end
 
 class Time
   def to_builder
-    self.strftime("%Y-%m-%dT%H:%M:%S").inspect
+    iso8601.inspect
   end
 end
 
 class Date
   def to_builder
-    self.strftime("%Y-%m-%dT%H:%M:%S").inspect
+    to_time.iso8601.inspect
   end
 end
 
 class DateTime
   def to_builder
-    self.strftime("%Y-%m-%dT%H:%M:%S").inspect
+    to_time.iso8601.inspect
   end
 end
 

data/lib/json_builder/member.rb

@@ -3,12 +3,23 @@ require 'json_builder/elements'
 
 module JSONBuilder
   class Member
-    attr_accessor :key
-    attr_accessor :value
-    
+    attr_accessor :key, :value
+
+    # Public: Returns a key value pair for the stored value which could
+    # be an instance of JSONBuilder::Elements or JSONBuilder::Value.
+    #
+    # key   - Used to generate the JSON member's key. Can be a String or Symbol.
+    # scope - The view scope context for any variables.
+    # args  - Can be an Array or other standard Ruby value.
+    # block - Yielding any block passed to the element.
+    #
+    # Raises JSONBuilder::MissingKeyError if the key passed is nil.
+    # Returns instance of JSONBuilder::Member.
     def initialize(key, scope, *args, &block)
+      raise MissingKeyError if key.nil?
+
       @key = key
-      
+
       argument = args.shift
       if argument.is_a?(Array) || defined?(ActiveRecord::Relation) && argument.is_a?(ActiveRecord::Relation)
         @value = Elements.new(scope, argument, &block)
@@ -16,7 +27,11 @@ module JSONBuilder
         @value = Value.new(scope, argument, &block)
       end
     end
-    
+
+    # Public: Returns a key value pair for the stored value which could
+    # be an instance of JSONBuilder::Elements or JSONBuilder::Value.
+    #
+    # Returns a String.
     def to_s
       "\"#{@key}\": #{@value}"
     end

data/lib/json_builder/template.rb

@@ -2,7 +2,7 @@ module ActionView #:nodoc:
   class Base
     cattr_accessor :pretty_print_json
     @@pretty_print_json = defined?(Rails) && Rails.env.development?
-    
+
     cattr_accessor :json_callback
     @@json_callback = true
   end

data/lib/json_builder/value.rb

@@ -3,12 +3,20 @@ require 'json_builder/extensions'
 module JSONBuilder
   class Value
     attr_accessor :value
-    
+
+    # Public: Creates
+    #
+    # scope - The view scope context for any variables.
+    # arg   - Could be string, hash, or any other Ruby value.
+    # block - Yielding any block passed to the element.
+    #
+    # Returns an instance of JSONBuilder::Member, JSONBuilder::Compiler
+    # or String.
     def initialize(scope, arg, &block)
       if block_given?
         @value = Compiler.new(:scope => scope)
         compiled = @value.compile(arg, &block)
-        
+
         # For the use case that the passed in block returns a non-member object
         # or normal Ruby object
         @value = compiled unless compiled.is_a?(Member)
@@ -16,7 +24,11 @@ module JSONBuilder
         @value = arg
       end
     end
-    
+
+    # Public: Determines of the stored value has a special return value
+    # or calls the default to_s on it.
+    #
+    # Returns a String.
     def to_s
       @value.respond_to?(:to_builder) ? @value.to_builder : @value.to_s
     end

data/lib/json_builder/version.rb

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

data/test/compiler_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+require 'active_support/ordered_hash'
+
+class TestCompiler < Test::Unit::TestCase
+  def assert_builder_json(json, *args, &block)
+    assert_equal json, JSONBuilder::Compiler.generate(*args, &block)
+  end
+
+  def test_without_nesting
+    assert_builder_json('{"name": "Garrett Bjerkhoel", "valid": true}') do
+      def valid?
+        true
+      end
+      
+      name 'Garrett Bjerkhoel'
+      valid valid?
+    end
+  end
+
+  def test_support_all_dates
+    actual = JSONBuilder::Compiler.generate do
+      date Date.new(2011, 11, 23)
+      date_time DateTime.new(2001, 2, 3, 4, 5, 6)
+      timed Time.utc(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)
+  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
+      mega_integer 100_000_000
+      float 13.37
+      true_class true
+      false_class false
+      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|
+        id i
+        l [1, 2] do |b|
+          l b * i
+          d 't' do |c|
+            c * b
+          end
+        end
+      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
+      nested do
+        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')
+    end
+  end
+
+  def test_adding_hash_objects
+    assert_builder_json('{"hash_test": {"garrett":true}}') do
+      hash_test :garrett => true
+    end
+  end
+end

data/test/elements_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+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

data/test/extensions_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+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_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

data/test/member_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class TestMember < Test::Unit::TestCase
+  def member(key, value=nil, &block)
+    JSONBuilder::Member.new(key, nil, value, &block)
+  end
+
+  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_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
+  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
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+$TESTING = true
+require 'test/unit'
+require 'json_builder'
+
+class Dozer
+  attr_accessor :value
+  
+  def initialize(value)
+    @value = value
+  end
+  
+  def to_builder
+    @value.reverse.inspect
+  end
+end

data/test/value_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+class TestValue < Test::Unit::TestCase
+  def value(value)
+    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
+
+  def test_negative_value
+    assert_equal '-5', value(-5)
+  end
+
+  def test_float_value
+    assert_equal '13.37', value(13.37)
+  end
+
+  def test_nil_value
+    assert_equal 'null', value(nil)
+  end
+
+  def test_true_value
+    assert_equal 'true', value(true)
+  end
+
+  def test_false_value
+    assert_equal 'false', value(false)
+  end
+
+  def test_symbol_value
+    assert_equal 'test', value(:test)
+  end
+
+  def test_time_value
+    assert_equal '"2012-01-01T00:00:00Z"', value(Time.utc(2012))
+  end
+
+  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
+
+  def test_date_time_value
+    assert_equal '"2012-01-01T00:00:00Z"', value(DateTime.parse('2012-01-01'))
+  end
+
+  def test_hash_value
+    assert_equal '{"oh":"boy"}', value(:oh => :boy)
+  end
+
+  def test_custom_class
+    assert_equal '"olleh"', value(Dozer.new('hello'))
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_builder
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-29 00:00:00.000000000Z
+date: 2012-02-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70270510504640 !ruby/object:Gem::Requirement
+  requirement: &70277572004620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,51 +21,7 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70270510504640
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: &70270510503740 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.0.beta
-  type: :development
-  prerelease: false
-  version_requirements: *70270510503740
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &70270510503140 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :development
-  prerelease: false
-  version_requirements: *70270510503140
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: &70270510502540 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70270510502540
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: &70270510501660 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :development
-  prerelease: false
-  version_requirements: *70270510501660
+  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
@@ -91,54 +47,13 @@ files:
 - lib/json_builder/template.rb
 - lib/json_builder/value.rb
 - lib/json_builder/version.rb
-- spec/benchmarks/builder.rb
-- spec/dummy/Rakefile
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/users_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/helpers/users_helper.rb
-- spec/dummy/app/models/user.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/views/users/index.json_builder
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/db/development.sqlite3
-- spec/dummy/db/migrate/20111127061428_create_users.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/production.log
-- spec/dummy/log/server.log
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/public/javascripts/application.js
-- spec/dummy/public/javascripts/controls.js
-- spec/dummy/public/javascripts/dragdrop.js
-- spec/dummy/public/javascripts/effects.js
-- spec/dummy/public/javascripts/prototype.js
-- spec/dummy/public/javascripts/rails.js
-- spec/dummy/public/stylesheets/.gitkeep
-- spec/dummy/script/rails
-- spec/dummy/spec/controllers/users_controller_spec.rb
-- spec/integration/navigation_spec.rb
-- spec/json_builder_spec.rb
-- spec/spec_helper.rb
-- spec/support/json_builder.rb
-- spec/unit/json_builder_spec.rb
+- test/benchmarks/builder.rb
+- test/compiler_test.rb
+- test/elements_test.rb
+- test/extensions_test.rb
+- test/member_test.rb
+- test/test_helper.rb
+- test/value_test.rb
 homepage: 
 licenses: []
 post_install_message: 
@@ -153,7 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1029443064844091129
+      hash: -1301567226691013722
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -162,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1029443064844091129
+      hash: -1301567226691013722
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -173,51 +88,10 @@ summary: Rails provides an excellent XML Builder by default to build RSS and ATO
   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:
-- spec/benchmarks/builder.rb
-- spec/dummy/Rakefile
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/users_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/helpers/users_helper.rb
-- spec/dummy/app/models/user.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/views/users/index.json_builder
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/db/development.sqlite3
-- spec/dummy/db/migrate/20111127061428_create_users.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/production.log
-- spec/dummy/log/server.log
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/public/javascripts/application.js
-- spec/dummy/public/javascripts/controls.js
-- spec/dummy/public/javascripts/dragdrop.js
-- spec/dummy/public/javascripts/effects.js
-- spec/dummy/public/javascripts/prototype.js
-- spec/dummy/public/javascripts/rails.js
-- spec/dummy/public/stylesheets/.gitkeep
-- spec/dummy/script/rails
-- spec/dummy/spec/controllers/users_controller_spec.rb
-- spec/integration/navigation_spec.rb
-- spec/json_builder_spec.rb
-- spec/spec_helper.rb
-- spec/support/json_builder.rb
-- spec/unit/json_builder_spec.rb
+- test/benchmarks/builder.rb
+- test/compiler_test.rb
+- test/elements_test.rb
+- test/extensions_test.rb
+- test/member_test.rb
+- test/test_helper.rb
+- test/value_test.rb