yaks 0.7.7 → 0.8.0.alpha

data/spec/unit/yaks/format/collection_json_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Format::CollectionJson do
   context 'with the plant collection resource' do
     include_context 'plant collection resource'
@@ -9,7 +7,110 @@ RSpec.describe Yaks::Format::CollectionJson do
     it { should deep_eql(load_json_fixture('plant_collection.collection')) }
   end
 
-  context 'link' do
+  context '#links?' do
+    context 'when resource is not a collection' do
+      let(:resource) {
+        Yaks::Resource.new(
+          attributes: {foo: 'fooval', bar: 'barval'},
+          links: [Yaks::Resource::Link.new(rel: 'the_rel', uri: 'the_uri')]
+        )
+      }
+
+      let(:cj) { Yaks::Format::CollectionJson.new(resource) }
+
+      it 'should return false' do
+        expect(cj.links?(resource)).to eq false
+      end
+    end
+
+    context 'when resource is a collection' do
+      let(:cj) { Yaks::Format::CollectionJson.new(resource) }
+
+      context 'and has links' do
+        let(:resource) {
+          Yaks::CollectionResource.new(
+            links: [Yaks::Resource::Link.new(rel: 'the_rel', uri: 'the_uri')]
+          )
+        }
+
+        it 'should return true' do
+          expect(cj.links?(resource)).to eq true
+        end
+      end
+
+      context 'and has no links' do
+        let(:resource) {
+          Yaks::CollectionResource.new(
+            links: []
+          )
+        }
+
+        it 'should return false' do
+          expect(cj.links?(resource)).to eq false
+        end
+      end
+    end
+  end
+
+  context '#queries?' do
+    let(:resource) {
+      Yaks::Resource.new(
+        attributes: {foo: 'fooval', bar: 'barval'},
+        forms: [Yaks::Resource::Form.new(full_args)]
+      )
+    }
+
+    subject {
+      Yaks::Primitivize.create.call(described_class.new.call(resource))
+    }
+
+    context 'when resource has GET forms' do
+      context 'and form has an action' do
+        let(:full_args) {
+          {
+            name: :search,
+            method: 'GET',
+            action: '/foo'
+          }
+        }
+
+        it 'should return true' do
+          cj = Yaks::Format::CollectionJson.new(resource)
+          expect(cj.queries?(resource)).to eq true
+        end
+      end
+
+      context 'and form has no action' do
+        let(:full_args) {
+          {
+            name: :search,
+            method: 'GET'
+          }
+        }
+
+        it 'should return false' do
+          cj = Yaks::Format::CollectionJson.new(resource)
+          expect(cj.queries?(resource)).to eq false
+        end
+      end
+    end
+
+    context 'when resource has not GET forms' do
+      let(:full_args) {
+        {
+          name: :search,
+          method: 'POST'
+        }
+      }
+
+      it 'should return false' do
+        cj = Yaks::Format::CollectionJson.new(resource)
+        expect(cj.queries?(resource)).to eq false
+      end
+    end
+  end
+
+  context 'serialize_links' do
     context 'without title' do
       let(:resource) {
         Yaks::Resource.new(
@@ -70,4 +171,95 @@ RSpec.describe Yaks::Format::CollectionJson do
       end
     end
   end
+
+  context 'serialize_queries' do
+    let(:resource) {
+      Yaks::Resource.new(
+        attributes: {foo: 'fooval', bar: 'barval'},
+        forms: [
+          Yaks::Resource::Form.new(full_args),
+          Yaks::Resource::Form.new(name: :no_render, action: '/foo', method: 'POST')
+        ]
+      )
+    }
+
+    subject {
+      Yaks::Primitivize.create.call(described_class.new.call(resource))
+    }
+
+    context 'when form method is GET' do
+      context "form uses only required fields" do
+        let(:full_args) {
+          {
+            name: :search,
+            action: '/foo',
+            method: 'GET'
+          }
+        }
+
+        it 'should render the queries array' do
+          should deep_eql(
+            "collection" => {
+              "version" => "1.0",
+              "items" => [
+                {
+                  "data" => [
+                    { "name"=>"foo", "value"=>"fooval" },
+                    { "name"=>"bar", "value"=>"barval" }
+                  ]
+                }
+              ],
+              "queries" => [
+                { "href"=>"/foo", "rel"=>"search" }
+              ]
+            }
+          )
+        end
+      end
+
+      context "form uses optional fields" do
+        let(:fields) {
+          [
+            Yaks::Resource::Form::Field.new(name: 'foo'),
+            Yaks::Resource::Form::Field.new(name: 'bar', label: 'My Bar Field')
+          ]
+        }
+
+        let(:full_args) {
+          {
+            name: :search,
+            action: '/foo',
+            method: 'GET',
+            title: 'My query prompt',
+            fields: fields
+          }
+        }
+
+        it 'should render the queries array with optional fields' do
+          should deep_eql(
+            "collection" => {
+              "version" => "1.0",
+              "items" => [
+                {
+                  "data" => [
+                    { "name"=>"foo", "value"=>"fooval" },
+                    { "name"=>"bar", "value"=>"barval" }
+                  ]
+                }
+              ],
+              "queries" => [
+                { "href"=>"/foo", "rel"=>"search", "prompt"=>"My query prompt",
+                  "data"=>
+                  [
+                    { "name"=>"foo", "value"=>"" },
+                    { "name"=>"bar", "value"=>"", "prompt"=>"My Bar Field" }
+                  ]
+                }
+              ]
+            }
+          )
+        end
+      end
+    end
+  end
 end

data/spec/unit/yaks/format/hal_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Format::Hal do
   context 'with the plant collection resource' do
     include_context 'plant collection resource'

data/spec/unit/yaks/format/halo_spec.rb

@@ -1,3 +1,2 @@
-
 RSpec.describe Yaks::Format::Halo do
 end

data/spec/unit/yaks/format/html_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 # RSpec.describe Yaks::Format::HTML do
 
 # end

data/spec/unit/yaks/format/json_api_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 # Mainly tested through the acceptance tests, here covering a few specific edge cases
 RSpec.describe Yaks::Format::JsonAPI do
   let(:format) { Yaks::Format::JsonAPI.new }

data/spec/unit/yaks/format_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Format do
   describe '.by_name' do
     specify do
@@ -10,9 +8,9 @@ RSpec.describe Yaks::Format do
     end
   end
 
-  describe '.by_mime_type' do
+  describe '.by_media_type' do
     specify do
-      expect(Yaks::Format.by_mime_type('application/hal+json')).to eql Yaks::Format::Hal
+      expect(Yaks::Format.by_media_type('application/hal+json')).to eql Yaks::Format::Hal
     end
   end
 
@@ -25,9 +23,9 @@ RSpec.describe Yaks::Format do
     end
   end
 
-  describe '.mime_types' do
+  describe '.media_types' do
     specify do
-      expect(Yaks::Format.mime_types.values_at(:collection_json, :hal, :json_api)).to eql(["application/vnd.collection+json", "application/hal+json", "application/vnd.api+json"])
+      expect(Yaks::Format.media_types.values_at(:collection_json, :hal, :json_api)).to eql(["application/vnd.collection+json", "application/hal+json", "application/vnd.api+json"])
     end
   end
 end

data/spec/unit/yaks/fp/callable_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::FP::Callable do
   it 'should delegate to_proc to method(:call)' do
     obj = Class.new do

data/spec/unit/yaks/fp_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::FP do
   include described_class
 

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Mapper::AssociationMapper do
   include_context 'yaks context'
 

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Mapper::Association do
   include_context 'yaks context'
 

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Mapper::Attribute do
   include_context 'yaks context'
 

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

@@ -1,174 +1,13 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Mapper::Config do
-  Undefined = Yaks::Undefined
-
-  subject(:config) { described_class.new }
-
-  describe '#initialize' do
-    subject(:config) do
-      described_class.new(
-        type:         'foo',
-        attributes:   [:a],
-        links:        [:b],
-        associations: [:c]
-      )
-    end
-
-
-    its(:type)         { should eql 'foo' }
-    its(:attributes)   { should eql [:a] }
-    its(:links)        { should eql [:b] }
-    its(:associations) { should eql [:c] }
-  end
-
-  describe '#attributes' do
-    context 'an empty config' do
-      it 'should return an empty attributes list' do
-        expect(config.attributes).to eq []
-      end
-    end
 
+  describe '#add_attributes' do
     it 'should add attributes' do
-      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
-      expect(
-        config
-          .attributes(:foo, :bar)
-          .attributes(:baz)
-          .attributes
-      ).to eq [
-        Yaks::Mapper::Attribute.new(:foo),
-        Yaks::Mapper::Attribute.new(:bar),
-        Yaks::Mapper::Attribute.new(:baz)
-      ]
-    end
-  end
-
-  describe '#links' do
-    context 'an empty config' do
-      it 'should have an empty link list' do
-        expect(config.links).to eq []
-      end
-    end
-
-    describe 'adding links' do
-      let(:config) {
-        subject
-          .link(:self, '/foo/bar/{id}')
-          .link(:profile, '/profile/foo')
-      }
-
-      it 'should have the links in the link list' do
-        expect(config.links).to include Yaks::Mapper::Link.new(rel: :profile, template: '/profile/foo')
-        expect(config.links).to include Yaks::Mapper::Link.new(rel: :self, template: '/foo/bar/{id}')
-      end
-    end
-
-    describe 'links with the same rel' do
-      let(:config) {
-        subject
-          .link(:self, '/foo/self')
-          .link(:self, '/foo/me')
-      }
-
-      it 'should have the links in the defined order' do
-        expect(config.links).to eql [
-          Yaks::Mapper::Link.new(rel: :self, template: '/foo/self'),
-          Yaks::Mapper::Link.new(rel: :self, template: '/foo/me')
-        ]
-      end
-    end
-  end
-
-  describe '#has_one' do
-    context 'with a mapper specified' do
-      let(:config) { subject.has_one :mother, mapper: Yaks::Mapper }
-
-      it 'should have the association configured' do
-        expect(config.associations).to eq [
-          Yaks::Mapper::HasOne.new(name: :mother, item_mapper: Yaks::Mapper)
-        ]
-      end
-    end
-
-    context 'with no options' do
-      let(:config) { subject.has_one :mother }
-
-      it 'should have undefined mapper, rel, collection_mapper' do
-        expect(config.associations).to eq [
-          Yaks::Mapper::HasOne.new(name: :mother)
-        ]
-      end
-    end
-
-    context 'with a rel specified' do
-      let(:config) { subject.has_one :mother, rel: '/api/rels/mother' }
-
-      it 'should have the rel' do
-        expect(config.associations).to eq [
-          Yaks::Mapper::HasOne.new(name: :mother, rel: '/api/rels/mother')
-        ]
-      end
-
-    end
-  end
-
-  describe '#has_many' do
-    context 'with a mapper specified' do
-      let(:config) { subject.has_many :shoes, mapper: Yaks::Mapper }
-
-      it 'should have the association configured' do
-        expect(config.associations).to eq [
-          Yaks::Mapper::HasMany.new(name: :shoes, item_mapper: Yaks::Mapper)
-        ]
-      end
-    end
-
-    context 'with no options' do
-      let(:config) { subject.has_many :shoes }
-
-      it 'should have undefined mapper, rel, collection_mapper' do
-        expect(config.associations).to eq [
-          Yaks::Mapper::HasMany.new(name: :shoes)
+      expect(subject.add_attributes(:bar).add_attributes(:baz)).to eql described_class.new(
+        attributes: [
+          Yaks::Mapper::Attribute.new(:bar),
+          Yaks::Mapper::Attribute.new(:baz),
         ]
-      end
-    end
-
-    context 'with a collection mapper set' do
-      let(:config) { subject.has_many :shoes, collection_mapper: :a_collection_mapper }
-
-      it 'should have the association configured' do
-        expect(config.associations).to eq [
-          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
-        .has_many(:shoes)
-        .has_one(:mother)
-    }
-
-    it 'should have them all present' do
-      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/form/field_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Mapper::Form::Field do
   include_context 'yaks context'
 

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

@@ -1,7 +1,5 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Mapper::Form do
-  let(:form)   { described_class.new( full_args ) }
+  let(:form)   { described_class.create( full_args ) }
   let(:name)      { :the_name }
   let(:full_args) { {name: name}.merge(args) }
   let(:args) {
@@ -16,26 +14,14 @@ RSpec.describe Yaks::Mapper::Form do
   let(:fields) { [] }
 
   describe '.create' do
-    it 'should create an instance, first arg is the name' do
-
-      expect( described_class.create(name, args) ).to eql form
-    end
-
     it 'should have a name of nil when ommitted' do
       expect(described_class.create.name).to be_nil
     end
   end
 
   describe '#add_to_resource' do
-    let(:resource) { form.add_to_resource(Yaks::Resource.new, Yaks::Mapper.new(nil), nil) }
+    let(:resource) { form.new.add_to_resource(Yaks::Resource.new, Yaks::Mapper.new(nil), nil) }
 
-    it 'should add a form to the resource' do
-      expect(resource.forms.length).to be 1
-    end
-
-    it 'should create a Yaks::Resource::Form with corresponding fields' do
-      expect(resource.forms.first).to eql Yaks::Resource::Form.new( full_args )
-    end
 
     context 'with fields' do
       let(:fields) {
@@ -49,16 +35,6 @@ RSpec.describe Yaks::Mapper::Form do
         ]
       }
 
-      it 'should map to Yaks::Resource::Form::Field instances' do
-        expect(resource.forms.first.fields).to eql [
-          Yaks::Resource::Form::Field.new(
-            name: 'field name',
-            label: 'field label',
-            type: 'text',
-            value: 7
-          )
-        ]
-      end
     end
   end
 end

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Mapper::HasMany do
   include_context 'yaks context'
 

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Mapper::HasOne do
   include_context 'yaks context'
 

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Mapper::Link do
   include_context 'yaks context'
 
@@ -45,6 +43,19 @@ RSpec.describe Yaks::Mapper::Link do
       end
     end
 
+    context 'with :replace => true' do
+      let(:options) { { remove: true } }
+      let(:resource) {
+        Yaks::Resource.new.add_link(Yaks::Resource::Link.new(rel: :next, uri: '/api/next'))
+      }
+
+      it 'should remove earlier links of the same rel' do
+        expect(link.add_to_resource(resource, mapper, yaks_context)).to eql(
+          Yaks::Resource.new
+        )
+      end
+    end
+
     context 'with :replace => true' do
       let(:options) { { replace: true } }
       let(:resource) {

data/spec/unit/yaks/mapper_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Mapper do
   include_context 'yaks context'
 
@@ -306,19 +304,13 @@ RSpec.describe Yaks::Mapper do
 
   describe '#map_links' do
     let(:object) { fake('Link') }
-    before { mapper.config(mapper.config.append_to(:links, object)) }
+    before { mapper_class.config = mapper.config.append_to(:links, object) }
     it_should_behave_like 'something that can be added to a resource'
   end
 
   describe '#map_subresources' do
     let(:object) { fake('Association') }
-    before { mapper.config(mapper.config.append_to(:associations, object)) }
-    it_should_behave_like 'something that can be added to a resource'
-  end
-
-  describe '#map_forms' do
-    let(:object) { fake('Form') }
-    before { mapper.config(mapper.config.append_to(:forms, object)) }
+    before { mapper_class.config = mapper.config.append_to(:associations, object) }
     it_should_behave_like 'something that can be added to a resource'
   end
 

data/spec/unit/yaks/null_resource_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::NullResource do
   subject(:null_resource) { described_class.new }
 
@@ -33,8 +31,8 @@ RSpec.describe Yaks::NullResource do
   end
 
   it 'should not allow updating attributes' do
-    expect { null_resource.update_attributes({}) }.to raise_error(
-      Yaks::UnsupportedOperationError, "Operation update_attributes not supported on Yaks::NullResource"
+    expect { null_resource.merge_attributes({}) }.to raise_error(
+      Yaks::UnsupportedOperationError, "Operation merge_attributes not supported on Yaks::NullResource"
     )
   end