yaks 0.4.0.rc1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 598793af50666377a34d0efb9e5264b2c7767f3b
-  data.tar.gz: 87071e277c536147dcbe47a3201dbb59156191ef
+  metadata.gz: f3292feb7cef328921828cc97b68f397d23b7269
+  data.tar.gz: 0d074d9a0ea85e905d22572182904fe4f6fb3e36
 SHA512:
-  metadata.gz: 45b38a236ceb4ceafcb68007663069a158b638116a46599071e054979d2747fd47550cfa3b0d04028ccefd8e47e0999e251686ab2bba2f3b08615a84e9b8bf16
-  data.tar.gz: 0a0887de90d46d746a4dc1761a2f2d377dbb0bae99dd59c6e1101c1a493eceb147a4fae8344655f98fbebbd1a35ca00c7b0e7fc92b11f4db97df1205e71dcb1b
+  metadata.gz: a61962b2c69d90ba0b4ccbd2223bc14b27e0ee5ae773bcb12392c7d5bb9a9969497e5e86ae85761ebbab732230dd14f59dc3e8241b35282d9630c39b5c0f41fe
+  data.tar.gz: 12d9e712b28185dc1409518045da51d4eb4a9fd32c7be42a55747e7fd33b4698728a3c46bf170f54183576f7437eafa54db795fb13d4177594b9de62ed418165

data/CHANGELOG.md

@@ -1,10 +1,18 @@
-# v0.4.0 (unreleased)
+# v0.4.0
+
+* Introduce after {} post-processing hook
+* Streamline interfaces and variable names
+* Improve deriving mappers automatically, even with Rails style autoloading
+* Give CollectionResource a members_rel, for HAL-like formats with no top-level collection concept
+* Switch back to using `src` and `dest` as the rel-template keys
+
+# v0.4.0.rc1
 
 * Introduce Yaks.new as the main public interface
 * Fix JsonApiSerializer and make it compliant with current spec
 * Remove Hamster dependency, Yaks new uses plain old Ruby arrays and hashes
-* Remove RelRegistry and ProfileRegistry in favor of a simpler explicit syntax + policy based fallback
-* Add more policy derivation hooks, plus make DefaultPolicy template for rel urls configurable
+* Remove `RelRegistry` and `ProfileRegistry` in favor of a simpler explicit syntax + policy based fallback
+* Add more policy derivation hooks, plus make `DefaultPolicy` template for rel urls configurable
 * Optionally take a Rack env hash, pass it around so mappers can inspect it
 * Honor the HTTP Accept header if it is present in the rack env
 * Add map_to_primitive configuration option

data/README.md

@@ -314,6 +314,30 @@ yaks = Yaks.new do
 end
 ```
 
+## Primitives
+
+For JSON based formats, a final step in serializing is to turn the nested data into primitives that have a JSON equivalent. For example, JSON has no notion of symbols or dates. If your mappers return these types as attributes, then Yaks needs to know how to turn these into primitives. To add extra types, use `map_to_primitive`
+
+```ruby
+Yaks.new do
+  map_to_primitive Date, Time, DateTime do
+    object.iso8601
+  end
+end
+```
+
+This can also be used to transform alternative data structures, like those from Hamster, into Ruby arrays and hashes. Use `call()` to recursively turn things into primitives.
+
+```ruby
+Yaks.new do
+  map_to_primitive Hamster::Vector, Hamster::List do
+    object.map do |item|
+      call(item)
+    end
+  end
+end
+```
+
 ## Usage
 
 Yaks is used in production by [Ticketsolve](http://www.ticketsolve.com/). You can find an example API endpoint [here](http://leicestersquaretheatre.ticketsolve.com/api).

data/bench/bench.rb

@@ -0,0 +1,17 @@
+
+require 'benchmark/ips'
+require 'yaks'
+
+require_relative '../spec/acceptance/models'
+require_relative '../spec/fixture_helpers'
+
+Benchmark.ips do |x|
+  $yaks = Yaks.new
+
+  input = FixtureHelpers.load_yaml_fixture 'confucius'
+
+  x.report "Simple HAL mapping" do
+    $yaks.serialize(input)
+  end
+
+end

data/lib/yaks/collection_mapper.rb

@@ -5,34 +5,45 @@ module Yaks
     attr_reader :collection
     alias collection object
 
-    def initialize(collection, context)
-      super(collection, context)
+    def initialize(context)
+      super(context)
     end
 
-    def resource_mapper
-      context[:resource_mapper]
+    def member_mapper
+      context.fetch(:member_mapper) do
+        if collection.first
+          mapper_for_model(collection.first)
+        end
+      end
     end
 
-    def to_resource
+    def call(collection)
+      @object = collection
+
       CollectionResource.new(
         type: collection_type,
+        members_rel: members_rel,
         links: map_links,
         attributes: map_attributes,
         members: collection.map do |obj|
-          mapper_for_model(obj).new(obj, context).to_resource
+          mapper_for_model(obj).new(context).call(obj)
         end
       )
     end
 
     private
 
+    def members_rel
+      policy.expand_rel( 'collection', pluralize( collection_type ) )
+    end
+
     def collection_type
-      return unless context.key?(:resource_mapper)
-      resource_mapper.config.type || policy.derive_type_from_mapper_class(resource_mapper)
+      return unless member_mapper
+      member_mapper.config.type || policy.derive_type_from_mapper_class(member_mapper)
     end
 
     def mapper_for_model(model)
-      context.fetch(:resource_mapper) do
+      context.fetch(:member_mapper) do
         policy.derive_mapper_from_object(model)
       end
     end

data/lib/yaks/collection_resource.rb

@@ -15,18 +15,19 @@ module Yaks
   # In the second case a collection has a single "subresource", being its
   # members.
   class CollectionResource < Resource
-    include Equalizer.new(:type, :links, :attributes, :members)
+    include Equalizer.new(:type, :links, :attributes, :members, :members_rel)
     include Enumerable
 
     extend Forwardable
 
-    attr_reader :type, :links, :members
+    attr_reader :type, :links, :members, :members_rel
 
     def_delegators :members, :each
 
     def initialize(options)
       super
-      @members = options.fetch(:members, [])
+      @members     = options.fetch(:members, [])
+      @members_rel = options.fetch(:members_rel, 'members')
     end
 
     # Make a CollectionResource quack like a resource.
@@ -44,8 +45,7 @@ module Yaks
     # :(
     def subresources
       if members.any?
-        profile_link = links.select{|link| link.rel.equal? :profile}.first.uri
-        { profile_link => self }
+        { members_rel => self }
       else
         {}
       end

data/lib/yaks/config.rb

@@ -33,11 +33,16 @@ module Yaks
       def mapper_namespace(namespace)
         config.policy_options[:namespace] = namespace
       end
+      alias namespace mapper_namespace
 
       def map_to_primitive(*args, &blk)
         config.primitivize.map(*args, &blk)
       end
 
+      def after(&block)
+        config.steps << block
+      end
+
       DefaultPolicy.public_instance_methods(false).each do |method|
         define_method method do |&blk|
           @policies << proc {
@@ -47,13 +52,14 @@ module Yaks
       end
     end
 
-    attr_accessor :format_options, :default_format, :policy_class, :policy_options, :primitivize
+    attr_accessor :format_options, :default_format, :policy_class, :policy_options, :primitivize, :steps
 
     def initialize(&blk)
       @format_options = Hash.new({})
       @default_format = :hal
       @policy_options = {}
-      @primitivize =  Primitivize.create
+      @primitivize    = Primitivize.create
+      @steps          = [ @primitivize ]
       DSL.new(self, &blk)
     end
 
@@ -64,7 +70,7 @@ module Yaks
     def serializer_class(opts, env)
       if env.key? 'HTTP_ACCEPT'
         accept = Rack::Accept::Charset.new(env['HTTP_ACCEPT'])
-        mime_type = accept.best_of(Yaks::Serializer.mime_types)
+        mime_type = accept.best_of(Yaks::Serializer.mime_types.values)
         return Yaks::Serializer.by_mime_type(mime_type) if mime_type
       end
       Yaks::Serializer.by_name(opts.fetch(:format) { @default_format })
@@ -82,15 +88,16 @@ module Yaks
     # Yaks::Resource       => serialized structure
     # serialized structure => serialized flat
 
-    def serialize(object, opts = {}, env = {})
+    def call(object, opts = {}, env = {})
       context = {
         policy: policy,
         env: env
       }
       mapper     = opts.fetch(:mapper) { policy.derive_mapper_from_object(object) }
-      resource   = mapper.new(object, context).to_resource
+      resource   = mapper.new(context).call(object)
       serialized = serializer_class(opts, env).new(resource, format_options[format_name(opts)]).call
-      primitivize.call(serialized)
+      steps.inject(serialized) {|memo, step| step.call(memo) }
     end
+    alias serialize call
   end
 end

data/lib/yaks/default_policy.rb

@@ -3,7 +3,7 @@ module Yaks
     include Util
 
     DEFAULTS = {
-      rel_template: "rel:src={mapper_name}&dest={association_name}",
+      rel_template: "rel:src={src}&dest={dest}",
       namespace: Kernel
     }
 
@@ -15,9 +15,18 @@ module Yaks
 
     def derive_mapper_from_object(model)
       if model.respond_to? :to_ary
-        if @options[:namespace].const_defined?(:CollectionMapper)
-          @options[:namespace].const_get(:CollectionMapper)
+        if m = model.first
+          name = m.class.name.split('::').last + 'CollectionMapper'
+          begin
+            return @options[:namespace].const_get(name)
+          rescue NameError
+          end
         end
+        begin
+          return @options[:namespace].const_get(:CollectionMapper)
+        rescue NameError
+        end
+        Yaks::CollectionMapper
       else
         name = model.class.name.split('::').last
         @options[:namespace].const_get(name + 'Mapper')
@@ -25,19 +34,22 @@ module Yaks
     end
 
     def derive_type_from_mapper_class(mapper_class)
-      underscore(mapper_class.to_s.sub(/Mapper$/, ''))
+      underscore(mapper_class.name.split('::').last.sub(/Mapper$/, ''))
     end
 
     def derive_mapper_from_association(association)
-      Object.const_get("#{camelize(singularize(association.name.to_s))}Mapper")
+      @options[:namespace].const_get("#{camelize(singularize(association.name.to_s))}Mapper")
     end
 
     def derive_rel_from_association(mapper, association)
+      expand_rel( derive_type_from_mapper_class(mapper.class), association.name )
+    end
+
+    def expand_rel(src_name, dest_name)
       URITemplate.new(@options[:rel_template]).expand(
-        mapper_name: derive_type_from_mapper_class(mapper.class),
-        association_name: association.name
+        src: src_name,
+        dest: dest_name
       )
     end
-
   end
 end

data/lib/yaks/mapper/has_many.rb

@@ -2,14 +2,15 @@ module Yaks
   class Mapper
     class HasMany < Association
       def map_resource(collection, context)
-        resource_mapper = association_mapper(context.fetch(:policy))
-        context         = context.merge(resource_mapper: resource_mapper)
-        collection_mapper.new(collection, context).to_resource
+        policy        = context.fetch(:policy)
+        member_mapper = association_mapper(policy)
+        context       = context.merge(member_mapper: member_mapper)
+        collection_mapper(collection, policy).new(context).call(collection)
       end
 
-      def collection_mapper
+      def collection_mapper(collection, policy)
         return @collection_mapper unless @collection_mapper.equal? Undefined
-        CollectionMapper
+        policy.derive_mapper_from_object(collection)
       end
     end
   end

data/lib/yaks/mapper/has_one.rb

@@ -1,10 +1,10 @@
 module Yaks
   class Mapper
     class HasOne < Association
-      def map_resource(instance, context)
+      def map_resource(object, context)
         association_mapper(context.fetch(:policy))
-          .new(instance, context)
-          .to_resource
+          .new(context)
+          .call(object)
       end
     end
   end

data/lib/yaks/mapper.rb

@@ -10,8 +10,7 @@ module Yaks
 
     attr_reader :object, :context
 
-    def initialize(object, context)
-      @object  = object
+    def initialize(context)
       @context = context
     end
 
@@ -23,7 +22,9 @@ module Yaks
       context.fetch(:env)
     end
 
-    def call
+    def call(object)
+      @object = object
+
       return NullResource.new if object.nil?
 
       Resource.new(
@@ -33,7 +34,6 @@ module Yaks
         subresources: map_subresources
       )
     end
-    alias to_resource call
 
     def map_attributes
       filter(attributes).each_with_object({}) do |attr, memo|

data/lib/yaks/serializer.rb

@@ -24,7 +24,7 @@ module Yaks
         @serializers[name] = klass
 
         @mime_types  ||= {}
-        @mime_types[mime_type] = klass
+        @mime_types[mime_type] = [name, klass]
       end
 
       def by_name(name)
@@ -32,11 +32,11 @@ module Yaks
       end
 
       def by_mime_type(mime_type)
-        @mime_types.fetch(mime_type)
+        @mime_types.fetch(mime_type)[1]
       end
 
       def mime_types
-        @mime_types.keys
+        @mime_types.inject({}) {|memo, (mime_type, (name, _))| memo[name] = mime_type ; memo }
       end
     end
   end

data/lib/yaks/version.rb

@@ -1,3 +1,3 @@
 module Yaks
-  VERSION = '0.4.0.rc1'
+  VERSION = '0.4.0'
 end

data/lib/yaks.rb

@@ -2,6 +2,7 @@
 
 require 'forwardable'
 require 'set'
+require 'pathname'
 
 require 'concord'
 require 'inflection'
@@ -16,6 +17,7 @@ require 'yaks/default_policy'
 
 module Yaks
   Undefined = Object.new
+  Root = Pathname(__FILE__).join('../..')
 
   YAKS_DEFAULT_OPTIONS = {
     singular_links: [:self, :profile]

data/spec/acceptance/acceptance_spec.rb

@@ -1,6 +1,4 @@
 require 'spec_helper'
-require 'yaml'
-require 'json'
 
 require_relative './models'
 

data/spec/fixture_helpers.rb

@@ -0,0 +1,14 @@
+require 'yaml'
+require 'json'
+
+module FixtureHelpers
+  module_function
+
+  def load_json_fixture(name)
+    JSON.parse(Yaks::Root.join('spec/json', name + '.json').read)
+  end
+
+  def load_yaml_fixture(name)
+    YAML.load(Yaks::Root.join('spec/yaml', name + '.yaml').read)
+  end
+end

data/spec/integration/map_to_resource_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 RSpec.describe 'Mapping domain models to Resource objects' do
   include_context 'fixtures'
 
-  subject { mapper.to_resource }
-  let(:mapper) { FriendMapper.new(john, policy: Yaks::DefaultPolicy.new, env: {}) }
+  subject { mapper.call(john) }
+  let(:mapper) { FriendMapper.new(policy: Yaks::DefaultPolicy.new, env: {}) }
 
   it { should be_a Yaks::Resource }
   its(:type)         { should eql 'friend' }
@@ -19,7 +19,8 @@ RSpec.describe 'Mapping domain models to Resource objects' do
         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'
       )
     )
   }

data/spec/json/hal_plant_collection.json

@@ -4,7 +4,7 @@
       "self" : { "href" : "http://api.example.com/plants" }
   },
    "_embedded" : {
-      "http://api.example.com/doc/plant_collection" : [
+      "http://api.example.com/rels/plants" : [
          {
             "_links" : {
                "profile" : { "href" : "http://api.example.com/doc/plant" },

data/spec/spec_helper.rb

@@ -1,13 +1,9 @@
-require 'pathname'
 require 'rspec/its'
 
-ROOT = Pathname(__FILE__).join('../..')
-
-$LOAD_PATH.unshift(ROOT.join('lib'))
-
 require 'yaks'
 require 'virtus'
-require 'json'
+
+require 'fixture_helpers'
 
 require_relative 'support/models'
 require_relative 'support/pet_mapper'
@@ -17,15 +13,9 @@ require_relative 'support/fixtures'
 require_relative 'support/shared_contexts'
 require_relative 'support/youtypeit_models_mappers'
 
-def load_json_fixture(name)
-  JSON.parse(ROOT.join('spec/json', name + '.json').read)
-end
-
-def load_yaml_fixture(name)
-  YAML.load(ROOT.join('spec/yaml', name + '.yaml').read)
-end
 
 RSpec.configure do |rspec|
+  rspec.include FixtureHelpers
   rspec.backtrace_exclusion_patterns = [] if ENV['FULLSTACK']
   #rspec.disable_monkey_patching!
   rspec.raise_errors_for_deprecations!

data/spec/support/shared_contexts.rb

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

data/spec/unit/yaks/collection_mapper_spec.rb

@@ -3,48 +3,52 @@ require 'spec_helper'
 RSpec.describe Yaks::CollectionMapper do
   include_context 'fixtures'
 
-  subject(:mapper) { described_class.new(collection, context) }
+  subject(:mapper) { described_class.new(context) }
   let(:context) {
-    { resource_mapper: resource_mapper,
+    { member_mapper: member_mapper,
       policy: policy,
       env: {}
     }
   }
   let(:collection) { [] }
-  let(:resource_mapper) { Class.new(Yaks::Mapper) { type 'the_type' } }
+  let(:member_mapper) { Class.new(Yaks::Mapper) { type 'the_type' } }
   let(:policy) { Yaks::DefaultPolicy.new }
 
-  its(:to_resource) {
-    should eql Yaks::CollectionResource.new(
-        type: 'the_type',
-        links: [],
-        attributes: {},
-        members: []
+  it 'should map the collection' do
+    expect(mapper.call(collection)).to eql Yaks::CollectionResource.new(
+      type: 'the_type',
+      links: [],
+      attributes: {},
+      members: [],
+      members_rel: 'rel:src=collection&dest=the_types'
     )
-  }
+  end
 
   context 'with members' do
     let(:collection) { [boingboing, wassup]}
-    let(:resource_mapper) { PetMapper }
+    let(:member_mapper) { PetMapper }
 
-    its(:to_resource) {
-      should eql Yaks::CollectionResource.new(
+    it 'should map the members' do
+      mapper.call(collection)
+
+      expect(mapper.call(collection)).to eql Yaks::CollectionResource.new(
         type: 'pet',
         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"})
-        ]
+        ],
+        members_rel: 'rel:src=collection&dest=pets'
       )
-    }
+    end
   end
 
   context 'with collection attributes' do
     subject(:mapper) {
       Class.new(Yaks::CollectionMapper) do
         attributes :foo, :bar
-      end.new(collection, context)
+      end.new(context)
     }
 
     let(:collection) {
@@ -54,31 +58,33 @@ RSpec.describe Yaks::CollectionMapper do
       end.new([])
     }
 
-    its(:to_resource) {
-      should eql Yaks::CollectionResource.new(
+    it 'should map the attributes' do
+      expect(mapper.call(collection)).to eql Yaks::CollectionResource.new(
         type: 'the_type',
         links: [],
         attributes: { foo: 123, bar: 'pi la~~~' },
-        members: []
+        members: [],
+        members_rel: 'rel:src=collection&dest=the_types'
       )
-    }
+    end
   end
 
   context 'with collection links' do
     subject(:mapper) {
       Class.new(Yaks::CollectionMapper) do
         link :self, 'http://api.example.com/orders'
-      end.new(collection, context)
+      end.new(context)
     }
 
-    its(:to_resource) {
-      should eql Yaks::CollectionResource.new(
+    it 'should map the links' do
+      expect(mapper.call(collection)).to eql Yaks::CollectionResource.new(
         type: 'the_type',
         links: [ Yaks::Resource::Link.new(:self, 'http://api.example.com/orders', {}) ],
         attributes: { },
-        members: []
+        members: [],
+        members_rel: 'rel:src=collection&dest=the_types'
       )
-    }
+    end
   end
 
 end

data/spec/unit/yaks/collection_resource_spec.rb

@@ -50,7 +50,7 @@ RSpec.describe Yaks::CollectionResource do
     }
 
     its(:subresources) { should eql(
-        'http://rels/collection' => Yaks::CollectionResource.new(
+        'members' => Yaks::CollectionResource.new(
           type: 'order',
           attributes: { total: 10.00 },
           links: [
@@ -63,7 +63,7 @@ RSpec.describe Yaks::CollectionResource do
               links: [Yaks::Resource::Link.new(:self, 'http://order/10', {})],
               attributes: { customer: 'John Doe', price: 10.00 }
             )
-          ]
+          ],
         )
       )
     }

data/spec/unit/yaks/config_spec.rb

@@ -56,12 +56,12 @@ RSpec.describe Yaks::Config do
 
   describe '#serialize' do
     configure do
-      rel_template 'http://api.mysuperfriends.com/{association_name}'
+      rel_template 'http://api.mysuperfriends.com/{dest}'
       format_options :hal, plural_links: [:copyright]
     end
 
     specify do
-      expect(config.serialize(john)).to eql(load_json_fixture 'john.hal')
+      expect(config.call(john)).to eql(load_json_fixture 'john.hal')
     end
   end
 

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

@@ -3,9 +3,10 @@ require 'spec_helper'
 RSpec.describe Yaks::Mapper::HasMany do
   let(:closet_mapper) do
     Class.new(Yaks::Mapper) do
+      type 'closet'
       has_many :shoes,
         rel: 'http://foo/shoes',
-        mapper: Class.new(Yaks::Mapper) { type 'shoes' ; attributes :size, :color }
+        mapper: Class.new(Yaks::Mapper) { type 'shoe' ; attributes :size, :color }
     end
   end
 
@@ -19,13 +20,14 @@ RSpec.describe Yaks::Mapper::HasMany do
   }
 
   it 'should map the subresources' do
-    expect(closet_mapper.new(closet, policy: Yaks::DefaultPolicy.new, env: {}).map_subresources).to eql(
+    expect(closet_mapper.new(policy: Yaks::DefaultPolicy.new, env: {}).call(closet).subresources).to eql(
       "http://foo/shoes" => Yaks::CollectionResource.new(
-        type: 'shoes',
+        type: 'shoe',
         members: [
-          Yaks::Resource.new(type: 'shoes', attributes: {:size => 9, :color => :blue}),
-          Yaks::Resource.new(type: 'shoes', attributes: {:size => 11.5, :color => :red})
-        ]
+          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'
       )
     )
   end
@@ -35,12 +37,17 @@ RSpec.describe Yaks::Mapper::HasMany do
     subject(:has_many)  { described_class.new(:name, :mapper, :rel, collection_mapper) }
 
     context 'when the collection mapper is undefined' do
-      its(:collection_mapper) { should equal Yaks::CollectionMapper }
+      it 'should derive one from collection and policy' do
+        expect(has_many.collection_mapper([], Yaks::DefaultPolicy.new)).to equal Yaks::CollectionMapper
+      end
     end
 
     context 'when the collection mapper is specified' do
       let(:collection_mapper) { :foo }
-      its(:collection_mapper) { should equal :foo }
+
+      it 'should use the given collection mapper' do
+        expect(has_many.collection_mapper([], Yaks::DefaultPolicy.new)).to equal :foo
+      end
     end
   end
 end

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

@@ -11,6 +11,9 @@ RSpec.describe Yaks::Mapper::Link do
   its(:uri_template) { should eq URITemplate.new(template) }
   its(:expand?) { should be true }
 
+  let(:policy)            { Yaks::DefaultPolicy.new }
+  let(:context)           { { policy: policy, env: {} } }
+
   describe '#rel?' do
     it 'should return true if the relation matches' do
       expect(link.rel?(:next)).to be true
@@ -81,7 +84,9 @@ RSpec.describe Yaks::Mapper::Link do
     let(:object) { Struct.new(:x,:y).new(3,4) }
 
     let(:mapper) do
-      Yaks::Mapper.new(object, nil)
+      Yaks::Mapper.new(context).tap do |mapper|
+        mapper.call(object)
+      end
     end
 
     context 'with attributes' do

data/spec/unit/yaks/mapper_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 RSpec.describe Yaks::Mapper do
-  subject(:mapper)       { mapper_class.new(instance, context) }
+  subject(:mapper)   { mapper_class.new(context) }
+  let(:resource)     { mapper.call(instance) }
 
   let(:mapper_class) { Class.new(Yaks::Mapper) { type 'foo' } }
   let(:instance)     { double(foo: 'hello', bar: 'world') }
@@ -19,7 +20,7 @@ RSpec.describe Yaks::Mapper do
     end
 
     it 'should load them from the model' do
-      expect(mapper.map_attributes).to eq(foo: 'hello', bar: 'world')
+      expect(resource.attributes).to eq(foo: 'hello', bar: 'world')
     end
 
     context 'with attribute filtering' do
@@ -32,7 +33,7 @@ RSpec.describe Yaks::Mapper do
       end
 
       it 'should only map the non-filtered attributes' do
-        expect(mapper.map_attributes).to eq(:bar => 'world')
+        expect(resource.attributes).to eq(:bar => 'world')
       end
     end
   end
@@ -43,13 +44,13 @@ RSpec.describe Yaks::Mapper do
     end
 
     it 'should map the link' do
-      expect(mapper.map_links).to eq [
+      expect(resource.links).to eq [
         Yaks::Resource::Link.new(:profile, 'http://foo/bar', {})
       ]
     end
 
     it 'should use the link in the resource' do
-      expect(mapper.to_resource.links).to include Yaks::Resource::Link.new(:profile, 'http://foo/bar', {})
+      expect(resource.links).to include Yaks::Resource::Link.new(:profile, 'http://foo/bar', {})
     end
 
     context 'with the same link rel defined multiple times' do
@@ -62,7 +63,7 @@ RSpec.describe Yaks::Mapper do
       end
 
       it 'should map all the links' do
-        expect(mapper.map_links).to eq [
+        expect(resource.links).to eq [
           Yaks::Resource::Link.new(:profile, 'http://foo/bar', {}),
           Yaks::Resource::Link.new(:self, 'http://foo/bam', {}),
           Yaks::Resource::Link.new(:self, 'http://foo/baz', {}),
@@ -91,12 +92,12 @@ RSpec.describe Yaks::Mapper do
 
 
       it 'should have the subresource in the resource' do
-        expect(mapper.to_resource.subresources).to eq("http://foo.bar/rels/widgets" => Yaks::Resource.new(type: 'widget', attributes: {:type => "super_widget"}))
+        expect(resource.subresources).to eq("http://foo.bar/rels/widgets" => Yaks::Resource.new(type: 'widget', attributes: {:type => "super_widget"}))
       end
 
       context 'with explicit mapper and rel' do
         it 'should delegate to the given mapper' do
-          expect(mapper.map_subresources).to eq(
+          expect(resource.subresources).to eq(
             "http://foo.bar/rels/widgets" => Yaks::Resource.new(type: 'widget', attributes: {:type => "super_widget"})
           )
         end
@@ -112,7 +113,7 @@ RSpec.describe Yaks::Mapper do
             expect(assoc).to be_a Yaks::Mapper::HasOne
             widget_mapper
           }
-          expect(mapper.map_subresources).to eq(
+          expect(resource.subresources).to eq(
             "http://foo.bar/rels/widgets" => Yaks::Resource.new(type: 'widget', attributes: {:type => "super_widget"})
           )
         end
@@ -129,7 +130,7 @@ RSpec.describe Yaks::Mapper do
             expect(assoc).to be_a Yaks::Mapper::HasOne
             'http://rel/rel'
           }
-          expect(mapper.map_subresources).to eq(
+          expect(resource.subresources).to eq(
             "http://rel/rel" => Yaks::Resource.new(type: 'widget', attributes: {:type => "super_widget"})
           )
         end
@@ -143,7 +144,7 @@ RSpec.describe Yaks::Mapper do
         end
 
         it 'should not map the resource' do
-          expect(mapper.map_subresources).to eq({})
+          expect(resource.subresources).to eq({})
         end
       end
     end
@@ -162,16 +163,14 @@ RSpec.describe Yaks::Mapper do
       end
 
       it 'should get the attribute from the mapper' do
-        expect(mapper.map_attributes).to eq(fooattr: 'hello my friend', bar: 'world')
+        expect(resource.attributes).to eq(fooattr: 'hello my friend', bar: 'world')
       end
     end
   end
 
-  describe '#to_resource' do
-    let(:instance) { nil }
-
+  describe '#call' do
     it 'should return a NullResource when the subject is nil' do
-      expect(mapper.to_resource).to be_a Yaks::NullResource
+      expect(mapper.call(nil)).to be_a Yaks::NullResource
     end
   end
 end

data/spec/unit/yaks/serializer_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Yaks::Serializer do
+RSpec.describe Yaks::Serializer do
   describe '.by_name' do
     specify { expect(Yaks::Serializer.by_name(:hal)).to eql Yaks::Serializer::Hal }
     specify { expect(Yaks::Serializer.by_name(:json_api)).to eql Yaks::Serializer::JsonApi }

data/yaks.gemspec

@@ -23,8 +23,10 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'rack-accept'  , '~> 0.4.5'
 
   gem.add_development_dependency 'virtus'
-  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rspec', '~> 2.99'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'mutant-rspec'
+  gem.add_development_dependency 'mutant', '0.5.12'
   gem.add_development_dependency 'rspec-its'
+  gem.add_development_dependency 'benchmark-ips'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaks
 version: !ruby/object:Gem::Version
-  version: 0.4.0.rc1
+  version: 0.4.0
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflection
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.99'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.12
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Serialize to hypermedia. HAL, JSON-API, etc.
 email:
 - arne@arnebrasseur.net
@@ -151,6 +179,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bench/bench.rb
 - examples/hal01.rb
 - examples/jsonapi01.rb
 - examples/jsonapi02.rb
@@ -182,6 +211,7 @@ files:
 - shaved_yak.gif
 - spec/acceptance/acceptance_spec.rb
 - spec/acceptance/models.rb
+- spec/fixture_helpers.rb
 - spec/integration/map_to_resource_spec.rb
 - spec/json/confucius.hal.json
 - spec/json/confucius.json_api.json
@@ -230,9 +260,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -242,6 +272,7 @@ summary: Serialize to hypermedia. HAL, JSON-API, etc.
 test_files:
 - spec/acceptance/acceptance_spec.rb
 - spec/acceptance/models.rb
+- spec/fixture_helpers.rb
 - spec/integration/map_to_resource_spec.rb
 - spec/json/confucius.hal.json
 - spec/json/confucius.json_api.json