ci_logger 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d378e44c124952aecefaada042e51ca49bde9f126970a7ed5b8e04a9f4523a4f
-  data.tar.gz: cb5d471262303a7b6075979c5c4d411424fa1783742e1a2c67aea4630ed5166e
+  metadata.gz: 51c9f02d787a2ea528d373395735b2a3f442c410b371b3a678cff837245056e2
+  data.tar.gz: b64fc8ea5f7f8590cf102b6ceb24bf47b113014061b526753ed12a22c8eec166
 SHA512:
-  metadata.gz: 40f1589c2767df171705caa124a03afe67b793e043f9ec94a2d4dc0552029bdca4c5cbca2dafe1b9182b6b6d00afec6821a9dea1b4024c6585c04ee1a560b9da
-  data.tar.gz: fbe15cfa23c67256a4b8a71fb2871b7da2dc0b236d913537d2ae49a70a4b4e2738ec0eff000013c2b921d24894e28f240018986ef02ba20b007c8dab1bfd07f3
+  metadata.gz: acfa40bed44dc82d44e311cf5a8124c32545176d8361e57e3fa82ae0b6a3bcc20bb3a201a4a6b84338eb6e4fc27d447e8ca8efaad14fe23343cbe24b5e08cbe8
+  data.tar.gz: 0eb2d0c042f3e926ee34368e9681200f676f30f54860bad8ff636b44c952e3cd94ec86084bbf77966d3ec529e815cb3995eebb71070b6dd10fb7836866f3a6bf

data/README.md

@@ -6,11 +6,9 @@ CiLogger specifically generates logs for failed tests, which proves invaluable d
 
 ## prerequisite
 
-- rspec
+- rspec or minitest
 - rails(>= 6.0)
 
-If you want minitest integration, send Pull Request! 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -37,6 +35,15 @@ config.ci_logger.enabled = ENV['CI']
 
 You can replace `ENV['CI']` with what you like.
 
+## Replace loggers besides rails logger
+
+CiLogger replaces Rails.logger by default, but other loggers can be replaced.
+
+```ruby
+your_logger = CiLogger.new(your_logger)
+your_logger.debug('debug!') # This is only output when the test fails
+```
+
 ## Contributing
 Contribution directions go here.
 

data/lib/ci_logger/logger.rb

@@ -1,3 +1,5 @@
+require "ci_logger/registry"
+
 module CiLogger
   class Logger < ::Logger
     def initialize(original)
@@ -5,6 +7,7 @@ module CiLogger
       @original_level = @original.level
       @original.level = :debug
       self.level = :debug
+      Registry.register(self)
     end
 
     def sync

data/lib/ci_logger/minitest/integration.rb

@@ -0,0 +1,19 @@
+module CiLogger
+  module Minitest
+    module Integration
+      def before_teardown
+        super
+        if CiLogger.disabled?
+          Registry.sync
+        elsif passed? || skipped?
+          Registry.clear
+        else
+          Registry.sync
+        end
+      end
+    end
+  end
+end
+class ActiveSupport::TestCase
+  include CiLogger::Minitest::Integration
+end

data/lib/ci_logger/railtie.rb

@@ -4,30 +4,20 @@ module CiLogger
     config.ci_logger.enabled = false
 
     config.before_initialize do
-      if Rails.application.config.ci_logger.enabled
+      if CiLogger.enabled?
         Rails.logger = CiLogger::Logger.new(Rails.logger)
-        require "rspec/core"
-        require "ci_logger/example_group_methods"
-
-        RSpec.configure do |config|
-          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
+        begin
+          require "rspec/core"
+          require "ci_logger/rspec/integration"
+        rescue LoadError
+          # do nothing
+        end
 
-          config.append_after do |example|
-            if !Rails.application.config.ci_logger.enabled
-              Rails.logger.sync
-            elsif passed?
-              Rails.logger.clear
-            else
-              Rails.logger.debug("finish example at #{example.location}")
-              Rails.logger.sync
-            end
-          end
+        begin
+          require "active_support/test_case"
+          require "ci_logger/minitest/integration"
+        rescue LoadError
+          # do nothing
         end
       end
     end

data/lib/ci_logger/registry.rb

@@ -0,0 +1,22 @@
+module CiLogger
+  module Registry
+    class << self
+      def register(logger)
+        @loggers ||= []
+        @loggers << logger
+      end
+
+      def sync
+        @loggers.each(&:sync)
+      end
+
+      def clear
+        @loggers.each(&:clear)
+      end
+
+      def debug(...)
+        @loggers.each { _1.debug(...) }
+      end
+    end
+  end
+end

data/lib/ci_logger/rspec/example_group_methods.rb

@@ -0,0 +1,16 @@
+module CiLogger
+  module Rspec
+    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
+end

data/lib/ci_logger/rspec/integration.rb

@@ -0,0 +1,22 @@
+require "ci_logger/rspec/example_group_methods"
+
+RSpec.configure do |config|
+  config.include CiLogger::Rspec::ExampleGroupMethods
+
+  config.prepend_before do |example|
+    next if CiLogger.disabled?
+
+    CiLogger::Registry.debug("start example at #{example.location}")
+  end
+
+  config.append_after do |example|
+    if CiLogger.disabled?
+      CiLogger::Registry.sync
+    elsif passed?
+      CiLogger::Registry.clear
+    else
+      CiLogger::Registry.debug("finish example at #{example.location}")
+      CiLogger::Registry.sync
+    end
+  end
+end

data/lib/ci_logger/version.rb

@@ -1,3 +1,3 @@
 module CiLogger
-  VERSION = '0.5.1'
+  VERSION = '0.7.0'
 end

data/lib/ci_logger.rb

@@ -3,4 +3,17 @@ require "ci_logger/railtie"
 require "ci_logger/logger"
 
 module CiLogger
+  class << self
+    def new(original)
+      Logger.new(original)
+    end
+
+    def enabled?
+      Rails.application.config.ci_logger.enabled
+    end
+
+    def disabled?
+      !enabled?
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci_logger
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - willnet
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2023-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-- !ruby/object:Gem::Dependency
-  name: rspec-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -63,9 +49,12 @@ files:
 - README.md
 - Rakefile
 - lib/ci_logger.rb
-- lib/ci_logger/example_group_methods.rb
 - lib/ci_logger/logger.rb
+- lib/ci_logger/minitest/integration.rb
 - lib/ci_logger/railtie.rb
+- lib/ci_logger/registry.rb
+- lib/ci_logger/rspec/example_group_methods.rb
+- lib/ci_logger/rspec/integration.rb
 - lib/ci_logger/version.rb
 - lib/tasks/ci_logger_tasks.rake
 homepage: https://github.com/willnet/ci_logger
@@ -90,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: Faster logger for CI

data/lib/ci_logger/example_group_methods.rb

@@ -1,14 +0,0 @@
-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