yaks 0.4.2 → 0.4.3

data/lib/yaks/resource.rb

@@ -1,11 +1,12 @@
 module Yaks
   class Resource
     include Equalizer.new(:type, :links, :attributes, :subresources)
+    include FP::HashUpdatable.new(:type, :links, :attributes, :subresources)
     include Enumerable
 
     attr_reader :type, :attributes, :links, :subresources
 
-    def initialize(options)
+    def initialize(options = {})
       @type         = options.fetch(:type, nil)
       @attributes   = options.fetch(:attributes, {})
       @links        = options.fetch(:links, [])
@@ -16,16 +17,13 @@ module Yaks
       attributes[attr]
     end
 
-    # def type
-    # end
-
     def each
       return to_enum unless block_given?
       yield self
     end
 
     def self_link
-      links.find do |link|
+      links.reverse.find do |link|
         link.rel.equal? :self
       end
     end
@@ -37,5 +35,17 @@ module Yaks
     def null_resource?
       false
     end
+
+    def update_attributes(new_attrs)
+      update(attributes: @attributes.merge(new_attrs))
+    end
+
+    def add_link(link)
+      update(links: @links + [link])
+    end
+
+    def add_subresource(rel, subresource)
+      update(subresources: @subresources.merge(rel => subresource))
+    end
   end
 end

data/lib/yaks/version.rb

@@ -1,3 +1,3 @@
 module Yaks
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

data/lib/yaks.rb

@@ -11,19 +11,21 @@ require 'rack/accept'
 
 require 'yaks/util'
 require 'yaks/fp'
+require 'yaks/fp/updatable'
+require 'yaks/fp/hash_updatable'
 require 'yaks/primitivize'
 
 require 'yaks/default_policy'
 
 module Yaks
+  # A PORO
   Undefined = Object.new
+  # Set the Root constant as the gems root path
   Root = Pathname(__FILE__).join('../..')
 
-  YAKS_DEFAULT_OPTIONS = {
-    singular_links: [:self, :profile]
-  }
-
   class << self
+    # @param [Proc] blk
+    # @return [Yaks::Config]
     def new(&blk)
       Yaks::Config.new(&blk)
     end
@@ -37,17 +39,21 @@ require 'yaks/null_resource'
 require 'yaks/resource/link'
 require 'yaks/collection_resource'
 
+require 'yaks/mapper/class_methods'
+require 'yaks/mapper'
+require 'yaks/mapper/attribute'
 require 'yaks/mapper/link'
 require 'yaks/mapper/association'
+require 'yaks/mapper/association_mapper'
 require 'yaks/mapper/has_one'
 require 'yaks/mapper/has_many'
 require 'yaks/mapper/config'
-require 'yaks/mapper/class_methods'
-require 'yaks/mapper'
 require 'yaks/collection_mapper'
 
-require 'yaks/serializer'
-require 'yaks/serializer/hal'
-require 'yaks/serializer/json_api'
-require 'yaks/serializer/collection_json'
+require 'yaks/format'
+require 'yaks/format/hal'
+require 'yaks/format/json_api'
+require 'yaks/format/collection_json'
+
+require 'yaks/config/dsl'
 require 'yaks/config'

data/spec/acceptance/acceptance_spec.rb

@@ -1,23 +1,17 @@
 require 'spec_helper'
 
-require_relative './models'
+require 'acceptance/models'
+require 'acceptance/json_shared_examples'
 
-RSpec.shared_examples_for 'JSON output format' do |yaks, format, name|
-  let(:input)  { load_yaml_fixture(name) }
-  let(:output) { load_json_fixture("#{name}.#{format}") }
-
-  subject { yaks.serialize(input) }
-
-  it { should deep_eql output }
-end
-
-RSpec.describe Yaks::Serializer::Hal do
+RSpec.describe Yaks::Format::Hal do
   yaks_rel_template = Yaks.new do
+    format_options :hal, plural_links: ['http://literature.example.com/rels/quotes']
     rel_template "http://literature.example.com/rel/{association_name}"
   end
 
   yaks_policy_dsl = Yaks.new do
-    derive_rel_from_association do |mapper, association|
+    format_options :hal, plural_links: ['http://literature.example.com/rels/quotes']
+    derive_rel_from_association do |association|
       "http://literature.example.com/rel/#{association.name}"
     end
   end
@@ -26,7 +20,7 @@ RSpec.describe Yaks::Serializer::Hal do
   include_examples 'JSON output format' , yaks_policy_dsl   , :hal , 'confucius'
 end
 
