ci_logger 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de52e260b632de6a46a6a19b69e566b0549edaa2b78e839251c2b954d6fbb1d0
-  data.tar.gz: 4c005a4e2417d12bada68fbd4165a2b0e00c6ad93df4a8516bda206c810e2d8d
+  metadata.gz: 4b17a0f9e369ac57c9c50d27c68fc855e92283a5902c3359f7ed5ccb5cc7693a
+  data.tar.gz: a2b0c16d35701e97ffc0ff6a166e33cb34ac337ccae1e71b7c53998efb2459b4
 SHA512:
-  metadata.gz: 9048488a216c30c627a7a303891331cc8489b40467fc0fdd698b747ee2bd5911e0fa1d23a33574549bf44f36b42b979e1de2feaeb25474fd7c32c31bc58365be
-  data.tar.gz: ff957687392a4b2438ccb736e2b7696c47dd3784fd673ac34206ae5e176b136b2251febbe273cc05414465d36ccb2cd15a4a465f427eb5c41d6a93090a9dbcfa
+  metadata.gz: 371545c384eef42fe36754faef537eb76166937c7ed2b7e6a80408841c449695317f436fabc3c1efcb54d4edab54df54cff33f0ac21244676f18487710e91413
+  data.tar.gz: 23bbc1bf2aa2907c37ccb71fc20797790272d744e6d213e114478e574ec50c3635497d0d3c0d16aeefa024216abae5a654738de836c0374c98a0af01c7104a85

data/README.md

@@ -1,8 +1,8 @@
 # CiLogger
 
-We run a large number of tests with CI every day. When a test fails, we have to investigate the log, but as it is, the log output is so large that it is difficult to investigate the cause of the failed test.
+We perform a significant number of tests using CI on a daily basis. Whenever a test fails, we need to examine the log. However, the current log output is excessively large, making it challenging to identify the root cause of the failed test.
 
-CiLogger outputs only the log of failed tests. This is useful when investigating the cause of a failed test.
+CiLogger specifically generates logs for failed tests, which proves invaluable during the investigation of test failures.
 
 ## prerequisite
 

data/lib/ci_logger/example_group_methods.rb

@@ -0,0 +1,14 @@
+module CiLogger
+  module ExampleGroupMethods
+    # original from https://github.com/rspec/rspec-rails/blob/229f5f7ca9c0de0c7bca452450416d988f7cf612/lib/rspec/rails/example/system_example_group.rb#L28-L37
+    def passed?
+      return false if RSpec.current_example.exception
+      return true unless defined?(::RSpec::Expectations::FailureAggregator)
+
+      failure_notifier = ::RSpec::Support.failure_notifier
+      return true unless failure_notifier.is_a?(::RSpec::Expectations::FailureAggregator)
+
+      failure_notifier.failures.empty? && failure_notifier.other_errors.empty?
+    end
+  end
+end

data/lib/ci_logger/railtie.rb

@@ -4,16 +4,30 @@ module CiLogger
     config.ci_logger.enabled = false
 
     config.before_initialize do
-      if config.ci_logger.enabled
+      if Rails.application.config.ci_logger.enabled
         Rails.logger = CiLogger::Logger.new(Rails.logger)
-        require "ci_logger/rspec_formatter"
+        require "rspec/core"
+        require "ci_logger/example_group_methods"
 
         RSpec.configure do |config|
-          config.add_formatter 'progress' if config.formatters.empty?
-          config.add_formatter ::CiLogger::RspecFormatter
-          config.before do |example|
+          config.include CiLogger::ExampleGroupMethods
+
+          config.prepend_before do |example|
+            next unless Rails.application.config.ci_logger.enabled
+
             Rails.logger.debug("start example at #{example.location}")
           end
+
+          config.append_after do |example|
+            if !Rails.application.config.ci_logger.enabled
+              Rails.logger.sync
+            elsif passed? || skipped?
+              Rails.logger.clear
+            else
+              Rails.logger.debug("finish example at #{example.location}")
+              Rails.logger.sync
+            end
+          end
         end
       end
     end

data/lib/ci_logger/version.rb

@@ -1,3 +1,3 @@
 module CiLogger
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci_logger
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - willnet
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -63,9 +63,9 @@ files:
 - README.md
 - Rakefile
 - lib/ci_logger.rb
+- lib/ci_logger/example_group_methods.rb
 - lib/ci_logger/logger.rb
 - lib/ci_logger/railtie.rb
-- lib/ci_logger/rspec_formatter.rb
 - lib/ci_logger/version.rb
 - lib/tasks/ci_logger_tasks.rake
 homepage: https://github.com/willnet/ci_logger
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: Faster logger for CI

data/lib/ci_logger/rspec_formatter.rb

@@ -1,37 +0,0 @@
-require "rspec/core"
-
-module CiLogger
-  class RspecFormatter
-    RSpec::Core::Formatters.register self, :example_passed, :example_pending, :example_failed
-
-    def initialize(_out)
-      @out = _out
-    end
-
-    def example_failed(notification)
-      if Rails.application.config.ci_logger.enabled
-        example = notification.example
-        Rails.logger.debug("finish example at #{example.location}")
-        Rails.logger.sync
-      else
-        Rails.logger.sync_with_original_level
-      end
-    end
-
-    def example_passed(_notification)
-      if Rails.application.config.ci_logger.enabled
-        Rails.logger.clear
-      else
-        Rails.logger.sync_with_original_level
-      end
-    end
-
-    def example_pending(_notification)
-      if Rails.application.config.ci_logger.enabled
-        Rails.logger.clear
-      else
-        Rails.logger.sync_with_original_level
-      end
-    end
-  end
-end