easytest 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b72dfc70d7a8d0661cc8db8f80722598819cd167ff8eaeceeb15804088df94f0
-  data.tar.gz: 9e3fa802e2efb674630998420f726c32a24021b9eb5bac8df77696ed9e3aeb23
+  metadata.gz: 8fe89003a399189c3dd7be356b251a1b1e153e235aa2bc4419553cec6c7f84e2
+  data.tar.gz: 4ad8a1cf831976b0d79bb433500737826f74baef0204b6ee203c23dce5b6d17c
 SHA512:
-  metadata.gz: 956aa6d38ccbbca19cde275ecd821453c8858ff7ce2652528233a480563304ec71c0c1ace5337904a0895287a26aa088e0bd5a5622d602a43e89bd82e402078c
-  data.tar.gz: ab7b14d3296cf0b37c517ff61f57b5b46b5697c9fd01af278f2fb1ca44ebe11b6f085a14565f8094ea41660a5eebfc7ef123b5d1b542ddfd6281ceef2a4a48e5
+  metadata.gz: 4e2f0f400c9db1e4bd7b67dc8fbe48deb432d08ecf43c1698c7468f96120845d77d40a2a7d5c157a52d92ae5053d6492a9b25e3c96fd602cdf13294c0924f799
+  data.tar.gz: cdc76fce7cee5a8f12a1c8781c8aa3791a1f0d9e36aa6853187e7f32a9d49b50620bf8a7caa7a24c2033bcb83744f80108d9926dece7366466901f497bd4dac3

data/CHANGELOG.md

@@ -2,9 +2,14 @@
 
 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`.
+- **[Breaking]** Rename `to_not_raise` to `to_raise_nothing`.
 - Add `to_match` matcher.
 - Add `only` to run only any cases.
 

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.
@@ -78,8 +82,8 @@ The test now passes! 🎉
 If you want to skip any cases, you can change `test` to `skip`:
 
 ```diff
--test "addition" do
-+skip "addition" do
+- test "addition" do
++ skip "addition" do
 ```
 
 Skipped cases will be reported as "skipped".
@@ -89,8 +93,8 @@ Skipped cases will be reported as "skipped".
 If you want to run only any cases, you can use `test` to `only`:
 
 ```diff
--test "addition" do
-+only "addition" do
+- test "addition" do
++ only "addition" do
 ```
 
 Only cases with `only` will be run, and other cases will be skipped.

data/lib/easytest/version.rb

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

data/sig/easytest.rbs

@@ -1,29 +1,52 @@
+# 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
+
+    # 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
 
-    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 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
+
+    # Expect to raise nothing.
     def to_raise_nothing: () -> void
   end
 end
@@ -32,10 +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,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: easytest
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Masafumi Koba
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
 date: 2022-10-07 00:00:00.000000000 Z
@@ -68,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
@@ -84,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: []