stdlogger 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de506a5086aed8c318df2b21f9a03ac1c81b3c42
+  data.tar.gz: 2f849a1a146adbefd723688dec3d273d2dadd66c
+SHA512:
+  metadata.gz: 725bbae7a000d0111bc8733119a611ef8bed82d3f3730e2ea97d4de81bd010347cbfd9cab4036717414734799a22461e0c28d0df98e88f81840180458b7e4833
+  data.tar.gz: 9c2dc13541a4e8028296a8584b3eb650e74df9d3e1115a38c7347355711a2143fe81aa857125f39fdfdb8a53913c70c0f47e9705439d5623468dc1fb7228d16b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.8
+- 2.2.0
+before_install: gem install bundler -v 1.11.2
+notifications:
+  slack:
+    secure: PRQpcAvvve3U7+TvebaDCuhidR8+HnJO3LBXwf21hZbPwEJvu0L4J/tkn5+ICMaFUXK9sc9ORUCbcHUVLC/6dvo4g8jqGASqWyCbNB5yxDo896dnWn5ekwXfvE4KPSp0tnuvCx0bXdhewVG18Zs7RvBRbE19/CNlexZGlbulcHTTjA56LiXopWAmbfZFsOiasjVpwUdXO+npWfstMwGQpWwWiidCD3uWZBXpGoGDxApqGkWYulnwLCIOCJju+yvJ80jtJlyrv/vXsJWEfWd1Y1cdfeCyFV2/t4L6ZcVys6+yb3EfYLvF1Izj7AoV9z1kxBwf4oBnQUeBxVffn1mayh31XUjUdQOtAHbYiVomb0zjWr6R1RlrN1pS9hNIGFAi9Uhw9cMYozAGxDYndhpPrKKqHia3TwyvelgUDQ1Np9dHafWK2ltKdOVcIqKc5vuBzbgeM0pj5tK00LFQc5xla0BoIjj4AlEBZ1DgwS8bsbnIHqV/+S6YcV1lh9iBE4SyvXkDjhnKV9WIiOV5cFcWMn2jz3raM538nzLEXwOOxz8HPF+iShAp0TUKpJ8qmU/1vcDsCm1fHzdlirr3fG5EvlaWAph1zhWeP+y25WRnbvM8MtSc+GrE0kqygnYuO2EBEzru49xBFz3V+099vX7HkG9SdJ2yAf3T9d+QtL+ei5c=

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## 0.3.0 (2016/4/5)
+
+Re-release as `stdlogger`.
+
+Change:
+
+- Rename main module from `LoggerWithStdout` to `StdLogger` and method `#logger` to `#create`.
+
+## 0.2.0 (2016/4/4)
+
+Re-release as `logger-with-stdout`.
+
+Change:
+
+- Provides `LoggerWithStdout#logger` public method which returns `Logger` object.
+- Removed `Logger::WithStdout` old interface.
+
+## 0.1.0 (2016/4/3)
+
+Initial release as `logger-with_stdout`.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stdlogger.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 YASUTAKE Kiyoshi
+
+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,64 @@
+# stdlogger
+[![Build Status](https://travis-ci.org/key-amb/ruby-stdlogger.svg?branch=master)](https://travis-ci.org/key-amb/ruby-stdlogger)
+
+This package enables to create `Logger` object which writes logs to _STDOUT_ in
+addition to specified log device when _STDOUT_ is TTY.  
+And it can also write logs to _STDERR_ by option.
+
+Useful for Command-line Tools.
+
+Rewritten from [logger-with_stdout](https://github.com/key-amb/logger-with_stdout).
+
+## Usage
+
+```ruby
+require 'stdlogger'
+
+# STDOUT only
+logger = StdLogger.create
+# logfile and STDOUT
+logger = StdLogger.create '/path/to/log'
+# logdev and STDERR
+logger = StdLogger.create io_obj, stdout: false, stderr: true
+# Other options for Logger::new
+logger = StdLogger.create io_obj, shift_age: 3, shift_size: 1024 * 1024 * 8
+# Doesn't raise error when STDOUT is not TTY
+logger = StdLogger.create nil, allow_nodev: true
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stdlogger'
+```
+
+And then run `bundle` command on your terminal.
+
+Or install it yourself as:
+
+```sh
+% gem install stdlogger
+```
+
+## Spetial Thanks
+
+Thanks to [David](http://stackoverflow.com/users/796195/david) who gave me the
+idea of `MultiIO`.
+
+It is illustrated as [answer to a question in Stack Overflow](http://stackoverflow.com/a/6407200/6150943).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](../../pull/new/master)
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 YASUTAKE Kiyoshi

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib -r stdlogger'
+end
+task :c => :console

data/lib/stdlogger.rb

@@ -0,0 +1,45 @@
+require 'logger'
+
+require "stdlogger/error"
+require "stdlogger/multi_io"
+require "stdlogger/version"
+
+module StdLogger
+
+  # When no target device available, this method raises StdLogger::Error
+  # without ':allow_nodev' option.
+  # @param logdev [String, IO] path to logfile or writable IO object.
+  # @param options [Hash]
+  # @option options [String] :stdout (true) log to STDOUT or not.
+  # @option options [String] :stderr (false) log to STDERR or not.
+  # @option options [String] :shift_age (0)
+  #  'shift_age' param for Logger#new
+  # @option options [String] :shift_size (1048576)
+  #  'shift_size' param for Logger#new
+  # @option options [String] :allow_nodev (nil)
+  #  don't raise error even if no target device available
+  # @return [Logger]
+  def self.create logdev=nil, options={}
+    stdout     = options[:stdout] || true
+    stderr     = options[:stderr] || false
+    shift_age  = options[:shift_age]  || 0
+    shift_size = options[:shift_size] || 1048576
+
+    targets = []
+    if logdev
+      if logdev.class == String
+        targets << File.open(logdev, 'a')
+      else
+        targets << logdev
+      end
+    end
+    targets << $stdout if (stdout and $stdout.tty?)
+    targets << $stderr if (stderr and $stderr.tty?)
+    if targets.empty? and !options[:allow_nodev]
+      raise Error, "No output device found!"
+    end
+    multi_dev = MultiIO.new targets
+
+    Logger.new multi_dev, shift_age, shift_size
+  end
+end

data/lib/stdlogger/error.rb

@@ -0,0 +1,4 @@
+module StdLogger
+  class Error < StandardError
+  end
+end

data/lib/stdlogger/multi_io.rb

@@ -0,0 +1,15 @@
+module StdLogger
+  class MultiIO
+    def initialize targets
+      @targets = targets
+    end
+
+    def write *args
+      @targets.each { |t| t.write(*args) }
+    end
+
+    def close
+      @targets.each { |t| t.close }
+    end
+  end
+end

data/lib/stdlogger/version.rb

@@ -0,0 +1,3 @@
+module StdLogger
+  VERSION = "0.3.0"
+end

data/stdlogger.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stdlogger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stdlogger"
+  spec.version       = StdLogger::VERSION
+  spec.authors       = ["YASUTAKE Kiyoshi"]
+  spec.email         = ["yasutake.kiyoshi@gmail.com"]
+
+  spec.summary       = %q{Make Logger write logs to STDOUT in addition}
+  spec.description   = %q{Creates Logger writing logs to STDOUT or STDERR in addition to target device.}
+  spec.homepage      = "https://github.com/key-amb/stdlogger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: stdlogger
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- YASUTAKE Kiyoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Creates Logger writing logs to STDOUT or STDERR in addition to target
+  device.
+email:
+- yasutake.kiyoshi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/stdlogger.rb
+- lib/stdlogger/error.rb
+- lib/stdlogger/multi_io.rb
+- lib/stdlogger/version.rb
+- stdlogger.gemspec
+homepage: https://github.com/key-amb/stdlogger
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+signing_key: 
+specification_version: 4
+summary: Make Logger write logs to STDOUT in addition
+test_files: []