spectus 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96536d6c2a867a9c5b529617dc77dae7116260f9
-  data.tar.gz: d4b4c8eb31aa8acf82e9c4168b257aa809cdbe95
+  metadata.gz: 3b29a968ab4babf3a903050203e7deb144040793
+  data.tar.gz: 88bceace4526d5b32086d8cffc4b0bafe0a63eea
 SHA512:
-  metadata.gz: dcf717c9763e6f17c6d5aa7649e70fdab32858fc909f8916a7a9a26dd6cb51ec5da739be759ef2f299f0c9a9eca9e4e8aeadcd239e1928c0006d5981c1e03054
-  data.tar.gz: 9db3be6caec7add9777241dc1e26919fe088056136d8ee342bd1d66f4e67bc091f32f2c72c2f84bbbf46a464f70668e15069b935ee55d0ca7d1b72db3db01ed6
+  metadata.gz: 33c4154ad5a8df2a17a18c150f8f08415cde517314b3b108ae25eb5e2150016d88653ff7a20e0bb0f6dd90e4daa4cdf4d443ec6e96da003cc8d0b5a3874ad506
+  data.tar.gz: 044277ab6398d8d44b2566b858cb394f22e75c6f8dcd09eae299e3beb3245c7c1304f2fb6966d925feb20f0f119e480b3d1635d5011688fc046c6142176ad660

data/README.md

@@ -41,8 +41,8 @@ $ gem install spectus
 
 ## Why would I want this library?
 
-* It's 194 lines of fast and KISS code.
-* Atomic state transitions, immutable objects, thread-safe.
+* It's 143 lines of fast and KISS code.
+* Atomic state transitions, unmutated objects, thread-safe.
 * Provides a generic and consistent DSL for assertions.
 
 ## API
@@ -53,7 +53,7 @@ It takes a block parameter and responds to:
 * `to(definition)`
 * `not_to(definition)`
 
-Then it returns `true`, `false`, or a cached exception.
+Then, it returns `true` or `false`; or it raises an exception.
 
 ## Usage
 
@@ -81,6 +81,29 @@ end
 require 'spectus'
 extend Spectus::DSL
 
+# Let's define the custom matcher `capture_stdout`.
+require 'stringio'
+module Spectus
+  module Matcher
+    class CaptureStdout
+      def initialize expected
+        @expected = expected
+      end
+
+      def matches?
+        begin
+          orig_std  = $stdout
+          $stdout   = StringIO.new
+          yield
+          $stdout.string.eql? @expected
+        ensure
+          $stdout   = orig_std
+        end
+      end
+    end
+  end
+end
+
 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"
@@ -99,18 +122,6 @@ end
 
 ## Built-in matchers
 
