spec_combos 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70820418ff04ef8f2f40f0382ba4ed28d2375211
+  data.tar.gz: 4adfb37fcde42123dad029c4514c40ba651b3dfa
+SHA512:
+  metadata.gz: 6ac030cb28dc2164a38fb605440a0ad0dd4bfac1dcf869ed9a615e79c6a3bd938ccbd4637eace6db9cf8d98f06bddf5bc34c30d65063a1cc6aa169038436066a
+  data.tar.gz: c6fced32dc8f7eb9b20777ba55074996fa5977fa136ffe2c9c9def008d9e4b6374d8d862bb5d1eb2a3ee3ed98161fa95236d00137c43a79345cce76e83c600e7

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+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/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - jruby-20mode
+  - rbx-19mode
+  - rbx-20mode
+script: bundle exec rake

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Philippe Bourgau
+
+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,49 @@
+# SpecCombos
+
+Rspec matchers that can combine other matchers together, to allow precise testing elements of a sequence for example. The goal is to get :
+
+* concise and readable specs
+* factorized code
+* explicit assertion failure messages
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spec_combos'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spec_combos
+
+## Usage
+
+The matchers can be used like any matcher, just taking other matchers as arguments.
+
+### All matcher
+
+    expect([1,3,5]).to all_ { be_odd }
+
+### Any matcher
+
+    expect([2,1,4]).to have_any_that { be_odd }
+
+### And matcher
+
+    expect(2).to and_(be_even, be_instance_of(Fixnum))
+
+It can be composed with 'any' or 'all' matchers :
+
+    expect([1,3,5]).to all_ { and_(be_odd, be_instance_of(Fixnum)) }
+
+## 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,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/spec_combos.rb

@@ -0,0 +1,7 @@
+require "spec_combos/version"
+require "spec_combos/matcher_combiner"
+require "spec_combos/collection_matcher"
+require "spec_combos/all_matcher"
+require "spec_combos/any_matcher"
+require "spec_combos/and_matcher"
+

data/lib/spec_combos/all_matcher.rb

@@ -0,0 +1,27 @@
+module SpecCombos
+
+  # Matcher to verify that all items match something else
+  class AllMatcher
+    include MatcherCombiner
+    include MatcherCombiner::And
+    include CollectionMatcher
+
+    private
+
+    def short_description
+      "all"
+    end
+
+    def failure_summary_for_should
+      "expected #{actual_items} to #{description}, but the following were not:"
+    end
+
+    def failure_summary_for_should_not
+      "expected #{actual_items} not to #{description}, but all were:"
+    end
+  end
+end
+
+def all_(&item_matcher_proc)
+  SpecCombos::AllMatcher.new(&item_matcher_proc)
+end

data/lib/spec_combos/and_matcher.rb

@@ -0,0 +1,44 @@
+module SpecCombos
+
+  # Matcher to verify that an item matches all matchers in a list
+  class AndMatcher
+    include MatcherCombiner
+    include MatcherCombiner::And
+
+    def initialize(*matchers)
+      @matchers = matchers
+    end
+
+    def description
+      descriptions = @matchers.map &:description
+
+      if descriptions.size <= 2
+        descriptions.join(" and ")
+      else
+        descriptions[0..-2].join(", ") + " and " + descriptions.last
+      end
+    end
+
+    private
+
+    def perform_matches(actual)
+      @matchers.map do |matcher|
+        { matcher: matcher,
+          match: matcher.matches?(actual)}
+      end
+    end
+
+    def failure_summary_for_should
+      "expected #{actual} to #{description}, but:"
+    end
+
+    def failure_summary_for_should_not
+      "expected #{actual} not to #{description}, but it is all:"
+    end
+
+  end
+end
+
+def and_(*matchers)
+  SpecCombos::AndMatcher.new(*matchers)
+end

data/lib/spec_combos/any_matcher.rb

@@ -0,0 +1,28 @@
+module SpecCombos
+
+  # Matcher to verify that all items match something else
+  class AnyMatcher
+    include MatcherCombiner
+    include MatcherCombiner::Or
+    include CollectionMatcher
+
+    private
+
+    def short_description
+      "have any that"
+    end
+
+    def failure_summary_for_should
+      "expected #{actual_items} to #{description}, but none were:"
+    end
+
+    def failure_summary_for_should_not
+      "expected #{actual_items} not to #{description}, but the following were:"
+    end
+  end
+end
+
+def any_(&item_matcher_proc)
+  SpecCombos::AnyMatcher.new(&item_matcher_proc)
+end
+alias :have_any_that :any_