-RSpec.describe Yaks::Serializer::JsonApi do
+RSpec.describe Yaks::Format::JsonApi do
   config = Yaks.new do
     default_format :json_api
   end
@@ -34,11 +28,16 @@ RSpec.describe Yaks::Serializer::JsonApi do
   include_examples 'JSON output format' , config , :json_api , 'confucius'
 end
 
-RSpec.describe Yaks::Serializer::CollectionJson do
-  config = Yaks.new do
+RSpec.describe Yaks::Format::CollectionJson do
+  youtypeit_yaks = Yaks.new do
+    default_format :collection_json
+    namespace Youtypeitwepostit
+  end
+
+  confucius_yaks = Yaks.new do
     default_format :collection_json
-    mapper_namespace Youtypeitwepostit
   end
 
-  include_examples 'JSON output format' , config , :collection , 'youtypeitwepostit'
+  include_examples 'JSON output format', youtypeit_yaks, :collection, 'youtypeitwepostit'
+  include_examples 'JSON output format', confucius_yaks, :collection, 'confucius'
 end

data/spec/acceptance/json_shared_examples.rb

@@ -0,0 +1,8 @@
+RSpec.shared_examples_for 'JSON output format' do |yaks, format, name|
+  let(:input)  { load_yaml_fixture(name) }
+  let(:output) { load_json_fixture("#{name}.#{format}") }
+
+  subject { yaks.serialize(input) }
+
+  it { should deep_eql output }
+end

data/spec/acceptance/models.rb

@@ -17,7 +17,7 @@ class Era
 end
 
 class LiteratureBaseMapper < Yaks::Mapper
-  link :profile, 'http://literature.example.com/profiles/{mapper_name}'
+  link :profile, 'http://literature.example.com/profiles/{mapper_name}', expand: true
   link :self, 'http://literature.example.com/{mapper_name}/{id}'
 end
 
@@ -25,7 +25,7 @@ class ScholarMapper < LiteratureBaseMapper
   attributes :id, :name, :pinyin, :latinized
   has_many :works
 
-  link 'http://literature.example.com/rels/quotes', 'http://literature.example.com/quotes/?author={downcased_pinyin}&q={query}', expand: [:downcased_pinyin]
+  link 'http://literature.example.com/rels/quotes', 'http://literature.example.com/quotes/?author={downcased_pinyin}&q={query}', expand: [:downcased_pinyin], title: 'Search for quotes'
   link :self, 'http://literature.example.com/authors/{downcased_pinyin}'
 
   def downcased_pinyin

data/spec/integration/map_to_resource_spec.rb

