tee_logger 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a90d6ef3ba88bed38455955c9e7e0654440d9e80
-  data.tar.gz: d99ccca31c41af678fe5111be644decb3e783a4c
+  metadata.gz: 9698a06d0147a9728b46a704c455ac4bbb72b0ee
+  data.tar.gz: 909f2f8b60a04dc98fa19bad8085650f9bd2a0ea
 SHA512:
-  metadata.gz: fcc81f3c5491f42351e90abb301bfc8821238fc237a843f483e29b42f5500464b1682569285bc943db7ba441ce80449e127380dfcf29ad89f881f18be3e6c974
-  data.tar.gz: c6a2a450f5284eea3b19ddd5e71292b1816b5337d1dd3343733b5eb9db580d6c58760357ec5b9d49201bdd7222fd49fe55655b4a9c7a74508f4c35b3ac682aa1
+  metadata.gz: e9df0fcc964c6f734a52936aacb66650575de2475e4a54805199c6772a41037ad0c4617c3455e85b3a35697f3adac7e7baa6c51e9f2f8b0a8ef9461f3189464c
+  data.tar.gz: 1e330f7fa8e445ee507c9604d1dd2b8d7c07dd3294537aed936abdf44c0e495b566bd2df5ada856acf61902ced1768035cb1f8b3b43830db2ad9be35ea1f0c48

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 cache: bundler
 rvm:
+  - 2.3.0
   - 2.2.3
   - 2.1.7
   - 2.0.0

data/README.md

@@ -47,102 +47,158 @@ $ gem install tee_logger
 
 ## Usage
 
+### let's logging
 ```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'
+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
+
+tl.debug 'hello'
+tl.debug(:progname) { 'hello world' }
+tl.progname = 'App'
+tl.debug 'hello tee_logger'
+```
 
-  # enable console output
-  tl.enable(:console)
-  tl.info 'this message is logfile and console'
+### enable only when specified
+```ruby
+tl.info 'this message is console and logfile'
+tl.info 'this message is console only', :console
+tl.info 'this message is logfile only', :logfile
+```
 
-  # disable logfile output
-  tl.disable(:logfile)
-  tl.info 'this message is consle only'
+### log meassage indent
+```ruby
+tl.info 'hello'    # => 'hello'
+tl.info 'hello', 0 # => 'hello'
+tl.info 'hello', 2 # => '  hello'
+```
 
-  # enable logfile output
-  tl.enable(:logfile)
-  tl.info 'this message is logfile and console'
+### enabling and indent
+```ruby
+tl.info 'this message is console only', 2, :console
+tl.info 'this message is console only', :console, 2
+```
 
-  # disabe in block
-  tl.disable(:console) do
-    tl.info 'this message is logfile only'
-  end
-  tl.info 'this message is logfile and console'
+### disable console output
+```ruby
+tl.disable(:console)
+tl.info 'this message is logfile only'
+```
 
-  # and others like Logger's
-  tl.debug? # => true
-  tl.info?  # => true
-  tl.warn?  # => true
-  tl.error? # => true
-  tl.fatal? # => true
+### enable console output
+```ruby
+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
+```ruby
+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
+```ruby
+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 '
+### disable in block
+```ruby
+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
+```ruby
+# log_level
+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'
+
+# formatter
+tl.formatter # => nil or Proc
+tl.formatter =
+  proc { |severity, datetime, progname, message| "#{severity}:#{message}" }
+
+# datetime_formatter
+tl.datetime_format # => nil or Proc
+tl.datetime_format = '%Y%m%d %H%M%S '
 ```
 
 
-## include or extend TeeLogger for casual use
+## include or extend TeeLogger
+
+> the log file will be in default of `./tee_logger.log`
+
+### for casual use
+```ruby
+require 'tee_logger'
+
+class YourAwesomeClass
+  # define method #logger for your class.
+  # log file will be in default of `./tee_logger.log`
+  include TeeLogger
+
+  def awesome_method
+    logger.info 'this is message is logging and disp console'
+  end
+end
+
+module YourAwesomeModule
+  # define singleton method .logger for your module.
+  # log file will be in default of `./tee_logger.log`
+  extend TeeLogger
 
-> TODO: the log file will be in default of `./tee_logger.log`
+  def self.awesome_method
+    logger.info 'this is message is logging and disp console'
+  end
+end
+```
 
