Add return type annotations

Addresses Crystal compiler warning about abstract method return types.

spec/helpers/errored_example.cr

@@ -1,17 +1,17 @@
 # Example that always raises an exception.
 class ErroredExample < Spectator::RunnableExample
   # Dummy description.
-  def what
+  def what : Symbol | String
     "ERROR"
   end
 
   # Dummy source.
-  def source
+  def source : ::Spectator::Source
     ::Spectator::Source.new(__FILE__, __LINE__)
   end
 
   # Dummy symbolic flag.
-  def symbolic?
+  def symbolic? : Bool
     false
   end
 

spec/helpers/failing_example.cr

@@ -1,17 +1,17 @@
 # Example that always fails.
 class FailingExample < Spectator::RunnableExample
   # Dummy description.
-  def what
+  def what : Symbol | String
     "FAIL"
   end
 
   # Dummy source.
-  def source
+  def source : ::Spectator::Source
     ::Spectator::Source.new(__FILE__, __LINE__)
   end
 
   # Dummy symbolic flag.
-  def symbolic?
+  def symbolic? : Bool
     false
   end
 

spec/helpers/passing_example.cr

@@ -6,17 +6,17 @@ class PassingExample < Spectator::RunnableExample
   end
 
   # Dummy description.
-  def what
+  def what : Symbol | String
     "PASS"
   end
 
   # Dummy source.
-  def source
+  def source : ::Spectator::Source
     ::Spectator::Source.new(__FILE__, __LINE__)
   end
 
   # Dummy symbolic flag.
-  def symbolic?
+  def symbolic? : Bool
     @symbolic
   end
 

spec/helpers/spy_example.cr

@@ -2,17 +2,17 @@
 # This is useful for capturing what's going on when an event is running.
 class SpyExample < Spectator::RunnableExample
   # Dummy description.
-  def what
+  def what : Symbol | String
     "SPY"
   end
 
   # Dummy source.
-  def source
+  def source : ::Spectator::Source
     ::Spectator::Source.new(__FILE__, __LINE__)
   end
 
   # Dummy symbolic flag.
-  def symbolic?
+  def symbolic? : Bool
     false
   end
 

spec/pending_example_spec.cr

@@ -1,15 +1,15 @@
 require "./spec_helper"
 
 class ConcretePendingExample < Spectator::PendingExample
-  def what
+  def what : Symbol | String
     "PENDING_TEST_EXAMPLE"
   end
 
-  def source
+  def source : ::Spectator::Source
     ::Spectator::Source.new(__FILE__, __LINE__)
   end
 
-  def symbolic?
+  def symbolic? : Bool
     false
   end
 

src/spectator/composite_example_filter.cr

@@ -6,7 +6,7 @@ module Spectator
     end
 
     # Checks whether the example satisfies the filter.
-    def includes?(example)
+    def includes?(example) : Bool
       @filters.any?(&.includes?(example))
     end
   end

src/spectator/dummy_example.cr

@@ -10,17 +10,17 @@ module Spectator
   # This class shouldn't be used, it's just to trick the compiler.
   private class DummyExample < RunnableExample
     # Dummy description.
-    def what
+    def what : Symbol | String
       "DUMMY"
     end
 
     # Dummy symbolic flag.
-    def symbolic?
+    def symbolic? : Bool
       false
     end
 
     # Dummy source.
-    def source
+    def source : Source
       Source.new(__FILE__, __LINE__)
     end
 

src/spectator/example.cr

@@ -4,8 +4,12 @@ module Spectator
   # Base class for all types of examples.
   # Concrete types must implement the `#run_impl, `#what`, `#instance`, and `#source` methods.
   abstract class Example < ExampleComponent
+    @finished = false
+
     # Indicates whether the example has already been run.
-    getter? finished = false
+    def finished? : Bool
+      @finished
+    end
 
     # Group that the example belongs to.
     getter group : ExampleGroup
@@ -36,12 +40,12 @@ module Spectator
     end
 
     # Indicates there is only one example to run.
-    def example_count
+    def example_count : Int
       1
     end
 
     # Retrieve the current example.
-    def [](index : Int)
+    def [](index : Int) : Example
       self
     end
 

