oat 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 557a927aa61099a4c1e3eb84c7cb4520247cb8ff
-  data.tar.gz: ba7fd708868211a749732afd0d8e48b2f3fde252
+  metadata.gz: 4fc6d823ab477ce6ea91958585093f23afb9d0d2
+  data.tar.gz: 84bf255fd575dd07ad62d6e942c8948ec44b20f0
 SHA512:
-  metadata.gz: e6ada6ca09572536681a11853b3958e676893cce4508f35006c33ad56e11ea4eb5f35e4bf3f436156be98b800af92efd935dae252cd4b89fcb9e5a4333a48134
-  data.tar.gz: 7bb01a60f853efd5fe8b7a7457565fe7bd41e8716ba6c80841abc9195442034d5ed1b6610a34d295da73b37391beaff0072fc7fc295eaaea81e595057de797b9
+  metadata.gz: 4ac3ea124a6cc06fcd3e21130e0ad99af95a59e92c113f8596298a093cc3bc34c879efb36a815ac0b388a77e231beecc8de8306bb2f12722d64c5bd7d17e7286
+  data.tar.gz: cf27b4fd9ca4dcb4d6b7e6d335d5d1055ee643b4f1a6e94d808724cbfa15d50d0120cba18b34e23cc1332df1bd259957920bdda06290ac1dcb70e3e5fb383c58

data/lib/oat/adapter.rb

@@ -28,7 +28,7 @@ module Oat
         serializer_class = Class.new(serializer.class)
         serializer_class.adapter self.class
         s = serializer_class.new(obj, serializer.context.merge(context_options), serializer.adapter_class, serializer.top)
-        serializer.top.instance_exec(obj, s, &block)
+        serializer.instance_exec(obj, s, &block)
         s.to_hash
       else
         serializer_class.new(obj, serializer.context.merge(context_options), serializer.adapter_class, serializer.top).to_hash

data/lib/oat/adapters/hal.rb

@@ -23,6 +23,7 @@ module Oat
           serializer_from_block_or_class(obj, serializer_class, context_options, &block)
         end
       end
+      alias_method :collection, :entities
 
     end
   end

data/lib/oat/adapters/json_api.rb

@@ -17,7 +17,7 @@ module Oat
       end
 
       def type(*types)
-        @root_name = types.first.to_s
+        @root_name = types.first.to_s.pluralize.to_sym
       end
 
       def link(rel, opts = {})
@@ -33,11 +33,11 @@ module Oat
       end
 
       def entity(name, obj, serializer_class = nil, context_options = {}, &block)
-        @entities[name.to_s.pluralize.to_sym] ||= []
         ent = serializer_from_block_or_class(obj, serializer_class, context_options, &block)
+        entity_hash[name.to_s.pluralize.to_sym] ||= []
         if ent
           link name, :href => ent[:id]
-          @entities[name.to_s.pluralize.to_sym] << ent
+          entity_hash[name.to_s.pluralize.to_sym] << ent
         end
       end
 
@@ -46,21 +46,36 @@ module Oat
         data[:links][link_name] = []
 
         collection.each do |obj|
-          @entities[link_name] ||= []
+          entity_hash[link_name] ||= []
           ent = serializer_from_block_or_class(obj, serializer_class, context_options, &block)
           if ent
             data[:links][link_name] << ent[:id]
-            @entities[link_name] << ent
+            entity_hash[link_name] << ent
           end
         end
       end
 
+      def collection(name, collection, serializer_class = nil, context_options = {}, &block)
+        @treat_as_resource_collection = true
+        data[:resource_collection] = [] unless data[:resource_collection].is_a?(Array)
+
+        collection.each do |obj|
+          ent = serializer_from_block_or_class(obj, serializer_class, context_options, &block)
+          data[:resource_collection] << ent if ent
+        end
+      end
+
       def to_hash
         raise "JSON API entities MUST define a type. Use type 'user' in your serializers" unless root_name
         if serializer.top != serializer
           return data
         else
-          h = {root_name.pluralize.to_sym => [data]}
+          h = {}
+          if @treat_as_resource_collection
+            h[root_name] = data[:resource_collection]
+          else
+            h[root_name] = [data]
+          end
           h[:linked] = @entities if @entities.keys.any?
           return h
         end
@@ -70,6 +85,14 @@ module Oat
 
       attr_reader :root_name
 
+      def entity_hash
+        if serializer.top == serializer
+          @entities
+        else
+          serializer.top.adapter.entity_hash
+        end
+      end
+
     end
   end
 end

data/lib/oat/adapters/siren.rb

@@ -36,6 +36,7 @@ module Oat
           entity name, obj, serializer_class, context_options, &block
         end
       end
+      alias_method :collection, :entities
 
       def action(name, &block)
         action = Action.new(name)

data/lib/oat/serializer.rb

@@ -15,7 +15,7 @@ module Oat
     end
 
     def self.warn(msg)
-      logger ? logger.warning(msg) : puts(msg)
+      logger ? logger.warning(msg) : Kernel.warn(msg)
     end
 
     attr_reader :item, :context, :adapter_class, :adapter

data/lib/oat/version.rb

@@ -1,3 +1,3 @@
 module Oat
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/spec/adapters/json_api_spec.rb

@@ -9,60 +9,11 @@ describe Oat::Adapters::JsonAPI do
   let(:hash) { serializer.to_hash }
 
   describe '#to_hash' do
-    it 'produces a JSON-API compliant hash' do
-      # the user being serialized
-      users = hash.fetch(:users)
-      expect(users.size).to be 1
-      expect(users.first).to include(
-        :id => user.id,
-        :name => user.name,
-        :age => user.age,
-        :controller_name => 'some_controller',
-        :message_from_above => nil
-      )
-
-      expect(users.first.fetch(:links)).to include(
-        :self => "http://foo.bar.com/#{user.id}",
-        # these links are added by embedding entities
-        :manager => manager.id,
-        :friends => [friend.id]
-      )
-
-      # embedded friends
-      linked_friends = hash.fetch(:linked).fetch(:friends)
-      expect(linked_friends.size).to be 1
-      expect(linked_friends.first).to include(
-        :id => friend.id,
-        :name => friend.name,
-        :age => friend.age,
-        :controller_name => 'some_controller',
-        :message_from_above => "Merged into parent's context"
-      )
-
-      expect(linked_friends.first.fetch(:links)).to include(
-        :self => "http://foo.bar.com/#{friend.id}",
-        :empty => nil,
-        :friends => []
-      )
-
-      # embedded manager
-      linked_managers = hash.fetch(:linked).fetch(:managers)
-      expect(linked_managers.size).to be 1
-      expect(linked_managers.first).to include(
-        :id => manager.id,
-        :name => manager.name,
-        :age => manager.age,
-        :links => { :self => "http://foo.bar.com/#{manager.id}" }
-      )
-    end
-
-    context 'with a nil entity relationship' do
-      let(:manager) { nil }
+    context 'top level' do
+      subject(:users){ hash.fetch(:users) }
+      its(:size) { should eq(1) }
 
-      it 'produces a JSON-API compliant hash' do
-        # the user being serialized
-        users = hash.fetch(:users)
-        expect(users.size).to be 1
+      it 'contains the correct user properties' do
         expect(users.first).to include(
           :id => user.id,
           :name => user.name,
@@ -70,33 +21,151 @@ describe Oat::Adapters::JsonAPI do
           :controller_name => 'some_controller',
           :message_from_above => nil
         )
+      end
 
-        expect(users.first.fetch(:links)).not_to include(:manager)
+      it 'contains the correct user links' do
         expect(users.first.fetch(:links)).to include(
           :self => "http://foo.bar.com/#{user.id}",
           # these links are added by embedding entities
+          :manager => manager.id,
           :friends => [friend.id]
         )
-        # embedded friends
-        linked_friends = hash.fetch(:linked).fetch(:friends)
-        expect(linked_friends.size).to be 1
-        expect(linked_friends.first).to include(
-          :id => friend.id,
-          :name => friend.name,
-          :age => friend.age,
-          :controller_name => 'some_controller',
-          :message_from_above => "Merged into parent's context"
-        )
+      end
+    end
 
