yaks 0.3.1 → 0.4.0.rc1

data/lib/yaks/serializer/hal.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+
+module Yaks
+  class Serializer
+    class Hal < self
+      Serializer.register self, :hal, 'application/hal+json'
+
+      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.merge(:_links => serialize_links(resource.links)) unless resource.links.empty?
+        result = result.merge(:_embedded => serialize_embedded(resource.subresources)) unless resource.subresources.empty?
+        result
+      end
+
+      def serialize_links(links)
+        links.reduce({}, &method(:serialize_link))
+      end
+
+      def serialize_link(memo, link)
+        hal_link = {href: link.uri}
+        hal_link.merge!(link.options.reject{|k,_| k==:templated})
+        hal_link.merge!(templated: true) if link.templated?
+
+        memo[link.rel] = if singular?(link.rel)
+                           hal_link
+                         else
+                           Array(memo[link.rel]) + [hal_link]
+                         end
+        memo
+      end
+
+      def singular?(rel)
+        !options.fetch(:plural_links) { [] }.include?(rel)
+      end
+
+      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)
+                      end
+        end
+      end
+
+    end
+  end
+end

data/lib/yaks/serializer/json_api.rb

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+
+module Yaks
+  class Serializer
+    class JsonApi < self
+      Serializer.register self, :json_api, 'application/vnd.api+json'
+
+      include FP
+
+      def call
+        serialized = {
+          pluralize(resource.type) => resource.map(&method(:serialize_resource))
+        }
+
+        linked = resource.each_with_object({}) do |res, hsh|
+          serialize_linked_subresources(res.subresources, hsh)
+        end
+        serialized = serialized.merge('linked' => linked)
+
+        serialized
+      end
+      alias serialize call
+
+      def serialize_resource(resource)
+        result = resource.attributes
+        result = result.merge(:links => serialize_links(resource.subresources)) unless resource.subresources.empty?
+        result
+      end
+
+      def serialize_links(subresources)
+        subresources.each_with_object({}) do |(name, resource), hsh|
+          hsh[pluralize(resource.type)] = serialize_link(resource)
+        end
+      end
+
+      def serialize_link(resource)
+        resource.collection? ? resource.map(&send_with_args(:[], :id)) : resource[:id]
+      end
+
+      def serialize_linked_subresources(subresources, hsh)
+        subresources.each_with_object(hsh) do |(name, resources), hsh|
+          serialize_linked_resources(resources, hsh)
+        end
+      end
+
+      def serialize_linked_resources(resources, linked)
+        resources.each_with_object(linked) do |resource, memo|
+          serialize_subresource(resource, memo)
+        end
+      end
+
+      # {shows => [{id: 3, name: 'foo'}]}
+      def serialize_subresource(resource, linked)
+        key = pluralize(resource.type)
+        set = linked.fetch(key) { Set.new }
+        linked = linked[key] = (set << serialize_resource(resource))
+        serialize_linked_subresources(resource.subresources, linked)
+      end
+    end
+  end
+end

data/lib/yaks/serializer.rb

@@ -1,7 +1,7 @@
 module Yaks
   class Serializer
     extend Forwardable
-    include Util, SharedOptions
+    include Util
 
     attr_reader :resource, :options
     def_delegators :resource, :links, :attributes, :subresources
@@ -13,10 +13,31 @@ module Yaks
       @options  = YAKS_DEFAULT_OPTIONS.merge(options)
     end
 
-    def profile_name
-      (profile = resource.profile) &&
-        profile_registry.find_by_uri(profile)
+    def call
+      serialize_resource(resource)
     end
+    alias serialize call
 
+    class << self
+      def register(klass, name, mime_type)
+        @serializers ||= {}
+        @serializers[name] = klass
+
+        @mime_types  ||= {}
+        @mime_types[mime_type] = klass
+      end
+
+      def by_name(name)
+        @serializers.fetch(name)
+      end
+
+      def by_mime_type(mime_type)
+        @mime_types.fetch(mime_type)
+      end
+
+      def mime_types
+        @mime_types.keys
+      end
+    end
   end
 end

