logger-application 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b5318c8d1ae14ac5f406e3893bdb700f8793d24
+  data.tar.gz: 46662688e0c14845c0578d0802df89cd4a024eac
+SHA512:
+  metadata.gz: fe0bee8f6ae57d925e28b3aa4ef9665bcc2c832f4e5327fa89100af3e3940aa610372d2a300246283c4b882a8b04de6f5f027fac5b221237418678c2cc557ca3
+  data.tar.gz: 818a73bd5d68588ff3e3c2f052ba5d66ce0a70750ddc7f25ec85c08ec5a634db2a6b23c660de02cedca43d001d6a06a85fa5db12203e73feafd0015695e6cc07

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1
+  - ruby-head
+
+script: bundle exec rake test

data/BSDL

@@ -0,0 +1,22 @@
+Copyright (C) 2014 Hiroshi SHIBATA, All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logger-application.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.md

@@ -0,0 +1,53 @@
+# Logger::Application
+
+## Description
+
+Add logging support to your application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'logger-application'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logger-application
+
+## Usage
+
+ 1. Define your application class as a sub-class of this class.
+ 2. Override the +run+ method in your class to do many things.
+ 3. Instantiate it and invoke #start.
+
+## Example
+
+```ruby
+class FooApp < Logger::Application
+  def initialize(foo_app, application_specific, arguments)
+    super('FooApp') # Name of the application.
+  end
+
+  def run
+    ...
+    log(WARN, 'warning', 'my_method1')
+    ...
+    @log.error('my_method2') { 'Error!' }
+    ...
+  end
+end
+
+status = FooApp.new(....).start
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/hsbt/logger-application/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake'
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob('test/**/test_*.rb')
+end

data/lib/logger-application.rb

@@ -0,0 +1 @@
+require 'logger/application'

data/lib/logger/application.rb

@@ -0,0 +1,127 @@
+require 'logger'
+require "logger/application/version"
+
+module Logger
+  #
+  # == Description
+  #
+  # Logger::Application --- Add logging support to your application.
+  #
+  # == Usage
+  #
+  # 1. Define your application class as a sub-class of this class.
+  # 2. Override the +run+ method in your class to do many things.
+  # 3. Instantiate it and invoke #start.
+  #
+  # == Example
+  #
+  #   class FooApp < Logger::Application
+  #     def initialize(foo_app, application_specific, arguments)
+  #       super('FooApp') # Name of the application.
+  #     end
+  #
+  #     def run
+  #       ...
+  #       log(WARN, 'warning', 'my_method1')
+  #       ...
+  #       @log.error('my_method2') { 'Error!' }
+  #       ...
+  #     end
+  #   end
+  #
+  #   status = FooApp.new(....).start
+  #
+  class Application
+    include Logger::Severity
+
+    # Name of the application given at initialize.
+    attr_reader :appname
+
+    #
+    # :call-seq:
+    #   Logger::Application.new(appname = '')
+    #
+    # == Args
+    #
+    # +appname+:: Name of the application.
+    #
+    # == Description
+    #
+    # Create an instance.  Log device is +STDERR+ by default.  This can be
+    # changed with #set_log.
+    #
+    def initialize(appname = nil)
+      @appname = appname
+      @log = Logger.new(STDERR)
+      @log.progname = @appname
+      @level = @log.level
+    end
+
+    #
+    # Start the application.  Return the status code.
+    #
+    def start
+      status = -1
+      begin
+        log(INFO, "Start of #{ @appname }.")
+        status = run
+      rescue
+        log(FATAL, "Detected an exception. Stopping ... #{$!} (#{$!.class})\n" << $@.join("\n"))
+      ensure
+        log(INFO, "End of #{ @appname }. (status: #{ status })")
+      end
+      status
+    end
+
+    # Logger for this application.  See the class Logger for an explanation.
+    def logger
+      @log
+    end
+
+    #
+    # Sets the logger for this application.  See the class Logger for an
+    # explanation.
+    #
+    def logger=(logger)
+      @log = logger
+      @log.progname = @appname
+      @log.level = @level
+    end
+
+    #
+    # Sets the log device for this application.  See <tt>Logger.new</tt> for
+    # an explanation of the arguments.
+    #
+    def set_log(logdev, shift_age = 0, shift_size = 1024000)
+      @log = Logger.new(logdev, shift_age, shift_size)
+      @log.progname = @appname
+      @log.level = @level
+    end
+
+    def log=(logdev)
+      set_log(logdev)
+    end
+
+    #
+    # Set the logging threshold, just like <tt>Logger#level=</tt>.
+    #
+    def level=(level)
+      @level = level
+      @log.level = @level
+    end
+
+    #
+    # See Logger#add.  This application's +appname+ is used.
+    #
+    def log(severity, message = nil, &block)
+      @log.add(severity, message, @appname, &block) if @log
+    end
+
+  private
+
+    def run
+      # TODO: should be an NotImplementedError
+      raise RuntimeError.new('Method run must be defined in the derived class.')
+    end
+  end
+end

data/lib/logger/application/version.rb

@@ -0,0 +1,5 @@
+class Logger
+  class Application
+    VERSION = "0.0.1"
+  end
+end

data/logger-application.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logger/application/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logger-application"
+  spec.version       = Logger::Application::VERSION
+  spec.authors       = ["SHIBATA Hiroshi"]
+  spec.email         = ["hsbt@ruby-lang.org"]
+  spec.summary       = %q{Add logging support to your application.}
+  spec.description   = %q{Add logging support to your application.}
+  spec.homepage      = ""
+  spec.license       = "2-clause BSDL"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+end

data/test/test_application.rb

@@ -0,0 +1,54 @@
+# coding: US-ASCII
+require 'test/unit'
+require 'logger'
+require 'tempfile'
+
+class TestLoggerApplication < Test::Unit::TestCase
+  def setup
+    @app = Logger::Application.new('appname')
+    @tempfile = Tempfile.new("logger")
+    @tempfile.close
+    @filename = @tempfile.path
+    File.unlink(@filename)
+  end
+
+  def teardown
+    @tempfile.close(true)
+  end
+
+  def test_initialize
+    app = Logger::Application.new('appname')
+    assert_equal('appname', app.appname)
+  end
+
+  def test_start
+    @app.set_log(@filename)
+    begin
+      @app.level = Logger::UNKNOWN
+      @app.start # logs FATAL log
+      assert_equal(1, File.read(@filename).split(/\n/).size)
+    ensure
+      @app.logger.close
+    end
+  end
+
+  def test_logger
+    @app.level = Logger::WARN
+    @app.set_log(@filename)
+    begin
+      assert_equal(Logger::WARN, @app.logger.level)
+    ensure
+      @app.logger.close
+    end
+    @app.logger = logger = Logger.new(STDOUT)
+    assert_equal(logger, @app.logger)
+    assert_equal(Logger::WARN, @app.logger.level)
+    @app.log = @filename
+    begin
+      assert(logger != @app.logger)
+      assert_equal(Logger::WARN, @app.logger.level)
+    ensure
+      @app.logger.close
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: logger-application
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- SHIBATA Hiroshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: test-unit
+  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: Add logging support to your application.
+email:
+- hsbt@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- BSDL
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logger-application.rb
+- lib/logger/application.rb
+- lib/logger/application/version.rb
+- logger-application.gemspec
+- test/test_application.rb
+homepage: ''
+licenses:
+- 2-clause BSDL
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Add logging support to your application.
+test_files:
+- test/test_application.rb
+has_rdoc: