petitest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad7132e7dbbfaf374485b3198b4e0d0950272f10
+  data.tar.gz: be7660bd9bca8b83d12b0bac75bc7c7f4a870a2b
+SHA512:
+  metadata.gz: c9290292fe37e1f0f44729e798900b17c2f151e4bd218da5878de2293549b3ea04532612c482096af2f78c9794a6ef51687cb50cfb2118f40a73eaeaea3fda64
+  data.tar.gz: 9cbf07c7adb70c3b8e73e1febcd7b537642c6b317f82145f2455647d90b065045aa494368e07c687a8ea311616671b28b8ac2d48b521393f3076585c6e9cd644

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0
+
+- 1st Release :tada:

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in petitest.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ryo Nakamura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# Petitest
+
+A minimal solid testing framework for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "petitest"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install petitest
+```
+
+## Usage
+
+### 1. Write test cases
+
+Define a child class of `Petitest::TestGroup` with `#test_xxx` methods.
+
+```ruby
+# test/some_test.rb
+require "petitest/autorun"
+
+class Sometest < Petitest::TestGroup
+  def test_empty_string
+    assert("")
+  end
+
+  def test_false
+    assert(false)
+  end
+
+  def test_nil
+    assert(nil)
+  end
+
+  def test_raise
+    raise
+  end
+
+  def test_true
+    assert(true)
+  end
+
+  def test_zero
+    assert(0)
+  end
+end
+```
+
+### 2. Run tests
+
+Run your test file as a Ruby script:
+
+```bash
+ruby test/sometest_test.rb
+```
+
+```
+.FFE..
+
+Failures:
+
+  1) Sometest#test_false
+    assert(false)
+    false is not truthy
+    # test/sometest_test.rb:9:in `test_false'
+
+  2) Sometest#test_nil
+    assert(nil)
+    nil is not truthy
+    # test/sometest_test.rb:13:in `test_nil'
+
+Errors:
+
+  1) Sometest#test_raise
+    raise
+    RuntimeError:
+    # test/sometest_test.rb:17:in `test_raise'
+
+Counts:
+
+  6 tests
+  3 passes
+  2 failures
+  1 errors
+  0 skips
+
+Times:
+
+  Started:  2017-03-22T05:40:32.846640+09:00
+  Finished: 2017-03-22T05:40:32.846784+09:00
+  Total:    0.000144s
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/petitest/assertion_failure_error.rb

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

data/lib/petitest/assertion_failure_message.rb

@@ -0,0 +1,35 @@
+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

data/lib/petitest/assertions.rb

@@ -0,0 +1,46 @@
+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(
+          template: "%{actual} is not truthy",
+          template_variables: {
+            actual: actual,
+          },
+          user_specified_message: user_specified_message,
+        ),
+        result: actual,
+      )
+    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
+      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,
+      )
+    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)
+      end
+    end
+  end
+end

data/lib/petitest/autorun.rb

@@ -0,0 +1,8 @@
+require "petitest"
+
+at_exit do
+  test_cases = Petitest::TestGroup.test_cases
+  result = Petitest::TestCasesRunner.new(test_cases).run
+  exit_code = result ? 0 : 1
+  exit(exit_code)
+end

data/lib/petitest/configuration.rb

@@ -0,0 +1,26 @@
+module Petitest
+  class Configuration
+    DEFAULT_COLOR_SCHEME = {
+      detail: :cyan,
+      error: :red,
+      failure: :red,
+      pass: :green,
+      skip: :yellow,
+    }
+
+    # @return [Hash{Symbol => Symbol}]
+    def color_scheme
+      @color_scheme ||= DEFAULT_COLOR_SCHEME.dup
+    end
+
+    # @return [Boolean]
+    def colored
+      true
+    end
+
+    # @return [Array<Petitest::Subscribers::BaseSubscriber>]
+    def subscribers
+      @subscribers ||= [::Petitest::Subscribers::ProgressReportSubscriber.new]
+    end
+  end
+end

data/lib/petitest/subscribers/base_subscriber.rb

