roar 1.0.4 → 1.1.0

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

data/lib/roar/xml.rb

@@ -35,10 +35,10 @@ module Roar
         # FIXME: this doesn't belong into the generic XML representer.
         {
           :as => :link,
-          :collection   => true,
           :class        => Hypermedia::Hyperlink,
           :extend       => XML::HyperlinkRepresenter,
           :exec_context => :decorator,
+          collection: true
           } # TODO: merge with JSON.
       end
     end

data/roar.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Nick Sutterer"]
   s.email       = ["apotonick@gmail.com"]
-  s.homepage    = "http://rubygems.org/gems/roar"
+  s.homepage    = "http://trailblazer.to/gems/roar"
   s.summary     = %q{Parse and render REST API documents using representers.}
   s.description = %q{Object-oriented representers help you defining nested REST API documents which can then be rendered and parsed using one and the same concept.}
   s.license = 'MIT'
@@ -17,14 +17,14 @@ 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", ">= 2.0.1", "< 2.4.0"
+  s.add_runtime_dependency "representable", "~> 3.0.0"
 
   s.add_development_dependency "rake", ">= 0.10.1"
   s.add_development_dependency "test_xml", "0.1.6"
-  s.add_development_dependency "minitest",	">= 5.4.2"
-  s.add_development_dependency "sinatra"
-  s.add_development_dependency "sinatra-contrib"
+  s.add_development_dependency 'minitest', '>= 5.10'
+  s.add_development_dependency "sinatra", '>= 2.0.0'
+  s.add_development_dependency "sinatra-contrib", '>= 2.0.0'
   s.add_development_dependency "virtus", ">= 1.0.0"
   s.add_development_dependency "faraday"
-  s.add_development_dependency "json"
+  s.add_development_dependency "multi_json"
 end

data/test/client_test.rb

@@ -30,7 +30,7 @@ class ClientTest < MiniTest::Spec
     # since this is considered dangerous, we test the mutuable options.
     it "adds links: false to options" do
       song.to_hash(options = {})
-      options.must_equal({:links => false})
+      options.must_equal(user_options: {links: false})
     end
   end
 end

data/test/coercion_feature_test.rb

@@ -1,14 +1,17 @@
 require 'test_helper'
 require 'roar/coercion'
+require 'roar/decorator'
 
 class CoercionFeatureTest < MiniTest::Spec
   describe "Coercion" do
-    class ImmigrantSong
+    class SongDecorator < Roar::Decorator
       include Roar::JSON
       include Roar::Coercion
 
       property :composed_at, :type => DateTime, :default => "May 12th, 2012"
+    end
 
+    class ImmigrantSong
       attr_accessor :composed_at
       def composed_at=(v) # in ruby 2.2, #label= is not there, all at sudden. what *is* that?
         @composed_at = v
@@ -16,7 +19,9 @@ class CoercionFeatureTest < MiniTest::Spec
     end
 
     it "coerces into the provided type" do
-      song = ImmigrantSong.new.from_json("{\"composed_at\":\"November 18th, 1983\"}")
+      song      = ImmigrantSong.new
+      decorator = SongDecorator.new(song)
+      decorator.from_json("{\"composed_at\":\"November 18th, 1983\"}")
       assert_equal DateTime.parse("Fri, 18 Nov 1983 00:00:00 +0000"), song.composed_at
     end
   end

data/test/decorator_test.rb

@@ -27,11 +27,15 @@ class DecoratorTest < MiniTest::Spec
     describe "JSON" do
       let (:decorator_class) { rpr_mod = rpr
         Class.new(Roar::Decorator) do
+          include Roar::JSON
+          include Roar::Hypermedia
+
           include rpr_mod
         end }
       let (:decorator) { decorator_class.new(model) }
 
-      it "rendering links works" do
+      it "xxxrendering links works" do
+        pp decorator.send(:representable_attrs)
         decorator.to_hash.must_equal({"links"=>[{"rel"=>"self", "href"=>"http://self"}]})
       end
 
@@ -42,7 +46,7 @@ class DecoratorTest < MiniTest::Spec
 
       it "does not set links on represented" do
         decorator_class.new(model_with_links).from_hash("links"=>[{:rel=>:self, :href=>"http://self"}])
-        model_with_links.links.must_equal nil
+        model_with_links.links.must_be_nil
       end
 
       class ConsumingDecorator < Roar::Decorator
@@ -63,10 +67,10 @@ class DecoratorTest < MiniTest::Spec
           decorator.from_hash("links"=>[{:rel=>:self, :href=>"http://percolator"}])
 
           # links are always set on decorator instance.
-          decorator       .links[:self].must_equal(link(:rel=>:self, :href=>"http://percolator"))
+          decorator.links["self"].must_equal(link(:rel=>:self, :href=>"http://percolator"))
 
           # and propagated to represented with HypermediaConsumer.
-          model_with_links.links[:self].must_equal(link(:rel=>:self, :href=>"http://percolator"))
+          model_with_links.links["self"].must_equal(link(:rel=>:self, :href=>"http://percolator"))
         end
       end
     end
@@ -78,6 +82,8 @@ class DecoratorTest < MiniTest::Spec
       end
       let (:decorator_class) { rpr_mod = rpr
         Class.new(Roar::Decorator) do
+          include Roar::XML
+          include Roar::Hypermedia
           include rpr_mod
           self.representation_wrap = :song
         end
@@ -97,10 +103,13 @@ class DecoratorTest < MiniTest::Spec
 
     describe "JSON::HAL" do
       representer_for([Roar::JSON::HAL]) do
+        # feature Roar::JSON::HAL
         link(:self) { "http://self" }
       end
       let (:decorator_class) { rpr_mod = rpr
         Class.new(Roar::Decorator) do
+          include Roar::JSON::HAL
+
           include rpr_mod
         end
       }
@@ -116,15 +125,16 @@ class DecoratorTest < MiniTest::Spec
       end
 
       describe "Decorator::HypermediaClient" do
-        let (:decorator) { rpr_mod = rpr
+        let (:decorator_class) { rpr_mod = rpr
           Class.new(Roar::Decorator) do
+            include Roar::JSON::HAL
             include rpr_mod
             include Roar::Decorator::HypermediaConsumer
           end }
 
         it "propagates links to represented" do
-          decorator.new(model_with_links).from_hash("_links"=>{"self"=>{:href=>"http://self"}})
-          model_with_links.links[:self].must_equal(link(:rel=>"self", :href=>"http://self"))
+          decorator_class.new(model_with_links).from_hash("_links"=>{"self"=>{:href=>"http://self"}})
+          model_with_links.links["self"].must_equal(link(:rel=>"self", :href=>"http://self"))
         end
       end
     end

data/test/hal_json_test.rb

@@ -2,8 +2,8 @@ require 'test_helper'
 require 'roar/json/hal'
 
 class HalJsonTest < MiniTest::Spec
-  let(:rpr) do
-    Module.new do
+  let(:decorator_class) do
+    Class.new(Roar::Decorator) do
       include Roar::JSON
       include Roar::JSON::HAL
 
@@ -18,112 +18,107 @@ class HalJsonTest < MiniTest::Spec
     end
   end
 
-  subject { Object.new.extend(rpr) }
+  subject { decorator_class.new(Object.new) }
 
   describe "links" do
     describe "parsing" do
       it "parses link array" do # TODO: remove me.
         obj = subject.from_json("{\"_links\":{\"self\":[{\"lang\":\"en\",\"href\":\"http://en.hit\"},{\"lang\":\"de\",\"href\":\"http://de.hit\"}]}}")
-        obj.links.must_equal "self" => [link("rel" => "self", "href" => "http://en.hit", "lang" => "en"), link("rel" => "self", "href" => "http://de.hit", "lang" => "de")]
+        subject.links.must_equal "self" => [link("rel" => "self", "href" => "http://en.hit", "lang" => "en"), link("rel" => "self", "href" => "http://de.hit", "lang" => "de")]
       end
 
       it "parses single links" do # TODO: remove me.
         obj = subject.from_json("{\"_links\":{\"next\":{\"href\":\"http://next\"}}}")
-        obj.links.must_equal "next" => link("rel" => "next", "href" => "http://next")
+        subject.links.must_equal "next" => link("rel" => "next", "href" => "http://next")
       end
 
       it "parses link and link array" do
-        obj = subject.from_json("{\"_links\":{\"next\":{\"href\":\"http://next\"}, \"self\":[{\"lang\":\"en\",\"href\":\"http://en.hit\"},{\"lang\":\"de\",\"href\":\"http://de.hit\"}]}}")
-        obj.links.must_equal "next" => link("rel" => "next", "href" => "http://next"), "self" => [link("rel" => "self", "href" => "http://en.hit", "lang" => "en"), link("rel" => "self", "href" => "http://de.hit", "lang" => "de")]
+        obj = subject.from_json(%@{"_links":{"next":{"href":"http://next"}, "self":[{"lang":"en","href":"http://en.hit"},{"lang":"de","href":"http://de.hit"}]}}@)
+        subject._links.must_equal "next"=>link("rel" => "next", "href" => "http://next"), "self"=>[link("rel" => "self", "href" => "http://en.hit", "lang" => "en"), link("rel" => "self", "href" => "http://de.hit", "lang" => "de")]
       end
 
       it "parses empty link array" do
-        subject.from_json("{\"_links\":{\"self\":[]}}").links[:self].must_equal []
+        subject.from_json("{\"_links\":{\"self\":[]}}")
+        subject.links[:self].must_be_nil
       end
 
       it "parses non-existent link array" do
-        subject.from_json("{\"_links\":{}}").links[:self].must_equal nil # DISCUSS: should this be []?
+        subject.from_json("{\"_links\":{}}")
+        subject.links[:self].must_be_nil # DISCUSS: should this be []?
       end
 
-      it "rejects single links declared as array" do
-        assert_raises TypeError do
-          subject.from_json("{\"_links\":{\"self\":{\"href\":\"http://next\"}}}")
-        end
-      end
+      # it "rejects single links declared as array" do
+      #   assert_raises TypeError do
+      #     subject.from_json("{\"_links\":{\"self\":{\"href\":\"http://next\"}}}")
+      #   end
+      # end
     end
 
     describe "rendering" do
       it "renders link and link array" do
         subject.to_json.must_equal "{\"_links\":{\"self\":[{\"lang\":\"en\",\"href\":\"http://en.hit\"},{\"lang\":\"de\",\"href\":\"http://de.hit\"}],\"next\":{\"href\":\"http://next\"}}}"
       end
+    end
+  end
 
-      it "renders empty link array" do
-        rpr = Module.new do
-          include Roar::JSON::HAL
+  describe "empty link array" do
+    let(:decorator_class) do
+      Class.new(Roar::Decorator) do
+        include Roar::JSON
+        include Roar::JSON::HAL
 
-          links :self do [] end
-        end
-        subject = Object.new.extend(rpr)
-
-        subject.to_json.must_equal "{\"_links\":{\"self\":[]}}"
+        links(:self) { [] }
       end
     end
-  end
 
-  # describe "#prepare_links!" do
-  #   it "should map link arrays correctly" do
-  #     subject.send :prepare_links!, {}
-  #     subject.links.must_equal :self => [link("rel" => "self", "href" => "http://en.hit", "lang" => "en"),link("rel" => :self, "href" => "http://de.hit", "lang" => "de")], "next" => link("href" => "http://next", "rel" => "next")
-  #   end
-  # end
+    subject { decorator_class.new(Object.new) }
 
-  describe "#link_array_rels" do
-    it "returns list of rels for array links" do
-      subject.send(:link_array_rels).must_equal [:self]
+    it "gets render" do
+      subject.to_json.must_equal %@{"_links":{"self":[]}}@
     end
   end
 
 
-  describe "HAL/JSON" do
-    Bla = Module.new do
-      include Roar::JSON::HAL
-      property :title
-      link :self do
-        "http://songs/#{title}"
-      end
-    end
+  describe "_links and _embedded" do
+    let(:decorator_class) do
+      Class.new(Roar::Decorator) do
+        include Roar::JSON
+        include Roar::JSON::HAL
 
-    representer_for([Roar::JSON::HAL]) do
-      property :id
-      collection :songs, :class => Song, :extend => Bla, :embedded => true
-      link :self do
-        "http://albums/#{id}"
+        property :id
+        collection :songs, class: Song, embedded: true do
+          include Roar::JSON::HAL
+
+          property :title
+          link(:self) { "http://songs/#{represented.title}" }
+        end
+
+        link(:self) { "http://albums/#{represented.id}" }
       end
     end
 
-    before do
-      @album = Album.new(:songs => [Song.new(:title => "Beer")], :id => 1).extend(rpr)
-    end
+    let(:album) { Album.new(:songs => [Song.new(:title => "Beer")], :id => 1) }
+    subject { decorator_class.new(album) }
 
     it "render links and embedded resources according to HAL" do
-      assert_equal "{\"id\":1,\"_embedded\":{\"songs\":[{\"title\":\"Beer\",\"_links\":{\"self\":{\"href\":\"http://songs/Beer\"}}}]},\"_links\":{\"self\":{\"href\":\"http://albums/1\"}}}", @album.to_json
+      subject.to_json.must_equal "{\"id\":1,\"_embedded\":{\"songs\":[{\"title\":\"Beer\",\"_links\":{\"self\":{\"href\":\"http://songs/Beer\"}}}]},\"_links\":{\"self\":{\"href\":\"http://albums/1\"}}}"
     end
 
     it "parses links and resources following the mighty HAL" do
-      @album.from_json("{\"id\":2,\"_embedded\":{\"songs\":[{\"title\":\"Coffee\",\"_links\":{\"self\":{\"href\":\"http://songs/Coffee\"}}}]},\"_links\":{\"self\":{\"href\":\"http://albums/2\"}}}")
-      assert_equal 2, @album.id
-      assert_equal "Coffee", @album.songs.first.title
-      assert_equal "http://songs/Coffee", @album.songs.first.links[:self].href
-      assert_equal "http://albums/2", @album.links[:self].href
+      subject.from_json("{\"id\":2,\"_embedded\":{\"songs\":[{\"title\":\"Coffee\",\"_links\":{\"self\":{\"href\":\"http://songs/Coffee\"}}}]},\"_links\":{\"self\":{\"href\":\"http://albums/2\"}}}")
+      assert_equal 2, album.id
+      assert_equal "Coffee", album.songs.first.title
+      # FIXME assert_equal "http://songs/Coffee", subject.songs.first.links["self"].href
+      assert_equal "http://albums/2", subject.links["self"].href
     end
 
     it "doesn't require _links and _embedded to be present" do
-      @album.from_json("{\"id\":2}")
-      assert_equal 2, @album.id
+      subject.from_json("{\"id\":2}")
+      assert_equal 2, album.id
 
       # in newer representables, this is not overwritten to an empty [] anymore.
-      assert_equal ["Beer"], @album.songs.map(&:title)
-      @album.links.must_equal nil
+      assert_equal ["Beer"], album.songs.map(&:title)
+      album.links.must_be_nil
     end
   end
 
@@ -134,73 +129,70 @@ class JsonHalTest < MiniTest::Spec
   Artist = Struct.new(:name)
   Song = Struct.new(:title)
 
-  def self.representer!
-    super([Roar::JSON::HAL])
-  end
-
-  def representer
-    rpr
-  end
-
   describe "render_nil: false" do
-    representer! do
-      property :artist, embedded: true, render_nil: false do
-        property :name
-      end
+    let(:decorator_class) do
+      Class.new(Roar::Decorator) do
+        include Roar::JSON
+        include Roar::JSON::HAL
 
-      collection :songs, embedded: true, render_empty: false do
-        property :title
+        property :artist, embedded: true, render_nil: false do
+          property :name
+        end
+
+        collection :songs, embedded: true, render_empty: false do
+          property :title
+        end
       end
     end
 
-    it { Album.new(Artist.new("Bare, Jr."), [Song.new("Tobacco Spit")]).extend(representer).to_hash.must_equal({"_embedded"=>{"artist"=>{"name"=>"Bare, Jr."}, "songs"=>[{"title"=>"Tobacco Spit"}]}}) }
-    it { Album.new.extend(representer).to_hash.must_equal({}) }
+    it { decorator_class.new(Album.new(Artist.new("Bare, Jr."), [Song.new("Tobacco Spit")])).to_hash.must_equal({"_embedded"=>{"artist"=>{"name"=>"Bare, Jr."}, "songs"=>[{"title"=>"Tobacco Spit"}]}}) }
+    it { decorator_class.new(Album.new).to_hash.must_equal({}) }
   end
 
   describe "as: alias" do
-    representer! do
-      property :artist, as: :my_artist, class: Artist, embedded: true do
-        property :name
-      end
+    let(:decorator_class) do
+      Class.new(Roar::Decorator) do
+        include Roar::JSON
+        include Roar::JSON::HAL
 
-      collection :songs, as: :my_songs, class: Song, embedded: true do
-        property :title
+        property :artist, as: :my_artist, class: Artist, embedded: true do
+          property :name
+        end
+
+        collection :songs, as: :my_songs, class: Song, embedded: true do
+          property :title
+        end
       end
     end
 
-    it { Album.new(Artist.new("Bare, Jr."), [Song.new("Tobacco Spit")]).extend(representer).to_hash.must_equal({"_embedded"=>{"my_artist"=>{"name"=>"Bare, Jr."}, "my_songs"=>[{"title"=>"Tobacco Spit"}]}}) }
-    it { Album.new.extend(representer).from_hash({"_embedded"=>{"my_artist"=>{"name"=>"Bare, Jr."}, "my_songs"=>[{"title"=>"Tobacco Spit"}]}}).inspect.must_equal "#<struct JsonHalTest::Album artist=#<struct JsonHalTest::Artist name=\"Bare, Jr.\">, songs=[#<struct JsonHalTest::Song title=\"Tobacco Spit\">]>" }
+    it { decorator_class.new(Album.new(Artist.new("Bare, Jr."), [Song.new("Tobacco Spit")])).to_hash.must_equal({"_embedded"=>{"my_artist"=>{"name"=>"Bare, Jr."}, "my_songs"=>[{"title"=>"Tobacco Spit"}]}}) }
+    it { decorator_class.new(Album.new).from_hash({"_embedded"=>{"my_artist"=>{"name"=>"Bare, Jr."}, "my_songs"=>[{"title"=>"Tobacco Spit"}]}}).inspect.must_equal "#<struct JsonHalTest::Album artist=#<struct JsonHalTest::Artist name=\"Bare, Jr.\">, songs=[#<struct JsonHalTest::Song title=\"Tobacco Spit\">]>" }
   end
 end
 
+class HalCurieTest < MiniTest::Spec
+  let(:decorator_class) do
+    Class.new(Roar::Decorator) do
+      include Roar::JSON
+      include Roar::JSON::HAL
 
-class LinkCollectionTest < MiniTest::Spec
-  subject { Roar::JSON::HAL::LinkCollection.new([:self, "next"]) }
-  describe "#is_array?" do
-    it "returns true for array link" do
-      subject.is_array?(:self).must_equal true
-      subject.is_array?("self").must_equal true
-    end
-
-    it "returns false otherwise" do
-      subject.is_array?("prev").must_equal false
-    end
-  end
-end
-
+      link "doc:self" do
+        "/"
+      end
 
-class HalCurieTest < MiniTest::Spec
-  representer!([Roar::JSON::HAL]) do
-    link "doc:self" do
-      "/"
-    end
+      links "doc:link_collection" do
+        [{:name => "link_collection", :href => "/"}]
+      end
 
-    curies do
-      [{:name => :doc,
-        :href => "//docs/{rel}",
-        :templated => true}]
+      curies do
+        [{:name => :doc,
+          :href => "//docs/{rel}",
+          :templated => true}]
+      end
     end
   end
 
-  it { Object.new.extend(rpr).to_hash.must_equal({"_links"=>{"doc:self"=>{"href"=>"/"}, :curies=>[{"name"=>:doc, "href"=>"//docs/{rel}", "templated"=>true}]}}) }
+  subject { decorator_class.new(Object.new) }
+
+  it { subject.to_hash.must_equal({"_links"=>{"doc:self"=>{"href"=>"/"}, "doc:link_collection"=>[{"name"=>"link_collection", "href"=>"/"}], "curies"=>[{"name"=>:doc, "href"=>"//docs/{rel}", "templated"=>true}]}}) }
 end