tee_logger 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c8a72c49080cdf67b57ba78fd480cbe99cb4e05
-  data.tar.gz: 98be6da99a89f38ab7543b8f448a5a8d89bb0c15
+  metadata.gz: 42308c52d2bc5ef56c767672b7ae3176649252a9
+  data.tar.gz: 2e8b699ed7291753b0e6c0b124ddcebf612617b0
 SHA512:
-  metadata.gz: eabb749828cb2247faac7382e621f31283e1f450a04a0517de3412a16276fe348b86a3fd4b3e8479cd6559aaf939265d3225219dd8fe5dad662892092c6d7f9a
-  data.tar.gz: 74b47c66dc590844949118221f9aaf2425e4da4db37c705d909224a35de0eecfe4da62807ca9522e5508a7b5f3a4c484a4cb1590c31a773529d4c611f5445e3f
+  metadata.gz: 346a26ebc18965a8a0b12f449b159c42a8caab094abea47cc1318ff4ea04ed3607d5a18d6d4013b63224c00a2b7bfea46a86811dcebf471ae536c1c299a2fe67
+  data.tar.gz: dd67b9fc88b165ddd134870fa42806207a1b19ff9a9f1319e68c2c795ba1e88f9519efd842ee1a41a40fa455a3be36142f3237aaf0bb4304da2b5b51a24f185a

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
   - ruby-head
+  - 2.2.3
   - 2.2.2
   - 2.1.5
   - 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v3.1.0
+- [issue #12](https://github.com/k-ta-yamada/tee_logger/issues/12)
+  Include and Extend support
+
 # v3.0.3
 - shared_examples_for_tee_logger_spec.rb [ae1e481](https://github.com/k-ta-yamada/tee_logger/commit/ae1e481)
 - new constant for disabling formatter [478eccb](https://github.com/k-ta-yamada/tee_logger/commit/478eccb)

data/lib/tee_logger.rb

@@ -11,6 +11,32 @@ module TeeLogger
     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

data/lib/tee_logger/constants.rb

@@ -13,7 +13,7 @@ module TeeLogger
 
   # using private method #parse_to_hash
   ParsedOption = Struct.new(:logdev_name, :indent_level)
-  # LOGDEV_NAMES not incuded error
+  # LOGDEV_NAMES not included error
   class IncorrectNameError < StandardError; end
   # option's class is not allow
   class IncorrectOptionError < StandardError; end

data/lib/tee_logger/utils.rb

@@ -4,6 +4,8 @@ module TeeLogger
   module Utils
     module_function
 
+    # @param options [Array]
+    # @return [ParsedOption]
     def extract_options(options)
       options.each_with_object(ParsedOption.new(nil, 0)) do |val, obj|
         case val
@@ -14,6 +16,10 @@ module TeeLogger
       end
     end
 
+    # @params progname
+    # @params block
+    # @params indent_level [Fixnum]
+    # @return [Array]
     def indentation(progname, block, indent_level)
       if block.nil?
         progname = "#{' ' * indent_level}#{formatting(progname)}"
@@ -24,6 +30,8 @@ module TeeLogger
       [progname, block]
     end
 
+    # @params val
+    # @return [String]
     def formatting(val)
       case val
       when Symbol then ":#{val}"
@@ -32,25 +40,33 @@ module TeeLogger
       end
     end
 
+    # @params val [Symbol]
+    # @return [Symbol]
     def name_reverse(val)
       correct_name?(val)
       LOGDEV_REVERSE[val]
     end
 
+    # @params name [Symbol]
+    # @return [true]
     def correct_name?(name)
       LOGDEV_NAMES.include?(name) ? true : incorrect_name_error(name)
     end
 
+    # @params name [Symbol]
     def incorrect_name_error(name)
       fail IncorrectNameError,
            "logdev_name is :console or :logfile. logdev_name=[:#{name}]"
     end
 
+    # @params name [Symbol]
     def incorrect_option_error(val)
       fail IncorrectOptionError,
            "option params is Symbol or Fixnum. class=[#{val.class}]"
     end
 
+    # @params logdev_name [Symbol]
+    # @return [Logger]
     def logdev_instance(logdev_name)
       instance_variable_get("@#{logdev_name}")
     end

data/lib/tee_logger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tee_logger
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - k-ta-yamada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: logging to file and standard output.