yaks 0.9.0 → 0.10.0

data/spec/unit/yaks/mapper/form_spec.rb

@@ -1,9 +1,10 @@
 RSpec.describe Yaks::Mapper::Form do
   include_context 'yaks context'
 
-  let(:form)   { described_class.create( full_args ) }
-  let(:name)      { :the_name }
-  let(:full_args) { {name: name}.merge(args) }
+  let(:form) { described_class.create(*full_args, &block_arg) }
+  let(:name) { :the_name }
+  let(:full_args) { [{name: name}.merge(args)] }
+  let(:block_arg) { nil }
   let(:args) {
     {
       action: '/foo',
@@ -16,10 +17,31 @@ RSpec.describe Yaks::Mapper::Form do
   let(:fields) { [] }
   let(:mapper) { Yaks::Mapper.new(yaks_context) }
 
-  describe '.create' do
-    it 'should have a name of nil when ommitted' do
+  describe ".create" do
+    it "should have a name of nil when ommitted" do
       expect(described_class.create.name).to be_nil
     end
+
+    context "with a symbol arg" do
+      let(:full_args) { [:the_name] }
+      it "should use the symbol as the form's name" do
+        expect(form.name).to be :the_name
+      end
+    end
+
+    context "with a name given in the options hash" do
+      it "should use that name" do
+        expect(form.name).to be :the_name
+      end
+    end
+
+    context "with a block" do
+      let(:block_arg) { ->{ method 'POST' } }
+
+      it "should use it as configuration block" do
+        expect(form.method).to eql 'POST'
+      end
+    end
   end
 
   describe '#add_to_resource' do
@@ -38,6 +60,22 @@ RSpec.describe Yaks::Mapper::Form do
       }
     end
 
+    it "should add the form to the resource" do
+      expect(form.add_to_resource(Yaks::Resource.new, mapper, nil))
+        .to eql Yaks::Resource.new(
+          forms: [
+            Yaks::Resource::Form.new(
+              name: :the_name,
+              action: "/foo",
+              title: "a title",
+              method: "PATCH",
+              media_type: "application/hal+json",
+              fields: []
+            )
+          ]
+        )
+    end
+
     context 'with a truthy condition' do
       let(:form) { described_class.create { condition { true }}}
 
@@ -53,30 +91,53 @@ RSpec.describe Yaks::Mapper::Form do
         expect(form.add_to_resource(Yaks::Resource.new, mapper, nil).forms.length).to be 0
       end
     end
+  end
+
+  describe '#to_resource_form' do
+    let(:block_arg) do
+      -> do
+        method { 'POST' }
+        action { '/foo/bar' }
+
+        text :name, required: true
+      end
+    end
+
+    it "should create a matching Yaks::Resource::Form" do
+      expect(form.to_resource_form(mapper))
+        .to eql Yaks::Resource::Form.new(
+          name: :the_name,
+          action: "/foo/bar",
+          title: "a title",
+          method: "POST",
+          media_type: "application/hal+json",
+          fields: [
+            Yaks::Resource::Form::Field.new(name: :name, type: :text, required: true)
+          ]
+        )
+    end
 
-    describe '#to_resource_form' do
-      context 'with dynamic elements' do
-        let(:form) do
-          described_class.create(name) do
-            dynamic do |object|
-              text object.name
-            end
+    context 'with dynamic elements' do
+      let(:args) {{}}
+      let(:block_arg) do
+        -> do
+          dynamic do |object|
+            text object.name
           end
         end
+      end
 
-        it 'should render them based on the mapped object' do
-          mapper.call(fake(name: :anthony)) # hack to set the mapper's object
-          expect(form.to_resource_form(mapper)).to eql(
-            Yaks::Resource::Form.new(
-              name: :the_name,
-              fields: [
-                Yaks::Resource::Form::Field.new(name: :anthony, type: :text)
-              ]
-            )
+      it 'should render them based on the mapped object' do
+        mapper.call(fake(name: :anthony)) # HACK: set the mapper's object
+        expect(form.to_resource_form(mapper)).to eql(
+          Yaks::Resource::Form.new(
+            name: :the_name,
+            fields: [
+              Yaks::Resource::Form::Field.new(name: :anthony, type: :text)
+            ]
           )
-        end
+        )
       end
     end
-
   end
 end

data/spec/unit/yaks/mapper/has_many_spec.rb

@@ -8,64 +8,67 @@ RSpec.describe Yaks::Mapper::HasMany do
       type 'closet'
       has_many :shoes,
         rel: 'http://foo/shoes',
-        item_mapper: Class.new(Yaks::Mapper) { type 'shoe' ; attributes :size, :color }
+        item_mapper: Class.new(Yaks::Mapper) { type 'shoe'; attributes :size, :color }
     end
   end
 
   subject(:shoe_association) { closet_mapper.associations.first }
 
-  its(:singular_name) { should eq 'shoe' }
+  describe "#singular_name" do
+    its(:singular_name) { should eq 'shoe' }
+  end
 
   let(:closet) {
     fake(
-      :shoes => [
+      shoes: [
         fake(size: 9,    color: :blue),
-        fake(size: 11.5, color: :red),
+        fake(size: 11.5, color: :red)
       ]
     )
   }
 
-  it 'should map the subresources' do
-    expect(closet_mapper.call(closet).subresources).to eql([
-      Yaks::CollectionResource.new(
-        type: 'shoe',
-        members: [
-          Yaks::Resource.new(type: 'shoe', attributes: {:size => 9, :color => :blue}),
-          Yaks::Resource.new(type: 'shoe', attributes: {:size => 11.5, :color => :red})
-        ],
-        rels: ['http://foo/shoes']
-      )
-    ])
-  end
+  describe "#map_resource" do
+    it 'should map the subresources' do
+      expect(closet_mapper.call(closet).subresources).to eql([
+        Yaks::CollectionResource.new(
+          type: 'shoe',
+          members: [
+            Yaks::Resource.new(type: 'shoe', attributes: {size: 9, color: :blue}),
+            Yaks::Resource.new(type: 'shoe', attributes: {size: 11.5, color: :red})
+          ],
+          rels: ['http://foo/shoes']
+        )
+      ])
+    end
 
-  it 'should map nil to a NullResource collection' do
-    expect(closet_mapper.call(fake(shoes: nil)).subresources).to eql([
-      Yaks::NullResource.new(collection: true, rels: ['http://foo/shoes'])
-    ])
-  end
+    it 'should map nil to a NullResource collection' do
+      expect(closet_mapper.call(fake(shoes: nil)).subresources).to eql([
+        Yaks::NullResource.new(collection: true, rels: ['http://foo/shoes'])
+      ])
+    end
 
-  context 'without an explicit mapper' do
-    let(:dress_mapper) {
-      Class.new(Yaks::Mapper) { type 'dress' ; attributes :color }
-    }
+    context 'without an explicit mapper' do
+      let(:dress_mapper) {
+        Class.new(Yaks::Mapper) { type 'dress'; attributes :color }
+      }
 
-    before do
-      closet_mapper_class.class_eval do
-        has_many :dresses
-      end
+      before do
+        closet_mapper_class.class_eval do
+          has_many :dresses
+        end
 
-      stub(closet_mapper.policy).derive_mapper_from_association(any_args) do
-        dress_mapper
+        stub(closet_mapper.policy).derive_mapper_from_association(any_args) do
+          dress_mapper
+        end
       end
-    end
 
-    it 'should derive it from policy' do
-      expect(closet_mapper.policy).to equal policy
-      closet_mapper.call(fake(shoes: [], dresses: [fake(color: 'blue')]))
+      it 'should derive it from policy' do
+        expect(closet_mapper.policy).to equal policy
+        closet_mapper.call(fake(shoes: [], dresses: [fake(color: 'blue')]))
+      end
     end
   end
 
-
   describe '#collection_mapper' do
     let(:collection_mapper) { Yaks::Undefined }
 

data/spec/unit/yaks/mapper/has_one_spec.rb

@@ -13,37 +13,45 @@ RSpec.describe Yaks::Mapper::HasOne do
 
   let(:association_mapper) { AuthorMapper }
   let(:name)               { 'William S. Burroughs' }
-  let(:author)             { fake(:name => name) }
+  let(:author)             { fake(name: name) }
 
   fake(:policy,
     derive_type_from_mapper_class: 'author',
     derive_mapper_from_association: AuthorMapper
   ){ Yaks::DefaultPolicy }
 
-  its(:singular_name) { should eq 'author' }
-
-  it 'should map to a single Resource' do
-    expect(has_one.map_resource(author, yaks_context)).to eq Yaks::Resource.new(type: 'author', attributes: {name: name})
+  describe "#singular_name" do
+    its(:singular_name) { should eq 'author' }
   end
 
-  context 'with no mapper specified' do
-    subject(:subresource)    { has_one.add_to_resource(Yaks::Resource.new, parent_mapper, yaks_context) }
-    let(:association_mapper) { Yaks::Undefined }
-    fake(:parent_mapper) { Yaks::Mapper }
-
-    before do
-      stub(parent_mapper).load_association(:author) { author }
+  describe "#map_resource" do
+    it 'should map to a single Resource' do
+      expect(has_one.map_resource(author, yaks_context))
+        .to eq Yaks::Resource.new(type: 'author', attributes: {name: name})
     end
 
-    it 'should derive one based on policy' do
-      expect(subresource).to eql(
-        Yaks::Resource.new(
-          subresources: [
-            Yaks::Resource.new(type: 'author', attributes: {name: name}, rels: ['http://rel'])
-          ]
+    context 'with no mapper specified' do
+      subject(:subresource) {
+        has_one.add_to_resource(Yaks::Resource.new, parent_mapper, yaks_context)
+      }
+      let(:association_mapper) { Yaks::Undefined }
+      fake(:parent_mapper) { Yaks::Mapper }
+
+      before do
+        stub(parent_mapper).load_association(:author) { author }
+      end
+
+      it 'should derive one based on policy' do
+        expect(subresource).to eql(
+          Yaks::Resource.new(subresources: [
+            Yaks::Resource.new(
+              type: 'author',
+              attributes: {name: name},
+              rels: ['http://rel']
+            )
+          ])
         )
-      )
+      end
     end
-
   end
 end

data/spec/unit/yaks/mapper/link_spec.rb

@@ -32,7 +32,7 @@ RSpec.describe Yaks::Mapper::Link do
       let(:template) { ->{ link_computer } }
       before do
         mapper_class.class_eval do
-          def link_computer ; end
+          def link_computer; end
         end
       end
 
@@ -43,34 +43,60 @@ RSpec.describe Yaks::Mapper::Link do
       end
     end
 
-    context 'with :replace => true' do
-      let(:options) { { remove: true } }
+    context 'with remove: true' do
+      let(:options) { {remove: true} }
       let(:resource) {
-        Yaks::Resource.new.add_link(Yaks::Resource::Link.new(rel: :next, uri: '/api/next'))
+        Yaks::Resource.new(links: [
+          Yaks::Resource::Link.new(rel: :next, uri: '/api/next'),
+          Yaks::Resource::Link.new(rel: :prev, uri: '/api/prev')
+        ])
       }
 
       it 'should remove earlier links of the same rel' do
         expect(link.add_to_resource(resource, mapper, yaks_context)).to eql(
-          Yaks::Resource.new
+          Yaks::Resource.new(links: [
+            Yaks::Resource::Link.new(rel: :prev, uri: '/api/prev')
+          ])
+        )
+      end
+    end
+
+    context 'with a link with the same rel already present' do
+      let(:resource) {
+        Yaks::Resource.new(links: [Yaks::Resource::Link.new(rel: :next, uri: '/api/next')])
+      }
+
+      it 'should keep both links' do
+        expect(link.add_to_resource(resource, mapper, yaks_context)).to eql(
+          Yaks::Resource.new(links: [
+            Yaks::Resource::Link.new(rel: :next, uri: "/api/next"),
+            Yaks::Resource::Link.new(rel: :next, uri: "/foo/bar/3/4")
+          ])
         )
       end
     end
 
-    context 'with :replace => true' do
-      let(:options) { { replace: true } }
+    context 'with replace: true' do
+      let(:options) { {replace: true} }
       let(:resource) {
-        Yaks::Resource.new.add_link(Yaks::Resource::Link.new(rel: :next, uri: '/api/next'))
+        Yaks::Resource.new(links: [
+          Yaks::Resource::Link.new(rel: :next, uri: '/api/next'),
+          Yaks::Resource::Link.new(rel: :prev, uri: '/api/prev')
+        ])
       }
 
       it 'should replace earlier links of the same rel' do
         expect(link.add_to_resource(resource, mapper, yaks_context)).to eql(
-          Yaks::Resource.new(links: [Yaks::Resource::Link.new(rel: :next, uri: "/foo/bar/3/4")])
+          Yaks::Resource.new(links: [
+            Yaks::Resource::Link.new(rel: :prev, uri: "/api/prev"),
+            Yaks::Resource::Link.new(rel: :next, uri: "/foo/bar/3/4")
+          ])
         )
       end
     end
 
     context 'with :if defined and resolving to true' do
-      let(:options) { { if: ->{ true } } }
+      let(:options) { {if: ->{ true }} }
 
       it 'should render the link' do
         expect(link.add_to_resource(Yaks::Resource.new, mapper, yaks_context)).to eql(
@@ -80,7 +106,7 @@ RSpec.describe Yaks::Mapper::Link do
     end
 
     context 'with :if defined and resolving to false' do
-      let(:options) { { if: ->{ false } } }
+      let(:options) { {if: ->{ false }} }
 
       it 'should not render the link' do
         expect(link.add_to_resource(Yaks::Resource.new, mapper, yaks_context)).to eql(
@@ -153,6 +179,10 @@ RSpec.describe Yaks::Mapper::Link do
       it 'should not propagate :expand' do
         expect(resource_link.options.key?(:expand)).to be false
       end
+
+      it 'should keep the link template intact' do
+        expect(resource_link.uri).to eql "/foo/bar/{x}/{y}"
+      end
     end
 
     context 'with partial expansion' do
@@ -164,7 +194,7 @@ RSpec.describe Yaks::Mapper::Link do
     end
 
     context 'with a title set' do
-      let(:options) { { title: 'link title' } }
+      let(:options) { {title: 'link title'} }
 
       it 'should set the title on the resource link' do
         expect(resource_link.title).to eq 'link title'
@@ -172,7 +202,7 @@ RSpec.describe Yaks::Mapper::Link do
     end
 
     context 'with a title lambda' do
-      let(:options) { { title: -> { "say #{mapper_method}" } } }
+      let(:options) { {title: -> { "say #{mapper_method}" }} }
 
       before do
         mapper_class.class_eval do
@@ -196,7 +226,7 @@ RSpec.describe Yaks::Mapper::Link do
     end
 
     context 'with a if lambda resolving to true' do
-      let(:options) { { if: -> { add_link? } } }
+      let(:options) { {if: -> { add_link? }} }
 
       before do
         mapper_class.class_eval do
@@ -212,7 +242,7 @@ RSpec.describe Yaks::Mapper::Link do
     end
 
     context 'with a if lambda resolving to false' do
-      let(:options) { { if: -> { add_link? } } }
+      let(:options) { {if: -> { add_link? }} }
 
       before do
         mapper_class.class_eval do
@@ -230,7 +260,7 @@ RSpec.describe Yaks::Mapper::Link do
 
   describe '.create' do
     it 'should take positional arguments' do
-      expect(Yaks::Mapper::Link.create(:foo, :bar, {baz: 3}))
+      expect(Yaks::Mapper::Link.create(:foo, :bar, baz: 3))
         .to eql Yaks::Mapper::Link.new(rel: :foo, template: :bar, options: {baz: 3})
     end
 
@@ -238,4 +268,26 @@ RSpec.describe Yaks::Mapper::Link do
       expect(Yaks::Mapper::Link.create(:foo, :bar).options).to eql({})
     end
   end
+
+  describe '#templated?' do
+    context 'when no expansion behavior is set (defaults to expand fully)' do
+      let(:options) { {} }
+      its(:templated?) { should be false }
+    end
+
+    context 'when the link does not expand' do
+      let(:options) { {expand: false} }
+      its(:templated?) { should be true }
+    end
+
+    context 'when the link expands fully' do
+      let(:options) { {expand: true} }
+      its(:templated?) { should be false }
+    end
+
+    context 'when the link expands partially' do
+      let(:options) { {expand: [:x]} }
+      its(:templated?) { should be true }
+    end
+  end
 end