-        expect(linked_friends.first.fetch(:links)).to include(
-          :self => "http://foo.bar.com/#{friend.id}",
-          :empty => nil,
-          :friends => []
-        )
+    context 'linked' do
+      context 'using #entities' do
+        subject(:linked_friends){ hash.fetch(:linked).fetch(:friends) }
+
+        its(:size) { should eq(1) }
+
+        it 'contains the correct properties' do
+          expect(linked_friends.first).to include(
+            :id => friend.id,
+            :name => friend.name,
+            :age => friend.age,
+            :controller_name => 'some_controller',
+            :message_from_above => "Merged into parent's context"
+          )
+        end
+
+        it 'contains the correct links' do
+          expect(linked_friends.first.fetch(:links)).to include(
+            :self => "http://foo.bar.com/#{friend.id}",
+            :empty => nil,
+            :friends => []
+          )
+        end
+      end
+
+      context 'using #entity' do
+        subject(:linked_managers){ hash.fetch(:linked).fetch(:managers) }
+        its(:size) { should eq(1) }
+
+        it "contains the correct properties and links" do
+          expect(linked_managers.first).to include(
+            :id => manager.id,
+            :name => manager.name,
+            :age => manager.age,
+            :links => { :self => "http://foo.bar.com/#{manager.id}" }
+          )
+        end
+      end
+
+      context 'with nested entities' do
+        let(:friend) { user_class.new('Joe', 33, 2, [other_friend]) }
+        let(:other_friend) { user_class.new('Jack', 28, 4, []) }
+
+        subject(:linked_friends){ hash.fetch(:linked).fetch(:friends) }
+        its(:size) { should eq(2) }
+
+        it 'has the correct entities' do
+          linked_friends.map{ |friend| friend.fetch(:id) }.should include(2, 4)
+        end
+      end
+    end
+
+    context 'with a nil entity relationship' do
+      let(:manager) { nil }
+      let(:users) { hash.fetch(:users) }
 
-        # embedded manager
+      it 'excludes the entity from user links' do
+        expect(users.first.fetch(:links)).not_to include(:manager)
+      end
+
+      it 'excludes the entity from the linked hash' do
         hash.fetch(:linked).fetch(:managers).should be_empty
       end
     end
+
+    context 'with an entity collection' do
+      let(:serializer_collection_class) do
+        USER_SERIALIZER = serializer_class unless defined?(USER_SERIALIZER)
+        Class.new(Oat::Serializer) do
+          schema do
+            type 'users'
+            collection :users, item, USER_SERIALIZER
+          end
+        end
+      end
+
+      let(:collection_serializer){
+        serializer_collection_class.new(
+          [user,friend],
+          {:name => "some_controller"},
+          Oat::Adapters::JsonAPI
+        )
+      }
+      let(:collection_hash) { collection_serializer.to_hash }
+
+      context 'top level' do
+        subject(:users){ collection_hash.fetch(:users) }
+        its(:size) { should eq(2) }
+
+        it 'contains the correct first user properties' do
+          expect(users[0]).to include(
+            :id => user.id,
+            :name => user.name,
+            :age => user.age,
+            :controller_name => 'some_controller',
+            :message_from_above => nil
+          )
+        end
+
+        it 'contains the correct second user properties' do
+          expect(users[1]).to include(
+            :id => friend.id,
+            :name => friend.name,
+            :age => friend.age,
+            :controller_name => 'some_controller',
+            :message_from_above => nil
+          )
+        end
+
+        it 'contains the correct user links' do
+          expect(users.first.fetch(:links)).to include(
+            :self => "http://foo.bar.com/#{user.id}",
+            # these links are added by embedding entities
+            :manager => manager.id,
+            :friends => [friend.id]
+          )
+        end
+
+        context 'sub entity' do
+          subject(:linked_managers){ collection_hash.fetch(:linked).fetch(:managers) }
+          its(:size) { should eq(1) }
+
+          it "contains the correct properties and links" do
+            expect(linked_managers.first).to include(
+              :id => manager.id,
+              :name => manager.name,
+              :age => manager.age,
+              :links => { :self => "http://foo.bar.com/#{manager.id}" }
+            )
+          end
+        end
+      end
+
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oat
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport