rspec-ci-prettify 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf3101b2b7072996c975de110df7bac584d6205895ab9bf552bcf41fa35617b8
-  data.tar.gz: 1845bf2494e6b29d36dee4c2c27141e54e3aa832b979717b4fcff2a5f78dc54d
+  metadata.gz: f4814566aeb1130a8ca2d63035a0664b8120753d608c280270f3e2369141033d
+  data.tar.gz: f2ee21c3127d7e5fc789994ee2efc75baafc0848ee81fda995f57c57e0ce96f1
 SHA512:
-  metadata.gz: 9614286b2c32940116ddbfb04d60945c334f3ee03deb77b099480ab41814748cdd1b16d023654eee04faf14fb97fb4b0494e04bc86559671a5723515ac4bd84d
-  data.tar.gz: 26fca45f6d8e042fb3907bdb098b977128079d56e2eed9e821588c4f375532b1b3ff0cc50df4bdd71c1630eaa516fdf426371f61eda1ef20af6e0c93e94d23cd
+  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/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
@@ -20,7 +21,7 @@ module RSpec
           @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)
+          @output << RSpec::Core::Formatters::ConsoleCodes.wrap('SUMMARY:', :cyan)
 
           build_summary(summary)
         end
@@ -29,7 +30,7 @@ module RSpec
           @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 << RSpec::Core::Formatters::ConsoleCodes.wrap('PENDING:', :pending)
           @output << "\n\n\t"
 
           @output << notification.pending_examples.map do |example|
@@ -41,20 +42,19 @@ module RSpec
           @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 << RSpec::Core::Formatters::ConsoleCodes.wrap('FAILURES:', :failure)
           @output << "\n\n\t"
           @output << failed_examples_output(notification)
         end
 
-        def example_passed(example)
-
+        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)
-        end
+        def example_passed(_example); end
 
-        def example_pending(example)
-        end
+        def example_pending(_example); end
 
         def close(_notification)
           @output << "\n"
@@ -76,7 +76,8 @@ module RSpec
 
           if pass_count == total_tests_ran
             @output << "\n"
-            @output << RSpec::Core::Formatters::ConsoleCodes.wrap("All #{total_tests_ran} tests ran passed!!!", :magenta)
+            @output << RSpec::Core::Formatters::ConsoleCodes.wrap("All #{total_tests_ran} tests ran passed!!!",
+                                                                  :magenta)
             return
           end
           @output << "\n"

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

@@ -3,7 +3,7 @@
 module RSpec
   module Ci
     module Prettify
-      VERSION = '0.2.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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - jjholmes927
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-05 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