easytest 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e87217a9622ad5c57a2b97d64fc8e0a6cf32c264b53901644740b4727363d1bf
-  data.tar.gz: 5703988217fdf9bc1e0aad99c2c5609a6e159e80d546124f0108ba4414dc1638
+  metadata.gz: 8fe89003a399189c3dd7be356b251a1b1e153e235aa2bc4419553cec6c7f84e2
+  data.tar.gz: 4ad8a1cf831976b0d79bb433500737826f74baef0204b6ee203c23dce5b6d17c
 SHA512:
-  metadata.gz: 98e353f726337a6d5b2b9aaad59a4bca8801f06885dc2e9f8f5c0dce6655e2d8e5ab178ede9f7d3b229e2e4f92b8896a5895454d211c8222570cf8e81ababea5
-  data.tar.gz: 88eff8410c841dffd3457beb20a3f78aaba46347ce724a680d9420f0e7831ce37d1ddcef9233a29758049a8b5e336f183781dc572b89531cd7472276984e5bb5
+  metadata.gz: 4e2f0f400c9db1e4bd7b67dc8fbe48deb432d08ecf43c1698c7468f96120845d77d40a2a7d5c157a52d92ae5053d6492a9b25e3c96fd602cdf13294c0924f799
+  data.tar.gz: cdc76fce7cee5a8f12a1c8781c8aa3791a1f0d9e36aa6853187e7f32a9d49b50620bf8a7caa7a24c2033bcb83744f80108d9926dece7366466901f497bd4dac3

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.5.1
+
+- Add RDoc to RBS.
+- Publish the official website.
+
+## 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.

data/README.md

@@ -9,18 +9,22 @@ Easytest is a tiny testing framework for Ruby with a familiar DSL.
 
 ## Installation
 
-via Bundler:
+Add this line to your `Gemfile` for Bundler:
 
-```shell
-bundle add easytest
+```ruby
+gem "easytest"
 ```
 
-via gem:
+Or install it via `gem`:
 
 ```shell
 gem install easytest
 ```
 
+## Documentation
+
+You can read more about Easytest on the [official website](https://ybiquitous.github.io/easytest/).
+
 ## Usage
 
 Here is a very easy example.
@@ -75,19 +79,32 @@ The test now passes! 🎉
 
 ### Skip
 
-If you want to skip a case, you can change `test` to `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
-+skip "addition" do
-   expect(1 + 2).to_eq 2
- end
+- 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 a to-do case, you can use `test` without a block:
+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

@@ -4,27 +4,30 @@ module Easytest
     attr_reader :file
     attr_reader :block
     attr_reader :skipped
+    attr_reader :only
+
     alias skipped? skipped
+    alias only? only
 
-    def initialize(name:, file:, skipped: false, &block)
+    def initialize(name:, file:, skipped: false, only: false, &block)
       @name = name
       @file = file
       @block = block
       @skipped = skipped
+      @only = only
     end
 
     def todo?
       block.nil?
     end
 
-    def run
-      if todo?
-        return [:todo, Reporter.new(name).report_todo]
-      end
+    def skip!
+      @skipped = true
+    end
 
-      if skipped?
-        return [:skipped, Reporter.new(name).report_skip]
-      end
+    def run
+      return [:todo, Reporter.new(name).report_todo] if todo?
+      return [:skipped, Reporter.new(name).report_skip] if skipped?
 
       block.call
       [:passed, nil]

data/lib/easytest/dsl.rb

@@ -2,19 +2,26 @@ module Easytest
   module DSL
     refine Kernel do
       def test(name, &block)
-        raise FatalError, "`test` requires a name" if name.nil? || name.empty?
+        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)
-        raise FatalError, "`skip` requires a name" if name.nil? || name.empty?
+        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

@@ -41,18 +41,22 @@ module Easytest
       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/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/runner.rb

@@ -17,13 +17,19 @@ module Easytest
     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|
+
+        cases_per_file.each do |c|
+          if include_only_case && !c.only?
+            c.skip!
+          end
+
           result, report = c.run
 
           case result
@@ -123,7 +129,9 @@ module Easytest
       end
 
       list << Rainbow("#{passed_count} passed").green.bright
-      list << "#{total_count} total #{Rainbow("(#{file_count} files)").dimgray}"
+
+      files_text = "#{file_count} #{Utils.pluralize("file", file_count)}"
+      list << "#{total_count} total #{Rainbow("(#{files_text})").dimgray}"
 
       list.join(", ")
     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.4.0"
+  VERSION = "0.5.1"
 end

data/lib/easytest.rb

@@ -20,9 +20,10 @@ 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

@@ -1,30 +1,53 @@
+# A easy testing framework.
 module Easytest
+  # The Easytest version.
   VERSION: String
 
+  # Define methods for the Easytest DSL.
   module DSL
   end
 
+  # Define methods for the Easytest DSL.
   class Expectation
+    # Negate an expectation.
     def not: () -> instance
 
+    # Expect to equal the given object.
     def to_eq: (untyped expected) -> void
     alias to_equal to_eq
 
+    # Expect to be the same as the given object.
     def to_be: (untyped expected) -> untyped
 
+    # Expect to be `nil`. Same as `to_be(nil)`.
     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
-
+    # Expect to be `false`. Same as `to_be(false)`.
     def to_be_false: () -> void
+
+    # Expect to be `true`. Same as `to_be(true)`.
     def to_be_true: () -> void
 
+    # Expect to be an instance of the given class (module) or its subclasses.
+    def to_be_a: (Module expected) -> void
+
+    # Expect to be an instance of the given class (module) or its subclasses.
+    def to_be_kind_of: (Module expected) -> void
+
+    # Expect to be an instance of the given class (module).
+    def to_be_instance_of: (Module expected) -> void
+
+    # Expect to include the given object.
     def to_include: (untyped expected) -> void
 
+    # Expect to match the given object.
+    def to_match: (untyped expected) -> void
+
+    # Expect to raise the given exception or an exception with the given message.
     def to_raise: ((Class | String | Regexp) expected) -> void
-    def to_not_raise: () -> void
+
+    # Expect to raise nothing.
+    def to_raise_nothing: () -> void
   end
 end
 
@@ -32,8 +55,13 @@ module Kernel
   # TODO: Can we avoid `RBS::DuplicatedMethodDefinitionError` "::Kernel#test has duplicated definitions"?
   # def test: (String name) ?{ () -> 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easytest
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Masafumi Koba
-autorequire: 
+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
@@ -50,9 +50,10 @@ files:
 - 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
@@ -67,7 +68,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
@@ -83,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Easy testing for Ruby.
 test_files: []