roar 1.0.4 → 1.1.0

data/test/hypermedia_feature_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+  require 'test_helper'
 
 class HypermediaTest < MiniTest::Spec
 
@@ -30,7 +30,7 @@ class HypermediaTest < MiniTest::Spec
 
     describe "#to_xml" do
       it "works when no links defined" do
-        repr = Module.new do
+        decorator_class = Class.new(Roar::Decorator) do
           include Roar::XML
           include Roar::Hypermedia
 
@@ -38,22 +38,22 @@ class HypermediaTest < MiniTest::Spec
           property :title
         end
 
-        song.extend(repr).to_xml.must_equal_xml "<song><title>Brandy Wine</title></song>"
+        decorator_class.new(song).to_xml.must_equal_xml "<song><title>Brandy Wine</title></song>"
       end
 
-      let (:rpr) { Module.new do
+      let(:decorator_class) { Class.new(Roar::Decorator) do
         include Roar::XML
         include Roar::Hypermedia
 
         self.representation_wrap = "song"
         property :title
 
-        link(:self) { "/songs/#{title}" }
+        link(:self) { "/songs/#{represented.title}" }
         link(:all) { "/songs" }
       end }
 
       it "includes links in rendered document" do
-        song.extend(rpr).to_xml.must_equal_xml %{
+        decorator_class.new(song).to_xml.must_equal_xml %{
           <song>
             <title>Brandy Wine</title>
             <link rel="self" href="/songs/Brandy Wine"/>
@@ -62,23 +62,22 @@ class HypermediaTest < MiniTest::Spec
       end
 
       it "suppresses links when links: false" do
-        song.extend(rpr).to_xml(:links => false).must_equal_xml "<song><title>Brandy Wine</title></song>"
+        decorator_class.new(song).to_xml(user_options: {links: false}).must_equal_xml "<song><title>Brandy Wine</title></song>"
       end
 
       it "renders nested links" do
-        song_rpr = rpr
-
-        album_rpr = Module.new do
+        song_decorator_class  = decorator_class
+        album_decorator_class = Class.new(Roar::Decorator) do
           include Roar::XML
           include Roar::Hypermedia
 
           self.representation_wrap = "album"
-          collection :songs, :extend => song_rpr
+          collection :songs, :extend => song_decorator_class
 
           link(:self) { "/albums/mixed" }
         end
 
-        Album.new(:songs => [song]).extend(album_rpr).to_xml.must_equal_xml %{
+        album_decorator_class.new(Album.new(:songs => [song])).to_xml.must_equal_xml %{
           <album>
             <song>
               <title>Brandy Wine</title>
@@ -125,30 +124,13 @@ class HypermediaTest < MiniTest::Spec
         </bookmarks>
         })
 
-        assert_kind_of Roar::Hypermedia::LinkCollection, doc.links
+        assert_kind_of Hash, doc.links
         assert_equal 1, doc.links.size
         assert_equal(["self", "http://bookmarks"], [doc.links["self"].rel, doc.links["self"].href])
       end
 
       it "sets up an empty link list if no links found in the document" do
-        @bookmarks_with_links.new.from_xml(%{<bookmarks/>}).links.must_equal nil
-      end
-    end
-  end
-end
-
-
-class LinkCollectionTest < MiniTest::Spec
-  describe "LinkCollection" do
-    subject {
-      Roar::Hypermedia::LinkCollection[
-        @self_link = link(:rel => :self), @next_link = link(:rel => :next)
-      ]
-    }
-
-    describe "::[]" do
-      it "keys by using rel string" do
-        subject.values.must_equal [@self_link, @next_link]
+        @bookmarks_with_links.new.from_xml(%{<bookmarks/>}).links.must_equal({})
       end
     end
   end

data/test/hypermedia_test.rb

@@ -1,52 +1,39 @@
 require 'test_helper'
+require 'roar/decorator'
 
 class HypermediaTest < MiniTest::Spec
   describe "inheritance" do
-    before do
-      module BaseRepresenter
-        include Roar::JSON
-        include Roar::Hypermedia
+    class BaseRepresenter < Roar::Decorator
+      include Roar::JSON
+      include Roar::Hypermedia
 
-        link(:base) { "http://base" }
-      end
-
-      module Bar
-        include Roar::JSON
-        include Roar::Hypermedia
-
-        link(:bar) { "http://bar" }
-      end
+      link(:base) { "http://base" }
+    end
 
-      module Foo
-        include Roar::JSON
-        include Roar::Hypermedia
-        include BaseRepresenter
-        include Bar
+    class Bar < BaseRepresenter
+      link(:bar) { "http://bar" }
+    end
 
-        link(:foo) { "http://foo" }
-      end
+    class Foo < Bar
+      link(:foo) { "http://foo" }
     end
 
     it "inherits parent links" do
-      foo = Object.new.extend(Foo)
-
-      assert_equal "{\"links\":[{\"rel\":\"base\",\"href\":\"http://base\"},{\"rel\":\"bar\",\"href\":\"http://bar\"},{\"rel\":\"foo\",\"href\":\"http://foo\"}]}", foo.to_json
+      Foo.new(Object.new).to_json.must_equal "{\"links\":[{\"rel\":\"base\",\"href\":\"http://base\"},{\"rel\":\"bar\",\"href\":\"http://bar\"},{\"rel\":\"foo\",\"href\":\"http://foo\"}]}"
     end
 
     it "inherits links from all mixed-in representers" do
-      skip
-      Object.new.extend(BaseRepresenter).extend(Bar).to_json.must_equal "{\"links\":[{\"rel\":\"base\",\"href\":\"http://base\"},{\"rel\":\"bar\",\"href\":\"http://bar\"}]}"
+      Bar.new(Object.new).to_json.must_equal "{\"links\":[{\"rel\":\"base\",\"href\":\"http://base\"},{\"rel\":\"bar\",\"href\":\"http://bar\"}]}"
     end
   end
 
   describe "#links_array" do
-    subject { Object.new.extend(rpr) }
+    subject { decorator_class.new(Object.new) }
 
-    representer_for do
+    decorator_for do
       link(:self) { "//self" }
     end
 
-
     describe "#to_json" do
       it "renders" do
         subject.to_json.must_equal "{\"links\":[{\"rel\":\"self\",\"href\":\"//self\"}]}"
@@ -56,7 +43,7 @@ class HypermediaTest < MiniTest::Spec
     describe "#from_json" do
       it "parses" do
         subject.from_json "{\"links\":[{\"rel\":\"self\",\"href\":\"//self\"}]}"
-        subject.links.must_equal({"self" => link("rel" => "self", "href" => "//self")})
+        subject.links.must_equal("self" => link("rel" => "self", "href" => "//self"))
       end
     end
 
@@ -64,7 +51,7 @@ class HypermediaTest < MiniTest::Spec
     describe "#link" do
 
       describe "with any options" do
-        representer_for do
+        decorator_for do
           link(:rel => :self, :title => "Hey, @myabc") { "//self" }
         end
 
@@ -74,38 +61,39 @@ class HypermediaTest < MiniTest::Spec
       end
 
       describe "with string rel" do
-        representer_for do
+        decorator_for do
           link("ns:self") { "//self" }
         end
 
         it "renders rel" do
+          # raise subject.inspect
           subject.to_json.must_equal "{\"links\":[{\"rel\":\"ns:self\",\"href\":\"//self\"}]}"
         end
       end
 
       describe "passing options to serialize" do
-        representer_for do
+        decorator_for do
           link(:self) { |opts| "//self/#{opts[:id]}" }
         end
 
         it "receives options when rendering" do
-          subject.to_json(:id => 1).must_equal "{\"links\":[{\"rel\":\"self\",\"href\":\"//self/1\"}]}"
+          subject.to_json(user_options: { id: 1 }).must_equal "{\"links\":[{\"rel\":\"self\",\"href\":\"//self/1\"}]}"
         end
 
         describe "in a composition" do
-          representer_for do
+          decorator_for do
             property :entity, :extend => self
             link(:self) { |opts| "//self/#{opts[:id]}" }
           end
 
           it "propagates options" do
-            Song.new(:entity => Song.new).extend(rpr).to_json(:id => 1).must_equal "{\"entity\":{\"links\":[{\"rel\":\"self\",\"href\":\"//self/1\"}]},\"links\":[{\"rel\":\"self\",\"href\":\"//self/1\"}]}"
+            decorator_class.new(Song.new(:entity => Song.new)).to_json(user_options: { id: 1 }).must_equal "{\"entity\":{\"links\":[{\"rel\":\"self\",\"href\":\"//self/1\"}]},\"links\":[{\"rel\":\"self\",\"href\":\"//self/1\"}]}"
           end
         end
       end
 
       describe "returning option hash from block" do
-        representer_for do
+        decorator_for do
           link(:self) do {:href => "//self", :type => "image/jpg"} end
           link(:other) do |params|
             hash = { :href => "//other" }
@@ -119,13 +107,13 @@ class HypermediaTest < MiniTest::Spec
         end
 
         it "is rendered according to context" do
-          subject.to_json(type: true).must_equal "{\"links\":[{\"rel\":\"self\",\"href\":\"//self\",\"type\":\"image/jpg\"},{\"rel\":\"other\",\"href\":\"//other\",\"type\":\"image/jpg\"}]}"
+          subject.to_json(user_options: { type: true }).must_equal "{\"links\":[{\"rel\":\"self\",\"href\":\"//self\",\"type\":\"image/jpg\"},{\"rel\":\"other\",\"href\":\"//other\",\"type\":\"image/jpg\"}]}"
           subject.to_json.must_equal "{\"links\":[{\"rel\":\"self\",\"href\":\"//self\",\"type\":\"image/jpg\"},{\"rel\":\"other\",\"href\":\"//other\"}]}"
         end
       end
 
       describe "not calling #link" do
-        representer_for {}
+        decorator_for {}
 
         it "still allows rendering" do
           subject.to_json.must_equal "{}"
@@ -134,57 +122,3 @@ class HypermediaTest < MiniTest::Spec
     end
   end
 end
-
-class HyperlinkTest < MiniTest::Spec
-  describe "Hyperlink" do
-    subject { link(:rel => "self", "href" => "http://self", "data-whatever" => "Hey, @myabc") }
-
-    it "accepts string keys in constructor" do
-      assert_equal "Hey, @myabc", subject.send("data-whatever")
-    end
-
-    it "responds to #rel" do
-      assert_equal "self", subject.rel
-    end
-
-    it "responds to #href" do
-      assert_equal "http://self", subject.href
-    end
-
-    it "responds to #replace with string keys" do
-      subject.replace("rel" => "next")
-      assert_equal nil, subject.href
-      assert_equal "next", subject.rel
-    end
-
-    it "responds to #each and implements Enumerable" do
-      assert_equal ["rel:self", "href:http://self", "data-whatever:Hey, @myabc"], subject.collect { |k,v| "#{k}:#{v}" }
-    end
-  end
-
-  describe "Config inheritance" do
-      it "doesn't mess up with inheritable_array" do  # FIXME: remove this test when uber is out.
-        OpenStruct.new.extend( Module.new do
-                  include Roar::JSON
-                  include(Module.new do
-                                      include Roar::JSON
-                                      include Roar::Hypermedia
-
-                                      property :bla
-
-                                      link( :self) {"bo"}
-
-                                      #puts "hey ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
-                                      #puts representable_attrs.inheritable_array(:links).inspect
-                                    end)
-
-
-                  #puts representable_attrs.inheritable_array(:links).inspect
-
-                  property :blow
-                  include Roar::Hypermedia
-                  link(:bla) { "boo" }
-                end).to_hash.must_equal({"links"=>[{"rel"=>"self", "href"=>"bo"}, {"rel"=>"bla", "href"=>"boo"}]})
-    end
-  end
-end

data/test/{decorator_client_test.rb → integration/decorator_client_test.rb}

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'integration/runner'
 require 'roar/decorator'
 require 'roar/client'
 
@@ -6,7 +7,7 @@ class DecoratorClientTest < MiniTest::Spec
   class Crew
     attr_accessor :moniker, :company
   end
-  
+
   class CrewDecorator < Roar::Decorator
     include Roar::JSON
     include Roar::Hypermedia
@@ -26,7 +27,7 @@ class DecoratorClientTest < MiniTest::Spec
   before do
     @crew = Crew.new
     @client = CrewClient.new(@crew)
-  end    
+  end
 
   describe 'HttpVerbs integration' do
     describe '#get' do
@@ -54,11 +55,11 @@ class DecoratorClientTest < MiniTest::Spec
       @crew.moniker = 'Silence'
       @client.to_json.must_equal %{{\"name\":\"Silence\",\"links\":[]}}
     end
-    
+
     # since this is considered dangerous, we test the mutuable options.
     it "adds links: false to options" do
       @client.to_hash(options = {})
-      options.must_equal({:links => false})
+      options.must_equal(user_options: {links: false})
     end
   end
 end

data/test/{faraday_http_transport_test.rb → integration/faraday_http_transport_test.rb}

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'integration/runner'
 require 'roar/transport/faraday'
 
 class FaradayHttpTransportTest < MiniTest::Spec

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

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'integration/runner'
 require 'roar/http_verbs'
 require 'roar/json'
 
@@ -80,11 +81,11 @@ class HttpVerbsTest < MiniTest::Spec
     describe "#post" do
       it "updates instance with incoming representation" do
         @band.name = "Strung Out"
-        assert_equal nil, @band.label
+        assert_nil @band.label
 
         @band.post(:uri => "http://localhost:4567/bands", :as => "application/xml")
         assert_equal "STRUNG OUT", @band.name
-        assert_equal nil, @band.label
+        assert_nil @band.label
       end
     end
 

data/test/integration/json_collection_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+require 'roar/json/collection'
+require 'roar/client'
+
+class JsonCollectionTest < MiniTest::Spec
+  class Band < OpenStruct; end
+
+  class BandRepresenter < Roar::Decorator
+    include Roar::JSON
+
+    property :name
+    property :label
+  end
+
+  class BandsRepresenter < Roar::Decorator
+    include Roar::JSON::Collection
+    include Roar::Client
+
+    items extend: BandRepresenter, class: Band
+  end
+
+  class Bands < Array
+    include Roar::JSON::Collection
+  end
+
+  let(:bands) { Bands.new }
+
+  # "[{\"name\":\"Slayer\",\"label\":\"Canadian Maple\"},{\"name\":\"Nirvana\",\"label\":\"Sub Pop\"}])"
+  it 'fetches lonely collection of existing bands' do
+    BandsRepresenter.new(bands).get(uri: 'http://localhost:4567/bands', as: 'application/json')
+    bands.size.must_equal(2)
+    bands[0].name.must_equal('Slayer')
+  end
+end

data/test/{net_http_transport_test.rb → integration/net_http_transport_test.rb}

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'integration/runner'
 require 'roar/transport/net_http'
 
 class NetHTTPTransportTest < MiniTest::Spec

data/test/integration/runner.rb

@@ -1,6 +1,5 @@
 require "integration/band_representer"
-# require 'sinatra/runner' # TODO: merge that into sinatra-contrib.
-require 'lib/runner'
+require 'sinatra/runner'
 
 class ServerRunner < Sinatra::Runner
   def app_file
@@ -46,4 +45,4 @@ rescue Exception => e
   ssl_runner.kill
 
   raise e
-end
+end

data/test/integration/server.rb

@@ -55,6 +55,12 @@ post "/bands" do
   status 201
 end
 
+get '/bands' do
+  [OpenStruct.new(:name => "Slayer", :label => "Canadian Maple"),
+   OpenStruct.new(:name => "Nirvana", :label => "Sub Pop")]
+    .extend(Integration::BandRepresenter.for_collection).to_json
+end
+
 put "/bands/strungout" do
   # DISCUSS: as long as we don't agree on what to return in PUT/PATCH, let's return an updated document.
   body consume_band.to_json

data/test/json_representer_test.rb

@@ -61,7 +61,7 @@ class JsonRepresenterTest < MiniTest::Spec
 
       it "accepts :include and :exclude" do
         @order.from_json('{"id":1}', :exclude => [:id])
-        assert_equal nil, @order.id
+        assert_nil @order.id
       end
     end
 
@@ -74,32 +74,6 @@ class JsonRepresenterTest < MiniTest::Spec
   end
 end
 
-# test the generic roar+json HyperlinkRepresenter
-class JsonHyperlinkRepresenterTest
-  describe "API" do
-    before do
-      @link = Roar::Hypermedia::Hyperlink.new.extend(Roar::JSON::HyperlinkRepresenter).from_json(
-        '{"rel":"self", "href":"http://roar.apotomo.de", "media":"web"}')
-    end
-
-    it "responds to #rel" do
-      assert_equal "self", @link.rel
-    end
-
-    it "responds to #href" do
-      assert_equal "http://roar.apotomo.de", @link.href
-    end
-
-    it "responds to #media" do
-      assert_equal "web", @link.media
-    end
-
-    it "responds to #to_json" do
-      assert_equal "{\"rel\":\"self\",\"href\":\"http://roar.apotomo.de\",\"media\":\"web\"}", @link.to_json
-    end
-  end
-end
-
 class JsonHypermediaTest
   describe "Hypermedia API" do
     before do
@@ -119,7 +93,7 @@ class JsonHypermediaTest
     end
 
     it "responds to #links" do
-      @r.links.must_equal nil
+      @r.links.must_equal({})
     end
 
     it "extracts links from JSON" do
@@ -146,4 +120,3 @@ class JsonHypermediaTest
 
   end
 end
-