easytest 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e042e91fa6e5c9b2c64188574118fbe3df09705081e9ef999cdf78ce50ba6633
-  data.tar.gz: 6e556cfb345aba74ec5eef4883b9f2bb33863c041223e8dfe3337f16dc2b3501
+  metadata.gz: ea89da5a0f2aba7252ea69be567591284bfcc1f53aa089e4824eb54773881b0b
+  data.tar.gz: b9bb01188ce657b918cdffe80cb962fd4e3c011fa9a4556b832d49eeed8fef5d
 SHA512:
-  metadata.gz: a064dadb35c5af370821737bca2e59bcbfea6e3b4ecb6179779fe34f0e17998d3778fc4eb978f997b7a876be9a95b13e13798c8a378eb9993e58f804bca2fb17
-  data.tar.gz: fef643dcd0e347880cb202653575c832edf431f6004216f0c054d5cc7246aade6427638d6b7f434b9c327c15255a55bb9f1927ead6e57c272418738b080540e1
+  metadata.gz: 6b1539eeef25d6343a411a05afbfcff6143d9f33798fb5f3d13dbf8f3d742ea79247ced5c5da1a994bc0d77b41787ec8c7477ed06b26664ef30987007291ad26
+  data.tar.gz: c5e5ebe81739839785eab40d24a3d4e529d7c33f0d2ac5fd5cc20bf2984b65849d6b99f18b46848f6d17d362dfdc95fb16ae7d0f3403b77913a6b182b0f1fc9a

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.2.0
+
+- Add many matchers.
+
+## 0.1.2
+
+- Fix the `easytest` command exit code.
+
 ## 0.1.1
 
 No code changes.

data/README.md

@@ -46,7 +46,7 @@ $ bundle exec easytest
     Expected: 2
     Received: 3
 
-    at test/addition_test.rb:6:in `block in <top (required)>'
+    # test/addition_test.rb:6:in `block in <top (required)>'
 
 
  Tests:  1 failed, 0 passed, 1 total (1 files)

data/exe/easytest

@@ -5,7 +5,4 @@ $LOAD_PATH << File.join(Dir.pwd, "test")
 
 require "easytest"
 
-test_files = Dir.glob("test/**/*_test.rb").filter do |file|
-  ARGV.empty? || ARGV.any? { |pattern| file.include?(pattern) }
-end
-test_files.each { |file| load file }
+exit Easytest::CLI.new(ARGV).run

data/lib/easytest/case.rb

@@ -15,10 +15,23 @@ module Easytest
     def run
       block.call
       true
-    rescue UnmatchedError => error
-      loc = error.backtrace_locations[2]
-      self.report = Reporter.new(error: error, file: loc.absolute_path, location: loc.to_s).report(name)
+    rescue MatchError, FatalError => error
+      loc = find_location(error) or raise
+
+      self.report = Reporter.new(
+        name: name,
+        error: error,
+        file: loc.absolute_path,
+        location: loc.to_s,
+      ).report or raise
+
       false
     end
+
+    private
+
+    def find_location(error)
+      error.backtrace_locations.find { |loc| loc.path.end_with?("_test.rb") }
+    end
   end
 end

data/lib/easytest/cli.rb

@@ -0,0 +1,29 @@
+module Easytest
+  class CLI
+    SUCCESS = 0
+    FAILURE = 1
+
+    attr_reader :argv
+    attr_reader :start_time
+
+    def initialize(argv)
+      @argv = argv
+      @start_time = Time.now
+    end
+
+    def run
+      Easytest.start
+      setup
+      successful = Easytest.run
+      successful ? SUCCESS : FAILURE
+    end
+
+    private
+
+    def setup
+      Dir.glob(Easytest.test_files_location)
+        .filter { |file| argv.empty? || argv.any? { |pattern| file.include?(pattern) } }
+        .each { |test_file| load test_file }
+    end
+  end
+end

data/lib/easytest/dsl.rb

@@ -6,8 +6,8 @@ module Easytest
         Easytest.add_case Case.new(name: name, file: file, &block)
       end
 
-      def expect(actual)
-        Expectation.new(actual)
+      def expect(actual = nil, &block)
+        Expectation.new(actual, &block)
       end
     end
   end

