rabl 0.7.6 → 0.7.7

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # CHANGELOG
 
-## 0.7.7 (unreleased)
+## 0.7.8 (unreleased)
+
+## 0.7.7
+
+  * Fix #344 to avoid: "warning: default `to_a' will be obsolete"
+  * Fix #356 by adding 'known object classes' like struct to be recognized as objects.
+  * Fix #354 by adding 'if' and 'unless' to `attribute` (Thanks @andrewhubbs)
 
 ## 0.7.6
 

data/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+We love pull requests. Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate: `bundle && rake test`
+
+3. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+4. Make the test pass.
+
+5. Push to your fork and submit a pull request.
+
+At this point you're waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation and README for anything affected by your contribution
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+* a = b and not a=b.
+* Follow the conventions you see used in the source already.
+
+And in case we didn't emphasize it enough: we love tests!
+
+NOTE: Adapted from https://raw.github.com/thoughtbot/factory_girl_rails/master/CONTRIBUTING.md

data/README.md

@@ -106,6 +106,7 @@ RABL is intended to require little to no configuration to get working. This is t
 
 ```ruby
 # config/initializers/rabl_init.rb
+require 'rabl'
 Rabl.configure do |config|
   # Commented as these are defaults
   # config.cache_all_output = false
@@ -253,6 +254,13 @@ attributes :bar => :baz, :dog => :animal
 # => # { baz : <bar value>, animal : <dog value> }
 ```
 
