easytest 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b604c00c58f93e811ba779e0581b57b8eed7df6ef57504bea9239083663af42c
-  data.tar.gz: 8912feb299336ea7e242d1f7349fca2cb089af40f751f6c4478c535594eb6269
+  metadata.gz: 1a0b3705ffc7039bfb7ac442d22bce3abf4f6cbb4a100b2f88a637b658d462e3
+  data.tar.gz: f578262b1621be8e67811a048c3ce0b6c1fb592a82c482a0a945d7b97e221f0c
 SHA512:
-  metadata.gz: 0f423c20fe3812b906a37498275cd46c5fe5ac9996b8296f0c3ae7e8889d8a73f643310a82d2e2ffbaee48c393f5a94debe3c2e20b71c1d0710fe1f16491009c
-  data.tar.gz: 267b8496e9faea80de95d311bb5d1abb48959499b9765ff37cf588e600950f6a8a5e20b13a21af90818180ad8509d5d7ca74cd1962dc3b3e5eb0fe541f43e8f5
+  metadata.gz: fe5a6d95407ebccecd912cc2ef7624f449e304662004db4b361be58ccd0ec0a758ed380c8af5efc6632a1172e7acac8e6361274274fa33d6daa0a835e592affb
+  data.tar.gz: 406ab02728e1d3b58fa18bae5122f5af0691a72c8aaa5568b4d3d572d750419aaea8af9e2b18b15ab03aa24097b75370d1c16bd5bc220af5956820fb399ada3d

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
+## 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.
+- Avoid unstable `Enumerable#sort_by` method.
+
 ## 0.6.0
 
 - Add `to_contain_exactly` 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,9 +9,9 @@ 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
       @block = block
       @skipped = skipped
       @only = only

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

@@ -14,15 +14,15 @@ module Easytest
     end
 
     def to_be_nil
-      Matcher::Nil.new(actual: actual, negate: negate).match!
+      Matcher::Nil.new(actual: actual, expected: nil, negate: negate).match!
     end
 
     def to_be_true
-      Matcher::True.new(actual: actual, negate: negate).match!
+      Matcher::True.new(actual: actual, expected: true, negate: negate).match!
     end
 
     def to_be_false
-      Matcher::False.new(actual: actual, negate: negate).match!
+      Matcher::False.new(actual: actual, expected: false, negate: negate).match!
     end
 
     def to_be_a(expected)
@@ -37,6 +37,10 @@ module Easytest
       Matcher::InstanceOf.new(actual: actual, expected: expected, negate: negate).match!
     end
 
+    def to_be_empty
+      Matcher::Empty.new(actual: actual, expected: nil, negate: negate).match!
+    end
+
     def to_include(expected)
       Matcher::Include.new(actual: actual, expected: expected, negate: negate).match!
     end
@@ -45,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
+      @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/empty.rb

@@ -0,0 +1,13 @@
+module Easytest
+  module Matcher
+    class Empty < Base
+      def match?
+        actual.empty?
+      end
+
+      def message
+        "empty"
+      end
+    end
+  end
+end

data/lib/easytest/matcher/false.rb

@@ -1,10 +1,6 @@
 module Easytest
   module Matcher
     class False < Base
-      def initialize(actual:, negate:)
-        super(actual: actual, expected: false, negate: negate)
-      end
-
       def match?
         actual == expected
       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/nil.rb

@@ -1,10 +1,6 @@
 module Easytest
   module Matcher
     class Nil < Base
-      def initialize(actual:, negate:)
-        super(actual: actual, expected: nil, negate: negate)
-      end
-
       def match?
         actual.nil?
       end

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

@@ -1,10 +1,6 @@
 module Easytest
   module Matcher
     class True < Base
-      def initialize(actual:, negate:)
-        super(actual: actual, expected: true, negate: negate)
-      end
-
       def match?
         actual == expected
       end

data/lib/easytest/runner.rb

@@ -18,19 +18,28 @@ 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
 
-        reports = []
+        hooks = hooks_by_file.fetch(file, [])
+        before_hooks = hooks.filter(&:before?)
+        after_hooks = hooks.filter(&:after?)
 
+        reports = []
 
         cases_per_file.each do |c|
           if include_only_case && !c.only?
             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
@@ -56,19 +65,7 @@ module Easytest
           puts "#{Rainbow(" FAIL ").bright.bg(:red)} #{link}"
         end
 
-        reports
-          .sort_by do |result, _|
-            case result
-            when :skipped, :todo
-              0
-            else
-              1
-            end
-          end
-          .each do |result, report|
-            puts report.gsub(/^/, "  ").gsub(/^\s+$/, "")
-            puts "" if result == :failed
-          end
+        print_reports(reports)
       end
 
       if no_tests?
@@ -95,6 +92,14 @@ module Easytest
       cases << new_case
     end
 
+    def hooks
+      @hooks ||= []
+    end
+
+    def add_hook(hook)
+      hooks << hook
+    end
+
     private
 
     def total_count
@@ -109,6 +114,20 @@ module Easytest
       total_count == 0
     end
 
+    def print_reports(reports)
+      unexecuted = [:skipped, :todo]
+      indent = "  "
+
+      reports.each do |result, report|
+        puts Utils.indent_text(report, indent) if unexecuted.include?(result)
+      end
+
+      reports.each do |result, report|
+        puts Utils.indent_text(report, indent) unless unexecuted.include?(result)
+        puts "" if result == :failed
+      end
+    end
+
     def elapsed_time
       Time.now - start_time
     end

data/lib/easytest/utils.rb

@@ -20,5 +20,9 @@ module Easytest
     def pluralize(singular, count)
       count == 1 ? singular : "#{singular}s"
     end
+
+    def indent_text(text, indent_string)
+      text.gsub(/^(.+)/, "#{indent_string}\\1")
+    end
   end
 end

data/lib/easytest/version.rb

@@ -1,3 +1,3 @@
 module Easytest
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 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"
@@ -16,8 +17,10 @@ require_relative "easytest/matcher/base"
 require_relative "easytest/matcher/be"
 require_relative "easytest/matcher/be_a"
 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"
@@ -25,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
@@ -33,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,7 +7,7 @@ module Easytest
   module DSL
   end
 
-  # Define methods for the Easytest DSL.
+  # An expectation in test cases.
   class Expectation
     # Negate an expectation.
     def not: () -> instance
@@ -37,6 +37,9 @@ module Easytest
     # Expect to be an instance of the given class (module).
     def to_be_instance_of: (Module expected) -> void
 
+    # Expect to be empty.
+    def to_be_empty: () -> void
+
     # Expect to include the given object.
     def to_include: (untyped expected) -> void
 
@@ -44,7 +47,13 @@ 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
@@ -53,12 +62,24 @@ module Easytest
     # Expect to raise nothing.
     def to_raise_nothing: () -> void
   end
+
+  # A test case.
+  class Case
+    # Return a test case name.
+    def 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.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Masafumi Koba
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2022-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -42,12 +42,15 @@ 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
 - lib/easytest/matcher/contain_exactly.rb
+- 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
@@ -55,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