data/lib/easytest/errors.rb

@@ -1,7 +1,9 @@
 module Easytest
   class Error < StandardError; end
 
-  class UnmatchedError < Error
+  class FatalError < Error; end
+
+  class MatchError < Error
     attr_reader :actual
     attr_reader :expected
 

data/lib/easytest/expectation.rb

@@ -1,19 +1,64 @@
 module Easytest
   class Expectation
-    def initialize(actual)
+    attr_reader :actual
+    attr_reader :block
+    attr_reader :negate
+    alias negate? negate
+
+    def initialize(actual, negate: false, &block)
       @actual = actual
+      @block = block
+      @negate = negate
+    end
+
+    def not
+      self.class.new(actual, negate: true, &block)
     end
 
     def to_eq(expected)
-      Matcher::Equal.new(actual: @actual, expected: expected).match!
+      Matcher::Equal.new(actual: actual, expected: expected, negate: negate).match!
     end
+    alias to_equal to_eq
 
     def to_be(expected)
-      Matcher::Be.new(actual: @actual, expected: expected).match!
+      Matcher::Be.new(actual: actual, expected: expected, negate: negate).match!
     end
 
     def to_be_nil
-      Matcher::BeNil.new(actual: @actual).match!
+      Matcher::Nil.new(actual: actual, negate: negate).match!
+    end
+
+    def to_be_true
+      Matcher::True.new(actual: actual, negate: negate).match!
+    end
+
+    def to_be_false
+      Matcher::False.new(actual: actual, negate: negate).match!
+    end
+
+    def to_be_a(expected)
+      Matcher::BeA.new(actual: actual, expected: expected, negate: negate).match!
+    end
+
+    def to_be_kind_of(expected)
+      Matcher::KindOf.new(actual: actual, expected: expected, negate: negate).match!
+    end
+
+    def to_be_instance_of(expected)
+      Matcher::InstanceOf.new(actual: actual, expected: expected, negate: negate).match!
+    end
+
+    def to_raise(exception_class)
+      raise FatalError, "`to_raise` requires a block like `expect { ... }.to_raise`" unless block
+      raise FatalError, "`not.to_raise` can cause a false positive, so use `to_not_raise` instead" if negate?
+
+      Matcher::Raise.new(actual: block, expected: exception_class, negate: negate).match!
+    end
+
+    def to_not_raise
+      raise FatalError, "`to_not_raise` requires a block like `expect { ... }.to_not_raise`" unless block
+
+      Matcher::NotRaise.new(actual: block).match!
     end
   end
 end

data/lib/easytest/matcher/base.rb

@@ -2,9 +2,14 @@ module Easytest
   module Matcher
     class Base
       attr_reader :actual
+      attr_reader :expected
+      attr_reader :negate
+      alias negate? negate
 
-      def initialize(actual:)
+      def initialize(actual:, expected:, negate: false)
         @actual = actual
+        @expected = expected
+        @negate = negate
       end
 
       def match?
@@ -12,8 +17,23 @@ module Easytest
       end
 
       def match!
+        matched = match?
+        matched = !matched if negate?
+        raise_match_error unless matched
+      end
+
+      def message
         raise NotImplementedError
       end
+
+      def build_error_message
+        prefix = negate? ? "not " : ""
+        "#{prefix}#{message}"
+      end
+
+      def raise_match_error
+        raise MatchError.new(message: build_error_message, actual: actual, expected: expected)
+      end
     end
   end
 end

data/lib/easytest/matcher/be.rb

@@ -1,21 +1,12 @@
 module Easytest
   module Matcher
     class Be < Base
-      attr_reader :expected
-
-      def initialize(actual:, expected:)
-        super(actual: actual)
-        @expected = expected
-      end
-
       def match?
         actual.equal? expected
       end
 
-      def match!
-        unless match?
-          raise UnmatchedError.new(message: "should be same", actual: actual, expected: expected)
-        end
+      def message
+        "same"
       end
     end
   end

data/lib/easytest/matcher/be_a.rb

@@ -0,0 +1,13 @@
+module Easytest
+  module Matcher
+    class BeA < Base
+      def match?
+        actual.is_a? expected
+      end
+
+      def message
+        "be a"
+      end
+    end
+  end
+end

