roar 0.8.0 → 0.8.1

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/roar.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_runtime_dependency "representable"
+  s.add_runtime_dependency "representable", "~> 0.9.2"
   s.add_runtime_dependency "restfulie", "~> 1.0.0"
   s.add_runtime_dependency "hooks",     "~> 0.1.4"
-  s.add_runtime_dependency "test_xml"
-
+  
+  s.add_development_dependency "test_xml"
   s.add_development_dependency "minitest",         "~> 1.6.0"
   s.add_development_dependency "sinatra",          "~> 1.2.6"
   s.add_development_dependency "sinatra-reloader", "~> 0.5.0"

data/test/{http_verbs_test.rb → http_verbs_feature_test.rb}

@@ -2,8 +2,8 @@ require 'test_helper'
 require 'roar/representer/feature/http_verbs'
 
 class HttpVerbsTest < MiniTest::Spec
-  class BandRepresenter < Roar::Representer::XML
-    self.representation_name = :band
+  class Band
+    include Roar::Representer::XML
     
     property :name
     property :label
@@ -13,7 +13,7 @@ class HttpVerbsTest < MiniTest::Spec
   
   describe "HttpVerbs" do
     before do
-      @r = BandRepresenter.new
+      @r = Band.new
     end
     
     # TODO: assert that Restfulie#post receives the correct document.

data/test/hypermedia_feature_test.rb

@@ -0,0 +1,132 @@
+require 'test_helper'
+require 'roar/representer/feature/hypermedia'
+
+class HypermediaTest
+  describe "Hypermedia Feature" do
+    before do
+      @bookmarks = Class.new do
+        include Roar::Representer::XML
+        include Roar::Representer::Feature::Hypermedia
+        
+        self.representation_name = "bookmarks"
+      end
+      
+      @bookmarks_with_links = Class.new(@bookmarks)
+      @bookmarks_with_links.class_eval do
+        property :id
+        link :self do "http://bookmarks" end
+        link :all do "http://bookmarks/all" end
+      end
+    end
+    
+    
+    describe "#to_xml" do
+      it "sets up links and renders <link> correctly in XML" do
+        assert_xml_equal '<bookmarks>
+                            <id>1</id>
+                            <link rel="self" href="http://bookmarks"/>
+                            <link rel="all" href="http://bookmarks/all"/>
+                          </bookmarks>', @bookmarks_with_links.from_attributes(:id => 1).to_xml
+      end
+      
+      it "still works even if there are no links defined" do
+        assert_xml_equal '<bookmarks/>', @bookmarks.new.to_xml
+      end
+      
+      it "doesn't render links with :links => false" do
+        assert_xml_equal '<bookmarks>
+                            <id>1</id>
+                          </bookmarks>', 
+          @bookmarks_with_links.from_attributes(:id => 1).to_xml(:links => false)
+      end
+      
+    end
+    
+    
+    describe "#from_xml" do
+      it "extracts links from document" do
+        doc = @bookmarks_with_links.from_xml(%{
+        <bookmarks>
+          <link rel="self" href="http://bookmarks">
+        </bookmarks>
+        })
+        
+        assert_kind_of Roar::Representer::Feature::Hypermedia::LinkCollection, doc.links
+        assert_equal 1, doc.links.size
+        assert_equal({"rel"=>"self", "href"=>"http://bookmarks"}, doc.links.first.to_attributes) 
+      end
+      
+      it "sets up an empty link list if no links found in the document" do
+        assert_equal [], @bookmarks_with_links.from_xml(%{<bookmarks/>}).links
+      end
+    end
+    
+    
+    describe "#links" do
+      before do
+        @set  = @bookmarks.new
+        hyper = Roar::Representer::XML::Hyperlink
+        
+        @set.links = [hyper.from_attributes({"rel" => "self", "href" => "http://self"}),
+                      hyper.from_attributes({"rel" => "next", "href" => "http://next"})]
+      end
+      
+      describe "#links=" do
+        it "wraps links in a LinkCollection" do
+          assert_kind_of Roar::Representer::Feature::Hypermedia::LinkCollection, @set.links
+          assert_equal 2, @set.links.size
+        end
+      end
+      
+      describe "#link[]" do
+        it "provides shorthand accessor for rels" do
+          assert_equal "http://self", @set.links["self"]
+          assert_equal "http://self", @set.links[:self]
+          assert_equal "http://next", @set.links[:next]
+          assert_equal nil, @set.links[:prev]
+        end
+      end
+      
+      it "returns an empty list when no links present" do
+        assert_equal Roar::Representer::Feature::Hypermedia::LinkCollection.new, @bookmarks.new.links
+      end
+    end
+    
+    
+    describe "#find_links_definition" do
+      it "returns Definition if links are present" do
+        @bookmarks.class_eval do
+          property :id
+          link :self
+        end
+        
+        assert_equal "links", @bookmarks.find_links_definition.name
+      end
+      
+      it "returns nil if no links defined" do
+        assert_equal nil, @bookmarks.find_links_definition
+      end
+    end
+  end
+end
+
+class LinksDefinitionTest < MiniTest::Spec
+  describe "LinksDefinition" do
+    before do
+      @d = Roar::Representer::Feature::Hypermedia::LinksDefinition.new(:links)
+    end
+    
+    it "accepts options in constructor" do
+      assert_equal [], @d.rel2block
+    end
+    
+    it "accepts configuration" do
+      @d.rel2block << {:rel => :self}
+      assert_equal [{:rel=>:self}], @d.rel2block
+    end
+    
+    it "responds to #each to iterate rel2block" do
+    end
+    
+  end
+end

data/test/integration_test.rb

@@ -8,8 +8,8 @@ require 'roar/representer/feature/hypermedia'
 
 class RepresenterIntegrationTest < MiniTest::Spec
   module XML
-    class BandRepresenter < Roar::Representer::XML
-      self.representation_name = :band
+    class Band
+      include Roar::Representer::XML
       
       property :name
       property :label
@@ -29,8 +29,8 @@ class RepresenterIntegrationTest < MiniTest::Spec
   
   # TODO: inherit properly.
   module JSON
-    class BandRepresenter < Roar::Representer::JSON
-      self.representation_name = :band
+    class Band
+      include Roar::Representer::JSON
       
       property :name
       property :label
@@ -55,7 +55,7 @@ class RepresenterIntegrationTest < MiniTest::Spec
     describe "JSON" do
       it "allows a POST workflow" do
         # create representation with initial values:
-        @r = JSON::BandRepresenter.new(:name => "Bigwig")
+        @r = JSON::Band.from_attributes(:name => "Bigwig")
         assert_equal "Bigwig", @r.name
         
         @r = @r.post("http://localhost:9999/band", "application/band+json")
@@ -70,7 +70,7 @@ class RepresenterIntegrationTest < MiniTest::Spec
       # TODO: implement me.
       it "allows an ordering workflow" do
         # create representation with initial values:
-        @o = ::JSON::Order.new(:client_id => 1)
+        @o = ::JSON::Order.from_attributes(:client_id => 1)
         assert_equal 1, @o.client_id
         
         @o.post!("http://localhost:9999/orders", "application/order+json")
@@ -82,7 +82,7 @@ class RepresenterIntegrationTest < MiniTest::Spec
         
         
         # manually POST item:
-        @i = ::JSON::Item.new(:article_id => "666-S", :amount => 1)
+        @i = ::JSON::Item.from_attributes(:article_id => "666-S", :amount => 1)
         @i.post!(@o.links[:items], "application/item+json")
         @o.get!(@o.links[:self], "application/order+json")
         
@@ -104,7 +104,7 @@ class RepresenterIntegrationTest < MiniTest::Spec
     describe "XML" do
       it "allows a POST workflow" do
         # create representation with initial values:
-        @r = XML::BandRepresenter.new(:name => "Bigwig")
+        @r = XML::Band.from_attributes(:name => "Bigwig")
         assert_equal "Bigwig", @r.name
         
         @r = @r.post("http://localhost:9999/band", "application/band+xml")

data/test/json_representer_test.rb

