yaks 0.4.2 → 0.4.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaks
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflection
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: bogus
+  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
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +140,16 @@ dependencies:
   name: mutant
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.12
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.12
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -182,18 +196,24 @@ files:
 - README.md
 - Rakefile
 - bench/bench.rb
-- examples/hal01.rb
-- examples/jsonapi01.rb
-- examples/jsonapi02.rb
-- examples/jsonapi03.rb
 - lib/yaks.rb
+- lib/yaks/breaking_changes.rb
 - lib/yaks/collection_mapper.rb
 - lib/yaks/collection_resource.rb
 - lib/yaks/config.rb
+- lib/yaks/config/dsl.rb
 - lib/yaks/default_policy.rb
+- lib/yaks/format.rb
+- lib/yaks/format/collection_json.rb
+- lib/yaks/format/hal.rb
+- lib/yaks/format/json_api.rb
 - lib/yaks/fp.rb
+- lib/yaks/fp/hash_updatable.rb
+- lib/yaks/fp/updatable.rb
 - lib/yaks/mapper.rb
 - lib/yaks/mapper/association.rb
+- lib/yaks/mapper/association_mapper.rb
+- lib/yaks/mapper/attribute.rb
 - lib/yaks/mapper/class_methods.rb
 - lib/yaks/mapper/config.rb
 - lib/yaks/mapper/has_many.rb
@@ -203,38 +223,46 @@ files:
 - lib/yaks/primitivize.rb
 - lib/yaks/resource.rb
 - lib/yaks/resource/link.rb
-- lib/yaks/serializer.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/json_shared_examples.rb
 - spec/acceptance/models.rb
 - spec/fixture_helpers.rb
 - spec/integration/map_to_resource_spec.rb
+- spec/json/confucius.collection.json
 - 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/classes_for_policy_testing.rb
 - spec/support/deep_eql.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/support/shared_contexts.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/dsl_spec.rb
 - spec/unit/yaks/config_spec.rb
+- spec/unit/yaks/default_policy/derive_mapper_from_object_spec.rb
+- spec/unit/yaks/default_policy_spec.rb
+- spec/unit/yaks/format/hal_spec.rb
+- spec/unit/yaks/format/json_api_spec.rb
+- spec/unit/yaks/format_spec.rb
+- spec/unit/yaks/fp/hash_updatable_spec.rb
+- spec/unit/yaks/fp/updatable_spec.rb
 - spec/unit/yaks/fp_spec.rb
+- spec/unit/yaks/mapper/association_mapper_spec.rb
 - spec/unit/yaks/mapper/association_spec.rb
+- spec/unit/yaks/mapper/attribute_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
@@ -245,8 +273,6 @@ files:
 - spec/unit/yaks/primitivize_spec.rb
 - spec/unit/yaks/resource/link_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
@@ -255,7 +281,22 @@ homepage: https://github.com/plexus/yaks
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |2+
+
+
+  Breaking Changes in Yaks 0.4.3
+  ==============================
+
+  Yaks::Mapper#filter was removed, if you override this method in your
+  mappers to conditionally filter attributes or associations, you will
+  have to override #attributes or #associations instead.
+
+  When specifying a rel_template, now a single {rel} placeholder is
+  expected instead of {src} and {dest}.
+
+  There are other internal changes. See the CHANGELOG and README for full
+  documentation.
+
 rdoc_options: []
 require_paths:
 - lib
@@ -277,29 +318,41 @@ specification_version: 4
 summary: Serialize to hypermedia. HAL, JSON-API, etc.
 test_files:
 - spec/acceptance/acceptance_spec.rb
+- spec/acceptance/json_shared_examples.rb
 - spec/acceptance/models.rb
 - spec/fixture_helpers.rb
 - spec/integration/map_to_resource_spec.rb
+- spec/json/confucius.collection.json
 - 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/classes_for_policy_testing.rb
 - spec/support/deep_eql.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/support/shared_contexts.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/dsl_spec.rb
 - spec/unit/yaks/config_spec.rb
+- spec/unit/yaks/default_policy/derive_mapper_from_object_spec.rb
+- spec/unit/yaks/default_policy_spec.rb
+- spec/unit/yaks/format/hal_spec.rb
+- spec/unit/yaks/format/json_api_spec.rb
+- spec/unit/yaks/format_spec.rb
+- spec/unit/yaks/fp/hash_updatable_spec.rb
+- spec/unit/yaks/fp/updatable_spec.rb
 - spec/unit/yaks/fp_spec.rb
+- spec/unit/yaks/mapper/association_mapper_spec.rb
 - spec/unit/yaks/mapper/association_spec.rb
+- spec/unit/yaks/mapper/attribute_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
@@ -310,8 +363,6 @@ test_files:
 - spec/unit/yaks/primitivize_spec.rb
 - spec/unit/yaks/resource/link_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/examples/hal01.rb

@@ -1,126 +0,0 @@
-# http://stateless.co/hal_specification.html
-
-# There are still some affordances missing to support all of HAL, in particular
-# for this example to ability to generate links based on composite content
-# (ea:admin) is not implemented, neither is explicit support for CURIEs (compact
-# URI shorthand syntax), although this examples works around that by manually
-# encoding the CURIE prefixes.
-
-# The 'next' link from the example below is also ommitted, pagination is an aspect
-# that will be implemented generically
-
-# Example from the specification, approximated with Yaks below
-
-# {
-#     "_links": {
-#         "self": { "href": "/orders" },
-#         "curies": [{ "name": "ea", "href": "http://example.com/docs/rels/{rel}", "templated": true }],
-#         "next": { "href": "/orders?page=2" },
-#         "ea:find": { "href": "/orders{?id}", "templated": true },
-#         "ea:admin": [{
-#             "href": "/admins/2",
-#             "title": "Fred"
-#         }, {
-#             "href": "/admins/5",
-#             "title": "Kate"
-#         }]
-#     },
-#     "currentlyProcessing": 14,
-#     "shippedToday": 20,
-#     "_embedded": {
-#         "ea:order": [{
-#             "_links": {
-#                 "self": { "href": "/orders/123" },
-#                 "ea:basket": { "href": "/baskets/98712" },
-#                 "ea:customer": { "href": "/customers/7809" }
-#             },
-#             "total": 30.00,
-#             "currency": "USD",
-#             "status": "shipped"
-#         }, {
-#             "_links": {
-#                 "self": { "href": "/orders/124" },
-#                 "ea:basket": { "href": "/baskets/97213" },
-#                 "ea:customer": { "href": "/customers/12369" }
-#             },
-#             "total": 20.00,
-#             "currency": "USD",
-#             "status": "processing"
-#         }]
-#     }
-# }
-
-require 'virtus'
-require 'yaks'
-require 'json'
-
-class Order
-  include Virtus.model
-  attribute :id, Integer
-  attribute :basket_id, Integer
-  attribute :customer_id, Integer
-  attribute :total, Numeric
-  attribute :currency, String
-  attribute :status, String
-end
-
-class OrderSet
-  include Virtus.model
-  attribute :currently_processing, Integer
-  attribute :shipped_today, Integer
-  attribute :orders, Array[Order]
-end
-
-class OrderMapper < Yaks::Mapper
-  link :self, '/orders/{id}'
-  link :"ea:basket", '/baskets/{basket_id}'
-  link :"ea:customer", '/customers/{customer_id}'
-
-  attributes :total, :currency, :status
-end
-
-class OrderSetMapper < Yaks::Mapper
-  link :self, '/orders'
-  link :curies, 'http://example.com/docs/rels/{rel}', name: "ea", expand: false
-  link :"ea:find", "/orders{?id}", expand: false
-
-  attributes :currentlyProcessing, :shippedToday
-
-  has_many :orders, as: :"ea:order", mapper: OrderMapper
-
-  # Having the attributes be encoded in CamelCase is such a common
-  # use case we might have to make this a setting
-
-  def load_attribute(name)
-    super(Yaks::Util.underscore(name.to_s))
-  end
-end
-
-order_set = OrderSet.new(
-  currently_processing: 14,
-  shipped_today: 20,
-  orders: [
-    Order.new(
-      id: 123,
-      basket_id: 98712,
-      customer_id: 7809,
-      total: 30.00,
-      currency: "USD",
-      status: "shipped"
-    ),
-    Order.new(
-      id: 124,
-      basket_id: 97213,
-      customer_id: 12369,
-      total: 20.00,
-      currency: "USD",
-      status: "processing"
-    )
-  ]
-)
-
-resource = OrderSetMapper.new(order_set).to_resource
-
-hal = Yaks::HalSerializer.new(resource, singular_links: [:self, :"ea:find", :"ea:basket", :"ea:customer"]).to_hal
-
-puts JSON.dump(hal)

data/examples/jsonapi01.rb

@@ -1,68 +0,0 @@
-# -*- coding: utf-8 -*-
-
-require 'virtus'
-require 'yaks'
-require 'json'
-
-Example = JSON.parse %q<
-    {
-      "posts": [{
-        "id": "1",
-        "title": "Rails is Omakase",
-        "links": {
-          "author": "9",
-          "comments": [ "5", "12", "17", "20" ]
-        }
-      }]
-    }
->
-
-class Author
-  include Virtus.model
-  attribute :id, String
-end
-
-class Comment
-  include Virtus.model
-  attribute :id, String
-end
-
-class Post
-  include Virtus.model
-  attribute :id, String
-  attribute :title, String
-  attribute :author, Author
-  attribute :comments, Array[Comment]
-end
-
-class AuthorMapper < Yaks::Mapper
-  attributes :id
-end
-
-class CommentMapper < Yaks::Mapper
-  attributes :id
-end
-
-class PostMapper < Yaks::Mapper
-  attributes :id, :title, :links
-
-  has_one :author, mapper: AuthorMapper
-  has_many :comments, mapper: CommentMapper
-end
-
-post = Post.new(
-  id: 1,
-  title: "Rails is Omakase",
-  author: Author.new(id: "9"),
-  comments: [5, 12, 17, 20].map {|id| Comment.new(id: id.to_s)}
-)
-
-resource = PostMapper.new(post).to_resource
-json_api = Yaks::JsonApiSerializer.new(resource).to_json_api
-
-gem 'minitest'
-require 'minitest/autorun'
-
-describe('json-api') {
-  specify { assert_equal Example, json_api }
-}

data/examples/jsonapi02.rb

@@ -1,62 +0,0 @@
-require 'virtus'
-require 'yaks'
-require 'json'
-
-Example = JSON.parse %q<
-    {
-      "posts": [{
-        "id": "1",
-        "title": "Rails is Omakase",
-        "links": {
-          "author": "9"
-        }
-      }],
-      "linked": {
-        "people": [{
-          "id": "9",
-          "name": "@d2h"
-        }]
-      }
-    }
->
-
-
-class Person
-  include Virtus.model
-  attribute :id, String
-  attribute :name, String
-end
-
-class Post
-  include Virtus.model
-  attribute :id, String
-  attribute :title, String
-  attribute :author, Person
-end
-
-class PersonMapper < Yaks::Mapper
-  attributes :id, :name
-end
-
-class PostMapper < Yaks::Mapper
-  attributes :id, :title, :links
-
-  has_one :author, mapper: PersonMapper
-end
-
-post = Post.new(
-  id: 1,
-  title: "Rails is Omakase",
-  author: Person.new(id: "9", name: "@d2h"),
-)
-
-resource = PostMapper.new(post).to_resource
-
-json_api = Yaks::JsonApiSerializer.new(resource, embed: :resources).to_json_api
-
-gem 'minitest'
-require 'minitest/autorun'
-
-describe('json-api') {
-  specify { assert_equal Example, json_api }
-}

data/examples/jsonapi03.rb

@@ -1,86 +0,0 @@
-require 'virtus'
-require 'yaks'
-require 'json'
-
-Example = JSON.parse %q<
-    {
-      "posts": [{
-        "id": "1",
-        "title": "Rails is Omakase",
-        "links": {
-          "author": "http://example.com/people/1",
-          "comments": "http://example.com/comments/5,12,17,20"
-        }
-      }]
-    }
->
-
-
-class Person
-  include Virtus.model
-  attribute :id, String
-  attribute :name, String
-end
-
-
-class Comment
-  include Virtus.model
-  attribute :id, String
-end
-
-class Post
-  include Virtus.model
-  attribute :id, String
-  attribute :title, String
-  attribute :author, Person
-  attribute :comments, Array[Comment]
-end
-
-class BaseMapper < Yaks::Mapper
-  link :self, 'http://example.com/{plural_profile_type}/{id}'
-
-  def plural_profile_type
-    pluralize(profile_type.to_s)
-  end
-end
-
-class CollectionMapper < Yaks::CollectionMapper
-  link :self, 'http://example.com/{plural_profile_type}/{id*}'
-
-  def plural_profile_type
-    pluralize(profile_type.to_s)
-  end
-end
-
-class CommentMapper < BaseMapper
-  attributes :id
-end
-
-class PersonMapper < BaseMapper
-  attributes :id, :name
-end
-
-class PostMapper < BaseMapper
-  attributes :id, :title
-
-  has_one :author, mapper: PersonMapper
-  has_many :comments, mapper: CommentMapper, collection_mapper: CollectionMapper
-end
-
-post = Post.new(
-  id: 1,
-  title: "Rails is Omakase",
-  author: Person.new(id: "1", name: "@d2h"),
-  comments: [5, 12, 17, 20].map {|id| Comment.new(id: id.to_s)}
-)
-
-resource = PostMapper.new(post).to_resource
-
-json_api = Yaks::JsonApiSerializer.new(resource, embed: :links).to_json_api
-
-gem 'minitest'
-require 'minitest/autorun'
-
-describe('json-api') {
-  specify { assert_equal Example, json_api }
-}

data/spec/support/serializers.rb

@@ -1,14 +0,0 @@
-# class FriendSerializer < Yaks::Mapper
-#   attributes :id, :name
-
-#   has_many :pets
-#   has_one :pet_peeve
-# end
-
-# class PetSerializer < Yaks::Mapper
-#   attributes :id, :name, :species
-# end
-
-# class PetPeeveSerializer < Yaks::Mapper
-#   attributes :id, :type
-# end

data/spec/unit/yaks/serializer_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-
-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 }
-  end
-
-  describe '.by_mime_type' do
-    specify { expect(Yaks::Serializer.by_mime_type('application/hal+json')).to eql Yaks::Serializer::Hal }
-  end
-end