jbuilder 0.4.0 → 0.4.2

data/README.md

@@ -66,6 +66,34 @@ end
 # => [ { "name": David", "age": 32 }, { "name": Jamie", "age": 31 } ]
 ```
 
+Jbuilder objects can be directly nested inside each other.  Useful for composing objects.
+
+``` ruby
+class Person
+  # ... Class Definition ... #
+  def to_builder
+    person = Jbuilder.new
+    person.(self, :name, :age)
+    person
+  end
+end
+
+class Company
+  # ... Class Definition ... #
+  def to_builder
+    company = Jbuilder.new
+    company.name name
+    company.president president.to_builder
+    company
+  end
+end
+
+company = Company.new("Doodle Corp", Person.new("John Stobs", 58))
+company.to_builder.target!
+
+# => {"name":"Doodle Corp","president":{"name":"John Stobs","age":58}}
+```
+
 You can either use Jbuilder stand-alone or directly as an ActionView template language. When required in Rails, you can create views ala show.json.jbuilder (the json is already yielded):
 
 ``` ruby
@@ -90,10 +118,25 @@ end
 json.partial! "api/comments/comments", comments: @message.comments
 ```
 
+Keys can be auto formatted using `key_format!`, this can be used to convert keynames from the standard ruby_format to CamelCase:
+
+``` ruby
+json.key_format! :camelize => :lower
+json.first_name "David"
+
+# { "firstName": "David" }
+```
+
+You can set this globaly with the class method `key_format` (from inside your enviorment.rb for example):
+
+``` ruby
+Jbuilder.key_format :camelize => :lower
+```
+
 Libraries similar to this in some form or another include:
 
 * RABL: https://github.com/nesquena/rabl
 * JsonBuilder: https://github.com/nov/jsonbuilder
 * JSON Builder: https://github.com/dewski/json_builder
 * Jsonify: https://github.com/bsiggelkow/jsonify
-* RepresentationView: https://github.com/mdub/representative_view
+* RepresentationView: https://github.com/mdub/representative_view

data/jbuilder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name    = 'jbuilder'
-  s.version = '0.4.0'
+  s.version = '0.4.2'
   s.author  = 'David Heinemeier Hansson'
   s.email   = 'david@37signals.com'
   s.summary = 'Create JSON structures via a Builder-style DSL'

data/lib/jbuilder.rb

@@ -3,23 +3,84 @@ require 'active_support/ordered_hash'
 require 'active_support/core_ext/array/access'
 require 'active_support/core_ext/enumerable'
 require 'active_support/json'
-
+require 'multi_json'
 class Jbuilder < BlankSlate
   # Yields a builder and automatically turns the result into a JSON string
   def self.encode
     new._tap { |jbuilder| yield jbuilder }.target!
   end
 
+  @@key_format = {}
+
   define_method(:__class__, find_hidden_method(:class))
   define_method(:_tap, find_hidden_method(:tap))
+  define_method(:_is_a?, find_hidden_method(:is_a?))
+  reveal(:respond_to?)
 
-  def initialize
+  def initialize(key_format = @@key_format.clone)
     @attributes = ActiveSupport::OrderedHash.new
+    @key_format = key_format
   end
 
   # Dynamically set a key value pair.
-  def set!(key, value)
-    @attributes[key] = value
+  #
+  # Example:
+  #
+  #   json.set!(:each, "stuff")
+  #
+  #   { "each": "stuff" }
+  #
+  # You can also pass a block for nested attributes
+  #
+  #   json.set!(:author) do |json|
+  #     json.name "David"
+  #     json.age 32
+  #   end
+  #
+  #   { "author": { "name": "David", "age": 32 } }
+  def set!(key, value = nil)
+    if block_given?
+      _yield_nesting(key) { |jbuilder| yield jbuilder }
+    else
+      @attributes[_format_key(key)] = value
+    end
+  end
+
+  # Specifies formatting to be applied to the key. Passing in a name of a function
+  # will cause that function to be called on the key.  So :upcase will upper case
+  # the key.  You can also pass in lambdas for more complex transformations.
+  #
+  # Example:
+  #
+  #   json.key_format! :upcase
+  #   json.author do |json|
+  #     json.name "David"
+  #     json.age 32
+  #   end
+  #
+  #   { "AUTHOR": { "NAME": "David", "AGE": 32 } }
+  #
+  # You can pass parameters to the method using a hash pair.
+  #
+  #   json.key_format! :camelize => :lower
+  #   json.first_name "David"
+  #
+  #   { "firstName": "David" }
+  #
+  # Lambdas can also be used.
+  #
+  #   json.key_format! ->(key){ "_" + key }
+  #   json.first_name "David"
+  #
+  #   { "_first_name": "David" }
+  #
+  def key_format!(*args)
+    __class__.extract_key_format(args, @key_format)
+  end
+  
+  # Same as the instance method key_format! except sets the default.
+  def self.key_format(*args)
+    extract_key_format(args, @@key_format)
   end
 
   # Turns the current element into an array and yields a builder to add a hash.
@@ -112,13 +173,19 @@ class Jbuilder < BlankSlate
   
   # Encodes the current builder as JSON.
   def target!
-    ActiveSupport::JSON.encode @attributes
+    MultiJson.encode @attributes
   end
 
 
   private
     def method_missing(method, *args)
       case
+      # json.age 32
+      # json.person another_jbuilder
+      # { "age": 32, "person": { ...  }
+      when args.one? && args.first.respond_to?(:_is_a?) && args.first._is_a?(Jbuilder)
+        set! method, args.first.attributes!
+
       # json.comments @post.comments { |json, comment| ... }
       # { "comments": [ { ... }, { ... } ] }
       when args.one? && block_given?
@@ -133,7 +200,7 @@ class Jbuilder < BlankSlate
       # { "comments": ... }
       when args.empty? && block_given?
         _yield_nesting(method) { |jbuilder| yield jbuilder }
-      
+
       # json.comments(@post.comments, :content, :created_at)
       # { "comments": [ { "content": "hello", "created_at": "..." }, { "content": "world", "created_at": "..." } ] }
       when args.many? && args.first.is_a?(Enumerable)
@@ -148,7 +215,7 @@ class Jbuilder < BlankSlate
 
     # Overwrite in subclasses if you need to add initialization values
     def _new_instance
-      __class__.new
+      __class__.new(@key_format)
     end
 
     def _yield_nesting(container)
@@ -180,6 +247,28 @@ class Jbuilder < BlankSlate
     def _inline_extract(container, record, attributes)
       __send__(container) { |parent| parent.extract! record, *attributes }
     end
+
+    # Format the key using the methods described in @key_format
+    def _format_key(key)
+      @key_format.inject(key.to_s) do |result, args|
+        func, args = args
+        if func.is_a? Proc
+          func.call(result, *args)
+        else
+          result.send(func, *args)
+        end
+      end
+    end
+
+    def self.extract_key_format(args, target)
+      options = args.extract_options!
+      args.each do |name|
+        target[name] = []
+      end
+      options.each do |name, paramaters|
+        target[name] = paramaters
+      end
+    end
 end
 
 require "jbuilder_template" if defined?(ActionView::Template)

data/lib/jbuilder_template.rb

@@ -7,11 +7,18 @@ class JbuilderTemplate < Jbuilder
     @context = context
     super()
   end
-  
-  def partial!(partial_name, options = {})
-    @context.render(partial_name, options.merge(:json => self))
+
+  def partial!(options, locals = {})
+    case options
+    when Hash
+      options[:locals] ||= {}
+      options[:locals].merge!(:json => self)
+      @context.render(options)
+    else
+      @context.render(options, locals.merge(:json => self))
+    end
   end
-  
+
   private
     def _new_instance
       __class__.new(@context)
@@ -23,15 +30,10 @@ class JbuilderHandler
   self.default_format = Mime::JSON
 
   def self.call(template)
-    %{
-      if defined?(json)
-        #{template.source}
-      else
-        JbuilderTemplate.encode(self) do |json|
-          #{template.source}
-        end
-      end
-    }
+    
+    # this juggling is required to keep line numbers right in the error
+    %{__already_defined = defined?(json); json||=JbuilderTemplate.new(self); #{template.source}
+      json.target! unless __already_defined}
   end
 end
 

data/test/jbuilder_test.rb

@@ -1,5 +1,6 @@
 require 'test/unit'
 require 'active_support/test_case'
+require 'active_support/inflector'
 
 require 'jbuilder'
 
@@ -207,7 +208,19 @@ class JbuilderTest < ActiveSupport::TestCase
     
     assert_equal "david", JSON.parse(json)["comments"].first["authors"].first["name"]
   end
-  
+
+  test "nested jbuilder objects" do
+    to_nest = Jbuilder.new
+    to_nest.nested_value "Nested Test"
+    json = Jbuilder.encode do |json|
+      json.value "Test"
+      json.nested to_nest
+    end
+    parsed = JSON.parse(json)
+    assert_equal "Test", parsed['value']
+    assert_equal "Nested Test", parsed["nested"]["nested_value"]
+  end
+
   test "top-level array" do
     comments = [ Struct.new(:content, :id).new("hello", 1), Struct.new(:content, :id).new("world", 2) ]
 
@@ -242,4 +255,80 @@ class JbuilderTest < ActiveSupport::TestCase
     
     assert_equal "stuff", JSON.parse(json)["each"]
   end
+
+  test "dynamically set a key/nested child with block" do
+    json = Jbuilder.encode do |json|
+      json.set!(:author) do |json|
+        json.name "David"
+        json.age 32
+      end
+    end
+    
+    JSON.parse(json).tap do |parsed|
+      assert_equal "David", parsed["author"]["name"]
+      assert_equal 32, parsed["author"]["age"]
+    end
+  end
+
+  test "key_format! with parameter" do
+    json = Jbuilder.new
+    json.key_format! :camelize => [:lower]
+    json.camel_style "for JS"
+
+    assert_equal ['camelStyle'], json.attributes!.keys
+  end
+
+  test "key_format! with parameter not as an array" do
+    json = Jbuilder.new
+    json.key_format! :camelize => :lower
+    json.camel_style "for JS"
+
+    assert_equal ['camelStyle'], json.attributes!.keys
+  end
+
+  test "key_format! propagates to child elements" do
+    json = Jbuilder.new
+    json.key_format! :upcase
+    json.level1 "one"
+    json.level2 do |json|
+      json.value "two"
+    end
+
+    result = json.attributes!
+    assert_equal "one", result["LEVEL1"]
+    assert_equal "two", result["LEVEL2"]["VALUE"]
+  end
+
+  test "key_format! with no parameter" do
+    json = Jbuilder.new
+    json.key_format! :upcase
+    json.lower "Value"
+
+    assert_equal ['LOWER'], json.attributes!.keys
+  end
+
+  test "key_format! with multiple steps" do
+    json = Jbuilder.new
+    json.key_format! :upcase, :pluralize
+    json.pill ""
+
+    assert_equal ["PILLs"], json.attributes!.keys
+  end
+
+  test "key_format! with lambda/proc" do
+    json = Jbuilder.new
+    json.key_format! ->(key){ key + " and friends" }
+    json.oats ""
+
+    assert_equal ["oats and friends"], json.attributes!.keys
+  end
+
+  test "default key_format!" do
+    Jbuilder.key_format :camelize => :lower
+    json = Jbuilder.new
+    json.camel_style "for JS"
+
+    assert_equal ['camelStyle'], json.attributes!.keys
+    Jbuilder.class_variable_set("@@key_format", {})
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-23 00:00:00.000000000 Z
+date: 2012-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70191736347120 !ruby/object:Gem::Requirement
+  requirement: &2152793760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70191736347120
+  version_requirements: *2152793760
 - !ruby/object:Gem::Dependency
   name: blankslate
-  requirement: &70191736346420 !ruby/object:Gem::Requirement
+  requirement: &2152793020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 2.1.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *70191736346420
+  version_requirements: *2152793020
 description: 
 email: david@37signals.com
 executables: []
@@ -41,9 +41,6 @@ extra_rdoc_files: []
 files:
 - ./Gemfile
 - ./Gemfile.lock
-- ./jbuilder-0.3.1.gem
-- ./jbuilder-0.3.2.gem
-- ./jbuilder-0.3.gem
 - ./jbuilder.gemspec
 - ./lib/jbuilder.rb
 - ./lib/jbuilder_template.rb
@@ -70,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: Create JSON structures via a Builder-style DSL