easytest 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 720ee750084f63381ed7032f4c66bcd045e10b6fe96e9a3680bd5347d8ccdaf8
-  data.tar.gz: 6b8b8c27ab380b898a2d52976ee3156e237041ff7d4f39006b9c3bd33c71b178
+  metadata.gz: b72dfc70d7a8d0661cc8db8f80722598819cd167ff8eaeceeb15804088df94f0
+  data.tar.gz: 9e3fa802e2efb674630998420f726c32a24021b9eb5bac8df77696ed9e3aeb23
 SHA512:
-  metadata.gz: 7faecdb6f83e99f7ddf0216f03bcc1cd0407f14bd9417e84a4887db2d99c0ef7aaed94a33c513b0c487766d0ee7d28363a2e4c4f705774e7ce8fda5ad0406e67
-  data.tar.gz: d33ea01dc76b139bba94125c4ca747cb07b2ac0c385bd96b27abbb1288e709ee2827d50bad957aad202c39eee2f21d16cb86f9b0b284b5ef804cdb145565ec38
+  metadata.gz: 956aa6d38ccbbca19cde275ecd821453c8858ff7ce2652528233a480563304ec71c0c1ace5337904a0895287a26aa088e0bd5a5622d602a43e89bd82e402078c
+  data.tar.gz: ab7b14d3296cf0b37c517ff61f57b5b46b5697c9fd01af278f2fb1ca44ebe11b6f085a14565f8094ea41660a5eebfc7ef123b5d1b542ddfd6281ceef2a4a48e5

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.5.0
+
+- [Breaking] Rename `to_not_raise` to `to_raise_nothing`.
+- Add `to_match` matcher.
+- Add `only` to run only any cases.
+
+## 0.4.0
+
+- Add `skip` and `test` without block for todo.
+- Add `to_include` matcher.
+
 ## 0.3.1
 
 - Remove polyfill from `.sig` file.

data/README.md

@@ -42,7 +42,7 @@ Then, run `easytest`:
 ```console
 $ easytest
  FAIL  test/addition_test.rb
-  ● addition  (should equal)
+  ✕ addition  (should equal)
 
     Expected: 2
     Received: 3
@@ -73,4 +73,34 @@ $ easytest
 
 The test now passes! 🎉
 
-For more, try `easytest --help`.
+### Skip
+
+If you want to skip any cases, you can change `test` to `skip`:
+
+```diff
+-test "addition" do
++skip "addition" do
+```
+
+Skipped cases will be reported as "skipped".
+
+### Only
+
+If you want to run only any cases, you can use `test` to `only`:
+
+```diff
+-test "addition" do
++only "addition" do
+```
+
+Only cases with `only` will be run, and other cases will be skipped.
+
+### To-do
+
+If you want to write to-do cases, you can use `test` without a block:
+
+```ruby
+test "addition"
+```
+
+To-do cases will be reported as "todo".

data/lib/easytest/case.rb

@@ -3,35 +3,37 @@ module Easytest
     attr_reader :name
     attr_reader :file
     attr_reader :block
-    attr_accessor :report
+    attr_reader :skipped
+    attr_reader :only
 
-    def initialize(name:, file:, &block)
+    alias skipped? skipped
+    alias only? only
+
+    def initialize(name:, file:, skipped: false, only: false, &block)
       @name = name
       @file = file
       @block = block
-      @report = nil
+      @skipped = skipped
+      @only = only
     end
 
-    def run
-      block.call
-      true
-    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
+    def todo?
+      block.nil?
+    end
 
-      false
+    def skip!
+      @skipped = true
     end
 
-    private
+    def run
+      return [:todo, Reporter.new(name).report_todo] if todo?
+      return [:skipped, Reporter.new(name).report_skip] if skipped?
 
-    def find_location(error)
-      error.backtrace_locations.find { |loc| loc.path.end_with?("_test.rb") }
+      block.call
+      [:passed, nil]
+    rescue MatchError, FatalError => error
+      report = Reporter.new(name).report_error(error) or raise error
+      [:failed, report]
     end
   end
 end

data/lib/easytest/cli.rb

@@ -66,7 +66,7 @@ module Easytest
     def help(parser)
       <<~MSG
         #{Rainbow("USAGE").bright}
-          #{parser.program_name} [options] [...<file, directory, or pattern>]
+          #{parser.program_name} [options] [<file, directory, or pattern>...]
 
         #{Rainbow("OPTIONS").bright}
           --help      Show help

data/lib/easytest/dsl.rb

@@ -2,10 +2,26 @@ module Easytest
   module DSL
     refine Kernel do
       def test(name, &block)
+        Utils.raise_if_no_test_name(name, method: "test")
+
         file = caller_locations(1, 1).first.absolute_path
         Easytest.add_case Case.new(name: name, file: file, &block)
       end
 
+      def skip(name, &block)
+        Utils.raise_if_no_test_name(name, method: "skip")
+
+        file = caller_locations(1, 1).first.absolute_path
+        Easytest.add_case Case.new(name: name, file: file, skipped: true, &block)
+      end
+
+      def only(name, &block)
+        Utils.raise_if_no_test_name(name, method: "only")
+
+        file = caller_locations(1, 1).first.absolute_path
+        Easytest.add_case Case.new(name: name, file: file, only: true, &block)
+      end
+
       def expect(actual = nil, &block)
         Expectation.new(actual, &block)
       end

data/lib/easytest/expectation.rb

@@ -37,18 +37,26 @@ module Easytest
       Matcher::InstanceOf.new(actual: actual, expected: expected, negate: negate).match!
     end
 
+    def to_include(expected)
+      Matcher::Include.new(actual: actual, expected: expected, negate: negate).match!
+    end
+
+    def to_match(expected)
+      Matcher::Match.new(actual: actual, expected: expected, negate: negate).match!
+    end
+
     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, "`not.to_raise` can cause a false positive, so use `to_raise_nothing` 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
-      raise FatalError, "`to_not_raise` requires a block like `expect { ... }.to_not_raise`" unless block
+    def to_raise_nothing
+      raise FatalError, "`to_raise_nothing` requires a block like `expect { ... }.to_raise_nothing`" unless block
 
-      Matcher::NotRaise.new(actual: block).match!
+      Matcher::RaiseNothing.new(actual: block).match!
     end
 
     private

data/lib/easytest/matcher/include.rb

@@ -0,0 +1,13 @@
+module Easytest
+  module Matcher
+    class Include < Base
+      def match?
+        actual.include? expected
+      end
+
+      def message
+        "include"
+      end
+    end
+  end
+end

data/lib/easytest/matcher/match.rb

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

data/lib/easytest/matcher/{not_raise.rb → raise_nothing.rb}

@@ -1,6 +1,6 @@
 module Easytest
   module Matcher
-    class NotRaise < Base
+    class RaiseNothing < Base
       def initialize(actual:)
         super(actual: actual, expected: nil)
       end
@@ -20,7 +20,7 @@ module Easytest
       end
 
       def message
-        "not raise"
+        "raise nothing"
       end
     end
   end

data/lib/easytest/reporter.rb

@@ -1,47 +1,65 @@
 module Easytest
   class Reporter
     attr_reader :name
-    attr_reader :error
-    attr_reader :file
-    attr_reader :location
 
-    def initialize(name:, error:, file:, location:)
+    def initialize(name)
       @name = name
-      @error = error
-      @file = file
-      @location = location
     end
 
-    def report
+    def report_error(error)
       case error
       when MatchError
-        report_match_error
+        report_match_error(error)
       when FatalError
-        report_fatal_error
+        report_fatal_error(error)
       end
     end
 
+    def report_skip
+      Rainbow("⚠ skipped \"#{name}\"").yellow
+    end
+
+    def report_todo
+      Rainbow("✎ todo \"#{name}\"").magenta
+    end
+
     private
 
-    def report_match_error
+    def report_match_error(error)
+      loc = find_location(error)
+
       <<~MSG
-        #{Rainbow("● #{name}").red.bright}  #{Rainbow("(#{error.message})").dimgray}
+        #{Rainbow("✕ #{name}").red.bright}  #{Rainbow("(#{error.message})").dimgray}
 
           #{Rainbow("Expected: #{error.expected.inspect}").green}
           #{Rainbow("Received: #{error.actual.inspect}").red}
 
-          #{Rainbow("# #{location}").dimgray}
+          #{Rainbow(format_location(loc)).dimgray}
       MSG
     end
 
-    def report_fatal_error
+    def report_fatal_error(error)
+      loc = find_location(error)
+
       <<~MSG
-        #{Rainbow("● #{name}").red.bright}
+        #{Rainbow("✕ #{name}").red.bright}
 
           #{Rainbow(error.message).red}
 
-          #{Rainbow("# #{location}").dimgray}
+          #{Rainbow(format_location(loc)).dimgray}
       MSG
     end
+
+    def find_location(error)
+      location = error.backtrace_locations.find do |loc|
+        loc.path.end_with?("_test.rb")
+      end
+      location or raise "Not found test location from #{error.inspect}"
+    end
+
+    def format_location(location)
+      path = Pathname(location.absolute_path).relative_path_from(Dir.pwd)
+      "# #{path}:#{location.lineno}:in `#{location.label}'"
+    end
   end
 end

data/lib/easytest/runner.rb

@@ -3,39 +3,72 @@ module Easytest
     attr_reader :start_time
     attr_accessor :passed_count
     attr_accessor :failed_count
+    attr_accessor :skipped_count
+    attr_accessor :todo_count
     attr_accessor :file_count
 
     def initialize(start_time: Time.now)
       @start_time = start_time
       @passed_count = 0
       @failed_count = 0
+      @skipped_count = 0
+      @todo_count = 0
       @file_count = 0
     end
 
     def run
-      cases_by_file = cases.group_by { |c| c.file }
-      cases_by_file.each do |file, cases|
+      include_only_case = cases.any?(&:only?)
+
+      cases.group_by(&:file).each do |file, cases_per_file|
         self.file_count += 1
+
         reports = []
 
-        cases.each do |c|
-          passed = c.run
 
-          if passed
+        cases_per_file.each do |c|
+          if include_only_case && !c.only?
+            c.skip!
+          end
+
+          result, report = c.run
+
+          case result
+          when :passed
             self.passed_count += 1
-          else
+          when :failed
             self.failed_count += 1
-            reports << c.report.gsub(/^/, "  ")
+          when :skipped
+            self.skipped_count += 1
+          when :todo
+            self.todo_count += 1
+          else
+            raise "Unknown result: #{result.inspect}"
           end
+
+          reports << [result, report] if report
         end
 
         link = Utils.terminal_hyperlink(file)
-        if reports.empty?
+
+        if reports.none? { |result, _| result == :failed }
           puts "#{Rainbow(" PASS ").bright.bg(:green)} #{link}"
         else
           puts "#{Rainbow(" FAIL ").bright.bg(:red)} #{link}"
-          reports.each { |report| puts report ; puts "" }
         end
+
+        reports
+          .sort_by do |result, _|
+            case result
+            when :skipped, :todo
+              0
+            else
+              1
+            end
+          end
+          .each do |result, report|
+            puts report.gsub(/^/, "  ").gsub(/^\s+$/, "")
+            puts "" if result == :failed
+          end
       end
 
       if no_tests?
@@ -65,7 +98,7 @@ module Easytest
     private
 
     def total_count
-      passed_count + failed_count
+      passed_count + failed_count + skipped_count + todo_count
     end
 
     def all_passed?
@@ -81,16 +114,26 @@ module Easytest
     end
 
     def summary
-      summary = ""
+      list = []
 
-      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}"
+      if failed_count > 0
+        list << Rainbow("#{failed_count} failed").red.bright
+      end
+
+      if skipped_count > 0
+        list << Rainbow("#{skipped_count} skipped").yellow.bright
       end
 
-      summary << ", #{total_count} total #{Rainbow("(#{file_count} files)").dimgray}"
+      if todo_count > 0
+        list << Rainbow("#{todo_count} todo").magenta.bright
+      end
+
+      list << Rainbow("#{passed_count} passed").green.bright
+
+      files_text = "#{file_count} #{Utils.pluralize("file", file_count)}"
+      list << "#{total_count} total #{Rainbow("(#{files_text})").dimgray}"
+
+      list.join(", ")
     end
   end
 end

data/lib/easytest/utils.rb

@@ -10,5 +10,15 @@ module Easytest
       # https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
       "\e]8;;file://#{path}\e\\#{Rainbow(dir).dimgray}#{base}\e]8;;\e\\"
     end
+
+    def raise_if_no_test_name(name, method:)
+      if name.nil? || name.empty?
+        raise FatalError.new("`#{method}` requires a name")
+      end
+    end
+
+    def pluralize(singular, count)
+      count == 1 ? singular : "#{singular}s"
+    end
   end
 end

data/lib/easytest/version.rb

@@ -1,3 +1,3 @@
 module Easytest
-  VERSION = "0.3.1"
+  VERSION = "0.5.0"
 end

data/lib/easytest.rb

@@ -17,11 +17,13 @@ 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/include"
 require_relative "easytest/matcher/instance_of"
 require_relative "easytest/matcher/kind_of"
+require_relative "easytest/matcher/match"
 require_relative "easytest/matcher/nil"
-require_relative "easytest/matcher/not_raise"
 require_relative "easytest/matcher/raise"
+require_relative "easytest/matcher/raise_nothing"
 require_relative "easytest/matcher/true"
 
 module Easytest

data/sig/easytest.rbs

@@ -11,22 +11,31 @@ module Easytest
     alias to_equal to_eq
 
     def to_be: (untyped expected) -> untyped
-
     def to_be_nil: () -> void
+    def to_be_false: () -> void
+    def to_be_true: () -> 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_include: (untyped expected) -> void
+
+    def to_match: (untyped expected) -> void
 
     def to_raise: ((Class | String | Regexp) expected) -> void
-    def to_not_raise: () -> void
+    def to_raise_nothing: () -> void
   end
 end
 
 module Kernel
+  # TODO: Can we avoid `RBS::DuplicatedMethodDefinitionError` "::Kernel#test has duplicated definitions"?
+  # def test: (String name) ?{ () -> void } -> void
+
+  def skip: (String name) { () -> void } -> void
+
+  def only: (String name) { () -> void } -> void
+
   def expect: (untyped actual) -> Easytest::Expectation
             | { () -> void } -> Easytest::Expectation
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easytest
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Masafumi Koba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -47,11 +47,13 @@ files:
 - lib/easytest/matcher/be_a.rb
 - lib/easytest/matcher/equal.rb
 - lib/easytest/matcher/false.rb
+- lib/easytest/matcher/include.rb
 - lib/easytest/matcher/instance_of.rb
 - lib/easytest/matcher/kind_of.rb
+- lib/easytest/matcher/match.rb
 - lib/easytest/matcher/nil.rb
-- lib/easytest/matcher/not_raise.rb
 - lib/easytest/matcher/raise.rb
+- lib/easytest/matcher/raise_nothing.rb
 - lib/easytest/matcher/true.rb
 - lib/easytest/reporter.rb
 - lib/easytest/runner.rb