yaks 0.9.0 → 0.10.0

data/spec/integration/map_to_resource_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe 'Mapping domain models to Resource objects' do
   specify {
     subject.subresources == [
       Yaks::Resource.new(
-        type:'pet_peeve',
+        type: 'pet_peeve',
         rels: ['rel:pet_peeve'],
         attributes: {id: 4, type: 'parsing with regexps'}
       ),
@@ -23,11 +23,11 @@ RSpec.describe 'Mapping domain models to Resource objects' do
         members: [
           Yaks::Resource.new(
             type: 'pet',
-            attributes: {:id => 2, :species => 'dog', :name => 'boingboing'}
+            attributes: {id: 2, species: 'dog', name: 'boingboing'}
           ),
           Yaks::Resource.new(
             type: 'pet',
-            attributes: {:id => 3, :species => 'cat', :name => 'wassup'}
+            attributes: {id: 3, species: 'cat', name: 'wassup'}
           )
         ]
       )
@@ -38,7 +38,7 @@ RSpec.describe 'Mapping domain models to Resource objects' do
     should eq(
       [
         Yaks::Resource.new(
-          type:'pet_peeve',
+          type: 'pet_peeve',
           rels: ['rel:pet_peeve'],
           attributes: {id: 4, type: 'parsing with regexps'}
         ),
@@ -48,11 +48,11 @@ RSpec.describe 'Mapping domain models to Resource objects' do
           members: [
             Yaks::Resource.new(
               type: 'pet',
-              attributes: {:id => 2, :species => 'dog', :name => 'boingboing'}
+              attributes: {id: 2, species: 'dog', name: 'boingboing'}
             ),
             Yaks::Resource.new(
               type: 'pet',
-              attributes: {:id => 3, :species => 'cat', :name => 'wassup'}
+              attributes: {id: 3, species: 'cat', name: 'wassup'}
             )
           ]
         )

data/spec/json/confucius.json_api.json

@@ -1,50 +1,66 @@
 {
-  "data": [
-    {
-      "id": 9,
-      "type": "scholars",
-      "href": "http://literature.example.com/authors/kongzi",
+  "data": {
+    "id": "9",
+    "type": "scholars",
+    "attributes": {
       "name": "孔子",
       "pinyin": "Kongzi",
-      "latinized": "Confucius",
-      "links": {
-        "works": {"type": "works", "ids": [11,12]}
-      }
+      "latinized": "Confucius"
+    },
+    "links": {
+      "profile": "http://literature.example.com/profiles/scholar",
+      "self": "http://literature.example.com/authors/kongzi",
+      "http://literature.example.com/rels/quotes": "http://literature.example.com/quotes/?author=kongzi&q={query}",
+      "works": {"linkage": [{"type": "works", "id": "11"}, {"type": "works", "id": "12"}]}
     }
-  ],
-  "linked": [
+  },
+  "included": [
       {
-        "id": 11,
+        "id": "11",
         "type": "works",
-        "href": "http://literature.example.com/work/11",
-        "chinese_name": "論語",
-        "english_name": "Analects",
+        "attributes": {
+          "chinese_name": "論語",
+          "english_name": "Analects"
+        },
         "links": {
-          "quotes": {"type": "quotes", "ids": [17, 18]},
-          "era": {"type": "erae", "id": 99}
+          "profile": "http://literature.example.com/profiles/work",
+          "self": "http://literature.example.com/work/11",
+          "quotes": {"linkage": [{"type": "quotes", "id": "17"}, {"type": "quotes", "id": "18"}]},
+          "era": {"linkage": {"type": "erae", "id": "99"}}
         }
       },
       {
-        "id": 17,
+        "id": "17",
         "type": "quotes",
-        "chinese": "廄焚。子退朝，曰：“傷人乎？” 不問馬。"
+        "attributes": {
+          "chinese": "廄焚。子退朝，曰：“傷人乎？” 不問馬。"
+        }
       },
       {
-        "id": 18,
+        "id": "18",
         "type": "quotes",
-        "chinese": "子曰：“其恕乎！己所不欲、勿施於人。”"
+        "attributes": {
+          "chinese": "子曰：“其恕乎！己所不欲、勿施於人。”"
+        }
       },
       {
-        "id": 99,
+        "id": "99",
         "type": "erae",
-        "name": "Zhou Dynasty"
+        "attributes": {
+          "name": "Zhou Dynasty"
+        }
       },
       {
-        "id": 12,
+        "id": "12",
         "type": "works",
-        "href": "http://literature.example.com/work/12",
-        "chinese_name": "易經",
-        "english_name": "Commentaries to the Yi-jing"
+        "attributes": {
+          "chinese_name": "易經",
+          "english_name": "Commentaries to the Yi-jing"
+        },
+        "links": {
+          "profile": "http://literature.example.com/profiles/work",
+          "self": "http://literature.example.com/work/12"
+        }
       }
   ]
 }

data/spec/json/list_of_quotes.collection_json.json

@@ -0,0 +1,43 @@
+{
+  "collection": {
+    "version": "1.0",
+    "items": [
+      {
+        "data": [
+          {
+            "name": "id",
+            "value": 17
+          },
+          {
+            "name": "chinese",
+            "value": "廄焚。子退朝，曰：“傷人乎？” 不問馬。"
+          }
+        ]
+      },
+      {
+        "data": [
+          {
+            "name": "id",
+            "value": 18
+          },
+          {
+            "name": "chinese",
+            "value": "子曰：“其恕乎！己所不欲、勿施於人。”"
+          }
+        ]
+      },
+      {
+        "data": [
+          {
+            "name": "id",
+            "value": 99
+          },
+          {
+            "name": "chinese",
+            "value": null
+          }
+        ]
+      }
+    ]
+  }
+}

data/spec/json/list_of_quotes.hal.json

@@ -0,0 +1,18 @@
+{
+  "_embedded": {
+    "rel:quotes": [
+      {
+        "id": 17,
+        "chinese": "廄焚。子退朝，曰：“傷人乎？” 不問馬。"
+      },
+      {
+        "id": 18,
+        "chinese": "子曰：“其恕乎！己所不欲、勿施於人。”"
+      },
+      {
+        "id": 99,
+        "chinese": null
+      }
+    ]
+  }
+}

data/spec/json/list_of_quotes.json_api.json

@@ -0,0 +1,25 @@
+ {
+  "data": [
+    {
+      "type": "quotes",
+      "id": "17",
+      "attributes": {
+        "chinese": "廄焚。子退朝，曰：“傷人乎？” 不問馬。"
+      }
+    },
+    {
+      "type": "quotes",
+      "id": "18",
+      "attributes": {
+        "chinese": "子曰：“其恕乎！己所不欲、勿施於人。”"
+      }
+    },
+    {
+      "type": "quotes",
+      "id": "99",
+      "attributes": {
+        "chinese": null
+      }
+    }
+  ]
+}

data/spec/json/youtypeitwepostit.collection_json.json

@@ -0,0 +1,45 @@
+{
+  "collection": {
+    "version": "1.0",
+    "href": "http://www.youtypeitwepostit.com/api/",
+
+    "links": [
+      { "rel": "self", "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

@@ -18,14 +18,15 @@ require_relative 'support/youtypeit_models_mappers'
 require_relative 'support/deep_eql'
 require_relative 'support/classes_for_policy_testing'
 
-
 RSpec.configure do |rspec|
   rspec.include FixtureHelpers
   rspec.backtrace_exclusion_patterns = [] if ENV['FULLSTACK']
   rspec.disable_monkey_patching!
   rspec.raise_errors_for_deprecations!
-  rspec.around(:each) do |example|
-    Timeout.timeout(1, &example)
+  if defined?(Mutant)
+    rspec.around(:each) do |example|
+      Timeout.timeout(1, &example)
+    end
   end
 end
 

data/spec/support/classes_for_policy_testing.rb

@@ -1,34 +1,58 @@
 # Used by Yaks::DefaultPolicy* tests to test various name inference schemes
 
-class SoyMapper ; end
-class Bean ; end
-class Soy < Bean; end
-class Wheat ; end
+class SoyMapper; end
+class Soy; end
+class WildSoy < Soy; end
+
+module Grain
+  class Soy; end
+  class WildSoy < Soy; end
+
+  class Wheat; end
+  class Durum < Wheat; end
+
+  module Dry
+    class Soy < ::Grain::Soy; end
+    class SoyMapper; end
+  end
+
+  class SoyMapper; end
+  class SoyCollectionMapper; end
+end
+
+class HomeMapper; end
+class WheatMapper; end
+class ObjectMapper; end
+class BasicObjectMapper; end
 
 module MyMappers
-  class SoyMapper ; end
-  class BeanMapper ; end
+  class SoyMapper; end
+  class WheatMapper; end
+
+  module Grain
+    class SoyMapper; end
+  end
 end
 
-class SoyCollectionMapper ; end
+class SoyCollectionMapper; end
 
 module Namespace
   module Nested
-    class Rye ; end
-    class Mung < Bean
-      alias inspect to_s # on 1.9 inspect calls to_s
+    class Rye; end
+    class Mung
+      alias_method :inspect, :to_s # on 1.9 inspect calls to_s
       def to_s
         "mungbean"
       end
     end
   end
 
-  class RyeMapper ; end
-  class RyeCollectionMapper ; end
+  class RyeMapper; end
+  class RyeCollectionMapper; end
 
-  class CollectionMapper ; end
+  class CollectionMapper; end
 
-  class ShoeMapper ; end
+  class ShoeMapper; end
 end
 
 module DislikesCollectionMapper

data/spec/support/deep_eql.rb

@@ -25,7 +25,9 @@ module Matchers
     end
 
     def recurse(target, expectation)
-      @result &&= DeepEql.new(expectation, stack, diffs).matches?(target)
+      # leave this in two lines so it doesn't short circuit
+      result = DeepEql.new(expectation, stack, diffs).matches?(target)
+      @result &&= result
     end
 
     def stack_as_jsonpath
@@ -51,14 +53,14 @@ module Matchers
           recurse(target[key], expectation[key])
         else
           add_failure_message begin
-                            if expectation[key].class == target[key].class
-                              "expected #{expectation[key].inspect}, got #{target[key].inspect}"
-                            else
-                              "expected #{expectation[key].class}: #{expectation[key].inspect}, got #{target[key].class}: #{target[key].inspect}"
-                            end
-                          rescue Encoding::CompatibilityError
-                            "expected #{expectation[key].encoding}, got #{target[key].encoding}"
-                          end
+                                if expectation[key].class == target[key].class
+                                  "expected #{expectation[key].inspect}, got #{target[key].inspect}"
+                                else
+                                  "expected #{expectation[key].class}: #{expectation[key].inspect}, got #{target[key].class}: #{target[key].inspect}"
+                                end
+                              rescue Encoding::CompatibilityError
+                                "expected #{expectation[key].encoding}, got #{target[key].encoding}"
+                              end
         end
       end
       pop
@@ -66,7 +68,6 @@ module Matchers
 
     def matches?(target)
       @target = target
-
       case expectation
       when Hash
         if target.is_a?(Hash)
@@ -74,12 +75,12 @@ module Matchers
             add_failure_message("expected #{expectation.class}, got #{target.class}")
           end
           (expectation.keys - target.keys).each do |key|
-            add_failure_message "Expected key #{key}"
+            add_failure_message "Expected key #{key.inspect} => #{expectation[key].inspect}"
           end
           (target.keys - expectation.keys).each do |key|
-            add_failure_message "Unexpected key #{key}"
+            add_failure_message "Unexpected key #{key.inspect} => #{target[key].inspect}"
           end
-          (target.keys | expectation.keys).each do |key|
+          (target.keys & expectation.keys).each do |key|
             compare key
           end
         else
@@ -107,17 +108,19 @@ module Matchers
     def failure_message_for_should
       diffs.join("\n")
     end
-    alias failure_message failure_message_for_should
+    alias_method :failure_message, :failure_message_for_should
 
     def failure_message_for_should_not
       "expected #{@target.inspect} not to be in deep_eql with #{@expectation.inspect}"
     end
-    alias failure_message_when_negated failure_message_for_should_not
+    alias_method :failure_message_when_negated, :failure_message_for_should_not
   end
 end
 
-module RSpec::Matchers
-  def deep_eql(exp)
-    Matchers::DeepEql.new(exp)
+module RSpec
+  module Matchers
+    def deep_eql(exp)
+      ::Matchers::DeepEql.new(exp)
+    end
   end
 end