tokamak 1.0.0.beta2 → 1.0.0.beta4

data/test/tokamak/builder/json_test.rb

@@ -0,0 +1,227 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class Tokamak::Builder::JsonTest < Test::Unit::TestCase
+
+  def test_media_type_should_be_json
+    assert_equal ["application/json"], Tokamak::Builder::Json.media_types
+  end
+  
+  def test_the_most_simple_json
+    obj = [{ :foo => "bar" }]
+    json = Tokamak::Builder::Json.build(obj) do |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+      
+      collection.members do |member, some_foos|
+        member.values do |values|
+          values.id some_foos[:foo]
+        end        
+      end
+    end
+    
+    hash = JSON.parse(json).extend(Methodize)
+    
+    assert_equal "an_id", hash.id
+    assert_equal "bar"  , hash.members.first.id
+  end
+
+  def test_root_set_on_builder
+    obj = [{ :foo => "bar" }, { :foo => "zue" }]
+    json = Tokamak::Builder::Json.build(obj, :root => "foos") do |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+      
+      collection.members do |member, some_foos|
+        member.values do |values|
+          values.id some_foos[:foo]
+        end        
+      end
+    end
+    
+    hash = JSON.parse(json).extend(Methodize)
+    
+    assert hash.has_key?("foos")
+    assert_equal "an_id", hash.foos.id
+    assert_equal "bar"  , hash.foos.members.first.id
+  end
+  
+  def test_collection_set_on_members
+    obj = { :foo => "bar" }
+    a_collection = [1,2,3,4]
+    json = Tokamak::Builder::Json.build(obj) do |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+      
+      collection.members(:collection => a_collection) do |member, number|
+        member.values do |values|
+          values.id number
+        end        
+      end
+    end
+    
+    hash = JSON.parse(json).extend(Methodize)
+    
+    assert_equal "an_id", hash.id
+    assert_equal 1      , hash.members.first.id
+    assert_equal 4      , hash.members.size
+  end
+  
+  def test_raise_exception_for_not_passing_a_collection_as_parameter_to_members
+    obj = 42
+    
+    assert_raise Tokamak::BuilderError do
+      json = Tokamak::Builder::Json.build(obj) do |collection, number|
+        collection.values do |values|
+          values.id number
+        end
+      
+        collection.members do |member, item|
+          member.values do |values|
+            values.id item
+          end        
+        end
+      end
+    end
+  end
+
+  def test_root_set_on_members
+    obj = [{ :foo => "bar" }, { :foo => "zue" }]
+    json = Tokamak::Builder::Json.build(obj) do |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+      
+      collection.members(:root => "foos") do |member, some_foos|
+        member.values do |values|
+          values.id some_foos[:foo]
+        end        
+      end
+    end
+    
+    hash = JSON.parse(json).extend(Methodize)
+    
+    assert_equal "an_id", hash.id
+    assert_equal "bar"  , hash.foos.first.id
+    assert_equal 2      , hash.foos.size
+  end
+  
+  def test_nested_crazy_values
+    obj = [{ :foo => "bar" }, { :foo => "zue" }]
+    json = Tokamak::Builder::Json.build(obj) do |collection|
+      collection.values do |values|
+        values.body {
+          values.face {
+            values.eyes  "blue"
+            values.mouth "large"
+          }
+          values.legs [
+            { :right => { :fingers_count => 5 } }, { :left => { :fingers_count => 4 } }
+          ]
+        }
+      end
+    end
+    
+    hash = JSON.parse(json).extend(Methodize)
+    
+    assert_equal "blue" , hash.body.face.eyes
+    assert_equal "large", hash.body.face.mouth
+    assert_equal 2      , hash.body.legs.count
+    assert_equal 4      , hash.body.legs.last.left.fingers_count
+  end
+
+  def test_build_full_collection
+    time = Time.now
+    some_articles = [
+      {:id => 1, :title => "a great article", :updated => time},
+      {:id => 2, :title => "another great article", :updated => time}
+    ]
+    
+    json = Tokamak::Builder::Json.build(some_articles) do |collection|
+      collection.values do |values|
+        values.id      "http://example.com/json"
+        values.title   "Feed"
+        values.updated time
+
+        values.author { 
+          values.name  "John Doe"
+          values.email "joedoe@example.com"
+        }
+        
+        values.author { 
+          values.name  "Foo Bar"
+          values.email "foobar@example.com"
+        }
+      end
+      
+      collection.link("next"    , "http://a.link.com/next")
+      collection.link("previous", "http://a.link.com/previous")
+      
+      collection.members(:root => "articles") do |member, article|
+        member.values do |values|
+          values.id      "uri:#{article[:id]}"                   
+          values.title   article[:title]
+          values.updated article[:updated]              
+        end
+        
+        member.link("image", "http://example.com/image/1")
+        member.link("image", "http://example.com/image/2", :type => "application/json")
+      end
+    end
+
+    hash = JSON.parse(json)
+    hash.extend(Methodize)
+    
+    assert_equal "John Doe"               , hash.author.first.name
+    assert_equal "foobar@example.com"     , hash.author.last.email
+    assert_equal "http://example.com/json", hash.id
+    
+    assert_equal "http://a.link.com/next" , hash.link.first.href
+    assert_equal "next"                   , hash.link.first.rel
+    assert_equal "application/json"       , hash.link.last.type
+    
+    assert_equal "uri:1"                      , hash.articles.first.id
+    assert_equal "a great article"            , hash.articles.first.title
+    assert_equal "http://example.com/image/1" , hash.articles.last.link.first.href
+    assert_equal "image"                      , hash.articles.last.link.first.rel
+    assert_equal "application/json"           , hash.articles.last.link.last.type
+  end
+
+  def test_build_full_member
+    time = Time.now
+    an_article = {:id => 1, :title => "a great article", :updated => time}
+    
+    json = Tokamak::Builder::Json.build(an_article, :root => "article") do |member, article|
+      member.values do |values|
+        values.id      "uri:#{article[:id]}"           
+        values.title   article[:title]
+        values.updated article[:updated]
+        
+        values.domain("xmlns" => "http://a.namespace.com") {
+          member.link("image", "http://example.com/image/1")
+          member.link("image", "http://example.com/image/2", :type => "application/atom+xml")
+        }
+      end
+      
+      member.link("image", "http://example.com/image/1")
+      member.link("image", "http://example.com/image/2", :type => "application/json")                                
+    end
+    
+    hash = JSON.parse(json)
+    hash.extend(Methodize)
+        
+    assert_equal "uri:1"                      , hash.article.id
+    assert_equal "a great article"            , hash.article.title
+    assert_equal "http://example.com/image/1" , hash.article.link.first.href
+    assert_equal "image"                      , hash.article.link.first.rel
+    assert_equal "application/json"           , hash.article.link.first.type
+    
+    assert_equal "http://example.com/image/1" , hash.article.domain.link.first.href
+    assert_equal "image"                      , hash.article.domain.link.first.rel
+    assert_equal "application/json"           , hash.article.domain.link.first.type
+    assert_equal "http://a.namespace.com"     , hash.article.domain.xmlns
+  end
+end
+

data/test/tokamak/builder/xml_test.rb

@@ -0,0 +1,254 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class Tokamak::Builder::XmlTest < Test::Unit::TestCase
+
+  def test_media_type_should_be_xml
+    assert_equal ["application/xml","text/xml"], Tokamak::Builder::Xml.media_types
+  end
+
+  def test_the_most_simple_xml
+    obj = [{ :foo => "bar" }]
+    xml = Tokamak::Builder::Xml.build(obj) do |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+
+      collection.members do |member, some_foos|
+        member.values do |values|
+          values.id some_foos[:foo]
+        end
+      end
+    end
+
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "root" , xml.root.name
+    assert_equal "an_id", xml.css("root id").first.text
+    assert_equal "bar"  , xml.css("root > member > id").first.text
+  end
+
+  def test_root_set_on_builder
+    obj = [{ :foo => "bar" }, { :foo => "zue" }]
+    xml = Tokamak::Builder::Xml.build(obj, :root => "foos") do |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+
+      collection.members do |member, some_foos|
+        member.values do |values|
+          values.id some_foos[:foo]
+        end
+      end
+    end
+
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "foos" , xml.root.name
+    assert_equal "an_id", xml.css("foos id").first.text
+    assert_equal "bar"  , xml.css("foos > member > id").first.text
+  end
+
+  def test_collection_set_on_members
+    obj = { :foo => "bar" }
+    a_collection = [1,2,3,4]
+    xml = Tokamak::Builder::Xml.build(obj) do |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+
+      collection.members(:collection => a_collection) do |member, number|
+        member.values do |values|
+          values.id number
+        end
+      end
+    end
+
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "an_id", xml.css("root id").first.text
+    assert_equal "1"    , xml.css("root > member > id").first.text
+    assert_equal 4      , xml.css("root > member > id").size
+  end
+
+  def test_raise_exception_for_not_passing_a_collection_as_parameter_to_members
+    obj = 42
+
+    assert_raise Tokamak::BuilderError do
+      json = Tokamak::Builder::Json.build(obj) do |collection, number|
+        collection.values do |values|
+          values.id number
+        end
+
+        collection.members do |member, item|
+          member.values do |values|
+            values.id item
+          end
+        end
+      end
+    end
+  end
+
+  def test_root_set_on_members
+    obj = [{ :foo => "bar" }, { :foo => "zue" }]
+    xml = Tokamak::Builder::Xml.build(obj) do |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+
+      collection.members(:root => "foos") do |member, some_foos|
+        member.values do |values|
+          values.id some_foos[:foo]
+        end
+      end
+    end
+
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "an_id", xml.css("root id").first.text
+    assert_equal "bar"  , xml.css("root > foos > id").first.text
+    assert_equal 2      , xml.css("root > foos > id").size
+  end
+
+  def test_nested_crazy_values
+    obj = [{ :foo => "bar" }, { :foo => "zue" }]
+    xml = Tokamak::Builder::Xml.build(obj) do |collection|
+      collection.values do |values|
+        values.body {
+          values.face {
+            values.eyes  "blue"
+            values.mouth "large"
+          }
+        }
+      end
+    end
+
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "blue" , xml.css("root > body > face > eyes").first.text
+    assert_equal "large", xml.css("root > body > face > mouth").first.text
+  end
+
+  def test_xml_attributes_on_values
+    obj = [{ :foo => "bar" }, { :foo => "zue" }]
+    xml = Tokamak::Builder::Xml.build(obj) do |collection|
+      collection.values do |values|
+        values.body(:type => "fat", :gender => "male") {
+          values.face {
+            values.eyes  "blue"
+            values.mouth "large", :teeth_count => 32
+          }
+        }
+      end
+    end
+
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "fat" , xml.css("root > body").first["type"]
+    assert_equal "32"  , xml.css("root > body > face > mouth").first["teeth_count"]
+  end
+
+  def test_xml_namespaces_on_values
+    obj = [{ :foo => "bar" }, { :foo => "zue" }]
+    xml = Tokamak::Builder::Xml.build(obj) do |collection|
+      collection.values do |values|
+        values.body("xmlns:biology" => "http://a.biology.namespace.com") {
+          values["biology"].face {
+            values["biology"].eyes  "blue"
+            values["biology"].mouth "large", :teeth_count => 32
+          }
+        }
+      end
+    end
+
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "biology", xml.at_xpath(".//biology:face", {"biology" => "http://a.biology.namespace.com"}).namespace.prefix
+  end
+
+  def test_build_full_collection
+    time = Time.now
+    some_articles = [
+      {:id => 1, :title => "a great article", :updated => time},
+      {:id => 2, :title => "another great article", :updated => time}
+    ]
+
+    xml = Tokamak::Builder::Xml.build(some_articles) do |collection|
+      collection.values do |values|
+        values.id      "http://example.com/json"
+        values.title   "Feed"
+        values.updated time
+
+        values.author {
+          values.name  "John Doe"
+          values.email "joedoe@example.com"
+        }
+
+        values.author {
+          values.name  "Foo Bar"
+          values.email "foobar@example.com"
+        }
+      end
+
+      collection.link("next"    , "http://a.link.com/next")
+      collection.link("previous", "http://a.link.com/previous")
+
+      collection.members(:root => "articles") do |member, article|
+        member.values do |values|
+          values.id      "uri:#{article[:id]}"
+          values.title   article[:title]
+          values.updated article[:updated]
+        end
+
+        member.link("image", "http://example.com/image/1")
+        member.link("image", "http://example.com/image/2", :type => "application/json")
+      end
+    end
+
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "John Doe"               , xml.css("root > author").first.css("name").first.text
+    assert_equal "foobar@example.com"     , xml.css("root > author").last.css("email").first.text
+
+    assert_equal "http://a.link.com/next" , xml.css("root > link").first["href"]
+    assert_equal "next"                   , xml.css("root > link").first["rel"]
+    assert_equal "application/xml"        , xml.css("root > link").last["type"]
+
+    assert_equal "uri:1"                      , xml.css("root > articles").first.css("id").first.text
+    assert_equal "a great article"            , xml.css("root > articles").first.css("title").first.text
+    assert_equal "http://example.com/image/1" , xml.css("root > articles").first.css("link").first["href"]
+    assert_equal "image"                      , xml.css("root > articles").first.css("link").first["rel"]
+    assert_equal "application/json"           , xml.css("root > articles").first.css("link").last["type"]
+  end
+
+  def test_build_full_member
+    time = Time.now
+    an_article = {:id => 1, :title => "a great article", :updated => time}
+
+    xml = Tokamak::Builder::Xml.build(an_article, :root => "article") do |member, article|
+      member.values do |values|
+        values.id      "uri:#{article[:id]}"
+        values.title   article[:title]
+        values.updated article[:updated]
+
+        values.domain("xmlns" => "http://a.namespace.com") {
+          member.link("image", "http://example.com/image/1")
+          member.link("image", "http://example.com/image/2", :type => "application/atom+xml")
+        }
+      end
+
+      member.link("image", "http://example.com/image/1")
+      member.link("image", "http://example.com/image/2", :type => "application/json")
+    end
+
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "http://example.com/image/1" , xml.css("article > link").first["href"]
+    assert_equal "image"                      , xml.css("article > link").first["rel"]
+    assert_equal "application/json"           , xml.css("article > link").last["type"]
+
+    assert_equal "http://example.com/image/1" , xml.xpath("/article/xmlns:domain/xmlns:link", {"xmlns" => "http://a.namespace.com"}).first["href"]
+    assert_equal "image"                      , xml.xpath("/article/xmlns:domain/xmlns:link", {"xmlns" => "http://a.namespace.com"}).first["rel"]
+    assert_equal "application/atom+xml"       , xml.xpath("/article/xmlns:domain/xmlns:link", {"xmlns" => "http://a.namespace.com"}).last["type"]
+  end
+end
+

