rspec-siren 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Neer Friedman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Rspec::Siren
+
+Helpers for testing [siren](https://github.com/kevinswiber/siren) objects with
+RSpec
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-siren'
+
+And then execute:
+
+    $ bundle
+
+In your `spec_helper.rb` add: `require 'rspec-siren'`
+
+## Usage
+
+```ruby
+require 'spec_helper'
+
+RSpec.describe MyCustomSirenSerializer do
+  let(:siren) { MyCustomSirenSerializer.new.to_siren }
+
+  it { should have_class("MyCustomSiren") }
+
+  it { should have_entities.with_class("MySubEntity").exactly(2) }
+
+  it { should have_link_with_rel("my-rel") }
+
+  it { should have_property("myProperty").with_value("myValue") }
+end
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rspec/siren/matchers/has_class.rb

@@ -0,0 +1,28 @@
+module RSpec
+  module Siren
+    module Matchers
+      class HasClass
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(target)
+          @target = target
+          @target[:class] && safe_classes.include?(@expected)
+        end
+
+        def safe_classes
+          Array(@target[:class])
+        end
+
+        def description
+          "have siren class '#{@expected}'"
+        end
+
+        def failure_message
+          "expected siren object to have class '#{@expected}' found classes: #{safe_classes.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/siren/matchers/has_entities.rb

@@ -0,0 +1,47 @@
+module RSpec
+  module Siren
+    module Matchers
+      class HasEntities
+        def matches?(target)
+          @target = target
+
+          @entities = safe_entities.select do |e|
+            !@klass || e[:class].include?(@klass)
+          end
+
+          !@entities.empty? && (!@count || @entities.count == @count)
+        end
+
+        def with_class(klass)
+          @klass = klass
+          self
+        end
+
+        def exactly(count)
+          @count = count
+          self
+        end
+
+        def description
+          message = "have"
+          message << " #{@count}" if @count
+          message << " entities with klass '#{@klass}'"
+        end
+
+        def failure_message
+          message = "expected"
+          message << " #{@count}"
+          message << " entities with class '#{@klass}'."
+          message << " Found #{@entities.count}."
+        end
+
+        private
+
+        def safe_entities
+          Array(@target[:entities])
+        end
+
+      end
+    end
+  end
+end

data/lib/rspec/siren/matchers/has_link.rb

@@ -0,0 +1,32 @@
+module RSpec
+  module Siren
+    module Matchers
+      class HasLink
+        def initialize(expected_rel)
+          @expected_rel = expected_rel
+        end
+
+        def matches?(target)
+          @target = target
+          link = safe_links.detect { |l| l[:rel].include?(@expected_rel) }
+
+          !!link
+        end
+
+        def description
+          "have a link with rel '#{@expected_rel}'"
+        end
+
+        def failure_message
+          "has no link with rel '#{@expected_rel}'"
+        end
+
+        private
+
+        def safe_links
+          Array(@target[:links])
+        end
+      end
+    end
+  end
+end

data/lib/rspec/siren/matchers/has_property.rb

@@ -0,0 +1,61 @@
+module RSpec
+  module Siren
+    module Matchers
+      class HasProperty
+        def initialize(expected_name)
+          @expected_name = expected_name
+        end
+
+        def matches?(target)
+          @target = target
+
+          @value = safe_properties[@expected_name]
+
+          property_exists? && (!has_expected_value? || expected_value_matches?)
+        end
+
+        def with_value(expected_value)
+          @expected_value = expected_value
+          self
+        end
+
+        def has_expected_value?
+          !!@expected_value
+        end
+
+        def expected_value_matches?
+          @value == @expected_value
+        end
+
+        def property_exists?
+          safe_properties.has_key?(@expected_name)
+        end
+
+        def description
+          message = "have"
+          message << " property '#{@expected_name}'"
+          message << " with value '#{@expected_value}'"
+        end
+
+        def failure_message
+          message = "expected"
+          message << " property '#{@expected_name}'"
+          message << " with value '#{@expected_value}'" if @expected_value
+          message << ". Found"
+          if !property_exists?
+            message << " no such property."
+          else
+            message << " with value '#{@value}'"
+          end
+          message
+        end
+
+        private
+
+        def safe_properties
+          @target[:properties] || @target["properties"] || {}
+        end
+      end
+    end
+  end
+end

data/lib/rspec/siren/matchers.rb

@@ -0,0 +1,27 @@
+module RSpec
+  module Siren
+    module Matchers
+      autoload :HasClass, "rspec/siren/matchers/has_class"
+      autoload :HasEntities, "rspec/siren/matchers/has_entities"
+      autoload :HasLink, "rspec/siren/matchers/has_link"
+      autoload :HasProperty, "rspec/siren/matchers/has_property"
+
+      def have_class(expected_class)
+        HasClass.new(expected_class)
+      end
+
+      def have_entities
+        HasEntities.new
+      end
+
+      def have_link_with_rel(expected_rel)
+        HasLink.new(expected_rel)
+      end
+
+      def have_property(expected_name)
+        HasProperty.new(expected_name)
+      end
+    end
+  end
+end
+

data/lib/rspec/siren/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Siren
+    VERSION = "1.0.0"
+  end
+end

data/lib/rspec/siren.rb

@@ -0,0 +1,7 @@
+require "rspec/siren/version"
+require "rspec/siren/matchers"
+
+module RSpec
+  module Siren
+  end
+end

data/lib/rspec-siren.rb

@@ -0,0 +1 @@
+require "rspec/siren"

data/rspec-siren.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/siren/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-siren"
+  spec.version       = RSpec::Siren::VERSION
+  spec.authors       = ["Neer Friedman"]
+  spec.email         = ["neerfri@gmail.com"]
+  spec.description   = %q{RSpec for siren hypermedia}
+  spec.summary       = %q{A collection of matchers and helpers for easy testing of siren objects via RSpec}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/rspec/siren/matchers/has_class_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+RSpec.describe RSpec::Siren::Matchers::HasClass do
+  include RSpec::Siren::Matchers
+  include RSpec::Siren::MatchersSpecHelper
+
+  let(:expected_class) { "my-class" }
+  let(:matcher) { have_class(expected_class) }
+  subject { matcher }
+
+  context "with correct class" do
+    it { should match_siren }
+  end
+
+  context "with incorrect class" do
+    let(:expected_class) { "wrong-class" }
+
+    it { should_not match_siren }
+  end
+
+  context "when siren object has no class attribute" do
+    it { should_not match_siren }
+
+    def siren_hash
+      super.merge(class: nil)
+    end
+  end
+end

data/spec/rspec/siren/matchers/has_entities_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+RSpec.describe RSpec::Siren::Matchers::HasEntities do
+  include RSpec::Siren::Matchers
+  include RSpec::Siren::MatchersSpecHelper
+
+  let(:expected_rel) { "some-rel" }
+  let(:matcher) { have_entities }
+  subject { matcher }
+
+  context "with any entity" do
+    it { should match_siren }
+
+    context "and correct count" do
+      let(:matcher) { super().exactly(2) }
+
+      it { should match_siren }
+    end
+
+    context "and wrong count" do
+      let(:matcher) { super().exactly(3) }
+
+      it { should_not match_siren }
+    end
+  end
+
+  context "with existing entity class" do
+    let(:matcher) { super().with_class("my-entity") }
+
+    it { should match_siren }
+
+    context "and correct count" do
+      let(:matcher) { super().exactly(2) }
+
+      it { should match_siren }
+    end
+
+    context "and wrong count" do
+      let(:matcher) { super().exactly(3) }
+
+      it { should_not match_siren }
+    end
+  end
+
+  context "with no entities" do
+    it { should_not match_siren }
+
+    def siren_hash
+      super.merge(entities: [])
+    end
+  end
+
+  context "when siren has no entities attribute" do
+    it { should_not match_siren }
+
+    def siren_hash
+      super.merge(entities: nil)
+    end
+  end
+end

data/spec/rspec/siren/matchers/has_link_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+RSpec.describe RSpec::Siren::Matchers::HasLink do
+  include RSpec::Siren::Matchers
+  include RSpec::Siren::MatchersSpecHelper
+
+  let(:expected_rel) { "some-rel" }
+  let(:matcher) { have_link_with_rel(expected_rel) }
+  subject { matcher }
+
+  context "with correct rel" do
+    let(:expected_rel) { "my-link" }
+
+    it { should match_siren }
+
+    it "describes link presence" do
+      match!
+
+      expect(matcher.description).to eq("have a link with rel 'my-link'")
+    end
+  end
+
+  context "when siren object has no class attribute" do
+    it { should_not match_siren }
+
+    it "does not raise" do
+      matcher = have_a_link("some-rel")
+      expect { match! }.to_not raise_error
+    end
+
+    def siren_hash
+      super.merge(links: nil)
+    end
+  end
+
+  context "with incorrect rel" do
+    let(:expected_rel) { "some-rel" }
+
+    it { should_not match_siren }
+
+    it "notifies about missing link" do
+      match!
+      expect(matcher.failure_message).to eq("has no link with rel 'some-rel'")
+    end
+  end
+end

data/spec/rspec/siren/matchers/has_property_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+RSpec.describe RSpec::Siren::Matchers::HasProperty do
+  include RSpec::Siren::Matchers
+  include RSpec::Siren::MatchersSpecHelper
+
+  let(:expected_property) { :someProperty }
+  let(:matcher) { have_property(expected_property) }
+  subject { matcher }
+
+  context "with existing property" do
+    it { should match_siren }
+
+    context "and correct value" do
+      let(:matcher) { super().with_value("someValue") }
+
+      it { should match_siren }
+    end
+
+    context "and wrong value" do
+      let(:matcher) { super().with_value("wrongValue") }
+
+      it { should_not match_siren }
+    end
+  end
+
+  context "with non-existing property" do
+    let(:expected_property) { :nonExistingProperty }
+
+    it { should_not match_siren }
+  end
+
+  context "when siren has no properties attribute" do
+    it { should_not match_siren }
+
+    def siren_hash
+      super.merge(properties: nil)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require "rspec-siren"
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  # load files in support dir
+  Dir[File.expand_path("../support/**/*.rb", __FILE__)]
+    .sort
+    .each { |f| require f }
+end

data/spec/support/matchers_spec_helper.rb

@@ -0,0 +1,66 @@
+module RSpec
+  module Siren
+    module MatchersSpecHelper
+      def match!
+        matcher.matches?(siren_hash)
+      end
+
+      def siren_hash
+        {
+          class: siren_classes,
+          links: siren_links,
+          entities: siren_entities,
+          properties: siren_properties,
+        }
+      end
+
+      def siren_classes
+        [ "my-class" ]
+      end
+
+      def siren_links
+        [
+          { rel: ["my-link"], href: "http://example.com" },
+        ]
+      end
+
+      def siren_entities
+        [
+          { class: ["my-entity"], href: "http://example.com" },
+          { class: ["my-entity"], href: "http://example.com" },
+        ]
+      end
+
+      def siren_properties
+        {
+          someProperty: "someValue"
+        }
+      end
+
+      class MatchSirenMatcher < Struct.new(:siren_hash)
+        def matches?(matcher)
+          @matcher = matcher
+          matcher.matches?(siren_hash) == true
+        end
+
+        def description
+          "match"
+        end
+
+        def failure_message
+          "expected to match but did not match." \
+            " original failure message is: " \
+            "#{@matcher.failure_message.inspect}"
+        end
+
+        def failure_message_when_negated
+          "expected to not match but matched"
+        end
+      end
+
+      def match_siren
+        MatchSirenMatcher.new(siren_hash)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: rspec-siren
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Neer Friedman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RSpec for siren hypermedia
+email:
+- neerfri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-siren.rb
+- lib/rspec/siren.rb
+- lib/rspec/siren/matchers.rb
+- lib/rspec/siren/matchers/has_class.rb
+- lib/rspec/siren/matchers/has_entities.rb
+- lib/rspec/siren/matchers/has_link.rb
+- lib/rspec/siren/matchers/has_property.rb
+- lib/rspec/siren/version.rb
+- rspec-siren.gemspec
+- spec/rspec/siren/matchers/has_class_spec.rb
+- spec/rspec/siren/matchers/has_entities_spec.rb
+- spec/rspec/siren/matchers/has_link_spec.rb
+- spec/rspec/siren/matchers/has_property_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers_spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4380809523059336186
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4380809523059336186
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A collection of matchers and helpers for easy testing of siren objects via
+  RSpec
+test_files:
+- spec/rspec/siren/matchers/has_class_spec.rb
+- spec/rspec/siren/matchers/has_entities_spec.rb
+- spec/rspec/siren/matchers/has_link_spec.rb
+- spec/rspec/siren/matchers/has_property_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers_spec_helper.rb