+or show attributes only if a condition is true:
+
+```ruby
+# m is the object being rendered, also supports :unless
+attributes :foo, :bar, :if => lambda { |m| m.condition? }
+```
+
 Named and aliased attributes can not be combined on the same line. This currently does not work:
 
 ```ruby
@@ -495,16 +503,19 @@ Rails and Padrino. I recommend a before_filter on that controller or directly sp
 ## Resources ##
 
 There are many resources available relating to RABL including the [RABL Wiki](https://github.com/nesquena/rabl/wiki),
-and many tutorials and guides detailed below.
+and many tutorials and guides detailed below. 
+You can check out the [RABL Site](http://nesquena.github.com/rabl) as well.
 
 ### Advanced Usage ###
 
 Links to resources for advanced usage:
 
+ * Production Speed Optimizations: https://github.com/nesquena/rabl/wiki/Rabl-In-Production
  * Grape Integration: https://github.com/nesquena/rabl/wiki/Using-Rabl-with-Grape
  * Rendering JSON for a tree structure using RABL: https://github.com/nesquena/rabl/issues/70
  * Layouts (erb, haml and rabl) in RABL: https://github.com/nesquena/rabl/wiki/Using-Layouts
  * Backbone or [Ember.js](http://www.emberjs.com) Integration: https://github.com/nesquena/rabl/wiki/Backbone-Integration
+ * RABL with Rails Engines: https://github.com/nesquena/rabl/wiki/Setup-rabl-with-rails-engines
 
 Please add your own usages and let me know so we can add them here! Also be sure to check out
 the [RABL Wiki](https://github.com/nesquena/rabl/wiki) for other usages.
@@ -531,6 +542,8 @@ Let me know if there's any other useful resources not listed here.
 There are other libraries that can either complement or extend the functionality of RABL:
 
  * [gon](https://github.com/gazay/gon) - Exposes your Rails variables in JS with RABL support integrated.
+ * [rabl-rails](https://github.com/ccocchi/rabl-rails) - Reimplementation for RABL and Rails 
+   [focused on speed](https://github.com/ccocchi/rabl-benchmark/blob/master/BENCHMARK).
 
 Let me know if there's any other related libraries not listed here.
 
@@ -581,6 +594,8 @@ Check out the patches for [msgpack support](https://github.com/nesquena/rabl/pul
 
 Please fork and contribute, any help in making this project better is appreciated!
 
+This project is a member of the [OSS Manifesto](http://ossmanifesto.org).
+
 ## Inspirations ##
 
 There are a few excellent libraries that helped inspire RABL and they are listed below:

data/fixtures/rails3_2/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rails', '~> 3.2.8'
+gem 'rails', '~> 3.2.9.rc3'
 
 # Bundle edge Rails instead:
 # gem 'rails', :git => 'git://github.com/rails/rails.git'

data/lib/rabl.rb

@@ -2,6 +2,7 @@ require 'active_support'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/reverse_merge'
+require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/hash/slice'
 
 require 'rabl/version'

data/lib/rabl/builder.rb

@@ -34,8 +34,8 @@ module Rabl
         extends(settings[:file], settings[:options], &settings[:block])
       end if @options.has_key?(:extends)
       # Attributes
-      @options[:attributes].each_pair do |attribute, name|
-        attribute(attribute, :as => name)
+      @options[:attributes].each_pair do |attribute, options|
+        attribute(attribute, options)
       end if @options.has_key?(:attributes)
       # Node
       @options[:node].each do |settings|
@@ -63,14 +63,16 @@ module Rabl
 
     # Indicates an attribute or method should be included in the json output
     # attribute :foo, :as => "bar"
+    # attribute :foo, :as => "bar", :if => lambda { |m| m.foo }
     def attribute(name, options={})
-      @_result[options[:as] || name] = data_object_attribute(name) if @_object && @_object.respond_to?(name)
+      if @_object && @_object.respond_to?(name) && resolve_condition(options)
+        @_result[options[:as] || name] = data_object_attribute(name)
+      end
     end
     alias_method :attributes, :attribute
 
     # Creates an arbitrary node that is included in the json output
     # node(:foo) { "bar" }
-    # node(:foo) { "bar" }
     # node(:foo, :if => lambda { |m| m.foo.present? }) { "bar" }
     def node(name, options={}, &block)
       return unless resolve_condition(options)

data/lib/rabl/engine.rb

@@ -135,7 +135,7 @@ module Rabl
       @_collection_name = options[:root] if options[:root]
       @_collection_name ||= data.values.first if data.respond_to?(:each_pair)
       @_object_root_name = options[:object_root] if options.has_key?(:object_root)
-      self.object(data_object(data).to_a)
+      self.object(Array(data_object(data)))
     end
 
     # Sets the cache key to be used by ActiveSupport::Cache.expand_cache_key
@@ -152,13 +152,15 @@ module Rabl
 
     # Indicates an attribute or method should be included in the json output
     # attribute :foo, :as => "bar"
-    # attribute :foo => :bar
+    # attribute :foo => :bar, :bar => :baz
+    # attribute :foo => :bar, :bar => :baz, :if => lambda { |r| r.foo }
     def attribute(*args)
       if args.first.is_a?(Hash) # :foo => :bar, :bar => :baz
-        args.first.each_pair { |k,v| self.attribute(k, :as => v) }
+        attr_aliases, conds = args.first.except(:if, :unless), args.first.slice(:if, :unless)
+        attr_aliases.each_pair { |k,v| self.attribute(k, conds.merge(:as => v)) }
       else # array of attributes i.e :foo, :bar, :baz
-        options = args.extract_options!
-        args.each { |name| @_options[:attributes][name] = options[:as] || name }
+        attr_options = args.extract_options!
+        args.each { |name| @_options[:attributes][name] = attr_options }
       end
     end
     alias_method :attributes, :attribute

data/lib/rabl/helpers.rb

@@ -2,6 +2,8 @@ require 'active_support/inflector' # for the sake of pluralizing
 
 module Rabl
   module Helpers
+    # Set of class names known to be objects, not collections
+    KNOWN_OBJECT_CLASSES = ['Struct']
 
     # data_object(data) => <AR Object>
     # data_object(@user => :person) => @user
@@ -55,12 +57,16 @@ module Rabl
     # is_object?([]) => false
     # is_object?({}) => false
     def is_object?(obj)
-      obj && (!data_object(obj).respond_to?(:map) || !data_object(obj).respond_to?(:each))
+      obj && (!data_object(obj).respond_to?(:map) || !data_object(obj).respond_to?(:each) ||
+       (KNOWN_OBJECT_CLASSES & obj.class.ancestors.map(&:name)).any?)
     end
 
     # Returns true if the obj is a collection of items
+    # is_collection?(@user) => false
+    # is_collection?([]) => true
     def is_collection?(obj)
-      obj && data_object(obj).respond_to?(:map) && data_object(obj).respond_to?(:each)
+      obj && data_object(obj).respond_to?(:map) && data_object(obj).respond_to?(:each) &&
+        (KNOWN_OBJECT_CLASSES & obj.class.ancestors.map(&:name)).empty?
     end
 
     # Returns the scope wrapping this engine, used for retrieving data, invoking methods, etc

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.7.6"
+  VERSION = "0.7.7"
 end

data/test/builder_test.rb

@@ -23,21 +23,21 @@ context "Rabl::Builder" do
 
   context "#to_hash" do
     context "when given a simple object" do
-      setup { builder({ :attributes => { :name => :name } }) }
+      setup { builder({ :attributes => { :name => {} } }) }
       asserts "that the object is set properly" do
         topic.build(User.new, :root_name => "user")
       end.equivalent_to({ "user" => { :name => "rabl" } })
     end
 
     context "when given an object alias" do
-     setup { builder({ :attributes => { :name => :name } }) }
+     setup { builder({ :attributes => { :name => { :as => :foo } } }) }
       asserts "that the object is set properly" do
         topic.build(User.new, :root_name => "person")
-      end.equivalent_to({ "person" => { :name => "rabl" } })
+      end.equivalent_to({ "person" => { :foo => "rabl" } })
     end
 
     context "when specified with no root" do
-      setup { builder({ :attributes => { :name => :name } }) }
+      setup { builder({ :attributes => { :name => { :as => :name } } }) }
       asserts "that the object is set properly" do
         topic.build(User.new, :root => false)
       end.equivalent_to({ :name => "rabl" })
@@ -46,7 +46,7 @@ context "Rabl::Builder" do
 
   context "#attribute" do
     asserts "that the node" do
-      build_hash @user, :attributes => { :name => :name, :city => :city }
+      build_hash @user, :attributes => { :name => {}, :city => { :as => :city } }
     end.equivalent_to({:name => 'rabl', :city => 'irvine'})
 
     asserts "that with a non-existent attribute the node" do

data/test/engine_test.rb

@@ -427,7 +427,62 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@user, User.new(:name => 'irvine')
         template.render(scope)
       end.equals "{\"city\":\"irvine\"}"
-    end
+
+      asserts "that it handle structs correctly as child elements" do
+        template = rabl %{
+          object @user
+          child(:city) do
+            attributes :name
+          end
+        }
+        City = Struct.new(:name)
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:city => City.new('San Francisco'))
+        template.render(scope)
+      end.equals "{\"city\":{\"name\":\"San Francisco\"}}"
+
+      asserts "that it can be passed an if cond for single real attr" do
+        template = rabl %{
+          object @user
+          attribute :name
+          attributes :age, :first, :if => lambda { |i| i.name != 'irvine' }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"name\":\"irvine\"}")
+
+      asserts "that it can be passed an if cond for aliased attrs" do
+        template = rabl %{
+          object @user
+          attributes :name => :title, :age => :year, :if => lambda { |i| i.name == 'irvine' }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"title\":\"irvine\",\"year\":24}")
+
+      asserts "that it can be passed an unless cond to hide attrs" do
+        template = rabl %{
+          object @user
+          attribute :name
+          attributes :age, :unless => lambda { |i| i.name == 'irvine' }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"name\":\"irvine\"}")
+
+      asserts "that it can be passed an unless cond for aliased attrs" do
+        template = rabl %{
+          object @user
+          attributes :name => :title, :age => :year, :unless => lambda { |i| i.name == 'irvine' }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{}")
+    end # attribute
 
     context "#code" do
       asserts "that it can create an arbitraty code node" do

data/test/helpers_test.rb

@@ -39,15 +39,20 @@ context "Rabl::Helpers" do
       @helper_class.is_object?(@user)
     end.equals(true)
 
-    # asserts "returns true for an object with each" do
-    #   obj = Class.new { def each; end }
-    #   @helper_class.is_object?(obj.new)
-    # end.equals(true)
+    asserts "returns true for an object with each" do
+      obj = Class.new { def each; end }
+      @helper_class.is_object?(obj.new)
+    end.equals(true)
 
     asserts "returns true for a hash alias" do
       @helper_class.is_object?(@user => :user)
     end.equals(true)
 
+    asserts "returns true for a struct" do
+      obj = Struct.new(:name)
+      @helper_class.is_object?(obj.new('foo'))
+    end.equals(true)
+
     asserts "returns false for an array" do
       @helper_class.is_object?([@user])
     end.equals(false)
@@ -58,14 +63,19 @@ context "Rabl::Helpers" do
       @helper_class.is_collection?(nil)
     end.equals(nil)
 
+    asserts "returns false for a struct" do
+      obj = Struct.new(:name)
+      @helper_class.is_collection?(obj.new('foo'))
+    end.equals(false)
+
     asserts "returns false for an object" do
       @helper_class.is_collection?(@user)
     end.equals(false)
 
-    # asserts "returns false for an object with each" do
-    #  obj = Class.new { def each; end }
-    #  @helper_class.is_collection?(obj.new)
-    # end.equals(false)
+    asserts "returns false for an object with each" do
+      obj = Class.new { def each; end }
+      @helper_class.is_collection?(obj.new)
+    end.equals(false)
 
     asserts "returns false for a hash alias" do
       @helper_class.is_collection?(@user => :user)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-30 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -181,6 +181,7 @@ files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.ci
 - MIT-LICENSE