Improve type coverage (#27)

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## Head
+
+- Improve type coverage.
+
 ## 0.8.1
 
 - Improve type-checking.

Rakefile

@@ -5,7 +5,7 @@ require "rdoc/task"
 task default: %i[lint test]
 
 desc "Run lint"
-task lint: %i[rubocop rbs:setup typecheck:run rdoc]
+task lint: %i[rubocop rbs:setup typecheck:run typecheck:stats rdoc]
 
 RuboCop::RakeTask.new
 
@@ -30,6 +30,11 @@ namespace :typecheck do
   task :save do
     sh "steep check --save-expectations"
   end
+
+  desc "Show type coverage stats"
+  task :stats do
+    sh "steep stats --format=table"
+  end
 end
 
 namespace :rbs do

lib/easytest/case.rb

@@ -9,7 +9,7 @@ class Case
     alias skipped? skipped
     alias only? only
 
-    def initialize(name:, skipped: false, only: false, &block)
+    def initialize(name:, skipped: false, only: false, block: nil)
       @name = name
       @file = (caller_locations(3, 1)&.first&.absolute_path or raise)
       @block = block

lib/easytest/cli.rb

@@ -28,6 +28,7 @@ def initialize(argv)
     end
 
     def parse_options
+      # @type var options: Hash[Symbol, bool]
       options = {}
 
       parser = OptionParser.new do |p|

lib/easytest/dsl.rb

@@ -3,25 +3,25 @@ module DSL
     refine Kernel do
       def test(name, &block)
         Utils.raise_if_no_test_name(name, method: "test")
-        Easytest.add_case Case.new(name: name, &block)
+        Easytest.add_case Case.new(name: name, block: block)
       end
 
       def before(&block)
-        Easytest.add_hook Hook.new(type: :before, &block)
+        Easytest.add_hook Hook.new(type: :before, block: block)
       end
 
       def after(&block)
-        Easytest.add_hook Hook.new(type: :after, &block)
+        Easytest.add_hook Hook.new(type: :after, block: block)
       end
 
       def skip(name, &block)
         Utils.raise_if_no_test_name(name, method: "skip")
-        Easytest.add_case Case.new(name: name, skipped: true, &block)
+        Easytest.add_case Case.new(name: name, skipped: true, block: block)
       end
 
       def only(name, &block)
         Utils.raise_if_no_test_name(name, method: "only")
-        Easytest.add_case Case.new(name: name, only: true, &block)
+        Easytest.add_case Case.new(name: name, only: true, block: block)
       end
 
       def expect(actual = nil, &block)

lib/easytest/hook.rb

@@ -4,7 +4,7 @@ class Hook
     attr_reader :type
     attr_reader :block
 
-    def initialize(type:, &block)
+    def initialize(type:, block:)
       raise ArgumentError, "" unless [:before, :after].include?(type)
 
       @file = (caller_locations(3, 1)&.first&.absolute_path or raise)

lib/easytest/matcher/contain_exactly.rb

@@ -2,7 +2,7 @@ module Easytest
   module Matcher
     class ContainExactly < Base
       def match?
-        (actual.to_a - expected).empty?
+        (Array(actual) - Array(expected)).empty?
       end
 
       def message

lib/easytest/runner.rb

@@ -27,19 +27,21 @@ def run
         before_hooks = hooks.filter(&:before?)
         after_hooks = hooks.filter(&:after?)
 
+        # @type var reports: Array[[Symbol, String]]
         reports = []
 
         cases_per_file.each do |c|
           if include_only_case && !c.only?
             c.skip!
           end
 
-          begin
-            before_hooks.each { |hook| hook.run(c) }
-            result, report = c.run
-          ensure
-            after_hooks.each { |hook| hook.run(c) }
-          end
+          result, report =
+            begin
+              before_hooks.each { |hook| hook.run(c) }
+              c.run
+            ensure
+              after_hooks.each { |hook| hook.run(c) }
+            end
 
           case result
           when :passed
@@ -133,6 +135,7 @@ def elapsed_time
     end
 
     def summary
+      # @type var list: Array[String]
       list = []
 
       if failed_count > 0

sig-private/easytest/case.rbs

@@ -12,7 +12,7 @@ module Easytest
 
     alias only? only
 
-    def initialize: (name: String, ?skipped: bool, ?only: bool) ?{ () -> void } -> void
+    def initialize: (name: String, ?skipped: bool, ?only: bool, ?block: (^() -> void)?) -> void
 
     def skip!: () -> void
 

sig-private/easytest/hook.rbs

@@ -6,7 +6,7 @@ module Easytest
 
     attr_reader block: ^(Case) -> void
 
-    def initialize: (type: Symbol) { (Case) -> void } -> void
+    def initialize: (type: Symbol, block: ^(Case) -> void) -> void
 
     def run: (Case test_case) -> void
 

sig-private/easytest/matcher/base.rbs

@@ -1,15 +1,15 @@
 module Easytest
   module Matcher
-    class Base
-      attr_reader actual: untyped
+    class Base[A, E]
+      attr_reader actual: A
 
-      attr_reader expected: untyped
+      attr_reader expected: E
 
       attr_reader negate: bool
 
       alias negate? negate
 
-      def initialize: (actual: untyped, expected: untyped, ?negate: bool) -> void
+      def initialize: (actual: A, expected: E, ?negate: bool) -> void
 
       def match?: () -> bool
 

sig-private/easytest/matcher/be.rbs

@@ -1,6 +1,6 @@
 module Easytest
   module Matcher
-    class Be < Base
+    class Be < Base[Object, Object]
     end
   end
 end

sig-private/easytest/matcher/be_a.rbs

@@ -1,6 +1,6 @@
 module Easytest
   module Matcher
-    class BeA < Base
+    class BeA < Base[Object, Module]
     end
   end
 end

sig-private/easytest/matcher/contain_exactly.rbs

@@ -1,6 +1,16 @@
 module Easytest
   module Matcher
-    class ContainExactly < Base
+    interface _ToA
+      def to_a: () -> Array[untyped]
+    end
+
+    interface _ToAry
+      def to_ary: () -> Array[untyped]
+    end
+
+    type array_like = _ToA | _ToAry
+
+    class ContainExactly < Base[array_like, array_like]
     end
   end
 end

sig-private/easytest/matcher/empty.rbs

@@ -1,6 +1,10 @@
 module Easytest
   module Matcher
-    class Empty < Base
+    interface _Empty
+      def empty?: () -> bool
+    end
+
+    class Empty < Base[_Empty, untyped]
     end
   end
 end

sig-private/easytest/matcher/equal.rbs

@@ -1,6 +1,6 @@
 module Easytest
   module Matcher
-    class Equal < Base
+    class Equal < Base[Object, untyped]
     end
   end
 end

sig-private/easytest/matcher/false.rbs

@@ -1,6 +1,6 @@
 module Easytest
   module Matcher
-    class False < Base
+    class False < Base[bool, untyped]
     end
   end
 end

sig-private/easytest/matcher/have_attributes.rbs

@@ -1,6 +1,6 @@
 module Easytest
   module Matcher
-    class HaveAttributes < Base
+    class HaveAttributes < Base[Object, Hash[Symbol, untyped]]
     end
   end
 end

sig-private/easytest/matcher/include.rbs

@@ -1,6 +1,10 @@
 module Easytest
   module Matcher
-    class Include < Base
+    interface _Include
+      def include?: (untyped) -> bool
+    end
+
+    class Include < Base[_Include, untyped]
     end
   end
 end

sig-private/easytest/matcher/instance_of.rbs

@@ -1,6 +1,6 @@
 module Easytest
   module Matcher
-    class InstanceOf < Base
+    class InstanceOf < Base[Object, Module]
     end
   end
 end

sig-private/easytest/matcher/kind_of.rbs

@@ -1,6 +1,6 @@
 module Easytest
   module Matcher
-    class KindOf < Base
+    class KindOf < Base[Object, Module]
     end
   end
 end

sig-private/easytest/matcher/match.rbs

@@ -1,6 +1,10 @@
 module Easytest
   module Matcher
-    class Match < Base
+    interface _Match
+      def match?: (untyped) -> bool
+    end
+
+    class Match < Base[_Match, untyped]
     end
   end
 end

sig-private/easytest/matcher/nil.rbs

@@ -1,6 +1,6 @@
 module Easytest
   module Matcher
-    class Nil < Base
+    class Nil < Base[Object, untyped]
     end
   end
 end

sig-private/easytest/matcher/raise.rbs

@@ -1,11 +1,11 @@
 module Easytest
   module Matcher
-    class Raise < Base
+    class Raise < Base[Proc, untyped]
       @raised_error: Exception
 
       attr_reader with_message: (String | Regexp)?
 
-      def initialize: (actual: untyped, expected: untyped, negate: bool, with_message: (String | Regexp)?) -> void
+      def initialize: (actual: Proc, expected: untyped, negate: bool, with_message: (String | Regexp)?) -> void
 
       private
 

sig-private/easytest/matcher/raise_nothing.rbs

@@ -1,9 +1,9 @@
 module Easytest
   module Matcher
-    class RaiseNothing < Base
+    class RaiseNothing < Base[Proc, untyped]
       @raised_error: Exception
 
-      def initialize: (actual: untyped) -> void
+      def initialize: (actual: Proc) -> void
     end
   end
 end

sig-private/easytest/matcher/satisfy.rbs

@@ -1,6 +1,6 @@
 module Easytest
   module Matcher
-    class Satisfy < Base
+    class Satisfy < Base[untyped, Proc]
     end
   end
 end

sig-private/easytest/matcher/true.rbs

@@ -1,6 +1,6 @@
 module Easytest
   module Matcher
-    class True < Base
+    class True < Base[bool, untyped]
     end
   end
 end

steep_expectations.yml

@@ -42,16 +42,6 @@
               ::Object <: ::String
                 ::BasicObject <: ::String
     code: Ruby::ArgumentTypeMismatch
-  - range:
-      start:
-        line: 6
-        character: 31
-      end:
-        line: 6
-        character: 34
-    severity: ERROR
-    message: The method cannot be called without a block
-    code: Ruby::RequiredBlockMissing
   - range:
       start:
         line: 6