data/lib/yaks/util.rb

@@ -18,18 +18,6 @@ module Yaks
         .gsub!(/(?:^|_)(.)/) { $1.upcase          }
     end
 
-    def List(*args)
-      Hamster.list(*args)
-    end
-
-    def Hash(*args)
-      Hamster.hash(*args)
-    end
-
-    def Set(*args)
-      Hamster.set(*args)
-    end
-
     # Turn what is maybe a Proc into its result (or itself)
     #
     # When input can be either a value or a proc that returns a value,
@@ -44,9 +32,9 @@ module Yaks
     # @param [Object] context
     #   (optional) A context used to instance_eval the proc
     def Resolve(maybe_proc, context = nil)
-      if maybe_proc.respond_to?(:to_proc)
+      if maybe_proc.is_a? Proc or maybe_proc.is_a? Method
         if context
-          if maybe_proc.to_proc.arity > 0
+          if maybe_proc.arity > 0
             context.instance_eval(&maybe_proc)
           else
             # In case it's a lambda with zero arity instance_eval fails
@@ -60,33 +48,5 @@ module Yaks
       end
     end
 
-    def curry_method(name)
-      method(name).to_proc.curry
-    end
-    alias μ curry_method
-
-    def identity_function
-      ->(x) {x}
-    end
-    alias ι identity_function
-
-    def juxt(*procs)
-      ->(*args) { procs.map &σ(:call, *args) }
-    end
-
-    def curry_symbol(symbol, *args, &blk)
-      ->(obj) { obj.method(symbol).to_proc.curry.(*args, &blk) }
-    end
-    alias σ curry_symbol
-    alias send_with_args curry_symbol
-
-    def extract_options(args)
-      if args.last.is_a? Hash
-        [args.take(args.count-1), args.last]
-      else
-        [args, {}]
-      end
-    end
-
   end
 end

data/lib/yaks/version.rb

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

data/lib/yaks.rb

@@ -1,54 +1,31 @@
 # -*- coding: utf-8 -*-
 
 require 'forwardable'
+require 'set'
 
-require 'hamster'
 require 'concord'
 require 'inflection'
 require 'uri_template'
+require 'rack/accept'
 
 require 'yaks/util'
-require 'yaks/link_lookup'
-require 'yaks/shared_options'
+require 'yaks/fp'
 require 'yaks/primitivize'
 
-require 'yaks/profile_registry'
-require 'yaks/rel_registry'
 require 'yaks/default_policy'
 
 module Yaks
   Undefined = Object.new
 
   YAKS_DEFAULT_OPTIONS = {
-    policy: DefaultPolicy.new,
-    profile_registry: NullProfileRegistry.new,
-    rel_registry: NullRelRegistry.new,
     singular_links: [:self, :profile]
   }
 
-  module ClassMethods
-    def Hash(object = nil)
-      return object             if object.is_a? Hamster::Hash
-      return Hamster::EmptyHash if object.nil?
-      Hamster.hash(object)
-    end
-
-    def List(*entries)
-      case entries.size
-      when 0
-        Hamster::EmptyList
-      when 1
-        if entries.first.respond_to? :to_list
-          entries.first.to_list
-        else
-          Hamster.list(*entries.compact)
-        end
-      else
-        Hamster.list(*entries)
-      end
+  class << self
+    def new(&blk)
+      Yaks::Config.new(&blk)
     end
   end
-  extend ClassMethods
 
 end
 
@@ -64,10 +41,11 @@ require 'yaks/mapper/has_one'
 require 'yaks/mapper/has_many'
 require 'yaks/mapper/config'
 require 'yaks/mapper/class_methods'
-require 'yaks/mapper/map_links'
 require 'yaks/mapper'
 require 'yaks/collection_mapper'
 
 require 'yaks/serializer'
-require 'yaks/hal_serializer'
-require 'yaks/json_api_serializer'
+require 'yaks/serializer/hal'
+require 'yaks/serializer/json_api'
+require 'yaks/serializer/collection_json'
+require 'yaks/config'

data/notes.org

@@ -0,0 +1,72 @@
+0.4
+
+* DONE Get rid of profile/rel registry, use policy instead
+* DONE pass around policy explicitly instead of through options
+* DONE introduce name/type separate from profile
+** DONE mapper
+** DONE Resource
+* DONE allow setting rel types directly on associations, with fallback to policy
+* DONE switch to hash-based init of Resource to make it more extensible
+* DONE add Resource#type
+* DONE not 100% happy yet about nameing of mapper#mapper_name / config#name. Maybe use `type` across the board?
+* DONE Fix JsonAPISerializer
+* top-level automatic links, e.g. for self and profile
+* make HAL plural/singular links configurable from the Yaks.new
+* make primitivize configuration instance based, not global
+* Have JsonApi add self links as href: attributes
+* Move examples to acceptance tests
+* Select mapper based on content type
+* move to 100% mutcov
+
+pre 0.5
+
+* CURIES/namespaces
+
+Ticketsolve::Api::Yaks = ::Yaks.new do
+  policy do
+    def derive...
+  end
+
+  hal_options.plural_link '...'
+
+  primitivize Date, Time do |o|
+    o.iso8601
+  end
+
+  rel_template "http://literature.example.com/rel/#{association_name}"
+
+  link :self, "http://api.com/{key}/{id}"
+  link :profile, "http://api.com/profile/{key}"
+
+  # and/or
+  derive_rel_from_association do |mapper, association|
+    "http://literature.example.com/rel/#{association.name}"
+  end
+end
+
+
+
+* DONE 59 lib/yaks/mapper.rb
+* DONE 92 lib/yaks/mapper/link.rb
+* DONE 37 lib/yaks/mapper/association.rb
+* DONE 3 lib/yaks/version.rb
+* DONE 13 lib/yaks/mapper/has_many.rb
+* DONE 9 lib/yaks/mapper/has_one.rb
+* DONE 79 lib/yaks/config.rb
+*   79 lib/yaks/mapper/config.rb
+*   73 lib/yaks.rb
+* DONE 72 lib/yaks/util.rb
+* DONE 65 lib/yaks/collection_resource.rb
+*   59 lib/yaks/json_api_serializer.rb
+*   59 lib/yaks/hal_serializer.rb
+*   43 lib/yaks/primitivize.rb
+*   37 lib/yaks/mapper/class_methods.rb
+* DONE 33 lib/yaks/collection_mapper.rb
+*   28 lib/yaks/null_resource.rb
+* DONE 27 lib/yaks/resource.rb
+*   25 lib/yaks/resource/link.rb
+* DONE 23 lib/yaks/fp.rb
+*   22 lib/yaks/serializer.rb
+*   15 lib/yaks/shared_options.rb
+*   15 lib/yaks/default_policy.rb
+*   10 lib/yaks/mapper/map_links.rb

data/spec/acceptance/acceptance_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'yaml'
+require 'json'
+
+require_relative './models'
+
+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 eql output }
+end
+
+RSpec.describe Yaks::Serializer::Hal do
+  yaks_rel_template = Yaks.new do
+    rel_template "http://literature.example.com/rel/{association_name}"
+  end
+
+  yaks_policy_dsl = Yaks.new do
+    derive_rel_from_association do |mapper, association|
+      "http://literature.example.com/rel/#{association.name}"
+    end
+  end
+
+  include_examples 'JSON output format' , yaks_rel_template    , :hal      , 'confucius'
+  include_examples 'JSON output format' , yaks_policy_dsl      , :hal      , 'confucius'
+end
+
+RSpec.describe Yaks::Serializer::JsonApi do
+  config = Yaks.new do
+    default_format :json_api
+  end
+
+  include_examples 'JSON output format' , config , :json_api , 'confucius'
+end
+
+RSpec.describe Yaks::Serializer::CollectionJson do
+  config = Yaks.new do
+    default_format :collection_json
+    mapper_namespace Youtypeitwepostit
+  end
+
+  include_examples 'JSON output format' , config , :collection , 'youtypeitwepostit'
+end

data/spec/acceptance/models.rb

@@ -0,0 +1,28 @@
+require 'anima'
+
+class Scholar
+  include Anima.new(:id, :name, :pinyin, :latinized, :works)
+end
+
+class Work
+  include Anima.new(:id, :chinese_name, :english_name)
+end
+
+class LiteratureBaseMapper < Yaks::Mapper
+  link :profile, 'http://literature.example.com/profiles/{mapper_name}'
+  link :self, 'http://literature.example.com/{mapper_name}/{id}'
+end
+
+class ScholarMapper < LiteratureBaseMapper
+  attributes :id, :name, :pinyin, :latinized
+  has_many :works
+  link :self, "http://literature.example.com/authors/{downcased_pinyin}"
+
+  def downcased_pinyin
+    object.pinyin.downcase
+  end
+end
+
+class WorkMapper < LiteratureBaseMapper
+  attributes :id, :chinese_name, :english_name
+end

data/spec/integration/map_to_resource_spec.rb

@@ -1,28 +1,24 @@
 require 'spec_helper'
 
-describe 'Mapping domain models to Resource objects' do
+RSpec.describe 'Mapping domain models to Resource objects' do
   include_context 'fixtures'
-  include_context 'shorthands'
 
   subject { mapper.to_resource }
-  let(:mapper) { FriendMapper.new(john) }
-
+  let(:mapper) { FriendMapper.new(john, policy: Yaks::DefaultPolicy.new, env: {}) }
 
   it { should be_a Yaks::Resource }
