easytest 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea89da5a0f2aba7252ea69be567591284bfcc1f53aa089e4824eb54773881b0b
-  data.tar.gz: b9bb01188ce657b918cdffe80cb962fd4e3c011fa9a4556b832d49eeed8fef5d
+  metadata.gz: 9c1fb5f44f3dd5d049cd6775120712a614f7016a20c7f87d771043642ceb7bb6
+  data.tar.gz: '04591bad578ad4351de07ab07467378663cea9e0de2d40930aea5d4a3d132bac'
 SHA512:
-  metadata.gz: 6b1539eeef25d6343a411a05afbfcff6143d9f33798fb5f3d13dbf8f3d742ea79247ced5c5da1a994bc0d77b41787ec8c7477ed06b26664ef30987007291ad26
-  data.tar.gz: c5e5ebe81739839785eab40d24a3d4e529d7c33f0d2ac5fd5cc20bf2984b65849d6b99f18b46848f6d17d362dfdc95fb16ae7d0f3403b77913a6b182b0f1fc9a
+  metadata.gz: 718b38f0a0fc35339bdaae214baf115de1ee8d4a94bb20d157f102af5caf08a763580e2946976504443e3b45211fc5d8776668b353c9a9c07e5ed9abddca03e3
+  data.tar.gz: 4784ee059e028d9d8a7c6ed23d864182e280ced00d56e502b87d31b032212bde623b50b66fed087583f0ee24eda939900915d8d25fe9081bdf33b020930b7423

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 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.

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,7 +40,7 @@ end
 Then, run `easytest`:
 
 ```console
-$ bundle exec easytest
+$ easytest
  FAIL  test/addition_test.rb
   ● addition  (should equal)
 
@@ -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/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/expectation.rb

@@ -1,16 +1,5 @@
 module Easytest
   class Expectation
-    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
@@ -48,11 +37,12 @@ module Easytest
       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: exception_class, negate: negate).match!
+      Matcher::Raise.new(actual: block, expected: expected, negate: negate).match!
     end
 
     def to_not_raise
@@ -60,5 +50,18 @@ module Easytest
 
       Matcher::NotRaise.new(actual: block).match!
     end
+
+    private
+
+    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/raise.rb

@@ -30,7 +30,7 @@ module Easytest
         when Regexp
           actual.message.match? expected
         else
-          raise TypeError.new "Class, String, or Regexp is allowed: #{expected}"
+          false
         end
       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.2.0"
+  VERSION = "0.3.0"
 end

data/lib/easytest.rb

@@ -4,7 +4,6 @@ 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"

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.2.0
+  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
@@ -57,6 +57,7 @@ files:
 - lib/easytest/runner.rb
 - lib/easytest/utils.rb
 - lib/easytest/version.rb
+- sig/easytest.rbs
 homepage: https://github.com/ybiquitous/easytest
 licenses:
 - MIT