ci_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3360b4b4e26f728a5b149f75da20bc3d59bdc1a854cd636d4c27c1d47472a59d
+  data.tar.gz: 4c9e073889772abd247c543b349f8b882f0c300b960ef4c79e27e2289c7f14a2
+SHA512:
+  metadata.gz: 72beb64465367ab6fd393ed95482ddd0ee0c13555b8af0e054eda9cb38a22626834ac98cd16f7c9ad74ad5ace71e937a1908a0e852eb4842bcf7caa20ea04c9e
+  data.tar.gz: 3347289824b412d2a34997f703d8ace941b4c1fb3cc28673bcea8cd5d1bf5727199cf8601c7db778440daf6d8cc5d2b7395daae67ee14f16faa576fa5b7798dd

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 willnet
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# CiLogger
+
+Faster Logger for CI
+
+## prerequisite
+
+- rspec-rails
+- rails(>= 5.2)
+
+If you want minitest integration, send Pull Request! 
+
+## Usage
+
+As time pass, CI time increase gradually. Log output takes some times in CI, So someone may want to set :info or :error to loglevel. But we want debug log when CI fails to inspect the root cause. CiLogger output debug log only when CI fails. So we are able to logs and get faster CI.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ci_logger', group: :test
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ci_logger
+```
+
+Add this line to your config/environments/test.rb
+
+```ruby
+config.ci_logger.enabled = ENV['CI']
+```
+
+You can replace `ENV['CI']` with what you like.
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/ci_logger/logger.rb

@@ -0,0 +1,30 @@
+module CiLogger
+  class Logger < ::Logger
+    def initialize(original)
+      @original = original
+      @original.level = :debug
+      self.level = :debug
+    end
+
+    def clear
+      temporary_log.clear
+    end
+
+    def temporary_log
+      @temporary_log ||= []
+    end
+
+    def add(severity, message = nil, progname = nil)
+      temporary_log << { severity: severity, message: message, progname: progname }
+    end
+
+    def sync
+      temporary_log.each do |l|
+        if @level <= l[:severity]
+          @original.add(l[:severity], l[:message], l[:progname])
+        end
+      end
+      temporary_log.clear
+    end
+  end
+end

data/lib/ci_logger/railtie.rb

@@ -0,0 +1,20 @@
+module CiLogger
+  class Railtie < ::Rails::Railtie
+    config.ci_logger = ActiveSupport::OrderedOptions.new
+    config.ci_logger.enabled = false
+
+    config.before_initialize do
+      if config.ci_logger.enabled
+        Rails.logger = CiLogger::Logger.new(Rails.logger)
+
+        RSpec.configure do |config|
+          config.add_formatter 'progress'
+          config.add_formatter ::CiLogger::Formatter
+          config.before do |example|
+            Rails.logger.debug("start example at #{example.location}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ci_logger/version.rb

@@ -0,0 +1,3 @@
+module CiLogger
+  VERSION = '0.1.0'
+end

data/lib/ci_logger.rb

@@ -0,0 +1,36 @@
+require "ci_logger/version"
+require "ci_logger/railtie"
+require "ci_logger/logger"
+
+module CiLogger
+  begin
+    require "rspec/rails"
+
+    class Formatter
+      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.clear
+        end
+      end
+
+      def example_passed(_notification)
+        Rails.logger.clear
+      end
+
+      def example_pending(_notification)
+        Rails.logger.clear
+      end
+    end
+  rescue LoadError
+  end
+end

data/lib/tasks/ci_logger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ci_logger do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: ci_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- willnet
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+description: Faster logger for CI
+email:
+- netwillnet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/ci_logger.rb
+- lib/ci_logger/logger.rb
+- lib/ci_logger/railtie.rb
+- lib/ci_logger/version.rb
+- lib/tasks/ci_logger_tasks.rake
+homepage: https://github.com/willnet/ci_logger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/willnet/ci_logger
+  source_code_uri: https://github.com/willnet/ci_logger
+  changelog_uri: https://github.com/willnet/ci_logger
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Faster logger for CI
+test_files: []