yaks 0.3.1 → 0.4.0.rc1

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: yaks
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0.rc1
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: hamster
+  name: inflection
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: inflection
+  name: concord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
-  name: concord
+  name: uri_template
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: uri_template
+  name: rack-accept
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +122,21 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Serialize to JSON-API and similar
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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
 executables: []
@@ -134,7 +148,7 @@ files:
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - examples/hal01.rb
@@ -144,10 +158,9 @@ files:
 - lib/yaks.rb
 - lib/yaks/collection_mapper.rb
 - lib/yaks/collection_resource.rb
+- lib/yaks/config.rb
 - lib/yaks/default_policy.rb
-- lib/yaks/hal_serializer.rb
-- lib/yaks/json_api_serializer.rb
-- lib/yaks/link_lookup.rb
+- lib/yaks/fp.rb
 - lib/yaks/mapper.rb
 - lib/yaks/mapper/association.rb
 - lib/yaks/mapper/class_methods.rb
@@ -155,20 +168,26 @@ files:
 - lib/yaks/mapper/has_many.rb
 - lib/yaks/mapper/has_one.rb
 - lib/yaks/mapper/link.rb
-- lib/yaks/mapper/lookup.rb
-- lib/yaks/mapper/map_links.rb
 - lib/yaks/null_resource.rb
 - lib/yaks/primitivize.rb
-- lib/yaks/profile_registry.rb
-- lib/yaks/rel_registry.rb
 - lib/yaks/resource.rb
 - lib/yaks/resource/link.rb
 - lib/yaks/serializer.rb
-- lib/yaks/shared_options.rb
+- lib/yaks/serializer/collection_json.rb
+- lib/yaks/serializer/hal.rb
+- lib/yaks/serializer/json_api.rb
 - lib/yaks/util.rb
 - lib/yaks/version.rb
+- notes.org
+- shaved_yak.gif
+- spec/acceptance/acceptance_spec.rb
+- spec/acceptance/models.rb
 - spec/integration/map_to_resource_spec.rb
+- spec/json/confucius.hal.json
+- spec/json/confucius.json_api.json
 - spec/json/hal_plant_collection.json
+- spec/json/john.hal.json
+- spec/json/youtypeitwepostit.collection.json
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/friends_mapper.rb
@@ -177,17 +196,24 @@ files:
 - spec/support/pet_peeve_mapper.rb
 - spec/support/serializers.rb
 - spec/support/shared_contexts.rb
-- spec/support/shorthands.rb
-- spec/yaks/collection_resource_spec.rb
-- spec/yaks/hal_serializer_spec.rb
-- spec/yaks/mapper/association_spec.rb
-- spec/yaks/mapper/class_methods_spec.rb
-- spec/yaks/mapper/config_spec.rb
-- spec/yaks/mapper/has_one_spec.rb
-- spec/yaks/mapper/link_spec.rb
-- spec/yaks/mapper/map_links_spec.rb
-- spec/yaks/mapper_spec.rb
-- spec/yaks/resource_spec.rb
+- spec/support/youtypeit_models_mappers.rb
+- spec/unit/yaks/collection_mapper_spec.rb
+- spec/unit/yaks/collection_resource_spec.rb
+- spec/unit/yaks/config_spec.rb
+- spec/unit/yaks/fp_spec.rb
+- spec/unit/yaks/mapper/association_spec.rb
+- spec/unit/yaks/mapper/class_methods_spec.rb
+- spec/unit/yaks/mapper/config_spec.rb
+- spec/unit/yaks/mapper/has_many_spec.rb
+- spec/unit/yaks/mapper/has_one_spec.rb
+- spec/unit/yaks/mapper/link_spec.rb
+- spec/unit/yaks/mapper_spec.rb
+- spec/unit/yaks/resource_spec.rb
+- spec/unit/yaks/serializer/hal_spec.rb
+- spec/unit/yaks/serializer_spec.rb
+- spec/unit/yaks/util_spec.rb
+- spec/yaml/confucius.yaml
+- spec/yaml/youtypeitwepostit.yaml
 - yaks.gemspec
 homepage: https://github.com/plexus/yaks
 licenses:
@@ -204,18 +230,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Serialize to JSON-API and similar
+summary: Serialize to hypermedia. HAL, JSON-API, etc.
 test_files:
+- spec/acceptance/acceptance_spec.rb
+- spec/acceptance/models.rb
 - spec/integration/map_to_resource_spec.rb
