yaks 0.0.0 → 0.1.0

data/spec/yaks/mapper_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Yaks::Mapper do
+  include_context 'shorthands'
+
+  let(:mapper_class) { Class.new(Yaks::Mapper) }
+  let(:model)        { Struct.new(:foo, :bar) }
+  let(:instance)     { model.new('hello', 'world') }
+
+  context 'with attributes' do
+    before do
+      mapper_class.attributes :foo, :bar
+    end
+
+    it 'should make the configured attributes available on the instance' do
+      expect(mapper_class.new(Object.new).attributes).to eq Yaks::List(:foo, :bar)
+    end
+
+    describe 'mapping attributes' do
+      it 'should load them from the model' do
+        expect(mapper_class.new(instance).map_attributes).to eq Yaks::List([:foo, 'hello'], [:bar, 'world'])
+      end
+    end
+  end
+
+  describe 'profile links' do
+    before do
+      mapper_class.profile :show
+    end
+
+    context 'with a dummy registry' do
+      it 'should create a link with the profile name as the uri' do
+        expect(mapper_class.new(instance).map_links).to eq Yaks::List(resource_link[:profile, 'show'])
+      end
+    end
+
+    context 'with a registered profile' do
+      let(:registry) { Yaks::ProfileRegistry.create { profile :show, 'http://my.api/docs/show' } }
+
+      let(:mapper) { mapper_class.new(instance, profile_registry:registry) }
+
+      it 'should look up and use the correct uri' do
+        expect(mapper.map_links).to eq Yaks::List(resource_link[:profile, 'http://my.api/docs/show'])
+      end
+    end
+  end
+end

data/spec/yaks/resource_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Yaks::Resource do
+  include_context 'shorthands'
+
+  let(:object) { described_class.new(attributes, links, subresources) }
+  let(:attributes) { {} }
+  let(:links) { [] }
+  let(:subresources) { {} }
+
+  describe '#uri' do
+    subject { object.uri }
+
+    context 'without a self link' do
+      it { should be_nil }
+    end
+
+    context 'with a self link' do
+      let(:links) { [ resource_link[:self, '/foo/this_is_me/7'] ] }
+      it { should eq '/foo/this_is_me/7' }
+    end
+  end
+end

data/yaks.gemspec

@@ -17,12 +17,15 @@ Gem::Specification.new do |gem|
   gem.test_files       = `git ls-files -- spec`.split($/)
   gem.extra_rdoc_files = %w[README.md]
 
-  gem.add_runtime_dependency 'hamster'    , '~> 0.4.3' # 128k , flog: 1851.8
-  gem.add_runtime_dependency 'inflection' , '~> 1.0.0' #  12k , flog:  226.8
-  gem.add_runtime_dependency 'concord'    , '~> 0.1.4' #   8k , flog:   62.3
+  gem.add_runtime_dependency 'hamster'      , '~> 0.4.3' # 128k , flog: 1851.8
+  gem.add_runtime_dependency 'inflection'   , '~> 1.0.0' #  12k , flog:  226.8
+  gem.add_runtime_dependency 'concord'      , '~> 0.1.4' #   8k , flog:   62.3
+  gem.add_runtime_dependency 'uri_template' , '~> 0.6.0' # 104k , flog: 1521.4
 
   # For comparison, ActiveSupport has a flog score of 11134.7
 
   gem.add_development_dependency 'virtus'
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'rake'
 end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: yaks
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: hamster
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -18,13 +19,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.4.3
   type: :runtime
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.3
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: inflection
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -32,13 +33,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: concord
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -46,38 +47,79 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.4
   type: :runtime
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.4
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  name: uri_template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  prerelease: false
   name: virtus
   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'
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Serialize to JSON-API and similar
@@ -89,28 +131,61 @@ extra_rdoc_files:
 - README.md
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.md
+- examples/hal01.rb
+- examples/jsonapi01.rb
+- examples/jsonapi02.rb
+- examples/jsonapi03.rb
 - lib/yaks.rb
-- lib/yaks/dumper.rb
-- lib/yaks/fold_ams_compat.rb
-- lib/yaks/fold_json_api.rb
+- lib/yaks/collection_mapper.rb
+- lib/yaks/collection_resource.rb
+- lib/yaks/default_policy.rb
+- lib/yaks/hal_serializer.rb
+- lib/yaks/json_api_serializer.rb
+- lib/yaks/link_lookup.rb
+- lib/yaks/mapper.rb
+- lib/yaks/mapper/association.rb
+- lib/yaks/mapper/class_methods.rb
+- lib/yaks/mapper/config.rb
+- 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/serializable_association.rb
-- lib/yaks/serializable_collection.rb
-- lib/yaks/serializable_object.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/serializer/class_methods.rb
+- lib/yaks/shared_options.rb
 - lib/yaks/util.rb
 - lib/yaks/version.rb
-- spec/integration_spec.rb
+- spec/integration/map_to_resource_spec.rb
+- spec/json/hal_plant_collection.json
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
+- spec/support/friends_mapper.rb
 - spec/support/models.rb
+- spec/support/pet_mapper.rb
+- spec/support/pet_peeve_mapper.rb
 - spec/support/serializers.rb
-- spec/yaks/json_api_folder_spec.rb
-- spec/yaks/serializer_spec.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
 - yaks.gemspec
 homepage: https://github.com/plexus/yaks
 licenses:
@@ -122,26 +197,39 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Serialize to JSON-API and similar
 test_files:
-- spec/integration_spec.rb
+- spec/integration/map_to_resource_spec.rb
+- spec/json/hal_plant_collection.json
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
+- spec/support/friends_mapper.rb
 - spec/support/models.rb
+- spec/support/pet_mapper.rb
+- spec/support/pet_peeve_mapper.rb
 - spec/support/serializers.rb
-- spec/yaks/json_api_folder_spec.rb
-- spec/yaks/serializer_spec.rb
-has_rdoc: 
+- 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

data/lib/yaks/dumper.rb

@@ -1,23 +0,0 @@
-module Yaks
-  class Dumper
-    include Util
-
-    def initialize(options = {})
-      @lookup       = options.fetch(:serializer_lookup) { Yaks.default_serializer_lookup }
-      format        = options.fetch(:format) { :json_api }
-      @format       = Yaks.const_get("Fold#{camelize(format.to_s)}") if format.is_a?(Symbol)
-      @options      = options
-    end
-
-    def dump(type, objects)
-      serializer = @lookup.(type).new(@options.merge(root_key: type))
-      Primitivize.(
-        @format.new(
-          serializer.serializable_collection(objects)
-        ).fold
-      )
-    end
-    alias call dump
-
-  end
-end

data/lib/yaks/fold_ams_compat.rb

@@ -1,33 +0,0 @@
-module Yaks
-  class FoldAmsCompat < FoldJsonApi
-    include Concord.new(:collection)
-    include Util
-    extend Forwardable
-
-    def_delegator :collection, :root_key
-
-    def fold
-      Hamster.hash(
-        root_key => collection.map(&method(:fold_object)),
-      ).merge(
-        fold_associated_objects
-      )
-    end
-
-    private
-
-    def fold_object(object)
-      object.attributes.merge(link_ids(object))
-    end
-
-    def fold_association_ids(hash, association)
-      name = singular(association.name.to_s)
-      if association.one?
-        hash.put(name + '_id', association.identities.first)
-      else
-        hash.put(name + '_ids', association.identities)
-      end
-    end
-
-  end
-end

data/lib/yaks/fold_json_api.rb

@@ -1,61 +0,0 @@
-module Yaks
-  class FoldJsonApi
-    include Concord.new(:collection)
-    include Util
-    extend Forwardable
-
-    def_delegator :collection, :root_key
-
-    def fold
-      Hamster.hash(
-        root_key => collection.map(&method(:fold_object)),
-        "linked" => fold_associated_objects
-      )
-    end
-
-    private
-
-    def fold_object(object)
-      if object.has_associated_objects?
-        object.attributes.merge(Hamster.hash(links: link_ids(object)))
-      else
-        object.attributes
-      end
-    end
-
-    def link_ids(object)
-      object.associations.reduce(
-        Hamster.hash,
-        &method(:fold_association_ids)
-      )
-    end
-
-    def fold_association_ids(hash, association)
-      if association.one?
-        hash.put(association.name, association.identities.first)
-      else
-        hash.put(association.name, association.identities)
-      end
-    end
-
-    def fold_associated_objects
-      association_names = Hamster.set(*
-        collection.flat_map do |object|
-          object.associations.map{|ass| [ass.name, ass.one?] }
-        end
-      )
-      Hamster.hash(
-        association_names.map do |name, one|
-          [
-            one ? pluralize(name.to_s) : name,
-            Hamster.set(*
-              collection.flat_map do |object|
-                object.associated_objects(name)
-              end
-            ).map(&method(:fold_object))
-          ]
-        end
-      )
-    end
-  end
-end