dedicated_logger 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24f5acbfe3a2a1c8d5098ac2bca5cb3948ba63ef
-  data.tar.gz: a4b95d9ef7068fd492c2291c7b3c91a877ade2d0
+  metadata.gz: fb97931c134fb06563ce55d12adc128231daea07
+  data.tar.gz: d2660f9c14f370d1585a7d216ff4df6d68ae9749
 SHA512:
-  metadata.gz: e3bef859f0910ff3f90c8106bb0a677e003c34cbc1dd5dd9718166a756183b88f1bc4dffe5d8028e739fca4cf33c39a5da5f8e32839850fa807dadb99b5ccd94
-  data.tar.gz: 847a71cbdc3bdf1cf016583b7e3349212e2b9651b64f7a1bfd2099ae7a47823a234ec76dca1f5c2ce47a82d3d9819542948ebb48069a870f88c08601b21b9bee
+  metadata.gz: 338b104449fd44e1971fb1e7da758fc63b5073c6da3d8fe3374d185f8d7869c84e7eecfc49f7a6adba838c2eeca85abf3b6668d9915cbdcf9b6247bbd3e66175
+  data.tar.gz: ad48f6fc7c59c7543dafcc3a0645d12a318bb7cdb6e1f433b7e9b03a1bc79093d0468cb364d7c686c142b2338d6edd4464f3135f5c214a6b1db088eb49b082da

data/.gitignore

@@ -0,0 +1,2 @@
+/log/*.log
+*.swp

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/README.md

@@ -6,7 +6,11 @@ Used for any ruby class, perhaps running as background tasks, in desperate need
 Installation
 -----------
 
-    TODO
+    gem install dedicated_logger
+    
+or by including this line in your Gemfile
+
+    gem "dedicated_logger", :git => "git://github.com/tskorupa/dedicated_logger.git"
 
 Usage
 -----
@@ -14,6 +18,7 @@ Usage
     require 'dedicated_logger'
     
     class Foo
+      include DedicatedLogger
       
       def self.bar
         logger.info "info from class method"
@@ -29,19 +34,10 @@ Usage
         logger.fatal "fatal"
       end
       
-      private
-      
-      def logger
-        self.class.logger
-      end
-      
-      def self.logger
-        @logger ||= DedicatedLogger.new(self, "test")
-      end
     end
 
 TODO
 ================
 
-* Add tests
-* convert to acts_as_* module
+* write docs on how to use acts_as_* module
+* show how to specify a custom logger file and/or filepath

data/dedicated_logger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'dedicated_logger'
-  s.version       = '0.0.3'
+  s.version       = '0.0.4'
   s.description   = %q{Output formatter for the ruby Logger class}
   s.summary       = %q{Standardize the logged output for background tasks and store it in a dedicated file}
   s.authors       = ['Tomasz Skorupa']
@@ -11,4 +11,5 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 1.9.3'
   s.add_development_dependency 'rake'
+  s.add_dependency 'activesupport'
 end

data/lib/dedicated_logger/base.rb

@@ -0,0 +1,30 @@
+require 'logger'
+require 'fileutils'
+
+module DedicatedLogger
+  class Base < Logger
+
+    def initialize logger_name, filepath, options={}
+      @logger_name = logger_name
+      filename = File.basename filepath
+      dir_path = File.dirname(File.absolute_path(filepath))
+
+      FileUtils.mkdir_p(dir_path) unless File.exists? dir_path
+
+      super File.join(dir_path, filename)
+    end
+
+    def format_message severity, timestamp, progname, msg
+      msg = "#{timestamp.strftime("%Y-%m-%d %H:%M:%S")} #{@logger_name} [#{$$}] #{severity}: #{msg}\n"
+
+      if %w(WARN ERROR FATAL).include?(severity.to_s)
+        STDERR.puts(msg)
+      else
+        STDOUT.puts(msg)
+      end
+
+      msg
+    end
+
+  end
+end

data/lib/dedicated_logger.rb

@@ -1,27 +1,26 @@
-require 'logger'
-require 'fileutils'
+require 'active_support/concern'
+require 'active_support/inflector'
+require 'dedicated_logger/base'
 
-class DedicatedLogger < Logger
+module DedicatedLogger
+  extend ActiveSupport::Concern
 
-  def initialize logger_name, filename, options={}
-    @logger_name = logger_name
-
-    log_dir = File.absolute_path(options[:log_dir] || "log")
-    FileUtils.mkdir_p(log_dir) unless File.exists? log_dir
-
-    super File.join(log_dir, "#{filename}.log")
+  included do
+    def logger
+      self.class.logger
+    end
   end
 
-  def format_message severity, timestamp, progname, msg
-    msg = "#{timestamp.strftime("%Y-%m-%d %H:%M:%S")} #{@logger_name} [#{$$}] #{severity}: #{msg}\n"
+  module ClassMethods
+    def acts_as_dedicated_logger options={}
+      name = options[:name] || self.name.to_s.underscore
+      filepath = options[:filepath] || File.join("log", "#{name}.log")
+      @logger = DedicatedLogger::Base.new(name, filepath)
+    end
 
-    if %w(WARN ERROR FATAL).include?(severity.to_s)
-      STDERR.puts(msg)
-    else
-      STDOUT.puts(msg)
+    def logger
+      @logger || acts_as_dedicated_logger
     end
 
-    msg
   end
-
 end

data/test/test_base.rb

@@ -0,0 +1,14 @@
+require 'minitest/autorun'
+require 'dedicated_logger/base'
+
+class BaseTest < Minitest::Test
+
+  def setup
+    @logger = DedicatedLogger::Base.new("TEST", "test/log/test.log")
+  end
+
+  def test_instantiation
+    assert_kind_of DedicatedLogger::Base, @logger
+  end
+
+end

data/test/test_dedicated_logger.rb

@@ -1,14 +1,45 @@
 require 'minitest/autorun'
 require 'dedicated_logger'
 
-class DedicatedLoggerTest < MiniTest::Unit::TestCase
+class DedicatedLoggerTest < Minitest::Test
 
-  def setup
-    @logger = DedicatedLogger.new("TEST", "test")
+  def test_dummy_instance_does_not_define_logger_method
+    assert_raises(NoMethodError) do
+      dummy_class.new.logger
+    end
   end
 
-  def test_instantiation
-    assert_kind_of DedicatedLogger, @logger
+  def test_dummy_class_does_not_define_logger_method
+    assert_raises(NoMethodError) do
+      dummy_class.logger
+    end
+  end
+
+  def test_dummy_instance_with_module_defines_logger_method
+    assert_kind_of DedicatedLogger::Base, dummy_class_with_module.new.logger
+  end
+
+  def test_dummy_class_with_module_defines_logger_method
+    assert_kind_of DedicatedLogger::Base, dummy_class_with_module.logger
+  end
+
+  private
+
+  def dummy_class
+    Class.new do
+      def self.name
+        "Dummy"
+      end
+    end
+  end
+
+  def dummy_class_with_module
+    Class.new do
+      include DedicatedLogger
+      def self.name
+        "DummyWithModule"
+      end
+    end
   end
 
 end

metadata

@@ -1,27 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: dedicated_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tomasz Skorupa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Output formatter for the ruby Logger class
@@ -30,11 +44,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".ruby-version"
 - LICENSE
 - README.md
 - Rakefile
 - dedicated_logger.gemspec
 - lib/dedicated_logger.rb
+- lib/dedicated_logger/base.rb
+- test/test_base.rb
 - test/test_dedicated_logger.rb
 homepage: 
 licenses: []
@@ -45,17 +63,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Standardize the logged output for background tasks and store it in a dedicated