roar 0.11.9 → 0.11.10

data/CHANGES.markdown

@@ -1,3 +1,7 @@
+## 0.11.10
+* Fix a syntax error for Ruby 1.8.
+* Store link definitions in `representable_attrs(:links)` now and no longer in the `LinksDefinition` instance itself. removing `#links_definition` in favor of `#link_configs`.
+
 ## 0.11.9
 
 * When using `Feature::Client` hyperlinks are no longer rendered in POST and PUT since we pass `links: false`.

data/Gemfile

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

data/TODO.markdown

@@ -1,3 +1,4 @@
 * 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
+* alias Roar::Representer to Representer
+* remove #before_serialize and just overwrite #serialize

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

@@ -37,6 +37,7 @@ module Roar
       module Hypermedia
         def self.included(base)
           base.extend ClassMethods
+          base.extend InheritableArray
         end
 
         def before_serialize(options={})
@@ -60,15 +61,19 @@ module Roar
           ary.each { |lnk| links.add(lnk) }
         end
 
-      private
-        def links_definition
-          representable_attrs.find { |d| d.is_a?(LinksDefinition) } or [] # FIXME: this is a bug as soon as #links_definition is used somewhere else beside #prepare_links.
+        module LinkConfigsMethod
+          def link_configs
+            representable_attrs.inheritable_array(:links)
+          end
         end
 
+        include LinkConfigsMethod
+
+      private
         # 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.
-          compile_links_for(links_definition, *args).each do |lnk|
+          compile_links_for(link_configs, *args).each do |lnk|
             links.add(lnk)  # TODO: move to LinkCollection.new.
           end
         end
@@ -117,42 +122,20 @@ module Roar
           # Note that you're free to put decider logic into #link blocks, too.
           def link(options, &block)
             options = {:rel => options} if options.is_a?(Symbol)
-            links_definition << [options, block]
+            create_links_definition # this assures the links are rendered at the right position.
+            link_configs << [options, block]
           end
 
+          include LinkConfigsMethod
+
         private
           def create_links_definition
-            representable_attrs << links = LinksDefinition.new(*links_definition_options)
-            links
-          end
-
-          def links_definition
-            representable_attrs.find { |d| d.is_a?(LinksDefinition) } or create_links_definition
+            return if representable_attrs.find { |d| d.is_a?(LinksDefinition) }
+            representable_attrs << LinksDefinition.new(*links_definition_options)
           end
         end
 
-
         class LinksDefinition < Representable::Definition
-          include Enumerable
-
-          attr_accessor :rel2block
-          def initialize(*)
-            super
-            @rel2block = []
-          end
-
-          def <<(args)
-            rel2block << args
-          end
-
-          def each(*args, &block)
-            rel2block.each(*args, &block)
-          end
-
-          # DISCUSS: where do we need this?
-          def clone
-            super.tap { |d| d.rel2block = rel2block.clone }
-          end
         end
 
 
@@ -171,6 +154,31 @@ module Roar
             marshal_load(hash.inject({}) { |h, (k,v)| h[k.to_sym] = v; h })
           end
         end
+
+        # TODO: move to separate module
+        # DISCUSS: experimental. this will soon be moved to a separate gem
+        module InheritableArray
+          def representable_attrs
+            super.extend(ConfigExtensions)
+          end
+
+          module ConfigExtensions
+            def inheritable_array(name)
+              inheritable_arrays[name] ||= []
+            end
+            def inheritable_arrays
+              @inheritable_arrays ||= {}
+            end
+
+            def inherit(parent)
+              super
+              
+              parent.inheritable_arrays.keys.each do |k|
+                inheritable_array(k).push *parent.inheritable_array(k).clone
+              end
+            end
+          end
+        end
       end
     end
   end

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

@@ -23,7 +23,7 @@ module Roar::Representer::JSON
 
         collection :queries, :extend => Roar::Representer::JSON::HyperlinkRepresenter
         def queries
-          compile_links_for(representable_attrs.collection_representers[:queries].representable_attrs.first)
+          compile_links_for(representable_attrs.collection_representers[:queries].link_configs)
         end
         def queries=(v)
         end
@@ -43,7 +43,7 @@ module Roar::Representer::JSON
 
         property :__href, :as => :href
         def __href
-          compile_links_for(representable_attrs.collection_representers[:href].representable_attrs.first).first.href
+          compile_links_for(representable_attrs.collection_representers[:href].link_configs).first.href
         end
         
 