+- spec/json/confucius.hal.json
+- spec/json/confucius.json_api.json
 - spec/json/hal_plant_collection.json
+- spec/json/john.hal.json
+- spec/json/youtypeitwepostit.collection.json
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/friends_mapper.rb
@@ -224,14 +256,21 @@ test_files:
 - spec/support/pet_peeve_mapper.rb
 - spec/support/serializers.rb
 - spec/support/shared_contexts.rb
-- spec/support/shorthands.rb
-- spec/yaks/collection_resource_spec.rb
-- spec/yaks/hal_serializer_spec.rb
-- spec/yaks/mapper/association_spec.rb
-- spec/yaks/mapper/class_methods_spec.rb
-- spec/yaks/mapper/config_spec.rb
-- spec/yaks/mapper/has_one_spec.rb
-- spec/yaks/mapper/link_spec.rb
-- spec/yaks/mapper/map_links_spec.rb
-- spec/yaks/mapper_spec.rb
-- spec/yaks/resource_spec.rb
+- spec/support/youtypeit_models_mappers.rb
+- spec/unit/yaks/collection_mapper_spec.rb
+- spec/unit/yaks/collection_resource_spec.rb
+- spec/unit/yaks/config_spec.rb
+- spec/unit/yaks/fp_spec.rb
+- spec/unit/yaks/mapper/association_spec.rb
+- spec/unit/yaks/mapper/class_methods_spec.rb
+- spec/unit/yaks/mapper/config_spec.rb
+- spec/unit/yaks/mapper/has_many_spec.rb
+- spec/unit/yaks/mapper/has_one_spec.rb
+- spec/unit/yaks/mapper/link_spec.rb
+- spec/unit/yaks/mapper_spec.rb
+- spec/unit/yaks/resource_spec.rb
+- spec/unit/yaks/serializer/hal_spec.rb
+- spec/unit/yaks/serializer_spec.rb
+- spec/unit/yaks/util_spec.rb
+- spec/yaml/confucius.yaml
+- spec/yaml/youtypeitwepostit.yaml

data/Gemfile.lock

@@ -1,111 +0,0 @@
-GIT
-  remote: git://github.com/harukizaemon/hamster.git
-  revision: f34f3e2faa489818bbbd069acaec005692891bc6
-  specs:
-    hamster (1.0.1.pre.rc.1)
-
-PATH
-  remote: .
-  specs:
-    yaks (0.3.1)
-      concord (~> 0.1.4)
-      hamster
-      inflection (~> 1.0.0)
-      uri_template (~> 0.6.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    abstract_type (0.0.7)
-    adamantium (0.2.0)
-      ice_nine (~> 0.11.0)
-      memoizable (~> 0.4.0)
-    anima (0.2.0)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.1)
-      equalizer (~> 0.0.8)
-    ast (2.0.0)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
-    concord (0.1.5)
-      adamantium (~> 0.2.0)
-      equalizer (~> 0.0.9)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.2.5)
-    equalizer (0.0.9)
-    ice_nine (0.11.0)
-    inflection (1.0.0)
-    inflecto (0.0.2)
-    memoizable (0.4.2)
-      thread_safe (~> 0.3, >= 0.3.1)
-    morpher (0.2.3)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      anima (~> 0.2.0)
-      ast (~> 2.0.0)
-      concord (~> 0.1.4)
-      equalizer (~> 0.0.9)
-      ice_nine (~> 0.11.0)
-      procto (~> 0.0.2)
-    mutant (0.5.11)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      anima (~> 0.2.0)
-      ast (~> 2.0)
-      concord (~> 0.1.5)
-      diff-lcs (~> 1.2)
-      equalizer (~> 0.0.9)
-      ice_nine (~> 0.11.0)
-      inflecto (~> 0.0.2)
-      memoizable (~> 0.4.2)
-      morpher (~> 0.2.3)
-      parser (~> 2.1)
-      procto (~> 0.0.2)
-      unparser (~> 0.1.12)
-    mutant-rspec (0.5.10)
-      mutant (~> 0.5.10)
-      rspec-core (>= 2.14.1, <= 3.0.0.beta2)
-    parser (2.1.9)
-      ast (>= 1.1, < 3.0)
-      slop (~> 3.4, >= 3.4.5)
-    procto (0.0.2)
-    rake (10.3.1)
-    rspec (2.14.0)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    slop (3.5.0)
-    thread_safe (0.3.3)
-    unparser (0.1.12)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      concord (~> 0.1.4)
-      equalizer (~> 0.0.9)
-      parser (~> 2.1)
-      procto (~> 0.0.2)
-    uri_template (0.6.0)
-    virtus (1.0.2)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0.3)
-      equalizer (~> 0.0.9)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  hamster!
-  mutant-rspec
-  rake
-  rspec (~> 2.14)
-  virtus
-  yaks!

