rabl 0.9.3 → 0.9.4.pre1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjcwOGMyNWMwNDhjYzlkN2ZkMTg3ZjRlMjgwMzdiYTliNTQwOWE3NA==
-  data.tar.gz: !binary |-
-    N2FjZmZkNjFhMmVhMTY4NjAxNDEyNGZmN2ZkMzUyMzJlMmYxZWViZg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YjQ1YmM1Y2FkZGFjYmYxYzJmMGQyYmI1Y2MzZjkwNGJmMmNhMDU2NzFjYjZi
-    ZmZhYTRmZGNiZmFmOTkxMjY2OWZkZjQ2OTRhMmNkZDlmMmZiMjQ5MTMzNjdi
-    MDA4NmE4ZmNmYjA4Njk3MDcyM2QyMDI4OGJjYzdiZmRjNTNhMWY=
-  data.tar.gz: !binary |-
-    Mjk5MGY5YmZlNTZkMjQ0YjUwNjdmZDlmYmU4NjNjNDYzNDMwODliMzQwNjQy
-    MGI2NGJlMDQ4MjhmOWIxNTRiYmEyZjgxZTM0NTE1YTcxYmNjMDQ3Y2I3OTc5
-    MmRkZWU5ODdlZGM5YTdiOTU4YzQ3NDZjODYxMmI1MDhjYzEzOGM=
+SHA1:
+  metadata.gz: 1866c412279ffb2db8142893bab3ea5f898aad3b
+  data.tar.gz: 0dd7d7cd23cef1401f1e84b65f4bbd3ec9438e08
+SHA512:
+  metadata.gz: 730240cb3efea4af23359f5a11a5e022f83355b00e3ff58c6bf90a44a45f54d84ad6ea263617d6d0bdd5988cfae8ecd5b06150e96ac23acf012cf55d3cf1cfbb
+  data.tar.gz: 51942438bcba8d05ec2029b9e41a672ac438281c28b3dc9246aa02a398b2e1ba79abc8c83b4442d12f4f015f28a517e86a7629e78187311865e997931550c0d5

data/.gitignore