@@ -0,0 +1,21 @@
+module Petitest
+  module Subscribers
+    class BaseSubscriber
+      # @param test_case [Petit::TestCase]
+      def after_running_test_case(test_case)
+      end
+
+      # @param test_cases [Array<Petit::TestCase>]
+      def after_running_test_cases(test_cases)
+      end
+
+      # @param test_case [Petit::TestCase]
+      def before_running_test_case(test_case)
+      end
+
+      # @param test_cases [Array<Petit::TestCase>]
+      def before_running_test_cases(test_cases)
+      end
+    end
+  end
+end

data/lib/petitest/subscribers/json_report_subscriber.rb

@@ -0,0 +1,38 @@
+require "json"
+require "petitest/subscribers/timer_subscriber"
+
+module Petitest
+  module Subscribers
+    class JsonReportSubscriber < ::Petitest::Subscribers::TimerSubscriber
+      # @note Override
+      def after_running_test_cases(test_cases)
+        super
+        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_message: test_case.failure_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,
+              path: test_case.test_method.path,
+              skipped: test_case.skipped?,
+              started_at: test_case.started_at.iso8601(6),
+            }
+          end,
+          times: {
+            finished_at: finished_at.iso8601(6),
+            started_at: started_at.iso8601(6),
+          },
+        }
+        output = ::JSON.pretty_generate(data)
+        puts output
+      end
+    end
+  end
+end

data/lib/petitest/subscribers/progress_report_subscriber.rb

@@ -0,0 +1,23 @@
+require "petitest/subscribers/timer_subscriber"
+
+module Petitest
+  module Subscribers
+    class ProgressReportSubscriber < ::Petitest::Subscribers::TimerSubscriber
+      # @note Override
+      def after_running_test_case(test_case)
+        super
+        print ::Petitest::Texts::TestCaseResultCharacterText.new(test_case: test_case)
+      end
+
+      # @note Override
+      def after_running_test_cases(test_cases)
+        super
+        puts ::Petitest::Texts::TestCasesResultText.new(
+          finished_at: finished_at,
+          started_at: started_at,
+          test_cases: test_cases,
+        )
+      end
+    end
+  end
+end

data/lib/petitest/subscribers/timer_subscriber.rb

@@ -0,0 +1,26 @@
+require "petitest/subscribers/base_subscriber"
+require "time"
+
+module Petitest
+  module Subscribers
+    class TimerSubscriber < ::Petitest::Subscribers::BaseSubscriber
+      # @return [Time, nil]
+      attr_accessor :finished_at
+
+      # @return [Time, nil]
+      attr_accessor :started_at
+
+      # @note Override
+      def after_running_test_cases(test_cases)
+        super
+        self.finished_at = ::Time.now
+      end
+
+      # @note Override
+      def before_running_test_cases(test_cases)
+        super
+        self.started_at = ::Time.now
+      end
+    end
+  end
+end

data/lib/petitest/test_case.rb

@@ -0,0 +1,125 @@
+module Petitest
+  class TestCase
+    # @return [StandardError, nil]
+    attr_accessor :error
+
+    # @return [Time, nil]
+    attr_accessor :finished_at
+
+    # @return [Time, nil]
+    attr_accessor :started_at
+
+    # @return [Class]
+    attr_reader :test_group_class
+
+    # @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(
+      test_group_class:,
+      test_method:
+    )
+      @duration = nil
+      @processed = false
+      @test_group_class = test_group_class
+      @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?
+        error.backtrace
+      end
+    end
+
+    # @return [String, nil]
+    def error_class_name
+      if aborted?
+        error.class.to_s
+      end
+    end
+
+    # @return [String, nil]
+    def error_message
+      if aborted?
+        error.to_s
+      end
+    end
+
+    # @return [String, nil]
+    def failure_message
+      if failed?
+        error.to_s
+      end
+    end
+
+    # @return [Boolean]
+    def failed?
+      processed? && has_assertion_error?
+    end
+
+    # @return [Array<String>, nil]
+    def filtered_backtrace
+      @filtered_backtrace ||= backtrace.reject do |line|
+        line.start_with?(self.class.prefix_to_filter_backtrace)
+      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?
+    end
+
+    # @return [Boolean]
+    def processed?
+      @processed
+    end
+
+    def run
+      self.started_at = ::Time.now
+      test_group_class.new.send(test_method.method_name)
+      true
+    rescue => error
+      self.error = error
+      false
+    ensure
+      @finished_at = ::Time.now
+      @processed = true
+    end
+
+    # @todo
+    # @return [Boolean]
+    def skipped?
+      false
+    end
+
+    # @return [String]
+    def test_signature
+      [test_group_class, test_method.method_name].join("#")
+    end
+  end
+end

