rspec-roar_matchers 0.0.1

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 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-roar_matchers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hashrocket Workstation
+
+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,67 @@
+# Rspec::RoarMatchers
+
+Rspec::RoarMatchers is a collection of matchers designed to enforce a contract between your spec and representer.  The driving concern while recently developing for an app that was making extensive use of Roar, was the fact that we were able to modify the various representers without the spec complaining.
+
+So to ensure that any change to the representation of an object was explicit we made a few rspec matchers to do the heavy lifting.
+
+# Usage
+
+Below are the matchers we've defined thus far (will likely be expanding).  For more information regarding implementation see `spec/roar_matchers/matchers_spec.rb`.  
+
+The will enforce bi-directionally.  This means that it will fail if:
+
+* if a property/collection/link is present in the representer but not in the spec
+* if a property/collection/link is present in the spec but not in the representer
+
+All of these matchers receive a word array as an argument.
+
+### have_collections
+
+```ruby
+context "collection is present in both spec and representer (happy path)" do
+  it "passes" do
+    expected_collections = %w{state_or_provinces}
+    expect(country.extend(CountryRepresenter)).to have_collections(expected_collections)
+  end
+end
+```
+
+### have_links
+
+```ruby
+context "link is present in both spec and representer (happy path)" do
+  it "passes" do
+    expected_links = %w{self}
+    expect(country.extend(CountryRepresenter)).to have_links(expected_links)
+  end
+end
+```
+
+### have_properties
+
+```ruby
+context "link is present in both spec and representer (happy path)" do
+  it "passes" do
+    expected_properties = %w{name}
+    expect(country.extend(CountryRepresenter)).to have_properties(expected_properties)
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-roar_matchers'
+
+And then execute:
+
+    $ bundle
+
+## 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/roar_matchers/have_collections.rb

@@ -0,0 +1,26 @@
+RSpec::Matchers.define :have_collections do |expected_collections|
+  match do |representer|
+    first = expected_collections.all? do |expected_collection|
+      RoarMatchers.get_actual_collection_names(representer).include?(expected_collection)
+    end
+
+    second = RoarMatchers.get_actual_collection_names(representer).all? do |expected_collection|
+      expected_collections.include?(expected_collection)
+    end
+
+    first && second
+  end
+
+  failure_message_for_should do |representer|
+    actual_collection_names = RoarMatchers.get_actual_collection_names(representer)
+    representation_or_specification, missing = RoarMatchers.missing(actual_collection_names, expected_collections)
+
+    (<<-EOS)
+      expected that #{actual_collection_names}
+
+      should contain #{expected_collections}
+
+      missing collection(s) from #{representation_or_specification}: #{missing}
+    EOS
+  end
+end

data/lib/roar_matchers/have_links.rb

@@ -0,0 +1,26 @@
+RSpec::Matchers.define :have_links do |expected_links|
+  match do |representer|
+    first = expected_links.all? do |expected_link|
+      RoarMatchers.get_actual_link_names(representer).include?(expected_link)
+    end
+
+    second = RoarMatchers.get_actual_link_names(representer).all? do |expected_link|
+      expected_links.include?(expected_link)
+    end
+
+    first && second
+  end
+
+  failure_message_for_should do |representer|
+    actual_link_names = RoarMatchers.get_actual_link_names(representer)
+    representation_or_specification, missing = RoarMatchers.missing(actual_link_names,expected_links)
+
+    (<<-EOS)
+      expected that #{actual_link_names}
+
+      should contain #{expected_links}
+
+      missing links from #{representation_or_specification}: #{missing}
+    EOS
+  end
+end

data/lib/roar_matchers/have_properties.rb

@@ -0,0 +1,27 @@
+RSpec::Matchers.define :have_properties do |expected_properties|
+  match do |representer|
+    first = expected_properties.all? do |expected_property|
+      RoarMatchers.get_actual_property_names(representer).include?(expected_property)
+    end
+
+    second = RoarMatchers.get_actual_property_names(representer).all? do |expected_property|
+      expected_properties.include?(expected_property)
+    end
+
+    first && second
+  end
+
+  failure_message_for_should do |representer|
+    actual_property_names = RoarMatchers.get_actual_property_names(representer)
+    representation_or_specification, missing = RoarMatchers.missing(actual_property_names,expected_properties)
+
+    (<<-EOS)
+      expected that #{actual_property_names}
+
+      should contain #{expected_properties}
+
+      missing properties from #{representation_or_specification}: #{missing}
+    EOS
+
+  end
+end

data/lib/roar_matchers/support.rb

@@ -0,0 +1,26 @@
+module RoarMatchers
+  def self.missing(actual,expected)
+    if (mp = (expected - actual)).any?
+      ["Representer", mp]
+    else
+      ["Spec", actual - expected]
+    end
+  end
+
+  def self.get_actual_property_names(representer)
+    representer.instance_variable_get("@representable_attrs").reject do |attr|
+      attr.options[:collection]
+    end.map(&:name)
+  end
+
+  def self.get_actual_link_names(representer)
+    representer.to_json;
+    representer.links.keys
+  end
+
+  def self.get_actual_collection_names(representer)
+    representer.instance_variable_get("@representable_attrs").select do |attr|
+      attr.options[:collection] && attr.name != "links_array"
+    end.map(&:name)
+  end
+end

data/lib/roar_matchers/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module RoarMatchers
+    VERSION = "0.0.1"
+  end
+end

data/lib/roar_matchers.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'roar_matchers/version'
+require 'roar_matchers/support'
+require 'roar_matchers/have_links'
+require 'roar_matchers/have_properties'
+require 'roar_matchers/have_collections'
+
+module Roar
+  module Matchers
+  end
+end

data/rspec-roar_matchers.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'roar_matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-roar_matchers"
+  spec.version       = Rspec::RoarMatchers::VERSION
+  spec.authors       = ["Hashrocket Workstation"]
+  spec.email         = ["dev@hashrocket.com"]
+  spec.description   = %q{Rspec::RoarMatchers is a collection of matchers designed to enforce a contract between your spec and representer.}
+  spec.summary       = %q{ Rspec::RoarMatchers is a collection of matchers designed to enforce a contract between your spec and representer.  The driving concern, while recently developing for an app that was making extensive use of Roar, was the fact that we were able to modify the various representers without the spec complaining. }
+
+  spec.homepage      = "https://github.com/rondale-sc/rspec-roar_matchers"
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "roar"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/spec/fixtures/country.rb

@@ -0,0 +1,8 @@
+class Country
+  attr_accessor :name, :state_or_provinces
+
+  def initialize(name, state_or_provinces=nil)
+    @name = name
+    @state_or_provinces = state_or_provinces
+  end
+end

data/spec/fixtures/country_representer.rb

@@ -0,0 +1,12 @@
+module CountryRepresenter
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+
+  property :name
+
+  collection :state_or_provinces, extend: StateRepresenter, class: State
+
+  link :self do
+    "Generic link"
+  end
+end

data/spec/fixtures/state.rb

@@ -0,0 +1,7 @@
+class State
+  attr_accessor :name
+
+  def initialize(name)
+    @name = name
+  end
+end

data/spec/fixtures/state_representer.rb

@@ -0,0 +1,6 @@
+module StateRepresenter
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+
+  property :name
+end

data/spec/roar_matchers/matchers_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe "RSpec::Matchers" do
+  describe "#have_collection" do
+    let(:country) do
+      Country.new("Canada", [State.new("Ontario")])
+    end
+
+    context "collection is present in both spec and representer (happy path)" do
+      it "passes" do
+        expected_collections = %w{state_or_provinces}
+        expect(country.extend(CountryRepresenter)).to have_collections(expected_collections)
+      end
+    end
+
+    context "when collection is absent in representer" do
+      it "fails and returns message about where to look" do
+        expect do
+          country.extend(CountryRepresenter).should have_collections(["not_in_representer"])
+        end.to raise_error(/missing collection\(s\) from Representer: \["not_in_representer"\]/)
+      end
+    end
+  end
+
+  describe "#have_links" do
+    let(:country) do
+      Country.new("United States",  [State.new("Florida")])
+    end
+
+    context "link is present in both spec and representer (happy path)" do
+      it "passes" do
+        expected_links = %w{self}
+        expect(country.extend(CountryRepresenter)).to have_links(expected_links)
+      end
+    end
+
+    context "when collection is absent in representer" do
+      it "fails and returns message about where to look" do
+        expect do
+          country.extend(CountryRepresenter).should have_links(["not_in_representer"])
+        end.to raise_error(/missing links from Representer: \["not_in_representer"\]/)
+      end
+    end
+  end
+
+  describe "#have_properties" do
+    let(:country) do
+      Country.new("United States",  [State.new("Florida")])
+    end
+
+    context "link is present in both spec and representer (happy path)" do
+      it "passes" do
+        expected_properties = %w{name}
+        expect(country.extend(CountryRepresenter)).to have_properties(expected_properties)
+      end
+    end
+
+    context "when property is absent in representer" do
+      it "fails and returns message about where to look" do
+        expect do
+          country.extend(CountryRepresenter).should have_properties(["not_in_representer"])
+        end.to raise_error(/missing properties from Representer: \["not_in_representer"\]/)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+Bundler.require(:default)
+
+require 'roar_matchers'
+require 'roar/representer/json'
+require 'roar/representer/feature/hypermedia'
+
+require_relative './fixtures/country'
+require_relative './fixtures/state'
+require_relative './fixtures/state_representer'
+require_relative './fixtures/country_representer'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = "random"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: rspec-roar_matchers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Hashrocket Workstation
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: roar
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: pry
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Rspec::RoarMatchers is a collection of matchers designed to enforce a
+  contract between your spec and representer.
+email:
+- dev@hashrocket.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/roar_matchers.rb
+- lib/roar_matchers/have_collections.rb
+- lib/roar_matchers/have_links.rb
+- lib/roar_matchers/have_properties.rb
+- lib/roar_matchers/support.rb
+- lib/roar_matchers/version.rb
+- rspec-roar_matchers.gemspec
+- spec/fixtures/country.rb
+- spec/fixtures/country_representer.rb
+- spec/fixtures/state.rb
+- spec/fixtures/state_representer.rb
+- spec/roar_matchers/matchers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rondale-sc/rspec-roar_matchers
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rspec::RoarMatchers is a collection of matchers designed to enforce a contract
+  between your spec and representer.  The driving concern, while recently developing
+  for an app that was making extensive use of Roar, was the fact that we were able
+  to modify the various representers without the spec complaining.
+test_files:
+- spec/fixtures/country.rb
+- spec/fixtures/country_representer.rb
+- spec/fixtures/state.rb
+- spec/fixtures/state_representer.rb
+- spec/roar_matchers/matchers_spec.rb
+- spec/spec_helper.rb
+has_rdoc: