easytest 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42389cdde1ebd51de0f636f3c5ec0e67ffe842ff91029f71617795799841d47b
-  data.tar.gz: 559dadc55a86bfc6da11234b05f1fd9a5477311379f94ea41565731516271405
+  metadata.gz: 9c1fb5f44f3dd5d049cd6775120712a614f7016a20c7f87d771043642ceb7bb6
+  data.tar.gz: '04591bad578ad4351de07ab07467378663cea9e0de2d40930aea5d4a3d132bac'
 SHA512:
-  metadata.gz: e4d9cc9b6bc5a76ecccf5f98d076e123eeddabe7a16c42a093050e154c3c32565a80c99301ed615ab0be95e2b7b7e0773088d3d5dc621ddc2fda3f69e28ed184
-  data.tar.gz: 8a8612f4baf5bc8bc026ecb20fbbe906ad32044f22c9232137dc68b5bb32940d634aed10703d6455f339518bba18c8a433bee66d2ed30afbcff2c93cbe03ec57
+  metadata.gz: 718b38f0a0fc35339bdaae214baf115de1ee8d4a94bb20d157f102af5caf08a763580e2946976504443e3b45211fc5d8776668b353c9a9c07e5ed9abddca03e3
+  data.tar.gz: 4784ee059e028d9d8a7c6ed23d864182e280ced00d56e502b87d31b032212bde623b50b66fed087583f0ee24eda939900915d8d25fe9081bdf33b020930b7423

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.3.0
+
+- Add RBS support.
+- Add CLI help.
+- Fix CLI to aware absolute paths.
+
+## 0.2.0
+
+- Add many matchers.
+
 ## 0.1.2
 
 - Fix the `easytest` command exit code.

data/README.md

@@ -1,10 +1,11 @@
 [![Gem Version](https://badge.fury.io/rb/easytest.svg)](https://badge.fury.io/rb/easytest)
+[![CI](https://github.com/ybiquitous/easytest/actions/workflows/ci.yml/badge.svg)](https://github.com/ybiquitous/easytest/actions/workflows/ci.yml)
 
 # Easytest
 
 > makes you write tests easily
 
-Easytest is a tiny testing framework with a familiar DSL.
+Easytest is a tiny testing framework for Ruby with a familiar DSL.
 
 ## Installation
 
@@ -39,14 +40,14 @@ end
 Then, run `easytest`:
 
 ```console
-$ bundle exec easytest
+$ easytest
  FAIL  test/addition_test.rb
   ● addition  (should equal)
 
     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)
@@ -63,11 +64,13 @@ Oops. Let's fix the failure:
 Then, run it again:
 
 ```console
-$ bundle exec easytest
+$ easytest
  PASS  test/addition_test.rb
 
  Tests:  1 passed, 1 total (1 files)
  Time:   0.00077 seconds
 ```
 
-The test passes! 🎉
+The test now passes! 🎉
+
+For more, try `easytest --help`.

data/exe/easytest

@@ -3,6 +3,6 @@
 $LOAD_PATH << File.expand_path("../lib", __dir__)
 $LOAD_PATH << File.join(Dir.pwd, "test")
 
-require "easytest"
+require "easytest/cli"
 
 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

@@ -1,7 +1,23 @@
+require "easytest"
+require "optparse"
+
 module Easytest
   class CLI
     SUCCESS = 0
     FAILURE = 1
+    FATAL = 2
+
+    def run
+      exit_code = parse_options
+      return exit_code if exit_code
+
+      Easytest.start
+      setup
+      successful = Easytest.run
+      successful ? SUCCESS : FAILURE
+    end
+
+    private
 
     attr_reader :argv
     attr_reader :start_time
@@ -11,18 +27,72 @@ module Easytest
       @start_time = Time.now
     end
 
-    def run
-      Easytest.start
-      setup
-      successful = Easytest.run
-      successful ? SUCCESS : FAILURE
+    def parse_options
+      options = {}
+
+      parser = OptionParser.new do |p|
+        p.program_name = "easytest"
+        p.version = "#{p.program_name} #{Easytest::VERSION}"
+
+        p.on "--help" do
+          options[:help] = true
+        end
+
+        p.on "--version" do
+          options[:version] = true
+        end
+      end
+
+      begin
+        parser.parse!(argv)
+
+        if options[:help]
+          puts help(parser)
+          return SUCCESS
+        end
+
+        if options[:version]
+          puts parser.version
+          return SUCCESS
+        end
+
+        nil
+      rescue OptionParser::ParseError => error
+        $stderr.puts Rainbow(error.message).red
+        FATAL
+      end
     end
 
-    private
+    def help(parser)
+      <<~MSG
+        #{Rainbow("USAGE").bright}
+          #{parser.program_name} [options] [...<file, directory, or pattern>]
+
+        #{Rainbow("OPTIONS").bright}
+          --help      Show help
+          --version   Show version
+
+        #{Rainbow("EXAMPLES").bright}
+          # Run all tests (test/**/*_test.rb)
+          $ easytest
+
+          # Run only test files
+          $ easytest test/example_test.rb
+
+          # Run only test files in specified directories
+          $ easytest test/example
+
+          # Run only test files that matches specified patterns
+          $ easytest example
+      MSG
+    end
 
     def setup
       Dir.glob(Easytest.test_files_location)
-        .filter { |file| argv.empty? || argv.any? { |pattern| file.include?(pattern) } }
+        .map { |file| File.absolute_path(file) }
+        .filter do |file|
+          argv.empty? || argv.any? { |pattern| file.include?(pattern) }
+        end
         .each { |test_file| load test_file }
     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,41 +1,67 @@
 module Easytest
   class Expectation
-    attr_reader :actual
-    attr_reader :block
-
-    def initialize(actual, &block)
-      @actual = actual
-      @block = block
+    def not
+      self.class.new(actual, negate: true, &block)
     end
 
     def to_eq(expected)
-      Matcher::Equal.new(actual: eval_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: eval_actual, expected: expected).match!
+      Matcher::Be.new(actual: actual, expected: expected, negate: negate).match!
     end
 
     def to_be_nil
-      Matcher::BeNil.new(actual: eval_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)
+    def to_raise(expected)
+      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?
+      raise FatalError, "`to_raise` requires a Class, String, or Regexp" unless [Class, String, Regexp].any? { expected.is_a? _1 }
 
+      Matcher::Raise.new(actual: block, expected: expected, negate: negate).match!
     end
 
-    def to_not_raise(exception_class)
+    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
 
     private
 
-    def eval_actual
-      if block
-        block.call
-      else
-        actual
-      end
+    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
   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,17 +17,22 @@ module Easytest
       end
 
       def match!
-        unless match?
-          raise UnmatchedError.new(message: message, actual: actual, expected: expected)
-        end
+        matched = match?
+        matched = !matched if negate?
+        raise_match_error unless matched
       end
 
-      def expected
+      def message
         raise NotImplementedError
       end
 
-      def message
-        raise NotImplementedError
+      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

data/lib/easytest/matcher/be.rb

@@ -1,19 +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 message
-        "should be same"
+        "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,26 +1,13 @@
 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 message
-        "should equal"
+        "equal"
       end
-
-      #  def match!
-      #   unless match?
-      #     raise UnmatchedError.new(message: "should equal", actual: actual, expected: expected)
-      #   end
-      # end
     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/{be_nil.rb → nil.rb}

@@ -1,16 +1,16 @@
 module Easytest
   module Matcher
-    class BeNil < Base
-      def match?
-        actual.nil?
+    class Nil < Base
+      def initialize(actual:, negate:)
+        super(actual: actual, expected: nil, negate: negate)
       end
 
-      def expected
-        nil
+      def match?
+        actual.nil?
       end
 
       def message
-        "should be nil"
+        "nil"
       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
+          false
+        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

@@ -39,10 +39,12 @@ module Easytest
       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."
+        $stderr.puts <<~MSG
+          #{Rainbow("Oops. No tests found!").red.bright}
+
+          #{Rainbow("Put `#{Easytest.test_files_location}` files to include at least one test case.").red}
+          #{Rainbow("Or specify a pattern that matches an existing test file.").red}
+        MSG
         false
       else
         puts ""

data/lib/easytest/version.rb

@@ -1,3 +1,3 @@
 module Easytest
-  VERSION = "0.1.2"
+  VERSION = "0.3.0"
 end

data/lib/easytest.rb

@@ -4,18 +4,26 @@ 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/matcher/base"
-require_relative "easytest/matcher/be"
-require_relative "easytest/matcher/be_nil"
-require_relative "easytest/matcher/equal"
 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_a"
+require_relative "easytest/matcher/equal"
+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.start
     @runner = Runner.new

data/sig/easytest.rbs

@@ -0,0 +1,37 @@
+module Easytest
+  VERSION: String
+
+  module DSL
+  end
+
+  class Expectation
+    def not: () -> instance
+
+    def to_eq: (untyped expected) -> void
+    alias to_equal to_eq
+
+    def to_be: (untyped expected) -> untyped
+
+    def to_be_nil: () -> void
+
+    def to_be_a: (Class expected) -> void
+    def to_be_kind_of: (Class expected) -> void
+    def to_be_instance_of: (Class expected) -> void
+
+    def to_be_false: () -> void
+    def to_be_true: () -> void
+
+    def to_raise: ((Class | String | Regexp) expected) -> void
+    def to_not_raise: () -> void
+  end
+end
+
+module Kernel
+  def expect: (untyped actual) -> Easytest::Expectation
+            | { () -> void } -> Easytest::Expectation
+end
+
+# polyfill
+class Object
+  def using: (Module target) -> void
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easytest
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Masafumi Koba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2022-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -44,12 +44,20 @@ files:
 - 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
+- sig/easytest.rbs
 homepage: https://github.com/ybiquitous/easytest
 licenses:
 - MIT