data/lib/spec_combos/collection_matcher.rb

@@ -0,0 +1,39 @@
+module SpecCombos
+
+  # Mixin for the :and and :any collection matchers
+  module CollectionMatcher
+
+    def initialize(&item_matcher_proc)
+      @item_matcher_proc = item_matcher_proc
+    end
+
+    def description
+      "#{short_description} #{new_matcher.description}"
+    end
+
+    private
+
+    def perform_matches(actual_items)
+      actual_items.each_with_index.map do |item, index|
+        matcher = new_matcher
+        { index: index,
+          item: item,
+          matcher: matcher,
+          match: matcher.matches?(item)}
+      end
+    end
+
+    def new_matcher
+      @item_matcher_proc.call
+    end
+
+    def failure_message_prefix(failure)
+      "[#{failure[:index]}] (#{failure[:item]}): "
+    end
+
+    def actual_items
+      @actual
+    end
+
+  end
+end

data/lib/spec_combos/matcher_combiner.rb

@@ -0,0 +1,74 @@
+module SpecCombos
+
+  module MatcherCombiner
+
+    module And
+      def match_result
+        matches(NOT_MATCHING).empty?
+      end
+    end
+
+    module Or
+      def match_result
+        !matches(MATCHING).empty?
+      end
+    end
+
+    def matches?(actual)
+      @actual = actual
+      @match_details = perform_matches(actual)
+      match_result
+    end
+
+    def failure_message_for_should
+      failure_message(MATCHING, failure_summary_for_should)
+    end
+
+    def failure_message_for_should_not
+      failure_message(NOT_MATCHING, failure_summary_for_should_not)
+    end
+
+    private
+
+    attr_reader :actual
+
+    MATCHING = true
+    NOT_MATCHING = false
+    INDENT_WIDTH = 2
+
+    def failure_message(expected_match, summary)
+      summary + "\n" + indent(full_explanation(expected_match), INDENT_WIDTH)
+    end
+    def full_explanation(expected_match)
+      explanations(!expected_match).join("\n")
+    end
+    def explanations(expected_match)
+      matches(expected_match).map {|failure| explain(failure)}
+    end
+    def explain(failure)
+      failure_message_prefix(failure) + message(failure)
+    end
+    def failure_message_prefix(failure)
+      ""
+    end
+    def message(failure)
+      failure[:matcher].send(message_selector(failure))
+    end
+    def message_selector(failure)
+      if failure[:match]
+        :failure_message_for_should_not
+      else
+        :failure_message_for_should
+      end
+    end
+
+    def matches(expected_match)
+      @match_details.find_all {|detail| detail[:match] == expected_match}
+    end
+
+    def indent(text, tabs)
+      text.gsub(/^/, ' ' * tabs)
+    end
+  end
+
+end

data/lib/spec_combos/version.rb

@@ -0,0 +1,3 @@
+module SpecCombos
+  VERSION = "0.2.0"
+end

data/spec/lib/spec_combos/all_matcher_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module SpecCombos
+
+  describe AllMatcher do
+    it 'matches collections with all matching elements' do
+      expect([1,3,5]).to all_ { be_odd }
+    end
+
+    it 'does not match collections where not all elements match' do
+      expect([3,5,6]).not_to all_ { be_odd }
+    end
+
+    it "has a straigtforward description" do
+      matcher = all_ { be_odd }
+
+      expect(matcher.description).to eq "all #{be_odd.description}"
+    end
+
+    it 'has an explicit should message' do
+      expect do
+        expect([1,2,3]).to all_ { be_odd }
+
+      end.to raise_error(RSpec::Expectations::ExpectationNotMetError,
+                         "expected [1, 2, 3] to all be odd, but the following were not:\n" +
+                         "  [1] (2): expected odd? to return true, got false")
+    end
+
+    it 'has an explicit should not message' do
+      expect do
+        expect([1,3]).not_to all_ { be_odd }
+
+      end.to raise_error(RSpec::Expectations::ExpectationNotMetError,
+                         "expected [1, 3] not to all be odd, but all were:\n" +
+                         "  [0] (1): expected odd? to return false, got true\n" +
+                         "  [1] (3): expected odd? to return false, got true")
+    end
+  end
+end