data/test/tokamak/helper_test.rb

@@ -0,0 +1,106 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+# every builder comes with a default helper, with collection and member methods. See lib/tokamak/builder.rb
+class TestDefaultHelper
+  extend Tokamak::Builder::Json.helper
+end
+
+# but here you can cheack how to pass other default options to helper methods
+class DummyAtom < Tokamak::Builder::Base
+  builder_for "application/atom+xml"
+
+  collection_helper_default_options :atom_type => :feed
+  member_helper_default_options     :atom_type => :entry
+  
+  def initialize(obj, options = {})
+    #do nothing
+  end
+  
+  def representation
+    "puft!"
+  end
+end
+class AtomGenerator
+  extend DummyAtom.helper
+end
+
+# how to complete override the helper
+module MyHelper
+  # these examples are just to show that you can freely change the behavior 
+  # of the helper methods, since you respect the methods signature
+  def collection(obj, *args, &block)
+    member(obj, *args, &block)
+  end
+
+  def member(obj, *args, &block)
+    default_options = {:my_option => "my_value"}
+    default_options.merge!(args.shift)
+    args.unshift(default_options)
+    OverwrittenHelperBuilder.build(obj, *args, &block)
+  end
+end
+class OverwrittenHelperBuilder < Tokamak::Builder::Base
+  builder_for "some/media+type"
+
+  # just implement this method passing the new helper
+  def self.helper
+    MyHelper
+  end
+  
+  def initialize(obj, options = {})
+    #do nothing
+  end
+  
+  def representation
+    "pleft!"
+  end
+end
+class TestOverwrittenHelper
+  extend OverwrittenHelperBuilder.helper
+end
+
+class Tokamak::Builder::HelperTest < Test::Unit::TestCase
+
+  def test_default_helper
+    obj = { :foo => "bar" }
+    a_collection = [1,2,3,4]
+    json = TestDefaultHelper.collection(obj) do |collection|
+      collection.values do |values|
+        values.id "an_id"
+      end
+
+      collection.members(:collection => a_collection) do |member, number|
+        member.values do |values|
+          values.id number
+        end
+      end
+    end
+
+    hash = JSON.parse(json).extend(Methodize)
+
+    assert_equal "an_id", hash.id
+    assert_equal 1      , hash.members.first.id
+    assert_equal 4      , hash.members.size
+  end
+
+  def test_helper_with_options_overwritten
+    numbers = [1,2,3,4,5]
+    result = AtomGenerator.collection(numbers, :other_option => "an_option") do |collection, num, opt|
+      assert_equal :feed      , opt[:atom_type]
+      assert_equal "an_option", opt[:other_option]
+      assert_equal [1,2,3,4,5], num
+    end
+    assert_equal "puft!", result
+  end
+  
+  def test_overwritten_helper
+    numbers = [1,2,3,4,5]
+    result = TestOverwrittenHelper.collection(numbers, :other_option => "an_option") do |collection, num, opt|
+      assert_equal "an_option", opt[:other_option]
+      assert_equal "my_value" , opt[:my_option]
+      assert_equal [1,2,3,4,5], num
+    end
+    assert_equal "pleft!", result
+  end
+end
+

