Add Yardoc

Author: avmnu-sng

.codeclimate.yml

@@ -41,6 +41,7 @@ plugins:
     config:
       file: ".rubocop.yml"
 exclude_patterns:
+  - "doc/"
   - "gemfiles/"
   - "manual/"
   - "resources/"

.rubocop.yml

@@ -3,8 +3,6 @@ require:
   - rubocop-rspec
 AllCops:
   TargetRubyVersion: 2.3
-Documentation:
-  Enabled: false
 Layout/ClassStructure:
   Enabled: true
   Categories:

.travis.yml

@@ -34,11 +34,11 @@ before_install:
 before_script:
   - ./cc-test-reporter before-build
 script:
+  - bundle exec rake
   - |
     for i in `seq 0 9`
     do
       BUNDLE_GEMFILE=gemfiles/rspec_3_$i.gemfile bundle install
-      BUNDLE_GEMFILE=gemfiles/rspec_3_$i.gemfile bundle exec rubocop
       BUNDLE_GEMFILE=gemfiles/rspec_3_$i.gemfile bundle exec rspec spec
     done
 after_script:

.yardopts

@@ -1,2 +1,3 @@
 --markup markdown
---hide-void-return
+--default-return ''
+--private

CHANGELOG.md

@@ -1,7 +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
+**First Release**
+- Added support for four TAP formats:
+    - RSpec::TAP::Formatters::Default
+    - RSpec::TAP::Formatters::Compact
+    - RSpec::TAP::Formatters::Flat
+    - RSpec::TAP::Formatters::FlatCompact

README.md

@@ -1,5 +1,7 @@
 [![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)
+[![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 

Rakefile

@@ -4,6 +4,36 @@ require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
+desc 'Generate doc'
+task :doc do
+  sh 'yardoc'
+end
+
+desc 'Verify doc coverage'
+task :verify_doc do
+  sh <<-SCRIPT.gsub(/^\s+\|/, '').chomp
+    |yard stats --list-undoc | ruby -e "
+    |  while (line = gets)
+    |    warnings ||= line.start_with?('[warn]:')
+    |    coverage ||= line[/([\\d\.]+)% documented/, 1]
+    |  end
+    |
+    |  exit(1) if warnings || Float(coverage) != 100
+    |"
+  SCRIPT
+
+  sh <<-SCRIPT.gsub(/^\s+\|/, '').chomp
+    |yard doc --no-cache | ruby -e "
+    |  while (line = gets)
+    |    warnings ||= line.start_with?('[warn]:')
+    |    errors ||= line.start_with?('[error]:')
+    |  end
+    |
+    |  exit(1) if warnings || errors
+    |"
+  SCRIPT
+end
+
 desc 'Run Rubocop'
 task :rubocop do
   sh 'bundle exec rubocop'
@@ -12,4 +42,4 @@ end
 desc 'Run all examples'
 RSpec::Core::RakeTask.new(:spec)
 
-task default: %i[rubocop spec]
+task default: %i[verify_doc rubocop spec]

bin/console

@@ -3,6 +3,7 @@
 
 require 'bundler/setup'
 require 'pry'
+require 'rspec/core'
 require 'rspec/tap/formatters'
 
 ARGV.clear

lib/rspec/tap/formatters/compact.rb

@@ -7,7 +7,9 @@
 module RSpec
   module TAP
     module Formatters
+      # Compact TAP formatter
       class Compact < RSpec::Core::Formatters::BaseFormatter
+        # List of subscribed notifications
         NOTIFICATIONS = %i[
           seed
           start
@@ -36,27 +38,40 @@ def initialize(output)
           @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
         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]],
@@ -67,10 +82,14 @@ def example_group_finished(notification)
           @test_stats = TestStats.new if @level.zero?
         end
 
+        # Example start notification
         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)
@@ -81,6 +100,9 @@ def example_passed(notification)
           )
         end
 
+        # Failing example notification
+        #
+        # @param notification [FailedExampleNotification]
         def example_failed(notification)
           @test_stats.populate(notification, 2)
           @printer.example_progress_output(:failure)
@@ -91,6 +113,10 @@ def example_failed(notification)
           )
         end
 
+        # Pending example notification
+        #
+        # @param notification [PendingExampleFailedAsExpectedNotification
+        #   , SkippedExampleException]
         def example_pending(notification)
           @test_stats.populate(notification, 3)
           @printer.example_progress_output(:pending)
@@ -102,18 +128,30 @@ def example_pending(notification)
           )
         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

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

@@ -1,13 +1,30 @@
 # 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?
 
@@ -20,6 +37,14 @@ def transform_keys
   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

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

@@ -1,13 +1,46 @@
 # 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