bldr 0.2.0 → 0.3.0

data/.travis.yml

@@ -1,6 +1,5 @@
 rvm:
   - 1.8.7
-  - 1.9.1
   - 1.9.2
   - ree
   - ruby-head

data/README.md

@@ -290,6 +290,24 @@ get '/posts' do
 end
 ```
 
+### Custom Handlers
+
+Bldr supports the definition of custom handlers, based on the class of specific
+values in the result. You would make use of this to define how specific classes
+are rendered by Bldr at a global level.
+
+For example, the `BSON::ObjectId` class defines `to_json` and `as_json` methods
+that produce a result like the following: `{"$oid": "4e77a682364141ecf5000002"}`.
+If you wanted to over-ride this default format, you could do so by defining a
+custom handler:
+
+```ruby
+# place in a file that get's loaded before your application code
+Bldr.handler BSON::ObjectId do |val|
+  val.to_s # => "4e77a682364141ecf5000002"
+end
+```
+
 ## Editor Syntax Support
 
 To get proper syntax highlighting in vim, add this line to your .vimrc:

data/lib/bldr.rb

@@ -8,8 +8,29 @@ require 'bldr/node'
 
 module Bldr
   class << self
+
     def json_encoder=(encoder)
       MultiJson.engine = encoder
     end
+
+    # Define a custom handler.
+    #
+    # @example Over-riding BSON::ObjectId
+    #   Bldr.handler BSON::ObjectId do |value|
+    #     val.to_s # => "4e77a682364141ecf5000002"
+    #   end
+    #
+    # @param [Class] klass The klass name of the class to match
+    # @param [Proc] block The code to execute to properly format the data
+    def handler(klass,&block)
+      raise(ArgumentError, "You must pass a Proc") if block.nil?
+      raise(ArgumentError, "You must pass only one argument to the Proc") unless block.arity == 1
+
+      handlers[klass] = block
+    end
+
+    def handlers
+      @handlers ||= {}
+    end
   end
 end

data/lib/bldr/engine.rb

@@ -7,6 +7,7 @@ module Bldr
     def initialize(template, options = {})
       @template, @options = template, options
       @result   = {}
+      @handlers = {}
     end
 
   end

data/lib/bldr/node.rb

@@ -177,14 +177,24 @@ module Bldr
     # Merges values into the "local" result hash.
     def merge_result!(key, val)
       if key
-        result[key] = val
+        result[key] = massage_value(val)
       else
-        result.merge!(val)
+        result.merge!(massage_value(val))
       end
     end
 
     def append_result!(key, val)
-      result[key] << val
+      result[key] << massage_value(val)
+    end
+
+    # put any specializations in here
+    # @todo: add config handlers to specify your own overridable Class->lambda methods of serialization
+    def massage_value(val)
+      if block = Bldr.handlers[val.class]
+        return block.call(val)
+      else
+        val
+      end
     end
 
   end

data/lib/bldr/version.rb

@@ -1,4 +1,4 @@
 
 module Bldr
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/perf/bench

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+output = `ruby -r bench_press ./benchmark.rb`
+
+results = File.open(File.expand_path(File.dirname(__FILE__)) + "/results.txt", "a") do |f|
+  f.puts "\n"
+  f.puts "=" * 80
+  f.puts "Spec run time: #{Time.now}"
+  f.puts "Git SHA: #{`cat ../.git/\`cat ../.git/HEAD | awk '{print $2}'\``.chomp}"
+  f.puts "Latest Tag: #{`git tag | tail -n 1`}"
+  f.puts output
+end

data/perf/benchmark.rb

@@ -0,0 +1,30 @@
+require 'benchmark'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/bldr')
+
+class Person
+  attr_reader :name
+  def initialize(name)
+    @name = name
+  end
+end
+
+Benchmark.bm(20) do |bm|
+  i = 1000
+  $guy = Person.new "john"
+  $friends = [Person.new("jim"), Person.new("bob")]
+  puts "i = #{i}"
+
+  bm.report "node with collection" do
+    i.times do
+      Bldr::Node.new do
+        object :dude => $guy do
+          attributes :name
+
+          collection :friends => $friends do
+            attributes :name
+          end
+        end
+      end
+    end
+  end
+end

data/perf/results.txt

@@ -0,0 +1,16 @@
+
+================================================================================
+Spec run time: 2011-09-09 11:57:07 -0700
+Git SHA: e74a003d8653a4b6cfe0f14e043c554e636f55b5
+Latest Tag: v0.2.0
+                          user     system      total        real
+i = 1000
+node with collection  0.080000   0.000000   0.080000 (  0.076949)
+
+================================================================================
+Spec run time: 2011-09-19 13:48:53 -0700
+Git SHA: 09214bfe2c38107ba68dd4c14f17e81d4f5bef72
+Latest Tag: v0.2.0
+                          user     system      total        real
+i = 1000
+node with collection  0.070000   0.010000   0.080000 (  0.076655)

data/spec/functional/handlers_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe "Defining different types of handlers" do
+
+  describe "Time" do
+    it "uses the handler for Time when rendering" do
+      Bldr.handler Time do |time|
+        "bar"
+      end
+
+      output = "{\"foo\":\"bar\"}"
+      node = Bldr::Node.new do
+        object { attribute(:foo) { Time.now } }
+      end
+
+      node.to_json.should == output
+    end
+  end
+
+end

data/spec/functional/tilt_template_spec.rb

@@ -31,6 +31,17 @@ describe "evaluating a tilt template" do
     })
   end
 
+  it "renders nil -> null correctly" do
+    alex = Person.new('alex')
+    tpl = Bldr::Template.new {
+      <<-RUBY
+        object(:person_1 => alex) { attributes(:age) }
+      RUBY
+    }
+    result = tpl.render(Bldr::Node.new, :alex => alex)
+    result.should == %%{"person_1":{"age":null}}%
+  end
+
   describe "root Object nodes" do
 
     let(:alex) { Person.new('alex', 25) }
@@ -66,6 +77,19 @@ describe "evaluating a tilt template" do
       }
     end
 
+    it "renders nil -> null correctly" do
+      alex = Person.new('alex')
+      tpl = Bldr::Template.new {
+        <<-RUBY
+          object :person_1 => alex do
+            attributes(:age)
+          end
+        RUBY
+      }
+      result = tpl.render(Bldr::Node.new, :alex => alex)
+      result.should == %%{"person_1":{"age":null}}%
+    end
+
   end
 
   describe "root Collection nodes" do

data/spec/spec_helper.rb

@@ -32,4 +32,9 @@ RSpec.configure do |c|
     result.should == jsonify(hash)
   end
 
+  c.after do
+    Bldr.handlers.clear
+  end
+
+
 end

data/spec/unit/bldr_spec.rb

@@ -14,4 +14,54 @@ describe "the json encoding library" do
     Bldr.json_encoder = :json_gem
     MultiJson.engine.should == MultiJson::Engines::JsonGem
   end
+
+end
+
+describe "defining custom handlers" do
+
+  describe "erroneously" do
+
+    it "errors when you don't pass a class arg" do
+      expect {
+        Bldr.handler {|foo| 'foo' }
+      }.to raise_error(ArgumentError)
+    end
+
+    it "errors when you don't pass a block" do
+      expect {
+        Bldr.handler(Object)
+      }.to raise_error(ArgumentError, "You must pass a Proc")
+    end
+
+    it "errors when no args are passed to the block" do
+      expect {
+        Bldr.handler(Object) do
+        end
+      }.to raise_error(ArgumentError, "You must pass only one argument to the Proc")
+    end
+
+    it "errors when 2 args are passed to the block" do
+      expect {
+        Bldr.handler(Object) do |one,two|
+        end
+      }.to raise_error(ArgumentError, "You must pass only one argument to the Proc")
+    end
+
+  end
+
+  describe "successfully" do
+
+    it "adds the handler to the collection for the specific Class" do
+      Bldr.handler(Object) {|o|}
+      Bldr.handlers[Object].should respond_to(:call)
+    end
+
+    it "assigns the lambda passed in" do
+      code = lambda {|foo| "foo" }
+      Bldr.handler(Time,&code)
+      Bldr.handlers[Time].should == code
+    end
+
+  end
+
 end

data/spec/unit/node_spec.rb

@@ -71,6 +71,10 @@ describe "Node#object" do
           }
         }.to raise_error(ArgumentError, ERROR_MESSAGES[:attribute_inferred_missing_arity_too_large])
       end
+      it "should render null attributes to null, not 'null'" do
+        node = wrap { attribute(:name, nil) }
+        node.render!.should == {:name => nil}
+      end
 
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bldr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-09 00:00:00.000000000Z
+date: 2011-09-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2152503360 !ruby/object:Gem::Requirement
+  requirement: &2153229880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *2152503360
+  version_requirements: *2153229880
 - !ruby/object:Gem::Dependency
   name: json_pure
-  requirement: &2152533900 !ruby/object:Gem::Requirement
+  requirement: &2153229460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152533900
+  version_requirements: *2153229460
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2152533360 !ruby/object:Gem::Requirement
+  requirement: &2153228920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.6
   type: :development
   prerelease: false
-  version_requirements: *2152533360
+  version_requirements: *2153228920
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &2152532860 !ruby/object:Gem::Requirement
+  requirement: &2153228420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *2152532860
+  version_requirements: *2153228420
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2152532480 !ruby/object:Gem::Requirement
+  requirement: &2153228040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152532480
+  version_requirements: *2153228040
 description: Provides a simple and intuitive templating DSL for serializing objects
   to JSON.
 email:
@@ -89,8 +89,12 @@ files:
 - lib/bldr/template.rb
 - lib/bldr/version.rb
 - lib/sinatra/bldr.rb
+- perf/bench
+- perf/benchmark.rb
+- perf/results.txt
 - spec/fixtures/nested_objects.json.bldr
 - spec/fixtures/root_template.json.bldr
+- spec/functional/handlers_spec.rb
 - spec/functional/tilt_template_spec.rb
 - spec/integration/sinatra_spec.rb
 - spec/models/comment.rb
@@ -126,6 +130,7 @@ summary: Templating library with a simple, minimalist DSL.
 test_files:
 - spec/fixtures/nested_objects.json.bldr
 - spec/fixtures/root_template.json.bldr
+- spec/functional/handlers_spec.rb
 - spec/functional/tilt_template_spec.rb
 - spec/integration/sinatra_spec.rb
 - spec/models/comment.rb