easytest 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a0b3705ffc7039bfb7ac442d22bce3abf4f6cbb4a100b2f88a637b658d462e3
-  data.tar.gz: f578262b1621be8e67811a048c3ce0b6c1fb592a82c482a0a945d7b97e221f0c
+  metadata.gz: 9a953eabbcc6eb08f30507561d26309fd305983f9f6be7f0c2e2e1a1ce3410b5
+  data.tar.gz: 86ae0173c242a2069944836dcf48795960f29af50f3bb62c41aae2f079cc86df
 SHA512:
-  metadata.gz: fe5a6d95407ebccecd912cc2ef7624f449e304662004db4b361be58ccd0ec0a758ed380c8af5efc6632a1172e7acac8e6361274274fa33d6daa0a835e592affb
-  data.tar.gz: 406ab02728e1d3b58fa18bae5122f5af0691a72c8aaa5568b4d3d572d750419aaea8af9e2b18b15ab03aa24097b75370d1c16bd5bc220af5956820fb399ada3d
+  metadata.gz: aeabfbd63843ff8edb06d2929f65c20c6a748da8f85f2d60b67dc87b7e446776cb76f524ae6ca48aae0601846a9f4da48b1d961f71f32b502697cff9a98e09e5
+  data.tar.gz: 87f634738fa05e63a1ac0e544965b15b72b6e66b44eccf806102894318f042eb286890cf1c559815c6681f958ec499e06fcbddae2fdee989c76430a7ff6460c2

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.9.0
+
+- Add watch mode (`--watch`).
+- Improve type coverage.
+
+## 0.8.1
+
+- Improve type-checking.
+
 ## 0.8.0
 
 - Add `before` and `after` hooks.

data/README.md

