petitest 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c22fb01aaa90a168cd116fc8c99313dab896a85
-  data.tar.gz: f30f8cc4416912d7765cb27cdd650dd853c385ab
+  metadata.gz: 94d661afca2ae26812fcfd79ffd3c54e1fbd4085
+  data.tar.gz: 26ce49148e23ff5e854b4ae1898ab7c11250a81b
 SHA512:
-  metadata.gz: 38043bfacf0205fc857e1d86fa266d4a02aa08864361b5d302ad8860da9365aa5ac473e028440a98e08f432334f23854308a08c834dfc781850cf31539e1cafe
-  data.tar.gz: 7ac2359c9a3fc6b3679b8e3d461f5b47a32782e29ab7fd26bfa7545956b7b64e92ee9bf75b4a286e2edcae2ab40a9af2f8c42e5f73ea99ff3185cb6e41a1c108
+  metadata.gz: 4e6243251265c19413ffff8923419cccf9c436e9c12ae058abb22d9545464270ac294ed87bec5d3f57ddb350fd9910e96013d947c820e3295e1cebe6bb7a5ce5
+  data.tar.gz: b68470322a44f4155d482e0d154758f2c09188a3f670452b0542a03d8087f950506e899ba10c0aa1c3fa9bca82c6e2dccef4c6c15e62d984ed9a04c02e3f935a

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v0.2.0
+
+- Merge errors into failures
+- Change test message interface
+- Remove utility assertions except for `#assert`
+- Add Petitest.configuration.backtrace_filter
+- Stop tests if any error occured before running tests
+- Improve report about empty errors/failures
+
 ## v0.1.3
 
 - Fix OutputConcern bug

data/README.md

@@ -110,3 +110,4 @@ Times:
 ## Plug-ins
 
 - https://github.com/petitest/petitest-power_assert
+- https://github.com/petitest/petitest-tap

data/lib/petitest.rb

@@ -1,5 +1,4 @@
 require "petitest/assertion_failure_error"
-require "petitest/assertions"
 require "petitest/configuration"
 require "petitest/subscriber_concerns/output_concern"
 require "petitest/subscriber_concerns/time_concern"
@@ -12,9 +11,6 @@ require "petitest/test_group"
 require "petitest/test_method"
 require "petitest/texts/base_text"
 require "petitest/texts/error_message_text"
-require "petitest/texts/errors_element_text"
-require "petitest/texts/errors_text"
-require "petitest/texts/failure_message_text"
 require "petitest/texts/failures_element_text"
 require "petitest/texts/failures_text"
 require "petitest/texts/filtered_backtrace_text"

data/lib/petitest/assertion_failure_error.rb

@@ -1,40 +1,4 @@
 module Petitest
   class AssertionFailureError < ::StandardError
-    # @return [String, nil]
-    attr_reader :additional_message
-
-    # @return [String]
-    attr_reader :template
-
-    # @return [Hash{Symbol => Object}]
-    attr_reader :template_variables
-
-    # @param additional_message [String, nil]
-    # @param template [String]
-    # @param template_variables [Hash, nil]
-    def initialize(
-      additional_message:,
-      template:,
-      template_variables:
-    )
-      @additional_message = additional_message
-      @template = template
-      @template_variables = template_variables
-      super(assertion_type_message)
-    end
-
-    # @return [String]
-    def assertion_type_message
-      template % inspected_template_variables
-    end
-
-    private
-
-    # @return [Hash{Symbol => String}]
-    def inspected_template_variables
-      template_variables.map do |key, value|
-        [key, value.inspect]
-      end.to_h
-    end
   end
 end

data/lib/petitest/autorun.rb

@@ -1,6 +1,9 @@
 require "petitest"
 
 at_exit do
+  if $! && !($!.is_a?(::SystemExit) && $!.success?)
+    next
+  end
   test_cases = Petitest::TestGroup.test_cases
   result = Petitest::TestCasesRunner.new(test_cases).run
   exit_code = result ? 0 : 1

data/lib/petitest/configuration.rb

@@ -1,31 +1,48 @@
 module Petitest
   class Configuration
-    DEFAULT_COLOR_SCHEME = {
-      detail: :cyan,
-      error: :red,
-      failure: :red,
-      pass: :green,
-      skip: :yellow,
-    }
+    attr_writer :backtrace_filters
 
-    # @return [Hash{Symbol => Symbol}]
-    attr_accessor :color_scheme
+    attr_writer :color
+
+    attr_writer :color_scheme
+
+    attr_writer :output
+
+    attr_writer :subscribers
+
+    # @return [Array<String>]
+    def backtrace_filters
+      @backtrace_filters ||= begin
+        path = ::File.expand_path("../..", __FILE__)
+        [-> (line) { line.start_with?(path) }]
+      end
+    end
 
     # @return [Boolean]
-    attr_accessor :color
+    def color
+      @color ||= true
+    end
+
+    # @return [Hash{Symbol => Symbol}]
+    def color_scheme
+      @color_scheme ||= {
+        detail: :cyan,
+        error: :red,
+        pass: :green,
+        skip: :yellow,
+      }
+    end
 
     # @return [IO]
-    attr_accessor :output
+    def output
+      @output ||= ::STDOUT.tap do |io|
+        io.sync = true
+      end
+    end
 
     # @return [Array<Petitest::Subscribers::BaseSubscriber>]
-    attr_accessor :subscribers
-
-    def initialize
-      @color_scheme = DEFAULT_COLOR_SCHEME.dup
-      @color = true
-      @output = ::STDOUT
-      @output.sync = true
-      @subscribers = [::Petitest::Subscribers::ProgressReportSubscriber.new]
+    def subscribers
+      @subscribers ||= [::Petitest::Subscribers::ProgressReportSubscriber.new]
     end
   end
 end

data/lib/petitest/subscribers/json_report_subscriber.rb

