active_model_serializers_matchers 0.0.3 → 0.2.0

data/spec/active_model_serializers_matchers_spec.rb

@@ -2,21 +2,23 @@ require 'spec_helper'
 
 describe ActiveModelSerializersMatchers do
 
-  include described_class
-
   describe '#have_many' do
-    it 'instantiates a new HaveManyAssociationMatcher' do
-      expect(described_class::HaveManyAssociationMatcher)
-        .to receive(:new).with(:association_root)
-      have_many(:association_root)
+    it 'returns a new AssociationMatcher of type :has_many' do
+      expect(described_class::AssociationMatcher)
+        .to receive(:new).with(:association_root, :has_many)
+        .and_call_original
+      expect(have_many(:association_root))
+        .to be_a described_class::AssociationMatcher
     end
   end
 
   describe '#have_one' do
-    it 'instantiates a new HaveOneAssociationMatcher' do
-      expect(described_class::HaveOneAssociationMatcher)
-        .to receive(:new).with(:association_root)
-      have_one(:association_root)
+    it 'returns a new AssociationMatcher of type :has_one' do
+      expect(described_class::AssociationMatcher)
+        .to receive(:new).with(:association_root, :has_one)
+        .and_call_original
+      expect(have_one(:association_root))
+        .to be_a described_class::AssociationMatcher
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,11 @@
-require 'pry-byebug'
-require 'rspec/its'
+require 'coveralls'
+Coveralls.wear!
+
 require 'active_model_serializers'
 require 'active_model_serializers_matchers'