@@ -27,7 +27,7 @@ You can read more about Easytest on the [official website](https://ybiquitous.gi
 
 ## Usage
 
-Here is a very easy example.
+This section explains easy usage.
 
 First, put `test/addition_test.rb` as below:
 
@@ -126,3 +126,13 @@ test "addition"
 ```
 
 To-do cases will be reported as "todo".
+
+### Watch
+
+If you want to run tests immediately when changing code, specify the `--watch` option:
+
+```console
+$ easytest --watch
+```
+
+This *watch* mode is useful during development.

data/lib/easytest/case.rb

@@ -9,24 +9,20 @@ module Easytest
     alias skipped? skipped
     alias only? only
 
-    def initialize(name:, skipped: false, only: false, &block)
+    def initialize(name:, skipped: false, only: false, block: nil)
       @name = name
-      @file = caller_locations(3, 1).first.absolute_path
+      @file = (caller_locations(3, 1)&.first&.absolute_path or raise)
       @block = block
       @skipped = skipped
       @only = only
     end
 
-    def todo?
-      block.nil?
-    end
-
     def skip!
       @skipped = true
     end
 
     def run
-      return [:todo, Reporter.new(name).report_todo] if todo?
+      return [:todo, Reporter.new(name).report_todo] unless block
       return [:skipped, Reporter.new(name).report_skip] if skipped?
 
       block.call

data/lib/easytest/cli.rb

@@ -8,9 +8,14 @@ module Easytest
     FATAL = 2
 
     def run
-      exit_code = parse_options
+      exit_code = parse_argv
       return exit_code if exit_code
 
+      if watch?
+        watch_files
+        return SUCCESS
+      end
+
       Easytest.start
       setup
       successful = Easytest.run
@@ -21,33 +26,41 @@ module Easytest
 
     attr_reader :argv
     attr_reader :start_time
+    attr_reader :options
+    attr_reader :parser
 
     def initialize(argv)
       @argv = argv
       @start_time = Time.now
+      @options = {}
+      @parser = init_parser
     end
 
-    def parse_options
-      options = {}
+    def init_parser
+      OptionParser.new do |op|
+        op.program_name = "easytest"
+        op.version = "#{op.program_name} #{Easytest::VERSION}"
 
-      parser = OptionParser.new do |p|
-        p.program_name = "easytest"
-        p.version = "#{p.program_name} #{Easytest::VERSION}"
+        op.on "-w", "--watch" do
+          options[:watch] = true
+        end
 
-        p.on "--help" do
+        op.on "--help" do
           options[:help] = true
         end
 
-        p.on "--version" do
+        op.on "--version" do
           options[:version] = true
         end
       end
+    end
 
+    def parse_argv
       begin
         parser.parse!(argv)
 
         if options[:help]
-          puts help(parser)
+          puts help
           return SUCCESS
         end
 
@@ -63,37 +76,73 @@ module Easytest
       end
     end
 
-    def help(parser)
+    def help
+      program = Rainbow(parser.program_name).green
+      heading = ->(text) { Rainbow(text).bright }
+      secondary = ->(text) { Rainbow(text).dimgray }
+      option = ->(text) { Rainbow(text).yellow }
+      prompt = ->() { Rainbow("$").cyan }
+
       <<~MSG
-        #{Rainbow("USAGE").bright}
-          #{parser.program_name} [options] [<file, directory, or pattern>...]
+        #{heading["USAGE"]}
+          #{program} [options] [<file, directory, or pattern>...]
 
-        #{Rainbow("OPTIONS").bright}
-          --help      Show help
-          --version   Show version
+        #{heading["OPTIONS"]}
+          #{option["-w, --watch"]}    Watch file changes and rerun test
+          #{option["--help"]}         Show help
+          #{option["--version"]}      Show version
 
-        #{Rainbow("EXAMPLES").bright}
-          # Run all tests (test/**/*_test.rb)
-          $ easytest
+        #{heading["EXAMPLES"]}
+          #{secondary["# Run all tests (test/**/*_test.rb)"]}
+          #{prompt[]} #{program}
 
-          # Run only test files
-          $ easytest test/example_test.rb
+          #{secondary["# Run only test files"]}
+          #{prompt[]} #{program} test/example_test.rb
 
-          # Run only test files in specified directories
-          $ easytest test/example
+          #{secondary["# Run only test files in given directories"]}
+          #{prompt[]} #{program} test/example
 
-          # Run only test files that matches specified patterns
-          $ easytest example
+          #{secondary["# Run only test files that matches given patterns"]}
+          #{prompt[]} #{program} example
       MSG
     end
 
     def setup
-      Dir.glob(Easytest.test_files_location)
-        .map { |file| File.absolute_path(file) }
+      test_files
         .filter do |file|
           argv.empty? || argv.any? { |pattern| file.include?(pattern) }
         end
         .each { |test_file| load test_file }
     end
+
+    def test_files
+      Dir.glob(Easytest.test_files_location).map do |file|
+        File.absolute_path(file)
+      end
+    end
+
+    def watch?
+      options[:watch] == true
+    end
+
+    def watch_files
+      require "listen"
+      listener = Listen.to(Easytest.test_dir, only: /_test\.rb$/) do |modified, added|
+        Easytest.start(no_tests_forbidden: false)
+        test_files.intersection(modified + added).each do |file|
+          load(file)
+        end
+        Easytest.run
+      end
+      listener.start
+
+      begin
+        puts "Start watching \"#{Easytest.test_files_location}\" changed. Press Ctrl-C to stop."
+        sleep
+      rescue Interrupt
+        puts
+        puts "Stopped watching."
+      end
+    end
   end
 end

data/lib/easytest/dsl.rb

@@ -3,25 +3,25 @@ module Easytest
     refine Kernel do
       def test(name, &block)
         Utils.raise_if_no_test_name(name, method: "test")
-        Easytest.add_case Case.new(name: name, &block)
+        Easytest.add_case Case.new(name: name, block: block)
       end
 
       def before(&block)
-        Easytest.add_hook Hook.new(type: :before, &block)
+        Easytest.add_hook Hook.new(type: :before, block: block)
       end
 
       def after(&block)
-        Easytest.add_hook Hook.new(type: :after, &block)
+        Easytest.add_hook Hook.new(type: :after, block: block)
       end
 
       def skip(name, &block)
         Utils.raise_if_no_test_name(name, method: "skip")
-        Easytest.add_case Case.new(name: name, skipped: true, &block)
+        Easytest.add_case Case.new(name: name, skipped: true, block: block)
       end
 
       def only(name, &block)
         Utils.raise_if_no_test_name(name, method: "only")
-        Easytest.add_case Case.new(name: name, only: true, &block)
+        Easytest.add_case Case.new(name: name, only: true, block: block)
       end
 
       def expect(actual = nil, &block)

data/lib/easytest/hook.rb

@@ -4,10 +4,10 @@ module Easytest
     attr_reader :type
     attr_reader :block
 
-    def initialize(type:, &block)
+    def initialize(type:, block:)
       raise ArgumentError, "" unless [:before, :after].include?(type)
 
-      @file = caller_locations(3, 1).first.absolute_path
+      @file = (caller_locations(3, 1)&.first&.absolute_path or raise)
       @type = type
       @block = block
     end

data/lib/easytest/matcher/base.rb

@@ -22,6 +22,8 @@ module Easytest
         raise_match_error unless matched
       end
 
+      private
+
       def message
         raise NotImplementedError
       end

data/lib/easytest/matcher/contain_exactly.rb

@@ -2,7 +2,7 @@ module Easytest
   module Matcher
     class ContainExactly < Base
       def match?
-        (actual.to_a - expected).empty?
+        (Array(actual) - Array(expected)).empty?
       end
 
       def message

data/lib/easytest/matcher/raise.rb

@@ -3,9 +3,9 @@ module Easytest
     class Raise < Base
       attr_reader :with_message
 
-      def initialize(**kwargs)
-        @with_message = kwargs.delete(:with_message)
-        super(**kwargs)
+      def initialize(actual:, expected:, negate:, with_message:)
+        super(actual: actual, expected: expected, negate: negate)
+        @with_message = with_message
       end
 
       def match?

data/lib/easytest/reporter.rb

@@ -51,14 +51,15 @@ module Easytest
     end
 
     def find_location(error)
-      location = error.backtrace_locations.find do |loc|
-        loc.path.end_with?("_test.rb")
+      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)
+      absolute_path = location.absolute_path or raise
+      path = Pathname(absolute_path).relative_path_from(Dir.pwd)
       "# #{path}:#{location.lineno}:in `#{location.label}'"
     end
   end

data/lib/easytest/runner.rb

@@ -1,21 +1,5 @@
 module Easytest
   class Runner
-    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
       include_only_case = cases.any?(&:only?)
       hooks_by_file = hooks.group_by(&:file)
@@ -27,6 +11,7 @@ module Easytest
         before_hooks = hooks.filter(&:before?)
         after_hooks = hooks.filter(&:after?)
 
+        # @type var reports: Array[[Symbol, String]]
         reports = []
 
         cases_per_file.each do |c|
@@ -34,12 +19,13 @@ module Easytest
             c.skip!
           end
 
-          begin
-            before_hooks.each { |hook| hook.run(c) }
-            result, report = c.run
-          ensure
-            after_hooks.each { |hook| hook.run(c) }
-          end
+          result, report =
+            begin
+              before_hooks.each { |hook| hook.run(c) }
+              c.run
+            ensure
+              after_hooks.each { |hook| hook.run(c) }
+            end
 
           case result
           when :passed
@@ -69,12 +55,7 @@ module Easytest
       end
 
       if no_tests?
-        $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
+        print_error_for_no_tests if no_tests_forbidden?
         false
       else
         puts ""
@@ -102,6 +83,26 @@ module Easytest
 
     private
 
+    attr_reader :start_time
+    attr_reader :no_tests_forbidden
+    alias no_tests_forbidden? no_tests_forbidden
+
+    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, no_tests_forbidden: true)
+      @start_time = start_time
+      @no_tests_forbidden = no_tests_forbidden
+      @passed_count = 0
+      @failed_count = 0
+      @skipped_count = 0
+      @todo_count = 0
+      @file_count = 0
+    end
+
     def total_count
       passed_count + failed_count + skipped_count + todo_count
     end