@@ -3,37 +3,49 @@ require 'test_helper'
 require "test_xml/mini_test"
 require "roar/representer/json"
 
-class JsonRepresenterFunctionalTest < MiniTest::Spec
-  class OrderRepresenter < Roar::Representer::JSON
-    self.representation_name= :order
-    representable_property :id
+class JsonRepresenterTest < MiniTest::Spec
+  class Order
+    include Roar::Representer::JSON
+    property :id
+    property :pending
   end
   
   
   describe "JsonRepresenter" do
     before do
-      @r = OrderRepresenter.new
+      @r = Order.new
     end
     
     describe "#to_json" do
       it "#serialize returns the serialized model" do
         @r.id = 1
-        assert_equal '{"order":{"id":1}}', @r.serialize
+        assert_equal '{"order":{"id":1}}', @r.to_json
       end
-      
-      
-      it ".from_xml returns the deserialized model" do
-        @m = OrderRepresenter.deserialize('{"order": {"id":1}}')
+    end
+    
+    describe ".from_json" do
+      it "returns the deserialized model" do
+        @m = Order.from_json('{"order": {"id":1}}')
         assert_equal 1, @m.id
       end
       
-      it ".from_xml still works with nil" do
-        assert OrderRepresenter.deserialize(nil)
+      it "accepts :except option" do
+        order = Order.from_json({order: {id: 1, pending: 1}}.to_json, :except => [:id])
+        assert_equal nil, order.id
+        assert_equal 1, order.pending
+      end
+      
+      it "accepts :include option" do
+        order = Order.from_json({order: {id: 1, pending: 1}}.to_json, :include => [:id])
+        assert_equal 1, order.id
+        assert_equal nil, order.pending
       end
       
+      it "works with a nil document" do
+        assert Order.from_json(nil)
+      end
     end
   end
-  
 end
 
 class JsonHyperlinkRepresenterTest
@@ -60,12 +72,13 @@ end
 class JsonHypermediaTest
   describe "Hypermedia API" do
     before do
-      @c = Class.new(Roar::Representer::JSON) do
+      @c = Class.new do
+        include Roar::Representer::JSON
         include Roar::Representer::Feature::Hypermedia
         
         self.representation_name= :order
         
-        representable_property :id
+        property :id
         
         link :self do "http://self" end
         link :next do "http://next/#{id}" end
@@ -75,27 +88,19 @@ class JsonHypermediaTest
     end
     
     it "responds to #links" do
-      assert_equal nil, @r.links
-    end
-    
-    it "computes links in #from_attributes" do
-      @r = @c.from_attributes({"id" => 1})
-      assert_equal 2, @r.links.size
-      assert_equal({"rel"=>:self, "href"=>"http://self"}, @r.links.first.to_attributes)
-      assert_equal({"rel"=>:next, "href"=>"http://next/1"}, @r.links.last.to_attributes) 
+      assert_equal [], @r.links
     end
     
     it "extracts links from JSON" do
-      @r = @c.deserialize({:order => {:links => [{:rel => "self", :href => "http://self"}]}}.to_json)
+      @r = @c.from_json({:order => {:links => [{:rel => "self", :href => "http://self"}]}}.to_json)
       
       assert_equal 1, @r.links.size
       assert_equal({"rel"=>"self", "href"=>"http://self"}, @r.links.first.to_attributes) 
     end
     
     it "renders link: correctly in JSON" do
-      assert_equal "{\"order\":{\"id\":1,\"links\":[{\"rel\":\"self\",\"href\":\"http://self\"},{\"rel\":\"next\",\"href\":\"http://next/1\"}]}}", @c.from_attributes({"id" => 1}).serialize
+      assert_equal "{\"order\":{\"id\":1,\"links\":[{\"rel\":\"self\",\"href\":\"http://self\"},{\"rel\":\"next\",\"href\":\"http://next/1\"}]}}", @c.from_attributes(:id => 1).to_json
     end
-    
   end
 end
 

data/test/model_representing_test.rb

@@ -3,24 +3,27 @@ require 'roar/representer/feature/model_representing'
 
 class ModelRepresentingTest < MiniTest::Spec
   describe "ModelRepresenting" do
-    class ItemRepresenter < Roar::Representer::XML
-      include Roar::Representer::Feature::ModelRepresenting # TODO: move to abstract!
+    class ItemRepresenter
+      include Roar::Representer::XML
+      include Roar::Representer::Feature::ModelRepresenting
       self.representation_name= :item
-      representable_property :value
+      property :value
     end
     
-    class PositionRepresenter < Roar::Representer::XML
-      include Roar::Representer::Feature::ModelRepresenting # TODO: move to abstract! 
+    class PositionRepresenter
+      include Roar::Representer::XML
+      include Roar::Representer::Feature::ModelRepresenting
       self.representation_name= :position
-      representable_property :id
-      representable_property :item, :as => ItemRepresenter
+      property :id
+      property :item, :as => ItemRepresenter
     end
     
-    class OrderRepresenter < Roar::Representer::XML
-      include Roar::Representer::Feature::ModelRepresenting # TODO: move to abstract!
+    class OrderRepresenter
+      include Roar::Representer::XML
+      include Roar::Representer::Feature::ModelRepresenting
       self.representation_name= :order
-      representable_property :id
-      representable_property :items, :as => [ItemRepresenter]
+      property :id
+      collection :items, :as => ItemRepresenter
     end
     
     describe "#definition_class" do
@@ -33,7 +36,6 @@ class ModelRepresentingTest < MiniTest::Spec
     describe "#for_model" do
       it "copies represented model attributes, nothing more" do
         @o = Position.new("id" => 1, "item" => Item.new("value" => "Beer"))
-        
         @r = PositionRepresenter.for_model(@o)
         assert_kind_of PositionRepresenter, @r
         assert_equal 1, @r.id
@@ -43,23 +45,13 @@ class ModelRepresentingTest < MiniTest::Spec
         assert_equal "Beer", @i.value
       end
       
-      it "copies the model to @represented" do
+      it "references the model in @represented" do
         @o = Position.new("id" => 1, "item" => @i = Item.new("value" => "Beer"))
         
         @r = PositionRepresenter.for_model(@o)
         assert_equal @o, @r.represented
         assert_equal @i, @r.item.represented
       end
-      
-      
-      it "works with Hyperlink attributes" do
-        @c = Class.new(ItemRepresenter) do
-          link :self do "http://self" end
-        end
-        
-        assert_equal({"value"=>"Beer", "links"=>[{"rel"=>:self, "href"=>"http://self"}]}, @c.for_model(Item.new("value" => "Beer")).to_attributes)
-      end
-      
     end
     
     describe "#serialize_model" do
@@ -93,6 +85,9 @@ class ModelRepresentingTest < MiniTest::Spec
         OrderRepresenter.class_eval do
           include Roar::Representer::Feature::ActiveRecordMethods
         end
+        ItemRepresenter.class_eval do
+          include Roar::Representer::Feature::ActiveRecordMethods
+        end
         assert_equal({"id" => 1, "items_attributes" => [{"value" => "Beer"}]}, @r.to_nested_attributes) # DISCUSS: overwrite #to_attributes.
       end
       
@@ -103,11 +98,14 @@ class ModelRepresentingTest < MiniTest::Spec
         
         OrderRepresenter.class_eval do
           include Roar::Representer::Feature::ActiveRecordMethods
+          include Roar::Representer::Feature::Hypermedia
           link :self do
         #    "bla"
           end
         end
         ItemRepresenter.class_eval do
+          include Roar::Representer::Feature::ActiveRecordMethods
+          include Roar::Representer::Feature::Hypermedia
           link :self do
             
           end

data/test/order_representers.rb

@@ -4,7 +4,9 @@ require 'roar/representer/feature/hypermedia'
 
 module JSON
   
-  class Item < Roar::Representer::JSON
+  class Item
+    include Roar::Representer::JSON
+    
     property :article_id
     property :amount
     
@@ -13,7 +15,8 @@ module JSON
   end
   
   
-  class Order < Roar::Representer::JSON
+  class Order
+    include Roar::Representer::JSON
     property :client_id
     collection :items, :as => Item