daily_logger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ae66ffd5b9886b69f59226a9adea89dd3f6b7b9
+  data.tar.gz: 69aa1d917eee5b8d8ab5d66ab741f71eedf548ed
+SHA512:
+  metadata.gz: fe9e39ee297d205696f91ca6be3c50b9047883743c15270c0c644381bc1b718d2e87a984220cc1c8b8985aa991d9e67ac31b92110cd4b7805f0993375b1d605a
+  data.tar.gz: 6b3980e648aa0873335633002d9b92eed6fbc7ac4aaef5ad6b2f6c5e7ba495ed1fb7dc1aa4f83bd5e8ee2e89fd9ba1b1748bd052872253e49741f615f5d82d02

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+example/log
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: 1.9.3

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in file_alternative_logger.gemspec
+gemspec
+
+group :test do
+  gem 'bundler'
+  gem 'rake'
+  gem 'coveralls', require: false
+  gem 'rspec'
+  gem 'timecop'
+  gem 'parallel'
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 SpringMT
+
+MIT License
+
+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,38 @@
+# DailyLogger
+[![Build Status](https://travis-ci.org/SpringMT/daily_logger.png)](https://travis-ci.org/SpringMT/daily_logger)
+[![Coverage Status](https://coveralls.io/repos/SpringMT/daily_logger/badge.png)](https://coveralls.io/r/SpringMT/daily_logger)
+
+* Yet Another Logger for ruby
+* daily lotate logger
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'daily_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install daily_logger
+
+## Usage
+
+```
+require 'daily_logger'
+logger = DailyLogger.new('/your/directory/filename')
+logger.info('info------')
+# output /your/directory/filename.info.log.YYYYMMDD
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+
+task :test do
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:test) do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+  end
+end
+

data/daily_logger.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "daily_logger"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Spring_MT"]
+  gem.email         = ["today.is.sky.blue.sky@gmail.com"]
+  gem.description   = %q{Write a gem description}
+  gem.summary       = %q{daily lotate logger}
+  gem.homepage      = "https://github.com/SpringMT/daily_logger"
+
+  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"]
+end
+

data/example/lotate_process_safe_check.rb

@@ -0,0 +1,33 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'daily_logger'
+require 'parallel'
+require 'timecop'
+require 'test/unit'
+
+Timecop.scale(24 * 60 * 60)
+
+$proc_num = 2
+$execute_num = 10000
+
+logger = DailyLogger.new("example/log/lotate_test_process")
+Parallel.map(['a', 'b'], :in_processes => $proc_num) do |letter|
+  $execute_num.times do
+  logger.info letter * 5000
+  end
+end
+
+$total_num = `wc -l example/log/lotate_test_process*`.split("\n").map(&:strip).grep(/\stotal\z/).first.split(' ').first.to_i
+p "Expected total line num #{$execute_num * $proc_num}"
+p "Actually total line num #{$total_num}"
+
+
+class DailyLoggerTC < Test::Unit::TestCase
+  def test_logger
+    assert_equal($execute_num * $proc_num, $total_num)
+  end
+  def teardown
+    p 'rm -rf example/log/*'
+  end
+end
+

data/example/lotate_thread_safe_check.rb

@@ -0,0 +1,33 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'daily_logger'
+require 'parallel'
+require 'timecop'
+require 'test/unit'
+
+Timecop.scale(24 * 60 * 60)
+
+$proc_num = 2
+$execute_num = 10000
+
+logger = DailyLogger.new("example/log/lotate_test_thread")
+Parallel.map(['a', 'b'], :in_threads => $proc_num) do |letter|
+  $execute_num.times do
+  logger.info letter * 5000
+  end
+end
+
+$total_num = `wc -l example/log/lotate_test_thread*`.split("\n").map(&:strip).grep(/\stotal\z/).first.split(' ').first.to_i
+p "Expected total line num #{$execute_num * $proc_num}"
+p "Actually total line num #{$total_num}"
+
+class DailyLoggerTC < Test::Unit::TestCase
+  def test_logger
+    assert_equal($execute_num * $proc_num, $total_num)
+  end
+  def teardown
+    p 'rm -rf example/log/*'
+  end
+end
+
+

data/example/thread_safe_check.rb

@@ -0,0 +1,14 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'daily_logger'
+require 'parallel'
+
+logger = DailyLogger.new("example/log/test")
+Parallel.map(['a', 'b'], :in_threads => 2) do |letter|
+  3000.times do
+  logger.info letter * 5000
+  end
+end
+
+# egrep -e 'ab' -e 'ba' example/log/test.log
+# これはまざらない

data/lib/daily_logger/adapter/file.rb

@@ -0,0 +1,82 @@
+# writeするときに逐次open closeする
+require 'monitor'
+
+class DailyLogger
+  class Adapter
+    class File
+
+      class LogFileMutex
+        include MonitorMixin
+      end
+
+      def initialize(level, path)
+        @path = path
+        @today = Time.now.strftime "%Y%m%d"
+        @timestamp_path = "#{@path}.#{level}.log.#{@today}"
+        # DIRの判定はここでするか?
+        @mutex = LogFileMutex.new
+        @log = open_logfile(@timestamp_path)
+      end
+
+      def write(level, msg)
+        begin
+          @mutex.synchronize do
+            if @log.nil? || !same_date?
+              begin
+                @today = Time.now.strftime "%Y%m%d"
+                @timestamp_path = "#{@path}.#{level}.log.#{@today}"
+                @log.close rescue nil
+                @log = create_logfile(@timestamp_path)
+              rescue
+                warn("log shifting failed. #{$!}")
+              end
+            end
+
+            begin
+              @log.write msg
+            rescue
+              warn("log writing failed. #{$!}")
+            end
+          end
+        rescue Exception => ignored
+          warn("log writing failed. #{ignored}")
+        end
+      end
+
+      def close
+        if !@log.nil? && !@log.closed?
+          @log.close
+        end
+      end
+
+      private
+      # ファイルがない場合はnilを返す
+      def open_logfile(filename)
+        return nil unless ::FileTest.exist? filename
+        # ファイルは作らない
+        f = ::File.open filename, (::File::WRONLY | ::File::APPEND)
+        #f.binmode
+        f.sync = true
+        f
+      end
+
+      def create_logfile(filename)
+        begin
+          f = ::File.open filename, (::File::WRONLY | ::File::APPEND | ::File::CREAT | ::File::EXCL)
+          #f.binmode
+          f.sync = true
+        rescue Errno::EEXIST
+          f = open_logfile(filename)
+        end
+        f
+      end
+
+      def same_date?
+        @today == Time.now.strftime("%Y%m%d")
+      end
+
+    end
+  end
+end
+
+

data/lib/daily_logger/adapter.rb

@@ -0,0 +1,46 @@
+require File.expand_path('../adapter/file', __FILE__)
+
+class DailyLogger
+  class Adapter
+
+    def initialize(level, name)
+      @log_adapters = set_adaptor(level, name)
+    end
+
+    def write(level, msg)
+      @log_adapters.each do |adapter|
+        adapter.write(level, msg)
+      end
+    end
+
+    def close
+      @log_adapters.each do |adapter|
+        adapter.close
+      end
+    end
+
+    private
+    def config
+      config = {
+        debug:   [DailyLogger::Adapter::File],
+        info:    [DailyLogger::Adapter::File],
+        warn:    [DailyLogger::Adapter::File],
+        error:   [DailyLogger::Adapter::File],
+        fatal:   [DailyLogger::Adapter::File],
+        unknown: [DailyLogger::Adapter::File],
+      }
+      config
+    end
+
+    def set_adaptor(level, name)
+      adapters = Array.new
+      config[level].each do |adapter|
+         adapters.push adapter.new(level, name)
+      end
+      adapters
+    end
+
+  end
+end
+
+

data/lib/daily_logger/formatter.rb

@@ -0,0 +1,58 @@
+class DailyLogger
+# Default formatter for log messages
+  class Formatter
+    Format = "[%s]\t%s\n"
+
+    attr_accessor :datetime_format
+
+    def initialize
+      @datetime_format = nil
+    end
+
+    def call(time, msg, block_msg)
+      Format % [format_datetime(time), make_msg(msg, block_msg)]
+    end
+
+    private
+    def format_datetime(time)
+      if @datetime_format.nil?
+        time.strftime "%Y/%m/%d %H:%M:%S"
+      else
+        time.strftime @datetime_format
+      end
+    end
+
+    def make_msg(*args)
+      msgs = Array.new
+      args.each do |msg|
+        str = msg2str msg
+        next if str.nil?
+        msgs.push str
+      end
+      msgs.join "\t"
+    end
+
+    def msg2str(msg)
+      return nil if msg.nil?
+      return msg if msg.kind_of? ::String
+      all_msg = []
+      msg.each do |m|
+        case m
+        when ::String
+          all_msg << m
+        when ::Array
+          all_msg << m
+        when ::Exception
+          short_backtrace = m.backtrace[0,4]
+          all_msg << [m.message, short_backtrace]
+        else
+          all_msg << m.inspect
+        end
+      end
+      all_msg.flatten
+    end
+  end
+
+end
+
+

data/lib/daily_logger.rb

@@ -0,0 +1,134 @@
+require File.expand_path('daily_logger/formatter', __dir__)
+require File.expand_path('daily_logger/adapter', __dir__)
+require File.expand_path('daily_logger/adapter/file', __dir__)
+
+class DailyLogger
+
+  # Logging severity.
+  module Severity
+    # Low-level information, mostly for developers
+    DEBUG = 0
+    # generic, useful information about system operation
+    INFO = 1
+    # a warning
+    WARN = 2
+    # a handleable error condition
+    ERROR = 3
+    # an unhandleable error that results in a program crash
+    FATAL = 4
+    # an unknown message that should always be logged
+    UNKNOWN = 5
+  end
+  include Severity
+
+  # Logging severity threshold (e.g. <tt>Logger::INFO</tt>).
+  attr_accessor :level
+  alias sev_threshold level
+  alias sev_threshold= level=
+
+  attr_accessor :formatter
+  attr_accessor :device
+
+  def initialize(name = nil)
+    @name = name || 'all'
+    @level = DEBUG
+    @default_formatter = DailyLogger::Formatter.new
+    @formatter = nil
+
+    @log_adaptor = {}
+    sev_label.each do |level|
+      @log_adaptor[level] = DailyLogger::Adapter.new(level, @name)
+    end
+  end
+
+  def append(severity, msg = nil, &block)
+    severity ||= UNKNOWN
+
+    if @log_adaptor.nil? or severity < @level
+      return true
+    end
+
+    block_msg = nil
+    if block_given?
+      block_msg = yield
+    end
+
+    log_level = sev_label[severity]
+    if @log_adaptor[log_level].nil?
+      @log_adaptor[log_level] = DailyLogger::Adapter.new(log_level, @name)
+    end
+
+    @log_adaptor[log_level].write(log_level, format_message(Time.now, msg, block_msg))
+    true
+  end
+  alias log append
+
+  def debug(*msg, &block)
+    append(DEBUG, msg, &block)
+  end
+
+  def info(*msg, &block)
+    append(INFO, msg, &block)
+  end
+
+  def warn(*msg, &block)
+    #msg = called_from.concat msg
+    append(WARN, msg, &block)
+  end
+
+  def error(*msg, &block)
+    #msg = called_from.concat msg
+    append(ERROR, msg, &block)
+  end
+
+  def fatal(*msg,  &block)
+    #msg = called_from.concat msg
+    append(FATAL, msg, &block)
+  end
+
+  def unknown(*msg, &block)
+    append(UNKNOWN, msg, &block)
+  end
+
+  # Returns +true+ iff the current severity level allows for the printing of
+  # +DEBUG+ messages.
+  def debug?; @level <= DEBUG; end
+
+  # Returns +true+ iff the current severity level allows for the printing of
+  # +INFO+ messages.
+  def info?; @level <= INFO; end
+
+  # Returns +true+ iff the current severity level allows for the printing of
+  # +WARN+ messages.
+  def warn?; @level <= WARN; end
+
+  # Returns +true+ iff the current severity level allows for the printing of
+  # +ERROR+ messages.
+  def error?; @level <= ERROR; end
+
+  # Returns +true+ iff the current severity level allows for the printing of
+  # +FATAL+ messages.
+  def fatal?; @level <= FATAL; end
+
+  def close
+    sev_label.each do |level|
+      next if @log_adaptor[level].nil?
+      @log_adaptor[level].close
+    end
+  end
+
+  private
+  def sev_label; [:debug, :info, :warn, :error, :fatal, :unknown]; end
+
+  def called_from
+    caller(1)[1] =~ /(.*?):(\d+)(:in `(.*)')?/
+    file_name, line_num, function = $1, $2, $3
+    return [file_name, line_num, function]
+  end
+
+  def format_message(datetime, msg, block_msg)
+    (@formatter || @default_formatter).call(datetime, msg, block_msg)
+  end
+
+end
+

data/spec/daily_logger_spec.rb

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/spec_helper'
+require 'daily_logger'
+
+describe DailyLogger do
+  let(:default_instance) { described_class.new }
+  let(:log_dir)   { "#{File.dirname(__FILE__)}/log" }
+  let(:today)     {Time.now.strftime "%Y%m%d"}
+  let(:now)       {Time.now.strftime "%Y/%m/%d %H:%M:%S"}
+
+  before do
+    Dir.mkdir(log_dir)
+    Timecop.freeze(Time.now)
+  end
+
+  after do
+    # サブディレクトリを階層が深い順にソートした配列を作成
+    dirlist = Dir::glob(log_dir + "**/").sort do |a,b|
+      b.split('/').size <=> a.split('/').size
+    end
+
+    dirlist.each do |d|
+      Dir::foreach(d) do |f|
+        File::delete(d+f) if ! (/\.+$/ =~ f)
+      end
+      Dir::rmdir(d)
+    end
+    Timecop.return
+  end
+
+  describe 'default' do
+    subject { default_instance }
+    it do
+      expect(default_instance.level).to eq DailyLogger::DEBUG
+    end
+  end
+
+  describe :debug do
+    context 'default' do
+      subject { DailyLogger.new("#{log_dir}/test") }
+      it do
+        subject.debug("test")
+        expect(File.read("#{log_dir}/test.debug.log.#{today}")).to eq "[#{now}]\ttest\n"
+      end
+    end
+  end
+
+
+  describe :info do
+    context 'default' do
+      subject { DailyLogger.new("#{log_dir}/test") }
+      it do
+        subject.info("test")
+        expect(File.read("#{log_dir}/test.info.log.#{today}")).to eq "[#{now}]\ttest\n"
+      end
+    end
+
+    context 'Array msg' do
+      subject { DailyLogger.new("#{log_dir}/test") }
+      it do
+        subject.info("foo", "bar", "buzz")
+        expect(File.read("#{log_dir}/test.info.log.#{today}")).to eq "[#{now}]\tfoo\tbar\tbuzz\n"
+      end
+    end
+
+    context 'Exception msg' do
+      subject { DailyLogger.new("#{log_dir}/test") }
+      it do
+        begin
+          raise "error test"
+        rescue => e
+          subject.info(e)
+        end
+        expect(File.read("#{log_dir}/test.info.log.#{today}")).to match(/\A\[#{now}\]\terror test\t/)
+      end
+    end
+  end
+
+  describe :warn do
+    context 'default' do
+      subject { DailyLogger.new("#{log_dir}/test") }
+      it do
+        subject.warn("test")
+        expect(File.read("#{log_dir}/test.warn.log.#{today}")).to eq "[#{now}]\ttest\n"
+      end
+    end
+  end
+
+  describe :error do
+    context 'default' do
+      subject { DailyLogger.new("#{log_dir}/test") }
+      it do
+        subject.error("test")
+        expect(File.read("#{log_dir}/test.error.log.#{today}")).to eq "[#{now}]\ttest\n"
+      end
+    end
+  end
+
+  describe :fatal do
+    context 'default' do
+      subject { DailyLogger.new("#{log_dir}/test") }
+      it do
+        subject.fatal("test")
+        expect(File.read("#{log_dir}/test.fatal.log.#{today}")).to eq "[#{now}]\ttest\n"
+      end
+    end
+  end
+
+  describe :unknown do
+    context 'default' do
+      subject { DailyLogger.new("#{log_dir}/test") }
+      it do
+        subject.unknown("test")
+        expect(File.read("#{log_dir}/test.unknown.log.#{today}")).to eq "[#{now}]\ttest\n"
+      end
+    end
+  end
+
+  describe 'lotate log' do
+    context 'default' do
+      subject { DailyLogger.new("#{log_dir}/test") }
+      it do
+        subject.info("test")
+        Timecop.freeze(Time.now + 24 * 60 * 60)
+        subject.info("test")
+        yesterday = (Time.now - 24 * 60 * 60).strftime "%Y%m%d"
+        one_day_ago = (Time.now - 24 * 60 * 60).strftime "%Y/%m/%d %H:%M:%S"
+        expect(File.read("#{log_dir}/test.info.log.#{yesterday}")).to eq "[#{one_day_ago}]\ttest\n"
+        expect(File.read("#{log_dir}/test.info.log.#{today}")).to eq "[#{now}]\ttest\n"
+      end
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'daily_logger'
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: daily_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Spring_MT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies: []
+description: Write a gem description
+email:
+- today.is.sky.blue.sky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- daily_logger.gemspec
+- example/lotate_process_safe_check.rb
+- example/lotate_thread_safe_check.rb
+- example/thread_safe_check.rb
+- lib/daily_logger.rb
+- lib/daily_logger/adapter.rb
+- lib/daily_logger/adapter/file.rb
+- lib/daily_logger/formatter.rb
+- spec/daily_logger_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/SpringMT/daily_logger
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: daily lotate logger
+test_files:
+- spec/daily_logger_spec.rb
+- spec/spec_helper.rb