@@ -15,14 +15,11 @@ module Petitest
         data = {
           test_cases: test_cases.map do |test_case|
             {
-              aborted: test_case.aborted?,
               backtrace: test_case.backtrace,
               class_name: test_case.test_group_class.to_s,
               error_class_name: test_case.error_class_name,
               error_message: test_case.error_message,
               failed: test_case.failed?,
-              failure_additional_message: test_case.failure_additional_message,
-              failure_assertion_type_message: test_case.failure_assertion_type_message,
               finished_at: test_case.finished_at.iso8601(6),
               method_line_number: test_case.test_method.line_number,
               method_name: test_case.test_method.method_name,

data/lib/petitest/test_case.rb

@@ -15,13 +15,6 @@ module Petitest
     # @return [Petitest::TestMethod]
     attr_reader :test_method
 
-    class << self
-      # @return [String]
-      def prefix_to_filter_backtrace
-        @prefix_to_filter_backtrace ||= ::File.expand_path("../..", __FILE__)
-      end
-    end
-
     # @param test_group_class [Class]
     # @param test_method [Petitest::TestMethod]
     def initialize(
@@ -34,75 +27,47 @@ module Petitest
       @test_method = test_method
     end
 
-    # @return [Boolean]
-    def aborted?
-      processed? && has_error? && !has_assertion_error?
-    end
-
     # @return [Array<String>, nil]
     def backtrace
-      if has_error?
+      if error
         error.backtrace
       end
     end
 
     # @return [String, nil]
     def error_class_name
-      if aborted?
+      if error
         error.class.to_s
       end
     end
 
     # @return [String, nil]
     def error_message
-      if aborted?
+      if error
         error.to_s
       end
     end
 
-    # @return [String, nil]
-    def failure_additional_message
-      if failed?
-        error.additional_message
-      end
-    end
-
-    # @return [String, nil]
-    def failure_assertion_type_message
-      if failed?
-        error.assertion_type_message
-      end
-    end
-
     # @return [Boolean]
     def failed?
-      processed? && has_assertion_error?
+      processed? && !error.nil?
     end
 
     # @return [Array<String>, nil]
     def filtered_backtrace
       @filtered_backtrace ||= begin
+        path = ::File.expand_path("../test_group.rb", __FILE__)
         backtrace.reverse_each.each_with_object([]) do |line, lines|
-          if line.start_with?(::File.expand_path("../assertions.rb", __FILE__))
+          if line.start_with?(path)
             break lines
           end
-          unless line.start_with?(self.class.prefix_to_filter_backtrace)
+          unless ::Petitest.configuration.backtrace_filters.any? { |filter| filter === line }
             lines << line
           end
         end.reverse
       end
     end
 
-    # @return [Boolean]
-    def has_assertion_error?
-      error.is_a?(::Petitest::AssertionFailureError)
-    end
-
-    # @return [Boolean]
-    def has_error?
-      !error.nil?
-    end
-
     # @return [Boolean]
     def passed?
       processed? && error.nil?

data/lib/petitest/test_group.rb

@@ -1,7 +1,5 @@
 module Petitest
   class TestGroup
-    include ::Petitest::Assertions
-
     TEST_METHOD_NAME_PREFIX = "test_"
 
     class << self
@@ -16,7 +14,7 @@ module Petitest
         descendants << sub_class
       end
 
-      # @return [Array<Petit::TestCase]
+      # @return [Array<Petit::TestCase>]
       def test_cases
         descendants.flat_map do |test_group_class|
           test_group_class.test_methods.map do |test_method|
@@ -47,5 +45,28 @@ module Petitest
         end
       end
     end
+
+    # @param actual_or_message [Object]
+    # @param message [String, nil]
+    def assert(actual_or_message = nil, message = nil, &block)
+      if block
+        message = actual_or_message
+        check(message || "Given block returned falsy", &block)
+      else
+        actual = actual_or_message
+        check(message || "#{actual.inspect} is not truthy") do
+          actual
+        end
+      end
+    end
+
+    private
+
+    # @param message [String, nil]
+    def check(message, &block)
+      unless block.call
+        raise ::Petitest::AssertionFailureError.new(message)
+      end
+    end
   end
 end

data/lib/petitest/texts/failures_element_text.rb

@@ -30,7 +30,7 @@ module Petitest
       def body
         [
           ::Petitest::Texts::RaisedCodeText.new(test_case: test_case),
-          ::Petitest::Texts::FailureMessageText.new(test_case: test_case),
+          ::Petitest::Texts::ErrorMessageText.new(test_case: test_case),
           ::Petitest::Texts::FilteredBacktraceText.new(test_case: test_case),
         ].join("\n")
       end

data/lib/petitest/texts/raised_code_text.rb

@@ -24,24 +24,32 @@ module Petitest
 
       # @return [String, nil]
       def caller_file_content
-        if ::FileTest.file?(caller_path)
+        if caller_path && ::FileTest.file?(caller_path)
           ::File.read(caller_path)
         end
       end
 
-      # @return [String]
+      # @return [String, nil]
       def caller_line_number
-        caller_segments[1].to_i
+        if caller_segments[1]
+          caller_segments[1].to_i
+        end
       end
 
-      # @return [String]
+      # @return [String, nil]
       def caller_path
         caller_segments[0]
       end
 
       # @return [Array<String>]
       def caller_segments
-        @caller_segments ||= test_case.filtered_backtrace[0].split(":", 3)
+        @caller_segments ||= begin
+          if test_case.filtered_backtrace[0]
+            test_case.filtered_backtrace[0].split(":", 3)
+          else
+            []
+          end
+        end
       end
     end
   end

data/lib/petitest/texts/test_case_result_character_text.rb

@@ -14,10 +14,8 @@ module Petitest
       # @note Override
       def to_s
         case
-        when test_case.aborted?
-          colorize("E", :error)
         when test_case.failed?
-          colorize("F", :failure)
+          colorize("F", :error)
         when test_case.skipped?
           colorize("*", :skip)
         else

data/lib/petitest/texts/test_cases_result_text.rb

@@ -28,18 +28,34 @@ module Petitest
       # @note Override
       def to_s
         [
-          ::Petitest::Texts::TestCasesResultMarginTopText.new(test_cases: test_cases),
-          [
-            ::Petitest::Texts::FailuresText.new(test_cases: test_cases.select(&:failed?)),
-            ::Petitest::Texts::ErrorsText.new(test_cases: test_cases.select(&:aborted?)),
-            ::Petitest::Texts::TestCountsText.new(test_cases: test_cases),
-            ::Petitest::Texts::TimesText.new(
-              finished_at: finished_at,
-              started_at: started_at,
-            ),
-          ].join("\n\n"),
+          header,
+          body,
         ].join
       end
+
+      private
+
+      # @return [String]
+      def body
+        texts = []
+        texts << ::Petitest::Texts::FailuresText.new(test_cases: test_cases_failed) unless test_cases_failed.empty?
+        texts << ::Petitest::Texts::TestCountsText.new(test_cases: test_cases)
+        texts << ::Petitest::Texts::TimesText.new(
+          finished_at: finished_at,
+          started_at: started_at,
+        )
+        texts.join("\n\n")
+      end
+
+      # @return [String]
+      def header
+        ::Petitest::Texts::TestCasesResultMarginTopText.new(test_cases: test_cases).to_s
+      end
+
+      # @return [Array<Petitest::TestCase>]
+      def test_cases_failed
+        @test_cases_failed ||= test_cases.select(&:failed?)
+      end
     end
   end
 end

data/lib/petitest/texts/test_counts_text.rb

@@ -27,16 +27,10 @@ module Petitest
           text_of_count_of_test_cases,
           text_of_count_of_passed_test_cases,
           text_of_count_of_failed_test_cases,
-          text_of_count_of_aborted_test_cases,
           text_of_count_of_skipped_test_cases,
         ].join("\n")
       end
 
-      # @return [Integer]
-      def count_of_aborted_test_cases
-        test_cases.select(&:aborted?).length
-      end
-
       # @return [Integer]
       def count_of_failed_test_cases
         test_cases.select(&:failed?).length
@@ -67,14 +61,9 @@ module Petitest
         @max_digits_length ||= count_of_test_cases.to_s.length
       end
 
-      # @return [String]
-      def text_of_count_of_aborted_test_cases
-        colorize("%#{max_digits_length}d errors" % count_of_aborted_test_cases, :error)
-      end
-
       # @return [String]
       def text_of_count_of_failed_test_cases
-        colorize("%#{max_digits_length}d failures" % count_of_failed_test_cases, :failure)
+        colorize("%#{max_digits_length}d failures" % count_of_failed_test_cases, :error)
       end
 
       # @return [String]

data/lib/petitest/version.rb

@@ -1,3 +1,3 @@
 module Petitest
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: petitest
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,6 @@ files:
 - Rakefile
 - lib/petitest.rb
 - lib/petitest/assertion_failure_error.rb
-- lib/petitest/assertions.rb
 - lib/petitest/autorun.rb
 - lib/petitest/configuration.rb
 - lib/petitest/subscriber_concerns/output_concern.rb
@@ -67,9 +66,6 @@ files:
 - lib/petitest/test_method.rb
 - lib/petitest/texts/base_text.rb
 - lib/petitest/texts/error_message_text.rb
-- lib/petitest/texts/errors_element_text.rb
-- lib/petitest/texts/errors_text.rb
-- lib/petitest/texts/failure_message_text.rb
 - lib/petitest/texts/failures_element_text.rb
 - lib/petitest/texts/failures_text.rb
 - lib/petitest/texts/filtered_backtrace_text.rb

data/lib/petitest/assertions.rb

@@ -1,66 +0,0 @@
-module Petitest
-  module Assertions
-    # @param actual_or_message [Object]
-    # @param message [String, nil]
-    def assert(actual_or_message = nil, message = nil, &block)
-      if block
-        assert_block(actual_or_message, &block)
-      else
-        actual = actual_or_message
-        check(
-          message: message,
-          template: "%{actual} is not truthy",
-          template_variables: {
-            actual: actual,
-          },
-        ) do
-          actual
-        end
-      end
-    end
-
-    # @param message [String, nil]
-    def assert_block(message = nil, &block)
-      check(
-        message: message,
-        template: "Given block returned falsy",
-        &block
-      )
-    end
-
-    # @param expected [Object]
-    # @param actual [Object]
-    # @param message [String, nil]
-    def assert_equal(expected, actual, message = nil)
-      check(
-        message: message,
-        template: "%{expected} expected but was %{actual}",
-        template_variables: {
-          actual: actual,
-          expected: expected,
-        },
-      ) do
-        expected == actual
-      end
-    end
-
-    private
-
-    # @param message [String, nil]
-    # @param template [String]
-    # @param template_variables [Hash, nil]
-    def check(
-      message:,
-      template:,
-      template_variables: {}
-    )
-      unless yield
-        raise ::Petitest::AssertionFailureError.new(
-          additional_message: message,
-          template: template,
-          template_variables: template_variables,
-        )
-      end
-    end
-  end
-end

data/lib/petitest/texts/errors_element_text.rb

@@ -1,54 +0,0 @@
-require "petitest/texts/base_text"
-
-module Petitest
-  module Texts
-    class ErrorsElementText < ::Petitest::Texts::BaseText
-      # @return [Integer]
-      attr_reader :index
-
-      # @return [Petitest::TestCase]
-      attr_reader :test_case
-
-      # @param index [Integer]
-      # @param test_case [Petitest::TestCase]
-      def initialize(index:, test_case:)
-        @index = index
-        @test_case = test_case
-      end
-
-      # @note Override
-      def to_s
-        [
-          heading,
-          indent(body, 2)
-        ].join("\n")
-      end
-
-      private
-
-      # @return [String]
-      def body
-        [
-          ::Petitest::Texts::RaisedCodeText.new(test_case: test_case),
-          ::Petitest::Texts::ErrorMessageText.new(test_case: test_case),
-          ::Petitest::Texts::FilteredBacktraceText.new(test_case: test_case),
-        ].join("\n")
-      end
-
-      # @return [String]
-      def heading
-        "#{ordinal_number}) #{test_signature}"
-      end
-
-      # @return [Integer]
-      def ordinal_number
-        index + 1
-      end
-
-      # @return [String]
-      def test_signature
-        test_case.test_signature
-      end
-    end
-  end
-end

data/lib/petitest/texts/errors_text.rb

@@ -1,45 +0,0 @@
-require "petitest/texts/base_text"
-
-module Petitest
-  module Texts
-    class ErrorsText < ::Petitest::Texts::BaseText
-      # @return [Array<Petitest::TestCase>]
-      attr_reader :test_cases
-
-      # @param test_cases [Array<Petitest::TestCase>]
-      def initialize(test_cases:)
-        @test_cases = test_cases
-      end
-
-      # @note Override
-      def to_s
-        [
-          heading,
-          indent(body, 2),
-        ].join("\n\n")
-      end
-
-      private
-
-      # @return [String]
-      def body
-        errors_element_texts.join("\n\n")
-      end
-
-      # @return [Array<Petitest::Textx::FailuresElementText>]
-      def errors_element_texts
-        test_cases.map.with_index do |test_case, index|
-          ::Petitest::Texts::ErrorsElementText.new(
-            index: index,
-            test_case: test_case,
-          )
-        end
-      end
-
-      # @return [String]
-      def heading
-        "Errors:"
-      end
-    end
-  end
-end

data/lib/petitest/texts/failure_message_text.rb

@@ -1,26 +0,0 @@
-require "petitest/texts/base_text"
-
-module Petitest
-  module Texts
-    class FailureMessageText < ::Petitest::Texts::BaseText
-      # @return [Petitest::TestCase]
-      attr_reader :test_case
-
-      # @param test_case [Petitest::TestCase]
-      def initialize(test_case:)
-        @test_case = test_case
-      end
-
-      # @note Override
-      def to_s
-        colorize(
-          [
-            test_case.failure_assertion_type_message,
-            test_case.failure_additional_message,
-          ].compact.join("\n"),
-          :failure,
-        )
-      end
-    end
-  end
-end