petitest 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bea44c83eede7392c848c866de9ad3f02e8bf6cd
-  data.tar.gz: 6de656fb3130c545bd98bb7702f16e281b9e8d04
+  metadata.gz: 2fa31c282318eafafb3924faa1b0d8896b8d7c3a
+  data.tar.gz: 147f137bf109acfb85ad8e6a36f7ce1c07605b25
 SHA512:
-  metadata.gz: 2f46a03a8de9f1cbfa1a689a06a8883671f7ddc36429adebf2e1beef431498735f87a0d1739a03dcee74af70b87d8b2e42e61b9fd64ccf7ca0e1dc2c73739068
-  data.tar.gz: '0550090e2cf0f0b70d950d25785446af0030d73cf862d2f4160d62461ffe3b0d6e09d1bf2c2da64c67e8473150be9725393b40ff3bec4288ec4aab215351dd98'
+  metadata.gz: 3767d10b75eb06fc7943fb46aeee35a14daf2870eb55aa7c33268ab3345e32e1a50a4ef36548cbc67144ab683e2a62ac0b7a263ddf27f397b3e5f4d2380bbf39
+  data.tar.gz: 2f7ecabd8e1fcb9000818cbf2c6062f160149fbe04599f4cd20f365dc5815f9b696c897424966343fbe0037727863a5e52f5e5ba161a038422ffe43e68d94dcf

data/CHANGELOG.md

@@ -1,8 +1,21 @@
+## v0.3.0
+
+- Add `Petitest::DSL`
+- Add `Petitest::TestRunner`
+- Add `Petitest::Test#skip`
+- Remove `Petitest::Test.nest_level`
+- Change `Petitest::Test.sub_test` to `Petitest::DSL#sub_test`
+- Change `Petitest::TestGroup` to `Petitest::Test`
+- Change `#after_running_test_case` to `#after_running_test`
+- Change `#after_running_tests` to `#after_running_test_plan`
+- Change `#before_running_test_case` to `#before_running_test`
+- Change `#before_running_tests` to `#before_running_test_plan`
+
 ## 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 `Petitest::TestGroup#sub_test`
 - Add document style report
 - Improve error report format
 - Improve default `#assert` message

data/README.md

@@ -5,6 +5,8 @@
 
 A minimal solid testing framework for Ruby.
 
+![demo](/images/demo.png)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,85 +29,234 @@ gem install petitest
 
 ## Usage
 
-### 1. Write test cases
+### Create your test file
 
-Define a child class of `Petitest::TestGroup` with `#test_xxx` methods.
+Define a child class of `Petitest::Test` with `#test_xxx` methods.
 
 ```ruby
 require "petitest/autorun"
 
-class Sometest < Petitest::TestGroup
-  def test_empty_string
-    assert("")
+class ExampleTest < Petitest::Test
+  def test_addition
+    assert { 1 + 1 == 100 }
   end
+end
+```
 
-  def test_false
-    assert(false)
-  end
+### Run it
 
-  def test_nil
-    assert(nil)
-  end
+Run your test file as a Ruby script:
+
+```bash
+ruby test/example_test.rb
+```
+
+```
+PetitestTest
+  #test_one_plus_one_to_be_two
+
+
+Counts:
+
+  1 tests
+  1 passes
+  0 failures
+  0 skips
+
+Times:
+
+  Started:  2017-03-25T15:29:21.243918+09:00
+  Finished: 2017-03-25T15:29:21.244149+09:00
+  Total:    0.000231s
+```
+
+If any test failed, exit code 1 is returned, othewise 0.
+
+```bash
+echo $?
+```
+
+```
+0
+```
+
+## Assertions
+
+Petitest provides only one assertion method, `#assert`.
+
+```ruby
+assert { foo }
+```
 
-  def test_raise
-    raise
+If you need more assertions, use plugins like [patitest-assertions](https://github.com/petitest/petitest-assertions).
+
+## DSL
+
+If you want to use `#desc`, `#test` and `#sub_test` DSL, extend `Petitest::DSL` into your test class.
+
+```ruby
+class ExampleTest < Petitest::Test
+  extend ::Petitest::DSL
+
+  test "foo" do
+    assert { foo }
   end
 
-  def test_true
-    assert(true)
+  desc "fuba"
+  def test_fuba
+    assert { fuba }
   end
 
-  def test_zero
-    assert(0)
+  sub_test "bar" do
+    test "baz" do
+      assert { baz }
+    end
+
+    sub_test "boo" do
+      test "boz" do
+        assert { boz }
+      end
+    end
   end
 end
 ```
 
-### 2. Run tests
+## Configuration
 
-Run your test file as a Ruby script:
+### backtrace_filters
 
-```bash
-ruby test/sometest_test.rb
+Mechanism for filter out unnecessary lines from error backtrace.
+Each element must be able to respond to `#===` method.
+
+```ruby
+Petitest.configuration.backtrace_filters = [
+  -> (line) { line.start_with?("/path/to/petitest/lib") },
+]
 ```
 
+### color
+
+Enable colored output.
+
+```ruby
+Petitest.configuration.color = true
 ```
-.FFF..
 
-Failures:
+### color_scheme
 
-  1) PetitestTest#test_false
-    assert(false)
-    Expected false to be truthy
-    # test/petitest_test.rb:9:in `test_false'
+Color scheme for colored output.
 
-  2) PetitestTest#test_nil
-    assert(nil)
-    Expected nil to be truthy
-    # test/petitest_test.rb:13:in `test_nil'
+```ruby
+Petitest.configuration.color_scheme = {
+  detail: :cyan,
+  error: :red,
+  pass: :green,
+  skip: :yellow,
+}
+```
 
-  3) PetitestTest#test_raise
-    raise
-    RuntimeError
+These color types are available on color scheme configuration:
 
-    # test/petitest_test.rb:17:in `test_raise'
+- `:black`
+- `:blue`
+- `:bold`
+- `:cyan`
+- `:green`
+- `:magenta`
+- `:red`
+- `:white`
+- `:yellow`
 
-Counts:
+### output
 
-  6 tests
-  3 passes
-  3 failures
-  0 skips
+Output path for some subscribers.
 
-Times:
+```ruby
+Petitest.configuration.output = ::STDOUT
+Petitest.configuration.output.sync = true
+```
 
-  Started:  2017-03-24T03:09:17.776418+09:00
-  Finished: 2017-03-24T03:09:17.776527+09:00
-  Total:    0.000109s
+### subscribers
+
+Test event subscribers (test reporters are kind of subscribers).
+
+```ruby
+Petitest.configuration.subscribers = [
+  ::Petitest::Subscribers::DocomentReportSubscriber.new,
+]
 ```
 
-## Plug-ins
+These subscribers are provided by default:
+
+- `Petitest::Subscribers::DocumentReportSubscriber` (default)
+- `Petitest::Subscribers::JsonReportSubscriber`
+- `Petitest::Subscribers::ProgressReportSubscriber`
+
+## Official Plugins
+
+Here are some official plugins for Petitest:
 
 - https://github.com/petitest/petitest-assertions
 - https://github.com/petitest/petitest-power_assert
 - https://github.com/petitest/petitest-tap
+
+## For developers
+
+### Tree
+
+```
+TestPlan
+|---Test 1
+|---Test 2
+|---Test 3
+|---TestGroup 1
+|   |---Test 1-1
+|   |---Test 1-2
+|   |---Test 1-3
+|   `---TestGroup1-1
+|       |---Test 1-1-1
+|       |---Test 1-1-2
+|       `---Test 1-1-3
+|---TestGroup2
+|   |---Test 2-1
+|   |---Test 2-2
+|   `---Test 2-3
+`---TestGroup3
+    |---Test 3-1
+    |---Test 3-2
+    |---Test 3-3
+    `---TestGroup3-1
+        |---Test 3-1-1
+        |---Test 3-1-2
+        `---Test 3-1-3
+```
+
+### Order
+
+1. Test 1
+1. Test 2
+1. Test 3
+1. Test 1-1
+1. Test 1-2
+1. Test 1-3
+1. Test 1-1-1
+1. Test 1-1-2
+1. Test 1-1-3
+1. Test 2-1
+1. Test 2-2
+1. Test 2-3
+1. Test 3-1
+1. Test 3-2
+1. Test 3-3
+1. Test 3-1-1
+1. Test 3-1-2
+1. Test 3-1-3
+
+### Events
+
+- `#before_running_test_plan(test_plan)`
+- `#before_running_test_group(test_group)`
+- `#before_running_test(test)`
+- `#after_running_test(test)`
+- `#after_running_test_group(test_group)`
+- `#after_running_test_plan(test_plan)`

