jbuilder 0.8.2 → 0.8.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jbuilder (0.8.0)
+    jbuilder (0.8.2)
       activesupport (>= 3.0.0)
 
 GEM

data/jbuilder.gemspec

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

data/lib/jbuilder.rb

@@ -45,10 +45,12 @@ class Jbuilder < ActiveSupport::BasicObject
   end
 
   @@key_formatter = KeyFormatter.new
+  @@ignore_nil    = false
 
-  def initialize(key_formatter = @@key_formatter.clone)
+  def initialize(key_formatter = @@key_formatter.clone, ignore_nil = @@ignore_nil)
     @attributes = ::ActiveSupport::OrderedHash.new
     @key_formatter = key_formatter
+    @ignore_nil = ignore_nil
   end
 
   # Dynamically set a key value pair.
@@ -112,6 +114,30 @@ class Jbuilder < ActiveSupport::BasicObject
     @@key_formatter = KeyFormatter.new(*args)
   end
 
+  # If you want to skip adding nil values to your JSON hash. This is useful
+  # for JSON clients that don't deal well with nil values, and would prefer
+  # not to receive keys which have null values.
+  #
+  # Example:
+  #   json.ignore_nil!
+  #   json.id User.new.id
+  #
+  #   { "id": null }
+  #
+  #   json.ignore_nil
+  #   json.id User.new.id
+  #
+  #   {}
+  #
+  def ignore_nil!(value = true)
+    @ignore_nil = value
+  end
+
+  # Same as instance method ignore_nil! except sets the default.
+  def self.ignore_nil(value = true)
+    @@ignore_nil = value
+  end
+
   # Turns the current element into an array and yields a builder to add a hash.
   #
   # Example:
@@ -216,7 +242,9 @@ class Jbuilder < ActiveSupport::BasicObject
 
   protected
     def _set_value(key, value)
-      @attributes[@key_formatter.format(key)] = value
+      unless @ignore_nil && value.nil?
+        @attributes[@key_formatter.format(key)] = value
+      end
     end
 
   private

data/test/jbuilder_test.rb

@@ -457,4 +457,37 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal [], Jbuilder.send(:class_variable_get, "@@key_formatter").instance_variable_get("@cache").keys
   end
 
+  test "ignore_nil! without a parameter" do
+    json = Jbuilder.new
+    json.ignore_nil!
+    json.test nil
+
+    assert_equal [], json.attributes!.keys
+  end
+
+  test "ignore_nil! with parameter" do
+    json = Jbuilder.new
+    json.ignore_nil! true
+    json.name "Bob"
+    json.dne nil
+
+    assert_equal ["name"], json.attributes!.keys
+
+    json = Jbuilder.new
+    json.ignore_nil! false
+    json.name "Bob"
+    json.dne nil
+
+    assert_equal ["name", "dne"], json.attributes!.keys
+  end
+
+  test "default ignore_nil!" do
+    Jbuilder.ignore_nil
+    json = Jbuilder.new
+    json.name "Bob"
+    json.dne nil
+
+    assert_equal ["name"], json.attributes!.keys
+    Jbuilder.send(:class_variable_set, "@@ignore_nil", false)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-07 00:00:00.000000000 Z
+date: 2012-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -35,7 +35,8 @@ extra_rdoc_files: []
 files:
 - ./Gemfile
 - ./Gemfile.lock
-- ./jbuilder-0.5.0.gem
+- ./jbuilder-0.4.0.gem
+- ./jbuilder-0.8.1.gem
 - ./jbuilder.gemspec
 - ./lib/jbuilder.rb
 - ./lib/jbuilder_template.rb