yaks 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bee1c06eddf937efc5ff746b97d372c0a3ff5691
-  data.tar.gz: 8079af8a09a0b0949fcd034f1df937279f203860
+  metadata.gz: b4ec03c9b3f3c19ac3eaca461185e507d6f7edb3
+  data.tar.gz: 01e2fb005d69f7add878d814e23cc76029a49969
 SHA512:
-  metadata.gz: 7b3d2438420e029ab8548b4b63e5cc518bba5b9584cfb7ea7321c7a9ce5a5e400dccf0613d36881fc0bcd474ac40ed038051355adbeebae008543fc02e7dd9d4
-  data.tar.gz: 49e39f0108e9d045c3225bd672da3fb544d9b08ef00382552100baab91adc13936bdf2fe1eff974dcff0e6f2e624831f457c325358d0c29c546ae61ff1df8568
+  metadata.gz: 8833c0d2122ad0b3cce1791ac7f4b982110595e31cb33c54db8740085404ba98cf2e4eda60cd941f77f7f82e263f415f56f80bfae82e6baeff6660ea92b6f792
+  data.tar.gz: 9b93205060524ffa7aa2b7a8a1d3c59491c208df0c77fd8942baa27498c17757c4117a3cf555ce2d019ce45be0a546c2de4de7b365823501fba830482579dd26

data/README.md

@@ -8,28 +8,25 @@
 [gemnasium]: https://gemnasium.com/plexus/yaks
 [codeclimate]: https://codeclimate.com/github/plexus/yaks
 
-# Yak Serializers
+# Yaks
 
-### One Stop Hypermedia Shopping ###
+The library that understands hypermedia.
 
-*We did the shaving for you*
+Yaks consists of a resource representation that is independent of any
+output type. A Yaks mapper transforms an object into a resource, which
+can then be serialized into whichever output format the client
+requested. These formats are presently supported:
 
