spectus 1.0.0.pre

data/lib/spectus/matcher/capture_stdout.rb

@@ -0,0 +1,31 @@
+require 'stringio'
+
+module Spectus
+  module Matcher
+
+    # @api private
+    # Provides the implementation for `capture_stdout`.
+    class CaptureStdout
+
+      # @api private
+      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/lib/spectus/matcher/eql.rb

@@ -0,0 +1,21 @@
+module Spectus
+  module Matcher
+
+    # @api private
+    # Provides the implementation for `eql`.
+    class Eql
+
+      # @api private
+      def initialize expected
+        @expected = expected
+
+        freeze
+      end
+
+      # @return [Boolean] Comparison between actual and expected values.
+      def matches?
+        @expected.eql? yield
+      end
+    end
+  end
+end

data/lib/spectus/matcher/equal.rb

@@ -0,0 +1,21 @@
+module Spectus
+  module Matcher
+
+    # @api private
+    # Provides the implementation for `equal`.
+    class Equal
+
+      # @api private
+      def initialize expected
+        @expected = expected
+
+        freeze
+      end
+
+      # @return [Boolean] Comparison between actual and expected values.
+      def matches?
+        @expected.equal? yield
+      end
+    end
+  end
+end

data/lib/spectus/matcher/match.rb

@@ -0,0 +1,21 @@
+module Spectus
+  module Matcher
+
+    # @api private
+    # Provides the implementation for `match`.
+    class Match
+
+      # @api private
+      def initialize expected
+        @expected = expected
+
+        freeze
+      end
+
+      # @return [Boolean] Comparison between actual and expected values.
+      def matches?
+        !@expected.match(yield).nil?
+      end
+    end
+  end
+end

data/lib/spectus/matcher/raise_exception.rb

@@ -0,0 +1,27 @@
+module Spectus
+  module Matcher
+
+    # @api private
+    # Provides the implementation for `raise_exception`.
+    class RaiseException
+
+      # @api private
+      def initialize expected
+        @expected = expected
+
+        freeze
+      end
+
+      # @return [Boolean] Comparison between actual and expected values.
+      def matches?
+        begin
+          yield
+        rescue @expected
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/spectus/reporter.rb

@@ -0,0 +1,45 @@
+module Spectus
+
+  # This class is responsible for reporting the result of the expectation.
+  class Reporter
+    attr_reader :negated, :matcher, :expected, :exception
+
+    # @api private
+    def initialize negated, matcher, expected, result
+      @negated    = negated
+      @matcher    = matcher
+      @expected   = expected
+      @pass       = result.equal? true
+      @exception  = ([ true, false ].include?(result) ? nil : result)
+
+      freeze
+    end
+
+    # Returns true if the expectation is true. False otherwise.
+    def pass?
+      @pass
+    end
+
+    # Returns the state of the expectation.
+    def state
+      if pass?
+        :success
+      elsif @exception.nil?
+        :failure
+      else
+        :error
+      end
+    end
+
+    # Returns a char as the result of the expectation.
+    def to_s
+      if pass?
+        '.'
+      elsif @exception.nil?
+        'F'
+      else
+        'E'
+      end
+    end
+  end
+end

data/lib/spectus/version.rb

@@ -0,0 +1,9 @@
+require 'pathname'
+
+module Spectus
+
+  # Gem version
+  VERSION = File.open(
+    Pathname.new(__FILE__).join '..', '..', '..', 'VERSION.semver'
+  ).read.chomp.to_sym
+end

data/spectus.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'spectus'
+  spec.version       = File.read('VERSION.semver')
+  spec.authors       = ['Cyril Wack']
+  spec.email         = ['cyril@sashite.com']
+  spec.summary       = %q{Expectation library.}
+  spec.description   = %q{An expectation library with some matchers for Ruby.}
+  spec.homepage      = 'https://github.com/cyril/spectus.rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler',    '~> 1.7'
+  spec.add_development_dependency 'rake',       '~> 10.0'
+  spec.add_development_dependency 'yard',       '~> 0.8'
+  spec.add_development_dependency 'coveralls',  '~> 0.7'
+end

data/test/helper_test.rb

@@ -0,0 +1,4 @@
+require_relative 'support'
+
+require_relative File.join '..', 'lib', 'spectus'
+extend Spectus::DSL

data/test/spectus/helper_test.rb

@@ -0,0 +1 @@
+require_relative File.join '..', 'helper_test'

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

@@ -0,0 +1 @@
+require_relative File.join '..', 'helper_test'

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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,21 @@
+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/matcher/built_in/test_eql.rb

@@ -0,0 +1,21 @@
+require_relative 'helper_test'
+
+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' } }.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_equal.rb

@@ -0,0 +1,21 @@
+require_relative 'helper_test'
+
+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 } }.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_match.rb

@@ -0,0 +1,21 @@
+require_relative 'helper_test'
+
+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' } }.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_raise_exception.rb

@@ -0,0 +1,21 @@
+require_relative 'helper_test'
+
+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 } }.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/custom/be_prime/helper_test.rb

@@ -0,0 +1,13 @@
+require_relative File.join '..', 'helper_test'
+
+require 'prime'
+
+module Spectus
+  module Matcher
+    class BePrime
+      def matches?
+        Prime.prime? yield
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative 'helper_test'
+
+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 } }.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/custom/be_the_answer/helper_test.rb

@@ -0,0 +1,11 @@
+require_relative File.join '..', 'helper_test'
+
+module Spectus
+  module Matcher
+    class BeTheAnswer
+      def matches?
+        42.equal? yield
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative 'helper_test'
+
+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' } }.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/custom/helper_test.rb

@@ -0,0 +1 @@
+require_relative File.join '..', 'helper_test'

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

@@ -0,0 +1,15 @@
+require_relative File.join '..', 'helper_test'
+
+module Spectus
+  module Matcher
+    class StartWith
+      def initialize expected
+        @expected = expected
+      end
+
+      def matches?
+        Regexp.new("^#{@expected}").match(yield) != nil
+      end
+    end
+  end
+end