data/lib/yaks/hal_serializer.rb

@@ -1,59 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# application/hal+json
-#
-# see examples/hal01.rb
-
-module Yaks
-  class HalSerializer < Serializer
-
-    def serialize
-      Primitivize.(serialize_resource(resource))
-    end
-    alias to_hal serialize
-
-    protected
-
-    def serialize_resource(resource)
-      # The HAL spec doesn't say explicitly how to deal missing values,
-      # looking at client behavior (Hyperagent) it seems safer to return an empty
-      # resource.
-      #
-      # return nil if resource.is_a? NullResource
-      result = resource.attributes
-      result = result.put(:_links, serialize_links(resource.links)) unless resource.links.empty?
-      result = result.put(:_embedded, serialize_embedded(resource.subresources)) unless resource.subresources.empty?
-      result
-    end
-
-    def serialize_links(links)
-      links.reverse.reduce(Yaks::Hash(), &method(:serialize_link))
-    end
-
-    def serialize_link(memo, link)
-      memo.put(link.rel) {|links|
-        slink = {href: link.uri}.merge(link.options.reject{|k,_| k==:templated})
-        slink.merge!(templated: true) if link.templated?
-        singular?(link.rel) ? slink : Yaks::List(links).cons(slink)
-      }
-    end
-
-    def singular?(rel)
-      options.fetch(:singular_links) { [] }.include?(rel)
-    end
-
-    def serialize_embedded(subresources)
-      subresources.map do |rel, resources|
-        [
-          rel,
-          if resources.collection?
-            resources.map( &method(:serialize_resource) )
-          else
-            serialize_resource(resources)
-          end
-        ]
-      end
-    end
-
-  end
-end

data/lib/yaks/json_api_serializer.rb

@@ -1,59 +0,0 @@
-# -*- coding: utf-8 -*-
-
-module Yaks
-  class JsonApiSerializer < Serializer
-    def serialize
-      serialized = Yaks::Hash(
-        pluralize(profile_name.to_s) => resource.map(&method(:serialize_resource))
-      )
-
-      if options[:embed] == :resources
-        linked = resource.reduce(Yaks::Hash()) do |memo, res|
-          serialize_linked_subresources(res.subresources, memo)
-        end
-        serialized = serialized.put('linked', linked)
-      end
-
-      Primitivize.( serialized )
-    end
-    alias to_json_api serialize
-
-    def serialize_resource(resource)
-      result = resource.attributes
-      result = result.merge(Yaks::Hash(:links => serialize_links(resource.subresources))) unless resource.subresources.empty?
-      result
-    end
-
-    def serialize_links(subresources)
-      Yaks::Hash(subresources.map &method(:serialize_link))
-    end
-
-    def serialize_link(name, resource)
-      if options[:embed] == :links
-        [ name, resource.uri ]
-      else
-        [ name, resource.collection? ? resource.map(&curry_symbol(:[], :id)) : resource[:id] ]
-      end
-    end
-
-    def serialize_linked_subresources(subresources, linked)
-      subresources.reduce(linked) do |memo, name, resources|
-        serialize_linked_resources(resources, memo)
-      end
-    end
-
-    def serialize_linked_resources(resources, linked)
-      resources.reduce(linked) do |memo, resource|
-        serialize_subresource(resource, memo)
-      end
-    end
-
-    # {shows => [{id: 3, name: 'foo'}]}
-    def serialize_subresource(resource, linked)
-      key = pluralize(profile_registry.find_by_uri(resource.profile).to_s)
-      set = linked.fetch(key) { Hamster.set }
-      linked = linked.put(key, set << serialize_resource(resource))
-      serialize_linked_subresources(resource.subresources, linked)
-    end
-  end
-end

data/lib/yaks/link_lookup.rb

@@ -1,23 +0,0 @@
-module Yaks
-  module LinkLookup
-
-    def uri
-      self_link = links_by_rel(:self).first
-      self_link.uri if self_link
-    end
-
-    def profile
-      link = links_by_rel(:profile).first
-      link.uri if link
-    end
-
-    def profile_type
-      profile_registry.find_by_uri(profile)
-    end
-
-    def links_by_rel(rel)
-      links.select {|link| link.rel == rel}
-    end
-
-  end
-end