@@ -114,6 +115,15 @@ module Easytest
       total_count == 0
     end
 
+    def print_error_for_no_tests
+      $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
+    end
+
     def print_reports(reports)
       unexecuted = [:skipped, :todo]
       indent = "  "
@@ -133,6 +143,7 @@ module Easytest
     end
 
     def summary
+      # @type var list: Array[String]
       list = []
 
       if failed_count > 0

data/lib/easytest/version.rb

@@ -1,3 +1,3 @@
 module Easytest
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/easytest.rb

@@ -32,8 +32,8 @@ require_relative "easytest/matcher/satisfy"
 require_relative "easytest/matcher/true"
 
 module Easytest
-  def self.start
-    @runner = Runner.new
+  def self.start(no_tests_forbidden: true)
+    @runner = Runner.new(no_tests_forbidden: no_tests_forbidden)
   end
 
   def self.add_case(new_case)
@@ -48,7 +48,11 @@ module Easytest
     @runner.run
   end
 
+  def self.test_dir
+    "test"
+  end
+
   def self.test_files_location
-    "test/**/*_test.rb"
+    "#{test_dir}/**/*_test.rb"
   end
 end

data/sig/easytest.rbs

@@ -9,8 +9,8 @@ module Easytest
 
   # An expectation in test cases.
   class Expectation
-    # Negate an expectation.
-    def not: () -> instance
+    # Negate this expectation.
+    def not: () -> Expectation
 
     # Expect to equal the given object.
     def to_eq: (untyped expected) -> void
@@ -56,7 +56,7 @@ module Easytest
     def to_satisfy: () { (untyped actual) -> bool } -> void
 
     # Expect to raise the given exception or an exception with the given message.
-    def to_raise: (Class expected, ?(String | Regexp) with_message) -> void
+    def to_raise: (Class expected, ?(String | Regexp)? with_message) -> void
                 | ((String | Regexp) expected) -> void
 
     # Expect to raise nothing.
@@ -65,8 +65,8 @@ module Easytest
 
   # A test case.
   class Case
-    # Return a test case name.
-    def name: () -> String
+    # A test case name.
+    attr_reader name: String
   end
 end
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: easytest
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Masafumi Koba
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2022-10-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement