petitest 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad7132e7dbbfaf374485b3198b4e0d0950272f10
-  data.tar.gz: be7660bd9bca8b83d12b0bac75bc7c7f4a870a2b
+  metadata.gz: 352ae5dae0ba8eb8e866f277ae8252b94c15f4bd
+  data.tar.gz: c5feb6113073d80f36e406e6cfd4f4929cd2160a
 SHA512:
-  metadata.gz: c9290292fe37e1f0f44729e798900b17c2f151e4bd218da5878de2293549b3ea04532612c482096af2f78c9794a6ef51687cb50cfb2118f40a73eaeaea3fda64
-  data.tar.gz: 9cbf07c7adb70c3b8e73e1febcd7b537642c6b317f82145f2455647d90b065045aa494368e07c687a8ea311616671b28b8ac2d48b521393f3076585c6e9cd644
+  metadata.gz: dd63a6b94dd92d850e56e96ca98e0eabfc80feaa1312b112f8c229f73b149a4c32acd0940a45ef0918acc75956bd5f43c949672fd6e2d2ebf5c64d9a74de87d4
+  data.tar.gz: 712f51bada7fd39c605d340629a072c9930a91563d27c9eb18ada7903ecde018dc949adfa4f0aef3ca0d6c878f63b629cc4c11e20eb1fad884bd36df01f436b1

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.1.1
+
+- Support block on `#assert` method for Power Assert
+- Improve backtrace for plug-ins
+- Change failure messages API
+
 ## v0.1.0
 
 - 1st Release :tada:

data/README.md

@@ -1,5 +1,8 @@
 # Petitest
 
+[![Gem Version](https://badge.fury.io/rb/petitest.svg)](https://rubygems.org/gems/petitest)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/github/petitest/petitest)
+
 A minimal solid testing framework for Ruby.
 
 ## Installation

data/lib/petitest/assertion_failure_error.rb

@@ -1,4 +1,40 @@
 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/assertions.rb

@@ -1,45 +1,65 @@
 module Petitest
   module Assertions
-    # @param actual [Object]
-    # @param user_specified_message [String, nil]
-    def assert(actual, user_specified_message = nil)
-      check(
-        assertion_failure_message: ::Petitest::AssertionFailureMessage.new(
+    # @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,
           },
-          user_specified_message: user_specified_message,
-        ),
-        result: 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 user_specified_message [String, nil]
-    def assert_equal(expected, actual, user_specified_message = nil)
-      result = expected == actual
+    # @param message [String, nil]
+    def assert_equal(expected, actual, message = nil)
       check(
-        assertion_failure_message: ::Petitest::AssertionFailureMessage.new(
-          template: "%{expected} expected but was %{actual}",
-          template_variables: {
-            actual: actual,
-            expected: expected,
-          },
-          user_specified_message: user_specified_message,
-        ),
-        result: result,
-      )
+        message: message,
+        template: "%{expected} expected but was %{actual}",
+        template_variables: {
+          actual: actual,
+          expected: expected,
+        },
+      ) do
+        expected == actual
+      end
     end
 
     private
 
-    # @param assertion_failure_message [Petitest::AssertionFailureMessage]
-    # @param result [Boolean]
-    def check(assertion_failure_message:, result:)
-      unless result
-        raise ::Petitest::AssertionFailureError.new(assertion_failure_message)
+    # @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

data/lib/petitest/subscribers/json_report_subscriber.rb

@@ -16,7 +16,8 @@ module Petitest
               error_class_name: test_case.error_class_name,
               error_message: test_case.error_message,
               failed: test_case.failed?,
-              failure_message: test_case.failure_message,
+              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

@@ -61,9 +61,16 @@ module Petitest
     end
 
     # @return [String, nil]
-    def failure_message
+    def failure_additional_message
       if failed?
-        error.to_s
+        error.additional_message
+      end
+    end
+
+    # @return [String, nil]
+    def failure_assertion_type_message
+      if failed?
+        error.assertion_type_message
       end
     end
 
@@ -74,8 +81,15 @@ module Petitest
 
     # @return [Array<String>, nil]
     def filtered_backtrace
-      @filtered_backtrace ||= backtrace.reject do |line|
-        line.start_with?(self.class.prefix_to_filter_backtrace)
+      @filtered_backtrace ||= begin
+        backtrace.reverse_each.each_with_object([]) do |line, lines|
+          if line.start_with?(::File.expand_path("../assertions.rb", __FILE__))
+            break lines
+          end
+          unless line.start_with?(self.class.prefix_to_filter_backtrace)
+            lines << line
+          end
+        end.reverse
       end
     end
 

data/lib/petitest/texts/failure_message_text.rb

@@ -13,7 +13,13 @@ module Petitest
 
       # @note Override
       def to_s
-        colorize(test_case.failure_message, :failure)
+        colorize(
+          [
+            test_case.failure_assertion_type_message,
+            test_case.failure_additional_message,
+          ].compact.join("\n"),
+          :failure,
+        )
       end
     end
   end

data/lib/petitest/version.rb

@@ -1,3 +1,3 @@
 module Petitest
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/petitest.rb

@@ -1,5 +1,4 @@
 require "petitest/assertion_failure_error"
-require "petitest/assertion_failure_message"
 require "petitest/assertions"
 require "petitest/configuration"
 require "petitest/subscribers/base_subscriber"

data/petitest.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Ryo Nakamura"]
   spec.email = ["r7kamura@gmail.com"]
   spec.summary = "A minimal solid testing framework for Ruby."
-  spec.homepage = "https://github.com/r7kamura/petitest"
+  spec.homepage = "https://github.com/petitest/petitest"
   spec.license = "MIT"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: petitest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -53,7 +53,6 @@ files:
 - Rakefile
 - lib/petitest.rb
 - lib/petitest/assertion_failure_error.rb
-- lib/petitest/assertion_failure_message.rb
 - lib/petitest/assertions.rb
 - lib/petitest/autorun.rb
 - lib/petitest/configuration.rb
@@ -81,7 +80,7 @@ files:
 - lib/petitest/texts/times_text.rb
 - lib/petitest/version.rb
 - petitest.gemspec
-homepage: https://github.com/r7kamura/petitest
+homepage: https://github.com/petitest/petitest
 licenses:
 - MIT
 metadata: {}

data/lib/petitest/assertion_failure_message.rb

@@ -1,35 +0,0 @@
-module Petitest
-  class AssertionFailureMessage
-    # @return [String]
-    attr_reader :template
-
-    # @return [Hash{Symbol => Object}]
-    attr_reader :template_variables
-
-    # @return [String, nil]
-    attr_reader :user_specified_message
-
-    # @param template [String]
-    # @param template_variables [Hash{Symbol => Object}]
-    # @param user_specified_message [String, nil]
-    def initialize(template:, template_variables: {}, user_specified_message:)
-      @template = template
-      @template_variables = template_variables
-      @user_specified_message = user_specified_message
-    end
-
-    # @note Override
-    def to_s
-      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