tokamak 1.0.0.beta2

data/spec/integration/full_atom.xml

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+
+	<id>http://example.com/albums/1</id>
+	<title>Albums feed</title>
+	<subtitle>all your examples are belong to us</subtitle>
+	<updated>2010-05-03T16:29:26-03:00</updated>
+
+	<author>
+		<name>John Doe</name>
+		<email>joedoe@example.com</email>
+		<uri>Http://john.doe.com</uri>
+	</author>
+
+	<author>
+		<name>Foo Bar</name>
+		<email>foobar@example.com</email>
+	</author>
+
+	<contributor>
+		<name>Foo Bar</name>
+		<email>foobar@example.com</email>
+	</contributor>
+
+	<generator uri="http://restfulie.com" version="1.0">Restfulie</generator>
+	<icon>/icon.jpg</icon>
+	<rights>&lt;b&gt;2005 John Doe&lt;/b&gt;</rights>
+	
+	<count xmlns="http://a.special.namespace">2</count>
+
+	<link href="http://example.com/albums/1" rel="self" />
+	<link href="http://example.com/albums/1/csv" rel="alternate" type="text/csv" />
+
+	<entry>
+
+	    <id>uri:1</id>
+	    <title>Article 1</title>
+	    <updated>2010-05-03T16:29:26-03:00</updated>
+		<published>2010-05-03T16:29:26-03:00</published>
+
+		<author>
+			<name>Foo Bar</name>
+			<email>foobar@example.com</email>
+		</author>
+		
+		<summary>Some text.</summary>
+		
+		<category term="sports" scheme="http://a.scheme.com" label="Sports"/>
+		
+		<content>a freaking awesome content</content>
+
+		<article xmlns="http://article.namespace.com"  xmlns:albums="http://example.com/albums">
+			<tag>tag1</tag>
+			<tag>tag2</tag>
+
+		    <editor name="foozine">
+		      <category>category 1, category 2</category>
+		    </editor>
+
+		    <albums:album>
+		      <albums:id>uri:albums:1</albums:id>
+		      <albums:title>Album 1</albums:title>
+		    </albums:album>
+
+		    <albums:album xmlns:song="http://example.com.br">      
+		      <albums:id>1</albums:id>
+		      <song:title></song:title>
+		    </albums:album>
+		</article>
+
+	    <link href="http://example.com/image/1" rel="image" />
+	    <link href="http://example.com/image/2" rel="image" type="application/atom+xml" />
+
+	</entry>
+
+	<entry>
+
+	    <id>uri:2</id>
+	    <title>Article 2</title>
+	    <updated>2010-05-03T16:29:26-03:00</updated>
+
+		<article xmlns="http://article.namespace.com">
+			<tag>tag1</tag>
+			<tag>tag2</tag>
+		</article>
+
+	    <link href="http://example.com/image/1" rel="image" />
+	    <link href="http://example.com/image/2" rel="image" type="application/atom+xml" />
+
+	</entry>
+
+</feed>

data/spec/integration/full_json.js

@@ -0,0 +1,46 @@
+{
+    "articles": {
+        "link": [
+            {
+                "rel": "self",
+                "href": "http://another.place.com",
+                "type": "text/json",
+                "charset": "utf-8" 
+            },
+            {
+                "rel": "search",
+                "href": "http://search.place.com",
+                "type": "application/opensearchdescription+xml",
+                "charset": "utf-8" 
+            }
+        ],
+        "size": 2,
+        "freezed": null,
+        "article": [
+            {
+                "link": {
+                    "rel": "self",
+                    "href": "http://a.link.com",
+                    "type": "text/json",
+                    "profile": "article",
+                    "charset": "utf-8" 
+                },
+                "title": "a awesome title",
+                "subtitle": "Article subtitle",
+                "author": "John  Maclane" 
+            },
+            {
+                "link": {
+                    "rel": "self",
+                    "href": "http://a.link.com",
+                    "type": "text/json",
+                    "profile": "article",
+                    "charset": "utf-8" 
+                },
+                "title": "a awesome title",
+                "subtitle": "Article subtitle",
+                "author": "John  Maclane"
+            }
+        ]
+    }
+}

data/spec/integration/json/json_spec.rb