-Yaks is a tool for turning your domain models into Hypermedia resources.
-
-There are at the moment a number of competing media types for building Hypermedia APIs. These all add a layer of semantics on top of a low level serialization format such as JSON or XML. Even though they each have their own design goals, the core features mostly overlap. They typically provide a way to represent resources (entities), and resource collections, consisting of
-
-* Data in key-value format, possibly with composite values
-* Embedded resources
-* Links to related resources
-* Outbound links that have a specific relation to the resource
-
-They might also contain extra control data to specify possible future interactions, not unlike HTML forms.
-
-These different media types for Hypermedia clients and servers base themselves on the same set of internet standards, such as [RFC4288 Media types](http://tools.ietf.org/html/rfc4288), [RFC5988 Web Linking](http://tools.ietf.org/html/rfc5988), [RFC6906 The "profile" link relation](http://tools.ietf.org/search/rfc6906) and [RFC6570 URI Templates](http://tools.ietf.org/html/rfc6570).
+* HAL
+* JSON API
+* Collection+JSON
+* HTML
+* HALO
 
 ## Concepts
 
-Yaks is a processing pipeline, you create and configure the pipeline, then feed data through it.
+Yaks is a processing pipeline, you create and configure the pipeline,
+then feed data through it.
 
 ``` ruby
 yaks = Yaks.new do
@@ -42,7 +39,7 @@ yaks = Yaks.new do
   end
 end
 
-yaks.call(data) # => JSON
+yaks.call(data) # => '{"foo": "bar", "_links": { ... }}'
 ```
 
 Yaks performs this serialization in three steps
@@ -386,10 +383,6 @@ default_format :collection_json
 
 Subresources aren't mapped because Collection+JSON doesn't really have that concept, and the other way around templates and queries don't exist (yet) in Yaks.
 
-### More formats
-
-Are planned... at the moment HAL is the only format I actually use, so it's the one that's best supported. Adding formats that follow the resource=(attributes, links, subresources) structure or a subset thereof is straightforward. More features, e.g. forms/actions such as used in Mason might be added in the future.
-
 ## Hooks
 
 It is possible to hook into the Yaks pipeline to perform extra processing steps before, after, or around each step. It also possible to skip a step.
@@ -481,25 +474,19 @@ Yaks by default "primitivizes" symbols (as strings), and classes that include En
 
 Yaks is used in production by [Ticketsolve](http://www.ticketsolve.com/). You can find an example API endpoint [here](http://leicestersquaretheatre.ticketsolve.com/api).
 
-Get in touch if you like to see your name and API here.
-
 ## Demo
 
-You can find an example app at [Yakports](https://github.com/plexus/yakports), or browse the HAL api directly using the [HAL browser](http://yaks-airports.herokuapp.com/browser.html).
-
-## Acknowledgment
-
-The mapper syntax is largely borrowed from ActiveModel::Serializers, which in turn closely mimics the syntax of ActiveRecord models. It's a great concise syntax that still offers plenty of flexibility, so to not reinvent the wheel I've stuck to the existing syntax as far as practical, although there are several extensions and deviations.
-
-## Lightweight
-
-Yaks is a lean library. It only depends on a few other tiny libraries (inflection, concord, uri_template). It has no core extensions (monkey patches). There is deliberately no built-in "integration" with existing frameworks, since the API is simply enough. You just call it.
+You can find an outdated example app at [Yakports](https://github.com/plexus/yakports), or browse the HAL api directly using the [HAL browser](http://yaks-airports.herokuapp.com/browser.html).
 
-If this approach sounds appealing, have a look at [microrb.com](http://microrb.com/).
+## Standards Based
 
-## Is it any good
+Yaks is based on internet standards, including
 
-[Yes](https://news.ycombinator.com/item?id=3067434)
+* [RFC4288 Media types](http://tools.ietf.org/html/rfc4288)
+* [RFC5988 Web Linking](http://tools.ietf.org/html/rfc5988)
+* [RFC6906 The "profile" link relation](http://tools.ietf.org/search/rfc6906)
+* [RFC6570 URI Templates](http://tools.ietf.org/html/rfc6570)
+* [RFC4229 HTTP Header Field Registrations](http://tools.ietf.org/html/rfc4229).
 
 ## How to contribute
 

data/lib/yaks/breaking_changes.rb

@@ -5,7 +5,20 @@ module Yaks
 
 BreakingChanges = {
 
-'0.5.0' => %q~
+    '0.7.0' => %q~
+Breaking Changes in Yaks 0.7.0
+==============================
+Yaks::Resource#subresources is now an array, not a hash. The rel is
+stored on the resource itself as Yaks::Resource#rels (an array). This
+should only be of concern if you implement custom output formats
+
+The general signature of all processing steps (mapper, formatter,
+hooks) has changed to incldue a second parameter, the rack env. If you
+have custom implementations of any of these, or hooks that are not
+specified as ruby blocks, you will need to take this into account
+~,
+
+    '0.5.0' => %q~
 
 Breaking Changes in Yaks 0.5.0
 ==============================
@@ -26,7 +39,7 @@ for full documentation.
 
 ~,
 
-'0.4.3' => %q~
+    '0.4.3' => %q~
 
 Breaking Changes in Yaks 0.4.3
 ==============================

data/lib/yaks/collection_mapper.rb

@@ -16,7 +16,9 @@ module Yaks
         end
       }
 
-      attrs[ :collection_rel ] = collection_rel
+      if context[:mapper_stack].empty?
+        attrs[:rels] = [collection_rel]
+      end
 
       map_attributes(
         map_links(

data/lib/yaks/collection_resource.rb

@@ -5,25 +5,20 @@ module Yaks
   # A collection can be the top-level result of an API call, like all posts to
   # a blog, or a subresource collection, like the comments on a post result.
   #
-  # Some formats treat everything like a collection, and a single resource as a
-  # collection of one. Others treat every top level response as singular, e.g.
-  # a single "collection of orders". Because of this Resource and
-  # CollectionResource can both be iterated with #each, for the "everything is
-  # a collection crowd", and they both respond to `links`, `attributes` and
-  # `subresources`, so they can both be approached like a singular resource.
-  #
-  # In the second case a collection has a single "subresource", being its
-  # members.
   class CollectionResource < Resource
-    include attributes.add(members: [], collection_rel: 'members')
+    include attributes.add(members: [])
 
     extend Forwardable
-    def_delegators :members, :each
+    def_delegators :members, :each, :map, :each_with_object
 
     # @return [Boolean]
     def collection?
       true
     end
 
+    def seq
+      self
+    end
+
   end
 end

data/lib/yaks/config.rb

@@ -47,6 +47,10 @@ module Yaks
       @policy ||= @policy_class.new(@policy_options)
     end
 
+    def runner(object, options)
+      Runner.new(config: self, object: object, options: options)
+    end
+
     # Main entry point into yaks
     #
     # @param object [Object] The object to serialize
@@ -58,7 +62,7 @@ module Yaks
     # @option item_mapper [Class] Mapper class to use for items in a top-level collection
     #
     def call(object, options = {})
-      Runner.new(config: self, object: object, options: options).call
+      runner(object, options).call
     end
     alias serialize call
   end

data/lib/yaks/format.rb

@@ -20,7 +20,7 @@ module Yaks
 
     # @param [Yaks::Resource] resource
     # @return [Hash]
-    def call(resource)
+    def call(resource, env = {})
       serialize_resource(resource)
     end
     alias serialize call

data/lib/yaks/format/collection_json.rb

@@ -19,7 +19,7 @@ module Yaks
       # @param [Yaks::Resource] resource
       # @return [Array]
       def serialize_items(resource)
-        resource.map do |item|
+        resource.seq.map do |item|
           attrs = item.attributes.map do |name, value|
             {
               name: name,

data/lib/yaks/format/hal.rb

@@ -40,7 +40,7 @@ module Yaks
 
         if resource.collection?
           result = result.merge(_embedded:
-                                  serialize_embedded(resource.collection_rel => resource))
+                                  serialize_embedded([resource]))
         elsif resource.subresources.any?
           result = result.merge(_embedded:
                                   serialize_embedded(resource.subresources))
@@ -79,12 +79,14 @@ module Yaks
       # @param [Array] subresources
       # @return [Hash]
       def serialize_embedded(subresources)
-        subresources.each_with_object({}) do |(rel, resources), memo|
-          memo[rel] = if resources.collection?
-                        resources.map( &method(:serialize_resource) )
-                      else
-                        serialize_resource(resources) unless resources.null_resource?
-                      end
+        subresources.each_with_object({}) do |sub, memo|
+          memo[sub.rels.first] = if sub.collection?
+                                   sub.map( &method(:serialize_resource) )
+                                 elsif sub.null_resource?
+                                   nil
+                                 else
+                                   serialize_resource(sub)
+                                 end
         end
       end
 

data/lib/yaks/format/json_api.rb

@@ -9,11 +9,11 @@ module Yaks
 
       # @param [Yaks::Resource] resource
       # @return [Hash]
-      def call(resource)
-        main_collection = resource.map(&method(:serialize_resource))
+      def call(resource, env = {})
+        main_collection = resource.seq.map(&method(:serialize_resource))
 
         { pluralize(resource.type) => main_collection }.tap do |serialized|
-          linked = resource.each_with_object({}) do |res, hsh|
+          linked = resource.seq.each_with_object({}) do |res, hsh|
             serialize_linked_subresources(res.subresources, hsh)
           end
           serialized.merge!(linked: linked) unless linked.empty?
@@ -39,8 +39,8 @@ module Yaks
       # @param [Yaks::Resource] subresource
       # @return [Hash]
       def serialize_links(subresources)
-        subresources.each_with_object({}) do |(_name, resource), hsh|
-          next if resource.instance_of? NullResource
+        subresources.each_with_object({}) do |resource, hsh|
+          next if resource.null_resource?
           key = resource.collection? ? pluralize(resource.type) : resource.type
           hsh[key] = serialize_link(resource)
         end
@@ -56,7 +56,7 @@ module Yaks
       # @param [Hash] hsh
       # @return [Hash]
       def serialize_linked_subresources(subresources, hsh)
-        subresources.values.each do |resources|
+        subresources.each do |resources|
           serialize_linked_resources(resources, hsh)
         end
       end
@@ -64,8 +64,8 @@ module Yaks
       # @param [Array] resources
       # @param [Hash] linked
       # @return [Hash]
-      def serialize_linked_resources(resources, linked)
-        resources.each_with_object(linked) do |resource, memo|
+      def serialize_linked_resources(subresource, linked)
+        subresource.seq.each_with_object(linked) do |resource, memo|
           serialize_subresource(resource, memo)
         end
       end

data/lib/yaks/mapper.rb

@@ -36,7 +36,7 @@ module Yaks
       self.class.mapper_name(policy)
     end
 
-    def call(object)
+    def call(object, env = {})
       @object = object
 
       return NullResource.new if object.nil?

data/lib/yaks/mapper/association_mapper.rb

@@ -34,8 +34,8 @@ module Yaks
 
       def add_subresource(resource)
         object      = parent_mapper.load_association(association.name)
-        subresource = association.map_resource(object, context)
-        resource.add_subresource(rel, subresource)
+        subresource = association.map_resource(object, context).add_rel(rel)
+        resource.add_subresource(subresource)
       end
     end
   end

data/lib/yaks/null_resource.rb

@@ -1,10 +1,13 @@
 module Yaks
   class NullResource < Resource
-    include Equalizer.new(:collection?)
+    include attributes.add(collection: false),
+            Equalizer.new(:rels, :collection)
 
     def initialize(opts = {})
-      super()
-      @collection = opts.fetch(:collection) { false }
+      _opts = {}
+      _opts[:rels]       = opts[:rels]       if opts.key?(:rels)
+      _opts[:collection] = opts[:collection] if opts.key?(:collection)
+      super(_opts)
     end
 
     def each
@@ -19,6 +22,15 @@ module Yaks
       true
     end
 
+    def seq
+      []
+    end
+
+    def map
+      return [] if collection?
+      raise UnsupportedOperationError, "Operation #{__method__} not supported on #{self.class}"
+    end
+
     def update_attributes(_new_attrs)
       raise UnsupportedOperationError, "Operation #{__method__} not supported on #{self.class}"
     end
@@ -31,7 +43,7 @@ module Yaks
       raise UnsupportedOperationError, "Operation #{__method__} not supported on #{self.class}"
     end
 
-    def add_subresource(_rel, _subresource)
+    def add_subresource(_subresource)
       raise UnsupportedOperationError, "Operation #{__method__} not supported on #{self.class}"
     end
   end

data/lib/yaks/primitivize.rb

@@ -26,7 +26,7 @@ module Yaks
           object
         end
 
-        p.map Symbol do |object|
+        p.map Symbol, URI do |object|
           object.to_s
         end
 

data/lib/yaks/resource.rb

@@ -1,17 +1,25 @@
 module Yaks
   class Resource
     include Attributes.new(
-              type: nil, links: [], attributes: {}, subresources: {}, controls: []
-            ),
-            Enumerable
+              type: nil,
+              rels: [],
+              links: [],
+              attributes: {},
+              subresources: [],
+              controls: []
+            )
+
+    def initialize(attrs = {})
+      raise attrs.inspect if attrs.key?(:subresources) && !attrs[:subresources].instance_of?(Array)
+      super
+    end
 
     def [](attr)
       attributes[attr]
     end
 
-    def each
-      return to_enum unless block_given?
-      yield self
+    def seq
+      [self]
     end
 
     def self_link
@@ -23,23 +31,27 @@ module Yaks
     def collection?
       false
     end
+    alias collection collection?
 
     def null_resource?
       false
     end
 
-    def collection_rel
-      raise UnsupportedOperationError, "Only Yaks::CollectionResource has a collection_rel"
-    end
-
     def members
       raise UnsupportedOperationError, "Only Yaks::CollectionResource has members"
     end
+    alias each members
+    alias map members
+    alias each_with_object members
 
     def update_attributes(new_attrs)
       update(attributes: @attributes.merge(new_attrs))
     end
 
+    def add_rel(rel)
+      append_to(:rels, rel)
+    end
+
     def add_link(link)
       append_to(:links, link)
     end
@@ -48,8 +60,30 @@ module Yaks
       append_to(:controls, control)
     end
 
-    def add_subresource(rel, subresource)
-      update(subresources: @subresources.merge(rel => subresource))
+    def add_subresource(subresource)
+      append_to(:subresources, subresource)
+    end
+
+    def pp
+      indent = ->(str) { str.lines.map {|l| "  #{l}"}.join }
+      format = ->(val) { val.respond_to?(:pp) ? val.pp : val.inspect }
+
+      fmt_attrs = self.class.attributes.attributes.map do |attr|
+        value   = public_send(attr)
+        fmt_val = case value
+                  when Array
+                    if value.inspect.length < 50
+                      value.inspect
+                    else
+                      "[\n#{indent[value.map(&format).join(",\n")]}\n]"
+                    end
+                  else
+                    format[value]
+                  end
+        "#{attr}=#{fmt_val}"
+      end.join("\n")
+
+      "#<#{self.class.name}\n#{indent[fmt_attrs]}\n>"
     end
   end
 end

data/lib/yaks/runner.rb

@@ -5,11 +5,12 @@ module Yaks
     include Adamantium::Flat
     extend Forwardable
 
-    def_delegators :config, :policy, :default_format, :format_options, :primitivize, :serializers, :hooks
+    def_delegators :config, :policy, :default_format, :format_options, :primitivize, :serializers
 
     def call
-      steps.inject(object) {|memo, (_, step)| step.call(memo) }
+      steps.inject(object) {|memo, (_, step)| step.call(memo, env) }
     end
+    alias result call
 
     def context
       {
@@ -33,6 +34,14 @@ module Yaks
     end
     memoize :format_class
 
+    def media_type
+      format_class.media_type
+    end
+
+    def format
+      format_class.format_name
+    end
+
     def steps
       insert_hooks(
         [[ :map, mapper ],
@@ -55,7 +64,7 @@ module Yaks
     memoize :formatter
 
     def primitivizer
-      ->(input) do
+      proc do |input|
         if format_class.serializer.equal? :json
           primitivize.call(input)
         else
@@ -77,6 +86,10 @@ module Yaks
     end
     memoize :serializer
 
+    def hooks
+      config.hooks + options.fetch(:hooks, [])
+    end
+
     def insert_hooks(steps)
       hooks.inject(steps) do |steps, (type, target_step, name, hook)|
         steps.flat_map do |step_name, callable|

data/lib/yaks/serializer.rb

@@ -6,7 +6,7 @@ module Yaks
     end
 
     def self.all
-      @serializers ||= {json: JSON.method(:pretty_generate)}
+      @serializers ||= {json: ->(data, env) { JSON.pretty_generate(data) }}
     end
   end
 end

data/lib/yaks/version.rb

@@ -1,3 +1,3 @@
 module Yaks
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

data/spec/acceptance/json_shared_examples.rb

@@ -2,7 +2,7 @@ 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) }
+  subject { yaks.call(input) }
 
   it { should deep_eql output }
 end

data/spec/integration/map_to_resource_spec.rb

@@ -12,17 +12,56 @@ RSpec.describe 'Mapping domain models to Resource objects' do
   its(:attributes)   { should eql(id: 1, name: 'john') }
   its(:links)        { should eql [ Yaks::Resource::Link.new(rel: :copyright, uri: '/api/copyright/2024') ] }
 
+  specify {
+
+    subject.subresources ==       [
+        Yaks::Resource.new(
+          type:'pet_peeve',
+          rels: ['rel:pet_peeve'],
+          attributes: {id: 4, type: 'parsing with regexps'}
+        ),
+        Yaks::CollectionResource.new(
+          type: 'pet',
+          rels: ['rel:pets'],
+          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'}
+            )
+          ]
+        )
+      ]
+
+
+  }
+
   its(:subresources) {
     should eq(
-      "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"})
-        ],
-        collection_rel: 'rel:pets'
-      )
+      [
+        Yaks::Resource.new(
+          type:'pet_peeve',
+          rels: ['rel:pet_peeve'],
+          attributes: {id: 4, type: 'parsing with regexps'}
+        ),
+        Yaks::CollectionResource.new(
+          type: 'pet',
+          rels: ['rel:pets'],
+          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'}
+            )
+          ]
+        )
+      ]
     )
   }
 end

data/spec/support/shared_contexts.rb

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

data/spec/unit/yaks/collection_mapper_spec.rb

@@ -23,7 +23,7 @@ RSpec.describe Yaks::CollectionMapper do
       links: [],
       attributes: {},
       members: [],
-      collection_rel: 'rel:the_types'
+      rels: ['rel:the_types']
     )
   end
 
@@ -44,7 +44,7 @@ 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"})
         ],
-        collection_rel: 'rel:pets'
+        rels: ['rel:pets']
       )
     end
   end
@@ -68,7 +68,7 @@ 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"})
         ],
-        collection_rel: 'rel:pets'
+        rels: ['rel:pets']
       )
     end
   end
@@ -93,7 +93,7 @@ RSpec.describe Yaks::CollectionMapper do
         links: [],
         attributes: { foo: 123, bar: 'pi la~~~' },
         members: [],
-        collection_rel: 'rel:the_types'
+        rels: ['rel:the_types']
       )
     end
   end
@@ -111,7 +111,7 @@ RSpec.describe Yaks::CollectionMapper do
         links: [ Yaks::Resource::Link.new(rel: :self, uri: 'http://api.example.com/orders') ],
         attributes: { },
         members: [],
-        collection_rel: 'rel:the_types'
+        rels: ['rel:the_types']
       )
     end
   end
@@ -138,7 +138,7 @@ RSpec.describe Yaks::CollectionMapper do
         members: [
           Yaks::Resource.new(type: 'pet', attributes: {:id => 3, :species => "cat", :name => "wassup"})
         ],
-        collection_rel: 'rel:pets'
+        rels: ['rel:pets']
       )
     end
   end
@@ -146,18 +146,18 @@ RSpec.describe Yaks::CollectionMapper do
   context 'with an empty collection' do
 
     context 'without an item_mapper specified' do
-      let(:context) { Yaks::Util.slice_hash(super(), :policy, :env) }
+      let(:context) { Yaks::Util.slice_hash(super(), :policy, :env, :mapper_stack) }
 
       it 'should use a rel of "collection"' do
