tee_logger 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0ff6fc15c1c8e804ba3667f9d181483125639e7
-  data.tar.gz: b7370c6fd53453ad75b82aac738fbe310fca0d5a
+  metadata.gz: e038d2637ea600e0ee63ecff7d2be02d8692658b
+  data.tar.gz: 347e52f9ddd2ef5c76a4320951867d409062b368
 SHA512:
-  metadata.gz: 4b83206e8378f1e44920fa27419f07829dd00106a7e9b899eab201bfe11608ec8840038175e7e8629c91cbdc532b5a213ac6982a7e595a7dfb2078cb86abf71d
-  data.tar.gz: b724b8b6e99e0213cb0aebb98e7b51ea1ef0398989f34563a232ef8f1badc0e0b77e79ff4bd9843ec947648169155c492fcb0c61616db0281968145b9d3f6532
+  metadata.gz: 553e57ad94ea5cff19078c08d4b414a1df6d045d720a10743c9c1dbb15961d55cc00e2ab49dff9d02079e3b7a2253961166ad3753f8f44c060716bd4314b732f
+  data.tar.gz: 67aca467869d1aeef54ab6f225de2cb0a08d4d8e33307f48e75d75145b191ebfeb577d4b121df7b2b04452b796c2acbd3ffab1ae1ce3285c507f62188e356cdc

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v2.4.1
+- update README.md
+- and YARD comment
+
 # v2.4.0
 - TeeLogger#disable is allow block given
 

data/README.md