data/lib/yaks/mapper/lookup.rb

@@ -1,19 +0,0 @@
-module Yaks
-  class Mapper
-    module Lookup
-
-      def serializer_for(object_or_key)
-        serializer_class_for(object_or_key).new(object_or_key, options)
-      end
-
-      def serializer_class_for(object_or_key)
-        if object_or_key.respond_to?(:to_str) || object_or_key.is_a?(Symbol)
-          serializer_lookup.(Object.const_get(Util.singular(Util.camelize(obj.to_s))))
-        else
-          serializer_lookup.(object_or_key)
-        end
-      end
-
-    end
-  end
-end

data/lib/yaks/mapper/map_links.rb

@@ -1,17 +0,0 @@
-# -*- coding: utf-8 -*-
-
-module Yaks
-  class Mapper
-    module MapLinks
-
-      def map_links
-        mapped = links.map &send_with_args(:map_to_resource_link, self)
-        unless links.any? {|link| link.rel? :profile }
-          mapped = mapped.cons(Resource::Link.new(:profile, profile_registry.find_by_type(profile_type), {}))
-        end
-        mapped
-      end
-
-    end
-  end
-end

data/lib/yaks/profile_registry.rb

@@ -1,60 +0,0 @@
-# -*- coding: utf-8 -*-
-module Yaks
-  # RFC6906 The "profile" link relation http://tools.ietf.org/search/rfc6906
-  class ProfileRegistry
-    class << self
-      include Util
-
-      def create(&blk)
-        blk ||= ->{}
-        Class.new(self).tap(&σ(:instance_eval, &blk)).new
-      end
-
-      def profile(type, uri)
-        profiles {|reg| reg.put(type, uri)}
-      end
-
-      def profiles
-        @profiles ||= Yaks::Hash()
-        @profiles = yield(@profiles) if block_given?
-        @profiles
-      end
-
-      def inherited(child)
-        child.profiles { @profiles }
-      end
-    end
-
-    def find_by_type(type)
-      self.class.profiles[type]
-    end
-
-    def find_by_uri(by_uri)
-      self.class.profiles.detect {|type, uri| uri == by_uri}.first
-    end
-  end
-
-  class NullProfileRegistry
-    def find_by_type(type)
-      type.to_s
-    end
-
-    def find_by_uri(uri)
-      uri.to_sym
-    end
-  end
-
-  class TemplateProfileRegistry
-    def initialize(template)
-      @template = URITemplate.new(template)
-    end
-
-    def find_by_type(type)
-      @template.expand(type: type)
-    end
-
-    def find_by_uri(uri)
-      @template.extract(uri).fetch(:type) { uri }.to_sym
-    end
-  end
-end

data/lib/yaks/rel_registry.rb

@@ -1,20 +0,0 @@
-module Yaks
-  class RelRegistry
-  end
-
-  class TemplateRelRegistry < RelRegistry
-    def initialize(template)
-      @template = URITemplate.new(template)
-    end
-
-    def lookup(source, destination)
-      @template.expand(:src => source, :dest => destination)
-    end
-  end
-
-  class NullRelRegistry < TemplateRelRegistry
-    def initialize
-      super('rel:src={src}&dest={dest}')
-    end
-  end
-end

data/lib/yaks/shared_options.rb

@@ -1,15 +0,0 @@
-module Yaks
-  module SharedOptions
-    def policy
-      options[:policy]
-    end
-
-    def profile_registry
-      options[:profile_registry]
-    end
-
-    def rel_registry
-      options[:rel_registry]
-    end
-  end
-end

data/spec/support/shorthands.rb

@@ -1,22 +0,0 @@
-shared_context 'shorthands' do
-  let(:resource) {
-    ->(attrs, links = nil) {
-      Yaks::Resource.new(Yaks::Hash(attrs), links, nil)
-    }
-  }
-
-  let(:collection_resource) {
-    ->(*attr_hashes) {
-      Yaks::CollectionResource.new(
-        nil,
-        Yaks::List(attr_hashes.map(&resource.method(:call)))
-      )
-    }
-  }
-
-  let(:resource_link) {
-    ->(rel, uri, options = {}) {
-      Yaks::Resource::Link.new(rel, uri, options)
-    }
-  }
-end