rabl 0.0.4 → 0.0.5

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
 .bundle
+.rvmrc
 Gemfile.lock
 pkg/*

data/README.md

@@ -25,6 +25,12 @@ or add to your Gemfile:
 
 and run `bundle install` to install the dependency.
 
+If you are using Rails 2.X or Padrino, RABL works out of the box. With Sinatra, or any other tilt-based framework, simply register:
+
+    Rabl.register!
+
+and RABL will be initialized.
+
 ## Usage ##
 
 ### Object Assignment ###

data/Rakefile

@@ -1,2 +1,10 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+  test.ruby_opts = ['-rubygems']
+end

data/lib/rabl.rb

@@ -1,8 +1,19 @@
 require 'rabl/version'
 require 'rabl/engine'
 require 'rabl/builder'
-require 'rabl/template' if defined?(Rails)
 
+# Rabl.register!
 module Rabl
-  # Nothing yet
+  def self.register!
+    require 'rabl/template' if defined?(Rails)
+    require 'rabl/register'
+  end
 end
+
+# Register
+if defined?(Padrino)
+  require 'padrino-core'
+  Padrino.after_load { Rabl.register! }
+else
+  Rabl.register!
+end

data/lib/rabl/builder.rb

@@ -32,7 +32,7 @@ module Rabl
       end if @options.has_key?(:extends)
 
       @_root_name ||= @_object.class.model_name.element
-      options[:root] ? { @_root_name => @_result } : @_result
+      (@options[:root] || options[:root]) ? { @_root_name => @_result } : @_result
     end
 
     # Indicates an attribute or method should be included in the json output
@@ -74,18 +74,11 @@ module Rabl
       @_result.merge!(glued_attributes)
     end
 
-    # Renders a partial hash based on another rabl template
-    # partial("users/show", :object => @user)
-    def partial(file, options={}, &block)
-      source = File.read(Rails.root.join("app/views/" + file + ".json.rabl"))
-      self.object_to_hash(options[:object], source, &block)
-    end
-
     # Extends an existing rabl template with additional attributes in the block
     # extends("users/show") { attribute :full_name }
     def extends(file, options={}, &block)
       options = options.merge!(:object => @_object)
-      result = partial(file, options, &block)
+      result = @options[:engine].partial(file, options, &block)
       @_result.merge!(result)
     end
 
@@ -110,7 +103,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.first.is_a?(ActiveRecord::Base)
+      return data.first.class.model_name.element.pluralize if data.respond_to?(:first) && data.first.respond_to?(:valid?)
       data.class.model_name.element
     end
   end

data/lib/rabl/engine.rb

@@ -1,15 +1,23 @@
 module Rabl
   class Engine
     # Constructs a new ejs engine based on given vars, handler and declarations
-    def initialize(vars, handler, source_string=nil, &block)
-      @_vars = vars
-      @_handler = handler
-      @_options = { :handler => @_handler, :vars => @_vars, :engine => self }
-      self.copy_instance_variables_from(@_handler, [:@assigns, :@helpers]);
-      @_object = vars[:object] || self.default_object
-      # raise @user.inspect + " - " + @_handler.instance_variable_get(:@options).inspect + " - " + @_handler.inspect
-      instance_eval(source_string) if source_string.present?
+    # Rabl::Engine.new("...source...", { :format => "xml" })
+    def initialize(source, options={})
+      @_source = source
+      @_options = options.reverse_merge(:format => "json")
+    end
+
+    # Renders the representation based on source, object, scope and locals
+    # Rabl::Engine.new("...source...", { :format => "xml" }).render(scope, { :foo => "bar", :object => @user })
+    def render(scope, locals, &block)
+      @_locals = locals
+      @_scope = scope
+      @_options = @_options.merge(:scope => @_scope, :locals => @_locals, :engine => self)
+      self.copy_instance_variables_from(@_scope, [:@assigns, :@helpers]);
+      @_object = locals[:object] || self.default_object
+      instance_eval(@_source) if @_source.present?
       instance_eval(&block) if block_given?
+      self.send("to_" + @_options[:format])
     end
 
     # Sets the object to be used as the data source for this template
@@ -63,14 +71,14 @@ module Rabl
     # Renders a partial hash based on another rabl template
     # partial("users/show", :object => @user)
     def partial(file, options={}, &block)
-      source = File.read(Rails.root.join("app/views/" + file + ".json.rabl"))
+      source = self.fetch_source(file)
       self.object_to_hash(options[:object], source, &block)
     end
 
     # Returns a hash representation of the data object
     # to_hash(:root => true)
     def to_hash(options={})
-      if @_object.is_a?(ActiveRecord::Base)
+      if is_record?(@_object)
         Rabl::Builder.new(@_object, @_options).to_hash(options)
       elsif @_object.respond_to?(:each)
         @_object.map { |object| Rabl::Builder.new(object, @_options).to_hash(options) }
@@ -80,24 +88,39 @@ module Rabl
     # Returns a json representation of the data object
     # to_json(:root => true)
     def to_json(options={})
-      options.reverse_merge!(:root => true)
+      options = options.reverse_merge(:root => true)
       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 object.is_a?(ActiveRecord::Base) || object.first.is_a?(ActiveRecord::Base)
-      self.class.new(@_vars.merge(:object => object), @_handler, source, &block).to_hash(:root => false)
+      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)
     end
 
     protected
 
     # Returns a guess at the default object for this template
     def default_object
-      @_handler.respond_to?(:controller) ?
-        instance_variable_get("@#{@_handler.controller.controller_name}") :
+      @_scope.respond_to?(:controller) ?
+        instance_variable_get("@#{@_scope.controller.controller_name}") :
         nil
     end
+
+    # Returns true if item is a ORM record; false otherwise
+    def is_record?(obj)
+      obj && obj.respond_to?(:valid?)
+    end
+
+    # Returns source for a given relative file
+    # fetch_source("show") => "...contents..."
+    def fetch_source(file)
+      root_path = Rails.root if defined?(Rails)
+      root_path = Padrino.root if defined?(Padrino)
+      view_path = File.join(root_path, "app/views/")
+      file_path = Dir[File.join(view_path, file + "*.rabl")].first
+      File.read(file_path) if file_path
+    end
   end
 end

data/lib/rabl/register.rb

@@ -0,0 +1,20 @@
+## 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

data/lib/rabl/template.rb

@@ -1,3 +1,5 @@
+# Rails Template
+
 require 'action_view/base'
 require 'action_view/template'
 
@@ -7,9 +9,8 @@ module ActionView
       include Compilable
 
       def compile(template) %{
-        ::Rabl::Engine.new(assigns.merge(local_assigns), self) do
-          #{template.source}
-        end.to_#{template.format}
+        ::Rabl::Engine.new(#{template.source.inspect}, { :format => #{template.format.inspect} }).
+          render(self, assigns.merge(local_assigns))
       } end
     end
   end

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/rabl.gemspec

@@ -18,4 +18,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_development_dependency 'riot', '~>0.12.3'
+  s.add_development_dependency 'rr', '~>1.0.2'
 end

data/test.watchr

@@ -0,0 +1,48 @@
+ENV["WATCHR"] = "1"
+system 'clear'
+
+def run(cmd)
+  puts(cmd)
+  system cmd
+end
+
+def run_test_file(file)
+  system('clear')
+  run(%Q(ruby -I"lib:test" -rubygems #{file}))
+end
+
+def run_all_tests
+  system('clear')
+  run('rake test')
+end
+
+def related_test_files(path)
+  Dir['test/**/*.rb'].select { |file| file =~ /#{File.basename(path).split(".").first}_test.rb/ }
+end
+
+watch('test/teststrap\.rb') { run_all_tests }
+watch('test/(.*).*_test\.rb') { |m| run_test_file(m[0]) }
+watch('lib/.*/.*\.rb') { |m| related_test_files(m[0]).map {|tf| run_test_file(tf) } }
+
+# Ctrl-\
+Signal.trap 'QUIT' do
+  puts " --- Running all tests ---\n\n"
+  run_all_tests
+end
+
+@interrupted = false
+
+# Ctrl-C
+Signal.trap 'INT' do
+  if @interrupted then
+    @wants_to_quit = true
+    abort("\n")
+  else
+    puts "Interrupt a second time to quit"
+    @interrupted = true
+    Kernel.sleep 1.5
+    # raise Interrupt, nil # let the run loop catch it
+    run_all_tests
+  end
+end
+

data/test/builder_test.rb

@@ -0,0 +1 @@
+require File.expand_path('../teststrap',__FILE__)

data/test/engine_test.rb

@@ -0,0 +1,2 @@
+require File.expand_path('../teststrap',__FILE__)
+

data/test/template_test.rb

@@ -0,0 +1,2 @@
+require File.expand_path('../teststrap',__FILE__)
+

data/test/teststrap.rb

@@ -0,0 +1,11 @@
+require 'riot'
+require 'riot/rr'
+require File.expand_path('../../lib/rabl',__FILE__)
+
+Riot.pretty_dots
+
+class Riot::Situation
+end
+
+class Riot::Context
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rabl
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -16,8 +16,39 @@ bindir: bin
 cert_chain: []
 
 date: 2011-04-12 00:00:00 Z
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 41
+        segments: 
+        - 0
+        - 12
+        - 3
+        version: 0.12.3
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :development
+  version_requirements: *id002
 description: General ruby templating for json or xml
 email: 
 - nesquena@gmail.com
@@ -35,9 +66,15 @@ 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
+- test.watchr
+- test/builder_test.rb
+- test/engine_test.rb
+- test/template_test.rb
+- test/teststrap.rb
 homepage: https://github.com/nesquena/rabl
 licenses: []
 
@@ -71,5 +108,8 @@ rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: General ruby templating for json or xml
-test_files: []
-
+test_files: 
+- test/builder_test.rb
+- test/engine_test.rb
+- test/template_test.rb
+- test/teststrap.rb