spawning-logger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1c55f2d38055862dc3b2b585be3e1fc1f6e56a5
+  data.tar.gz: 12c9036eb7d86661e95db59efaf8fd69b92f4fd2
+SHA512:
+  metadata.gz: caf4a49ed5b233f8d8d8c38407c603008d8d874872402d96540ac0ce85c78d271ba403978839db43130b34be42e44e8ad4929e192a98899da12a6b224e20f4f3
+  data.tar.gz: 39aa7f7765c05342b43b6afa53f4618dabb0051cc7428a8cbc5eee2baf7b2f89b3b8abb4a6ab3ee53b1bda93de26588da067241b7277a254972e5b08e20c05c3

data/.gitignore

@@ -0,0 +1,40 @@
+# SimpleCov
+test/coverage
+
+# Bundler
+Gemfile.lock
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.simplecov

@@ -0,0 +1,13 @@
+SimpleCov.start do
+  coverage_dir "test/coverage"
+  command_name "tests"
+
+  use_merging true
+  merge_timeout 3600
+
+  add_filter "test/"
+
+  add_group "All", "/lib/*.rb"
+
+  formatter SimpleCov::Formatter::HTMLFormatter
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+guard :minitest do
+
+  # run all tests when lib main module file changes
+  watch(%r{^lib/configuration.rb$}) { "test" }
+
+  # run accompanying test for single source file if it changes
+  watch(%r{^lib/(.*)\.rb$}) {|m| "test/#{m[1]}_test.rb" }
+
+  # run test whenever it changes
+  watch(%r{^test/(.*)\/?(.*)?_test\.rb$})
+
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Markus Seeger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+spawning_logger
+===============
+
+A logger that is able to spawn sub-loggers

data/Rakefile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/lib/spawning_logger.rb

@@ -0,0 +1,128 @@
+# A Logger that is able to spawn sub-loggers.
+#
+# Sub-loggers are created with a different filename.
+# Also supports a preset logfile subdirectory in case you create many subloggers.
+#
+# Only the constructor is modified and the spawning factory method added,
+# everything else is delegated to the ruby stdlib ::Logger class.
+#
+# ## Examples:
+#
+# ### 1) usage same as ::Logger
+#
+# ```ruby
+# logger = SpawningLogger.new('server.log')
+#
+# # => creates ./server.log
+# ```
+#
+# ### 2) spawn child logger
+#
+# ```ruby
+# logger = SpawningLogger.new('server.log')
+# child_logger = logger.spawn('worker1')
+#
+# # => creates ./server_worker1.log
+# # => returns a ::Logger instance logging into this file
+# ```
+#
+# ### 3) spawn child logger with prefix
+#
+# ```ruby
+# SpawningLogger.configure do |config|
+#   config.child_prefix = 'worker'
+# end
+#
+# logger = SpawningLogger.new('server.log')
+# child_logger = logger.spawn('1')
+#
+# # => creates ./server_worker_1.log
+# # => returns a ::Logger instance logging into this file
+# ```
+#
+# ### 4) create all logfiles inside subdir, injected into original path
+#
+# ```ruby
+# SpawningLogger.configure do |config|
+#   config.subdir = 'production'
+# end
+#
+# logger = SpawningLogger.new('log/server.log')
+# child_logger = logger.spawn('1')
+#
+# # => creates ./log/production/server.log
+# # => creates ./log/production/server_worker_1.log
+# ```
+
+require 'logger'
+
+class SpawningLogger < ::Logger
+
+  class ArgumentError < ::ArgumentError; end
+
+  # cattr_accessor :child_prefix
+  # cattr_accessor :subdir
+
+  @@child_prefix = nil
+  @@subdir = nil
+
+  def self.configure
+    yield self
+  end
+
+  def self.child_prefix=(value)
+    @@child_prefix = value
+  end
+
+  def self.subdir=(value)
+    @@subdir = value
+  end
+
+  # creates the logfile inside a subdir (optional).
+  def initialize(file_path, subdir = nil)
+    file_path = File.expand_path(file_path)
+
+    @log_dir = File.dirname(file_path)
+    @log_dir = File.join(@log_dir, @@subdir) unless @@subdir.nil?
+    FileUtils.mkdir_p(@log_dir) if !Dir.exist?(@log_dir)
+
+    @file_name = File.basename(file_path)
+    @child_loggers = {} # these are the special sub-loggers
+
+    super(File.join(@log_dir, @file_name)) # this creates the main logger
+  end
+
+  # creates a sub logger with filename <orig_file>_<child_prefix>_<child_name>.log
+  # example: see class docstring or README.md
+  def spawn(child_name)
+    raise ArgumentError.new("empty child_name") if child_name.to_s.empty?
+
+    @child_loggers[child_name] ||= create_child_logger(child_name)
+    @child_loggers[child_name]
+  end
+
+  protected
+
+    # creates a logger for child_name. uses child_name and
+    # child_prefix (if configured) for construction of the new logger's filename.
+    #
+    # example:
+    #   origfile.log => origfile_childprefix_childname.log
+    #
+    def create_child_logger(child_name)
+      # remove extension
+      parent_filename = File.basename(@file_name, File.extname(@file_name))
+
+      # add child_prefix + child_id
+      file_basename = [
+        parent_filename, @@child_prefix, child_name
+      ].compact.join('_')
+
+      # add extension
+      file_name = file_basename + File.extname(@file_name)
+
+      file_path = File.join(@log_dir, file_name)
+      ::Logger.new(file_path)
+    end
+
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+require 'logger'
+
+class SpawningLogger < ::Logger
+  VERSION = "0.0.1"
+end

