rspec-ci-prettify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a2e3078e3f88cb494342835d5dd5a82c8e7a5a55df5ea7dca66c0f34d22008d
+  data.tar.gz: 9b570af8c0d2710379e801ea0a6239b588c5ea1e1fd4564194268c4bd462bf4d
+SHA512:
+  metadata.gz: 425d510af634ee01ad47c3eb8e3c2289f2f2e7c1b099cec3aa6a52df29bb0531d93170828391768832b6335d8b6e8f57497c432ace485c3c14fd2490e127a3dd
+  data.tar.gz: 5a1fef723c7ff99386fb14557bfb8a032936cf37ffad3f7361f68229fa2cb9378162e87f3f63aaa7adfbe324fa3f226b8562d3e970a042e93bb0d41cef1f26a8

data/lib/rspec/ci/prettify/constants.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Ci
+    module Prettify
+      module Constants
+        SEPARATOR = "\n\n#{'-' * 55}"
+      end
+    end
+  end
+end

data/lib/rspec/ci/prettify/formatter.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'rspec/core'
+require 'rspec/core/formatters/base_formatter'
+require 'rspec/core/formatters/console_codes'
+require_relative 'constants'
+
+module RSpec
+  module Ci
+    module Prettify
+      class Formatter < RSpec::Core::Formatters::BaseFormatter
+        RSpec::Core::Formatters.register self, :dump_summary, :dump_pending, :dump_failures,
+                                         :example_passed, :example_failed, :example_pending, :close
+
+        def initialize(output)
+          @output = output
+        end
+
+        def dump_summary(summary)
+          @output << RSpec::Ci::Prettify::Constants::SEPARATOR
+          @output << format_colour("\n\nSUMMARY:\n\t", :cyan)
+
+          build_summary(summary)
+        end
+
+        def dump_pending(notification)
+          @output << RSpec::Ci::Prettify::Constants::SEPARATOR
+          @output << format_colour("\n\nPENDING:\n\t", :pending)
+
+          @output << notification.pending_examples.map do |example|
+            format_colour(format_example_summary(example), :pending)
+          end.join("\n\t")
+        end
+
+        def dump_failures(notification)
+          @output << RSpec::Ci::Prettify::Constants::SEPARATOR
+          @output << format_colour("\n\nFAILURES:\n\t", :failure)
+          @output << failed_examples_output(notification)
+        end
+
+        def example_passed(example)
+          # @output << RSpec::Core::Formatters::ConsoleCodes.wrap(".", :success)
+        end
+
+        def example_failed(example)
+          # @output << RSpec::Core::Formatters::ConsoleCodes.wrap("F", :failure)
+        end
+
+        def example_pending(example)
+          # @output << RSpec::Core::Formatters::ConsoleCodes.wrap("*", :pending)
+        end
+
+        def close(_notification)
+          @output << "\n"
+        end
+
+        private
+
+        def build_summary(summary)
+          total_test_count = summary.examples.count
+          pending_count = summary.pending_examples.count
+          total_tests_ran = total_test_count - pending_count
+
+          failure_count = summary.failed_examples.count
+          pass_count = total_tests_ran - failure_count
+
+          @output << build_test_suite_duration(summary, total_tests_ran)
+          @output << build_pending_summary(pending_count, total_test_count)
+
+          if pass_count == total_tests_ran
+            @output << format_colour("\n All #{total_tests_ran} tests ran passed!!!", :magenta)
+            return
+          end
+
+          @output << build_failure_summary(failure_count, total_tests_ran)
+          @output << build_pass_summary(pass_count, total_tests_ran)
+        end
+
+        def build_test_suite_duration(summary, test_run_count)
+          duration = RSpec::Core::Formatters::Helpers.format_duration(summary.duration)
+          duration_text = "\nRan #{test_run_count} tests overall in #{duration}."
+
+          format_colour(duration_text, :cyan)
+        end
+
+        def build_pending_summary(pending_count, total_test_count)
+          pending_percentage = percentage_of_examples(pending_count, total_test_count)
+          pending_summary = "\n #{pending_percentage} of tests skipped/pending (#{pending_count})"
+          indent(format_colour(pending_summary, :pending), 4)
+        end
+
+        def build_failure_summary(failure_count, total_tests_ran)
+          failure_percentage = percentage_of_examples(failure_count, total_tests_ran)
+          failure_summary = "\n #{failure_percentage} of tests failed (#{failure_count})"
+          indent(format_colour(failure_summary, :failure), 4)
+        end
+
+        def build_pass_summary(pass_count, total_tests_ran)
+          pass_percentage = percentage_of_examples(pass_count, total_tests_ran)
+
+          pass_summary = "\n #{pass_percentage} of tests passed (#{pass_count})"
+
+          indent(format_colour(pass_summary, :success), 4)
+        end
+
+        def percentage_of_examples(count, total)
+          percentage = (count.to_f / total) * 100.0
+          "#{percentage.round(2)}%"
+        end
+
+        def failed_examples_output(notification)
+          failed_examples_output = notification.failed_examples.map do |example|
+            failed_example_output(example)
+          end
+
+          build_examples_output(failed_examples_output)
+        end
+
+        def build_examples_output(output)
+          output.join("\n\n\t")
+        end
+
+        def format_colour(str, status)
+          RSpec::Core::Formatters::ConsoleCodes.wrap(str, status)
+        end
+
+        def format_example_summary(example)
+          full_description = example.full_description
+          location = example.location
+          "#{full_description} - #{location}"
+        end
+
+        def failed_example_output(example)
+          msg = example.execution_result.exception.message
+          formatted_err_message = sanitize_msg(msg)
+          summary = format_colour(format_example_summary(example), :failure)
+
+          "#{summary} \n  #{formatted_err_message}"
+        end
+
+        def sanitize_msg(msg)
+          msg.split("\n").map(&:strip).join("\n#{' ' * 10}")
+        end
+
+        def indent(str, count)
+          indent = ' ' * count
+          indent + str
+        end
+      end
+    end
+  end
+end

data/lib/rspec/ci/prettify/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Ci
+    module Prettify
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/rspec/ci/prettify.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'prettify/version'
+require_relative 'prettify/formatter'
+
+module RSpec
+  module Ci
+    module Prettify
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: rspec-ci-prettify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jjholmes927
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description:
+email:
+- jjholmes927@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec/ci/prettify.rb
+- lib/rspec/ci/prettify/constants.rb
+- lib/rspec/ci/prettify/formatter.rb
+- lib/rspec/ci/prettify/version.rb
+homepage: https://github.com/jjholmes927/rspec-ci-prettify
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jjholmes927/rspec-ci-prettify
+  source_code_uri: https://github.com/jjholmes927/rspec-ci-prettify
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: rspec formatter that gives a more readable output on CI runs (specifically
+  Github actions)
+test_files: []