tee_logger 3.1.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86ce84adde4f699ebfbb78b876b2772f6d35e8af
-  data.tar.gz: d9eefa9bc74cd88ee68becce4495c7ca35aa6542
+  metadata.gz: a90d6ef3ba88bed38455955c9e7e0654440d9e80
+  data.tar.gz: d99ccca31c41af678fe5111be644decb3e783a4c
 SHA512:
-  metadata.gz: afb40f06dd8f92fd504271acbbdefcffd47d4ee2120ca84b16c75f4b1d0669fcdd0cb973f8081beeef4e22de49c4bcb43c753190a54a97936e01c2688904d93a
-  data.tar.gz: b6d9e611a97c4c088511f5566acaf0f798301235b8332daab62fa9d6679918a5baae4c989f001790c4c4cf5a4c233f6c9fe8bba1fdedc8c646c1ebf901ac9331
+  metadata.gz: fcc81f3c5491f42351e90abb301bfc8821238fc237a843f483e29b42f5500464b1682569285bc943db7ba441ce80449e127380dfcf29ad89f881f18be3e6c974
+  data.tar.gz: c6a2a450f5284eea3b19ddd5e71292b1816b5337d1dd3343733b5eb9db580d6c58760357ec5b9d49201bdd7222fd49fe55655b4a9c7a74508f4c35b3ac682aa1

data/.gitignore

@@ -55,3 +55,6 @@ $RECYCLE.BIN/
 
 # Windows shortcuts
 *.lnk