-        expect(mapper.([]).collection_rel).to eq 'collection'
+        expect(mapper.([]).rels).to eq ['collection']
       end
     end
 
     context 'with an item_mapper specified' do
-      let(:context) { Yaks::Util.slice_hash(super(), :policy, :env, :item_mapper) }
+      let(:context) { Yaks::Util.slice_hash(super(), :policy, :env, :mapper_stack, :item_mapper) }
 
       it 'should derive the collection rel from the item mapper' do
-        expect(mapper.([]).collection_rel).to eq 'rel:the_types'
+        expect(mapper.([]).rels).to eq ['rel:the_types']
       end
     end
 

data/spec/unit/yaks/collection_resource_spec.rb

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

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

@@ -39,16 +39,14 @@ RSpec.describe Yaks::Mapper::AssociationMapper do
         stub(association).render_as_link?(parent_mapper) { false }
         stub(association).map_rel(policy) { 'rels:the_rel' }
         stub(association).name { :the_name }
-        stub(association).map_resource(:the_object, association_mapper.context) { :the_resource }
+        stub(association).map_resource(:the_object, association_mapper.context) { Yaks::Resource.new }
 
         stub(parent_mapper).load_association(:the_name) { :the_object }
       end
 
-      it 'should render a link' do
+      it 'should render a subresource' do
         expect(association_mapper.call(Yaks::Resource.new)).to eql Yaks::Resource.new(
-          subresources: {
-            'rels:the_rel' => :the_resource
-          }
+          subresources: [ Yaks::Resource.new(rels: ['rels:the_rel']) ]
         )
       end
 

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

