rabl 0.0.9 → 0.1.0

data/README.md

@@ -1,21 +1,21 @@
 # RABL #
 
-RABL (Ruby API Builder Language) is a ruby templating system for Rails and [Padrino](http://padrinorb.com) that takes a new approach to generating JSON and other formats. Rather than using the ActiveRecord 'to_json', I generally find myself wanting a more expressive and powerful system for generating my APIs. This is especially important when the json representation is complex or doesn't match the exact schema defined in the database itself.
+RABL (Ruby API Builder Language) is a Rails and [Padrino](http://padrinorb.com) ruby templating system for generating JSON and XML. When using the ActiveRecord 'to_json' method, I tend to quickly find myself wanting a more expressive and powerful system for generating APIs. This is especially frustrating when the json representation is complex or doesn't match the exact schema defined in the database itself.
 
-There were a few things in particular I wanted to do easily:
+I wanted a simple, and flexible system for generating APIs. In particular, I wanted to easily:
 
  * Create arbitrary nodes named based on combining data in an object
- * Include nodes only if a certain condition is met
  * Pass arguments to methods and store the result as a child node
  * Partial templates and inheritance to reduce code duplication
  * Easily renaming attributes from their name in the model
  * Simple way to append attributes from a child into the parent
+ * Include nodes only if a certain condition is met
 
-The list goes on. Anyone who has used the 'to_json' approach used in ActiveRecord for generating a json response has felt the pain of the extremely restrictive system. RABL is a general templating system created to solve all of those problems. When I created RABL, I wanted a simple, expressive DRY ruby DSL for defining JSON responses for my APIs.
+Anyone who has tried the 'to_json' method used in ActiveRecord for generating a json response has felt the pain of this restrictive approach. RABL is a general templating system created to solve all of those problems.
 
 ## Installation ##
 
-Install as a gem:
+Install RABL as a gem:
 
     gem install rabl
 
@@ -26,7 +26,9 @@ or add to your Gemfile:
 
 and run `bundle install` to install the dependency.
 
-If you are using Rails 2.X or Padrino, RABL works without configuration. With Sinatra, or any other tilt-based framework, simply register:
+If you are using **Rails 2.X, Rails 3 or Padrino**, RABL works without configuration.
+
+With Sinatra, or any other tilt-based framework, simply register:
 
     Rabl.register!
 
@@ -153,11 +155,9 @@ Using partials and inheritance can significantly reduce code duplication in your
 Check out the [Issues](https://github.com/nesquena/rabl/issues) tab for a full list:
 
  * I am sloppy and failed to unit test this as I cobbled it together. Don't use it in production until I do, for now this is a fun experiment.
- * No support for Rails 3 yet, need a Railstie
  * No configuration options yet for how to create the json (root nodes) :(
  * Better Tilt template support (precompiling templates)
  * Benchmarks and performance optimizations
- * XML Support and potentially others
 
 ## Authors and Contributors ##
 

data/lib/rabl.rb

@@ -5,8 +5,7 @@ require 'rabl/builder'
 # Rabl.register!
 module Rabl
   def self.register!
-    require 'rabl/template' if defined?(Rails)
-    require 'rabl/register'
+    require 'rabl/template'
   end
 end
 
@@ -14,6 +13,8 @@ end
 if defined?(Padrino)
   require 'padrino-core'
   Padrino.after_load { Rabl.register! }
-else
+elsif defined?(Rails) && Rails.version =~ /^2/
+  Rabl.register!
+elsif defined?(Rails) && Rails.version =~ /^3/
   Rabl.register!
 end

data/lib/rabl/builder.rb

@@ -31,7 +31,7 @@ module Rabl
         extends(settings[:file], settings[:options], &settings[:block])
       end if @options.has_key?(:extends)
 
-      @_root_name ||= @_object.class.model_name.element
+      @_root_name ||= data_name(@_object)
       (@options[:root] || options[:root]) ? { @_root_name => @_result } : @_result
     end
 
@@ -106,8 +106,7 @@ module Rabl
     # data_name(@users) => :user
     def data_name(data)
       return data.values.first if data.is_a?(Hash)
-      return data.first.class.model_name.element.pluralize if data.respond_to?(:first) && data.first.respond_to?(:valid?)
-      data.class.model_name.element
+      @options[:engine].model_name(data)
     end
 
     # resolve_condition(:if => true) => true

data/lib/rabl/engine.rb

@@ -17,7 +17,7 @@ module Rabl
       @_object = locals[:object] || self.default_object
       instance_eval(@_source) if @_source.present?
       instance_eval(&block) if block_given?
-      self.send("to_" + @_options[:format])
+      self.send("to_" + @_options[:format].to_s)
     end
 
     # Sets the object to be used as the data source for this template
@@ -93,11 +93,11 @@ module Rabl
       to_hash(options).to_json
     end
 
-    # Returns a hash based representation of any data object given ejs template block
-    # object_to_hash(@user) { attribute :full_name } => { ... }
-    def object_to_hash(object, source=nil, &block)
-      return object unless is_record?(object) || is_record?(object.respond_to?(:first) && object.first)
-      self.class.new(source, :format => "hash", :root => false).render(@_scope, :object => object, &block)
+    # Returns a json representation of the data object
+    # to_xml(:root => true)
+    def to_xml(options={})
+      options = options.reverse_merge(:root => false)
+      to_hash(options).to_xml(:root => model_name(@_object))
     end
 
     # Includes a helper module for RABL
@@ -107,6 +107,24 @@ module Rabl
     end
     alias_method :helpers, :helper
 
+    # Returns a hash based representation of any data object given ejs template block
+    # object_to_hash(@user) { attribute :full_name } => { ... }
+    def object_to_hash(object, source=nil, &block)
+      return object unless is_record?(object) || object.respond_to?(:each)
+      self.class.new(source, :format => "hash", :root => false).render(@_scope, :object => object, &block)
+    end
+
+    # model_name(@user) => "user"
+    # model_name([@user]) => "user"
+    # model_name([]) => "array"
+    def model_name(data)
+      if data.respond_to?(:first) && data.first.respond_to?(:valid?)
+        model_name(data.first).pluralize
+      else # actual data object
+        data.class.respond_to?(:model_name) ? data.class.model_name.element : data.class.to_s.downcase
+      end
+    end
+
     protected
 
     # Returns a guess at the default object for this template

data/lib/rabl/template.rb

@@ -1,19 +1,64 @@
-# Rails Template
+# TILT Template
+if defined?(Tilt)
+  class RablTemplate < Tilt::Template
+    def initialize_engine
+      return if defined?(::Rabl)
+      require_template_library 'rabl'
+    end
+
+    def prepare
+      options = @options.merge(:format => "json")
+      @engine = ::Rabl::Engine.new(data, options)
+    end
+
+    def evaluate(scope, locals, &block)
+      @engine.render(scope, locals, &block)
+    end
+  end
+
+  Tilt.register 'rabl', RablTemplate
+end
 
-require 'action_view/base'
-require 'action_view/template'
+# Rails 2.X Template
+if defined?(Rails) && Rails.version =~ /^2/
+  require 'action_view/base'
+  require 'action_view/template'
 
-module ActionView
-  module TemplateHandlers
-    class RablHandler < TemplateHandler
-      include Compilable
+  module ActionView
+    module TemplateHandlers
+      class RablHandler < TemplateHandler
+        include Compilable
 
-      def compile(template) %{
-        ::Rabl::Engine.new(#{template.source.inspect}, { :format => #{template.format.inspect} }).
-          render(self, assigns.merge(local_assigns))
-      } end
+        def compile(template) %{
+          ::Rabl::Engine.new(#{template.source.inspect}, { :format => #{template.format.inspect} }).
+            render(self, assigns.merge(local_assigns))
+        } end
+      end
     end
   end
+
+  ActionView::Template.register_template_handler :rabl, ActionView::TemplateHandlers::RablHandler
 end
 
-ActionView::Template.register_template_handler :rabl, ActionView::TemplateHandlers::RablHandler
+# Rails 3.X Template
+if defined?(Rails) && Rails.version =~ /^3/
+  require 'action_view/base'
+  require 'action_view/template'
+
+  module ActionView
+    module Template::Handlers
+      class RablHandler < Template::Handler
+        include Compilable
+
+        self.default_format = Mime::JSON
+
+        def compile(template) %{
+          ::Rabl::Engine.new(#{template.source.inspect}, { :format => #{template.formats.first.inspect} }).
+            render(self, assigns.merge(local_assigns))
+        } end
+      end
+    end
+  end
+
+  ActionView::Template.register_template_handler :rabl, ActionView::TemplateHandlers::RablHandler
+end

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rabl
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -70,7 +70,6 @@ files:
 - lib/rabl.rb
 - lib/rabl/builder.rb
 - lib/rabl/engine.rb
-- lib/rabl/register.rb
 - lib/rabl/template.rb
 - lib/rabl/version.rb
 - rabl.gemspec

data/lib/rabl/register.rb

@@ -1,20 +0,0 @@
-## TILT ##
-if defined?(Tilt)
-  class RablTemplate < Tilt::Template
-    def initialize_engine
-      return if defined?(::Rabl)
-      require_template_library 'rabl'
-    end
-
-    def prepare
-      options = @options.merge(:format => "json")
-      @engine = ::Rabl::Engine.new(data, options)
-    end
-
-    def evaluate(scope, locals, &block)
-      @engine.render(scope, locals, &block)
-    end
-  end
-
-  Tilt.register 'rabl', RablTemplate
-end