yaks 0.4.2 → 0.4.3

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

@@ -14,45 +14,6 @@ RSpec.describe Yaks::Mapper::Config do
     its(:associations) { should eql [:c] }
   end
 
-  describe '#updated' do
-    context 'with no updates' do
-      let(:config) {
-        super()
-          .type('foo')
-          .attributes(:a, :b, :c)
-          .link(:foo, 'http://bar')
-          .has_many(:bars)
-      }
-
-      it 'should update attributes' do
-        expect(config.updated(attributes: [:foo])).to eql described_class.new(
-          'foo',
-          [:foo],
-          [Yaks::Mapper::Link.new(:foo, 'http://bar', {})],
-          [Yaks::Mapper::HasMany.new(:bars, Undefined, Undefined, Undefined)]
-        )
-      end
-
-      it 'should update links' do
-        expect(config.updated(links: [:foo])).to eql described_class.new(
-          'foo',
-          [:a, :b, :c],
-          [:foo],
-          [Yaks::Mapper::HasMany.new(:bars, Undefined, Undefined, Undefined)]
-        )
-      end
-
-      it 'should update associations' do
-        expect(config.updated(associations: [:foo])).to eql described_class.new(
-          'foo',
-          [:a, :b, :c],
-          [Yaks::Mapper::Link.new(:foo, 'http://bar', {})],
-          [:foo]
-        )
-      end
-    end
-  end
-
   describe '#attributes' do
     context 'an empty config' do
       it 'should return an empty attributes list' do
@@ -61,8 +22,11 @@ RSpec.describe Yaks::Mapper::Config do
     end
 
     it 'should add attributes' do
-      expect(config.attributes(:foo, :bar, :baz).attributes)
-        .to eq [:foo, :bar, :baz]
+      expect(config.attributes(:foo, :bar, :baz).attributes).to eq [
+        Yaks::Mapper::Attribute.new(:foo),
+        Yaks::Mapper::Attribute.new(:bar),
+        Yaks::Mapper::Attribute.new(:baz)
+      ]
     end
 
     it 'should be chainable' do
@@ -71,7 +35,11 @@ RSpec.describe Yaks::Mapper::Config do
           .attributes(:foo, :bar)
           .attributes(:baz)
           .attributes
-      ).to eq [:foo, :bar, :baz]
+      ).to eq [
+        Yaks::Mapper::Attribute.new(:foo),
+        Yaks::Mapper::Attribute.new(:bar),
+        Yaks::Mapper::Attribute.new(:baz)
+      ]
     end
   end
 
@@ -117,7 +85,7 @@ RSpec.describe Yaks::Mapper::Config do
 
       it 'should have the association configured' do
         expect(config.associations).to eq [
-          Yaks::Mapper::HasOne.new(:mother, Yaks::Mapper, Undefined, Undefined)
+          Yaks::Mapper::HasOne.new(name: :mother, mapper: Yaks::Mapper)
         ]
       end
     end
@@ -127,7 +95,7 @@ RSpec.describe Yaks::Mapper::Config do
 
       it 'should have undefined mapper, rel, collection_mapper' do
         expect(config.associations).to eq [
-          Yaks::Mapper::HasOne.new(:mother, Undefined, Undefined, Undefined)
+          Yaks::Mapper::HasOne.new(name: :mother)
         ]
       end
     end
@@ -137,7 +105,7 @@ RSpec.describe Yaks::Mapper::Config do
 
       it 'should have the rel' do
         expect(config.associations).to eq [
-          Yaks::Mapper::HasOne.new(:mother, Undefined, '/api/rels/mother', Undefined)
+          Yaks::Mapper::HasOne.new(name: :mother, rel: '/api/rels/mother')
         ]
       end
 
