logger-joint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e45acde6b29657925fcfb1129ac063cffe029bb0edf81eced14b54499d4a957f
+  data.tar.gz: 603cd6fc299340edb2375cfb3d4a2e2cc5241b6195b1a78f150910cee9b5d6ce
+SHA512:
+  metadata.gz: 1dcf661052c15f5e3b518660df74363e282b8f28b08145e8f18c2be644cfaf2803fd629fdaef173adca437fa9d235a6c385580de12399328f0df1311a9e60d9d
+  data.tar.gz: be85060c678684a7d4a563373c9a8ecc4f0e9ab0c4080b804bc4d3830128d23187d2b99ab7068d4567abbb5c560f3f0c70530a18ffa9ba1c4b98c516c446e615

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/Gemfile.lock
+/README.html
+*~

data/Gemfile

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in logger-joint.gemspec
+gemspec
+
+# Local Variables:
+# mode: Ruby
+# indent-tabs-mode: nil
+# End:

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TOKI Yoshinori
+
+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,115 @@
+Logger::Joint
+=============
+
+logger-joint is a utility to joint multiple loggers into one logger.
+Logs can be output to multiple output destinations at the same time
+with one jointed logger.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logger-joint'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logger-joint
+
+Usage
+-----
+
+Using logger-joint is simple.
+Create an instance of `Logger::Joint` that joints two loggers.
+When a log is output to an instance of `Logger::Joint`, that log is
+output to each logger.
+
+```ruby
+irb(main):001:0> require 'stringio'
+=> false
+irb(main):002:0> out1 = StringIO.new
+=> #<StringIO:...>
+irb(main):003:0> out2 = StringIO.new
+=> #<StringIO:...>
+irb(main):004:0> require 'logger'
+=> true
+irb(main):005:0> logger1 = Logger.new(out1)
+=> #<Logger:...>
+irb(main):006:0> logger2 = Logger.new(out2)
+=> #<Logger:...>
+irb(main):007:0> require 'logger/joint'
+=> true
+irb(main):008:0> joint_logger = Logger::Joint.new(logger1, logger2)
+=> #<Logger::Joint:... @primary=#<Logger:...>, @secondary=#<Logger:...>>
+irb(main):009:0> joint_logger.info('HALO')
+=> true
+irb(main):010:0> out1.string
+=> "I, [2019-03-10T15:46:37.815496 #15407]  INFO -- : HALO\n"
+irb(main):011:0> out2.string
+=> "I, [2019-03-10T15:46:37.815669 #15407]  INFO -- : HALO\n"
+```
+
+An instance of `Logger::Joint` can be jointed with another logger.
+
+```ruby
+irb(main):012:0> out3 = StringIO.new
+=> #<StringIO:...>
+irb(main):013:0> logger3 = Logger.new(out3)
+=> #<Logger:...>
+irb(main):014:0> next_joint_logger = joint_logger + logger3
+=> #<Logger::Joint:... @primary=#<Logger::Joint:... @primary=#<Logger:...>, @secondary=#<Logger:...>>, @secondary=#<Logger:...>>
+irb(main):015:0> next_joint_logger.info('foo')
+=> true
+irb(main):016:0> out1.string
+=> "I, [2019-03-10T15:46:37.815496 #15407]  INFO -- : HALO\nI, [2019-03-10T15:56:35.320060 #15416]  INFO -- : foo\n"
+irb(main):017:0> out2.string
+=> "I, [2019-03-10T15:46:37.815669 #15407]  INFO -- : HALO\nI, [2019-03-10T15:56:35.320521 #15416]  INFO -- : foo\n"
+irb(main):018:0> out3.string
+=> "I, [2019-03-10T15:56:35.320643 #15416]  INFO -- : foo\n"
+```
+
+By using refinement of `Logger::JointPlus` it is possible to extend
+the logger object and joint the logger objects to create a
+`Logger::Joint` instance.
+
+```ruby
+irb(main):025:0> Logger.new(StringIO.new) + Logger.new(StringIO.new)
+Traceback (most recent call last):
+        4: from /usr/local/bin/irb:23:in `<main>'
+        3: from /usr/local/bin/irb:23:in `load'
+        2: from /usr/local/lib/ruby/gems/2.6.0/gems/irb-1.0.0/exe/irb:11:in `<top (required)>'
+        1: from (irb):25
+NoMethodError (undefined method `+' for #<Logger:0x00007ffff42da338>)
+irb(main):026:0> module RefinementExample
+irb(main):027:1>   using Logger::JointPlus
+irb(main):028:1>   Logger.new(StringIO.new) + Logger.new(StringIO.new)
+irb(main):029:1> end
+=> #<Logger::Joint:... @primary=#<Logger:...>, @secondary=#<Logger:...>>
+```
+
+By applying monkey patch with `require 'logger/joint_plus'` it is
+possible to extend the logger object globally and joint the logger
+objects to create a `Logger::Joint` instance.
+
+```ruby
+irb(main):030:0> require 'logger/joint_plus'
+=> true
+irb(main):031:0> Logger.new(StringIO.new) + Logger.new(StringIO.new)
+=> #<Logger::Joint:... @primary=#<Logger:...>, @secondary=#<Logger:...>>
+```
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/y10k/logger-joint>.
+
+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,31 @@
+# -*- coding: utf-8 -*-
+
+require "bundler/gem_tasks"
+require 'rake/clean'
+require 'rake/testtask'
+require 'rdoc/task'
+
+task :default => :spec
+
+Rake::TestTask.new do |task|
+  if ((ENV.key? 'RUBY_DEBUG') && (! ENV['RUBY_DEBUG'].empty?)) then
+    task.ruby_opts << '-d'
+  end
+end
+
+Rake::RDocTask.new do |rd|
+  rd.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Build README.html from markdown source.'
+task :readme => %w[ README.html ]
+
+file 'README.html' => [ 'README.md' ] do
+  sh "pandoc --from=markdown --to=html5 --standalone --self-contained --css=$HOME/.pandoc/github.css --output=README.html README.md"
+end
+CLOBBER.include 'README.html'
+
+# Local Variables:
+# mode: Ruby
+# indent-tabs-mode: nil
+# End:

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logger/joint"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/logger/joint.rb

@@ -0,0 +1,115 @@
+# -*- coding: utf-8 -*-
+
+require 'logger'
+require 'logger/joint/version'
+
+class Logger::Joint
+  # methods common to Logger and Syslog::Logger are need for.
+  def self.respond_as_logger?(object)
+    [ :level,
+      :add,
+      :debug,
+      :info,
+      :warn,
+      :error,
+      :fatal,
+      :unknown,
+      :debug?,
+      :info?,
+      :warn?,
+      :error?,
+      :fatal?
+    ].all?{|name| object.respond_to? name }
+  end
+
+  def initialize(primary_logger, secondary_logger)
+    self.class.respond_as_logger? primary_logger or raise TypeError, 'primary is not a logger.'
+    self.class.respond_as_logger? secondary_logger or raise TypeError, 'secondary is not a logger.'
+    @primary = primary_logger
+    @secondary = secondary_logger
+  end
+
+  def level
+    [ @primary, @secondary ].map(&:level).min
+  end
+
+  def apply_method(name, *args, &block)
+    r = @primary.__send__(name, *args, &block)
+    @secondary.__send__(name, *args, &block)
+    r
+  end
+  private :apply_method
+
+  def add(*args, &block)
+    apply_method(:add, *args, &block)
+  end
+
+  def debug(*args, &block)
+    apply_method(:debug, *args, &block)
+  end
+
+  def info(*args, &block)
+    apply_method(:info, *args, &block)
+  end
+
+  def warn(*args, &block)
+    apply_method(:warn, *args, &block)
+  end
+
+  def error(*args, &block)
+    apply_method(:error, *args, &block)
+  end
+
+  def fatal(*args, &block)
+    apply_method(:fatal, *args, &block)
+  end
+
+  def unknown(*args, &block)
+    apply_method(:unknown, *args, &block)
+  end
+
+  def apply_level_predicate(name)
+    @primary.__send__(name) || @secondary.__send__(name)
+  end
+  private :apply_level_predicate
+
+  def debug?
+    apply_level_predicate(:debug?)
+  end
+
+  def info?
+    apply_level_predicate(:info?)
+  end
+
+  def warn?
+    apply_level_predicate(:warn?)
+  end
+
+  def error?
+    apply_level_predicate(:error?)
+  end
+
+  def fatal?
+    apply_level_predicate(:fatal?)
+  end
+
+  module PlusMethod
+    def joint(other_logger)
+      Logger::Joint.new(self, other_logger)
+    end
+
+    alias + joint
+  end
+  include PlusMethod
+end
+
+module Logger::JointPlus
+  refine Logger do
+    include Logger::Joint::PlusMethod
+  end
+end
+
+# Local Variables:
+# mode: Ruby
+# indent-tabs-mode: nil
+# End:

data/lib/logger/joint/version.rb

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+
+require 'logger'
+
+class Logger::Joint
+  VERSION = '0.1.0'
+end
+
+# Local Variables:
+# mode: Ruby
+# indent-tabs-mode: nil
+# End:

data/lib/logger/joint_plus.rb

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+require 'logger'
+require 'logger/joint'
+
+Logger.class_eval{
+  include Logger::Joint::PlusMethod
+}
+
+# Local Variables:
+# mode: Ruby
+# indent-tabs-mode: nil
+# End:

data/logger-joint.gemspec

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "logger/joint/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "logger-joint"
+  spec.version       = Logger::Joint::VERSION
+  spec.authors       = ["TOKI Yoshinori"]
+  spec.email         = ["toki@freedom.ne.jp"]
+
+  spec.summary       = %q{logger-joint is a utility to joint multiple loggers into one logger.}
+  spec.description   = <<-'EOF'
+    logger-joint is a utility to joint multiple loggers into one logger.
+    Logs can be output to multiple output destinations at the same
+    time with one jointed logger.
+  EOF
+  spec.homepage      = "https://github.com/y10k/logger-joint"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "rdoc"
+end
+
+# Local Variables:
+# mode: Ruby
+# indent-tabs-mode: nil
+# End:

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: logger-joint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOKI Yoshinori
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      logger-joint is a utility to joint multiple loggers into one logger.
+      Logs can be output to multiple output destinations at the same
+      time with one jointed logger.
+email:
+- toki@freedom.ne.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logger/joint.rb
+- lib/logger/joint/version.rb
+- lib/logger/joint_plus.rb
+- logger-joint.gemspec
+homepage: https://github.com/y10k/logger-joint
+licenses:
+- MIT
+metadata: {}
+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.0.1
+signing_key: 
+specification_version: 4
+summary: logger-joint is a utility to joint multiple loggers into one logger.
+test_files: []