@@ -119,7 +119,7 @@ module Roar::Representer::JSON
           # TODO: share with main module!
           property :__href, :as => :href
           def __href
-            compile_links_for(representable_attrs.collection_representers[:href].representable_attrs.first).first.href
+            compile_links_for(representable_attrs.collection_representers[:href].link_configs).first.href
           end
           def __href=(v)
             @__href = Roar::Representer::Feature::Hypermedia::Hyperlink.new(:href => v)

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

@@ -81,28 +81,28 @@ module Roar::Representer
       module Links
         def self.included(base)
           base.class_eval do
+            extend Links::ClassMethods  # ::links_definition_options
             include Roar::Representer::Feature::Hypermedia
-            include InstanceMethods 
-            extend Links::ClassMethods
+            include InstanceMethods
           end
         end
-        
+
         module InstanceMethods
         private
           def prepare_link_for(href, options)
             return super(href, options) unless options[:array]  # TODO: remove :array and use special instan
-            
+
             list = href.collect { |opts| Feature::Hypermedia::Hyperlink.new(opts.merge!(:rel => options[:rel])) }
             LinkArray.new(list)
           end
-        
+
           # TODO: move to LinksDefinition.
           def link_array_rels
-            links_definition.collect { |cfg| cfg.first[:array] ? cfg.first[:rel] : nil }.compact
+            link_configs.collect { |cfg| cfg.first[:array] ? cfg.first[:rel] : nil }.compact
           end
         end
-        
-        
+
+
         require 'representable/json/hash'
         module LinkCollectionRepresenter
           include Representable::JSON::Hash
@@ -115,11 +115,11 @@ module Roar::Representer
               hsh.each { |k,v| v.delete(:rel) }
             end
           end
-          
+
 
           def from_hash(hash, options={})
             hash.each { |k,v| hash[k] = LinkArray.new(v) if is_array?(k) }
-            
+
             hsh = super(hash) # this is where :class and :extend do the work.
 
             hsh.each { |k, v| v.rel = k }
@@ -154,16 +154,18 @@ module Roar::Representer
         module ClassMethods
           def links_definition_options
             [:links,
-              :from     => :links, 
-              :extend   => HAL::Links::LinkCollectionRepresenter,
-              :instance => lambda { |hsh| LinkCollection.new(link_array_rels) }  # defined in InstanceMethods as this is executed in represented context.
+              {
+                :from     => :links,
+                :extend   => HAL::Links::LinkCollectionRepresenter,
+                :instance => lambda { |hsh| LinkCollection.new(link_array_rels) }  # defined in InstanceMethods as this is executed in represented context.
+              }
             ]
           end
 
           # Use this to define link arrays. It accepts the shared rel attribute and an array of options per link object.
           #
           #   links :self do
-          #     [{:lang => "en", :href => "http://en.hit"}, 
+          #     [{:lang => "en", :href => "http://en.hit"},
           #      {:lang => "de", :href => "http://de.hit"}]
           #   end
           def links(options, &block)

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "0.11.9"
+  VERSION = "0.11.10"
 end

data/test/hal_links_test.rb

@@ -18,7 +18,7 @@ class HalLinkTest < MiniTest::Spec
 
   describe "#to_json" do
     it "uses 'links' key" do
-      assert_equal subject.to_json, "{\"links\":{\"self\":{\"href\":\"//songs\"}}}"
+      subject.to_json.must_equal "{\"links\":{\"self\":{\"href\":\"//songs\"}}}"
     end
   end
 

data/test/hypermedia_feature_test.rb

@@ -134,39 +134,3 @@ class LinkCollectionTest < MiniTest::Spec
     end
   end
 end
-
-class HyperlinkInheritanceTest < MiniTest::Spec
-  describe "when the base representer has a link" do
-    before do
-      module BaseRepresenter
-        include Roar::Representer::JSON
-        include Roar::Representer::Feature::Hypermedia
-
-        link(:base) { "http://base" }
-      end
-
-       module Foo
-        include Roar::Representer::JSON
-        include Roar::Representer::Feature::Hypermedia
-        include BaseRepresenter
-
-        link(:foo) { "http://foo" }
-      end
-
-       module Bar
-        include Roar::Representer::JSON
-        include Roar::Representer::Feature::Hypermedia
-        include BaseRepresenter
-
-        link(:bar) { "http://bar" }
-      end
-    end
-
-    it "should inherit parent links" do
-      foo = Object.new.extend(Foo)
-
-      assert_equal "{\"links\":[{\"rel\":\"base\",\"href\":\"http://base\"},{\"rel\":\"foo\",\"href\":\"http://foo\"}]}", foo.to_json
-    end
-
-  end
-end