@@ -150,7 +118,7 @@ RSpec.describe Yaks::Mapper::Config do
 
       it 'should have the association configured' do
         expect(config.associations).to eq [
-          Yaks::Mapper::HasMany.new(:shoes, Yaks::Mapper, Undefined, Undefined)
+          Yaks::Mapper::HasMany.new(name: :shoes, mapper: Yaks::Mapper)
         ]
       end
     end
@@ -160,7 +128,7 @@ RSpec.describe Yaks::Mapper::Config do
 
       it 'should have undefined mapper, rel, collection_mapper' do
         expect(config.associations).to eq [
-          Yaks::Mapper::HasMany.new(:shoes, Undefined, Undefined, Undefined)
+          Yaks::Mapper::HasMany.new(name: :shoes)
         ]
       end
     end
@@ -170,12 +138,19 @@ RSpec.describe Yaks::Mapper::Config do
 
       it 'should have the association configured' do
         expect(config.associations).to eq [
-          Yaks::Mapper::HasMany.new(:shoes, Undefined, Undefined, :a_collection_mapper)
+          Yaks::Mapper::HasMany.new(name: :shoes, collection_mapper: :a_collection_mapper)
         ]
       end
     end
   end
 
+  describe "#type" do
+    it "should update the type" do
+      config = config().type :shoe
+      expect(config.type).to be :shoe
+    end
+  end
+
   context 'multiple associations' do
     let(:config) {
       subject
@@ -184,8 +159,8 @@ RSpec.describe Yaks::Mapper::Config do
     }
 
     it 'should have them all present' do
-      expect(config.associations).to include Yaks::Mapper::HasOne.new(:mother, Undefined, Undefined, Undefined)
-      expect(config.associations).to include Yaks::Mapper::HasMany.new(:shoes, Undefined, Undefined, Undefined)
+      expect(config.associations).to include Yaks::Mapper::HasOne.new(name: :mother)
+      expect(config.associations).to include Yaks::Mapper::HasMany.new(name: :shoes)
     end
   end
 end

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

@@ -19,10 +19,10 @@ RSpec.describe Yaks::Mapper::HasMany do
   its(:singular_name) { should eq 'shoe' }
 
   let(:closet) {
-    double(
+    fake(
       :shoes => [
-        double(size: 9,    color: :blue),
-        double(size: 11.5, color: :red),
+        fake(size: 9,    color: :blue),
+        fake(size: 11.5, color: :red),
       ]
     )
   }
@@ -35,14 +35,42 @@ RSpec.describe Yaks::Mapper::HasMany do
           Yaks::Resource.new(type: 'shoe', attributes: {:size => 9, :color => :blue}),
           Yaks::Resource.new(type: 'shoe', attributes: {:size => 11.5, :color => :red})
         ],
-        members_rel: 'rel:src=collection&dest=shoes'
+        collection_rel: 'rel:shoes'
       )
     )
   end
 
+  it 'should map nil to a NullResource collection' do
+    expect(closet_mapper.call(fake(shoes: nil)).subresources).to eql(
+      'http://foo/shoes' => Yaks::NullResource.new(collection: true)
+    )
+  end
+
+  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
+
+      stub(closet_mapper.policy).derive_mapper_from_association(any_args) do
+        dress_mapper
+      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')]))
+    end
+  end
+
+
   describe '#collection_mapper' do
     let(:collection_mapper) { Yaks::Undefined }
-    subject(:has_many)  { described_class.new(:name, :mapper, :rel, collection_mapper) }
+    subject(:has_many)  { described_class.new(name: :name, mapper: :mapper, rel: :rel, collection_mapper: collection_mapper) }
 
     context 'when the collection mapper is undefined' do
       it 'should derive one from collection and policy' do

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

@@ -1,35 +1,50 @@
 require 'spec_helper'
 
 RSpec.describe Yaks::Mapper::HasOne do
+  include_context 'yaks context'
+
   AuthorMapper = Class.new(Yaks::Mapper) { attributes :name }
 