data/lib/easytest/matcher/equal.rb

@@ -1,21 +1,12 @@
 module Easytest
   module Matcher
     class Equal < Base
-      attr_reader :expected
-
-      def initialize(actual:, expected:)
-        super(actual: actual)
-        @expected = expected
-      end
-
       def match?
         actual == expected
       end
 
-      def match!
-        unless match?
-          raise UnmatchedError.new(message: "should equal", actual: actual, expected: expected)
-        end
+      def message
+        "equal"
       end
     end
   end

data/lib/easytest/matcher/false.rb

@@ -0,0 +1,17 @@
+module Easytest
+  module Matcher
+    class False < Base
+      def initialize(actual:, negate:)
+        super(actual: actual, expected: false, negate: negate)
+      end
+
+      def match?
+        actual == expected
+      end
+
+      def message
+        "false"
+      end
+    end
+  end
+end

data/lib/easytest/matcher/instance_of.rb

@@ -0,0 +1,13 @@
+module Easytest
+  module Matcher
+    class InstanceOf < Base
+      def match?
+        actual.instance_of? expected
+      end
+
+      def message
+        "instance of"
+      end
+    end
+  end
+end

data/lib/easytest/matcher/kind_of.rb

@@ -0,0 +1,13 @@
+module Easytest
+  module Matcher
+    class KindOf < Base
+      def match?
+        actual.kind_of? expected
+      end
+
+      def message
+        "kind of"
+      end
+    end
+  end
+end

data/lib/easytest/matcher/nil.rb

@@ -0,0 +1,17 @@
+module Easytest
+  module Matcher
+    class Nil < Base
+      def initialize(actual:, negate:)
+        super(actual: actual, expected: nil, negate: negate)
+      end
+
+      def match?
+        actual.nil?
+      end
+
+      def message
+        "nil"
+      end
+    end
+  end
+end

data/lib/easytest/matcher/not_raise.rb

@@ -0,0 +1,27 @@
+module Easytest
+  module Matcher
+    class NotRaise < Base
+      def initialize(actual:)
+        super(actual: actual, expected: nil)
+      end
+
+      def match?
+        begin
+          actual.call
+          true
+        rescue => error
+          @raised_error = error
+          false
+        end
+      end
+
+      def raise_match_error
+        raise MatchError.new(message: build_error_message, actual: @raised_error, expected: expected)
+      end
+
+      def message
+        "not raise"
+      end
+    end
+  end
+end

data/lib/easytest/matcher/raise.rb

@@ -0,0 +1,38 @@
+module Easytest
+  module Matcher
+    class Raise < Base
+      def match?
+        begin
+          actual.call
+          false
+        rescue => error
+          @raised_error = error
+          match_error?(actual: error, expected: expected)
+        end
+      end
+
+      def raise_match_error
+        raise MatchError.new(message: build_error_message, actual: @raised_error, expected: expected)
+      end
+
+      def message
+        "raise"
+      end
+
+      private
+
+      def match_error?(actual:, expected:)
+        case expected
+        when Class
+          actual.class == expected
+        when String
+          actual.message == expected
+        when Regexp
+          actual.message.match? expected
+        else
+          raise TypeError.new "Class, String, or Regexp is allowed: #{expected}"
+        end
+      end
+    end
+  end
+end

data/lib/easytest/matcher/true.rb

@@ -0,0 +1,17 @@
+module Easytest
+  module Matcher
+    class True < Base
+      def initialize(actual:, negate:)
+        super(actual: actual, expected: true, negate: negate)
+      end
+
+      def match?
+        actual == expected
+      end
+
+      def message
+        "true"
+      end
+    end
+  end
+end

data/lib/easytest/reporter.rb

@@ -1,19 +1,46 @@
 module Easytest
   class Reporter
-    def initialize(error:, file:, location:)
+    attr_reader :name
+    attr_reader :error
+    attr_reader :file
+    attr_reader :location
+
+    def initialize(name:, error:, file:, location:)
+      @name = name
       @error = error
       @file = file
       @location = location
     end
 