data/test/hypermedia_test.rb

@@ -1,6 +1,44 @@
 require 'test_helper'
 
 class HypermediaTest < MiniTest::Spec
+  describe "inheritance" do
+    before do
+      module BaseRepresenter
+        include Roar::Representer::JSON
+        include Roar::Representer::Feature::Hypermedia
+
+        link(:base) { "http://base" }
+      end
+
+      module Bar
+        include Roar::Representer::JSON
+        include Roar::Representer::Feature::Hypermedia
+
+        link(:bar) { "http://bar" }
+      end
+
+      module Foo
+        include Roar::Representer::JSON
+        include Roar::Representer::Feature::Hypermedia
+        include BaseRepresenter
+        include Bar
+
+        link(:foo) { "http://foo" }
+      end
+    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
+    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\"}]}"
+    end
+  end
+
   describe "#links_array" do
     subject { Object.new.extend(rpr) }
 
@@ -89,35 +127,6 @@ class HypermediaTest < MiniTest::Spec
   end
 end
 
-class LinksDefinitionTest < MiniTest::Spec
-  describe "LinksDefinition" do
-    subject { Roar::Representer::Feature::Hypermedia::LinksDefinition.new(:links) }
-
-    it "responds to #<<" do
-      subject << "arbitrary bullshit"
-      subject.to_a.must_equal ["arbitrary bullshit"]
-    end
-
-    it "responds to #each" do
-      subject.to_a.must_equal []
-    end
-
-    it "accepts options in constructor" do
-      assert_equal [], subject.rel2block
-    end
-
-    it "accepts configuration" do
-      subject.rel2block << {:rel => :self}
-      assert_equal [{:rel=>:self}], subject.rel2block
-    end
-
-    it "responds to #clone" do
-      subject.rel2block << {:rel => :self}
-      assert subject.clone.rel2block.object_id != subject.rel2block.object_id
-    end
-  end
-end
-
 class HyperlinkTest < MiniTest::Spec
   describe "Hyperlink" do
     subject { link(:rel => "self", "href" => "http://self", "data-whatever" => "Hey, @myabc") }
@@ -144,4 +153,61 @@ class HyperlinkTest < MiniTest::Spec
       assert_equal ["rel:self", "href:http://self", "data-whatever:Hey, @myabc"], subject.collect { |k,v| "#{k}:#{v}" }
     end
   end
+
+  describe "Config inheritance" do
+    # TODO: this section will soon be moved to uber.
+    describe "inheritance when including" do
+      # TODO: test all the below issues AND if cloning works.
+      module TestMethods
+        def representer_for(modules=[Roar::Representer::Feature::Hypermedia, Representable], &block)
+          Module.new do
+            extend TestMethods
+            include *modules
+            module_exec(&block)
+          end
+        end
+      end
+      include TestMethods
+
+      it "inherits to uninitialized child" do
+        representer_for do # child
+          include(representer_for do # parent
+            representable_attrs.inheritable_array(:links) << "bar"
+          end)
+        end.representable_attrs.inheritable_array(:links).must_equal(["bar"])
+      end
+
+      it "works with uninitialized parent" do
+        representer_for do # child
+          representable_attrs.inheritable_array(:links) << "bar"
+
+          include(representer_for do # parent
+          end)
+        end.representable_attrs.inheritable_array(:links).must_equal(["bar"])
+      end
+
+      it "inherits when both are initialized" do
+        representer_for do # child
+          representable_attrs.inheritable_array(:links) << "bar"
+
+          include(representer_for do # parent
+            representable_attrs.inheritable_array(:links) << "stadium"
+          end)
+        end.representable_attrs.inheritable_array(:links).must_equal(["bar", "stadium"])
+      end
+
+      it "clones parent inheritables" do # FIXME: actually we don't clone here!
+        representer_for do # child
+          representable_attrs.inheritable_array(:links) << "bar"
+
+          include(parent = representer_for do # parent
+            representable_attrs.inheritable_array(:links) << "stadium"
+          end)
+
+          parent.representable_attrs.inheritable_array(:links) << "park"  # modify parent array.
+        
+        end.representable_attrs.inheritable_array(:links).must_equal(["bar", "stadium"])
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roar
 version: !ruby/object:Gem::Version
-  version: 0.11.9
+  version: 0.11.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable