petitest 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94d661afca2ae26812fcfd79ffd3c54e1fbd4085
-  data.tar.gz: 26ce49148e23ff5e854b4ae1898ab7c11250a81b
+  metadata.gz: bea44c83eede7392c848c866de9ad3f02e8bf6cd
+  data.tar.gz: 6de656fb3130c545bd98bb7702f16e281b9e8d04
 SHA512:
-  metadata.gz: 4e6243251265c19413ffff8923419cccf9c436e9c12ae058abb22d9545464270ac294ed87bec5d3f57ddb350fd9910e96013d947c820e3295e1cebe6bb7a5ce5
-  data.tar.gz: b68470322a44f4155d482e0d154758f2c09188a3f670452b0542a03d8087f950506e899ba10c0aa1c3fa9bca82c6e2dccef4c6c15e62d984ed9a04c02e3f935a
+  metadata.gz: 2f46a03a8de9f1cbfa1a689a06a8883671f7ddc36429adebf2e1beef431498735f87a0d1739a03dcee74af70b87d8b2e42e61b9fd64ccf7ca0e1dc2c73739068
+  data.tar.gz: '0550090e2cf0f0b70d950d25785446af0030d73cf862d2f4160d62461ffe3b0d6e09d1bf2c2da64c67e8473150be9725393b40ff3bec4288ec4aab215351dd98'

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v0.2.1
+
+- Add `after_running_test_group` and `before_running_test_group` events
+- Add `Petitest::TestGroup#nest_level`
+- Add `Petitest::TestGroup#sub_test_group`
+- Add document style report
+- Improve error report format
+- Improve default `#assert` message
+
 ## v0.2.0
 
 - Merge errors into failures

data/README.md

@@ -32,7 +32,6 @@ gem install petitest
 Define a child class of `Petitest::TestGroup` with `#test_xxx` methods.
 
 ```ruby
-# test/some_test.rb
 require "petitest/autorun"
 
 class Sometest < Petitest::TestGroup
@@ -71,43 +70,42 @@ ruby test/sometest_test.rb
 ```
 
 ```
-.FFE..
+.FFF..
 
 Failures:
 
-  1) Sometest#test_false
+  1) PetitestTest#test_false
     assert(false)
-    false is not truthy
-    # test/sometest_test.rb:9:in `test_false'
+    Expected false to be truthy
+    # test/petitest_test.rb:9:in `test_false'
 
-  2) Sometest#test_nil
+  2) PetitestTest#test_nil
     assert(nil)
-    nil is not truthy
-    # test/sometest_test.rb:13:in `test_nil'
+    Expected nil to be truthy
+    # test/petitest_test.rb:13:in `test_nil'
 
-Errors:
-
-  1) Sometest#test_raise
+  3) PetitestTest#test_raise
     raise
-    RuntimeError:
-    # test/sometest_test.rb:17:in `test_raise'
+    RuntimeError
+
+    # test/petitest_test.rb:17:in `test_raise'
 
 Counts:
 
   6 tests
   3 passes
-  2 failures
-  1 errors
+  3 failures
   0 skips
 
 Times:
 
