roar 0.11.15 → 0.11.16

data/.travis.yml

@@ -4,5 +4,4 @@ rvm:
 notifications:
   irc: "irc.freenode.org#cells"
 gemfile:
-  - gemfiles/Gemfile.representable-1.3
   - gemfiles/Gemfile.representable-1.4

data/CHANGES.markdown

@@ -1,3 +1,7 @@
+# 0.11.16
+
+* Added `Roar::Decorator::HypermediaConsumer` which propagates incoming hypermedia links to the represented object (it has to have accessors for `:links`).
+
 # 0.11.15
 
 * Fixing [#66](https://github.com/apotonick/roar/issues/66).

data/README.textile

@@ -281,6 +281,24 @@ order.post(order.links[:self])
 
 This was dead simple since representations can be composed of different documents in Roar.
 
+h2. Decorators
+
+You can use `Roar::Decorator` as a representer. More docs coming soon. Note that if you want your represented object to save incoming hypermedia you need to do two things.
+
+<pre>
+class SongClient
+  # do whatever here
+
+  attr_accessor :links
+end
+
+class SongRepresenter < Roar::Decorator
+  include Roar::Representer::JSON
+  include Roar::Decorator::HypermediaConsumer
+end
+</pre>
+
+
 h2. More Features
 
 Be sure to check out the bundled features.

data/TODO.markdown

@@ -1,4 +1,5 @@
 * Add proxies, so nested models can be lazy-loaded.
 * move #prepare_links! call to #_links or something so it doesn't need to be called in #serialize.
 * alias Roar::Representer to Representer
-* remove #before_serialize and just overwrite #serialize
+* remove #before_serialize and just overwrite #serialize
+* abstract ::links_definition_options and move them out of the generic representers (JSON, XML). remove lambdas when :representer_exec calls methods in decorator ctx, also

data/lib/roar/decorator.rb

@@ -1,3 +1,10 @@
 class Roar::Decorator < Representable::Decorator
   extend Roar::Representer::InheritableArray
+
+  module HypermediaConsumer
+    def links_array=(*args)
+      super # TODO: this currently sets #links which is not obvious.
+      represented.links = links
+    end
+  end
 end

data/lib/roar/representer/feature/hypermedia.rb

@@ -70,6 +70,12 @@ module Roar
         include LinkConfigsMethod
 
       private
+        def links_definition_options
+          # TODO: this method is never called.
+          [:links_array, {:from => :link, :class => Feature::Hypermedia::Hyperlink, :collection => true,
+            :representer_exec => true, :getter => lambda { |*| links_array }, :setter => lambda { |val,*| links_array=(val) } }] # TODO: merge with JSON.
+        end
+
         # Setup hypermedia links by invoking their blocks. Usually called by #serialize.
         def prepare_links!(*args)
           # TODO: move this method to _links or something so it doesn't need to be called in #serialize.

data/lib/roar/representer/json.rb

@@ -45,7 +45,9 @@ module Roar
 
         # TODO: move to instance method, or remove?
         def links_definition_options
-          [:links_array, {:from => :links, :class => Feature::Hypermedia::Hyperlink, :extend => HyperlinkRepresenter, :collection => true}]
+          # FIXME: this doesn't belong into the generic JSON representer.
+          [:links_array, {:from => :links, :class => Feature::Hypermedia::Hyperlink, :extend => HyperlinkRepresenter, :collection => true,
+            :representer_exec => true, :getter => lambda { |*| links_array }, :setter => lambda { |val,*| self.links_array=(val) } }]
         end
       end
 

data/lib/roar/representer/json/hal.rb

@@ -157,9 +157,11 @@ module Roar::Representer
           def links_definition_options
             [:links,
               {
-                :from     => :links,
+                :as       => :links,
                 :extend   => HAL::Links::LinkCollectionRepresenter,
-                :instance => lambda { |hsh| LinkCollection.new(link_array_rels) }  # defined in InstanceMethods as this is executed in represented context.
+                :instance => lambda { |hsh| LinkCollection.new(link_array_rels) }, # defined in InstanceMethods as this is executed in represented context.
+                :representer_exec => true,
+                :getter => lambda { |*| links }
               }
             ]
           end

data/lib/roar/representer/xml.rb

@@ -38,7 +38,9 @@ module Roar
         include Representable::XML::ClassMethods
 
         def links_definition_options
-          [:links_array, {:from => :link, :class => Feature::Hypermedia::Hyperlink, :collection => true, :extend => XML::HyperlinkRepresenter}]
+          # FIXME: this doesn't belong into the generic XML representer.
+          [:links_array, {:from => :link, :class => Feature::Hypermedia::Hyperlink, :collection => true, :extend => XML::HyperlinkRepresenter,
+            :representer_exec => true, :getter => lambda { |*| links_array }, :setter => lambda { |val,*| self.links_array=(val) } }] # TODO: merge with JSON.
         end
 
         # Generic entry-point for parsing.

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "0.11.15"
+  VERSION = "0.11.16"
 end

data/roar.gemspec

@@ -19,7 +19,7 @@ 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", ">= 1.2.8"
+  s.add_runtime_dependency "representable", ">= 1.4.2"
 
   s.add_development_dependency "rake"
   s.add_development_dependency "test_xml", ">= 0.1.4"

data/test/decorator_test.rb

@@ -1,21 +1,92 @@
 require 'test_helper'
+require 'roar/decorator'
 
 class DecoratorTest < MiniTest::Spec
-
-
   describe "Decorator" do
     it "exposes ::prepare" do
-      require 'representable/version'
-      if Representable::VERSION.split(".")[1] == "4"
-        require 'roar/decorator'
+      class SongRepresentation < Roar::Decorator
+        include Roar::Representer::JSON
+
+        property :name
+      end
 
-        class SongRepresentation < Roar::Decorator
-          include Roar::Representer::JSON
+      SongRepresentation.prepare(OpenStruct.new(:name => "Not The Same")).to_hash.must_equal({"name"=>"Not The Same"})
+    end
+  end
+
+  describe "Hypermedia modules" do
+    representer_for do
+      link(:self) { "http://self" } # TODO: test with Collection::JSON, too.
+    end
 
-          property :name
+    let (:model) { Object.new }
+
+    describe "JSON" do
+      let (:decorator) { rpr_mod = rpr
+        Class.new(Roar::Decorator) do
+          include rpr_mod
+        end }
+
+      it "rendering links works" do
+        decorator.new(model).to_hash.must_equal({"links"=>[{:rel=>:self, :href=>"http://self"}]})
+      end
+
+      it "sets links on decorator" do
+        decorator.new(model).from_hash("links"=>[{:rel=>:self, :href=>"http://self"}]).links.must_equal("self"=>link(:rel=>:self, :href=>"http://self"))
+      end
+
+      let (:model_with_links) { model.singleton_class.instance_eval { attr_accessor :links }; model }
+      it "does not set links on represented" do
+        decorator.new(model_with_links).from_hash("links"=>[{:rel=>:self, :href=>"http://self"}])
+        model_with_links.links.must_equal nil
+      end
+
+      describe "Decorator::HypermediaClient" do
+        let (:decorator) { rpr_mod = rpr
+          Class.new(Roar::Decorator) do
+            include rpr_mod
+            include Roar::Decorator::HypermediaConsumer
+          end }
+
+        it "propagates links to represented" do
+          decorator.new(model_with_links).from_hash("links"=>[{:rel=>:self, :href=>"http://self"}])
+          model_with_links.links[:self].must_equal(link(:rel=>:self, :href=>"http://self"))
         end
+      end
+    end
+
+    describe "XML" do
+      representer_for([Roar::Representer::XML, Roar::Representer::Feature::Hypermedia]) do
+        link(:self) { "http://self" } # TODO: test with HAL, too.
+        #self.representation_wrap = :song   # FIXME: why isn't this working?
+      end
+      let (:decorator) { rpr_mod = rpr
+        Class.new(Roar::Decorator) do
+          include rpr_mod
+          self.representation_wrap = :song
+        end }
+
+      it "rendering links works" do
+        decorator.new(model).to_xml.must_equal_xml "<song><link rel=\"self\" href=\"http://self\"/></song>"
+      end
+
+      it "sets links on decorator" do
+        decorator.new(model).from_xml(%{<song><link rel="self" href="http://self"/></song>}).links.must_equal("self"=>link(:rel=>:self, :href=>"http://self"))
+      end
+    end
+
+
+    describe "JSON::HAL" do
+      representer_for([Roar::Representer::JSON::HAL]) do
+        link(:self) { "http://self" }
+      end
+      let (:decorator) { rpr_mod = rpr
+        Class.new(Roar::Decorator) do
+          include rpr_mod
+        end }
 
-        SongRepresentation.prepare(OpenStruct.new(:name => "Not The Same")).to_hash.must_equal({"name"=>"Not The Same"})
+      it "rendering links works" do
+        decorator.new(model).to_hash.must_equal({"_links"=>{"self"=>{:href=>"http://self"}}})
       end
     end
   end

data/test/test_helper.rb

@@ -7,6 +7,7 @@ require 'ostruct'
 
 require 'roar/representer'
 require 'roar/representer/feature/http_verbs'
+require 'roar/representer/json/hal'
 
 begin
   require 'turn'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roar
 version: !ruby/object:Gem::Version
-  version: 0.11.15
+  version: 0.11.16
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-30 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.8
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.8
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -91,7 +91,6 @@ files:
 - README.textile
 - Rakefile
 - TODO.markdown
-- gemfiles/Gemfile.representable-1.3
 - gemfiles/Gemfile.representable-1.4
 - lib/roar.rb
 - lib/roar/decorator.rb

data/gemfiles/Gemfile.representable-1.3

@@ -1,13 +0,0 @@
-source "http://rubygems.org"
-
-gemspec :path => '../'
-
-gem 'representable', '~> 1.3.1'
-group :test do
-  gem 'faraday'
-  gem 'turn'
-  gem 'virtus'
-  gem "sinatra",   "~> 1.3.2"
-  gem "sham_rack", "~> 1.3.0"
-  gem "json"
-end