src/spectator/example_component.cr

@@ -3,7 +3,7 @@ module Spectator
   # This is used as the base node type for the composite design pattern.
   abstract class ExampleComponent
     # Text that describes the context or test.
-    abstract def what : String
+    abstract def what : Symbol | String
 
     # Indicates whether the example (or group) has been completely run.
     abstract def finished? : Bool

src/spectator/example_group.cr

@@ -18,6 +18,7 @@ module Spectator
     # Creates the example group.
     # The hooks are stored to be triggered later.
     def initialize(@hooks : ExampleHooks, @conditions : ExampleConditions)
+      @example_count = 0
       @before_all_hooks_run = false
       @after_all_hooks_run = false
     end
@@ -53,7 +54,9 @@ module Spectator
     end
 
     # Number of examples in this group and all sub-groups.
-    getter example_count = 0
+    def example_count : Int
+      @example_count
+    end
 
     # Retrieves an example by its index.
     # This recursively searches for an example.
@@ -118,7 +121,7 @@ module Spectator
     end
 
     # Checks whether all examples in the group have been run.
-    def finished?
+    def finished? : Bool
       children.all?(&.finished?)
     end
 

src/spectator/formatting/failure_junit_test_case.cr

@@ -11,7 +11,7 @@ module Spectator::Formatting
     end
 
     # Status string specific to the result type.
-    private def status
+    private def status : String
       "FAIL"
     end
 

src/spectator/formatting/skipped_junit_test_case.cr

@@ -11,7 +11,7 @@ module Spectator::Formatting
     end
 
     # Status string specific to the result type.
-    private def status
+    private def status : String
       "TODO"
     end
 

src/spectator/formatting/successful_junit_test_case.cr

@@ -9,7 +9,7 @@ module Spectator::Formatting
     end
 
     # Status string specific to the result type.
-    private def status
+    private def status : String
       "PASS"
     end
   end

src/spectator/line_example_filter.cr

@@ -6,7 +6,7 @@ module Spectator
     end
 
     # Checks whether the example satisfies the filter.
-    def includes?(example)
+    def includes?(example) : Bool
       @line == example.source.line
     end
   end

src/spectator/matchers/all_matcher.cr

@@ -16,7 +16,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "all #{matcher.description}"
     end
 

src/spectator/matchers/array_matcher.cr

@@ -17,7 +17,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "contains exactly #{expected.label}"
     end
 

src/spectator/matchers/attributes_matcher.cr

@@ -20,7 +20,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "has attributes #{expected.label}"
     end
 

src/spectator/matchers/case_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "matches #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       expected.value === actual.value
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} does not match #{expected.label}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} matched #{expected.label}"
     end
   end

src/spectator/matchers/change_exact_matcher.cr

@@ -21,7 +21,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "changes #{expression.label} from #{expected_before.inspect} to #{expected_after.inspect}"
     end
 

src/spectator/matchers/change_from_matcher.cr

@@ -19,7 +19,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "changes #{expression.label} from #{expected}"
     end
 

src/spectator/matchers/change_matcher.cr

@@ -17,7 +17,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "changes #{expression.label}"
     end
 

src/spectator/matchers/change_relative_matcher.cr

@@ -17,7 +17,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "changes #{expression.label} #{@relativity}"
     end
 

src/spectator/matchers/change_to_matcher.cr

@@ -19,7 +19,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "changes #{expression.label} to #{expected}"
     end
 

src/spectator/matchers/collection_matcher.cr

@@ -8,12 +8,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "is in #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       expected.value.includes?(actual.value)
     end
 
@@ -23,7 +23,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is not in #{expected.label}"
     end
 
@@ -34,7 +34,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is in #{expected.label}"
     end
 

src/spectator/matchers/contain_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "contains #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       expected.value.all? do |item|
         actual.value.includes?(item)
       end
@@ -24,7 +24,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} does not match #{expected.label}"
     end
 
@@ -35,7 +35,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} contains #{expected.label}"
     end
 

src/spectator/matchers/empty_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "is empty"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       actual.value.empty?
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is not empty"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is empty"
     end
   end

src/spectator/matchers/end_with_matcher.cr