-    def report(test_name)
+    def report
+      case error
+      when MatchError
+        report_match_error
+      when FatalError
+        report_fatal_error
+      end
+    end
+
+    private
+
+    def report_match_error
+      <<~MSG
+        #{Rainbow("● #{name}").red.bright}  #{Rainbow("(#{error.message})").dimgray}
+
+          #{Rainbow("Expected: #{error.expected.inspect}").green}
+          #{Rainbow("Received: #{error.actual.inspect}").red}
+
+          #{Rainbow("# #{location}").dimgray}
+      MSG
+    end
+
+    def report_fatal_error
       <<~MSG
-        #{Rainbow("● #{test_name}").red.bright}  #{Rainbow("(#{@error.message})").dimgray}
+        #{Rainbow("● #{name}").red.bright}
 
-          #{Rainbow("Expected: #{@error.expected.inspect}").green}
-          #{Rainbow("Received: #{@error.actual.inspect}").red}
+          #{Rainbow(error.message).red}
 
-          #{Rainbow("at #{@location}").dimgray}
+          #{Rainbow("# #{location}").dimgray}
       MSG
     end
   end

data/lib/easytest/runner.rb

@@ -0,0 +1,94 @@
+module Easytest
+  class Runner
+    attr_reader :start_time
+    attr_accessor :passed_count
+    attr_accessor :failed_count
+    attr_accessor :file_count
+
+    def initialize(start_time: Time.now)
+      @start_time = start_time
+      @passed_count = 0
+      @failed_count = 0
+      @file_count = 0
+    end
+
+    def run
+      cases_by_file = cases.group_by { |c| c.file }
+      cases_by_file.each do |file, cases|
+        self.file_count += 1
+        reports = []
+
+        cases.each do |c|
+          passed = c.run
+
+          if passed
+            self.passed_count += 1
+          else
+            self.failed_count += 1
+            reports << c.report.gsub(/^/, "  ")
+          end
+        end
+
+        link = Utils.terminal_hyperlink(file)
+        if reports.empty?
+          puts "#{Rainbow(" PASS ").bright.bg(:green)} #{link}"
+        else
+          puts "#{Rainbow(" FAIL ").bright.bg(:red)} #{link}"
+          reports.each { |report| puts report ; puts "" }
+        end
+      end
+
+      if no_tests?
+        puts Rainbow("Oops. No tests found!").red.bright
+        puts ""
+        puts "Write `#{Easytest.test_files_location}` files to include at least one `test` block,"
+        puts "or specify a matching pattern to the `easytest` command."
+        false
+      else
+        puts ""
+        puts " #{Rainbow('Tests:').bright}  #{summary}"
+        puts " #{Rainbow('Time:').bright}   #{elapsed_time.round(5)} seconds"
+        all_passed?
+      end
+    end
+
+    def cases
+      @cases ||= []
+    end
+
+    def add_case(new_case)
+      cases << new_case
+    end
+
+    private
+
+    def total_count
+      passed_count + failed_count
+    end
+
+    def all_passed?
+      failed_count == 0
+    end
+
+    def no_tests?
+      total_count == 0
+    end
+
+    def elapsed_time
+      Time.now - start_time
+    end
+
+    def summary
+      summary = ""
+
+      if failed_count == 0
+        summary << Rainbow("#{passed_count} passed").green.bright
+      else
+        summary << Rainbow("#{failed_count} failed").red.bright
+        summary << ", #{Rainbow("#{passed_count} passed").green.bright}"
+      end
+
+      summary << ", #{total_count} total #{Rainbow("(#{file_count} files)").dimgray}"
+    end
+  end
+end

data/lib/easytest/version.rb

@@ -1,3 +1,3 @@
 module Easytest
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/easytest.rb

@@ -4,83 +4,41 @@ require "rainbow"
 require_relative "easytest/version"
 
 require_relative "easytest/case"
+require_relative "easytest/cli"
 require_relative "easytest/dsl"
 require_relative "easytest/errors"
 require_relative "easytest/expectation"
+require_relative "easytest/reporter"
+require_relative "easytest/runner"
+require_relative "easytest/utils"
+
+# Matcher
 require_relative "easytest/matcher/base"
 require_relative "easytest/matcher/be"
-require_relative "easytest/matcher/be_nil"
+require_relative "easytest/matcher/be_a"
 require_relative "easytest/matcher/equal"
-require_relative "easytest/reporter"
-require_relative "easytest/utils"
+require_relative "easytest/matcher/false"
+require_relative "easytest/matcher/instance_of"
+require_relative "easytest/matcher/kind_of"
+require_relative "easytest/matcher/nil"
+require_relative "easytest/matcher/not_raise"
+require_relative "easytest/matcher/raise"
+require_relative "easytest/matcher/true"
 
 module Easytest
-  def self.run
-    passed_count = 0
-    failed_count = 0
-    file_count = 0
-
-    cases_by_file = cases.group_by { |c| c.file }
-    cases_by_file.each do |file, cases|
-      file_count += 1
-      reports = []
-
-      cases.each do |c|
-        passed = c.run
-
-        if passed
-          passed_count += 1
-        else
-          failed_count += 1
-          reports << c.report.gsub(/^/, "  ")
-        end
-      end
-
-      link = Utils.terminal_hyperlink(file)
-      if reports.empty?
-        puts "#{Rainbow(" PASS ").bright.bg(:green)} #{link}"
-      else
-        puts "#{Rainbow(" FAIL ").bright.bg(:red)} #{link}"
-        reports.each { |report| puts report ; puts "" }
-      end
-    end
-
-    [passed_count, failed_count, file_count]
-  end
-
-  def self.cases
-    @cases ||= []
+  def self.start
+    @runner = Runner.new
   end
 
   def self.add_case(new_case)
-    cases << new_case
+    @runner.cases << new_case
   end
-end
-
-start_time = Time.now
 
-at_exit do
-  passed_count, failed_count, file_count = Easytest.run
-  total_count = passed_count + failed_count
-
-  time = Time.now - start_time
-
-  if total_count == 0
-    puts Rainbow("A test suite should have at least one test case!").red.bright
-    puts ""
-    puts "Please put `test/**/*_test.rb` files or specify valid patterns to the `easytest` command."
-  else
-    summary = ""
-    if failed_count == 0
-      summary << Rainbow("#{passed_count} passed").green.bright
-    else
-      summary << Rainbow("#{failed_count} failed").red.bright
-      summary << ", #{Rainbow("#{passed_count} passed").green.bright}"
-    end
-    summary << ", #{total_count} total #{Rainbow("(#{file_count} files)").dimgray}"
+  def self.run
+    @runner.run
+  end
 
-    puts ""
-    puts " #{Rainbow('Tests:').bright}  #{summary}"
-    puts " #{Rainbow('Time:').bright}   #{time.round(5)} seconds"
+  def self.test_files_location
+    "test/**/*_test.rb"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easytest
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Masafumi Koba
@@ -38,14 +38,23 @@ files:
 - exe/easytest
 - lib/easytest.rb
 - lib/easytest/case.rb
+- lib/easytest/cli.rb
 - lib/easytest/dsl.rb
 - lib/easytest/errors.rb
 - lib/easytest/expectation.rb
 - lib/easytest/matcher/base.rb
 - lib/easytest/matcher/be.rb
-- lib/easytest/matcher/be_nil.rb
+- lib/easytest/matcher/be_a.rb
 - lib/easytest/matcher/equal.rb
+- lib/easytest/matcher/false.rb
+- lib/easytest/matcher/instance_of.rb
+- lib/easytest/matcher/kind_of.rb
+- lib/easytest/matcher/nil.rb
+- lib/easytest/matcher/not_raise.rb
+- lib/easytest/matcher/raise.rb
+- lib/easytest/matcher/true.rb
 - lib/easytest/reporter.rb
+- lib/easytest/runner.rb
 - lib/easytest/utils.rb
 - lib/easytest/version.rb
 homepage: https://github.com/ybiquitous/easytest

data/lib/easytest/matcher/be_nil.rb

@@ -1,15 +0,0 @@
-module Easytest
-  module Matcher
-    class BeNil < Base
-      def match?
-        actual.nil?
-      end
-
-      def match!
-        unless match?
-          raise UnmatchedError.new(message: "should be `nil`", actual: actual, expected: nil)
-        end
-      end
-    end
-  end
-end