rspec-tap-formatters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd8a0abda3b907ea87d405f47d2fffe1cb223780512851ac382728f3eac84397
+  data.tar.gz: dd32b01b12fd9856218e4048cdaca91363ff9660542bbf4f82322982bd748707
+SHA512:
+  metadata.gz: 6129728991705d169d3b348f37b63a2d85c86f8855e38bd6bcddacfa3c38e6ea70ddc41dfc0a13f9febe465a4cf8b9c907fa346028bd39a729ef4a30849c8461
+  data.tar.gz: fbc6a0360a91354968a6fd1b768e2bad394e0a8d31e945212227be060f1b31c9608aa49bcd6674f2825ae1232a187931ff48814aaf2309a03efa81f5e8550a21

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+-
+README.md
+LICENSE.md
+CHANGELOG.md

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+--default-return ''
+--private
+-
+LICENSE.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## v0.1.0 (November 1, 2019)
+**First Release**
+- Added support for four TAP formats:
+    - RSpec::TAP::Formatters::Default
+    - RSpec::TAP::Formatters::Compact
+    - RSpec::TAP::Formatters::Flat
+    - RSpec::TAP::Formatters::FlatCompact

data/LICENSE.md

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+=====================
+
+- **Copyright © 2019 Abhimanyu Singh**
+
+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,127 @@
+[![Build Status](https://travis-ci.com/avmnu-sng/rspec-tap-formatters.svg?branch=master)](https://travis-ci.com/avmnu-sng/rspec-tap-formatters)
+[![Documentation Status](https://readthedocs.org/projects/rspec-tap-formatters/badge/?version=latest)](https://rspec-tap-formatters.readthedocs.io/en/latest/?badge=latest)
+[![Inline docs](http://inch-ci.org/github/avmnu-sng/rspec-tap-formatters.svg?branch=master)](http://inch-ci.org/github/avmnu-sng/rspec-tap-formatters)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7dd41099b7e8569fc7ec/maintainability)](https://codeclimate.com/github/avmnu-sng/rspec-tap-formatters/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7dd41099b7e8569fc7ec/test_coverage)](https://codeclimate.com/github/avmnu-sng/rspec-tap-formatters/test_coverage)
+
+**RSpec TAP Formatters** provides four different [TAP 13](https://testanything.org/tap-version-13-specification.html) format style with 
+a proper nested display of example groups and includes stats for the total 
+number of passed, failed, and pending tests per example group. The supported 
+formats are:
+
+1. `RSpec::TAP::Formatters::Default`
+2. `RSpec::TAP::Formatters::Compact`
+3. `RSpec::TAP::Formatters::Flat`
+4. `RSpec::TAP::Formatters::FlatCompact`
+
+Each formatter respects the color configuration for the execution and only 
+prints colored output when enabled. However, writing to a file will never use 
+colors.
+
+When writing the report to a file, each formatter will print progress status 
+on the standard output:
+- `.` denotes a passing example.
+- `F` denotes a failing example.
+- `*` denotes a pending example.
+
+Sample report for [string_spec.rb](resources/string_spec.rb) using 
+`RSpec::TAP::Formatters::Default` format:
+```text
+TAP version 13
+# test: String {
+  # group: #present? {
+    # group: when whitespaces and other characters {
+      ok 1 - returns true
+      1..1
+      # tests: 1, passed: 1
+    }
+    # group: when nil {
+      not ok 1 - returns false
+        ---
+        location: "./resources/string_spec.rb:8"
+        error: |-
+          Failure/Error: expect(string.present?).to eq(false)
+          NoMethodError:
+            undefined method `present?' for nil:NilClass
+        backtrace: "./resources/string_spec.rb:9:in `block (4 levels) in <top (required)>'"
+        ...
+      1..1
+      # tests: 1, failed: 1
+    }
+    # group: when whitespaces only {
+      ok 1 - returns false
+      1..1
+      # tests: 1, passed: 1
+    }
+    1..3
+    # tests: 3, passed: 2, failed: 1
+  }
+  1..3
+  # tests: 3, passed: 2, failed: 1
+}
+1..3
+# tests: 3, passed: 2, failed: 1
+# duration: 0.026471 seconds
+# seed: 27428
+```
+
+You can check the reports for other formats [here](resources/reports).
+
+## Installation
+
+Installation is pretty standard:
+```sh
+gem install rspec-tap-formatters
+```
+
+You can install using `bundler` also but do not require it in `Gemfile`.
+Make sure to use it as a test dependency:
+```ruby
+group :test do
+  # other gems
+  gem 'rspec-tap-formatter', '~> 0.1.0', require: false
+end
+```
+
+You can also install using the GitHub package registry:
+```ruby
+source 'https://rubygems.pkg.github.com/avmnu-sng' do
+  gem 'rspec-tap-formatter', '~> 0.1.0', require: false
+end
+```
+
+## Usage
+
+You can specify the format as the command argument:
+```sh
+rspec --format RSpec::TAP::Formatters::Default
+```
+
+To write to file, provide the `--out` argument:
+```sh
+rspec --format RSpec::TAP::Formatters::Default --out report.tap
+```
+
+You can also configure the `.rspec` file:
+```sh
+# other configurations
+--format RSpec::TAP::Formatters::Default
+--out report.tap
+```
+
+## Documentation
+Read more about TAP specifications and supported formats in the [official docs](https://rspec-tap-formatters.readthedocs.io/en/latest/).
+
+## Source Code Documentation
+Read the source code documentation [here](https://rubydoc.info/github/avmnu-sng/rspec-tap-formatters/master).
+ 
+## Compatibility
+RSpec TAP Formatters supports `MRI 2.3+` and `RSpec 3`.
+
+## Changelog
+
+The changelog is available [here](CHANGELOG.md).
+
+## Copyright
+Copyright (c) 2019 Abhimanyu Singh. See [LICENSE.md](LICENSE.md) for
+further details.

data/lib/rspec/tap/formatters.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'psych'
+
+require_relative 'formatters/core_ext/hash'
+require_relative 'formatters/core_ext/string'
+require_relative 'formatters/version'
+require_relative 'formatters/compact'
+require_relative 'formatters/default'
+require_relative 'formatters/flat'
+require_relative 'formatters/flat_compact'
+require_relative 'formatters/printer'
+require_relative 'formatters/test_stats'

data/lib/rspec/tap/formatters/compact.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'rspec/core/formatters/base_formatter'
+require_relative 'printer'
+require_relative 'test_stats'
+
+module RSpec
+  module TAP
+    module Formatters
+      # Compact TAP formatter
+      class Compact < RSpec::Core::Formatters::BaseFormatter
+        # List of subscribed notifications
+        NOTIFICATIONS = %i[
+          seed
+          start
+          start_dump
+          example_group_started
+          example_group_finished
+          example_started
+          example_passed
+          example_failed
+          example_pending
+          message
+          dump_failures
+          dump_pending
+          dump_summary
+        ].freeze
+
+        RSpec::Core::Formatters.register(self, *NOTIFICATIONS)
+
+        # Constructor
+        #
+        # @param output [StringIO, File] output stream
+        def initialize(output)
+          super
+
+          @printer = Printer.new(output)
+          @test_stats = TestStats.new
+          @seed = nil
+          @level = 0
+          @example_number = 0
+        end
+
+        # Seed notification
+        #
+        # @param notification [SeedNotification]
+        def seed(notification)
+          @seed = notification.seed if notification.seed_used?
+        end
+
+        # Start notification
+        #
+        # @param notification [StartNotification]
+        def start(notification)
+          super
+
+          @printer.start_output
+        end
+
+        # Execution finished notification
+        #
+        # @param _notification [NullNotification]
+        def start_dump(_notification)
+          @printer.example_progress_dump
+        end
+
+        # Example group start notification
+        #
+        # @param notification [GroupNotification]
+        def example_group_started(notification)
+          @printer.group_start_output(notification, @level)
+
+          @level += 1
+          @example_number = 0
+        end
+
+        # Example group finish notification
+        #
+        # @param notification [GroupNotification]
+        def example_group_finished(notification)
+          @printer.group_finished_output(
+            @test_stats.data[notification.group.metadata[:line_number]],
+            @level
+          )
+
+          @level -= 1 if @level.positive?
+          @test_stats = TestStats.new if @level.zero?
+        end
+
+        # Example start notification
+        #
+        # @param _notification [ExampleNotification]
+        def example_started(_notification)
+          @example_number += 1
+        end
+
+        # Passing example notification
+        #
+        # @param notification [ExampleNotification]
+        def example_passed(notification)
+          @test_stats.populate(notification, 1)
+          @printer.example_progress_output(:success)
+          @printer.success_output(
+            notification.example.description.strip,
+            @example_number,
+            @level
+          )
+        end
+
+        # Failing example notification
+        #
+        # @param notification [FailedExampleNotification]
+        def example_failed(notification)
+          @test_stats.populate(notification, 2)
+          @printer.example_progress_output(:failure)
+          @printer.failure_output(
+            notification.example.description.strip,
+            @example_number,
+            @level
+          )
+        end
+
+        # Pending example notification
+        #
+        # @param notification [PendingExampleFailedAsExpectedNotification
+        #   , SkippedExampleException]
+        def example_pending(notification)
+          @test_stats.populate(notification, 3)
+          @printer.example_progress_output(:pending)
+          @printer.pending_output(
+            notification,
+            notification.example.description.strip,
+            @example_number,
+            @level
+          )
+        end
+
+        # Failure outside of example notification
+        #
+        # @param notification [MessageNotification]
+        def message(notification)
+          @printer.message_output(notification)
+        end
+
+        # Failure examples notification
+        #
+        # @param notification [ExamplesNotification]
+        def dump_failures(notification)
+          @printer.store_failed_examples_summary(notification)
+        end
+
+        # Pending examples notification
+        #
+        # @param notification [ExamplesNotification]
+        def dump_pending(notification)
+          @printer.store_pending_examples_summary(notification)
+        end
+
+        # Examples summary notification
+        #
+        # @param notification [SummaryNotification]
+        def dump_summary(notification)
+          @printer.summary_output(notification, @seed)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/tap/formatters/core_ext/hash.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Extensions to the core String class
+class Hash
+  unless method_defined?(:compact)
+    # Removes nil and blank values.
+    # The value is either +NilClass+ or +String+.
+    #
+    # @return [Hash] compact hash
+    #
+    # @example
+    #   { you: 0, me: nil, we: '  ' }.compact
+    #   #=> { you: 0 }
+    def compact
+      reject { |_, value| value.nil? || value.blank? }
+    end
+  end
+
+  unless method_defined?(:transform_keys)
+    # Transforms hash keys.
+    # The value is either +NilClass+ or +String+.
+    #
+    # @return [Hash] with transformed keys
+    #
+    # @example
+    #   { you: 0, me: nil, we: '  '}.transform_keys(&:upcase)
+    #   #=> { YOU: 0, ME: nil, WE: '  '}
+    def transform_keys
+      return enum_for(:transform_keys) { size } unless block_given?
+
+      new_hash = {}
+
+      each_key { |key| new_hash[yield(key)] = self[key] }
+
+      new_hash
+    end
+  end
+
+  unless method_defined?(:stringify_keys)
+    # Transforms hash keys by using +to_s+.
+    # The value is either +NilClass+ or +String+.
+    #
+    # @return [Hash] with transformed keys
+    #
+    # @example
+    #   { you: 0, me: nil, we: '  '}.stringify_keys
+    #   #=> { "you" => 0, "me" => nil, "we" => '  '}
+    def stringify_keys
+      transform_keys(&:to_s)
+    end
+  end
+end

data/lib/rspec/tap/formatters/core_ext/string.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Extensions to the core String class
+class String
+  unless method_defined?(:blank?)
+    # Checks whether a string is blank. A string is considered blank if it
+    # is either empty or contains only whitespaces.
+    #
+    # @return [Boolean] true is the string is blank, false otherwise
+    #
+    # @example
+    #   ''.blank?
+    #   #=> true
+    #
+    # @example
+    #   '  '.blank?
+    #   #=> true
+    #
+    # @example
+    #   '  abc  '.blank?
+    #   #=> false
+    def blank?
+      empty? || strip.empty?
+    end
+  end
+
+  unless method_defined?(:present?)
+    # Checks whether a string is present. A string is considered present if it
+    # is not blank.
+    #
+    # @return [Boolean] true is the string is present, false otherwise
+    #
+    # @example
+    #   ''.present?
+    #   #=> false
+    #
+    # @example
+    #   '  '.present?
+    #   #=> false
+    #
+    # @example
+    #   '  abc  '.present?
+    #   #=> true
+    def present?
+      !blank?
+    end
+  end
+end