rspec-ci-prettify 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a2e3078e3f88cb494342835d5dd5a82c8e7a5a55df5ea7dca66c0f34d22008d
-  data.tar.gz: 9b570af8c0d2710379e801ea0a6239b588c5ea1e1fd4564194268c4bd462bf4d
+  metadata.gz: f4814566aeb1130a8ca2d63035a0664b8120753d608c280270f3e2369141033d
+  data.tar.gz: f2ee21c3127d7e5fc789994ee2efc75baafc0848ee81fda995f57c57e0ce96f1
 SHA512:
-  metadata.gz: 425d510af634ee01ad47c3eb8e3c2289f2f2e7c1b099cec3aa6a52df29bb0531d93170828391768832b6335d8b6e8f57497c432ace485c3c14fd2490e127a3dd
-  data.tar.gz: 5a1fef723c7ff99386fb14557bfb8a032936cf37ffad3f7361f68229fa2cb9378162e87f3f63aaa7adfbe324fa3f226b8562d3e970a042e93bb0d41cef1f26a8
+  metadata.gz: fe45b373da2386e1a681535cb062c7d93637e6dd03708c76fd678349046a3e1228ff14af78aad34999387821b1d07c6a65534d7ea7b26778c0a88dfe14ae2028
+  data.tar.gz: 776c156d70fa5bcd18342c165bcb6698b45c4e2f8fba2e3aec66299eecc0dbcd08896d7b7f050330720d95122a57f173875b1c4106be660acd4eb53514102a48

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+module RSpec
+  module Ci
+    module Prettify
+        class Annotation
+            def initialize(notification)
+                @notification = notification
+                @example = notification.example
+            end
+
+            attr_reader :example, :notification
+
+            def line
+                location.split(':')[1]
+            end
+
+            def error
+                msg = notification.message_lines.join("\n")
+                format_annotation_err(msg)
+            end
+
+            def file
+                File.realpath(location.split(':')[0]).sub(/\A#{github_workspace_file_path}#{File::SEPARATOR}/, '')
+            end
+
+            private
+
+            def format_annotation_err(str)
+                stripped_str = strip_ansi_colours(str)
+                formatted_str = stripped_str.gsub("\n", '').gsub('"', "'")
+                formatted_str.squeeze(" ")
+            end
+
+            # running --force-color for rspec for a more readable CI
+            # output works great but unfortunately ANSI colours dont
+            # get parsed properly on github annotations therefore
+            # make them harder to read. Stripping any ANSI colours 
+            # on annotations here gives us the best of both worlds
+            # readable annotations and readable coloured CI
+            def strip_ansi_colours(str)
+                str.gsub(/\e\[(\d+)(;\d+)*m/, '')
+            end
+
+            def github_workspace_file_path
+                File.realpath(ENV.fetch('GITHUB_WORKSPACE', '.'))
+            end
+
+            def location
+                example.location
+            end
+        end
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module RSpec
   module Ci
     module Prettify
       module Constants
-        SEPARATOR = "\n\n#{'-' * 55}"
+        SEPARATOR = "#{'-' * 55}"
       end
     end
   end

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

@@ -4,6 +4,7 @@ require 'rspec/core'
 require 'rspec/core/formatters/base_formatter'
 require 'rspec/core/formatters/console_codes'
 require_relative 'constants'
+require_relative 'annotation'
 
 module RSpec
   module Ci
@@ -17,38 +18,43 @@ module RSpec
         end
 
         def dump_summary(summary)
-          @output << RSpec::Ci::Prettify::Constants::SEPARATOR
-          @output << format_colour("\n\nSUMMARY:\n\t", :cyan)
+          @output << "\n\n"
+          @output << RSpec::Core::Formatters::ConsoleCodes.wrap(RSpec::Ci::Prettify::Constants::SEPARATOR, :bold_white)
+          @output << "\n\n"
+          @output << RSpec::Core::Formatters::ConsoleCodes.wrap('SUMMARY:', :cyan)
 
           build_summary(summary)
         end
 
         def dump_pending(notification)
-          @output << RSpec::Ci::Prettify::Constants::SEPARATOR
-          @output << format_colour("\n\nPENDING:\n\t", :pending)
+          @output << "\n\n"
+          @output << RSpec::Core::Formatters::ConsoleCodes.wrap(RSpec::Ci::Prettify::Constants::SEPARATOR, :bold_white)
+          @output << "\n\n"
+          @output << RSpec::Core::Formatters::ConsoleCodes.wrap('PENDING:', :pending)
+          @output << "\n\n\t"
 
           @output << notification.pending_examples.map do |example|
-            format_colour(format_example_summary(example), :pending)
+            RSpec::Core::Formatters::ConsoleCodes.wrap(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 << "\n\n"
+          @output << RSpec::Core::Formatters::ConsoleCodes.wrap(RSpec::Ci::Prettify::Constants::SEPARATOR, :bold_white)
+          @output << "\n\n"
+          @output << RSpec::Core::Formatters::ConsoleCodes.wrap('FAILURES:', :failure)
+          @output << "\n\n\t"
           @output << failed_examples_output(notification)
         end
 
-        def example_passed(example)
-          # @output << RSpec::Core::Formatters::ConsoleCodes.wrap(".", :success)
+        def example_failed(notification)
+          annotation = RSpec::Ci::Prettify::Annotation.new(notification)
+          output << "\n::error file=#{annotation.file},line=#{annotation.line}::#{annotation.error}"
         end
 
-        def example_failed(example)
-          # @output << RSpec::Core::Formatters::ConsoleCodes.wrap("F", :failure)
-        end
+        def example_passed(_example); end
 
-        def example_pending(example)
-          # @output << RSpec::Core::Formatters::ConsoleCodes.wrap("*", :pending)
-        end
+        def example_pending(_example); end
 
         def close(_notification)
           @output << "\n"
@@ -63,44 +69,49 @@ module RSpec
 
           failure_count = summary.failed_examples.count
           pass_count = total_tests_ran - failure_count
-
+          @output << "\n"
           @output << build_test_suite_duration(summary, total_tests_ran)
+          @output << "\n"
           @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)
+            @output << "\n"
+            @output << RSpec::Core::Formatters::ConsoleCodes.wrap("All #{total_tests_ran} tests ran passed!!!",
+                                                                  :magenta)
             return
           end
-
+          @output << "\n"
           @output << build_failure_summary(failure_count, total_tests_ran)
+          @output << "\n"
           @output << build_pass_summary(pass_count, total_tests_ran)
+          @output << "\n"
         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}."
+          duration_text = "Ran #{test_run_count} tests overall in #{duration}."
 
-          format_colour(duration_text, :cyan)
+          RSpec::Core::Formatters::ConsoleCodes.wrap(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)
+
+          pending_summary = "#{pending_percentage} of tests skipped/pending (#{pending_count})"
+          indent(RSpec::Core::Formatters::ConsoleCodes.wrap(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)
+          failure_summary = "#{failure_percentage} of tests failed (#{failure_count})"
+          indent(RSpec::Core::Formatters::ConsoleCodes.wrap(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 = "#{pass_percentage} of tests passed (#{pass_count})"
 
-          pass_summary = "\n #{pass_percentage} of tests passed (#{pass_count})"
-
-          indent(format_colour(pass_summary, :success), 4)
+          indent(RSpec::Core::Formatters::ConsoleCodes.wrap(pass_summary, :success), 4)
         end
 
         def percentage_of_examples(count, total)
@@ -120,10 +131,6 @@ module RSpec
           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
@@ -132,10 +139,11 @@ module RSpec
 
         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)
+          sanitized_err_message = sanitize_msg(msg)
+          formatted_err_message = RSpec::Core::Formatters::ConsoleCodes.wrap(sanitized_err_message, :failure)
+          summary = RSpec::Core::Formatters::ConsoleCodes.wrap(format_example_summary(example), :failure)
 
-          "#{summary} \n  #{formatted_err_message}"
+          "#{summary} \n  #{formatted_err_message} \n"
         end
 
         def sanitize_msg(msg)

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

@@ -3,7 +3,7 @@
 module RSpec
   module Ci
     module Prettify
-      VERSION = '0.1.0'
+      VERSION = '0.3.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-ci-prettify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - jjholmes927
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rspec/ci/prettify.rb
+- lib/rspec/ci/prettify/annotation.rb
 - lib/rspec/ci/prettify/constants.rb
 - lib/rspec/ci/prettify/formatter.rb
 - lib/rspec/ci/prettify/version.rb