roar 0.12.1 → 0.12.2

data/examples/example.rb

@@ -0,0 +1,368 @@
+require 'bundler'
+Bundler.setup
+
+require 'ostruct'
+require 'roar/representer/json'
+
+def reset_representer(*module_name)
+  module_name.each do |mod|
+    mod.module_eval do
+      @representable_attrs = nil
+    end
+  end
+end
+
+
+class Song < OpenStruct
+end
+
+module SongRepresenter
+  include Roar::Representer::JSON
+
+  property :title
+end
+
+song = Song.new(title: "Fate").extend(SongRepresenter)
+puts song.to_json
+
+# Parsing
+
+song = Song.new.extend(SongRepresenter)
+song.from_json('{"title":"Linoleum"}')
+puts song.title
+
+
+# Decorator
+
+require 'roar/decorator'
+
+module Decorator
+  class SongRepresenter < Roar::Decorator
+    include Roar::Representer::JSON
+
+    property :title
+  end
+end
+
+song = Song.new(title: "Medicine Balls")
+puts Decorator::SongRepresenter.new(song).to_json
+
+# Collections
+
+reset_representer(SongRepresenter)
+
+module SongRepresenter
+  include Roar::Representer::JSON
+
+  property :title
+  collection :composers
+end
+
+
+song = Song.new(title: "Roxanne", composers: ["Sting", "Stu Copeland"])
+song.extend(SongRepresenter)
+puts song.to_json
+
+# Nesting
+
+class Album < OpenStruct
+end
+
+module AlbumRepresenter
+  include Roar::Representer::JSON
+
+  property :title
+  collection :songs, extend: SongRepresenter, class: Song
+end
+
+album = Album.new(title: "True North", songs: [Song.new(title: "The Island"), Song.new(:title => "Changing Tide")])
+album.extend(AlbumRepresenter)
+puts album.to_json
+
+album = Album.new
+album.extend(AlbumRepresenter)
+
+album.from_json('{"title":"Indestructible","songs":[{"title":"Tropical London"},{"title":"Roadblock"}]}')
+
+puts album.songs.last.inspect
+
+# Inline Representers # FIXME: what about collections?
+
+reset_representer(AlbumRepresenter)
+
+module AlbumRepresenter
+  include Roar::Representer::JSON
+
+  property :title
+
+  collection :songs, class: Song do
+    property :title
+  end
+end
+
+album = Album.new(title: "True North", songs: [Song.new(title: "The Island"), Song.new(:title => "Changing Tide")])
+album.extend(AlbumRepresenter)
+puts album.to_json
+
+
+
+album = Album.new
+album.extend(AlbumRepresenter)
+album.from_json('{"title":"True North","songs":[{"title":"The Island"},{"title":"Changing Tide"}]}')
+puts album.title
+puts album.songs.first.title
+
+# parse_strategy: :sync
+
+reset_representer(AlbumRepresenter)
+
+module AlbumRepresenter
+  include Roar::Representer::JSON
+
+  property :title
+
+  collection :songs, extend: SongRepresenter, parse_strategy: :sync
+end
+
+
+album = Album.new(title: "True North", songs: [Song.new(title: "The Island"), Song.new(:title => "Changing Tide")])
+album.extend(AlbumRepresenter)
+
+puts album.songs[0].object_id
+album.from_json('{"title":"True North","songs":[{"title":"Secret Society"},{"title":"Changing Tide"}]}')
+puts album.songs[0].title
+puts album.songs[0].object_id##
+
+# Coercion, renaming, ..
+
+# Hypermedia
+
+reset_representer(SongRepresenter)
+
+module SongRepresenter
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+
+  property :title
+
+  link :self do
+    "http://songs/#{title}"
+  end
+end
+
+song.extend(SongRepresenter)
+puts song.to_json
+
+# roar-rails and URL helpers
+
+
+# Passing options into link
+
+reset_representer(SongRepresenter)
+
+module SongRepresenter
+  include Roar::Representer::JSON
+
+  property :title
+
+  link :self do |opts|
+    "http://#{opts[:base_url]}songs/#{title}"
+  end
+end
+
+song.extend(SongRepresenter)
+puts song.to_json(base_url: "localhost:3001/")
+
+
+# Discovering Hypermedia
+
+song = Song.new.extend(SongRepresenter)
+song.from_json('{"title":"Roxanne","links":[{"rel":"self","href":"http://songs/Roxanne"}]}')
+puts song.links[:self].href
+
+# Media Formats: HAL
+
+require 'roar/representer/json/hal'
+
+module HAL
+  module SongRepresenter
+    include Roar::Representer::JSON::HAL
+
+    property :title
+
+    link :self do
+      "http://songs/#{title}"
+    end
+  end
+end
+
+song.extend(HAL::SongRepresenter)
+puts song.to_json
+
+reset_representer(AlbumRepresenter)
+
+module AlbumRepresenter
+  include Roar::Representer::JSON::HAL
+
+  property :title
+
+  collection :songs, class: Song, embedded: true do
+    property :title
+  end
+end
+
+album = Album.new(title: "True North", songs: [Song.new(title: "The Island"), Song.new(:title => "Changing Tide")])
+album.extend(AlbumRepresenter)
+puts album.to_json
+
+# Media Formats: JSON+Collection
+
+require 'roar/representer/json/collection_json'
+
+
+module Collection
+  module SongRepresenter
+    include Roar::Representer::JSON::CollectionJSON
+    version "1.0"
+    href { "http://localhost/songs/" }
+
+    property :title
+
+    items(:class => Song) do
+      href { "//songs/#{title}" }
+
+      property :title, :prompt => "Song title"
+
+      link(:download) { "//songs/#{title}.mp3" }
+    end
+
+    template do
+      property :title, :prompt => "Song title"
+    end
+
+    queries do
+      link :search do
+        {:href => "//search", :data => [{:name => "q", :value => ""}]}
+      end
+    end
+  end
+end
+
+song = Song.new(title: "Roxanne")
+song.extend(Collection::SongRepresenter)
+puts song.to_json
+
+
+
+# Client-side
+# share in gem, parse existing document.
+
+reset_representer(SongRepresenter)
+
+module SongRepresenter
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+
+  property :title
+  property :id
+
+  link :self do
+    "http://songs/#{title}"
+  end
+end
+
+
+require 'roar/representer/feature/client'
+
+module Client
+  class Song < OpenStruct
+    include Roar::Representer::JSON
+    include SongRepresenter
+    include Roar::Representer::Feature::Client
+  end
+end
+
+song = Client::Song.new(title: "Roxanne")
+song.post("http://localhost:4567/songs", "application/json")
+puts song.id
+
+
+song = Client::Song.new
+song.get("http://localhost:4567/songs/1", "application/json")
+puts song.title
+puts song.links[:self].href
+
+# XML
+
+require 'roar/representer/xml'
+
+module XML
+  module SongRepresenter
+    include Roar::Representer::XML
+    include Roar::Representer::Feature::Hypermedia
+
+    property :title
+    property :id
+
+    link :self do
+      "http://songs/#{title}"
+    end
+  end
+end
+
+song = Song.new(title: "Roxanne", id: 42)
+song.extend(XML::SongRepresenter)
+puts song.to_xml
+
+# Coercion
+
+reset_representer(SongRepresenter)
+
+require 'roar/representer/feature/coercion'
+
+module SongRepresenter
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Coercion
+
+  property :title
+  property :released_at, type: DateTime
+end
+
+song = Song.new
+song.extend(SongRepresenter)
+song.from_json('{"released_at":"1981/03/31"}')
+
+puts song.released_at
+
+
+class LinkOptionsCollection < Array
+
+end
+
+module HyperlinkiRepresenter
+  include Roar::Representer::JSON
+
+  def to_hash(*)  # setup the link
+    # FIXME: why does self.to_s throw a stack level too deep (SystemStackError) ?
+    "#{self}"
+    # how would the Link instance get access to its Definition in order to execute the block?
+  end
+end
+
+module Representer
+  include Roar::Representer::JSON
+
+  def self.links
+    [:self, :next]
+  end
+
+  collection :links, :extend => HyperlinkiRepresenter
+
+  def links
+    # get link configurations from representable_attrs object.
+    #self.representable_attrs.links
+    LinkOptionsCollection.new(["self", "next"])
+  end
+end
+
+puts "".extend(Representer).to_json

data/examples/example_server.rb

@@ -0,0 +1,18 @@
+require "bundler/setup"
+require "sinatra"
+require "ostruct"
+require "roar/representer/json"
+
+
+get "/method" do
+  "<method>get</method>"
+end
+
+post "/songs" do
+'{"id":"1","title":"Roxanne","links":[{"rel":"self","href":"http://localhost/songs/1"}]}'
+end
+
+
+get "/songs/1" do
+'{"id":"1","title":"Roxanne","links":[{"rel":"self","href":"http://localhost/songs/1"}]}'
+end

data/lib/roar/representer/xml.rb

@@ -18,7 +18,7 @@ module Roar
       end
 
       module InstanceMethods
-        def to_xml(*args)
+        def to_node(*args)
           before_serialize(*args)
           super
         end

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "0.12.1"
+  VERSION = "0.12.2"
 end

data/test/hypermedia_feature_test.rb

@@ -1,10 +1,9 @@
 require 'test_helper'
-require 'roar/representer/feature/hypermedia'
-require 'roar/representer/json'
 
 class HypermediaTest < MiniTest::Spec
   describe "Hypermedia Feature" do
 
+    let (:song) { Song.new(:title => "Brandy Wine") }
 
     before do
       @bookmarks = Class.new do
@@ -29,23 +28,65 @@ class HypermediaTest < MiniTest::Spec
 
 
     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.new(:id => 1).to_xml