+### logfile name setting
 ```ruby
-  require 'tee_logger'
+require 'tee_logger'
 
-  class YourAwesomeClass
-    include TeeLogger
+# Before extend or include the module, allow the setting of logdev
+# sorry, `TeeLogger.logev` is deprecate.
+# TeeLogger.logdev = 'log1.log'
+TeeLogger.configure do |config|
+  config.logdev = 'log1.log'
+end
 
-    def awesome_method
-      # do somthing
-      logger.info 'this is message is logging and disp console'
-    end
+class YourAwesomeClass
+  include TeeLogger
+
+  def awesome_method
+    logger.info 'this message is output `log1.log`'
   end
+end
 
-  module YourAwesomeModule
-    extend TeeLogger
+# Before extend or include the module, allow the setting of logdev
+# sorry, `TeeLogger.logev` is deprecate.
+TeeLogger.logdev = 'log2.log'
+module YourAwesomeModule
+  extend TeeLogger
 
-    def self.awesome_method
-      # do somthing
-      logger.info 'this is message is logging and disp console'
-    end
+  def self.awesome_method
+    logger.info 'this message is output `log2.log`'
   end
+end
+
 ```
 
 

data/lib/tee_logger.rb

@@ -1,42 +1,30 @@
+require 'logger'
 require 'tee_logger/version'
 require 'tee_logger/constants'
+require 'tee_logger/configuration'
 require 'tee_logger/utils'
 require 'tee_logger/tee_logger_base'
-require 'logger'
 
 # namespace
 module TeeLogger
+  extend Configration
+
   # 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)
+  def self.new(logdev = nil, shift_age = 0, shift_size = 1_048_576)
     TeeLoggerBase.new(logdev, shift_age, shift_size)
   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 = TeeLogger.new
       @logger.progname = mod
       @logger
     end
@@ -48,7 +36,7 @@ module TeeLogger
     klass.class_eval do
       define_method(:logger) do
         return @logger if @logger
-        @logger = TeeLoggerBase.new(TeeLogger.logdev || DEFAULT_FILE)
+        @logger = TeeLogger.new
         @logger.progname = klass.name
         @logger
       end

data/lib/tee_logger/configuration.rb

@@ -0,0 +1,40 @@
+# namespace
+module TeeLogger
+  # configuration
+  module Configration
+    Configration = Struct.new(:logdev)
+
+    # Yields the global configuration to a block.
+    # @yield [Configuration] global configuration
+    def configure
+      yield configuration if block_given?
+    end
+
+    # reset configuration
+    def configuration_reset
+      @configuration = nil
+    end
+
+    # set TeeLogger::Configuration::Configration's member :logdev.
+    # extend or include TeeLogger then, :logdev is default argument
+    # for Logger.new(logdev).
+    # @param logdev [String, File]
+    def logdev=(logdev)
+      configuration.logdev = logdev
+    end
+
+    extend Gem::Deprecate
+    deprecate :logdev=, 'TeeLogger.configure', 2016, 1
+
+    # @return [String, File] `configuration.logdev` or `DEFAULT_FILE`.
+    def logdev
+      configuration.logdev || DEFAULT_FILE
+    end
+
+    private
+
+    def configuration
+      @configuration ||= Configration.new
+    end
+  end
+end

data/lib/tee_logger/tee_logger_base.rb

@@ -43,9 +43,9 @@ module TeeLogger
     # @param shift_age [Integer]
     # @param shift_size [Integer]
     # @see Logger#initialize
-    def initialize(logdev = DEFAULT_FILE, shift_age = 0, shift_size = 1_048_576)
+    def initialize(logdev = nil, shift_age = 0, shift_size = 1_048_576)
       @console = Logger.new($stdout)
-      @logfile = Logger.new(logdev, shift_age, shift_size)
+      @logfile = Logger.new(logdev || TeeLogger.logdev, shift_age, shift_size)
 
       @level, @progname, @formatter, @datetime_format = nil
     end

data/lib/tee_logger/utils.rb

@@ -2,8 +2,6 @@
 module TeeLogger
   # util
   module Utils
-    # module_function
-
     # @param options [Array]
     # @return [ParsedOption]
     def extract_options(options)

data/lib/tee_logger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tee_logger
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
 platform: ruby
 authors:
 - k-ta-yamada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2016-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -183,6 +183,7 @@ files:
 - README.md
 - Rakefile
 - lib/tee_logger.rb
+- lib/tee_logger/configuration.rb
 - lib/tee_logger/constants.rb
 - lib/tee_logger/tee_logger_base.rb
 - lib/tee_logger/utils.rb
@@ -208,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: logging to file and standard output.