spectus 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96fa46cd60fb62f1704a8dbf1dbe3b5519b1981f
+  data.tar.gz: 5ade56a1a4865de27fe71781c3fd21853d94dd8a
+SHA512:
+  metadata.gz: 2ba1d3381e9c4f408e6f188c204582b11752119c8ee5fbca13e306ecfe93142cb4d7531bf2711ce768d9c38801b75228506de0a4e18edd8e4462531ecee2699f
+  data.tar.gz: db138bad384985792d3c480403a7881596a7334feca59618dd9146a265f1d4725fcd43bf20c331bb9a49be59b5276f82c149534147b10339d26f667d129146fa

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: 'bundle exec rake test:coverage'
+rvm:
+  - 2.0.0
+  - 2.1.3
+  - ruby-head

data/.yardopts

@@ -0,0 +1 @@
+- README.md

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cyril Wack
+
+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,239 @@
+# Spectus
+
+[![Build Status](https://travis-ci.org/cyril/spectus.rb.svg?branch=master)](https://travis-ci.org/cyril/spectus.rb)
+[![Coverage Status](http://img.shields.io/coveralls/cyril/spectus.rb.svg?branch=master)](https://coveralls.io/r/cyril/spectus.rb)
+[![Code Climate](http://img.shields.io/codeclimate/github/cyril/spectus.rb.svg)](https://codeclimate.com/github/cyril/spectus.rb)
+[![Dependency Status](https://gemnasium.com/cyril/spectus.rb.svg)](https://gemnasium.com/cyril/spectus.rb)
+[![Gem Version](http://img.shields.io/gem/v/spectus.svg)](https://rubygems.org/gems/spectus)
+[![Inline docs](http://inch-ci.org/github/cyril/spectus.rb.svg)](http://inch-ci.org/github/cyril/spectus.rb)
+[![Documentation](http://img.shields.io/:yard-docs-38c800.svg)](http://rubydoc.info/gems/spectus/frames)
+[![License](http://img.shields.io/:license-MIT-38c800.svg)](http://cyril.mit-license.org/)
+
+> An expectation library with some built-in matchers for Ruby.
+
+## Contact
+
+* Home page: https://github.com/cyril/spectus.rb
+* Bugs/issues: https://github.com/cyril/spectus.rb/issues
+* Support: https://stackoverflow.com/questions/tagged/spectus-ruby
+
+## Rubies
+
+__Spectus__ is supported by Ruby (MRI) 2+.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spectus'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install spectus
+```
+
+## Why would I want this library?
+
+* It's ~200 lines of fast and KISS code.
+* Atomic state transitions, immutable objects, thread-safe.
+* A generic, consistent DSL for assertions.
+
+## Usage
+
+```ruby
+class Duck
+  def walks
+    "Klop klop!"
+  end
+
+  def swims
+    "Swoosh..."
+  end
+
+  def quacks
+    puts "Quaaaaaack!"
+  end
+end
+
+@bird = Duck.new
+```
+
+> When I see a #<Duck:0x007f96b285d6d0> that ...
+
+```ruby
+require 'spectus'
+extend Spectus::DSL
+
+expectation_1 = expect { @bird.walks  }.to eql: "Klop klop!"
+expectation_2 = expect { @bird.swims  }.to eql: "Swoosh..."
+expectation_3 = expect { @bird.quacks }.to capture_stdout: "Quaaaaaack!\n"
+expectation_4 = expect { @bird.speaks }.to raise_exception: NoMethodError
+
+case (expectation_1.pass? &&
+      expectation_2.pass? &&
+      expectation_3.pass? &&
+      expectation_4.pass?)
+  when true then puts "I call that #{@bird} a duck."
+  else warn 'WAT?'
+end
+```
+
+> I call that #<Duck:0x007f96b285d6d0> a duck.
+
+## Built-in matchers
+
+### Standard error
+
+```ruby
+expect { warn 'foo' }.to capture_stderr: "foo\n"
+```
+
+### Standard output
+
+```ruby
+expect { puts 'foo' }.to capture_stdout: "foo\n"
+```
+
+### Equivalence
+
+```ruby
+expect { 'foo' }.to eql: 'foo'
+```
+
+### Identity
+
+```ruby
+expect { :foo }.to equal: :foo
+```
+
+### Regular expressions
+
+```ruby
+expect { 'foo' }.to({match: /^foo$/})
+```
+
+### Expecting errors
+
+```ruby
+expect { Foo }.to raise_exception: NameError
+```
+
+## Custom matchers
+
+Custom matchers can also be defined for expressing expectations.
+
+### Be prime
+
+The following expression...
+
+```ruby
+require 'prime'
+expect { Prime.prime? 42 }.to equal: false
+```
+
+...could be refactored into:
+
+```ruby
+expect { 42 }.not_to :be_prime
+```
+
+It can be done with this custom matcher:
+
+```ruby
+require 'prime'
+
+module Spectus
+  module Matcher
+    class BePrime
+      def matches?
+        Prime.prime? yield
+      end
+    end
+  end
+end
+```
+
+### Be the answer
+
+The following expression...
+
+```ruby
+expect { 42 }.to equal: 42
+```
+
+...could be refactored into:
+
+```ruby
+expect { 42 }.to :be_the_answer
+```
+
+It can be done with this custom matcher:
+
+```ruby
+module Spectus
+  module Matcher
+    class BeTheAnswer
+      def matches?
+        42.equal? yield
+      end
+    end
+  end
+end
+```
+
+### Start with
+
+The following expression...
+
+```ruby
+expect { 'foobar' }.to match: /^foo/
+```
+
+...could be refactored into:
+
+```ruby
+expect { 'foobar' }.to start_with: 'foo'
+```
+
+It can be done with this custom matcher:
+
+```ruby
+module Spectus
+  module Matcher
+    class StartWith
+      def initialize expected
+        @expected = expected
+      end
+
+      def matches?
+        !Regexp.new("^#{@expected}").match(yield).nil?
+      end
+    end
+  end
+end
+```
+
+## Contributing
+
+1. [Fork it](https://github.com/cyril/spectus.rb/fork)
+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 a new Pull Request
+
+## Versioning
+
+__Spectus__ follows [Semantic Versioning 2.0](http://semver.org/)
+
+## Copyright
+
+&copy; [Cyril Wack](https://plus.google.com/+CyrilWack?rel=author)

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = File.join 'test', '**', 'test_*.rb'
+  t.verbose = true
+  t.warning = true
+end
+
+namespace :test do
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].invoke
+  end
+end
+
+task(:doc_stats) { ruby '-S yard stats' }
+task default: [:test, :doc_stats]

data/VERSION.semver

@@ -0,0 +1 @@
+1.0.0.pre

data/lib/spectus.rb

@@ -0,0 +1,6 @@
+require_relative File.join 'spectus', 'dsl'
+require_relative File.join 'spectus', 'version'
+
+# Namespace for the Spectus library.
+module Spectus
+end

data/lib/spectus/dsl.rb

@@ -0,0 +1,14 @@
+require_relative 'expectation_target'
+
+module Spectus
+
+  # Expectation's domain-specific language.
+  module DSL
+
+    # Expectations are built with this method which takes a value, called the
+    # actual.
+    def expect &input
+      ExpectationTarget.new(&input)
+    end
+  end
+end

data/lib/spectus/expectation_target.rb

@@ -0,0 +1,27 @@
+require_relative 'matcher'
+
+module Spectus
+
+  # Wraps the target of an expectation.
+  #
+  # @example
+  #   expect { do_something } # => ExpectationTarget wrapping the block
+  class ExpectationTarget
+    # @api private
+    def initialize &actual
+      @actual = actual
+
+      freeze
+    end
+
+    # To evaluate to a positive assertion.
+    def to definition
+      Matcher.eval false, definition, &@actual
+    end
+
+    # To evaluate to a negative assertion.
+    def not_to definition
+      Matcher.eval true, definition, &@actual
+    end
+  end
+end

data/lib/spectus/matcher.rb

@@ -0,0 +1,35 @@
+require_relative 'reporter'
+
+module Spectus
+
+  # This module provides matchers to define expectations.
+  module Matcher
+
+    # Evaluate the expectation, and report the result.
+    def self.eval negated, definition, &actual
+      params        = Array(definition).flatten(1)
+      name          = params.first
+      expected_args = params[1..-1]
+      matcher       = Matcher.get(name).new(*expected_args)
+
+      Reporter.new negated, name, *expected_args, begin
+        negated ^ matcher.matches?(&actual)
+      rescue => e
+        e
+      end
+    end
+
+    # Get the class of a matcher from its symbol.
+    #
+    # @example
+    #
+    #   Matcher.get(:eql) # => Eql
+    def self.get name
+      const_get name.to_s.split('_').map {|w| w.capitalize }.join.to_sym
+    end
+  end
+end
+
+Dir[File.join File.dirname(__FILE__), 'matcher', '*.rb'].each do |filename|
+  require_relative filename
+end

data/lib/spectus/matcher/capture_stderr.rb

@@ -0,0 +1,31 @@
+require 'stringio'
+
+module Spectus
+  module Matcher
+
+    # @api private
+    # Provides the implementation for `capture_stderr`.
+    class CaptureStderr
+
+      # @api private
+      def initialize expected
+        @expected = expected
+
+        freeze
+      end
+
+      # @return [Boolean] Comparison between actual and expected values.
+      def matches?
+        begin
+          orig_std  = $stderr
+          $stderr   = StringIO.new
+
+          yield
+          $stderr.string.eql? @expected
+        ensure
+          $stderr   = orig_std
+        end
+      end
+    end
+  end
+end