+      it "works when no links defined" do
+        repr = Module.new do
+          include Roar::Representer::XML
+          include Roar::Representer::Feature::Hypermedia
+
+          self.representation_wrap = "song"
+          property :title
+        end
+
+        song.extend(repr).to_xml.must_equal_xml "<song><title>Brandy Wine</title></song>"
       end
 
-      it "still works even if there are no links defined" do
-        assert_xml_equal '<bookmarks/>', @bookmarks.new.to_xml
+      let (:rpr) { Module.new do
+        include Roar::Representer::XML
+        include Roar::Representer::Feature::Hypermedia
+
+        self.representation_wrap = "song"
+        property :title
+
+        link(:self) { "/songs/#{title}" }
+        link(:all) { "/songs" }
+      end }
+
+      it "includes links in rendered document" do
+        song.extend(rpr).to_xml.must_equal_xml %{
+          <song>
+            <title>Brandy Wine</title>
+            <link rel="self" href="/songs/Brandy Wine"/>
+            <link rel="all" href="/songs"/>
+          </song>}
       end
 
-      it "doesn't render links with :links => false" do
-        assert_xml_equal '<bookmarks>
-                            <id>1</id>
-                          </bookmarks>',
-          @bookmarks_with_links.new(:id => 1).to_xml(:links => false)
+      it "suppresses links when links: false" do
+        song.extend(rpr).to_xml(: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
+          include Roar::Representer::XML
+          include Roar::Representer::Feature::Hypermedia
+
+          self.representation_wrap = "album"
+          collection :songs, :extend => song_rpr
+
+          link(:self) { "/albums/mixed" }
+        end
+
+        Album.new(:songs => [song]).extend(album_rpr).to_xml.must_equal_xml %{
+          <album>
+            <song>
+              <title>Brandy Wine</title>
+              <link rel="self" href="/songs/Brandy Wine"/>
+              <link rel="all" href="/songs"/>
+            </song>
+            <link rel="self" href="/albums/mixed"/>
+          </album>
+        }
       end
     end
 
@@ -122,7 +163,7 @@ end
 class LinkCollectionTest < MiniTest::Spec
   describe "LinkCollection" do
     subject { Roar::Representer::Feature::Hypermedia::LinkCollection.new }
-    
+
     describe "#add" do
       it "keys by using rel string" do
         subject.size.must_equal 0