tee_logger 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42308c52d2bc5ef56c767672b7ae3176649252a9
-  data.tar.gz: 2e8b699ed7291753b0e6c0b124ddcebf612617b0
+  metadata.gz: 874f1b444b9aabcee203bb8353f3aa9dad7e949c
+  data.tar.gz: ca390ff17b91be912c99777dd02e67d27289ad5f
 SHA512:
-  metadata.gz: 346a26ebc18965a8a0b12f449b159c42a8caab094abea47cc1318ff4ea04ed3607d5a18d6d4013b63224c00a2b7bfea46a86811dcebf471ae536c1c299a2fe67
-  data.tar.gz: dd67b9fc88b165ddd134870fa42806207a1b19ff9a9f1319e68c2c795ba1e88f9519efd842ee1a41a40fa455a3be36142f3237aaf0bb4304da2b5b51a24f185a
+  metadata.gz: 39ff82dd2e8177e79941cf0c01f42fd9883e07836ae76aa884ff61830047f0354ace54c384019849eb130d13560b0b4ee3e2a5ff337d1762f45ef8e53378982d
+  data.tar.gz: a2e62ecde98d03f0471bcf28ec22ab849ed0ad994eaa6d8292c80bd5b0106338f2b816f74746f887cf579a26d794f3e96522067bb74a7ab14f25aa8f223e1f1b

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v3.1.1
+- [[clean] module split](https://github.com/k-ta-yamada/tee_logger/pull/14)
+
 # v3.1.0
 - [issue #12](https://github.com/k-ta-yamada/tee_logger/issues/12)
   Include and Extend support

data/README.md

@@ -2,6 +2,7 @@
 [![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)
 
 > 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).
@@ -117,6 +118,33 @@ tl.datetime_format = '%Y%m%d %H%M%S '
 ```
 
 
+## include or extend TeeLogger for casual use
+
+> TODO: the log file will be in default of `./tee_logger.log`
+
+```ruby
+require 'tee_logger'
+
+class YourAwesomeClass
+  include TeeLogger
+
+  def awesome_method
+    # do somthing
+    logger.info 'this is message is logging and disp console'
+  end
+end
+
+module YourAwesomeModule
+  extend TeeLogger
+
+  def self.awesome_method
+    # do somthing
+    logger.info 'this is message is logging and disp console'
+  end
+end
+```
+
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies.

data/lib/tee_logger/constants.rb

@@ -2,19 +2,27 @@
 module TeeLogger
   # no param of filename, set this filename
   DEFAULT_FILE = './tee_logger.log'
+
   # Implements targets
   LOGGING_METHODS = [:debug, :info, :warn, :error, :fatal]
+
   # defined logdev names
   LOGDEV_NAMES = [:console, :logfile]
+
   # defined paired of logdev name
   LOGDEV_REVERSE = { console: :logfile, logfile: :console }
 
+  # empty format
   FORMATTER_FOR_DISABLING = proc { |_severity, _time, _progname, _msg| '' }
 
-  # using private method #parse_to_hash
+  # using TeeLogger::Utils.extract_options
+  # @param logdev_name [Symbol]
+  # @param indent_level [Fixnum]
   ParsedOption = Struct.new(:logdev_name, :indent_level)
+
   # LOGDEV_NAMES not included error
   class IncorrectNameError < StandardError; end
+
   # option's class is not allow
   class IncorrectOptionError < StandardError; end
 end

data/lib/tee_logger/tee_logger_base.rb

@@ -0,0 +1,117 @@
+# namespace
+module TeeLogger
+  # main
+  # @see http://www.rubydoc.info/stdlib/logger/Logger Logger
+  class TeeLoggerBase
+    class << self
+      # @!macro [attach] logging_methods
+      #   @!method $1(progname = nil, *options, &block)
+      #   logging $1 level message.
+      #   @param progname see also Logger
+      #   @param options [Array]
+      #   @option options [Fixnum] indent_level
+      #   @option options [Symbol] enabling_target
+      #                            valid values => [:console, :logfile]
+      #   @param &block see also Logger
+      #   @return true
+      #   @see Logger
+      def define_logging_methods(name)
+        define_method(name) do |progname = nil, *options, &block|
+          logdev_name, indent_level = extract_options(options).values
+          progname, block = indentation(progname, block, indent_level)
+          logging(name, progname, logdev_name, &block)
+        end
+      end
+      private :define_logging_methods
+
+      # @!macro [attach] loglevel_check_methods
+      #   @!method $1(name)
+      #   @return [Boolean]
+      def define_loglevel_check_methods(name)
+        define_method(name) do
+          @console.send(name)
+          @logfile.send(name)
+        end
+      end
+      private :define_loglevel_check_methods
+    end
+
+    include Utils
+    attr_reader :level, :progname, :formatter, :datetime_format
+
+    # @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)
+      @console = Logger.new($stdout)
+      @logfile = Logger.new(logdev, shift_age, shift_size)
+    end
+
+    define_logging_methods :debug
+    define_logging_methods :info
+    define_logging_methods :warn
+    define_logging_methods :error
+    define_logging_methods :fatal
+
+    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?
+
+    # @param level [Integer]
+    def level=(level)
+      @console.level = @logfile.level = @level = level
+    end
+    alias_method :sev_threshold, :level
+    alias_method :sev_threshold=, :level=
+
+    # @param name [String, Symbol]
+    def progname=(name = nil)
+      @console.progname = @logfile.progname = @progname = name
+    end
+
+    # @param formatter
+    def formatter=(formatter)
+      @console.formatter = @logfile.formatter = @formatter = formatter
+    end
+
+    # @param formatter
+    def datetime_format=(format)
+      @console.datetime_format =
+        @logfile.datetime_format =
+          @datetime_format = format
+    end
+
+    # @param logdev_name [String, Symbol]
+    # @yield before logdev_name disable, after logdev_name enable.
+    def disable(logdev_name)
+      correct_name?(logdev_name)
+      if block_given?
+        disable(logdev_name)
+        yield
+        enable(logdev_name)
+      else
+        logdev_instance(logdev_name).formatter = FORMATTER_FOR_DISABLING
+      end
+    end
+
+    # @param logdev_name [String, Symbol]
+    def enable(logdev_name)
+      correct_name?(logdev_name)
+      logdev_instance(logdev_name).formatter = @formatter
+    end
+
+    private
+
+    def logging(name, progname, logdev_name = nil, &block)
+      if logdev_name
+        disable(logdev_name) { logging(name, progname, &block) }
+      else
+        @console.send(name, progname, &block)
+        @logfile.send(name, progname, &block)
+      end
+    end
+  end
+end

data/lib/tee_logger/utils.rb

@@ -16,9 +16,9 @@ module TeeLogger
       end
     end
 
-    # @params progname
-    # @params block
-    # @params indent_level [Fixnum]
+    # @param progname
+    # @param block
+    # @param indent_level [Fixnum]
     # @return [Array]
     def indentation(progname, block, indent_level)
       if block.nil?
@@ -30,7 +30,7 @@ module TeeLogger
       [progname, block]
     end
 
-    # @params val
+    # @param val [Object]
     # @return [String]
     def formatting(val)
       case val
@@ -40,32 +40,32 @@ module TeeLogger
       end
     end
 
-    # @params val [Symbol]
+    # @param val [Symbol]
     # @return [Symbol]
     def name_reverse(val)
       correct_name?(val)
       LOGDEV_REVERSE[val]
     end
 
-    # @params name [Symbol]
+    # @param name [Symbol]
     # @return [true]
     def correct_name?(name)
       LOGDEV_NAMES.include?(name) ? true : incorrect_name_error(name)
     end
 
-    # @params name [Symbol]
+    # @param name [Symbol]
     def incorrect_name_error(name)
       fail IncorrectNameError,
            "logdev_name is :console or :logfile. logdev_name=[:#{name}]"
     end
 
-    # @params name [Symbol]
+    # @param val [Symbol]
     def incorrect_option_error(val)
       fail IncorrectOptionError,
            "option params is Symbol or Fixnum. class=[#{val.class}]"
     end
 
-    # @params logdev_name [Symbol]
+    # @param logdev_name [Symbol]
     # @return [Logger]
     def logdev_instance(logdev_name)
       instance_variable_get("@#{logdev_name}")

data/lib/tee_logger/version.rb

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

data/lib/tee_logger.rb

@@ -1,153 +1,45 @@
 require 'tee_logger/version'
 require 'tee_logger/constants'
 require 'tee_logger/utils'
+require 'tee_logger/tee_logger_base'
 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
-
-  # define singleton method .logger for your module.
-  # and TeeLogger.progname is your module name.
-  def self.extended(mod)
-    mod.class_eval do
-      define_singleton_method(:logger) do |logdev = DEFAULT_FILE|
-        return @logger if @logger
-        @logger = TeeLogger.new(logdev)
-        @logger.progname = self
-        @logger
-      end
-    end
-  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 |logdev = DEFAULT_FILE|
-        return @logger if @logger
-        @logger = TeeLogger.new(logdev)
-        @logger.progname = self.class.name
-        @logger
-      end
-    end
-  end
-
-  # main
-  # @see http://www.rubydoc.info/stdlib/logger/Logger Logger
-  class TeeLogger
-    class << self
-      # @!macro [attach] logging_methods
-      #   @!method $1(progname = nil, *options, &block)
-      #   logging $1 level message.
-      #   @param progname see also Logger
-      #   @param options [Array]
-      #   @option options [Fixnum] indent_level
-      #   @option options [Symbol] enabling_target
-      #                            valid values => [:console, :logfile]
-      #   @param &block see also Logger
-      #   @return true
-      #   @see Logger
-      def define_logging_methods(name)
-        define_method(name) do |progname = nil, *options, &block|
-          logdev_name, indent_level = extract_options(options).values
-          progname, block = indentation(progname, block, indent_level)
-          logging(name, progname, logdev_name, &block)
-        end
-      end
-      private :define_logging_methods
-
-      # @!macro [attach] loglevel_check_methods
-      #   @!method $1(name)
-      #   @return [Boolean]
-      def define_loglevel_check_methods(name)
-        define_method(name) do
-          @console.send(name)
-          @logfile.send(name)
-        end
-      end
-      private :define_loglevel_check_methods
-    end
-
-    include Utils
-    attr_reader :level, :progname, :formatter, :datetime_format
-
+  class << self
+    # shortcut for TeeLogger::TeeLoggerBase.new
     # @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)
-      @console = Logger.new($stdout)
-      @logfile = Logger.new(logdev, shift_age, shift_size)
-    end
-
-    define_logging_methods :debug
-    define_logging_methods :info
-    define_logging_methods :warn
-    define_logging_methods :error
-    define_logging_methods :fatal
-
-    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?
-
-    # @param level [Integer]
-    def level=(level)
-      @console.level = @logfile.level = @level = level
-    end
-    alias_method :sev_threshold, :level
-    alias_method :sev_threshold=, :level=
-
-    # @param name [String, Symbol]
-    def progname=(name = nil)
-      @console.progname = @logfile.progname = @progname = name
-    end
-
-    # @param formatter
-    def formatter=(formatter)
-      @console.formatter = @logfile.formatter = @formatter = formatter
-    end
-
-    # @param formatter
-    def datetime_format=(format)
-      @console.datetime_format =
-        @logfile.datetime_format =
-          @datetime_format = format
-    end
-
-    # @param logdev_name [String, Symbol]
-    # @yield before logdev_name disable, after logdev_name enable.
-    def disable(logdev_name)
-      correct_name?(logdev_name)
-      if block_given?
-        disable(logdev_name)
-        yield
-        enable(logdev_name)
-      else
-        logdev_instance(logdev_name).formatter = FORMATTER_FOR_DISABLING
+    # @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
+
+    # 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
     end
 
-    # @param logdev_name [String, Symbol]
-    def enable(logdev_name)
-      correct_name?(logdev_name)
-      logdev_instance(logdev_name).formatter = @formatter
-    end
-
-    private
-
-    def logging(name, progname, logdev_name = nil, &block)
-      if logdev_name
-        disable(logdev_name) { logging(name, progname, &block) }
-      else
-        @console.send(name, progname, &block)
-        @logfile.send(name, progname, &block)
+    # 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
       end
     end
   end

data/tee_logger.gemspec

@@ -31,9 +31,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-doc'
   spec.add_development_dependency 'pry-theme'
+  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rubocop'
 
   spec.add_development_dependency 'capture_stdout'
   spec.add_development_dependency 'fakefs'
-  spec.add_development_dependency 'parallel'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tee_logger
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - k-ta-yamada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2015-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capture_stdout
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakefs
+  name: capture_stdout
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: parallel
+  name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -182,6 +182,7 @@ files:
 - Rakefile
 - lib/tee_logger.rb
 - lib/tee_logger/constants.rb
+- lib/tee_logger/tee_logger_base.rb
 - lib/tee_logger/utils.rb
 - lib/tee_logger/version.rb
 - tee_logger.gemspec
@@ -205,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: logging to file and standard output.