@@ -19,14 +19,14 @@ RSpec.describe Yaks::Mapper::Association do
   let(:href)              { Yaks::Undefined }
   let(:link_if)           { Yaks::Undefined }
 
-  its(:name)         { should equal :shoes }
+  its(:name)        { should equal :shoes }
   its(:item_mapper) { should equal Yaks::Mapper }
 
   context 'with a minimal constructor' do
     subject(:association) { described_class.new(name: :foo) }
 
     its(:name)         { should be :foo }
-    its(:item_mapper) { should be Yaks::Undefined }
+    its(:item_mapper)  { should be Yaks::Undefined }
     its(:rel)          { should be Yaks::Undefined }
     its(:href)         { should be Yaks::Undefined }
     its(:link_if)      { should be Yaks::Undefined }
@@ -38,12 +38,14 @@ RSpec.describe Yaks::Mapper::Association do
   describe '#add_to_resource' do
     let(:object) { fake(:shoes => []) }
     let(:rel)    { 'rel:shoes' }
+
     before do
       parent_mapper.call(object)
+      stub(association).map_resource(any_args) { Yaks::Resource.new }
     end
 
     it 'should delegate to AssociationMapper' do
-      expect(association.add_to_resource(Yaks::Resource.new, parent_mapper, yaks_context)).to eql Yaks::Resource.new(subresources: {'rel:shoes' => nil} )
+      expect(association.add_to_resource(Yaks::Resource.new, parent_mapper, yaks_context)).to eql Yaks::Resource.new(subresources: [Yaks::Resource.new(rels: ['rel:shoes'])])
     end
   end
 

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