@@ -17,7 +17,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "ends with #{expected.label}"
     end
 

src/spectator/matchers/equality_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "equals #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       expected.value == actual.value
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} does not equal #{expected.label}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} equals #{expected.label}"
     end
   end

src/spectator/matchers/exception_matcher.cr

@@ -21,7 +21,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       if (message = @expected)
         "raises #{ExceptionType} with message #{message}"
       else

src/spectator/matchers/failed_match_data.cr

@@ -4,7 +4,7 @@ module Spectator::Matchers
   # Information about a failed match.
   struct FailedMatchData < MatchData
     # Indicates that the match failed.
-    def matched?
+    def matched? : Bool
       false
     end
 

src/spectator/matchers/greater_than_equal_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "greater than or equal to #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       actual.value >= expected.value
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is less than #{expected.label}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is greater than or equal to #{expected.label}"
     end
 

src/spectator/matchers/greater_than_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "greater than #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       actual.value > expected.value
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is less than or equal to #{expected.label}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is greater than #{expected.label}"
     end
 

src/spectator/matchers/have_key_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "has key #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       actual.value.has_key?(expected.value)
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} does not have key #{expected.label}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} has key #{expected.label}"
     end
 

src/spectator/matchers/have_matcher.cr

@@ -8,12 +8,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "includes #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       if (value = actual.value).is_a?(String)
         match_string?(value)
       else
@@ -46,7 +46,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} does not include #{expected.label}"
     end
 
@@ -57,7 +57,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} includes #{expected.label}"
     end
 

src/spectator/matchers/have_predicate_matcher.cr

@@ -17,7 +17,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "has #{expected.label}"
     end
 
@@ -48,7 +48,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} does not have #{expected.label}"
     end
 
@@ -59,7 +59,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} has #{expected.label}"
     end
 
@@ -76,7 +76,7 @@ module Spectator::Matchers
     end
 
     # Checks if all predicate methods from the snapshot of them are satisified.
-    private def match?(snapshot)
+    private def match?(snapshot) : Bool
       # Test each predicate and immediately return false if one is false.
       {% for attribute in ExpectedType.keys %}
       return false unless snapshot[{{attribute.symbolize}}]

src/spectator/matchers/have_value_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "has value #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       actual.value.has_value?(expected.value)
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} does not have value #{expected.label}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} has value #{expected.label}"
     end
 

src/spectator/matchers/inequality_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "is not equal to #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       expected.value != actual.value
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is equal to #{expected.label}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is not equal to #{expected.label}"
     end
 

src/spectator/matchers/less_than_equal_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "less than or equal to #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       actual.value <= expected.value
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is greater than #{expected.label}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is less than or equal to #{expected.label}"
     end
 

src/spectator/matchers/less_than_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "less than #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       actual.value < expected.value
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is greater than or equal to #{expected.label}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is less than #{expected.label}"
     end
 

src/spectator/matchers/nil_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "is nil"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       actual.value.nil?
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is not nil"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is nil"
     end
   end

src/spectator/matchers/predicate_matcher.cr

@@ -16,7 +16,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "is #{expected.label}"
     end
 
@@ -47,7 +47,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is not #{expected.label}"
     end
 
@@ -58,7 +58,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is #{expected.label}"
     end
 

src/spectator/matchers/range_matcher.cr

@@ -7,7 +7,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "is in #{expected.label}"
     end
 
@@ -26,7 +26,7 @@ module Spectator::Matchers
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       expected.value.includes?(actual.value)
     end
 
@@ -36,7 +36,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is not in #{expected.label} (#{exclusivity})"
     end
 
@@ -47,7 +47,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is in #{expected.label} (#{exclusivity})"
     end
 

src/spectator/matchers/reference_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "is #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       expected.value.same?(actual.value)
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is not #{expected.label}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is #{expected.label}"
     end
   end

src/spectator/matchers/respond_matcher.cr

@@ -9,7 +9,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "responds to #{label}"
     end
 

src/spectator/matchers/size_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "has size #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       expected.value == actual.value.size
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} does not have #{expected.label} elements"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} has #{expected.label} elements"
     end
 

src/spectator/matchers/size_of_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "is the same size as #{expected.label}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       expected.value.size == actual.value.size
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is not the same size as #{expected.label}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is the same size as #{expected.label}"
     end
 

src/spectator/matchers/start_with_matcher.cr

@@ -16,7 +16,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "starts with #{expected.label}"
     end
 

src/spectator/matchers/successful_match_data.cr

@@ -4,7 +4,7 @@ module Spectator::Matchers
   # Information about a successful match.
   struct SuccessfulMatchData < MatchData
     # Indicates that the match succeeded.
-    def matched?
+    def matched? : Bool
       true
     end
   end

src/spectator/matchers/truthy_matcher.cr

@@ -18,7 +18,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "is #{label}"
     end
 
@@ -83,7 +83,7 @@ module Spectator::Matchers
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       @truthy == !!actual.value
     end
 
@@ -93,7 +93,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is #{negated_label}"
     end
 
@@ -104,7 +104,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is #{label}"
     end
 

src/spectator/matchers/type_matcher.cr

@@ -7,12 +7,12 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "is as #{Expected}"
     end
 
     # Checks whether the matcher is satisifed with the expression given to it.
-    private def match?(actual : TestExpression(T)) forall T
+    private def match?(actual : TestExpression(T)) : Bool forall T
       actual.value.is_a?(Expected)
     end
 
@@ -22,7 +22,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message(actual)
+    private def failure_message(actual) : String
       "#{actual.label} is not a #{Expected}"
     end
 
@@ -33,7 +33,7 @@ module Spectator::Matchers
     #
     # The message should typically only contain the test expression labels.
     # Actual values should be returned by `#values`.
-    private def failure_message_when_negated(actual)
+    private def failure_message_when_negated(actual) : String
       "#{actual.label} is a #{Expected}"
     end
 

src/spectator/matchers/unordered_array_matcher.cr

@@ -14,7 +14,7 @@ module Spectator::Matchers
     # Short text about the matcher's purpose.
     # This explains what condition satisfies the matcher.
     # The description is used when the one-liner syntax is used.
-    def description
+    def description : String
       "contains #{expected.label} in any order"
     end
 

src/spectator/name_example_filter.cr

@@ -6,7 +6,7 @@ module Spectator
     end
 
     # Checks whether the example satisfies the filter.
-    def includes?(example)
+    def includes?(example) : Bool
       @name == example.to_s
     end
   end

src/spectator/nested_example_group.cr

@@ -23,7 +23,7 @@ module Spectator
     end
 
     # Indicates wheter the group references a type.
-    def symbolic?
+    def symbolic? : Bool
       @what.is_a?(Symbol)
     end
 

src/spectator/null_example_filter.cr

@@ -2,7 +2,7 @@ module Spectator
   # Filter that matches all examples.
   class NullExampleFilter < ExampleFilter
     # Checks whether the example satisfies the filter.
-    def includes?(example)
+    def includes?(example) : Bool
       true
     end
   end

src/spectator/pending_example.cr

@@ -5,7 +5,7 @@ module Spectator
   # This class will not run example code.
   abstract class PendingExample < Example
     # Returns a pending result.
-    private def run_impl
+    private def run_impl : Result
       PendingResult.new(self)
     end
   end

src/spectator/root_example_group.cr

@@ -5,12 +5,12 @@ module Spectator
   # The root has no parent.
   class RootExampleGroup < ExampleGroup
     # Dummy value - this should never be used.
-    def what
+    def what : Symbol | String
       "ROOT"
     end
 
     # Indicates that the group is symbolic.
-    def symbolic?
+    def symbolic? : Bool
       true
     end
 

src/spectator/runnable_example.cr

@@ -8,7 +8,7 @@ module Spectator
   abstract class RunnableExample < Example
     # Runs the example, hooks, and captures the result
     # and translates to a usable result.
-    def run_impl
+    def run_impl : Result
       result = capture_result
       expectations = Internals::Harness.current.expectations
       translate_result(result, expectations)

src/spectator/source_example_filter.cr

@@ -7,7 +7,7 @@ module Spectator
     end
 
     # Checks whether the example satisfies the filter.
-    def includes?(example)
+    def includes?(example) : Bool
       @source === example.source
     end
   end