data/spec/lib/spec_combos/and_matcher_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module SpecCombos
+
+  describe AndMatcher do
+    it 'matches items that matches all matchers' do
+      expect(2).to and_(be_even,
+                        be_instance_of(Fixnum))
+    end
+
+    it "does not match items that don't match all matchers" do
+      expect(2).not_to and_(be_odd,
+                            be_even)
+    end
+
+    it "has a straigtforward description" do
+      matcher = and_(be_odd, be_even)
+
+      expect(matcher.description).to eq "#{be_odd.description} and #{be_even.description}"
+    end
+
+    it "does not repeat 'and' in the description" do
+      matcher = and_(be_odd, be_even, be_instance_of(Fixnum))
+
+      expect(matcher.description).to eq "#{be_odd.description}, #{be_even.description} and #{be_instance_of(Fixnum).description}"
+    end
+
+    it 'has an explicit should message' do
+      expect do
+        expect(1).to and_(be_odd, be_even)
+
+      end.to raise_error(RSpec::Expectations::ExpectationNotMetError,
+                         "expected 1 to be odd and be even, but:\n" +
+                         "  expected even? to return true, got false")
+    end
+
+    it 'has an explicit should not message' do
+      expect do
+        expect(2).not_to and_(be_even, be_instance_of(Fixnum))
+
+      end.to raise_error(RSpec::Expectations::ExpectationNotMetError,
+                         "expected 2 not to be even and be an instance of Fixnum, but it is all:\n" +
+                         "  expected even? to return false, got true\n" +
+                         "  expected 2 not to be an instance of Fixnum")
+    end
+  end
+end

data/spec/lib/spec_combos/any_matcher_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module SpecCombos
+
+  describe AnyMatcher do
+    it 'matches collections with at least one matching element' do
+      expect([2,3,4]).to have_any_that { be_odd }
+    end
+
+    it 'does not match collections where no element match' do
+      expect([2,4,6]).not_to have_any_that { be_odd }
+    end
+
+    it "has a straigtforward description" do
+      matcher = have_any_that { be_odd }
+
+      expect(matcher.description).to eq "have any that #{be_odd.description}"
+    end
+
+    it 'has an explicit should message' do
+      expect do
+        expect([0,2]).to have_any_that { be_odd }
+
+      end.to raise_error(RSpec::Expectations::ExpectationNotMetError,
+                         "expected [0, 2] to have any that be odd, but none were:\n" +
+                         "  [0] (0): expected odd? to return true, got false\n" +
+                         "  [1] (2): expected odd? to return true, got false")
+    end
+
+    it 'has an explicit should not message' do
+      expect do
+        expect([1,4,6]).not_to have_any_that { be_odd }
+
+      end.to raise_error(RSpec::Expectations::ExpectationNotMetError,
+                         "expected [1, 4, 6] not to have any that be odd, but the following were:\n" +
+                         "  [0] (1): expected odd? to return false, got true")
+    end
+  end
+end

data/spec/lib/spec_combos/matcher_combiner_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module SpecCombos
+
+  describe MatcherCombiner do
+    it 'can combine :all_ and :and_ matcher messages correctly' do
+      expect do
+        expect([1,2,3]).to all_{and_(be_odd, be_instance_of(Fixnum))}
+
+      end.to raise_error(RSpec::Expectations::ExpectationNotMetError,
+                         "expected [1, 2, 3] to all be odd and be an instance of Fixnum, but the following were not:\n"+
+                         "  [1] (2): expected 2 to be odd and be an instance of Fixnum, but:\n"+
+                         "    expected odd? to return true, got false")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'spec_combos'

data/spec_combos.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spec_combos/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spec_combos"
+  spec.version       = SpecCombos::VERSION
+  spec.authors       = ["Philou"]
+  spec.email         = ["philippe.bourgau@gmail.com"]
+  spec.description   = %q{Rspec matchers to combine matchers together}
+  spec.summary       = %q{Allows to build up matchers able to precisely match item from a collection for example}
+  spec.homepage      = "http://github.com/philou/spec_combos"
+  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_dependency "rspec", "~> 2.11"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "guard-rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: spec_combos
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Philou
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDkjCCAnqgAwIBAgIBATANBgkqhkiG9w0BAQUFADBHMRkwFwYDVQQDDBBwaGls
+  aXBwZS5ib3VyZ2F1MRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/Is
+  ZAEZFgNjb20wHhcNMTMwOTIzMTEwOTA3WhcNMTQwOTIzMTEwOTA3WjBHMRkwFwYD
+  VQQDDBBwaGlsaXBwZS5ib3VyZ2F1MRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzAR
+  BgoJkiaJk/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
+  AQC8CpoqZwEbzXr55EUxdSplgn0MYZ9xPGO/XmRa8bD63n+JYWF0AS+mj452ZY18
+  rwM+yKrKhtsA+aJJdlOafgIUnY5SrZOr7v7kgc6T2YNoUj+M00Um2jv+shQbOtV6
+  qGp0Jw1HfPNUMVa+3pXZyAGCecN6rTnsZJIuW6KNaJUq6lEMVXanoTHgAKrH5aHd
+  Y6ofwQL86d6LDkC1S4p86iMUWvF34w8h5ItVo+JKlPRR22rzsK/ZKgNH3lfjbS6i
+  JWqPva70rL2xz5kCVn6DL7XhNZtqnAO4kvCQyQeWezvcoGXEnbHacKky7B+/WKec
+  OIWEwedl6j+X0OD5OYki3QaTAgMBAAGjgYgwgYUwCQYDVR0TBAIwADALBgNVHQ8E
+  BAMCBLAwHQYDVR0OBBYEFJnLz40Onu/dfpLSipU5FgTy6WLmMCUGA1UdEQQeMByB
+  GnBoaWxpcHBlLmJvdXJnYXVAZ21haWwuY29tMCUGA1UdEgQeMByBGnBoaWxpcHBl
+  LmJvdXJnYXVAZ21haWwuY29tMA0GCSqGSIb3DQEBBQUAA4IBAQBGoH72KWYACGZl
+  cMHMJ9d/DRU7rynJ8c4xuuM4c3Ri8bGPqI/a1BAp4QPJApS4+ANXXJ220hslrekP
+  9/ExEKFiqiywh1clih9ttuN4cHqJzCP6QHqJznQrvaYToZLxGARDf3Mwz4mFSh4W
+  snSep53DZ1vrY2Gzmig/4PuBF4q3nhwPgxV6H3SH4/Py7QF5COZPQlCdBwPYczqW
+  XxIbXhRVXcgjBHT0w2HsXkOwmmYvBzbrfqtTx5NswwHcIeQZB/NID7berIf9awx3
+  yLcl1cmm5ALtJ/+Bkkmp0i4amXeTDMvq9r8PBsVsQwxYOYJBP+Umxz3PX6HjFHrQ
+  XdkXx3oZ
+  -----END CERTIFICATE-----
+date: 2013-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Rspec matchers to combine matchers together
+email:
+- philippe.bourgau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spec_combos.rb
+- lib/spec_combos/all_matcher.rb
+- lib/spec_combos/and_matcher.rb
+- lib/spec_combos/any_matcher.rb
+- lib/spec_combos/collection_matcher.rb
+- lib/spec_combos/matcher_combiner.rb
+- lib/spec_combos/version.rb
+- spec/lib/spec_combos/all_matcher_spec.rb
+- spec/lib/spec_combos/and_matcher_spec.rb
+- spec/lib/spec_combos/any_matcher_spec.rb
+- spec/lib/spec_combos/matcher_combiner_spec.rb
+- spec/spec_helper.rb
+- spec_combos.gemspec
+homepage: http://github.com/philou/spec_combos
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Allows to build up matchers able to precisely match item from a collection
+  for example
+test_files:
+- spec/lib/spec_combos/all_matcher_spec.rb
+- spec/lib/spec_combos/and_matcher_spec.rb
+- spec/lib/spec_combos/any_matcher_spec.rb
+- spec/lib/spec_combos/matcher_combiner_spec.rb
+- spec/spec_helper.rb