tee_logger 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68e6895e0af9a49ee888c733815c09316e5dd412
-  data.tar.gz: 9c7b5ce69e3c445393f38acd60de08fca85f7549
+  metadata.gz: be09165c03c07b79e29ef887ca1d88c9ef85afee
+  data.tar.gz: 8d12405174d93f5d051c8a58a72daec3c46abf34
 SHA512:
-  metadata.gz: b23d0cb8cfa8caa9e426038b83b4d06097822a3a80715fc14c5662bfc7920cc35f80e567802649473f531ea8b2dc4d99ecd03a937d5bf257b942ccb5e7132f11
-  data.tar.gz: 0a96a4049b5d6232b062c1830c222b845f364caf405c6319c18caaa98a6f81dd50bffc5d76fc877ff49dcbe221db7f1a57b26611bc4999ecbce0ac408ca99700
+  metadata.gz: 4dda6fea4467d09cab1402eba705fe2cbb6666074f1a7f1e0f00858c936995f08fd8b802703ba1014fba9e3dc6bfbe3b8631bd4c51255013eab4858eeb0e197c
+  data.tar.gz: 79b20992b4be5ae2f986b414601040e29e888f38955ebfa5daa6d683fb1f072c2064232a4b3d432e18109346c5d1ccddafa89f9e7e349cc1cd2bc6b0f3a0c60b

data/README.md