+
+Dir[Pathname(__FILE__).join('../support/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include ActiveModelSerializersMatchers
+end

data/spec/support/dummy_serializers.rb

@@ -0,0 +1,2 @@
+class FooSerializer; end
+class BarSerializer; end

data/spec/support/rspec_fail_matchers.rb

@@ -0,0 +1,20 @@
+module RSpec
+  module Matchers
+    def fail
+      raise_error(RSpec::Expectations::ExpectationNotMetError)
+    end
+
+    def fail_with(message)
+      raise_error(RSpec::Expectations::ExpectationNotMetError, message)
+    end
+
+    def fail_matching(message)
+      if String === message
+        regexp = /#{Regexp.escape(message)}/
+      else
+        regexp = message
+      end
+      raise_error(RSpec::Expectations::ExpectationNotMetError, regexp)
+    end
+  end
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,127 @@
+shared_examples 'it has_one :foo' do
+  it 'should pass a have_one :foo expectation' do
+    expectation = have_one(:foo)
+    expect(subject).to expectation
+    expect(expectation.description).to eq('have one :foo')
+  end
+
+  it 'should fail a have_one :fuu expectation' do
+    expect {
+      expect(subject).to have_one(:fuu)
+    }.to fail_with("expected #{ subject } to define a 'has_one :fuu' association")
+  end
+
+  it 'should fail a have_many :foo expectation' do
+    expect {
+      expect(subject).to have_many(:foo)
+    }.to fail_with("expected #{ subject } to define a 'has_many :foo' association")
+  end
+end
+
+shared_examples 'it has_one :foo and no key' do
+  it 'should fail a have_one :foo as :bar expectation' do
+    expect {
+      expect(subject).to have_one(:foo).as(:bar)
+    }.to fail_with("expected #{ subject } 'has_one :foo' association to explicitly have key :bar but instead has none")
+  end
+end
+
+shared_examples 'it has_one :foo and no serializer' do
+  it 'should fail a have_one :foo serialized with FooSerializer expectation' do
+    expect {
+      expect(subject).to have_one(:foo).serialized_with(FooSerializer)
+    }.to fail_with("expected #{ subject } 'has_one :foo' association to explicitly have serializer FooSerializer but instead has none")
+  end
+end
+
+shared_examples 'it has_one :foo with key :bar' do
+  it 'should pass a have_one :foo as :bar expectation' do
+    expectation = have_one(:foo).as(:bar)
+    expect(subject).to expectation
+    expect(expectation.description).to eq('have one :foo as :bar')
+  end
+
+  it 'should fail a have_one :foo as :bor expectation' do
+    expect {
+      expect(subject).to have_one(:foo).as(:bor)
+    }.to fail_with("expected #{ subject } 'has_one :foo' association to explicitly have key :bor but instead was :bar")
+  end
+end
+
+shared_examples 'it has_one :foo with serializer FooSerializer' do
+  it 'should pass a have_one :foo as :bar expectation' do
+    expectation = have_one(:foo).serialized_with(FooSerializer)
+    expect(subject).to expectation
+    expect(expectation.description).to eq('have one :foo serialized with FooSerializer')
+  end
+
+  it 'should fail a have_one :foo serialized with FooSerializer expectation' do
+    expect {
+      expect(subject).to have_one(:foo).serialized_with(BarSerializer)
+    }.to fail_with("expected #{ subject } 'has_one :foo' association to explicitly have serializer BarSerializer but instead was FooSerializer")
+  end
+end
+
+shared_examples 'it has_many :foos' do
+  it 'should pass a have_many :foos expectation' do
+    expectation = have_many(:foos)
+    expect(subject).to expectation
+    expect(expectation.description).to eq('have many :foos')
+  end
+
+  it 'should fail a have_many :fuus expectation' do
+    expect {
+      expect(subject).to have_many(:fuus)
+    }.to fail_with("expected #{ subject } to define a 'has_many :fuus' association")
+  end
+
+  it 'should fail a have_one :foos expectation' do
+    expect {
+      expect(subject).to have_one(:foos)
+    }.to fail_with("expected #{ subject } to define a 'has_one :foos' association")
+  end
+end
+
+shared_examples 'it has_many :foos and no key' do
+  it 'should fail a have_many :foos as :bars expectation' do
+    expect {
+      expect(subject).to have_many(:foos).as(:bars)
+    }.to fail_with("expected #{ subject } 'has_many :foos' association to explicitly have key :bars but instead has none")
+  end
+end
+
+shared_examples 'it has_many :foos and no serializer' do
+  it 'should fail a have_many :foos serialized with FooSerializer expectation' do
+    expect {
+      expect(subject).to have_many(:foos).serialized_with(FooSerializer)
+    }.to fail_with("expected #{ subject } 'has_many :foos' association to explicitly have serializer FooSerializer but instead has none")
+  end
+end
+
+shared_examples 'it has_many :foos with key :bars' do
+  it 'should pass a have_many :foos as :bars expectation' do
+    expectation = have_many(:foos).as(:bars)
+    expect(subject).to expectation
+    expect(expectation.description).to eq('have many :foos as :bars')
+  end
+
+  it 'should fail a have_many :foos as :bors expectation' do
+    expect {
+      expect(subject).to have_many(:foos).as(:bors)
+    }.to fail_with("expected #{ subject } 'has_many :foos' association to explicitly have key :bors but instead was :bars")
+  end
+end
+
+shared_examples 'it has_many :foos with serializer FooSerializer' do
+  it 'should pass a have_many :foos as :bar expectation' do
+    expectation = have_many(:foos).serialized_with(FooSerializer)
+    expect(subject).to expectation
+    expect(expectation.description).to eq('have many :foos serialized with FooSerializer')
+  end
+
+  it 'should fail a have_many :foos serialized with FooSerializer expectation' do
+    expect {
+      expect(subject).to have_many(:foos).serialized_with(BarSerializer)
+    }.to fail_with("expected #{ subject } 'has_many :foos' association to explicitly have serializer BarSerializer but instead was FooSerializer")
+  end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers_matchers
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Tony Ta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-25 00:00:00.000000000 Z
+date: 2014-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
@@ -67,21 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
-  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: pry-byebug
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: These matchers will allow you to test associations between serializers.
+description: RSpec Matchers for ActiveModel::Serializer Associations
 email:
 - tonyta.tt@gmail.com
 executables: []
@@ -103,19 +89,21 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - active_model_serializers_matchers.gemspec
 - lib/active_model_serializers_matchers.rb
-- lib/active_model_serializers_matchers/have_many_association_matcher.rb
-- lib/active_model_serializers_matchers/have_one_association_matcher.rb
+- lib/active_model_serializers_matchers/association_matcher.rb
 - lib/active_model_serializers_matchers/version.rb
-- spec/active_model_serializers_matchers/have_many_association_matcher_spec.rb
-- spec/active_model_serializers_matchers/have_one_association_matcher_spec.rb
+- spec/active_model_serializers_matchers/association_matcher_spec.rb
 - spec/active_model_serializers_matchers_spec.rb
 - spec/spec_helper.rb
+- spec/support/dummy_serializers.rb
+- spec/support/rspec_fail_matchers.rb
+- spec/support/shared_examples.rb
 homepage: ''
 licenses:
 - MIT
@@ -128,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -136,12 +124,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: RSpec matchers for testing ActiveModel::Serializer
+summary: These matchers will allow you to test associations between serializers.
 test_files:
-- spec/active_model_serializers_matchers/have_many_association_matcher_spec.rb
-- spec/active_model_serializers_matchers/have_one_association_matcher_spec.rb
+- spec/active_model_serializers_matchers/association_matcher_spec.rb
 - spec/active_model_serializers_matchers_spec.rb
 - spec/spec_helper.rb
+- spec/support/dummy_serializers.rb
+- spec/support/rspec_fail_matchers.rb
+- spec/support/shared_examples.rb

data/lib/active_model_serializers_matchers/have_many_association_matcher.rb

@@ -1,83 +0,0 @@
-module ActiveModelSerializersMatchers
-  class HaveManyAssociationMatcher
-    attr_accessor :actual, :root, :key, :serializer, :key_check, :serializer_check
-
-    def initialize(root)
-      @root             = root
-      @key_check        = false
-      @serializer_check = false
-    end
-
-    def matches?(actual)
-      @actual = actual.is_a?(Class) ? actual : actual.class
-      match_association? && match_key? && match_serializer?
-    end
-
-    def as(key)
-      self.key_check = true
-      self.key = key
-      self
-    end
-
-    def serialized_with(serializer)
-      self.serializer_check = true
-      self.serializer = serializer
-      self
-    end
-
-    def description
-      msg = "have many #{root}"
-      msg << " as \"#{key}\"" if key_check
-      msg << " serialized with #{serializer}" if serializer_check
-      msg
-    end
-
-    def failure_message
-      if match_association?
-        "expected #{actual} association options for #{root}: #{root_association.options} to include: #{expected_association}"
-      else
-        "expected #{actual} associations: #{associations} to include: {#{root.inspect}=>(subclass of ActiveModel::Serializer::Associations::HasMany)}"
-      end
-    end
-
-    def failure_message_when_negated
-      if match_association?
-        "expected #{actual} associations: #{associations} to not include: {#{root.inspect}=>(subclass of ActiveModel::Serializer::Associations::HasMany)}"
-      else
-        "expected #{actual} association options for #{root}: #{root_association.options} to not include: #{expected_options}"
-      end
-    end
-
-    def expected_options
-      expected = { root: root }
-      expected[:key] = key if key_check
-      expected[:serializer] = serializer if serializer_check
-      expected
-    end
-
-    private
-
-    def associations
-      actual._associations
-    end
-
-    def root_association
-      associations[root]
-    end
-
-    def match_association?
-      return false if root_association.nil?
-      root_association.superclass == ActiveModel::Serializer::Associations::HasMany
-    end
-
-    def match_key?
-      return true unless key_check
-      root_association.options[:key] == key
-    end
-
-    def match_serializer?
-      return true unless serializer_check
-      root_association.options[:serializer].to_s == serializer.to_s
-    end
-  end
-end

data/lib/active_model_serializers_matchers/have_one_association_matcher.rb

@@ -1,83 +0,0 @@
-module ActiveModelSerializersMatchers
-  class HaveOneAssociationMatcher
-    attr_accessor :actual, :root, :key, :serializer, :key_check, :serializer_check
-
-    def initialize(root)
-      @root             = root
-      @key_check        = false
-      @serializer_check = false
-    end
-
-    def matches?(actual)
-      @actual = actual.is_a?(Class) ? actual : actual.class
-      match_association? && match_key? && match_serializer?
-    end
-
-    def as(key)
-      self.key_check = true
-      self.key = key
-      self
-    end
-
-    def serialized_with(serializer)
-      self.serializer_check = true
-      self.serializer = serializer
-      self
-    end
-
-    def description
-      msg = "have one #{root}"
-      msg << " as \"#{key}\"" if key_check
-      msg << " serialized with #{serializer}" if serializer_check
-      msg
-    end
-
-    def failure_message
-      if match_association?
-        "expected #{actual} association options for #{root}: #{root_association.options} to include: #{expected_association}"
-      else
-        "expected #{actual} associations: #{associations} to include: {#{root.inspect}=>(subclass of ActiveModel::Serializer::Associations::HasOne)}"
-      end
-    end
-
-    def failure_message_when_negated
-      if match_association?
-        "expected #{actual} associations: #{associations} to not include: {#{root.inspect}=>(subclass of ActiveModel::Serializer::Associations::HasOne)}"
-      else
-        "expected #{actual} association options for #{root}: #{root_association.options} to not include: #{expected_options}"
-      end
-    end
-
-    def expected_options
-      expected = { root: root }
-      expected[:key] = key if key_check
-      expected[:serializer] = serializer if serializer_check
-      expected
-    end
-
-    private
-
-    def associations
-      actual._associations
-    end
-
-    def root_association
-      associations[root]
-    end
-
-    def match_association?
-      return false if root_association.nil?
-      root_association.superclass == ActiveModel::Serializer::Associations::HasOne
-    end
-
-    def match_key?
-      return true unless key_check
-      root_association.options[:key] == key
-    end
-
-    def match_serializer?
-      return true unless serializer_check
-      root_association.options[:serializer].to_s == serializer.to_s
-    end
-  end
-end