rabl 0.8.2 → 0.8.5

data/.travis.yml

@@ -3,9 +3,14 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   # - rbx
 gemfile: Gemfile.ci
 notifications:
   recipients:
     - nesquena@gmail.com
     - databyte@gmail.com
+matrix:
+  allow_failures:
+    - rvm: 1.8.7
+    - rvm: 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 0.8.5
+
+ * FIX #386 Support disabling root on child calls (Thanks @digger69)
+
+## 0.8.4
+
+ * NEW #411 Add "replace nil values with empty strings" option (Thanks @manuelmeurer)
+
+## 0.8.3
+
+ * Closes #421 bug with locals in engine
+
 ## 0.8.2
 
  * Passing locals when rendering templates via partials or inheritance (Thanks @simsalabim)

data/Gemfile

@@ -8,6 +8,7 @@ gem 'i18n', '~> 0.6'
 
 platforms :mri_18 do
   gem 'SystemTimer'
+  gem 'json'
 end
 
 group :test do

data/Gemfile.ci

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rabl.gemspec
 gemspec
@@ -8,6 +8,7 @@ gem "i18n", '~> 0.6'
 
 platforms :mri_18 do
   gem 'SystemTimer'
+  gem 'json'
 end
 
 gem 'activesupport', :require => 'active_support'

data/README.md

@@ -137,6 +137,7 @@ Rabl.configure do |config|
   # config.xml_options = { :dasherize  => true, :skip_types => false }
   # config.view_paths = []
   # config.raise_on_missing_attribute = true # Defaults to false
+  # config.replace_nil_values_with_empty_strings = true # Defaults to false
 end
 ```
 
@@ -171,6 +172,8 @@ attempts to render an attribute that does not exist. Otherwise, the attribute wi
 Setting this to true during development may help increase the robustness of your code, but using `true` in
 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 you wish to use [oj](https://github.com/ohler55/oj) as
 the primary JSON encoding engine simply add that to your Gemfile:
 

data/fixtures/rails2/Gemfile

@@ -4,6 +4,7 @@ gem "rails", "~> 2.3.18"
 gem "sqlite3", :require => "sqlite3"
 gem 'json'
 gem 'rabl', :path => File.expand_path(File.dirname(__FILE__) + "/../../")
+gem 'rake', "~> 0.9.2.2"
 
 gem 'riot', :group => "test"
 gem 'rack-test', :require => "rack/test", :group => "test"

data/fixtures/rails2/db/schema.rb

@@ -9,7 +9,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20111002075112) do
+ActiveRecord::Schema.define(:version => 20111002092024) do
 
   create_table "phone_numbers", :force => true do |t|
     t.integer "user_id"

data/lib/rabl/builder.rb

@@ -57,6 +57,14 @@ module Rabl
         @_root_name = nil
       end
 
+      # Replace nil values with empty strings if configured
+      if Rabl.configuration.replace_nil_values_with_empty_strings
+        @_result = @_result.inject({}) do |hash, (k, v)|
+          hash[k] = v.nil? ? '' : v
+          hash
+        end
+      end
+
       # Return Results
       @_root_name ? { @_root_name => @_result } : @_result
     end
@@ -92,7 +100,7 @@ module Rabl
     def child(data, options={}, &block)
       return false unless data.present? && resolve_condition(options)
       name, object = data_name(data), data_object(data)
-      include_root = is_collection?(object) && @options[:child_root] # child @users
+      include_root = is_collection?(object) && options.fetch(:object_root, @options[:child_root]) # child @users
       engine_options = @options.slice(:child_root).merge(:root => include_root)
       object = { object => name } if data.respond_to?(:each_pair) && object # child :users => :people
       @_result[name] = self.object_to_hash(object, engine_options, &block)

data/lib/rabl/configuration.rb

@@ -47,30 +47,32 @@ module Rabl
     attr_accessor :cache_engine
     attr_accessor :raise_on_missing_attribute
     attr_accessor :perform_caching
+    attr_accessor :replace_nil_values_with_empty_strings
 
     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
+      @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
     end
 
     # @return The JSON engine used to encode Rabl templates into JSON

data/lib/rabl/engine.rb

@@ -21,9 +21,9 @@ module Rabl
     # Rabl::Engine.new("...source...", { :format => "xml" }).render(scope, { :foo => "bar", :object => @user })
     def render(scope, locals, &block)
       reset_options!
-      locals.merge!(locals.delete(:locals) || {})
       @_locals, @_scope = locals, scope
       self.copy_instance_variables_from(@_scope, [:@assigns, :@helpers])
+      locals.merge!(locals.delete(:locals) || {})
       locals.each { |k,v| instance_variable_set(:"@#{k}", v) }
       @_options[:scope] = @_scope
       @_options[:format] ||= self.request_format

data/lib/rabl/template.rb

@@ -20,7 +20,7 @@ if defined?(Tilt)
 end
 
 # Rails 2.X Template
-if defined?(ActionView) && defined?(Rails) && Rails.version =~ /^2/
+if defined?(ActionView) && defined?(Rails) && Rails.version.to_s =~ /^2/
   require 'action_view/base'
   require 'action_view/template'
 
@@ -41,7 +41,7 @@ if defined?(ActionView) && defined?(Rails) && Rails.version =~ /^2/
 end
 
 # Rails 3.X Template
-if defined?(ActionView) && defined?(Rails) && Rails.version =~ /^[34]/
+if defined?(ActionView) && defined?(Rails) && Rails.version.to_s =~ /^[34]/
   module ActionView
     module Template::Handlers
       class Rabl

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.8.2"
+  VERSION = "0.8.5"
 end

data/test/builder_test.rb

@@ -42,6 +42,19 @@ context "Rabl::Builder" do
         topic.build(User.new, :root => false)
       end.equivalent_to({ :name => "rabl" })
     end
+
+    context "when nil values are replaced with empty strings" do
+      setup do
+        Rabl.configuration.replace_nil_values_with_empty_strings = true
+        builder({ :attributes => { :name => {} } })
+      end
+      asserts "that an empty string is returned as the value" do
+        topic.build(User.new(:name => nil))
+      end.equivalent_to({ :name => "" })
+      teardown do
+        Rabl.configuration.replace_nil_values_with_empty_strings = false
+      end
+    end
   end
 
   context "#attribute" do

data/test/configuration_test.rb

@@ -13,6 +13,7 @@ context 'Rabl::Configuration' do
     asserts(:view_paths).equals []
     asserts(:json_engine).equals { json_engine }
     asserts(:cache_engine).is_a?(Rabl::CacheEngine)
+    asserts(:replace_nil_values_with_empty_strings).equals false
   end
 
   context 'custom JSON engine configured as Symbol' do
@@ -44,4 +45,14 @@ context 'Rabl::Configuration' do
 
     asserts(:raise_on_missing_attribute).equals true
   end # raise on missing
+
+  context 'replace nil values with empty strings' do
+    setup do
+      Rabl.configure do |c|
+        c.replace_nil_values_with_empty_strings = true
+      end
+    end
+
+    asserts(:replace_nil_values_with_empty_strings).equals true
+  end # replace nil values with empty strings
 end

data/test/engine_test.rb

@@ -280,6 +280,31 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@user, User.new(:name => 'leo')
         template.render(scope)
       end.equals "{\"user\":{\"person\":{\"name\":\"leo\"}}}"
+
+      asserts "it sets root node for child collection" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(@users) { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        scope.instance_variable_set :@users, [User.new(:name => 'one', :city => 'UNO'), User.new(:name => 'two', :city => 'DOS')]
+        template.render(scope)
+      end.equals "{\"user\":{\"name\":\"leo\",\"users\":[{\"user\":{\"city\":\"UNO\"}},{\"user\":{\"city\":\"DOS\"}}]}}"
+
+      asserts "it allows suppression of root node for child collection" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(@users, :object_root => false) { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        scope.instance_variable_set :@users, [User.new(:name => 'one', :city => 'UNO'), User.new(:name => 'two', :city => 'DOS')]
+        template.render(scope)
+      end.equals "{\"user\":{\"name\":\"leo\",\"users\":[{\"city\":\"UNO\"},{\"city\":\"DOS\"}]}}"
+
     end
 
     context "#glue" do

data/test/models/user.rb

@@ -10,12 +10,10 @@ unless defined?(User)
     DEFAULT_HOBBIES  = ['Photography']
 
     def initialize(attributes={})
-      self.age     = attributes[:age]     || DEFAULT_AGE
-      self.city    = attributes[:city]    || DEFAULT_CITY
-      self.name    = attributes[:name]    || DEFAULT_NAME
-      self.first   = attributes[:first]   || DEFAULT_FIRST
-      self.float   = attributes[:float]   || DEFAULT_FLOAT
-      self.hobbies = (attributes[:hobbies] || DEFAULT_HOBBIES).map { |h| Hobby.new(h) }
+      %w(age city name first float hobbies).each do |attr|
+        self.send "#{attr}=", (attributes.has_key?(attr.to_sym) ? attributes[attr.to_sym] : self.class.const_get("DEFAULT_#{attr.upcase}"))
+      end
+      self.hobbies = self.hobbies.map { |h| Hobby.new(h) }
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -421,7 +421,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1400362274549242151
+      hash: -2073633213331132502
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -430,7 +430,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1400362274549242151
+      hash: -2073633213331132502
 requirements: []
 rubyforge_project: rabl
 rubygems_version: 1.8.25