@@ -1,106 +1,112 @@
-[![Gem Version](https://badge.fury.io/rb/tee_logger.svg)](http://badge.fury.io/rb/tee_logger)
-[![Build Status](https://travis-ci.org/k-ta-yamada/tee_logger.svg)](https://travis-ci.org/k-ta-yamada/tee_logger)
-[![Code Climate](https://codeclimate.com/github/k-ta-yamada/tee_logger/badges/gpa.svg)](https://codeclimate.com/github/k-ta-yamada/tee_logger)
-[![Test Coverage](https://codeclimate.com/github/k-ta-yamada/tee_logger/badges/coverage.svg)](https://codeclimate.com/github/k-ta-yamada/tee_logger/coverage)
-
-> Sorry, I changed Usage from version 2.0.0
-
-- [Rubygems.org](https://rubygems.org/gems/tee_logger)
-- [GitHub](https://github.com/k-ta-yamada/tee_logger)
-- [RubyDoc.info](http://www.rubydoc.info/gems/tee_logger)
-
-# TeeLogger
-
-logging to file and standard output.
-require standard library only.
-
-
-## Characteristic
-
-- simple: use standard lib only.
-- like Logger: see usage.
-- enabled or disabled by switching the output of the console and the logfile.
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'tee_logger'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install tee_logger
-
-
-## Usage
-
-```ruby
-require 'tee_logger'
-
-# Logger.new like options(logdev, shift_age, shift_size)
-# options default value is
-#   logdev     = './tee_logger.log'
-#   shift_age  = 0
-#   shift_size = 1_048_576
-tl = TeeLogger.new
-
-# let's logging
-tl.debug 'hello'                      # => D, [2015-09-10T00:36:45.925312 #16227] DEBUG -- : hello
-tl.debug(:progname) { 'hello world' } # => D, [2015-09-10T00:37:31.940226 #16227] DEBUG -- progname: hello world
-tl.progname = 'App'
-tl.debug 'hello tee_logger'           # => D, [2015-09-10T00:38:38.704274 #16227] DEBUG -- App: hello tee_logger
-
-# disable console output
-tl.disable(:console)
-tl.info 'this message is logfile only'
-
-# enable console output
-tl.enable(:console)
-tl.info 'this message is logfile and console'
-
-# disable logfile output
-tl.disable(:logfile)
-tl.info 'this message is consle only'
-
-# enable logfile output
-tl.enable(:logfile)
-tl.info 'this message is logfile and console'
-
-# and others like Logger's
-tl.debug? # => true
-tl.info?  # => true
-tl.warn?  # => true
-tl.error? # => true
-tl.fatal? # => true
-
-tl.level # => 0
-tl.level = Logger::INFO
-tl.debug 'this message is not logging'
-
-tl.formatter # => nil or Proc
-tl.formatter = proc {|severity, datetime, progname, message| "#{severity}:#{message}" }
-```
-
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/k-ta-yamada/tee_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+[![Gem Version](https://badge.fury.io/rb/tee_logger.svg)](http://badge.fury.io/rb/tee_logger)
+[![Build Status](https://travis-ci.org/k-ta-yamada/tee_logger.svg)](https://travis-ci.org/k-ta-yamada/tee_logger)
+[![Code Climate](https://codeclimate.com/github/k-ta-yamada/tee_logger/badges/gpa.svg)](https://codeclimate.com/github/k-ta-yamada/tee_logger)
+[![Test Coverage](https://codeclimate.com/github/k-ta-yamada/tee_logger/badges/coverage.svg)](https://codeclimate.com/github/k-ta-yamada/tee_logger/coverage)
+
+> Sorry, I changed Usage from version 2.0.0
+
+- [Rubygems.org](https://rubygems.org/gems/tee_logger)
+- [GitHub](https://github.com/k-ta-yamada/tee_logger)
+- [RubyDoc.info](http://www.rubydoc.info/gems/tee_logger)
+
+# TeeLogger
+
+logging to file and standard output.
+require standard library only.
+
+
+## Characteristic
+
+- simple: use standard lib only.
+- like Logger: see usage.
+- enabled or disabled by switching the output of the console and the logfile.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tee_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tee_logger
+
+
+## Usage
+
+```ruby
+require 'tee_logger'
+
+# Logger.new like options(logdev, shift_age, shift_size)
+# options default value is
+#   logdev     = './tee_logger.log'
+#   shift_age  = 0
+#   shift_size = 1_048_576
+tl = TeeLogger.new
+
+# let's logging
+tl.debug 'hello'
+tl.debug(:progname) { 'hello world' }
+tl.progname = 'App'
+tl.debug 'hello tee_logger'
+
+# disable console output
+tl.disable(:console)
+tl.info 'this message is logfile only'
+
+# enable console output
+tl.enable(:console)
+tl.info 'this message is logfile and console'
+
+# disable logfile output
+tl.disable(:logfile)
+tl.info 'this message is consle only'
+
+# enable logfile output
+tl.enable(:logfile)
+tl.info 'this message is logfile and console'
+
+# disabe in block
+tl.disable(:console) do
+  tl.info 'this message is logfile only'
+end
+tl.info 'this message is logfile and console'
+
+# and others like Logger's
+tl.debug? # => true
+tl.info?
+tl.warn?
+tl.error?
+tl.fatal?
+
+tl.level # => 0
+tl.level = Logger::INFO
+tl.debug 'this message is not logging'
+
+tl.formatter # => nil or Proc
+tl.formatter = proc {|severity, datetime, progname, message| "#{severity}:#{message}" }
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/k-ta-yamada/tee_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/tee_logger/constants.rb

@@ -1,10 +1,10 @@
-require 'logger'
-
-# namespace
-module TeeLogger
-  # no param of filename, set this filename
-  DEFAULT_FILE = './tee_logger.log'
-
-  # Implements targets
-  LOGGING_METHODS = [:debug, :info, :warn, :error, :fatal].freeze
-end
+require 'logger'
+
+# namespace
+module TeeLogger
+  # no param of filename, set this filename
+  DEFAULT_FILE = './tee_logger.log'
+
+  # Implements targets
+  LOGGING_METHODS = [:debug, :info, :warn, :error, :fatal].freeze
+end

data/lib/tee_logger/version.rb

@@ -1,5 +1,5 @@
-# namespace
-module TeeLogger
-  # version number
-  VERSION = '2.4.0'
-end
+# namespace
+module TeeLogger
+  # version number
+  VERSION = '2.4.1'
+end

data/lib/tee_logger.rb

@@ -1,121 +1,122 @@
-require 'tee_logger/version'
-require 'tee_logger/constants'
-require 'logger'
-
-# namespace
-module TeeLogger
-  # shortcut for TeeLogger::TeeLogger.new
-  # @see TeeLogger
-  def self.new(logdev = DEFAULT_FILE, shift_age = 0, shift_size = 1_048_576)
-    TeeLogger.new(logdev, shift_age, shift_size)
-  end
-
-  # main
-  # @see http://www.rubydoc.info/stdlib/logger/Logger Logger
-  class TeeLogger
-    # @param logdev String
-    # @param shift_age Integer
-    # @param shift_size Integer
-    # @see Logger#initialize
-    def initialize(logdev = DEFAULT_FILE, shift_age = 0, shift_size = 1_048_576)
-      @logfile = Logger.new(logdev, shift_age, shift_size)
-      @console = Logger.new($stdout)
-    end
-
-    class << self
-      private
-
-      # @!macro [attach] loglevel_check_methods
-      #   @!method $1(name)
-      #   @return [Boolean]
-      def define_loglevel_check_methods(name)
-        define_method(name) do
-          @logfile.send(name)
-          @console.send(name)
-        end
-      end
-
-      # @!macro [attach] logging_methods
-      #   @!method $1(progname = nil, &block)
-      #   logging $1 level message.
-      #   @return true
-      def define_logging_methods(name)
-        define_method(name) do |progname = nil, &block|
-          @logfile.send(name, progname, &block)
-          @console.send(name, progname, &block)
-        end
-      end
-    end
-
-    define_loglevel_check_methods :debug?
-    define_loglevel_check_methods :info?
-    define_loglevel_check_methods :warn?
-    define_loglevel_check_methods :error?
-    define_loglevel_check_methods :fatal?
-
-    define_logging_methods :debug
-    define_logging_methods :info
-    define_logging_methods :warn
-    define_logging_methods :error
-    define_logging_methods :fatal
-
-    # TODO: which value?
-    # @return [Integer]
-    def level
-      @logfile.level
-      @console.level
-    end
-
-    # @param level [Integer]
-    def level=(level)
-      @logfile.level = level
-      @console.level = level
-    end
-    alias_method :sev_threshold,  :level
-    alias_method :sev_threshold=, :level=
-
-    # TODO: both values?
-    # @return [String]
-    def progname
-      @logfile.progname
-      @console.progname
-    end
-
-    # @param name [String, Symbol]
-    def progname=(name = nil)
-      @logfile.progname = name
-      @console.progname = name
-    end
-
-    # TODO: both values?
-    # @return [String]
-    def formatter
-      @logfile.formatter
-      @console.formatter
-    end
-
-    # @param formatter
-    def formatter=(formatter)
-      @logfile.formatter = formatter
-      @console.formatter = formatter
-    end
-
-    # @todo Too miscellaneous
-    # @param target [String, Symbol]
-    def disable(target)
-      if block_given?
-        disable(target)
-        yield
-        enable(target)
-      else
-        instance_variable_get("@#{target}").formatter = proc { |_, _, _, _| '' }
-      end
-    end
-
-    # @todo Too miscellaneous
-    # @param target [String, Symbol]
-    def enable(target)
-      instance_variable_get("@#{target}").formatter = Logger::Formatter.new
-    end
-  end
-end
+require 'tee_logger/version'
+require 'tee_logger/constants'
+require 'logger'
+
+# namespace
+module TeeLogger
+  # shortcut for TeeLogger::TeeLogger.new
+  # @see TeeLogger
+  def self.new(logdev = DEFAULT_FILE, shift_age = 0, shift_size = 1_048_576)
+    TeeLogger.new(logdev, shift_age, shift_size)
+  end
+
+  # main
+  # @see http://www.rubydoc.info/stdlib/logger/Logger Logger
+  class TeeLogger
+    # @param logdev String
+    # @param shift_age Integer
+    # @param shift_size Integer
+    # @see Logger#initialize
+    def initialize(logdev = DEFAULT_FILE, shift_age = 0, shift_size = 1_048_576)
+      @logfile = Logger.new(logdev, shift_age, shift_size)
+      @console = Logger.new($stdout)
+    end
+
+    class << self
+      private
+
+      # @!macro [attach] loglevel_check_methods
+      #   @!method $1(name)
+      #   @return [Boolean]
+      def define_loglevel_check_methods(name)
+        define_method(name) do
+          @logfile.send(name)
+          @console.send(name)
+        end
+      end
+
+      # @!macro [attach] logging_methods
+      #   @!method $1(progname = nil, &block)
+      #   logging $1 level message.
+      #   @return true
+      def define_logging_methods(name)
+        define_method(name) do |progname = nil, &block|
+          @logfile.send(name, progname, &block)
+          @console.send(name, progname, &block)
+        end
+      end
+    end
+
+    define_loglevel_check_methods :debug?
+    define_loglevel_check_methods :info?
+    define_loglevel_check_methods :warn?
+    define_loglevel_check_methods :error?
+    define_loglevel_check_methods :fatal?
+
+    define_logging_methods :debug
+    define_logging_methods :info
+    define_logging_methods :warn
+    define_logging_methods :error
+    define_logging_methods :fatal
+
+    # TODO: which value?
+    # @return [Integer]
+    def level
+      @logfile.level
+      @console.level
+    end
+
+    # @param level [Integer]
+    def level=(level)
+      @logfile.level = level
+      @console.level = level
+    end
+    alias_method :sev_threshold,  :level
+    alias_method :sev_threshold=, :level=
+
+    # TODO: both values?
+    # @return [String]
+    def progname
+      @logfile.progname
+      @console.progname
+    end
+
+    # @param name [String, Symbol]
+    def progname=(name = nil)
+      @logfile.progname = name
+      @console.progname = name
+    end
+
+    # TODO: both values?
+    # @return [String]
+    def formatter
+      @logfile.formatter
+      @console.formatter
+    end
+
+    # @param formatter
+    def formatter=(formatter)
+      @logfile.formatter = formatter
+      @console.formatter = formatter
+    end
+
+    # @todo Too miscellaneous
+    # @param target [String, Symbol]
+    # @yield before target disable, after target enable.
+    def disable(target)
+      if block_given?
+        disable(target)
+        yield
+        enable(target)
+      else
+        instance_variable_get("@#{target}").formatter = proc { |_, _, _, _| '' }
+      end
+    end
+
+    # @todo Too miscellaneous
+    # @param target [String, Symbol]
+    def enable(target)
+      instance_variable_get("@#{target}").formatter = Logger::Formatter.new
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tee_logger
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - k-ta-yamada