+
+*tags*
+*.log

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+Style/AsciiComments:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v3.2.0
+- [issue #15](https://github.com/k-ta-yamada/tee_logger/issues/15)
+  Before extend or include the module, allow the setting of logdev
+
 # v3.1.2
 - add .gemspec required_ruby_version = '>= 2.0.0'
 

data/README.md

@@ -1,11 +1,11 @@
-[![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)
-[![Inline docs](http://inch-ci.org/github/k-ta-yamada/tee_logger.svg?branch=master)](http://inch-ci.org/github/k-ta-yamada/tee_logger)
+[![Gem Version][gem_version-svg]][gem_version]
+[![Build Status][travis-svg]][travis]
+[![Code Climate][codeclimate-svg]][codeclimate]
+[![Test Coverage][codeclimate_cov-svg]][codeclimate_cov]
+[![Inline docs][inch-ci-svg]][inch-ci]
 
 > Sorry. In from version 2 to version 3, changed usage.
-> see also [CHANGELOG.md](https://github.com/k-ta-yamada/tee_logger/blob/master/CHANGELOG.md).
+> see also [CHANGELOG.md][tee_logger-changelog].
 
 - [Rubygems.org](https://rubygems.org/gems/tee_logger)
 - [GitHub](https://github.com/k-ta-yamada/tee_logger)
@@ -48,73 +48,74 @@ $ 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'
-
-# enable only when specified
-tl.info 'this message is console and logfile'
-tl.info 'this message is console only', :console
-tl.info 'this message is logfile only', :logfile
-
-# log meassage indent
-tl.info 'hello'    # => 'hello'
-tl.info 'hello', 0 # => 'hello'
-tl.info 'hello', 2 # => '  hello'
-
-# enabling and indent
-tl.info 'this message is console only', 2, :console
-tl.info 'this message is console only', :console, 2
-
-# 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
+  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'
+
+  # enable only when specified
+  tl.info 'this message is console and logfile'
+  tl.info 'this message is console only', :console
+  tl.info 'this message is logfile only', :logfile
+
+  # log meassage indent
+  tl.info 'hello'    # => 'hello'
+  tl.info 'hello', 0 # => 'hello'
+  tl.info 'hello', 2 # => '  hello'
+
+  # enabling and indent
+  tl.info 'this message is console only', 2, :console
+  tl.info 'this message is console only', :console, 2
+
+  # disable console output
+  tl.disable(:console)
   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?  # => true
-tl.warn?  # => true
-tl.error? # => true
-tl.fatal? # => true
+  # enable console output
+  tl.enable(:console)
+  tl.info 'this message is logfile and console'
 
-tl.level # => 0
-tl.level = Logger::INFO
-tl.debug 'this message is not logging'
+  # disable logfile output
+  tl.disable(:logfile)
+  tl.info 'this message is consle only'
 
-tl.formatter # => nil or Proc
-tl.formatter = proc { |severity, datetime, progname, message| "#{severity}:#{message}" }
+  # enable logfile output
+  tl.enable(:logfile)
+  tl.info 'this message is logfile and console'
 
-tl.datetime_format # => nil or Proc
-tl.datetime_format = '%Y%m%d %H%M%S '
+  # 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?  # => 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}" }
+
+  tl.datetime_format # => nil or Proc
+  tl.datetime_format = '%Y%m%d %H%M%S '
 ```
 
 
@@ -123,25 +124,25 @@ tl.datetime_format = '%Y%m%d %H%M%S '
 > TODO: the log file will be in default of `./tee_logger.log`
 
 ```ruby
-require 'tee_logger'
+  require 'tee_logger'
 
-class YourAwesomeClass
-  include TeeLogger
+  class YourAwesomeClass
+    include TeeLogger
 
-  def awesome_method
-    # do somthing
-    logger.info 'this is message is logging and disp console'
+    def awesome_method
+      # do somthing
+      logger.info 'this is message is logging and disp console'
+    end
   end
-end
 
-module YourAwesomeModule
-  extend TeeLogger
+  module YourAwesomeModule
+    extend TeeLogger
 
-  def self.awesome_method
-    # do somthing
-    logger.info 'this is message is logging and disp console'
+    def self.awesome_method
+      # do somthing
+      logger.info 'this is message is logging and disp console'
+    end
   end
-end
 ```
 
 
@@ -162,12 +163,33 @@ 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.
+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](http://contributor-covenant.org) code of conduct.
+and contributors are expected to adhere to the
+[Contributor Covenant](http://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).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+
+
+[gem_version]: http://badge.fury.io/rb/tee_logger
+[gem_version-svg]: https://badge.fury.io/rb/tee_logger.svg
+
+[travis]: https://travis-ci.org/k-ta-yamada/tee_logger
+[travis-svg]: https://travis-ci.org/k-ta-yamada/tee_logger.svg
+
+[codeclimate]: https://codeclimate.com/github/k-ta-yamada/tee_logger
+[codeclimate-svg]: https://codeclimate.com/github/k-ta-yamada/tee_logger/badges/gpa.svg
+
+[codeclimate_cov]: https://codeclimate.com/github/k-ta-yamada/tee_logger/coverage
+[codeclimate_cov-svg]: https://codeclimate.com/github/k-ta-yamada/tee_logger/badges/coverage.svg
+
+[inch-ci]: http://inch-ci.org/github/k-ta-yamada/tee_logger
+[inch-ci-svg]: http://inch-ci.org/github/k-ta-yamada/tee_logger.svg?branch=master
+
+[tee_logger-changelog]: https://github.com/k-ta-yamada/tee_logger/blob/master/CHANGELOG.md

data/lib/tee_logger.rb

@@ -6,40 +6,51 @@ require 'logger'
 
 # namespace
 module TeeLogger
-  class << self
-    # shortcut for TeeLogger::TeeLoggerBase.new
-    # @param logdev [String]
-    # @param shift_age [Integer]
-    # @param shift_size [Integer]
-    # @return [TeeLogger::TeeLoggerBase]
-    # @see TeeLoggerBase
-    def new(logdev = DEFAULT_FILE, shift_age = 0, shift_size = 1_048_576)
-      TeeLoggerBase.new(logdev, shift_age, shift_size)
-    end
+  # shortcut for TeeLogger::TeeLoggerBase.new
+  # @param logdev [String]
+  # @param shift_age [Integer]
+  # @param shift_size [Integer]
+  # @return [TeeLogger::TeeLoggerBase]
+  # @see TeeLoggerBase
+  def self.new(logdev = DEFAULT_FILE, shift_age = 0, shift_size = 1_048_576)
+    TeeLoggerBase.new(logdev, shift_age, shift_size)
+  end
 
-    # define singleton method .logger for your module.
-    # and TeeLogger.progname is your module name.
-    def extended(mod)
-      mod.class_eval do
-        define_singleton_method(:logger) do |logdev = DEFAULT_FILE|
-          return @logger if @logger
-          @logger = TeeLoggerBase.new(logdev)
-          @logger.progname = self
-          @logger
-        end
-      end
+  @logdev = nil
+
+  # @return [String, File] instance variable @logdev.
+  def self.logdev
+    @logdev
+  end
+
+  # set TeeLogger's class instance variable @logdev.
+  # extend or include TeeLogger then, @logdev is default argument
+  # for Logger.new(logdev).
+  # @param logdev [String, File]
+  def self.logdev=(logdev)
+    @logdev = logdev
+  end
+
+  # define singleton method .logger for your module.
+  # and TeeLogger.progname is your module name.
+  def self.extended(mod)
+    mod.define_singleton_method(:logger) do
+      return @logger if @logger
+      @logger = TeeLoggerBase.new(TeeLogger.logdev || DEFAULT_FILE)
+      @logger.progname = mod
+      @logger
     end
+  end
 
-    # define instance method #logger for your class.
-    # and TeeLogger.progname is your class name.
-    def included(klass)
-      klass.class_eval do
-        define_method(:logger) do |logdev = DEFAULT_FILE|
-          return @logger if @logger
-          @logger = TeeLoggerBase.new(logdev)
-          @logger.progname = self.class.name
-          @logger
-        end
+  # define instance method #logger for your class.
+  # and TeeLogger.progname is your class name.
+  def self.included(klass)
+    klass.class_eval do
+      define_method(:logger) do
+        return @logger if @logger
+        @logger = TeeLoggerBase.new(TeeLogger.logdev || DEFAULT_FILE)
+        @logger.progname = klass.name
+        @logger
       end
     end
   end

data/lib/tee_logger/tee_logger_base.rb

@@ -46,6 +46,8 @@ module TeeLogger
     def initialize(logdev = DEFAULT_FILE, shift_age = 0, shift_size = 1_048_576)
       @console = Logger.new($stdout)
       @logfile = Logger.new(logdev, shift_age, shift_size)
+
+      @level, @progname, @formatter, @datetime_format = nil
     end
 
     define_logging_methods :debug

data/lib/tee_logger/utils.rb

@@ -2,7 +2,7 @@
 module TeeLogger
   # util
   module Utils
-    module_function
+    # module_function
 
     # @param options [Array]
     # @return [ParsedOption]

data/lib/tee_logger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tee_logger
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
 platform: ruby
 authors:
 - k-ta-yamada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2015-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,6 +173,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -206,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: logging to file and standard output.