@@ -28,22 +28,22 @@ RSpec.describe Yaks::Mapper::HasMany do
   }
 
   it 'should map the subresources' do
-    expect(closet_mapper.call(closet).subresources).to eql(
-      "http://foo/shoes" => Yaks::CollectionResource.new(
+    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})
         ],
-        collection_rel: 'rel:shoes'
+        rels: ['http://foo/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)
-    )
+    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

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

@@ -40,9 +40,9 @@ RSpec.describe Yaks::Mapper::HasOne do
     it 'should derive one based on policy' do
       expect(subresource).to eql(
         Yaks::Resource.new(
-          subresources: {
-            'http://rel' => Yaks::Resource.new(type: 'author', attributes: {name: name})
-          }
+          subresources: [
+            Yaks::Resource.new(type: 'author', attributes: {name: name}, rels: ['http://rel'])
+          ]
         )
       )
     end

data/spec/unit/yaks/mapper_spec.rb

@@ -98,14 +98,14 @@ RSpec.describe Yaks::Mapper do
 
 
         it 'should have the subresource in the resource' do
-          expect(resource.subresources).to eq("http://foo.bar/rels/widgets" => Yaks::Resource.new(type: 'widget', attributes: {:type => "super_widget"}))
+          expect(resource.subresources).to eq([Yaks::Resource.new(type: 'widget', attributes: {:type => 'super_widget'}, rels: ['http://foo.bar/rels/widgets'])])
         end
 
         context 'with explicit mapper and rel' do
           it 'should delegate to the given mapper' do