-  its(:attributes)   { should eq Yaks::Hash(id: 1, name: 'john') }
-  its(:links)        { should eq Yaks::List(
-      resource_link[:profile, 'friend'],
-      resource_link[:copyright, '/api/copyright/2024']
-  )}
+  its(:type)         { should eql 'friend' }
+  its(:attributes)   { should eql(id: 1, name: 'john') }
+  its(:links)        { should eql [ Yaks::Resource::Link.new(:copyright, '/api/copyright/2024', {}) ] }
 
   its(:subresources) {
-    should eq Yaks::Hash(
-      "rel:src=friend&dest=pet_peeve" => resource[{id: 4, type: 'parsing with regexps'}, [resource_link[:profile, 'pet_peeve']]],
+    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(
-        [resource_link[:profile, 'pet']],
-        [
-          resource[{:id => 2, :species => "dog", :name => "boingboing"}, [resource_link[:profile, 'pet']]],
-          resource[{:id => 3, :species => "cat", :name => "wassup"}, [resource_link[:profile, 'pet']]]
+        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"})
         ]
       )
     )

data/spec/json/confucius.hal.json

@@ -0,0 +1,23 @@
+{
+  "id": 9,
+  "name": "孔子",
+  "pinyin": "Kongzi",
+  "latinized": "Confucius",
+  "_links": {
+    "self":    { "href": "http://literature.example.com/authors/kongzi"  },
+    "profile": { "href": "http://literature.example.com/profiles/scholar" }
+  },
+  "_embedded": {
+    "http://literature.example.com/rel/works": [
+      {
+        "id": 11,
+        "chinese_name": "論語",
+        "english_name": "Analects",
+        "_links": {
+          "self":    { "href": "http://literature.example.com/work/11" },
+          "profile": { "href": "http://literature.example.com/profiles/work" }
+        }
+      }
+    ]
+  }
+}

data/spec/json/confucius.json_api.json

@@ -0,0 +1,22 @@
+{
+  "scholars": [
+    {
+      "id": 9,
+      "name": "孔子",
+      "pinyin": "Kongzi",
+      "latinized": "Confucius",
+      "links": {
+        "works": [11]
+      }
+    }
+  ],
+  "linked": {
+    "works": [
+      {
+        "id": 11,
+        "chinese_name": "論語",
+        "english_name": "Analects"
+      }
+    ]
+  }
+}

data/spec/json/john.hal.json

@@ -0,0 +1,29 @@
+{
+  "id": 1,
+  "name": "john",
+  "_links": {
+    "copyright": [
+      {
+        "href": "/api/copyright/2024"
+      }
+    ]
+  },
+  "_embedded": {
+    "http://api.mysuperfriends.com/pet_peeve": {
+      "id": 4,
+      "type": "parsing with regexps"
+    },
+    "http://api.mysuperfriends.com/pets": [
+      {
+        "id": 2,
+        "name": "boingboing",
+        "species": "dog"
+      },
+      {
+        "id": 3,
+        "name": "wassup",
+        "species": "cat"
+      }
+    ]
+  }
+}

data/spec/json/youtypeitwepostit.collection.json

@@ -0,0 +1,45 @@
+{
+    "collection" :
+    {
+        "version" : "1.0",
+        "href" : "http://www.youtypeitwepostit.com/api/",
+
+        "items" :
+        [
+            {
+                "href": "http://www.youtypeitwepostit.com/api/12091295723803341",
+                "data": [
+                    {
+                        "name": "text",
+                        "value": "massage"
+                    },
+                    {
+                        "name": "date_posted",
+                        "value": "2014-05-29T07:56:58.035Z"
+                    }
+                ],
+                "links" :
+                [
+                    { "rel": "profile", "href" : "http://www.youtypeitwepostit.com/profiles/message" }
+                ]
+            },
+            {
+                "href": "http://www.youtypeitwepostit.com/api/613856331910938",
+                "data": [
+                    {
+                        "name": "text",
+                        "value": "Squid!"
+                    },
+                    {
+                        "name": "date_posted",
+                        "value": "2013-03-28T21:51:08.406Z"
+                    }
+                ],
+                "links" :
+                [
+                    { "rel": "profile", "href" : "http://www.youtypeitwepostit.com/profiles/message" }
+                ]
+            }
+        ]
+    }
+}

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'rspec/its'
 
 ROOT = Pathname(__FILE__).join('../..')
 
@@ -13,9 +14,19 @@ require_relative 'support/pet_mapper'
 require_relative 'support/pet_peeve_mapper'
 require_relative 'support/friends_mapper'
 require_relative 'support/fixtures'
-require_relative 'support/shorthands'
 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.backtrace_exclusion_patterns = [] if ENV['FULLSTACK']
+  #rspec.disable_monkey_patching!
+  rspec.raise_errors_for_deprecations!
+end

data/spec/support/shared_contexts.rb

@@ -1,5 +1,5 @@
 shared_context 'collection resource' do
-  let(:resource) { Yaks::CollectionResource.new(links, members) }
+  let(:resource) { Yaks::CollectionResource.new(links: links, members: members) }
   let(:links)    { [] }
   let(:members)  { [] }
 end
@@ -23,25 +23,22 @@ shared_context 'plant collection resource' do
 
   let(:plain_grass) do
     Yaks::Resource.new(
-      {name: "Plain grass", type: "grass"},
-      [plain_grass_self_link, plant_profile_link],
-      {}
+      attributes: {name: "Plain grass", type: "grass"},
+      links: [plain_grass_self_link, plant_profile_link]
     )
   end
 
   let(:oak) do
     Yaks::Resource.new(
-      {name: "Oak", type: "tree"},
-      [oak_self_link, plant_profile_link],
-      {}
+      attributes: {name: "Oak", type: "tree"},
+      links: [oak_self_link, plant_profile_link],
     )
   end
 
   let(:passiflora) do
     Yaks::Resource.new(
-      {name: "Passiflora", type: "flower"},
-      [passiflora_self_link, plant_profile_link],
-      {}
+      attributes: {name: "Passiflora", type: "flower"},
+      links: [passiflora_self_link, plant_profile_link],
     )
   end
 end