@@ -14,14 +14,14 @@ RSpec.describe 'Mapping domain models to Resource objects' do
 
   its(:subresources) {
     should eq(
-      "rel:src=friend&dest=pet_peeve" => Yaks::Resource.new(type:'pet_peeve', attributes: {id: 4, type: 'parsing with regexps'}),
-      "rel:src=friend&dest=pets" => Yaks::CollectionResource.new(
+      "rel:pet_peeve" => Yaks::Resource.new(type:'pet_peeve', attributes: {id: 4, type: 'parsing with regexps'}),
+      "rel:pets" => Yaks::CollectionResource.new(
         type: 'pet',
         members: [
           Yaks::Resource.new(type: 'pet', attributes: {:id => 2, :species => "dog", :name => "boingboing"}),
           Yaks::Resource.new(type: 'pet', attributes: {:id => 3, :species => "cat", :name => "wassup"})
         ],
-        members_rel: 'rel:src=collection&dest=pets'
+        collection_rel: 'rel:pets'
       )
     )
   }

data/spec/json/confucius.collection.json

@@ -0,0 +1,39 @@
+{
+  "collection": {
+    "version": "1.0",
+    "href": "http://literature.example.com/authors/kongzi",
+    "items": [
+      {
+        "href": "http://literature.example.com/authors/kongzi",
+        "data": [
+          {
+            "name": "id",
+            "value": 9
+          },
+          {
+            "name": "name",
+            "value": "孔子"
+          },
+          {
+            "name": "pinyin",
+            "value": "Kongzi"
+          },
+          {
+            "name": "latinized",
+            "value": "Confucius"
+          }
+        ],
+        "links": [
+          {
+            "rel": "profile",
+            "href": "http://literature.example.com/profiles/scholar"
+          },
+          {
+            "rel": "http://literature.example.com/rels/quotes",
+            "href": "http://literature.example.com/quotes/?author=kongzi&q={query}"
+          }
+        ]
+      }
+    ]
+  }
+}

data/spec/json/confucius.hal.json

@@ -6,10 +6,13 @@
   "_links": {
     "self":    { "href": "http://literature.example.com/authors/kongzi"  },
     "profile": { "href": "http://literature.example.com/profiles/scholar" },
-    "http://literature.example.com/rels/quotes": {
-        "href": "http://literature.example.com/quotes/?author=kongzi&q={query}",
-        "templated": true
-    }
+    "http://literature.example.com/rels/quotes": [
+        {
+          "href": "http://literature.example.com/quotes/?author=kongzi&q={query}",
+          "templated": true,
+          "title": "Search for quotes"
+        }
+    ]
   },
   "_embedded": {
     "http://literature.example.com/rel/works": [

data/spec/json/confucius.json_api.json

@@ -2,7 +2,7 @@
   "scholars": [
     {
       "id": 9,
-      "href": "http://literature.example.com/scholar/9",
+      "href": "http://literature.example.com/authors/kongzi",
       "name": "孔子",
       "pinyin": "Kongzi",
       "latinized": "Confucius",

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'rspec/its'
+require 'bogus/rspec'
 
 require 'yaks'
 require 'virtus'
@@ -13,6 +14,7 @@ require_relative 'support/fixtures'
 require_relative 'support/shared_contexts'
 require_relative 'support/youtypeit_models_mappers'
 require_relative 'support/deep_eql'
+require_relative 'support/classes_for_policy_testing'
 
 
 RSpec.configure do |rspec|
@@ -21,3 +23,7 @@ RSpec.configure do |rspec|
   #rspec.disable_monkey_patching!
   rspec.raise_errors_for_deprecations!
 end
+
+Bogus.configure do |bogus|
+  bogus.search_modules << Yaks
+end

data/spec/support/classes_for_policy_testing.rb

@@ -0,0 +1,36 @@
+# Used by Yaks::DefaultPolicy* tests to test various name inference schemes
+
+class SoyMapper ; end
+class Soy ; end
+class Wheat ; end
+
+module MyMappers
+  class SoyMapper ; end
+end
+
+class SoyCollectionMapper ; end
+
+module Namespace
+  module Nested
+    class Rye ; end
+  end
+
+  class RyeMapper ; end
+  class RyeCollectionMapper ; end
+
+  class CollectionMapper ; end
+
+  class ShoeMapper ; end
+end
+
+module DislikesCollectionMapper
+  def self.const_get(const)
+    raise "not a NameError" if const.to_s == 'CollectionMapper'
+  end
+end
+
+module DislikesOtherMappers
+  def self.const_get(const)
+    raise "not a NameError" if const.to_s != 'CollectionMapper'
+  end
+end

data/spec/support/shared_contexts.rb

@@ -3,7 +3,7 @@ RSpec.shared_context 'collection resource' do
     Yaks::CollectionResource.new(
       links: links,
       members: members,
-      members_rel: 'http://api.example.com/rels/plants'
+      collection_rel: 'http://api.example.com/rels/plants'
     )
   end
   let(:links)    { [] }

data/spec/unit/yaks/collection_mapper_spec.rb

@@ -7,14 +7,15 @@ RSpec.describe Yaks::CollectionMapper do
   let(:mapper_class) { described_class }
 
   let(:context) {
-    { member_mapper: member_mapper,
+    { item_mapper: item_mapper,
       policy: policy,
       env: {},
       mapper_stack: []
     }
   }
+
   let(:collection) { [] }
-  let(:member_mapper) { Class.new(Yaks::Mapper) { type 'the_type' } }
+  let(:item_mapper) { Class.new(Yaks::Mapper) { type 'the_type' } }
   let(:policy) { Yaks::DefaultPolicy.new }
 
   it 'should map the collection' do
@@ -23,13 +24,13 @@ RSpec.describe Yaks::CollectionMapper do
       links: [],
       attributes: {},
       members: [],
-      members_rel: 'rel:src=collection&dest=the_types'
+      collection_rel: 'rel:the_types'
     )
   end
 
   context 'with members' do
     let(:collection) { [boingboing, wassup]}
-    let(:member_mapper) { PetMapper }
+    let(:item_mapper) { PetMapper }
 
     it 'should map the members' do
       expect(mapper.call(collection)).to eql Yaks::CollectionResource.new(
@@ -40,7 +41,31 @@ RSpec.describe Yaks::CollectionMapper do
           Yaks::Resource.new(type: 'pet', attributes: {:id => 2, :species => "dog", :name => "boingboing"}),
           Yaks::Resource.new(type: 'pet', attributes: {:id => 3, :species => "cat", :name => "wassup"})
         ],
-        members_rel: 'rel:src=collection&dest=pets'
+        collection_rel: 'rel:pets'
+      )
+    end
+  end
+
+  context 'without an item_mapper in the context' do
+    let(:context) {
+      {
+        policy: policy,
+        env: {},
+        mapper_stack: []
+      }
+    }
+    let(:collection) { [boingboing, wassup]}
+
+    it 'should infer the item mapper' do
+      expect(mapper.call(collection)).to eql Yaks::CollectionResource.new(
+        type: nil,
+        links: [],
+        attributes: {},
+        members: [
+          Yaks::Resource.new(type: 'pet', attributes: {:id => 2, :species => "dog", :name => "boingboing"}),
+          Yaks::Resource.new(type: 'pet', attributes: {:id => 3, :species => "cat", :name => "wassup"})
+        ],
+        collection_rel: 'collection'
       )
     end
   end
@@ -65,7 +90,7 @@ RSpec.describe Yaks::CollectionMapper do
         links: [],
         attributes: { foo: 123, bar: 'pi la~~~' },
         members: [],
-        members_rel: 'rel:src=collection&dest=the_types'
+        collection_rel: 'rel:the_types'
       )
     end
   end
@@ -83,7 +108,7 @@ RSpec.describe Yaks::CollectionMapper do
         links: [ Yaks::Resource::Link.new(:self, 'http://api.example.com/orders', {}) ],
         attributes: { },
         members: [],
-        members_rel: 'rel:src=collection&dest=the_types'
+        collection_rel: 'rel:the_types'
       )
     end
   end
@@ -100,7 +125,7 @@ RSpec.describe Yaks::CollectionMapper do
     end
 
     let(:collection) { [boingboing, wassup]}
-    let(:member_mapper) { PetMapper }
+    let(:item_mapper) { PetMapper }
 
     it 'should use the redefined collection method' do
       expect(mapper.call(collection)).to eql Yaks::CollectionResource.new(
@@ -110,7 +135,7 @@ RSpec.describe Yaks::CollectionMapper do
         members: [
           Yaks::Resource.new(type: 'pet', attributes: {:id => 3, :species => "cat", :name => "wassup"})
         ],
-        members_rel: 'rel:src=collection&dest=pets'
+        collection_rel: 'rel:pets'
       )
     end
   end

data/spec/unit/yaks/collection_resource_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe Yaks::CollectionResource do
     its(:attributes)   { should eql({}) }
     its(:members)      { should eql []  }
     its(:subresources) { should eql({}) }
-    its(:members_rel)  { should eql('members') }
+    its(:collection_rel)  { should eql('members') }
   end
 
   context 'with a full constructor' do
@@ -32,7 +32,7 @@ RSpec.describe Yaks::CollectionResource do
             attributes: { customer: 'John Doe', price: 10.00 }
           )
         ],
-        members_rel: 'http://api.example.org/rels/orders'
+        collection_rel: 'http://api.example.org/rels/orders'
       }
     }
 
@@ -51,7 +51,7 @@ RSpec.describe Yaks::CollectionResource do
         )
       ]
     }
-    its(:members_rel) { should eq 'http://api.example.org/rels/orders'}
+    its(:collection_rel) { should eq 'http://api.example.org/rels/orders'}
 
     its(:subresources) { should eql(
         'http://api.example.org/rels/orders' => Yaks::CollectionResource.new(
@@ -68,7 +68,7 @@ RSpec.describe Yaks::CollectionResource do
               attributes: { customer: 'John Doe', price: 10.00 }
             )
           ],
-          members_rel: 'http://api.example.org/rels/orders'
+          collection_rel: 'http://api.example.org/rels/orders'
         )
       )
     }

data/spec/unit/yaks/config/dsl_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+RSpec.describe Yaks::Config::DSL do
+  subject!(:dsl) { described_class.new(yaks_config, &config_block) }
+
+  let(:yaks_config)  { Yaks::Config.new }
+  let(:config_block) { nil }
+
+  def self.configure(&blk)
+    let(:config_block) { blk }
+  end
+
+  describe '#initialize' do
+    its(:config) { should equal yaks_config }
+
+    it 'should set a default policy' do
+      expect(yaks_config.policy_class.new).to be_a_kind_of Yaks::DefaultPolicy
+    end
+
+    it 'should execute the given block in instance scope' do
+      dsl = described_class.new(yaks_config) do
+        @config = :foo
+      end
+      expect(dsl.config).to be :foo
+    end
+
+    describe 'policy redefinitions' do
+      configure do
+        derive_type_from_mapper_class do |mapper_class|
+          :inside_redefined_policy_method
+        end
+      end
+
+      it 'should delegate and redefine' do
+        expect(yaks_config.policy.derive_type_from_mapper_class(nil)).to be :inside_redefined_policy_method
+      end
+
+      it 'should not change the original class definition' do
+        expect(Yaks::DefaultPolicy.new.derive_type_from_mapper_class(fake(name: 'FooMapper'))).to eql 'foo'
+      end
+    end
+  end
+
+  describe '#format_options' do
+    configure { format_options :hal, singular_link: [:self] }
+    specify   { expect(yaks_config.format_options[:hal].should eq(singular_link: [:self])) }
+  end
+
+  describe '#default_format' do
+    configure { default_format :json_api }
+    specify   { expect(yaks_config.default_format).to be :json_api }
+  end
+
+  describe '#policy' do
+    configure { policy 'MyPolicyClass' }
+    specify   { expect(yaks_config.policy_class).to eql 'MyPolicyClass' }
+  end
+
+  describe '#rel_template' do
+    configure { rel_template 'rels:{rel}' }
+    specify   { expect(yaks_config.policy_options[:rel_template]).to eql 'rels:{rel}' }
+  end
+
+  describe '#mapper_namespace' do
+    configure { mapper_namespace RSpec }
+    specify   { expect(yaks_config.policy_options[:namespace]).to eql RSpec }
+  end
+
+  describe '#map_to_primitive' do
+    Foo = Class.new do
+      attr_reader :foo
+
+      def initialize(foo)
+        @foo = foo
+      end
+    end
+
+    configure { map_to_primitive(Foo) {|c| c.foo } }
+    specify   { expect(yaks_config.primitivize.call({:abc => Foo.new('hello')})).to eql 'abc' => 'hello' }
+  end
+
+  describe '#after' do
+    configure do
+      after {|x| x + 1}
+      after {|x| x + 10}
+    end
+    it 'should register the block' do
+      expect(yaks_config.steps.inject(0) {|memo, step| step.call(memo)}).to be 11
+    end
+  end
+end

data/spec/unit/yaks/config_spec.rb

@@ -56,7 +56,7 @@ RSpec.describe Yaks::Config do
 
   describe '#serialize' do
     configure do
-      rel_template 'http://api.mysuperfriends.com/{dest}'
+      rel_template 'http://api.mysuperfriends.com/{rel}'
       format_options :hal, plural_links: [:copyright]
     end
 
@@ -102,7 +102,7 @@ RSpec.describe Yaks::Config do
     end
   end
 
-  context 'passing in a rack env' do
+  describe '#format_class' do
     configure do
       default_format :collection_json
     end
@@ -111,19 +111,23 @@ RSpec.describe Yaks::Config do
       { 'HTTP_ACCEPT' => 'application/hal+json;q=0.8, application/vnd.api+json' }
     }
 
-    it 'should detect serializer based on accept header' do
+    it 'should fall back to the default when no HTTP_ACCEPT key is present' do
+      expect(config.format_class({}, {})).to equal Yaks::Format::CollectionJson
+    end
+
+    it 'should detect format based on accept header' do
       rack_env = { 'HTTP_ACCEPT' => 'application/hal+json;q=0.8, application/vnd.api+json' }
-      expect(config.serializer_class({}, rack_env)).to equal Yaks::Serializer::JsonApi
+      expect(config.format_class({}, rack_env)).to equal Yaks::Format::JsonApi
     end
 
     it 'should know to pick the best match' do
       rack_env = { 'HTTP_ACCEPT' => 'application/hal+json;q=0.8, application/vnd.api+json;q=0.7' }
-      expect(config.serializer_class({}, rack_env)).to equal Yaks::Serializer::Hal
+      expect(config.format_class({}, rack_env)).to equal Yaks::Format::Hal
     end
 
     it 'should fall back to the default when no mime type is recognized' do
       rack_env = { 'HTTP_ACCEPT' => 'text/html, application/json' }
-      expect(config.serializer_class({}, rack_env)).to equal Yaks::Serializer::CollectionJson
+      expect(config.format_class({}, rack_env)).to equal Yaks::Format::CollectionJson
     end
   end
 end