-### Standard error
-
-```ruby
-expect { warn 'foo' }.to capture_stderr: "foo\n" # => true
-```
-
-### Standard output
-
-```ruby
-expect { puts 'foo' }.to capture_stdout: "foo\n" # => true
-```
-
 ### Equivalence
 
 ```ruby

data/VERSION.semver

@@ -1 +1 @@
-1.0.1
+1.1.1

data/example/duck/app.rb

@@ -1,3 +1,3 @@
 require_relative 'lib'
 
-@app = Duck.new
+@bird = Duck.new

data/example/duck/lib.rb

@@ -1,11 +1,10 @@
 class Duck
   def walks
-    "Quaaa... Klop klop!"
+    "Klop klop!"
   end
 
   def swims
-    warn " ..."
-    "Quaaa.."
+    "Swoosh..."
   end
 
   def quacks

data/example/duck/test.rb

@@ -2,19 +2,42 @@
 
 require_relative 'app'
 
-require 'spectus'
+require_relative '../../lib/spectus'
 
 extend Spectus::DSL
 
-expectation_1 = expect { @app.swims  }.to capture_stderr: " ...\n"
-expectation_2 = expect { @app.quacks }.to capture_stdout: "Quaaaaaack!\n"
-expectation_3 = expect { @app.speaks }.to raise_exception: NoMethodError
-expectation_4 = expect { @app.walks  }.to eql: "Quaaa... Klop klop!"
+# Let's define the custom matcher `capture_stdout`.
+require 'stringio'
+module Spectus
+  module Matcher
+    class CaptureStdout
+      def initialize expected
+        @expected = expected
+      end
+
+      def matches?
+        begin
+          orig_std  = $stdout
+          $stdout   = StringIO.new
+          yield
+          $stdout.string.eql? @expected
+        ensure
+          $stdout   = orig_std
+        end
+      end
+    end
+  end
+end
+
+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 == true &&
       expectation_2 == true &&
       expectation_3 == true &&
       expectation_4 == true)
-  when true then puts "I call that #{@app} a duck."
+  when true then puts "I call that #{@bird} a duck."
   else abort 'WAT?'
 end

data/lib/spectus/expectation_target.rb

@@ -6,29 +6,27 @@ module Spectus
   #
   # @example
   #   expect { do_something } # => ExpectationTarget wrapping the block
-  class ExpectationTarget
+  class ExpectationTarget < BasicObject
     def initialize &actual
       @actual = actual
-
-      freeze
     end
 
     # Evaluate to a positive assertion.
     #
     # @api public
     #
-    # @see Matcher#eval
+    # @see Matcher#pass?
     def to definition
-      Matcher.eval false, definition, &@actual
+      Matcher.pass? false, definition, &@actual
     end
 
     # Evaluate to a negative assertion.
     #
     # @api public
     #
-    # @see Matcher#eval
+    # @see Matcher#pass?
     def not_to definition
-      Matcher.eval true, definition, &@actual
+      Matcher.pass? true, definition, &@actual
     end
   end
 end

data/lib/spectus/matcher.rb

@@ -8,18 +8,14 @@ module Spectus
     # @param [Boolean] negated
     # @param [Hash] definition
     #
-    # @return [ExceptionClass, false, true] true, false, or a cached exception.
-    def self.eval negated, definition, &actual
-      params        = Array(definition).flatten(1)
+    # @return [Boolean] Report if the expectation is true or false.
+    def self.pass? negated, definition, &actual
+      params        = Array(definition).flatten 1
       name          = params.first
       expected_args = params[1..-1]
       matcher       = Matcher.get(name).new(*expected_args)
 
-      begin
-        negated ^ matcher.matches?(&actual)
-      rescue => e
-        e
-      end
+      negated ^ matcher.matches?(&actual)
     end
 
     # Get the class of a matcher from its symbol.

data/lib/spectus/matcher/eql.rb

@@ -2,11 +2,9 @@ module Spectus
   module Matcher
 
     # Provides the implementation for `eql`.
-    class Eql
+    class Eql < BasicObject
       def initialize expected
         @expected = expected
-
-        freeze
       end
 
       # @return [Boolean] Comparison between actual and expected values.

data/lib/spectus/matcher/equal.rb

@@ -2,11 +2,9 @@ module Spectus
   module Matcher
 
     # Provides the implementation for `equal`.
-    class Equal
+    class Equal < BasicObject
       def initialize expected
         @expected = expected
-
-        freeze
       end
 
       # @return [Boolean] Comparison between actual and expected values.

data/lib/spectus/matcher/match.rb

@@ -2,11 +2,9 @@ module Spectus
   module Matcher
 
     # Provides the implementation for `match`.
-    class Match
+    class Match < BasicObject
       def initialize expected
         @expected = expected
-
-        freeze
       end
 
       # @return [Boolean] Comparison between actual and expected values.

data/lib/spectus/matcher/raise_exception.rb

@@ -2,11 +2,9 @@ module Spectus
   module Matcher
 
     # Provides the implementation for `raise_exception`.
-    class RaiseException
+    class RaiseException < BasicObject
       def initialize expected
         @expected = expected
-
-        freeze
       end
 
       # @return [Boolean] Comparison between actual and expected values.

data/test/spectus/matcher/built_in/test_eql.rb

@@ -4,15 +4,15 @@ subject 'eql built-in matcher' do
   Spectus::Matcher::Eql.new 'foo'
 end
 
-it 'must return the expected value' do
-  expect { subject.instance_variable_get(:@expected) }.to eql: 'foo'
-end
-
 it 'must be eql' do
   expect { subject.matches? { 'foo' } }.to equal: true
 end
 
 it 'must not be eql' do
+  expect { subject.matches? { 'bar' } }.not_to equal: true
+end
+
+it 'must return false' do
   expect { subject.matches? { 'bar' } }.to equal: false
 end
 

data/test/spectus/matcher/built_in/test_equal.rb

@@ -4,15 +4,15 @@ subject 'equal built-in matcher' do
   Spectus::Matcher::Equal.new :foo
 end
 
-it 'must return the expected value' do
-  expect { subject.instance_variable_get(:@expected) }.to equal: :foo
-end
-
 it 'must be equal' do
   expect { subject.matches? { :foo } }.to equal: true
 end
 
 it 'must not be equal' do
+  expect { subject.matches? { :bar } }.not_to equal: true
+end
+
+it 'must return false' do
   expect { subject.matches? { :bar } }.to equal: false
 end
 

data/test/spectus/matcher/built_in/test_match.rb

@@ -4,15 +4,15 @@ subject 'match built-in matcher' do
   Spectus::Matcher::Match.new(/^foo/)
 end
 
-it 'must return the expected value' do
-  expect { subject.instance_variable_get(:@expected) }.to({eql: /^foo/})
-end
-
 it 'must match the string' do
   expect { subject.matches? { 'foobar' } }.to equal: true
 end
 
 it 'must not match the string' do
+  expect { subject.matches? { 'bar' } }.not_to equal: true
+end
+
+it 'must return false' do
   expect { subject.matches? { 'bar' } }.to equal: false
 end
 

data/test/spectus/matcher/built_in/test_raise_exception.rb

@@ -4,15 +4,15 @@ subject 'raise exception built-in matcher' do
   Spectus::Matcher::RaiseException.new ZeroDivisionError
 end
 
-it 'must return the expected value' do
-  expect { subject.instance_variable_get(:@expected) }.to equal: ZeroDivisionError
-end
-
 it 'must raise the expected exception' do
   expect { subject.matches? { 0 / 0 } }.to equal: true
 end
 
 it 'must not raise any exceptions' do
+  expect { subject.matches? { :foo } }.not_to equal: true
+end
+
+it 'must return false' do
   expect { subject.matches? { :foo } }.to equal: false
 end
 

data/test/spectus/matcher/custom/be_prime/test_be_prime.rb

@@ -4,15 +4,15 @@ subject 'be prime custom matcher' do
   Spectus::Matcher::BePrime.new
 end
 
-it 'must confirm that the instance variable is undefined' do
-  expect { subject.instance_variable_defined?(:@expected) }.to equal: false
-end
-
 it 'must be prime' do
   expect { subject.matches? { 3 } }.to equal: true
 end
 
 it 'must not match the string' do
+  expect { subject.matches? { 4 } }.not_to equal: true
+end
+
+it 'must return false' do
   expect { subject.matches? { 4 } }.to equal: false
 end
 

data/test/spectus/matcher/custom/be_the_answer/test_be_the_answer.rb

@@ -4,15 +4,15 @@ subject 'be the answer custom matcher' do
   Spectus::Matcher::BeTheAnswer.new
 end
 
-it 'must confirm that the instance variable is undefined' do
-  expect { subject.instance_variable_defined?(:@expected) }.to equal: false
-end
-
 it 'must be the answer' do
   expect { subject.matches? { 42 } }.to equal: true
 end
 
 it 'must not match the string' do
+  expect { subject.matches? { 'foo' } }.not_to equal: true
+end
+
+it 'must return false' do
   expect { subject.matches? { 'foo' } }.to equal: false
 end
 

data/test/spectus/matcher/custom/start_with/test_start_with.rb

@@ -4,15 +4,15 @@ subject 'start with custom matcher' do
   Spectus::Matcher::StartWith.new('foo')
 end
 
-it 'must return the expected value' do
-  expect { subject.instance_variable_get(:@expected) }.to eql: 'foo'
-end
-
 it 'must match the string' do
   expect { subject.matches? { 'foobar' } }.to equal: true
 end
 
 it 'must not match the string' do
+  expect { subject.matches? { 'bar' } }.not_to equal: true
+end
+
+it 'must return false' do
   expect { subject.matches? { 'bar' } }.to equal: false
 end
 

data/test/spectus/test_matcher.rb

@@ -5,22 +5,23 @@ subject "matcher module" do
 end
 
 it 'must return true after the evaluation' do
-  expect { subject.eval(false, eql: 'foo') { 'foo' } }.to equal: true
+  expect { subject.pass?(false, eql: 'foo') { 'foo' } }.to equal: true
 end
 
 it 'must return false after the evaluation' do
-  expect { subject.eval(false, eql: 'foo') { 'bar' } }.to equal: false
+  expect { subject.pass?(false, eql: 'foo') { 'bar' } }.to equal: false
 end
 
-it 'must return an exception after the evaluation' do
-  expect { subject.eval(false, eql: 'foo') { BOOM }.class }.to equal: NameError
+it 'must raise a name error exception' do
+  expect { subject.pass?(false, eql: 'foo') { BOOM } }.
+    to raise_exception: NameError
 end
 
 it 'must return the class of a matcher from its symbol' do
   expect { subject.get(:eql).equal? subject.const_get(:Eql) }.to equal: true
 end
 
-it 'must raise: uninitialized constant Foo' do
+it 'must raise a name error exception' do
   expect { subject.get(:foo).equal? subject.const_get(:Foo) }.
     to raise_exception: NameError
 end
@@ -29,9 +30,6 @@ it 'must no longer raise' do
   module Spectus
     module Matcher
       class Foo
-        def matches?
-          true
-        end
       end
     end
   end

data/test/support/coverage.rb

@@ -1,3 +1,11 @@
+require 'simplecov'
 require 'coveralls'
 
-Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  minimum_coverage 100
+end

data/test/support/env.rb

@@ -1,4 +1 @@
-if RUBY_VERSION < '2.0.0'
-  warn "Needs Ruby 2.0.0, you're running: #{RUBY_VERSION}"
-  exit 1
-end
+abort "Needs Ruby 2, you're running: #{RUBY_VERSION}" if RUBY_VERSION < '2'

data/test/support/immutable.rb

@@ -0,0 +1,12 @@
+class Object
+  alias_method :overridden_initialize, :initialize
+
+  def initialize
+    overridden_initialize
+
+    if  !self.class.ancestors.include?(SimpleCov::Formatter::MultiFormatter) &&
+        !self.class.ancestors.include?(SimpleCov::Formatter::HTMLFormatter)
+      freeze
+    end
+  end
+end

data/test/support/presenter.rb

@@ -1,5 +1,3 @@
-@failures = 0
-
 def subject title = nil, &block
   if block
     @subject = block.call
@@ -11,21 +9,5 @@ end
 
 def it describe, &expectation
   print " * #{describe}: ".ljust 79
-
-  result = expectation.call
-
-  case result
-  when true
-    puts "\e[32m.\e[0m"
-  when false
-    @failures += 1
-    warn "\e[31mF\e[0m"
-  else
-    @failures += 1
-    fail result
-  end
-end
-
-at_exit do
-  abort("\e[31mFailure.\e[0m") unless @failures.zero?
+  expectation.call.equal?(true) ? puts('.') : abort('F')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spectus
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Cyril Wack
@@ -30,7 +30,7 @@ cert_chain:
   zeYBFLJQAl0AQPaGujsG5tssIabiNy1ryydKAjWkNDxqLgvtwST3L0Qr9UQFQgoA
   O2Rl8PjSD+2P9XE7T2x1xQ==
   -----END CERTIFICATE-----
-date: 2014-10-13 00:00:00.000000000 Z
+date: 2014-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,8 +112,6 @@ files:
 - lib/spectus/dsl.rb
 - lib/spectus/expectation_target.rb
 - lib/spectus/matcher.rb
-- lib/spectus/matcher/capture_stderr.rb
-- lib/spectus/matcher/capture_stdout.rb
 - lib/spectus/matcher/eql.rb
 - lib/spectus/matcher/equal.rb
 - lib/spectus/matcher/match.rb
@@ -124,8 +122,6 @@ files:
 - test/helper_test.rb
 - test/spectus/helper_test.rb
 - test/spectus/matcher/built_in/helper_test.rb
-- test/spectus/matcher/built_in/test_capture_stderr.rb
-- test/spectus/matcher/built_in/test_capture_stdout.rb
 - test/spectus/matcher/built_in/test_eql.rb
 - test/spectus/matcher/built_in/test_equal.rb
 - test/spectus/matcher/built_in/test_match.rb
@@ -139,12 +135,12 @@ files:
 - test/spectus/matcher/custom/start_with/test_start_with.rb
 - test/spectus/matcher/helper_test.rb
 - test/spectus/test_dsl.rb
-- test/spectus/test_expectation_target.rb
 - test/spectus/test_matcher.rb
 - test/spectus/test_version.rb
 - test/support.rb
 - test/support/coverage.rb
 - test/support/env.rb
+- test/support/immutable.rb
 - test/support/presenter.rb
 homepage: https://github.com/fixrb/spectus
 licenses:
@@ -174,8 +170,6 @@ test_files:
 - test/helper_test.rb
 - test/spectus/helper_test.rb
 - test/spectus/matcher/built_in/helper_test.rb
-- test/spectus/matcher/built_in/test_capture_stderr.rb
-- test/spectus/matcher/built_in/test_capture_stdout.rb
 - test/spectus/matcher/built_in/test_eql.rb
 - test/spectus/matcher/built_in/test_equal.rb
 - test/spectus/matcher/built_in/test_match.rb
@@ -189,11 +183,11 @@ test_files:
 - test/spectus/matcher/custom/start_with/test_start_with.rb
 - test/spectus/matcher/helper_test.rb
 - test/spectus/test_dsl.rb
-- test/spectus/test_expectation_target.rb
 - test/spectus/test_matcher.rb
 - test/spectus/test_version.rb
 - test/support.rb
 - test/support/coverage.rb
 - test/support/env.rb
+- test/support/immutable.rb
 - test/support/presenter.rb
 has_rdoc: 

data/lib/spectus/matcher/capture_stderr.rb

@@ -1,28 +0,0 @@
-require 'stringio'
-
-module Spectus
-  module Matcher
-
-    # Provides the implementation for `capture_stderr`.
-    class CaptureStderr
-      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

data/lib/spectus/matcher/capture_stdout.rb

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

data/test/spectus/matcher/built_in/test_capture_stderr.rb

@@ -1,21 +0,0 @@
-require_relative 'helper_test'
-
-subject 'capture standard error built-in matcher' do
-  Spectus::Matcher::CaptureStderr.new "foo\n"
-end
-
-it 'must return the expected value' do
-  expect { subject.instance_variable_get(:@expected) }.to eql: "foo\n"
-end
-
-it 'must match the captured standard error' do
-  expect { subject.matches? { warn 'foo' } }.to equal: true
-end
-
-it 'must not match the captured standard error' do
-  expect { subject.matches? { warn 'bar' } }.to equal: false
-end
-
-it 'must return the raised exception' do
-  expect { raise subject.matches? { BOOM } }.to raise_exception: NameError
-end

data/test/spectus/matcher/built_in/test_capture_stdout.rb

@@ -1,21 +0,0 @@
-require_relative 'helper_test'
-
-subject 'capture standard output built-in matcher' do
-  Spectus::Matcher::CaptureStdout.new "foo\n"
-end
-
-it 'must return the expected value' do
-  expect { subject.instance_variable_get(:@expected) }.to eql: "foo\n"
-end
-
-it 'must match the captured standard output' do
-  expect { subject.matches? { puts 'foo' } }.to equal: true
-end
-
-it 'must not match the captured standard output' do
-  expect { subject.matches? { puts 'bar' } }.to equal: false
-end
-
-it 'must return the raised exception' do
-  expect { raise subject.matches? { BOOM } }.to raise_exception: NameError
-end

data/test/spectus/test_expectation_target.rb

@@ -1,17 +0,0 @@
-require_relative 'helper_test'
-
-subject "expectation target" do
-  Spectus::ExpectationTarget.new { 42 }
-end
-
-it 'must confirm that the block is defined' do
-  expect { subject.instance_variable_defined?(:@actual) }.to equal: true
-end
-
-it 'must responds to :to' do
-  expect { subject.respond_to? :to }.to equal: true
-end
-
-it 'must responds to :not_to' do
-  expect { subject.respond_to? :not_to }.to equal: true
-end