data/test/tokamak/hook/rails_test.rb

@@ -0,0 +1,74 @@
+require 'test/unit'
+require 'rubygems'
+require 'ruby-debug'
+require "methodize"
+require "rack/conneg"
+
+require File.expand_path(File.dirname(__FILE__) + '/../../rails2_skel/config/environment.rb')
+
+# put the require below to use tokamak in your rails project
+require "tokamak/hook/rails"
+
+class Tokamak::Hook::RailsTest < ActionController::IntegrationTest
+
+  def test_view_generation_with_json
+    get '/test/show', {}, :accept => 'application/json'
+
+    json = @controller.response.body
+    hash = JSON.parse(json).extend(Methodize)
+
+    assert_equal "John Doe"               , hash.author.first.name
+    assert_equal "foobar@example.com"     , hash.author.last.email
+    assert_equal "http://example.com/json", hash.id
+
+    assert_equal "http://a.link.com/next" , hash.link.first.href
+    assert_equal "next"                   , hash.link.first.rel
+    assert_equal "application/json"       , hash.link.last.type
+
+    assert_equal "uri:1"                      , hash.articles.first.id
+    assert_equal "a great article"            , hash.articles.first.title
+    assert_equal "http://example.com/image/1" , hash.articles.last.link.first.href
+    assert_equal "image"                      , hash.articles.last.link.first.rel
+    assert_equal "application/json"           , hash.articles.last.link.last.type
+  end
+
+  def test_view_generation_with_xml
+    get '/test/show', {}, :accept => 'application/xml'
+
+    xml = @controller.response.body
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "John Doe"               , xml.css("root > author").first.css("name").first.text
+    assert_equal "foobar@example.com"     , xml.css("root > author").last.css("email").first.text
+
+    assert_equal "http://a.link.com/next" , xml.css("root > link").first["href"]
+    assert_equal "next"                   , xml.css("root > link").first["rel"]
+    assert_equal "application/xml"        , xml.css("root > link").last["type"]
+
+    assert_equal "uri:1"                      , xml.css("root > articles").first.css("id").first.text
+    assert_equal "a great article"            , xml.css("root > articles").first.css("title").first.text
+    assert_equal "http://example.com/image/1" , xml.css("root > articles").first.css("link").first["href"]
+    assert_equal "image"                      , xml.css("root > articles").first.css("link").first["rel"]
+    assert_equal "application/json"           , xml.css("root > articles").first.css("link").last["type"]
+  end
+
+  def test_view_generation_with_partial
+    get '/test/feed', {}, :accept => 'application/xml'
+
+    xml = @controller.response.body
+    xml = Nokogiri::XML::Document.parse(xml)
+
+    assert_equal "John Doe"               , xml.css("root > author").first.css("name").first.text
+    assert_equal "foobar@example.com"     , xml.css("root > author").last.css("email").first.text
+
+    assert_equal "http://a.link.com/next" , xml.css("root > link").first["href"]
+    assert_equal "next"                   , xml.css("root > link").first["rel"]
+    assert_equal "application/xml"        , xml.css("root > link").last["type"]
+
+    assert_equal "uri:1"                      , xml.css("root > articles").first.css("id").first.text
+    assert_equal "a great article"            , xml.css("root > articles").first.css("title").first.text
+    assert_equal "http://example.com/image/1" , xml.css("root > articles").first.css("link").first["href"]
+    assert_equal "image"                      , xml.css("root > articles").first.css("link").first["rel"]
+    assert_equal "application/json"           , xml.css("root > articles").first.css("link").last["type"]
+  end
+end