easytest 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baf1f087a7353d74e8aa021313fd2f00c161af6cf5deb96552a5283e368f947f
-  data.tar.gz: 9ccc8f17a4911d3bc77abdd3916e4344e2965047ffe7d47d6794d88e6d8dd754
+  metadata.gz: 8b46bba7f2013706b78807e3ccda09b44711259717bda01d99d3610ee63436cb
+  data.tar.gz: 3231effd59cc137da79ce59eeb1db2acb5bccf58d951f69f4f6ab7ee38f58859
 SHA512:
-  metadata.gz: 7d907a3edc843501e6d20b408f358ca5cb0ec19b57a6ee7760577bbceff1fa078635209f439c0b5424ee72e2141c4a54ba51a8bb54c6a823406b55fd21246bd3
-  data.tar.gz: 7c01539bb3762b24f27f5483e86837a05844b8495c6bb9450557d610e978a9011e8c9012c39bb8c7288d7fd6296b9257583298e8c2255cf74492d271b9b83012
+  metadata.gz: eabd062a3db5062f77ea92a9316d148709af73e3f49d1ed8100eec9229273cc92a37a95fc6ebe671d487e0ecec4f7c38dc34347deb9a0d14c83a263488886115
+  data.tar.gz: 285b5df16fdd009212d0890fb3df87c9a8aba76f1019713060aca6e349beacb91591a6ddacafcf4b5d72bf120348c0017537e140938dcc6e6313d9e883db77f3

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.10.0
+
+- **Breaking:** Change refinement to `extend` in an anonymous module. The usage should change as follows:
+  ```diff
+  -using Easytest::DSL
+  +extend Easytest::DSL
+  ```
+- **Breaking:** Drop support for Ruby 2.7 (End-of-Life on March 31, 2023)
+- Remove extra whitespaces from console output.
+
+## 0.9.0
+
+- Add watch mode (`--watch`).
+- Improve type coverage.
+
 ## 0.8.1
 
 - Improve type-checking.

data/README.md

@@ -27,14 +27,14 @@ 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:
 
 ```ruby
 require "easytest"
 
-using Easytest::DSL
+extend Easytest::DSL
 
 test "addition" do
   expect(1 + 2).to_eq 2
@@ -54,8 +54,8 @@ $ easytest
     # test/addition_test.rb:6:in `block in <top (required)>'
 
 
- Tests:  1 failed, 0 passed, 1 total (1 files)
- Time:   0.00087 seconds
+Tests:  1 failed, 0 passed, 1 total (1 files)
+Time:   0.00087 seconds
 ```
 
 Oops. Let's fix the failure:
@@ -71,8 +71,8 @@ Then, run it again:
 $ easytest
  PASS  test/addition_test.rb
 
- Tests:  1 passed, 1 total (1 files)
- Time:   0.00077 seconds
+Tests:  1 passed, 1 total (1 files)
+Time:   0.00077 seconds
 ```
 
 The test now passes! 🎉
@@ -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:
+
+```shell
+easytest --watch
+```
+
+This *watch* mode is useful during development.

data/lib/easytest/case.rb

@@ -9,7 +9,7 @@ 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 or raise)
       @block = block

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,75 @@ 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 }
+        .each { load_test_file(_1) }
+    end
+
+    def load_test_file(file)
+      load(file, true)
+    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 { load_test_file(_1) }
+        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

@@ -1,32 +1,30 @@
 module Easytest
   module DSL
-    refine Kernel do
-      def test(name, &block)
-        Utils.raise_if_no_test_name(name, method: "test")
-        Easytest.add_case Case.new(name: name, &block)
-      end
+    def test(name, &block)
+      Utils.raise_if_no_test_name(name, method: "test")
+      Easytest.add_case Case.new(name: name, block: block)
+    end
 
-      def before(&block)
-        Easytest.add_hook Hook.new(type: :before, &block)
-      end
+    def before(&block)
+      Easytest.add_hook Hook.new(type: :before, block: block)
+    end
 
-      def after(&block)
-        Easytest.add_hook Hook.new(type: :after, &block)
-      end
+    def 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)
-      end
+    def skip(name, &block)
+      Utils.raise_if_no_test_name(name, method: "skip")
+      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)
-      end
+    def only(name, &block)
+      Utils.raise_if_no_test_name(name, method: "only")
+      Easytest.add_case Case.new(name: name, only: true, block: block)
+    end
 
-      def expect(actual = nil, &block)
-        Expectation.new(actual, &block)
-      end
+    def expect(actual = nil, &block)
+      Expectation.new(actual, &block)
     end
   end
 end

data/lib/easytest/hook.rb

@@ -4,7 +4,7 @@ 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 or raise)

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/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,17 +55,12 @@ 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 ""
-        puts " #{Rainbow('Tests:').bright}  #{summary}"
-        puts " #{Rainbow('Time:').bright}   #{elapsed_time.round(5)} seconds"
+        puts "#{Rainbow('Tests:').bright}  #{summary}"
+        puts "#{Rainbow('Time:').bright}   #{elapsed_time.round(5)} seconds"
         all_passed?
       end
     end
@@ -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.1"
+  VERSION = "0.10.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

@@ -5,6 +5,24 @@ module Easytest
 
   # Define methods for the Easytest DSL.
   module DSL
+    # Define a test case. If omitting a block, the case is considered a to-do.
+    def test: (String name) ?{ () -> void } -> void
+
+    # Run the given block before each test case.
+    def before: () { (Easytest::Case case) -> void } -> void
+
+    # Run the given block after each test case.
+    def after: () { (Easytest::Case case) -> void } -> void
+
+    # Skip the given test case.
+    def skip: (String name) { () -> void } -> void
+
+    # Run only the given test case.
+    def only: (String name) { () -> void } -> void
+
+    # Expect the given object or block to satisfy some criterion.
+    def expect: (untyped actual) -> Easytest::Expectation
+              | { () -> void } -> Easytest::Expectation
   end
 
   # An expectation in test cases.
@@ -69,24 +87,3 @@ module Easytest
     attr_reader name: String
   end
 end
-
-module Kernel
-  # TODO: Can we avoid `RBS::DuplicatedMethodDefinitionError` "::Kernel#test has duplicated definitions"?
-  # def test: (String name) ?{ () -> void } -> void
-
-  # Run the given block before each test case.
-  def before: () { (Easytest::Case case) -> void } -> void
-
-  # Run the given block after each test case.
-  def after: () { (Easytest::Case case) -> void } -> void
-
-  # Skip the given test case.
-  def skip: (String name) { () -> void } -> void
-
-  # Run only the given test case.
-  def only: (String name) { () -> void } -> void
-
-  # Expect the given object or block to satisfy some criterion.
-  def expect: (untyped actual) -> Easytest::Expectation
-            | { () -> void } -> Easytest::Expectation
-end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: easytest
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Masafumi Koba
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2023-09-14 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
@@ -73,7 +87,7 @@ metadata:
   source_code_uri: https://github.com/ybiquitous/easytest
   changelog_uri: https://github.com/ybiquitous/easytest/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -81,15 +95,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Easy testing for Ruby.
 test_files: []