-  Started:  2017-03-22T05:40:32.846640+09:00
-  Finished: 2017-03-22T05:40:32.846784+09:00
-  Total:    0.000144s
+  Started:  2017-03-24T03:09:17.776418+09:00
+  Finished: 2017-03-24T03:09:17.776527+09:00
+  Total:    0.000109s
 ```
 
 ## Plug-ins
 
+- https://github.com/petitest/petitest-assertions
 - https://github.com/petitest/petitest-power_assert
 - https://github.com/petitest/petitest-tap

data/lib/petitest.rb

@@ -3,11 +3,13 @@ require "petitest/configuration"
 require "petitest/subscriber_concerns/output_concern"
 require "petitest/subscriber_concerns/time_concern"
 require "petitest/subscribers/base_subscriber"
+require "petitest/subscribers/document_report_subscriber"
 require "petitest/subscribers/json_report_subscriber"
 require "petitest/subscribers/progress_report_subscriber"
 require "petitest/test_case"
 require "petitest/test_cases_runner"
 require "petitest/test_group"
+require "petitest/test_groups"
 require "petitest/test_method"
 require "petitest/texts/base_text"
 require "petitest/texts/error_message_text"
@@ -16,6 +18,7 @@ require "petitest/texts/failures_text"
 require "petitest/texts/filtered_backtrace_text"
 require "petitest/texts/raised_code_text"
 require "petitest/texts/test_case_result_character_text"
+require "petitest/texts/test_case_result_line_text"
 require "petitest/texts/test_cases_result_margin_top_text"
 require "petitest/texts/test_cases_result_text"
 require "petitest/texts/test_counts_text"

data/lib/petitest/autorun.rb

@@ -4,8 +4,7 @@ at_exit do
   if $! && !($!.is_a?(::SystemExit) && $!.success?)
     next
   end
-  test_cases = Petitest::TestGroup.test_cases
-  result = Petitest::TestCasesRunner.new(test_cases).run
+  result = Petitest::TestCasesRunner.new(Petitest::TestGroup.children).run
   exit_code = result ? 0 : 1
   exit(exit_code)
 end

data/lib/petitest/configuration.rb

@@ -42,7 +42,7 @@ module Petitest
 
     # @return [Array<Petitest::Subscribers::BaseSubscriber>]
     def subscribers
-      @subscribers ||= [::Petitest::Subscribers::ProgressReportSubscriber.new]
+      @subscribers ||= [::Petitest::Subscribers::DocumentReportSubscriber.new]
     end
   end
 end

data/lib/petitest/subscribers/base_subscriber.rb

@@ -9,6 +9,10 @@ module Petitest
       def after_running_test_cases(test_cases)
       end
 
+      # @param test_group [Class]
+      def after_running_test_group(test_group)
+      end
+
       # @param test_case [Petit::TestCase]
       def before_running_test_case(test_case)
       end
@@ -16,6 +20,10 @@ module Petitest
       # @param test_cases [Array<Petit::TestCase>]
       def before_running_test_cases(test_cases)
       end
+
+      # @param test_group [Class]
+      def before_running_test_group(test_group)
+      end
     end
   end
 end

data/lib/petitest/subscribers/document_report_subscriber.rb

@@ -0,0 +1,37 @@
+require "petitest/subscribers/base_subscriber"
+require "petitest/subscriber_concerns/output_concern"
+require "petitest/subscriber_concerns/time_concern"
+
+module Petitest
+  module Subscribers
+    class DocumentReportSubscriber < ::Petitest::Subscribers::BaseSubscriber
+      include ::Petitest::SubscriberConcerns::OutputConcern
+      include ::Petitest::SubscriberConcerns::TimeConcern
+
+      # @note Override
+      def after_running_test_case(test_case)
+        super
+        string = ::Petitest::Texts::TestCaseResultLineText.new(test_case: test_case).to_s
+        output.puts(string)
+      end
+
+      # @note Override
+      def after_running_test_cases(test_cases)
+        super
+        string = ::Petitest::Texts::TestCasesResultText.new(
+          finished_at: finished_at,
+          started_at: started_at,
+          test_cases: test_cases,
+        ).to_s
+        output.puts(string)
+      end
+
+      # @note Override
+      def before_running_test_group(test_group_class)
+        super
+        string = "#{'  ' * test_group_class.nest_level}#{test_group_class.description}"
+        output.puts(string)
+      end
+    end
+  end
+end

data/lib/petitest/test_case.rb

@@ -34,6 +34,19 @@ module Petitest
       end
     end
 
+    # @return [String]
+    def description
+      @description ||= "##{method_name}"
+    end
+
+    # @return [String]
+    def full_description
+      [
+        test_group_class.full_description,
+        description,
+      ].join(" ")
+    end
+
     # @return [String, nil]
     def error_class_name
       if error

data/lib/petitest/test_cases_runner.rb

@@ -1,20 +1,19 @@
 module Petitest
   class TestCasesRunner
-    # @return [Array<Petitest::TestCase>]
-    attr_reader :test_cases
+    # @return [Array<Class>]
+    attr_reader :test_group_classes
 
-    # @param test_cases [Array<Petitest::TestCase>]
-    def initialize(test_cases)
-      @test_cases = test_cases
+    # @param test_group_classes [Array<Class>]
+    def initialize(test_group_classes)
+      @test_group_classes = test_group_classes
     end
 
     # @return [Boolean]
     def run
+      test_cases = test_group_classes.flat_map(&:test_cases_and_children_test_cases)
       before_running_test_cases(test_cases)
-      test_cases.each do |test_case|
-        before_running_test_case(test_case)
-        test_case.run
-        after_running_test_case(test_case)
+      test_group_classes.each do |test_group_class|
+        run_test_group(test_group_class)
       end
       after_running_test_cases(test_cases)
       test_cases.all?(&:passed?)
@@ -36,6 +35,13 @@ module Petitest
       end
     end
 
+    # @param test_group_class [Class]
+    def after_running_test_group(test_group_class)
+      subscribers.each do |subscriber|
+        subscriber.after_running_test_group(test_group_class)
+      end
+    end
+
     # @param test_case [Petitest::TestCase]
     def before_running_test_case(test_case)
       subscribers.each do |subscriber|
@@ -50,6 +56,32 @@ module Petitest
       end
     end
 
+    # @param test_group_class [Class]
+    def before_running_test_group(test_group_class)
+      subscribers.each do |subscriber|
+        subscriber.before_running_test_group(test_group_class)
+      end
+    end
+
+    # @param test_case [Petitest::TestCase]
+    def run_test_case(test_case)
+      before_running_test_case(test_case)
+      test_case.run
+      after_running_test_case(test_case)
+    end
+
+    # @param test_group_class [Class]
+    def run_test_group(test_group_class)
+      before_running_test_group(test_group_class)
+      test_group_class.test_cases.each do |test_case|
+        run_test_case(test_case)
+      end
+      test_group_class.children.each do |child_test_group_class|
+        run_test_group(child_test_group_class)
+      end
+      after_running_test_group(test_group_class)
+    end
+
     # @return [Array<Petitest::Subscribers::BaseSubscriber>]
     def subscribers
       ::Petitest.configuration.subscribers

data/lib/petitest/test_group.rb

@@ -3,29 +3,78 @@ module Petitest
     TEST_METHOD_NAME_PREFIX = "test_"
 
     class << self
+      attr_writer :description
+
+      attr_writer :metadata
+
+      attr_writer :nest_level
+
+      # @return [Array<Class>]
+      def children
+        @children ||= []
+      end
+
       # @return [Array<Class>]
       def descendants
-        @@descendants ||= []
+        children.flat_map(&:children)
+      end
+
+      # @return [String]
+      def description
+        @description ||= name
+      end
+
+      # @return [String, nil]
+      def full_description
+        descriptions = concrete_test_group_ancestors.reverse.map(&:description)
+        unless descriptions.empty?
+          descriptions.join(" ")
+        end
       end
 
       # @note Override
-      def inherited(sub_class)
+      def inherited(child)
         super
-        descendants << sub_class
+        children << child
+      end
+
+      # @return [Hash{Symbol => Object}]
+      def metadata
+        @metadata ||= {}
+      end
+
+      # @return [Integer]
+      def nest_level
+        @nest_level ||= 0
+      end
+
+      # @param description [String]
+      # @param metadata [Hash{Symbol => Object}]
+      def sub_test_group(description, metadata = {}, &block)
+        child = ::Class.new(self)
+        child.nest_level = nest_level + 1
+        child.description = description
+        child.metadata = self.metadata.merge(metadata)
+        child.undefine_test_methods
+        child.class_eval(&block)
+        child
       end
 
       # @return [Array<Petit::TestCase>]
       def test_cases
-        descendants.flat_map do |test_group_class|
-          test_group_class.test_methods.map do |test_method|
-            ::Petitest::TestCase.new(
-              test_group_class: test_group_class,
-              test_method: test_method,
-            )
-          end
+        @test_cases ||= test_methods.map do |test_method|
+          ::Petitest::TestCase.new(
+            test_group_class: self,
+            test_method: test_method,
+          )
         end
       end
 
+      # @return [Array<Petit::TestCase>]
+      def test_cases_and_children_test_cases
+        test_cases + children.flat_map(&:test_cases_and_children_test_cases)
+      end
+
       # @return [Array<String>]
       def test_method_names
         public_instance_methods.map(&:to_s).select do |method_name|
@@ -44,6 +93,26 @@ module Petitest
           )
         end
       end
+
+      def undefine_test_methods
+        test_method_names.each do |method_name|
+          undef_method(method_name)
+        end
+      end
+
+      private
+
+      # @return [Array<Class>]
+      def concrete_test_group_ancestors
+        ancestors.each_with_object([]) do |klass, classes|
+          if klass == ::Petitest::TestGroup
+            break classes
+          end
+          if klass.is_a?(::Class)
+            classes << klass
+          end
+        end
+      end
     end
 
     # @param actual_or_message [Object]
@@ -51,10 +120,10 @@ module Petitest
     def assert(actual_or_message = nil, message = nil, &block)
       if block
         message = actual_or_message
-        check(message || "Given block returned falsy", &block)
+        check(message || "Expected given block to return truthy", &block)
       else
         actual = actual_or_message
-        check(message || "#{actual.inspect} is not truthy") do
+        check(message || "Expected #{actual.inspect} to be truthy") do
           actual
         end
       end

data/lib/petitest/test_groups.rb

@@ -0,0 +1,4 @@
+module Petitest
+  module TestGroups
+  end
+end

data/lib/petitest/texts/error_message_text.rb

@@ -13,7 +13,11 @@ module Petitest
 
       # @note Override
       def to_s
-        colorize("#{test_case.error_class_name}: #{test_case.error_message}", :error)
+        elements = []
+        elements << test_case.error_class_name unless test_case.error.is_a?(::Petitest::AssertionFailureError)
+        elements << test_case.error_message unless test_case.error_message.empty?
+        string = elements.join("\n")
+        colorize(string, :error)
       end
     end
   end

data/lib/petitest/texts/test_case_result_line_text.rb

@@ -0,0 +1,37 @@
+require "petitest/texts/base_text"
+
+module Petitest
+  module Texts
+    class TestCaseResultLineText < ::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
+        indent(
+          colorize("##{test_case.test_method.method_name}", color_type),
+          2 * (test_case.test_group_class.nest_level + 1),
+        )
+      end
+
+      private
+
+      # @return [Symbol]
+      def color_type
+        case
+        when test_case.failed?
+          :error
+        when test_case.skipped?
+          :skip
+        else
+          :pass
+        end
+      end
+    end
+  end
+end

data/lib/petitest/version.rb

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

data/petitest.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.1.0"
 
   spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "petitest-power_assert"
   spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: petitest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: petitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,11 +72,13 @@ files:
 - lib/petitest/subscriber_concerns/output_concern.rb
 - lib/petitest/subscriber_concerns/time_concern.rb
 - lib/petitest/subscribers/base_subscriber.rb
+- lib/petitest/subscribers/document_report_subscriber.rb
 - lib/petitest/subscribers/json_report_subscriber.rb
 - lib/petitest/subscribers/progress_report_subscriber.rb
 - lib/petitest/test_case.rb
 - lib/petitest/test_cases_runner.rb
 - lib/petitest/test_group.rb
+- lib/petitest/test_groups.rb
 - lib/petitest/test_method.rb
 - lib/petitest/texts/base_text.rb
 - lib/petitest/texts/error_message_text.rb
@@ -71,6 +87,7 @@ files:
 - lib/petitest/texts/filtered_backtrace_text.rb
 - lib/petitest/texts/raised_code_text.rb
 - lib/petitest/texts/test_case_result_character_text.rb
+- lib/petitest/texts/test_case_result_line_text.rb
 - lib/petitest/texts/test_cases_result_margin_top_text.rb
 - lib/petitest/texts/test_cases_result_text.rb
 - lib/petitest/texts/test_counts_text.rb