-            expect(resource.subresources).to eq(
-              "http://foo.bar/rels/widgets" => Yaks::Resource.new(type: 'widget', attributes: {:type => "super_widget"})
-            )
+            expect(resource.subresources).to eq([
+              Yaks::Resource.new(type: 'widget', attributes: {:type => 'super_widget'}, rels: ['http://foo.bar/rels/widgets'])
+            ])
           end
         end
 
@@ -121,9 +121,9 @@ RSpec.describe Yaks::Mapper do
           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"})
-            )
+            expect(resource.subresources).to eq([
+              Yaks::Resource.new(type: 'widget', attributes: {:type => 'super_widget'}, rels: ['http://foo.bar/rels/widgets'])
+            ])
           end
         end
 
@@ -139,9 +139,9 @@ RSpec.describe Yaks::Mapper do
           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"})
-            )
+            expect(resource.subresources).to eq([
+              Yaks::Resource.new(type: 'widget', attributes: {:type => 'super_widget'}, rels: ['http://rel/rel'])
+            ])
           end
         end
 
@@ -155,7 +155,7 @@ RSpec.describe Yaks::Mapper do
           end
 
           it 'should not map the resource' do
-            expect(resource.subresources).to eq({})
+            expect(resource.subresources).to eq([])
           end
         end
       end

data/spec/unit/yaks/null_resource_spec.rb

@@ -3,9 +3,9 @@ require 'spec_helper'
 RSpec.describe Yaks::NullResource do
   subject(:null_resource) { described_class.new }
 
-  its(:attributes)     { should eq Hash[] }
+  its(:attributes)     { should eq({}) }
   its(:links)          { should eq [] }
-  its(:subresources)   { should eq Hash[] }
+  its(:subresources)   { should eq [] }
   its(:collection?)    { should be false }
   its(:null_resource?) { should be true }
 
@@ -49,7 +49,7 @@ RSpec.describe Yaks::NullResource do
   end
 
   it 'should not allow adding subresources' do
-    expect { null_resource.add_subresource(nil, nil) }.to raise_error(
+    expect { null_resource.add_subresource(nil) }.to raise_error(
       Yaks::UnsupportedOperationError, "Operation add_subresource not supported on Yaks::NullResource"
     )
   end

data/spec/unit/yaks/resource_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe Yaks::Resource do
     its(:type)           { should be_nil }
     its(:attributes)     { should eql({}) }
     its(:links)          { should eql [] }
-    its(:subresources)   { should eql({}) }
+    its(:subresources)   { should eql [] }
     its(:self_link)      { should be_nil }
     its(:null_resource?) { should be false }
     its(:collection?)    { should be false }
@@ -48,17 +48,16 @@ RSpec.describe Yaks::Resource do
   end
 
   context 'with subresources' do
-    let(:init_opts) { { subresources: { 'comments' => [Yaks::Resource.new(type: 'comment')] } } }
-    its(:subresources) { should eql 'comments' => [Yaks::Resource.new(type: 'comment')]  }
+    let(:init_opts) { { subresources: [ Yaks::Resource.new(type: 'comment', rels: ['comments']) ] } }
+    its(:subresources) { should eql [Yaks::Resource.new(type: 'comment', rels: ['comments'])]  }
 
-    it 'should return an enumerator for #each' do
-      expect(resource.each.with_index.to_a).to eq  [ [resource, 0] ]
+    it 'should return an enumerable for #seq' do
+      expect(resource.seq.each.with_index.to_a).to eq  [ [resource, 0] ]
     end
   end
 
-
   it 'should act as a collection of one' do
-    expect(resource.each.to_a).to eql [resource]
+    expect(resource.seq.each.to_a).to eql [resource]
   end
 
   describe 'persistent updates' do
@@ -66,7 +65,7 @@ RSpec.describe Yaks::Resource do
       Yaks::Resource.new(
         attributes: {x: :y},
         links: [:one],
-        subresources: {foo_rel: :subres}
+        subresources: [ :subres ]
       )
     }
 
@@ -75,18 +74,18 @@ RSpec.describe Yaks::Resource do
         resource
           .update_attributes(foo: :bar)
           .add_link(:a_link)
-          .add_subresource(:rel, :a_subresource)
+          .add_subresource(: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}
+        subresources: [:subres, :a_subresource]
       )
 
       expect(resource).to eq Yaks::Resource.new(
         attributes: {x: :y},
         links: [:one],
-        subresources: {foo_rel: :subres}
+        subresources: [:subres]
       )
     end
   end
@@ -113,14 +112,6 @@ RSpec.describe Yaks::Resource do
     end
   end
 
-  describe '#collection_rel' do
-    it 'should raise unsupported operation error' do
-      expect { resource.collection_rel }.to raise_error(
-        Yaks::UnsupportedOperationError, "Only Yaks::CollectionResource has a collection_rel"
-      )
-    end
-  end
-
   describe '#members' do
     it 'should raise unsupported operation error' do
       expect { resource.members }.to raise_error(

data/spec/unit/yaks/runner_spec.rb

@@ -13,8 +13,8 @@ RSpec.describe Yaks::Runner do
     let(:runner) {
       Class.new(described_class) do
         def steps
-          [ [:step1, ->(x) { x + 35     }],
-            [:step2, ->(x) { "#{x} #{x}"}] ]
+          [ [:step1, proc { |x| x + 35      }],
+            [:step2, proc { |x| "#{x} #{x}" }] ]
         end
       end.new(object: object, config: config, options: options)
     }
@@ -219,12 +219,12 @@ RSpec.describe Yaks::Runner do
       }
 
       it 'should try to find an explicitly configured serializer' do
-        expect(runner.serializer.call('42')).to eql 'serialized 42'
+        expect(runner.serializer.call('42', {})).to eql 'serialized 42'
       end
     end
 
     it 'should fall back to the policy' do
-      expect(runner.serializer.call([1,2,3])).to eql "[\n  1,\n  2,\n  3\n]"
+      expect(runner.serializer.call([1,2,3], {})).to eql "[\n  1,\n  2,\n  3\n]"
     end
   end
 

data/spec/unit/yaks/serializer_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe Yaks::Serializer do
   end
 
   it 'should by default have a serializer for JSON' do
-    expect(Yaks::Serializer.all[:json].call([1,2,3])).to eql "[\n  1,\n  2,\n  3\n]"
+    expect(Yaks::Serializer.all[:json].call([1,2,3], {})).to eql "[\n  1,\n  2,\n  3\n]"
   end
 
   it 'should warn when registering a key again' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaks
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-05 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflection
@@ -346,7 +346,18 @@ homepage: https://github.com/plexus/yaks
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |2
+
+  Breaking Changes in Yaks 0.7.0
+  ==============================
+  Yaks::Resource#subresources is now an array, not a hash. The rel is
+  stored on the resource itself as Yaks::Resource#rels (an array). This
+  should only be of concern if you implement custom output formats
+
+  The general signature of all processing steps (mapper, formatter,
+  hooks) has changed to incldue a second parameter, the rack env. If you
+  have custom implementations of any of these, or hooks that are not
+  specified as ruby blocks, you will need to take this into account
 rdoc_options: []
 require_paths:
 - lib