-  subject(:has_one)  { described_class.new(:author, mapper, 'http://rel', Yaks::Undefined) }
-  let(:name)     { 'William S. Burroughs' }
-  let(:mapper)   { AuthorMapper }
-  let(:author)   { double(:name => name) }
-  let(:policy)   {
-    double(
-      Yaks::DefaultPolicy,
-      derive_type_from_mapper_class: 'author',
-      derive_mapper_from_association: AuthorMapper
+  subject(:has_one)  do
+    described_class.new(
+      name: :author,
+      mapper: association_mapper,
+      rel: 'http://rel'
     )
-  }
-  let(:context) {{policy: policy, env: {}}}
+  end
+
+  let(:association_mapper) { AuthorMapper }
+  let(:name)               { 'William S. Burroughs' }
+  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, context)).to eq Yaks::Resource.new(type: 'author', attributes: {name: name})
+    expect(has_one.map_resource(author, yaks_context)).to eq Yaks::Resource.new(type: 'author', attributes: {name: name})
   end
 
   context 'with no mapper specified' do
-    let(:mapper)   { Yaks::Undefined }
+    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(has_one.create_subresource(nil, {author: author}, context)).to eql [
-        'http://rel',
-        Yaks::Resource.new(type: 'author', attributes: {name: name})
-      ]
+      expect(subresource).to eql(
+        Yaks::Resource.new(
+          subresources: {
+            'http://rel' => Yaks::Resource.new(type: 'author', attributes: {name: name})
+          }
+        )
+      )
     end
 
   end

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

@@ -11,8 +11,43 @@ RSpec.describe Yaks::Mapper::Link do
 
   its(:template_variables) { should eq [:x, :y] }
   its(:uri_template) { should eq URITemplate.new(template) }
-  its(:expand?) { should be true }
 
+  let(:object) { Struct.new(:x, :y, :returns_nil).new(3, 4, nil) }
+
+  let(:mapper_class) do
+    Class.new(Yaks::Mapper) do
+      type 'foo'
+    end
+  end
+
+  let(:mapper) do
+    mapper_class.new(yaks_context).tap do |mapper|
+      mapper.call(object) # set @object
+    end
+  end
+
+  describe '#add_to_resource' do
+    it 'should add itself to the resource' do
+      expect(link.add_to_resource(Yaks::Resource.new, mapper, yaks_context)).to eql(
+        Yaks::Resource.new(links: [Yaks::Resource::Link.new(:next, "/foo/bar/3/4", {})])
+      )
+    end
+
+    context 'with a link function returning nothing' do
+      let(:template) { :link_computer }
+      before do
+        mapper_class.class_eval do
+          def link_computer ; end
+        end
+      end
+
+      it 'should not render the link' do
+        expect(link.add_to_resource(Yaks::Resource.new, mapper, yaks_context)).to eql(
+          Yaks::Resource.new
+        )
+      end
+    end
+  end
 
   describe '#rel?' do
     it 'should return true if the relation matches' do
@@ -47,8 +82,6 @@ RSpec.describe Yaks::Mapper::Link do
       it 'should keep the template in the response' do
         expect(link.expand_with(->{ })).to eq '/foo/bar/{x}/{y}'
       end
-
-      its(:expand?) { should be false }
     end
 
     context 'with a URI without expansion variables' do
@@ -81,14 +114,6 @@ RSpec.describe Yaks::Mapper::Link do
 
     its(:rel) { should eq :next }
 
-    let(:object) { Struct.new(:x, :y, :returns_nil).new(3, 4, nil) }
-
-    let(:mapper) do
-      Yaks::Mapper.new(yaks_context).tap do |mapper|
-        mapper.call(object) # set @object
-      end
-    end
-
     context 'with attributes' do
       it 'should not have a title' do
         expect(resource_link.options.key?(:title)).to be false
@@ -146,8 +171,15 @@ RSpec.describe Yaks::Mapper::Link do
     context 'with a title lambda' do
       let(:options) { { title: -> { "say #{mapper_method}" } } }
 