@@ -5,3 +5,4 @@ Gemfile.lock
 pkg/*
 fixtures/rails2/log/*.log
 tags
+.idea

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 0.9.4.pre1 (March 30th)
+
+* NEW #527 Add configuration excluding empty values in collections (@addbrick)
+* FIX #516 Set default root_object lazily (@DouweM)
+* FIX #540 Fix cache digest in Rails 4.1 (@huoxito)
+* FIX #534 Bug with management of empty string values (@nickkov89)
+* FIX #519 JSON in README (@shirish4you)
+* NEW #514 Add configuration to exclude nil values (@oharsta)
+
 ## 0.9.3 (December 5th)
 
 * FIX Send engine options through from render call (Thanks @bhicks)

data/README.md

@@ -105,8 +105,8 @@ Which would output the following JSON or XML when visiting `http://localhost:300
 ```js
 [{  "post" :
   {
-    "id" : 5, title: "...", subject: "...",
-    "user" : { full_name : "..." },
+    "id" : 5, "title": "...", "subject": "...",
+    "user" : { "full_name" : "..." },
     "read" : true
   }
 }]
@@ -143,10 +143,13 @@ Rabl.configure do |config|
   # config.view_paths = []
   # config.raise_on_missing_attribute = true # Defaults to false
   # config.replace_nil_values_with_empty_strings = true # Defaults to false
+  # config.replace_empty_string_values_with_nil = true # Defaults to false
+  # config.exclude_nil_values = true # Defaults to false
+  # config.exclude_empty_values_in_collections = true # Defaults to false
 end
 ```
 
-Each option specifies behavior related to RABL's output. 
+Each option specifies behavior related to RABL's output.
 
 If `include_json_root` is disabled that removes the root node for each root object in the output, and `enable_json_callbacks` enables support for 'jsonp' style callback
 output if the incoming request has a 'callback' parameter.
@@ -180,6 +183,10 @@ production code is not recommended.
 
 If `replace_nil_values_with_empty_strings` is set to `true`, all values that are `nil` and would normally be displayed as `null` in the response are converted to empty strings.
 
+If `exclude_nil_values` is set to `true`, all values that are `nil` and would normally be displayed as `null` in the response are not included in the response.
+
+if `exclude_empty_values_in_collections` is set to `true`, all vaules in a collection that are `{}` and would normally be displayed as `{}` in the response are not included in the response.
+
 If you wish to use [oj](https://github.com/ohler55/oj) as
 the primary JSON encoding engine simply add that to your Gemfile:
 

data/lib/rabl/builder.rb

@@ -44,7 +44,9 @@ module Rabl
 
       wrap_result(options[:root_name])
 
-      replace_nil_values if Rabl.configuration.replace_nil_values_with_empty_strings
+      replace_nil_values          if Rabl.configuration.replace_nil_values_with_empty_strings
+      replace_empty_string_values if Rabl.configuration.replace_empty_string_values_with_nil_values
+      remove_nil_values           if Rabl.configuration.exclude_nil_values
 
       # Return Results
       @_root_name ? { @_root_name => @_result } : @_result
@@ -57,6 +59,20 @@ module Rabl
       end
     end
 
+    def replace_empty_string_values
+      @_result = @_result.inject({}) do |hash, (k, v)|
+        hash[k] = (!v.nil? && v != "") ? v : nil
+        hash
+      end
+    end
+
+    def remove_nil_values
+      @_result = @_result.inject({}) do |hash, (k, v)|
+        hash[k] = v unless v.nil?
+        hash
+      end
+    end
+
     def wrap_result(root_name)
       if root_name.present?
         @_root_name = root_name

data/lib/rabl/configuration.rb

@@ -48,31 +48,37 @@ module Rabl
     attr_accessor :raise_on_missing_attribute
     attr_accessor :perform_caching
     attr_accessor :replace_nil_values_with_empty_strings
+    attr_accessor :replace_empty_string_values_with_nil_values
+    attr_accessor :exclude_nil_values
+    attr_accessor :exclude_empty_values_in_collections
 
     DEFAULT_XML_OPTIONS = { :dasherize  => true, :skip_types => false }
 
     def initialize
-      @include_json_root                     = true
-      @include_child_root                    = true
-      @include_msgpack_root                  = true
-      @include_plist_root                    = true
-      @include_xml_root                      = false
-      @include_bson_root                     = true
-      @enable_json_callbacks                 = false
-      @bson_check_keys                       = false
-      @bson_move_id                          = false
-      @json_engine                           = nil
-      @msgpack_engine                        = nil
-      @bson_engine                           = nil
-      @plist_engine                          = nil
-      @xml_options                           = {}
-      @cache_sources                         = false
-      @cache_all_output                      = false
-      @escape_all_output                     = false
-      @view_paths                            = []
-      @cache_engine                          = Rabl::CacheEngine.new
-      @perform_caching                       = false
-      @replace_nil_values_with_empty_strings = false
+      @include_json_root                            = true
+      @include_child_root                           = true
+      @include_msgpack_root                         = true
+      @include_plist_root                           = true
+      @include_xml_root                             = false
+      @include_bson_root                            = true
+      @enable_json_callbacks                        = false
+      @bson_check_keys                              = false
+      @bson_move_id                                 = false
+      @json_engine                                  = nil
+      @msgpack_engine                               = nil
+      @bson_engine                                  = nil
+      @plist_engine                                 = nil
+      @xml_options                                  = {}
+      @cache_sources                                = false
+      @cache_all_output                             = false
+      @escape_all_output                            = false
+      @view_paths                                   = []
+      @cache_engine                                 = Rabl::CacheEngine.new
+      @perform_caching                              = false
+      @replace_nil_values_with_empty_strings        = false
+      @replace_empty_string_values_with_nil_values  = false
+      @exclude_nil_values                           = false
+      @exclude_empty_values_in_collections   = false
     end
 
     # @return The JSON engine used to encode Rabl templates into JSON

data/lib/rabl/digestor.rb

@@ -2,17 +2,30 @@ module Rabl
   class Digestor < ActionView::Digestor
     # Override the original digest function to ignore partial which
     # rabl doesn't use the Rails conventional _ symbol.
-    def self.digest(name, format, finder, options = {})
-      cache_key = [name, format] + Array.wrap(options[:dependencies])
-      @@cache[cache_key.join('.')] ||= begin
-        Digestor.new(name, format, finder, options).digest
+    if Rails.version.to_s >= '4.1'
+      def self.digest(options = {})
+        cache_key = [options[:name]] + Array.wrap(options[:dependencies])
+        @@cache[cache_key.join('.')] ||= begin
+          Digestor.new({ name: options[:name], finder: options[:finder] }.merge!(options)).digest
+        end
+      end
+    else
+      def self.digest(name, format, finder, options = {})
+        cache_key = [name, format] + Array.wrap(options[:dependencies])
+        @@cache[cache_key.join('.')] ||= begin
+          Digestor.new(name, format, finder, options).digest
+        end
       end
     end
 
     private
       def dependency_digest
         template_digests = dependencies.collect do |template_name|
-          Digestor.digest(template_name, format, finder)
+          if Rails.version.to_s >= '4.1'
+            Digestor.digest(name: template_name, finder: finder)
+          else
+            Digestor.digest(template_name, format, finder)
+          end
         end
 
         (template_digests + injected_dependencies).join("-")

data/lib/rabl/engine.rb

@@ -27,15 +27,12 @@ module Rabl
       locals.each { |k,v| instance_variable_set(:"@#{k}", v) }
       @_options[:scope] = @_scope
       @_options[:format] ||= self.request_format
-      data = locals[:object].nil? ? self.default_object : locals[:object]
-      @_data_object = data_object(data)
-      @_data_name = @_options[:object_root_name] || data_name(data)
       if @_options[:source_location]
         instance_eval(@_source, @_options[:source_location]) if @_source.present?
       else # without source location
         instance_eval(@_source) if @_source.present?
       end
-      instance_exec(@_data_object, &block) if block_given?
+      instance_exec(root_object, &block) if block_given?
       cache_results { self.send("to_" + @_options[:format].to_s, @_options) }
     end
 
@@ -43,14 +40,16 @@ module Rabl
     # to_hash(:root => true, :child_root => true)
     def to_hash(options={})
       options = options.merge(@_options)
-      data = @_data_object
+      data = root_object
       builder = Rabl::Builder.new(options)
-      options[:root_name] = determine_object_root(@_data_object, @_data_name, options[:root])
+      options[:root_name] = determine_object_root(data, root_name, options[:root])
 
       if is_object?(data) || !data # object @user
         builder.build(data, options)
       elsif is_collection?(data) # collection @users
-        data.map { |object| builder.build(object, options) }
+        result = data.map { |object| builder.build(object, options) }
+        result = result.map(&:presence).compact if Rabl.configuration.exclude_empty_values_in_collections
+        result
       end
     end
 
@@ -91,7 +90,7 @@ module Rabl
       include_root = Rabl.configuration.include_xml_root
       include_child_root = include_root && Rabl.configuration.include_child_root
       options = options.reverse_merge(:root => include_root, :child_root => include_child_root)
-      xml_options = Rabl.configuration.default_xml_options.merge(:root => collection_root_name || @_data_name)
+      xml_options = Rabl.configuration.default_xml_options.merge(:root => collection_root_name || root_name)
       result = to_hash(options)
       result.to_xml(xml_options)
     end
@@ -104,8 +103,8 @@ module Rabl
       options = options.reverse_merge(:root => include_root, :child_root => include_child_root)
       result = if collection_root_name
                  { collection_root_name => to_hash(options) }
-               elsif is_collection?(@_data_object) && @_data_object.is_a?(Array)
-                 { @_data_name => to_hash(options) }
+               elsif is_collection?(root_object) && root_object.is_a?(Array)
+                 { root_name => to_hash(options) }
                else
                  to_hash(options)
                end
@@ -126,7 +125,19 @@ module Rabl
     # Can be the collection or the object depending on topic assigned
     # root_object => @user
     def root_object
-      @_data_object
+      return @_data_object if defined?(@_data_object)
+
+      data = @_locals[:object].nil? ? self.default_object : @_locals[:object]
+      @_data_object = data_object(data)
+    end
+
+    def root_name
+      return @_data_name if defined?(@_data_name)
+
+      @_data_name = @_options[:object_root_name] || begin
+        data = @_locals[:object].nil? ? root_object : @_locals[:object]
+        data_name(data)
+      end
     end
 
     # Sets the object as a collection casted to a simple array
@@ -149,7 +160,7 @@ module Rabl
     # cache 'user', expires_in: 1.hour
     # options is passed through to the cache store
     def cache(key = nil, options = nil)
-      key ||= @_data_object # if called but missing, use object
+      key ||= root_object # if called but missing, use object
       @_cache = [key, options]
     end
 
@@ -288,10 +299,17 @@ module Rabl
 
     def cache_key_with_digest(cache_key)
       template = @_options[:template] || @virtual_path
+
+      if Rails.version.to_s >= '4.1'
+        digested =  Digestor.digest(name: template, finder: lookup_context)
+      else
+        digested = Digestor.digest(template, :rabl, lookup_context)
+      end
+
       Array(cache_key) + [
         @_options[:root_name],
         @_options[:format],
-        Digestor.digest(template, :rabl, lookup_context)
+        digested
       ]
     rescue NameError => e # Handle case where lookup_context doesn't exist
       raise e unless e.message =~ /lookup_context/

data/lib/rabl/helpers.rb

@@ -27,9 +27,12 @@ module Rabl
       return unless data_token # nil or false
       return data_token.values.first if data_token.is_a?(Hash) # @user => :user
       data = data_object(data_token)
-      if is_collection?(data) && data.respond_to?(:first) # data is a collection
+      if is_collection?(data) # data is a collection
         object_name = data.table_name if data.respond_to?(:table_name)
-        object_name ||= data_name(data.first).to_s.pluralize if data.first.present?
+        if !object_name && data.respond_to?(:first)
+          first = data.first
+          object_name = data_name(first).to_s.pluralize if first.present?
+        end
         object_name ||= data_token if data_token.is_a?(Symbol)
         object_name
       elsif is_object?(data) # data is an object

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.9.3"
+  VERSION = "0.9.4.pre1"
 end

data/test/builder_test.rb

@@ -55,6 +55,42 @@ context "Rabl::Builder" do
         Rabl.configuration.replace_nil_values_with_empty_strings = false
       end
     end
+
+    context "when empty string values are replaced with nil values" do
+      setup do
+        Rabl.configuration.replace_empty_string_values_with_nil_values = true
+        builder({ :attributes => { :name => {} } })
+      end
+
+      asserts "that nil is returned as the value" do
+        topic.build(User.new(:name => ""))
+      end.equivalent_to({ :name => nil })
+
+      asserts "that it handles existing nil values correctly" do
+        topic.build(User.new(:name => nil))
+      end.equivalent_to({ :name => nil })
+
+      asserts "that it handles existing non nil values correctly" do
+        topic.build(User.new(:name => 10))
+      end.equivalent_to({ :name => 10 })
+
+      teardown do
+        Rabl.configuration.replace_empty_string_values_with_nil_values = false
+      end
+    end
+
+    context "when nil values are excluded" do
+      setup do
+        Rabl.configuration.exclude_nil_values = true
+        builder({ :attributes => { :name => {} } })
+      end
+      asserts "that an nil attribute is not returned" do
+        topic.build(User.new(:name => nil))
+      end.equivalent_to({ })
+      teardown do
+        Rabl.configuration.exclude_nil_values = false
+      end
+    end
   end
 
   context "#attribute" do

data/test/configuration_test.rb

@@ -14,6 +14,9 @@ context 'Rabl::Configuration' do
     asserts(:json_engine).equals { json_engine }
     asserts(:cache_engine).is_a?(Rabl::CacheEngine)
     asserts(:replace_nil_values_with_empty_strings).equals false
+    asserts(:replace_empty_string_values_with_nil_values).equals false
+    asserts(:exclude_nil_values).equals false
+    asserts(:exclude_empty_values_in_collections).equals false
   end
 
   context 'custom JSON engine configured as Symbol' do
@@ -55,4 +58,34 @@ context 'Rabl::Configuration' do
 
     asserts(:replace_nil_values_with_empty_strings).equals true
   end # replace nil values with empty strings
+
+  context 'replace empty string values with nil values' do
+    setup do
+      Rabl.configure do |c|
+        c.replace_empty_string_values_with_nil_values = true
+      end
+    end
+
+    asserts(:replace_empty_string_values_with_nil_values).equals true
+  end # replace empty string values with nil values
+
+  context 'exclude nil values' do
+    setup do
+      Rabl.configure do |c|
+        c.exclude_nil_values = true
+      end
+    end
+
+    asserts(:exclude_nil_values).equals true
+  end # exclude nil values
+
+  context 'exclude empty values in collections' do
+    setup do
+      Rabl.configure do |c|
+        c.exclude_empty_values_in_collections = true
+      end
+    end
+
+    asserts(:exclude_empty_values_in_collections).equals true
+  end # exclude empty values in collections
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4.pre1
 platform: ruby
 authors:
 - Nathan Esquenazi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-06 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.14
 - !ruby/object:Gem::Dependency
@@ -56,42 +56,42 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -126,14 +126,14 @@ dependencies:
   name: plist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: General ruby templating with json, bson, xml and msgpack support
@@ -456,17 +456,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: rabl
-rubygems_version: 2.0.7
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: General ruby templating with json, bson, xml and msgpack support