data/lib/petitest/test_cases_runner.rb

@@ -0,0 +1,58 @@
+module Petitest
+  class TestCasesRunner
+    # @return [Array<Petitest::TestCase>]
+    attr_reader :test_cases
+
+    # @param test_cases [Array<Petitest::TestCase>]
+    def initialize(test_cases)
+      @test_cases = test_cases
+    end
+
+    # @return [Boolean]
+    def run
+      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)
+      end
+      after_running_test_cases(test_cases)
+      test_cases.all?(&:passed?)
+    end
+
+    private
+
+    # @param test_case [Petitest::TestCase]
+    def after_running_test_case(test_case)
+      subscribers.each do |subscriber|
+        subscriber.after_running_test_case(test_case)
+      end
+    end
+
+    # @param test_cases [Array<Petitest::TestCase>]
+    def after_running_test_cases(test_cases)
+      subscribers.each do |subscriber|
+        subscriber.after_running_test_cases(test_cases)
+      end
+    end
+
+    # @param test_case [Petitest::TestCase]
+    def before_running_test_case(test_case)
+      subscribers.each do |subscriber|
+        subscriber.before_running_test_case(test_case)
+      end
+    end
+
+    # @param test_cases [Array<Petitest::TestCase>]
+    def before_running_test_cases(test_cases)
+      subscribers.each do |subscriber|
+        subscriber.before_running_test_cases(test_cases)
+      end
+    end
+
+    # @return [Array<Petitest::Subscribers::BaseSubscriber>]
+    def subscribers
+      ::Petitest.configuration.subscribers
+    end
+  end
+end

data/lib/petitest/test_group.rb

@@ -0,0 +1,51 @@
+module Petitest
+  class TestGroup
+    include ::Petitest::Assertions
+
+    TEST_METHOD_NAME_PREFIX = "test_"
+
+    class << self
+      # @return [Array<Class>]
+      def descendants
+        @@descendants ||= []
+      end
+
+      # @note Override
+      def inherited(sub_class)
+        super
+        descendants << sub_class
+      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
+        end
+      end
+
+      # @return [Array<String>]
+      def test_method_names
+        public_instance_methods.map(&:to_s).select do |method_name|
+          method_name.start_with?(TEST_METHOD_NAME_PREFIX)
+        end
+      end
+
+      # @return [Array<Petitest::TestMethod>]
+      def test_methods
+        test_method_names.map do |method_name|
+          unbound_method = public_instance_method(method_name)
+          ::Petitest::TestMethod.new(
+            line_number: unbound_method.source_location[1],
+            method_name: method_name.to_s,
+            path: unbound_method.source_location[0],
+          )
+        end
+      end
+    end
+  end
+end

data/lib/petitest/test_method.rb

@@ -0,0 +1,25 @@
+module Petitest
+  class TestMethod
+    # @return [Integer]
+    attr_reader :line_number
+
+    # @return [String]
+    attr_reader :method_name
+
+    # @return [String]
+    attr_reader :path
+
+    # @param line_number [Integer]
+    # @param method_name [String]
+    # @param path [String]
+    def initialize(
+      line_number:,
+      method_name:,
+      path:
+    )
+      @line_number = line_number
+      @method_name = method_name
+      @path = path
+    end
+  end
+end