+      before do
+        mapper_class.class_eval do
+          def mapper_method
+            'hello'
+          end
+        end
+      end
+
       it 'should evaluate the lambda in the context of the mapper' do
-        expect(mapper).to receive(:mapper_method).and_return('hello')
         expect(resource_link.title).to eq 'say hello'
       end
     end

data/spec/unit/yaks/mapper_spec.rb

@@ -7,7 +7,8 @@ RSpec.describe Yaks::Mapper do
   let(:resource)     { mapper.call(instance) }
 
   let(:mapper_class) { Class.new(Yaks::Mapper) { type 'foo' } }
-  let(:instance)     { double(foo: 'hello', bar: 'world') }
+
+  let(:instance) { fake(foo: 'hello', bar: 'world') }
 
   its(:env) { should equal rack_env }
 
@@ -17,7 +18,10 @@ RSpec.describe Yaks::Mapper do
     end
 
     it 'should make the configured attributes available on the instance' do
-      expect(mapper.attributes).to eq [:foo, :bar]
+      expect(mapper.attributes).to eq [
+        Yaks::Mapper::Attribute.new(:foo),
+        Yaks::Mapper::Attribute.new(:bar)
+      ]
     end
 
     it 'should load them from the model' do
@@ -27,8 +31,8 @@ RSpec.describe Yaks::Mapper do
     context 'with attribute filtering' do
       before do
         mapper_class.class_eval do
-          def filter(attrs)
-            attrs.to_a - [:foo]
+          def attributes
+            super.reject {|attr| attr.name == :foo}
           end
         end
       end
@@ -75,10 +79,10 @@ RSpec.describe Yaks::Mapper do
   end
 
   context 'with subresources' do
-    let(:instance)      { double(widget: widget) }
-    let(:widget)        { double(type: 'super_widget') }
+    let(:widget)   { fake(type: 'super_widget') }
+    let(:instance) { fake(widget: widget) }
     let(:widget_mapper) { Class.new(Yaks::Mapper) { type 'widget' } }
-    let(:policy)        { double('Policy') }
+    fake(:policy) { Yaks::DefaultPolicy }
 
     describe 'has_one' do
       let(:has_one_opts) do
@@ -109,11 +113,13 @@ RSpec.describe Yaks::Mapper do
           { rel: 'http://foo.bar/rels/widgets' }
         end
 
-        it 'should derive the mapper based on policy' do
-          expect(policy).to receive(:derive_mapper_from_association) {|assoc|
-            expect(assoc).to be_a Yaks::Mapper::HasOne
+        before do
+          stub(policy).derive_mapper_from_association(mapper.associations.first) do
             widget_mapper
-          }
+          end
+        end
+
+        it 'should derive the mapper based on policy' do
           expect(resource.subresources).to eq(
             "http://foo.bar/rels/widgets" => Yaks::Resource.new(type: 'widget', attributes: {:type => "super_widget"})
           )
@@ -125,12 +131,13 @@ RSpec.describe Yaks::Mapper do
           { mapper: widget_mapper }
         end
 
-        it 'should derive the rel based on policy' do
-          expect(policy).to receive(:derive_rel_from_association) {|parent_mapper, assoc|
-            expect(parent_mapper).to equal mapper
-            expect(assoc).to be_a Yaks::Mapper::HasOne
+        before do
+          stub(policy).derive_rel_from_association(mapper.associations.first) do
             'http://rel/rel'
-          }
+          end
+        end
+
+        it 'should derive the rel based on policy' do
           expect(resource.subresources).to eq(
             "http://rel/rel" => Yaks::Resource.new(type: 'widget', attributes: {:type => "super_widget"})
           )
@@ -140,7 +147,9 @@ RSpec.describe Yaks::Mapper do
       context 'with the association filtered out' do
         before do
           mapper_class.class_eval do
-            def filter(attrs) [] end
+            def associations
+              []
+            end
           end
         end
 