@@ -0,0 +1,172 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require 'json'
+
+module Tokamak::Test
+  class SimpleClass
+    attr_accessor :id, :title, :updated
+    def initialize(id,title,updated)
+      @id, @title, @updated = id, title, updated
+    end
+  end
+end
+
+describe Tokamak do
+  describe 'JSON' do
+
+    describe "Collection" do
+      
+      it "should create a collection from builder DSL" do
+        time = Time.now
+        some_articles = [
+          {:id => 1, :title => "a great article", :updated => time},
+          {:id => 2, :title => "another great article", :updated => time}
+        ]
+        
+        json = to_json(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
+
+        json = Tokamak::Json.to_hash(json)
+        json.id.should == "http://example.com/json"
+        json.title.should == "Feed"
+        json.author.first.name.should == "John Doe"
+        json.author.last.email.should == "foobar@example.com"
+        
+        json.articles.first.id.should == "uri:1"
+        json.articles.first.title.should == "a great article"
+    end
+     
+    it "should create a collection from a string input" do
+      full_json = IO.read(File.dirname(__FILE__) + '/../full_json.js')
+      json = to_json(full_json)
+
+      json["articles"]["size"].should  == 2
+      json["articles"]["freezed"].should == nil
+      
+      json.articles.__free_method__(:size).size.should  == 2
+      json.articles.freezed.should == nil    end
+  end
+
+    describe "Member" do
+      
+      it "should create a member from builder DSL" do
+        time = Time.now
+        an_article = {:id => 1, :title => "a great article", :updated => time}
+        
+        entry = to_json(an_article, :atom_type => :entry) 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
+        
+        entry = Tokamak::Json.to_hash(entry)
+        entry["id"].should == "uri:1"
+        entry["title"].should == "a great article"
+      end
+    
+      it "should be able to declare links inside values block" do
+        time = Time.now
+        an_article = {:id => 1, :title => "a great article", :updated => time}
+    
+        entry = to_json(an_article, :atom_type => :entry) 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
+        end
+    
+        entry = Tokamak::Json.to_hash(entry)
+        entry["id"].should == "uri:1"
+        entry["title"].should == "a great article"
+        
+        entry["domain"]["link"][0].rel.should == "image"
+      end
+      
+      it "should create a member from an already declared recipe" do
+       
+        describe_recipe(:simple_entry) 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/atom+xml")                                
+        end
+       
+        time = Time.now
+        an_article = {:id => 1, :title => "a great article", :updated => time}
+        
+        entry = to_json(an_article, :recipe => :simple_entry)
+        entry = Tokamak::Json.to_hash(entry)
+                
+        entry["id"].should == "uri:1"
+        entry["title"].should == "a great article"
+      end
+    
+    end
+
+    describe "Errors" do
+      it "should raise error for converter without recipe" do
+        lambda {
+          to_json
+        }.should raise_error(Tokamak::ConverterError, "Recipe required")
+      end
+      
+    end
+
+  end
+
+  def to_json(*args, &recipe)
+    Tokamak::Json.to_json(*args, &recipe)
+  end
+
+  def describe_recipe(*args, &recipe)
+    Tokamak::Json.describe_recipe(*args, &recipe)
+  end
+  
+  def simple_object(*args)
+    Tokamak::Test::SimpleClass.new(*args)
+  end
+
+end

data/spec/integration/xml/xml_spec.rb

@@ -0,0 +1,203 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+class SimpleClass
+  attr_accessor :id, :title, :updated
+  def initialize(id,title,updated)
+    @id, @title, @updated = id, title, updated
+  end
+end
+
+class Item
+  attr_reader :name
+  def initialize(name)
+    @name = name
+  end
+end
+
+describe Tokamak do
+  describe 'Xml' do
+  
+    describe "pure to_xml method" do
+      
+      it "should use a default recipe extracting first root element that serializes an entire object if responds to to_xml" do
+        time = Time.now
+        an_article = {:article => {:id => 1, :title => "a great article", :updated => time}}
+        
+        entry = to_xml(an_article)
+        entry.should == an_article[:article].to_xml(:root => "article")
+      end
+
+      it "should use a default recipe that serializes an entire object if responds to to_xml" do
+        time = Time.now
+        an_article = {:id => 1, :title => "a great article", :updated => time}
+        
+        entry = to_xml(an_article)
+        entry.should == an_article.to_xml
+      end
+    
+    end
+      
+    describe "entry dsl" do
+      
+      it "should create an entry from builder DSL" do
+        an_article = {:article => {:id => 1, :title => "a great article"}}
+
+        entry = to_xml(an_article) do |member, article|
+          member.values do |values|
+            values.id      "uri:#{article[:article][:id]}"            
+            values.title   article[:article][:title]
+          end
+
+          member.link("image", "http://example.com/image/1")
+          member.link("image", "http://example.com/image/2", :type => "application/atom+xml")                                
+        end
+
+        entry = Hash.from_xml entry
+        entry["article"]["id"].should == "uri:1"
+        entry["article"]["title"].should == "a great article"
+      end
+    
+      it "should be able to declare links inside values block" do
+        an_article = {:article => {:id => 1, :title => "a great article"}}
+        
+        entry = to_xml(an_article) do |member, article|
+          member.values do |values|
+            values.id      "uri:#{article[:article][:id]}"            
+            values.title   article[:article][:title]
+  
+            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
+          
+        end
+        
+        entry = Hash.from_xml entry
+        entry["article"]["id"].should == "uri:1"
+        entry["article"]["title"].should == "a great article"
+        entry["article"]["domain"]["link"].size.should == 2
+      end
+      
+      it "should be able to method missing to define values" do
+        an_article = {:article => {:id => 1, :title => "a great article"}}
+        
+        entry = to_xml(an_article) do |member, article|
+          member.id      "uri:#{article[:article][:id]}"            
+          member.title   article[:article][:title]
+            
+          member.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
+        
+        entry = Hash.from_xml entry
+        entry["article"]["id"].should == "uri:1"
+        entry["article"]["title"].should == "a great article"
+        entry["article"]["domain"]["link"].size.should == 2
+      end
+
+      it "should create an entry from an already declared recipe" do
+        describe_recipe(:simple_entry) do |member, article|
+          member.values do |values|
+            values.id      "uri:#{article[:article][:id]}"            
+            values.title   article[:article][:title]
+            values.updated article[:article][:updated]
+          end
+          
+          member.link("image", "http://example.com/image/1")
+          member.link("image", "http://example.com/image/2", :type => "application/atom+xml")                                
+        end
+       
+        time = Time.now
+        an_article = {:article => {:id => 1, :title => "a great article", :updated => time}}
+        
+        entry = to_xml(an_article, :atom_type => :entry, :recipe => :simple_entry)
+        
+        entry = Hash.from_xml entry
+        entry["article"]["id"].should == "uri:1"
+        entry["article"]["title"].should == "a great article"
+      end
+    
+    end
+      
+  end
+  
+  def to_xml(*args, &recipe)
+    Tokamak::Xml.to_xml(*args, &recipe)
+  end
+  
+  def describe_recipe(*args, &recipe)
+    Tokamak::Xml.describe_recipe(*args, &recipe)
+  end
+  
+  def simple_object(*args)
+    SimpleClass.new(*args)
+  end
+
+end
+
+  # 
+  #   describe "Feed" do
+  #     it "should create a feed from builder DSL" do
+  #       time = Time.now
+  #       some_articles = {:some_articles => [
+  #         {:id => 1, :title => "a great article", :updated => time},
+  #         {:id => 2, :title => "another great article", :updated => time}
+  #       ]}
+  #       
+  #       feed = to_xml(some_articles) do |collection|
+  #         collection.values do |values|
+  #           values.id      "http://example.com/feed"
+  #           values.title   "Feed"
+  #           values.updated time
+  #           
+  #           values.authors {
+  #             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")
+  #         
+  #       end
+  #       
+  #       feed = Hash.from_xml feed
+  #       feed["some_articles"]["id"].should == "http://example.com/feed"
+  #       feed["some_articles"]["title"].should == "Feed"
+  #       # feed["updated"].should == DateTime.parse(time.xmlschema)
+  #       feed.some_articles.authors.author.first["name"].should == "John Doe"
+  #       feed.some_articles.authors.author.last["email"].should == "foobar@example.com"
+  #       
+  #    end
+  # 
+  #     it "should pluralize items on root and singularize on element" do
+  #       time = Time.now
+  #       some_articles = [Item.new("training"), Item.new("books")]
+  #       
+  #       feed = to_xml(some_articles) do |collection|
+  #         collection.values do |values|
+  #           collection.members do |member, item|
+  #           end
+  #         end
+  #       end
+  #       
+  #       feed = Hash.from_xml feed
+  #       feed.keys.first.should =="items"
+  #       feed.items.keys.first.should =="item"
+  #       # feed.items.item[0].name.should == "training"
+  #       # feed.items.item[1].name.should == "books"
+  #       
+  #    end
+  # 
+  #   end
+  #