data/spawning_logger.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "spawning-logger"
+  gem.version       = SpawningLogger::VERSION
+  gem.authors       = ["Markus Seeger"]
+  gem.email         = ["mail@codegourmet.de"]
+  gem.description   = "A logger that can spawn other loggers"
+  gem.summary       = ""
+  gem.homepage      = "https://github.com/codegourmet/spawning_logger"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake",  "~> 10.1"
+  gem.add_development_dependency "guard-minitest"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "minitest-reporters"
+  gem.add_development_dependency "simplecov"
+end

data/test/spawning_logger_test.rb

@@ -0,0 +1,81 @@
+require_relative "./test_helper"
+require_relative "../lib/spawning_logger"
+
+class SpawningLoggerTest < MiniTest::Test
+
+  def setup
+    @log_dir = Dir.mktmpdir('spawning_logger_test')
+    @logfile_name = 'test_file.log'
+    @logfile_path = File.join(@log_dir, @logfile_name)
+    @child_id = 'childid'
+
+    reset_logger_config
+  end
+
+  def teardown
+    FileUtils.remove_entry(@log_dir)
+    reset_logger_config
+  end
+
+  def test_creates_subdir_if_doesnt_exist
+    subdir = 'development'
+
+    SpawningLogger.configure do |config|
+      config.subdir = subdir
+    end
+    SpawningLogger.new(@logfile_path)
+
+    expected_dir = File.join(@log_dir, subdir)
+    expected_file = File.join(expected_dir, @logfile_name)
+
+    assert File.exist?(expected_file)
+    assert Dir.exist?(expected_dir)
+  end
+
+  def test_spawn_interface_yields_logger_for_child_id
+    assert_creates_log_file('test_file_childid.log')
+  end
+
+  def test_child_logger_filename_includes_child_prefix
+    SpawningLogger.configure do |config|
+      config.child_prefix = 'childprefix'
+    end
+
+    assert_creates_log_file('test_file_childprefix_childid.log')
+  end
+
+  def test_raises_if_child_id_is_nil_or_empty
+    logger = SpawningLogger.new(@logfile_path)
+
+    assert_raises SpawningLogger::ArgumentError do
+      logger.spawn(nil)
+    end
+  end
+
+  def test_creates_child_logger_only_once
+    skip "NYI"
+    # TODO
+    #   expect ::Logger.new(child_path) to be called only once
+    #   spawn child logger 2x
+  end
+
+  protected
+
+    def assert_creates_log_file(file_name)
+      logger = SpawningLogger.new(@logfile_path)
+      child_logger = logger.spawn(@child_id)
+
+      assert_kind_of(::Logger, child_logger)
+
+      expected_path = File.join(@log_dir, file_name)
+      assert File.exist?(expected_path)
+    end
+
+    def reset_logger_config
+      SpawningLogger.configure do |config|
+        config.child_prefix = nil
+        config.subdir = nil
+      end
+    end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov' # has to be at top, will execute ../.simplecov
+
+require 'spawning_logger'
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+if ENV["RM_INFO"] || ENV["TEAMCITY_VERSION"]
+  MiniTest::Reporters.use! MiniTest::Reporters::RubyMineReporter.new
+else
+  MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: spawning-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Markus Seeger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A logger that can spawn other loggers
+email:
+- mail@codegourmet.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .simplecov
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/spawning_logger.rb
+- lib/version.rb
+- spawning_logger.gemspec
+- test/spawning_logger_test.rb
+- test/test_helper.rb
+homepage: https://github.com/codegourmet/spawning_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- test/spawning_logger_test.rb
+- test/test_helper.rb