data/lib/petitest.rb

@@ -1,26 +1,28 @@
 require "petitest/assertion_failure_error"
+require "petitest/assertion_skip_error"
 require "petitest/configuration"
+require "petitest/dsl"
 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"
 require "petitest/test_group"
-require "petitest/test_groups"
 require "petitest/test_method"
+require "petitest/test_plan"
+require "petitest/test_runner"
 require "petitest/texts/base_text"
 require "petitest/texts/error_message_text"
 require "petitest/texts/failures_element_text"
 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_result_character_text"
+require "petitest/texts/test_result_line_text"
+require "petitest/texts/tests_result_margin_top_text"
+require "petitest/texts/tests_result_text"
 require "petitest/texts/test_counts_text"
 require "petitest/texts/times_text"
 require "petitest/version"

data/lib/petitest/assertion_skip_error.rb

@@ -0,0 +1,4 @@
+module Petitest
+  class AssertionSkipError < ::StandardError
+  end
+end

data/lib/petitest/autorun.rb

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

data/lib/petitest/dsl.rb

@@ -0,0 +1,27 @@
+module Petitest
+  module DSL
+    # @param current_description [String]
+    def desc(current_description)
+      self.current_description = current_description
+    end
+
+    # @param description [String]
+    # @param metadata [Hash{Symbol => Object}]
+    def sub_test(description, metadata = {}, &block)
+      child = ::Class.new(self)
+      child.description = description
+      child.metadata = self.metadata.merge(metadata)
+      child.undefine_test_methods
+      child.class_eval(&block)
+      child
+    end
+
+    # @param description [String]
+    # @param metadata [Hash{Symbol => Object}]
+    def test(description, metadata = {}, &block)
+      block ||= -> { skip }
+      desc(description)
+      define_method("test_#{description}", &block)
+    end
+  end
+end

data/lib/petitest/subscriber_concerns/time_concern.rb

@@ -10,13 +10,13 @@ module Petitest
       attr_accessor :started_at
 
       # @note Override
-      def after_running_test_cases(test_cases)
+      def after_running_test_plan(test_plan)
         super
         self.finished_at = ::Time.now
       end
 
       # @note Override
-      def before_running_test_cases(test_cases)
+      def before_running_test_plan(test_plan)
         super
         self.started_at = ::Time.now
       end

data/lib/petitest/subscribers/base_subscriber.rb

@@ -1,29 +1,29 @@
 module Petitest
   module Subscribers
     class BaseSubscriber
-      # @param test_case [Petit::TestCase]
-      def after_running_test_case(test_case)
+      # @param test [Petitest::Test]
+      def after_running_test(test)
       end
 
-      # @param test_cases [Array<Petit::TestCase>]
-      def after_running_test_cases(test_cases)
-      end
-
-      # @param test_group [Class]
+      # @param test_group [Petitest::TestGroup]
       def after_running_test_group(test_group)
       end
 
-      # @param test_case [Petit::TestCase]
-      def before_running_test_case(test_case)
+      # @param test_plan [Petitest::TestPlan]
+      def after_running_test_plan(test_plan)
       end
 
-      # @param test_cases [Array<Petit::TestCase>]
-      def before_running_test_cases(test_cases)
+      # @param test [Petitest::Test]
+      def before_running_test(test)
       end
 
-      # @param test_group [Class]
+      # @param test_group [Petitest::TestGroup]
       def before_running_test_group(test_group)
       end
+
+      # @param test_plan [Petitest::TestPlan]
+      def before_running_test_plan(test_plan)
+      end
     end
   end
 end