easytest 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f45ff0adb716aa609a9fce9fd5eaefab60b8d56e4b2708a26b56d63189c3b78
-  data.tar.gz: 93b56e1770e0cd3a7d233580eddbd72737e56de4c5ebe405f244c6ca300f1ab9
+  metadata.gz: baf1f087a7353d74e8aa021313fd2f00c161af6cf5deb96552a5283e368f947f
+  data.tar.gz: 9ccc8f17a4911d3bc77abdd3916e4344e2965047ffe7d47d6794d88e6d8dd754
 SHA512:
-  metadata.gz: 14fe72a70136f6aeca4f044bee8c4616d6b3ac8ee32f43bb46b1c888dd70823e73574204c32a91dd48b5df73233e217adfc9b19d6a05c2181a4df2974a4cdb1b
-  data.tar.gz: 90bd1e9e0c2e30905e1c2b4875c29fdc93b861da2ae26cd3df8441bdd5b5bb973b27a9830fe9c5597593ca398362ebeb2b26e96dcb65d0f4a93c1ae76a56e7ac
+  metadata.gz: 7d907a3edc843501e6d20b408f358ca5cb0ec19b57a6ee7760577bbceff1fa078635209f439c0b5424ee72e2141c4a54ba51a8bb54c6a823406b55fd21246bd3
+  data.tar.gz: 7c01539bb3762b24f27f5483e86837a05844b8495c6bb9450557d610e978a9011e8c9012c39bb8c7288d7fd6296b9257583298e8c2255cf74492d271b9b83012

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.8.1
+
+- Improve type-checking.
+
+## 0.8.0
+
+- Add `before` and `after` hooks.
+- Add `to_have_attributes` matcher.
+- Add `to_satisfy` matcher.
+
 ## 0.7.0
 
 - Add `to_be_empty` matcher.

data/README.md

@@ -77,6 +77,24 @@ $ easytest
 
 The test now passes! 🎉
 
+### Hooks
+
+You can add hooks called `before` and `after` to each test case:
+
+```ruby
+before do
+  # set up something...
+end
+
+after do
+  # clean up something...
+end
+
+test "something" do
+  # test something...
+end
+```
+
 ### Skip
 
 If you want to skip any cases, you can change `test` to `skip`:

data/lib/easytest/case.rb

@@ -9,24 +9,20 @@ module Easytest
     alias skipped? skipped
     alias only? only
 
-    def initialize(name:, file:, skipped: false, only: false, &block)
+    def initialize(name:, skipped: false, only: false, &block)
       @name = name
-      @file = file
+      @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/dsl.rb

@@ -3,23 +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)
+      end
+
+      def before(&block)
+        Easytest.add_hook Hook.new(type: :before, &block)
+      end
 
-        file = caller_locations(1, 1).first.absolute_path
-        Easytest.add_case Case.new(name: name, file: file, &block)
+      def after(&block)
+        Easytest.add_hook Hook.new(type: :after, &block)
       end
 
       def skip(name, &block)
         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)
+        Easytest.add_case Case.new(name: name, 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)
+        Easytest.add_case Case.new(name: name, only: true, &block)
       end
 
       def expect(actual = nil, &block)

data/lib/easytest/expectation.rb

@@ -49,8 +49,16 @@ module Easytest
       Matcher::Match.new(actual: actual, expected: expected, negate: negate).match!
     end
 
-    def to_contain_exactly(*expected_items)
-      Matcher::ContainExactly.new(actual: actual, expected: expected_items, negate: negate).match!
+    def to_contain_exactly(*expected)
+      Matcher::ContainExactly.new(actual: actual, expected: expected, negate: negate).match!
+    end
+
+    def to_have_attributes(**expected)
+      Matcher::HaveAttributes.new(actual: actual, expected: expected, negate: negate).match!
+    end
+
+    def to_satisfy(&expected)
+      Matcher::Satisfy.new(actual: actual, expected: expected, negate: negate).match!
     end
 
     def to_raise(expected, with_message = nil)

data/lib/easytest/hook.rb

@@ -0,0 +1,27 @@
+module Easytest
+  class Hook
+    attr_reader :file
+    attr_reader :type
+    attr_reader :block
+
+    def initialize(type:, &block)
+      raise ArgumentError, "" unless [:before, :after].include?(type)
+
+      @file = (caller_locations(3, 1)&.first&.absolute_path or raise)
+      @type = type
+      @block = block
+    end
+
+    def run(test_case)
+      block.call(test_case)
+    end
+
+    def before?
+      type == :before
+    end
+
+    def after?
+      type == :after
+    end
+  end
+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/have_attributes.rb

@@ -0,0 +1,15 @@
+module Easytest
+  module Matcher
+    class HaveAttributes < Base
+      def match?
+        expected.all? do |name, value|
+          actual.send(name) == value
+        end
+      end
+
+      def message
+        "have attributes"
+      end
+    end
+  end
+end

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/matcher/satisfy.rb

@@ -0,0 +1,13 @@
+module Easytest
+  module Matcher
+    class Satisfy < Base
+      def match?
+        expected.call(actual) == true
+      end
+
+      def message
+        "satisfy"
+      end
+    end
+  end
+end

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

@@ -18,10 +18,15 @@ module Easytest
 
     def run
       include_only_case = cases.any?(&:only?)
+      hooks_by_file = hooks.group_by(&:file)
 
       cases.group_by(&:file).each do |file, cases_per_file|
         self.file_count += 1
 
+        hooks = hooks_by_file.fetch(file, [])
+        before_hooks = hooks.filter(&:before?)
+        after_hooks = hooks.filter(&:after?)
+
         reports = []
 
         cases_per_file.each do |c|
@@ -29,7 +34,12 @@ module Easytest
             c.skip!
           end
 
-          result, report = c.run
+          begin
+            before_hooks.each { |hook| hook.run(c) }
+            result, report = c.run
+          ensure
+            after_hooks.each { |hook| hook.run(c) }
+          end
 
           case result
           when :passed
@@ -82,6 +92,14 @@ module Easytest
       cases << new_case
     end
 
+    def hooks
+      @hooks ||= []
+    end
+
+    def add_hook(hook)
+      hooks << hook
+    end
+
     private
 
     def total_count

data/lib/easytest/version.rb

@@ -1,3 +1,3 @@
 module Easytest
-  VERSION = "0.7.0"
+  VERSION = "0.8.1"
 end

data/lib/easytest.rb

@@ -7,6 +7,7 @@ require_relative "easytest/case"
 require_relative "easytest/dsl"
 require_relative "easytest/errors"
 require_relative "easytest/expectation"
+require_relative "easytest/hook"
 require_relative "easytest/reporter"
 require_relative "easytest/runner"
 require_relative "easytest/utils"
@@ -19,6 +20,7 @@ require_relative "easytest/matcher/contain_exactly"
 require_relative "easytest/matcher/empty"
 require_relative "easytest/matcher/equal"
 require_relative "easytest/matcher/false"
+require_relative "easytest/matcher/have_attributes"
 require_relative "easytest/matcher/include"
 require_relative "easytest/matcher/instance_of"
 require_relative "easytest/matcher/kind_of"
@@ -26,6 +28,7 @@ require_relative "easytest/matcher/match"
 require_relative "easytest/matcher/nil"
 require_relative "easytest/matcher/raise"
 require_relative "easytest/matcher/raise_nothing"
+require_relative "easytest/matcher/satisfy"
 require_relative "easytest/matcher/true"
 
 module Easytest
@@ -34,7 +37,11 @@ module Easytest
   end
 
   def self.add_case(new_case)
-    @runner.cases << new_case
+    @runner.add_case(new_case)
+  end
+
+  def self.add_hook(hook)
+    @runner.add_hook(hook)
   end
 
   def self.run

data/sig/easytest.rbs

@@ -1,4 +1,4 @@
-# A easy testing framework.
+# An easy testing framework.
 module Easytest
   # The Easytest version.
   VERSION: String
@@ -7,10 +7,10 @@ module Easytest
   module DSL
   end
 
-  # Define methods for the Easytest DSL.
+  # 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
@@ -47,21 +47,39 @@ module Easytest
     def to_match: (untyped expected) -> void
 
     # Expect to contain all the given items regardless of order.
-    def to_contain_exactly: (*untyped expected_items) -> void
+    def to_contain_exactly: (*untyped expected) -> void
+
+    # Expect to have the given attributes.
+    def to_have_attributes: (**untyped expected) -> void
+
+    # Expect to satisfy a condition that the given block returns `true`.
+    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.
     def to_raise_nothing: () -> void
   end
+
+  # A test case.
+  class Case
+    # A test case name.
+    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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easytest
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Masafumi Koba
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -42,6 +42,7 @@ files:
 - lib/easytest/dsl.rb
 - lib/easytest/errors.rb
 - lib/easytest/expectation.rb
+- lib/easytest/hook.rb
 - lib/easytest/matcher/base.rb
 - lib/easytest/matcher/be.rb
 - lib/easytest/matcher/be_a.rb
@@ -49,6 +50,7 @@ files:
 - lib/easytest/matcher/empty.rb
 - lib/easytest/matcher/equal.rb
 - lib/easytest/matcher/false.rb
+- lib/easytest/matcher/have_attributes.rb
 - lib/easytest/matcher/include.rb
 - lib/easytest/matcher/instance_of.rb
 - lib/easytest/matcher/kind_of.rb
@@ -56,6 +58,7 @@ files:
 - lib/easytest/matcher/nil.rb
 - lib/easytest/matcher/raise.rb
 - lib/easytest/matcher/raise_nothing.rb
+- lib/easytest/matcher/satisfy.rb
 - lib/easytest/matcher/true.rb
 - lib/easytest/reporter.rb
 - lib/easytest/runner.rb