@@ -1,6 +1,16 @@
+
+Sorry, I changed Usage.
+
+- [rubygems](https://rubygems.org/gems/tee_logger)
+- [github](https://github.com/k-ta-yamada/tee_logger)
+
 # TeeLogger
 
-logging to logfile and standard output
+logging to logfile and standard output.
+
+Characteristic
+- simple: use standard lib only.
+- like Logger: see usage.
 
 ## Installation
 
@@ -22,68 +32,35 @@ Or install it yourself as:
 
 ```ruby
 require 'tee_logger'
-TeeLogger.setup
-
-TeeLogger.debug 'hello' # => output console and logfile
-TeeLogger.info 'hello' # => output console and logfile
-TeeLogger.warn 'hello' # => output console and logfile
-TeeLogger.error 'hello' # => output console and logfile
-TeeLogger.fatal 'hello' # => output console and logfile
-
-TeeLogger.console_debug 'hello' # => output console only
-TeeLogger.console_info 'hello' # => output console only
-TeeLogger.console_warn 'hello' # => output console only
-TeeLogger.console_error 'hello' # => output console only
-TeeLogger.console_fatal 'hello' # => output console only
-
-TeeLogger.logger_debug 'hello' # => output logfile only
-TeeLogger.logger_info 'hello' # => output logfile only
-TeeLogger.logger_warn 'hello' # => output logfile only
-TeeLogger.logger_error 'hello' # => output logfile only
-TeeLogger.logger_fatal 'hello' # => output logfile only
-```
 
-and more
-- debug? # => Boolean
-- info? # => Boolean
-- warn? # => Boolean
-- error? # => Boolean
-- fatal? # => Boolean
-- console_debug? # => Boolean
-- console_info? # => Boolean
-- console_warn? # => Boolean
-- console_error? # => Boolean
-- console_fatal? # => Boolean
-- logger_debug? # => Boolean
-- logger_info? # => Boolean
-- logger_warn? # => Boolean
-- logger_error? # => Boolean
-- logger_fatal? # => Boolean
-
-## define logfile name
-
-default logfile is `./tee_logger.log`.
-
-you can change logfile.
+# Logger.new like options
+tl = TeeLogger.new('./tee_logger.log', 5, 1_024)
 
-```ruby
-require 'tee_logger'
-TeeLogger.setup do |tee_logger|
-  tee_logger.logdev = './hello_world.log'
-  tee_logger.shift_age = 5
-  tee_logger.shift_size = 1_024
-end
-
-TeeLogger.info 'hello' # => output console and logfile('./hello_world.log')
-TeeLogger.console_info 'hello' # => output console only
-TeeLogger.logger_info 'hello' # => output logfile only('./hello_world.log')
-```
+tl.debug(:progname) { 'hello world' }
+tl.progname = 'App'
+tl.debug('hello tee_logger')
+
+# console only
+tl.console.info('console only')
 
-setup item is Logger.new arguments.
-- logdev
-- shift_age
-- shift_size
+# logfile only
+tl.logger.info('logger only')
+```
 
+# TODO feature
+```
+# disable and enable console output
+tl.disable(:console)
+tl.info 'this message is logfile only'
+tl.enable(:console)
+tl.info 'this message is logfile and console'
+
+# disable and enable logfile output
+tl.disable(:logger)
+tl.info 'this message is consle only'
+tl.enable(:logger)
+tl.info 'this message is logfile and console'
+```
 
 ## Development
 
@@ -93,7 +70,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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.
+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

data/lib/tee_logger/base.rb

@@ -1,11 +1,7 @@
 require 'logger'
 
-# main
+# namespace
 module TeeLogger
-  # TODO: defined by setup method, etc ...
-  DEFAULT_FILE = './tee_logger.log'
-  LOGGING_METHODS = %i(debug info warn error fatal).freeze
-
   # base class
   class Base
     attr_reader :logger, :console
@@ -15,18 +11,43 @@ module TeeLogger
       @console = Logger.new(STDOUT)
     end
 
+    # logging methods.
     LOGGING_METHODS.each do |method_name|
-      define_method(method_name) do |progname = nil, &block|
-        @logger.send(method_name, progname, &block)
-        @console.send(method_name, progname, &block)
+      define_method(name) do |progname = nil, &block|
+        @logger.send(name, progname, &block)
+        @console.send(name, progname, &block)
       end
+    end
 
-      define_method("#{method_name}?") do
-        @logger.send("#{method_name}?")
-        @console.send("#{method_name}?")
+    # check logging level methods.
+    LOGGING_METHODS.map { |v| "#{v}?" }
+      define_method(name) do
+        @logger.send(name)
+        @console.send(name)
       end
     end
 
+    # TODO: Implement
+    def disable(target)
+      # undef_method, remove_method ....
+    end
+
+    # TODO: Implement
+    def enable(target)
+      # undef_method, remove_method ....
+    end
+
+    def progname
+      # TODO: which?
+      # @logger.progname
+      @console.progname
+    end
+
+    def progname=(name = nil)
+      @logger.progname  = name
+      @console.progname = name
+    end
+
     def close
       @logger.close
       # @console.close

data/lib/tee_logger/constants.rb

@@ -0,0 +1,7 @@
+require 'logger'
+
+# namespace
+module TeeLogger
+  DEFAULT_FILE = './tee_logger.log'
+  LOGGING_METHODS = %i(debug info warn error fatal).freeze
+end

data/lib/tee_logger/version.rb

@@ -1,4 +1,4 @@
-# main
+# namespace
 module TeeLogger
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

data/lib/tee_logger.rb

@@ -1,71 +1,44 @@
 require 'tee_logger/version'
+require 'tee_logger/constants'
 require 'tee_logger/base'
 
-# main
-module TeeLogger
-  @logdev     = DEFAULT_FILE
-  @shift_age  = 0
-  @shift_size = 1_048_576
-
-  # @ref https://github.com/railsconfig/config/blob/master/lib/config.rb#L18
-  @_run_once = false
-  def self.setup
-    return base_logger if @_run_once
-    define_singleton_methods_for_setup
+require 'forwardable'
 
-    yield(self) if block_given?
-    @_run_once = true
-
-    define_singleton_methods_for_logging
-    define_singleton_methods_for_logging_with_prefix
-    base_logger
+# namespace
+module TeeLogger
+  # shortcut for TeeLogger::TeeLogger.new
+  def self.new(logdev = DEFAULT_FILE, shift_age = 0, shift_size = 1_048_576)
+    TeeLogger.new(logdev, shift_age, shift_size)
   end
 
-  class << self
-    private
+  class TeeLogger
+    extend Forwardable
 
-    def define_singleton_methods_for_setup
-      %i(logdev shift_age shift_size).each do |name|
-        define_singleton_method(name) do
-          instance_variable_get("@#{name}".to_sym)
-        end
-        # private_class_method name
+    attr_reader :logger, :console
 
-        define_singleton_method("#{name}=") do |arg|
-          instance_variable_set("@#{name}".to_sym, arg)
-        end
-        # private_class_method "#{name}=".to_sym
-      end
+    def initialize(logdev = DEFAULT_FILE, shift_age = 0, shift_size = 1_048_576)
+      @base_logger = Base.new(logdev, shift_age, shift_size)
+      @logger  = @base_logger.logger
+      @console = @base_logger.console
     end
 
-    def base_logger
-      @base_logger ||= Base.new(logdev, shift_age, shift_size)
-    end
+    # logging methods.
+    def_delegators :@base_logger, *LOGGING_METHODS
 
-    def define_singleton_methods_for_logging
-      LOGGING_METHODS.each do |name|
-        define_singleton_method(name) do |progname = nil, &block|
-          base_logger.send(name, progname, &block)
-        end
+    # check logging level methods.
+    def_delegators :@base_logger, *LOGGING_METHODS.map { |v| "#{v}?" }
 
-        define_singleton_method("#{name}?") do
-          base_logger.send("#{name}?")
-        end
-      end
-    end
+    # others.
+    def_delegators :@base_logger, :progname, :progname=
 
-    def define_singleton_methods_for_logging_with_prefix
-      %i(logger console).each do |pre|
-        LOGGING_METHODS.each do |name|
-          define_singleton_method("#{pre}_#{name}") do |progname = nil, &block|
-            base_logger.send(pre).send(name, progname, &block)
-          end
+    # TODO: Implement
+    # def_delegators :@base_logger, :datetime_format, :datetime_format=
+    # def_delegators :@base_logger, :formatter, :formatter=
 
-          define_singleton_method("#{pre}_#{name}?") do
-            base_logger.send(pre).send("#{name}?")
-          end
-        end
-      end
-    end
+    # TODO: Implement
+    # def_delegator :@base_logger, :close
+    # def_delegators :@base_logger, :level, :sev_threshold
+    # def_delegators :@base_logger, :add, :log
+    # def_delegators :@base_logger, :unknown, :unknown?
   end
 end

data/tee_logger.gemspec

@@ -4,24 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tee_logger/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "tee_logger"
+  spec.name          = 'tee_logger'
   spec.version       = TeeLogger::VERSION
-  spec.authors       = ["k-ta-yamada"]
-  spec.email         = ["key.luvless@gmail.com"]
+  spec.authors       = ['k-ta-yamada']
+  spec.email         = ['key.luvless@gmail.com']
 
-  spec.summary       = %q{logging to file and standard output}
-  spec.description   = %q{logging to file and standard output}
+  spec.summary       = 'logging to file and standard output'
+  spec.description   = 'logging to file and standard output'
   spec.homepage      = 'https://github.com/k-ta-yamada/tee_logger'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
 
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-doc'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tee_logger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - k-ta-yamada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,6 +126,7 @@ files:
 - bin/setup
 - lib/tee_logger.rb
 - lib/tee_logger/base.rb
+- lib/tee_logger/constants.rb
 - lib/tee_logger/version.rb
 - tee_logger.gemspec
 homepage: https://github.com/k-ta-yamada/tee_logger