roar 0.10.2 → 0.11.0

data/CHANGES.markdown

@@ -1,3 +1,18 @@
+## 0.11.0
+
+* Using representable-1.2.2 now. Be warned that in 1.2 parsing and rendering slightly changed. When a property is not found in the incoming document, it is ignored and thus might not be initialised in your represented model (empty collections are still set to an empty array). Also, the way `false` and `nil` values are rendered changed. Quoted from the representable CHANGES file:
+* A property with false value will now be included in the rendered representation. Same applies to parsing, false values will now be included. That particularly means properties that used to be unset (i.e. nil) after parsing might be false now.
+* You can include nil values now in your representations since #property respects :represent_nil => true.
+
+* The `:except` option got deprecated in favor of `:exclude`.
+* Hyperlinks can now have arbitrary attributes. To render, just provide `#link` with the options 
+<code>link :self, :title => "Mee!", "data-remote" => true</code>
+When parsing, the options are avaible via `OpenStruct` compliant readers.
+<code>link = Hyperlink.from_json({\"rel\":\"self\",\"data-url\":\"http://self\"} )
+link.rel #=> "self"
+link.send("data-url") #=> "http://self"
+</code>
+
 ## 0.10.2
 
 * You can now pass values from outside to the render method (e.g. `#to_json`), they will be available as block parameters inside `#link`.

data/Gemfile

@@ -3,7 +3,7 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in roar.gemspec
 gemspec
 
-#gem "representable", :path => "../representable"
+gem "representable", :path => "../representable"
 
 
 group :test do

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

@@ -129,20 +129,18 @@ module Roar
         end
         
         
-        # An abstract hypermedia link with +rel+, +href+ and other attributes.
-        # Overwrite the Hyperlink.params method if you need more link attributes.
-        class Hyperlink
-          def self.params
-            [:rel, :href, :media, :title, :hreflang]
-          end
+        require "ostruct"
+        # An abstract hypermedia link with arbitrary attributes.
+        class Hyperlink < OpenStruct
+          include Enumerable
           
-          attr_accessor *params
+          def each(*args, &block)
+            marshal_dump.each(*args, &block)
+          end
           
-          def initialize(options={})
-            options.each do |k,v|
-              next unless self.class.params.include?(k.to_sym)
-              instance_variable_set("@#{k}", v)
-            end
+          def replace(hash)
+            # #marshal_load requires symbol keys: http://apidock.com/ruby/v1_9_3_125/OpenStruct/marshal_load
+            marshal_load(hash.inject({}) { |h, (k,v)| h[k.to_sym] = v; h })
           end
         end
       end

data/lib/roar/representer/json.rb

@@ -49,13 +49,10 @@ module Roar
         end
       end
       
-      
-      # Represents a hyperlink in standard roar+json. 
+      require "representable/json/hash"
+      # Represents a hyperlink in standard roar+json hash representation. 
       module HyperlinkRepresenter
-        include JSON
-        Feature::Hypermedia::Hyperlink.params.each do |attr|
-          property attr
-        end
+        include Representable::JSON::Hash
       end
     end
   end

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

@@ -84,7 +84,7 @@ module Roar::Representer
             {}.tap do |hash|
               each do |link|
                 # TODO: we statically use JSON::HyperlinkRepresenter here.
-                hash[link.rel] = link.extend(JSON::HyperlinkRepresenter).to_hash(:except => [:rel])
+                hash[link.rel] = link.extend(JSON::HyperlinkRepresenter).to_hash(:exclude => [:rel])
               end
             end
           end

data/lib/roar/representer/xml.rb

@@ -47,14 +47,12 @@ module Roar
         end
       end
       
+      
+      require 'representable/xml/hash'
       module HyperlinkRepresenter
-        include XML
+        include Representable::XML::AttributeHash
         
         self.representation_wrap = :link
-        
-        Feature::Hypermedia::Hyperlink.params.each do |attr|
-          property attr, :attribute => true
-        end
       end
     end
   end

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "0.10.2"
+  VERSION = "0.11.0"
 end

data/test/hal_json_test.rb

@@ -1,3 +1,4 @@
+require 'test_helper'
 require 'roar/representer/json/hal'
 
 class HalJsonTest < MiniTest::Spec
@@ -20,7 +21,7 @@ class HalJsonTest < MiniTest::Spec
     end
     
     it "renders links according to the HAL spec" do
-      assert_equal "{\"links\":{\"self\":{\"href\":\"http://self\"},\"next\":{\"href\":\"http://hit\",\"title\":\"Hey, @myabc\"}}}", @song.to_json
+      assert_equal "{\"links\":{\"self\":{\"href\":\"http://self\"},\"next\":{\"title\":\"Hey, @myabc\",\"href\":\"http://hit\"}}}", @song.to_json
     end
     
     it "parses incoming JSON links correctly" do

data/test/hypermedia_feature_test.rb

@@ -29,7 +29,7 @@ class HypermediaTest
           end
         end
 
-        assert_equal "{\"links\":[{\"rel\":\"self\",\"href\":\"http://self\",\"title\":\"Hey, @myabc\"}]}", Object.new.extend(@mod).to_json
+        assert_equal "{\"links\":[{\"rel\":\"self\",\"title\":\"Hey, @myabc\",\"href\":\"http://self\"}]}", Object.new.extend(@mod).to_json
       end
       
       it "receives options from to_*" do
@@ -234,15 +234,11 @@ class HyperlinkTest < MiniTest::Spec
   Hyperlink = Roar::Representer::Feature::Hypermedia::Hyperlink
   describe "Hyperlink" do
     before do
-      @link = Hyperlink.new(:rel => "self", :href => "http://self")
+      @link = Hyperlink.new(:rel => "self", "href" => "http://self", "data-whatever" => "Hey, @myabc")
     end
 
     it "accepts string keys in constructor" do
-      assert_equal "Hey, @myabc", Hyperlink.new("title" => "Hey, @myabc").title
-    end
-
-    it "responds to #media" do
-      assert_equal nil, @link.media
+      assert_equal "Hey, @myabc", @link.send("data-whatever")
     end
 
     it "responds to #rel" do
@@ -252,6 +248,16 @@ class HyperlinkTest < MiniTest::Spec
     it "responds to #href" do
       assert_equal "http://self", @link.href
     end
+    
+    it "responds to #replace with string keys" do
+      @link.replace("rel" => "next")
+      assert_equal nil, @link.href
+      assert_equal "next", @link.rel
+    end
+    
+    it "responds to #each and implements Enumerable" do
+      assert_equal ["rel:self", "href:http://self", "data-whatever:Hey, @myabc"], @link.collect { |k,v| "#{k}:#{v}" }
+    end
   end
 end
 

data/test/json_representer_test.rb

@@ -31,8 +31,8 @@ class JsonRepresenterTest < MiniTest::Spec
         assert_equal '{"id":1}', @order.serialize
       end
       
-      it "accepts :include and :except" do
-        assert_equal '{}', @order.to_json(:except => [:id])
+      it "accepts :include and :exclude" do
+        assert_equal '{}', @order.to_json(:exclude => [:id])
       end
     end
     
@@ -55,8 +55,8 @@ class JsonRepresenterTest < MiniTest::Spec
         assert @order.from_json('')
       end
       
-      it "accepts :include and :except" do
-        @order.from_json('{"id":1}', :except => [:id])
+      it "accepts :include and :exclude" do
+        @order.from_json('{"id":1}', :exclude => [:id])
         assert_equal nil, @order.id
       end
     end
@@ -118,10 +118,11 @@ class JsonHypermediaTest
     end
     
     it "extracts links from JSON" do
-      @r = @c.from_json({:links => [{:rel => "self", :href => "http://self"}]}.to_json)
+      r = @c.from_json({:links => [{:rel => "self", :href => "http://self"}]}.to_json)
       
-      assert_equal 1, @r.links.size
-      assert_equal(["self", "http://self"], [@r.links.first.rel, @r.links.first.href]) 
+      assert_equal 1, r.links.size
+      link = r.links.first
+      assert_equal(["self", "http://self"], [link.rel, link.href]) 
     end
     
     it "renders link: correctly in JSON" do

data/test/xml_representer_test.rb

@@ -60,8 +60,8 @@ class XMLRepresenterFunctionalTest < MiniTest::Spec
         assert_equal @r.to_xml, @r.serialize
       end
       
-      it "accepts :include and :except" do
-        assert_equal '<order/>', @r.to_xml(:except => [:id])
+      it "accepts :include and :exclude" do
+        assert_equal '<order/>', @r.to_xml(:exclude => [:id])
       end
     end
     
@@ -76,8 +76,8 @@ class XMLRepresenterFunctionalTest < MiniTest::Spec
         assert_equal "1", @order.id
       end
       
-      it "accepts :include and :except" do
-        @order = Order.new.deserialize("<order><id>1</id></order>", :except => [:id])
+      it "accepts :include and :exclude" do
+        @order = Order.new.deserialize("<order><id>1</id></order>", :exclude => [:id])
         assert_equal nil, @order.id
       end
     end
@@ -95,8 +95,8 @@ class XMLRepresenterFunctionalTest < MiniTest::Spec
         assert_equal TestXmlRepresenter.from_xml("<order/>").id, TestXmlRepresenter.deserialize("<order/>").id
       end
       
-      it "accepts :except option" do
-        order = Order.from_xml(%{<order><id>1</id><pending>1</pending></order>}, :except => [:id])
+      it "accepts :exclude option" do
+        order = Order.from_xml(%{<order><id>1</id><pending>1</pending></order>}, :exclude => [:id])
         assert_equal nil, order.id
         assert_equal "1", order.pending
       end

metadata

@@ -1,92 +1,88 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: roar
-version: !ruby/object:Gem::Version 
-  hash: 51
+version: !ruby/object:Gem::Version
+  version: 0.11.0
   prerelease: 
-  segments: 
-  - 0
-  - 10
-  - 2
-  version: 0.10.2
 platform: ruby
-authors: 
+authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-18 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: representable
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 1
-        - 1
-        - 7
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.1.7
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: test_xml
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test_xml
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 45
-        segments: 
-        - 2
-        - 8
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.8.1
   type: :development
-  version_requirements: *id004
-description: Streamlines the development of RESTful, resource-oriented architectures in Ruby.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+description: Streamlines the development of RESTful, resource-oriented architectures
+  in Ruby.
+email:
 - apotonick@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGES.markdown
@@ -162,36 +158,26 @@ files:
 - test/xml_representer_test.rb
 homepage: http://rubygems.org/gems/roar
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: roar
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Resource-oriented architectures in Ruby.
 test_files: []
-