@@ -172,4 +181,23 @@ RSpec.describe Yaks::Mapper do
       expect(mapper.call(nil)).to be_a Yaks::NullResource
     end
   end
+
+  context 'with a link generated by a method that returns nil' do
+    before do
+      mapper_class.class_eval do
+        attributes :id
+        link :bar_link, :link_generating_method
+
+        def link_generating_method
+        end
+      end
+    end
+
+    it 'should not render the link' do
+      expect(mapper.call(fake(id: 123))).to eql Yaks::Resource.new(
+        type: 'foo',
+        attributes: {id: 123}
+      )
+    end
+  end
 end

data/spec/unit/yaks/resource_spec.rb

@@ -4,13 +4,17 @@ RSpec.describe Yaks::Resource do
   subject(:resource) { described_class.new(init_opts) }
   let(:init_opts) { {} }
 
-  its(:type)           { should be_nil }
-  its(:attributes)     { should eql({}) }
-  its(:links)          { should eql [] }
-  its(:subresources)   { should eql({}) }
-  its(:self_link)      { should be_nil }
-  its(:null_resource?) { should be false }
-  its(:collection?)    { should be false }
+  context 'with a zero-arg constructor' do
+    subject(:resource) { described_class.new }
+
+    its(:type)           { should be_nil }
+    its(:attributes)     { should eql({}) }
+    its(:links)          { should eql [] }
+    its(:subresources)   { should eql({}) }
+    its(:self_link)      { should be_nil }
+    its(:null_resource?) { should be false }
+    its(:collection?)    { should be false }
+  end
 
   context 'with a type' do
     let(:init_opts) { { type: 'post' } }
@@ -56,4 +60,34 @@ RSpec.describe Yaks::Resource do
   it 'should act as a collection of one' do
     expect(resource.each.to_a).to eql [resource]
   end
+
+  describe 'persistent updates' do
+    let(:resource) {
+      Yaks::Resource.new(
+        attributes: {x: :y},
+        links: [:one],
+        subresources: {foo_rel: :subres}
+      )
+    }
+
+    it 'should do updates without modifying the original' do
+      expect(
+        resource
+          .update_attributes(foo: :bar)
+          .add_link(:a_link)
+          .add_subresource(:rel, :a_subresource)
+          .update_attributes(foo: :baz)
+      ).to eq Yaks::Resource.new(
+        attributes: {x: :y, foo: :baz},
+        links: [:one, :a_link],
+        subresources: {foo_rel: :subres, rel: :a_subresource}
+      )
+
+      expect(resource).to eq Yaks::Resource.new(
+        attributes: {x: :y},
+        links: [:one],
+        subresources: {foo_rel: :subres}
+      )
+    end
+  end
 end

data/yaks.gemspec

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require File.expand_path('../lib/yaks/version', __FILE__)
+require File.expand_path('../lib/yaks/breaking_changes', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name        = 'yaks'
@@ -17,6 +18,10 @@ Gem::Specification.new do |gem|
   gem.test_files       = `git ls-files -- spec`.split($/)
   gem.extra_rdoc_files = %w[README.md]
 
+  if Yaks::BreakingChanges.key? Yaks::VERSION
+    gem.post_install_message = Yaks::BreakingChanges[Yaks::VERSION]
+  end
+
   gem.add_runtime_dependency 'inflection'   , '~> 1.0'
   gem.add_runtime_dependency 'concord'      , '~> 0.1.4'
   gem.add_runtime_dependency 'uri_template' , '~> 0.6.0'
@@ -24,9 +29,10 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'virtus'
   gem.add_development_dependency 'rspec', '~> 2.99'
+  gem.add_development_dependency 'bogus'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'mutant-rspec'
-  gem.add_development_dependency 'mutant', '0.5.12'
+  gem.add_development_dependency 'mutant'
   gem.add_development_dependency 'rspec-its'
   gem.add_development_dependency 'benchmark-ips'
 end