rspec-hal 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9463991d7f7b862e2979e8f110458daa8a005f8f
-  data.tar.gz: a28bf60caeb1602ea86ee49bf70cfbb87e6a14bf
+  metadata.gz: 56ffc8c99f84bb144a2dc97705eb0499a2bb1cd7
+  data.tar.gz: 8983c9abffc8c5980330c950d268914b3a01eebe
 SHA512:
-  metadata.gz: 459b268f52a050327e80253dbffd0d9172f2c7ecf81b2687eb2953fcc0f7281dd4eea58efbf74e4d32ccd14731e18a099abf4231bb76e9713a5fae00e3dc0ae0
-  data.tar.gz: e48f6a959f34e8db673a2db0995b3c2cd5cde16f2e9b73c9bde3f76a42f119ca57d628df284dabd21ec3ffadfe6ba1548a9c4b99b78d7793a304ea411a1994f3
+  metadata.gz: 345a34323d5c89748d3355cba81016e3bc1c2657828073ea51a9133bb89ccd51d34062efb817f8114328f49aaf3208f80659b1fa9cfddf0fa585ad56e1bd6e15
+  data.tar.gz: d71388e4b12afda7a66e7a5311579a6b8c47611a1a979a5bb9655423583a37806e0e6eef5f914eda53d970e40b0e119932494237aacf69c72552662bd5262dc7

data/README.md

@@ -10,15 +10,15 @@ Provides matchers and convenience methods for verifying HAL documents.
 Include the matchers by adding this to your spec_helper
 
 ```ruby
-RSpec.configuration.include RSpec::Hal::Matchers::Documents
+RSpec.configuration.include RSpec::Hal::Matchers
 ```
 
-(Don't forget to `require rspec-hal` if you are not using bundler.)
+(Don't forget to `require "rspec-hal"` if you are not using bundler.)
 
 If you are using rspec-rails and want only include the matchers for views do this
 
 ```ruby
-RSpec.configuration.include RSpec::Hal::Matchers::Documents, type: 'view'
+RSpec.configuration.include RSpec::Hal::Matchers, type: 'view'
 ```
 
 Once you have the matchers included you can use it like this

data/lib/rspec/hal/matchers/templated_relation_matcher.rb

@@ -0,0 +1,87 @@
+module RSpec
+  module Hal
+    module Matchers
+
+      # Example
+      #
+      #     expect(doc).to have_templated_relation("search")
+      #     expect(doc).to have_templated_relation("search", matching("{?q}"))
+      #
+      class TemplatedRelationMatcher
+        def initialize(link_rel, expected=nil)
+          @link_rel = link_rel
+          @expected = expected
+        end
+
+        def matches?(jsonish)
+          repr = parse(jsonish)
+
+          repr.raw_related_hrefs(link_rel){[]}
+            .select{|it| it.respond_to? :expand}
+            .select{|it| expected === it }
+            .any?
+            .tap do |outcome|
+              @outcome = if outcome
+                           :pass
+                         elsif repr.raw_related_hrefs(link_rel){[]}.any?
+                           :no_templates
+                         else
+                           :no_relations
+                         end
+            end
+        end
+
+        def failure_message
+          but_clause = if outcome == :no_templates
+                         "found only non-templated links"
+                       else
+                         "found none"
+                       end
+          expected_clause = if expected != NullMatcher && expected.respond_to?(:description)
+                              expected.description
+                            elsif expected != NullMatcher
+                              "matching #{expected}"
+                            else
+                              "to exist"
+                            end
+
+          "Expected templated `#{link_rel}` link #{expected_clause} but #{but_clause}"
+        end
+        alias_method :failure_message_for_should, :failure_message
+
+        def failure_message_when_negated
+          "Expected `#{link_rel}` link to be absent or not templated"
+        end
+        alias_method :failure_message_for_should_not, :failure_message_when_negated
+
+        def description
+          "have templated #{link_rel} link"
+        end
+
+        protected
+
+        attr_reader :link_rel, :outcome
+
+        NullMatcher = ->(_url_template){ true }
+
+        def expected
+          @expected ||= NullMatcher
+        end
+
+        def parse(jsonish)
+          json = if jsonish.kind_of? String
+                   jsonish
+
+                 elsif jsonish.respond_to? :to_hal
+                   jsonish.to_hal
+
+                 else jsonish.respond_to? :to_json
+                   jsonish.to_json
+                 end
+
+          HalClient::Representation.new(parsed_json: MultiJson.load(json))
+        end
+      end
+    end
+  end
+end

data/lib/rspec/hal/matchers.rb

@@ -4,6 +4,17 @@ require 'hal-client'
 module RSpec
   module Hal
     module Matchers
+      require "rspec/hal/matchers/templated_relation_matcher"
+
+      # Examples
+      #
+      #     expect(doc).to have_templated_relation("search")
+      #     expect(doc).to have_templated_relation("search", matching("{?q}"))
+      #
+      def have_templated_relation(*args)
+        TemplatedRelationMatcher.new(*args)
+      end
+
       module Document
         extend RSpec::Matchers::DSL
 
@@ -147,6 +158,8 @@ module RSpec
 
         end
       end
+
+      include Document
     end
   end
 end

data/lib/rspec/hal/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Hal
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/rspec-hal.gemspec

@@ -21,6 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.1"
 
   spec.add_runtime_dependency "rspec", ">= 2.0", "< 4.0.0.pre"
-  spec.add_runtime_dependency "hal-client", "~> 2.2
-"
+  spec.add_runtime_dependency "hal-client", "~> 2.4"
 end

data/spec/rspec/hal/matchers/templated_relation_matcher_spec.rb

@@ -0,0 +1,108 @@
+require_relative "../../../spec_helper"
+
+describe RSpec::Hal::Matchers::TemplatedRelationMatcher do
+  describe "creation" do
+    specify { expect{ described_class.new(a_link_rel) }.not_to raise_error }
+    specify { expect{ described_class.new(a_link_rel, any_template_str_matcher) }.not_to raise_error }
+    specify { expect{ described_class.new(a_link_rel, /hello/) }.not_to raise_error }
+  end
+
+  subject(:matcher) { described_class.new(a_link_rel) }
+
+  specify{ expect(matcher.matches?(json_str_w_link)).to be }
+  specify{ expect(matcher.matches?(json_str_wo_link)).not_to be }
+
+  specify{ expect(matcher.matches?(parsed_json_w_link)).to be }
+  specify{ expect(matcher.matches?(parsed_json_wo_link)).not_to be }
+
+  specify{ expect(matcher.matches?(to_halable_w_link)).to be }
+  specify{ expect(matcher.matches?(to_halable_wo_link)).not_to be }
+
+  specify{ expect(matcher.matches?(json_str_w_nontemplate_link)).not_to be }
+
+  specify { expect(matcher.description).to match "have templated #{a_link_rel} link" }
+
+  context "failed due to missing relation matcher" do
+    before do
+      matcher.matches? json_str_wo_link
+    end
+
+    specify { expect(matcher.failure_message)
+        .to match "Expected templated `#{a_link_rel}` link to exist but found none" }
+    specify { expect(matcher.failure_message_for_should)
+        .to match matcher.failure_message }
+  end
+
+  context "failed due to unexpected existing relation" do
+    before do
+      matcher.matches? json_str_w_link
+    end
+
+    specify { expect(matcher.failure_message_when_negated)
+        .to match "Expected `#{a_link_rel}` link to be absent or not templated" }
+    specify { expect(matcher.failure_message_for_should_not)
+        .to match matcher.failure_message_when_negated }
+  end
+
+  context "failed due existing non-templated relation" do
+    before do
+      matcher.matches? json_str_w_nontemplate_link
+    end
+
+    specify { expect(matcher.failure_message)
+        .to match "Expected templated `#{a_link_rel}` link to exist but found only non-templated links" }
+  end
+
+  context "failed due to sub-matcher failure matcher" do
+    subject(:matcher) { described_class.new(a_link_rel, matching("absent")) }
+    before do
+      matcher.matches? json_str_wo_link
+    end
+
+    specify { expect(matcher.failure_message)
+        .to match %(Expected templated `#{a_link_rel}` link matching "absent" but found none) }
+  end
+
+
+  # Background
+  # ---
+
+  let(:json_str_w_link) { <<-HAL }
+    { "_links": {
+      "search": {"href": "http://example.com/s{?q}", "templated": true}
+    }}
+  HAL
+
+  let(:json_str_wo_link) { <<-HAL }
+    { "_links": {
+    }}
+  HAL
+
+  let(:json_str_w_nontemplate_link) { <<-HAL }
+    { "_links": {
+      "search": {"href": "http://example.com/s{?q}", "templated": false}
+    }}
+  HAL
+
+
+  let(:parsed_json_w_link) { MultiJson.load json_str_w_link }
+  let(:parsed_json_wo_link) { MultiJson.load json_str_wo_link }
+
+  let(:to_halable_w_link) { halable.new json_str_w_link}
+  let(:to_halable_wo_link) { halable.new json_str_wo_link }
+
+  let(:halable) { Class.new do
+      def initialize(json)
+        @json = json
+      end
+
+      def to_hal
+        return @json
+      end
+    end }
+
+  let(:a_link_rel) { "search" }
+  let(:any_template_str_matcher) { matching_template_str_matcher }
+  let(:matching_template_str_matcher) { match "example.com" }
+  let(:nonmatching_template_str_matcher) { match "hello" }
+end

data/spec/rspec/hal/matchers_spec.rb

@@ -1,6 +1,27 @@
 require_relative "../../spec_helper"
 require "rspec/version"
 
+describe RSpec::Hal::Matchers do
+  subject { Class.new do
+      include RSpec::Hal::Matchers
+    end.new }
+
+  specify { expect(subject.be_hal).to be_a_matcher }
+  specify { expect(subject.be_hal_collection).to be_a_matcher }
+  specify { expect(subject.have_property("name")).to be_a_matcher }
+  specify { expect(subject.have_templated_relation("search")).to be_a_matcher }
+  specify { expect(subject.have_relation("search")).to be_a_matcher }
+
+  # Background/Support
+  # ---
+
+  matcher :be_a_matcher do
+    match do |actual|
+      respond_to?(:matches?) && respond_to?(:failure_message)
+    end
+  end
+end
+
 describe RSpec::Hal::Matchers::Document do
   describe "be_hal" do
     subject(:matcher) { be_hal }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-hal
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Peter Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.4'
 description: 
 email:
 - pezra@barelyenough.org
@@ -88,8 +88,10 @@ files:
 - lib/rspec-hal.rb
 - lib/rspec/hal.rb
 - lib/rspec/hal/matchers.rb
+- lib/rspec/hal/matchers/templated_relation_matcher.rb
 - lib/rspec/hal/version.rb
 - rspec-hal.gemspec
+- spec/rspec/hal/matchers/templated_relation_matcher_spec.rb
 - spec/rspec/hal/matchers_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/pezra/rspec-hal
@@ -117,5 +119,6 @@ signing_key:
 specification_version: 4
 summary: Matchers and helpers for specing HAL documents.
 test_files:
+- spec/rspec/hal/matchers/templated_relation_matcher_spec.rb
 - spec/rspec/hal/matchers_spec.rb
 - spec/spec_helper.rb