multi_logger 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +52 -0
- data/Rakefile +1 -0
- data/lib/multi_logger.rb +48 -0
- data/lib/multi_logger/version.rb +3 -0
- data/multi_logger.gemspec +22 -0
- metadata +71 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 lulalala <endofsummer1981@gmail.com>
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
# MultiLogger
|
2
|
+
|
3
|
+
Makes it easier to create multiple log files in Rails.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your Rails application's Gemfile:
|
8
|
+
|
9
|
+
gem 'multi_logger'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle install
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install multi_logger
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
To setup a logger, create a initializer script like `[Rails.root]/config/initializers/logger.rb`. In the script, call `MultiLogger.add_logger(log_name)` to create new logger. For example, calling `MultiLogger.add_logger('mail')` will create a log file located at `log/mail.log`.
|
22
|
+
|
23
|
+
In Rails, you can access the logger by calling `logger.log_name` or `Rails.logger.log_name`. For example, calling `logger.mail.debug('42')` will log the message in the mail log.
|
24
|
+
|
25
|
+
Note that log_name must not collide with existing method names in Rails logger, so names such as 'debug' or 'info' can not be used. You should try calling `add_logger` in Rails console to test if it is ok or raises an error.
|
26
|
+
|
27
|
+
## Advanced
|
28
|
+
|
29
|
+
You can assign formatter to loggers directly, or pass the formatter during setup:
|
30
|
+
|
31
|
+
class CustomFormatter
|
32
|
+
def call(severity, time, progname, msg)
|
33
|
+
formatted_severity = sprintf("%-5s",severity.to_s)
|
34
|
+
formatted_time = time.strftime("%Y-%m-%d %H:%M:%S")
|
35
|
+
"[#{formatted_severity} #{formatted_time}] #{msg.strip}\n"
|
36
|
+
end
|
37
|
+
end
|
38
|
+
formatter = CustomFormatter.new
|
39
|
+
MultiLogger.add_logger('mail', formatter:formatter)
|
40
|
+
MultiLogger.add_logger('user', formatter:formatter)
|
41
|
+
|
42
|
+
## Contributing
|
43
|
+
|
44
|
+
1. Fork it
|
45
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
46
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
47
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
48
|
+
5. Create new Pull Request
|
49
|
+
|
50
|
+
## License
|
51
|
+
|
52
|
+
MIT License (See LICENSE.txt)
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/lib/multi_logger.rb
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
require "multi_logger/version"
|
2
|
+
|
3
|
+
module MultiLogger
|
4
|
+
class << self
|
5
|
+
def add_logger(name, options={})
|
6
|
+
name = name.to_s
|
7
|
+
rails_logger_class = get_rails_logger_class()
|
8
|
+
|
9
|
+
if rails_logger_class.method_defined?(name)
|
10
|
+
raise "'#{name}' is reserved in #{rails_logger_class} and can not be used as a log accessor name."
|
11
|
+
else
|
12
|
+
logger = Logger.new(get_path(name, options[:path]))
|
13
|
+
rails_logger_class.class_eval do
|
14
|
+
define_method name.to_sym do
|
15
|
+
logger
|
16
|
+
end
|
17
|
+
end
|
18
|
+
if options[:formatter]
|
19
|
+
logger.formatter = options[:formatter]
|
20
|
+
end
|
21
|
+
logger
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
# Computes log file path
|
26
|
+
def get_path(name, path=nil)
|
27
|
+
if path.nil?
|
28
|
+
path = name.underscore
|
29
|
+
end
|
30
|
+
if !path.include?('/')
|
31
|
+
path = Rails.root.join('log',path).to_s
|
32
|
+
end
|
33
|
+
if !path.end_with?('.log')
|
34
|
+
path += '.log'
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
def get_rails_logger_class
|
39
|
+
if defined?(ActiveSupport::BufferedLogger)
|
40
|
+
ActiveSupport::BufferedLogger
|
41
|
+
elsif defined?(ActiveSupport::Logger)
|
42
|
+
ActiveSupport::Logger
|
43
|
+
else
|
44
|
+
raise 'Rails logger not found'
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'multi_logger/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |gem|
|
7
|
+
gem.name = "multi_logger"
|
8
|
+
gem.version = MultiLogger::VERSION
|
9
|
+
gem.authors = ["lulalala"]
|
10
|
+
gem.email = ["mark@goodlife.tw"]
|
11
|
+
gem.description = %q{Create multiple loggers in Rails.}
|
12
|
+
gem.summary = %q{Provide helper to define loggers and access them. Each logger will log into a different file under the log folder.}
|
13
|
+
|
14
|
+
gem.homepage = "https://github.com/lulalala/multi_logger"
|
15
|
+
|
16
|
+
gem.files = `git ls-files`.split($/)
|
17
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
18
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
19
|
+
gem.require_paths = ["lib"]
|
20
|
+
|
21
|
+
gem.add_dependency 'railties'
|
22
|
+
end
|
metadata
ADDED
@@ -0,0 +1,71 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: multi_logger
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- lulalala
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-05-30 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: railties
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '0'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ! '>='
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '0'
|
30
|
+
description: Create multiple loggers in Rails.
|
31
|
+
email:
|
32
|
+
- mark@goodlife.tw
|
33
|
+
executables: []
|
34
|
+
extensions: []
|
35
|
+
extra_rdoc_files: []
|
36
|
+
files:
|
37
|
+
- .gitignore
|
38
|
+
- Gemfile
|
39
|
+
- LICENSE.txt
|
40
|
+
- README.md
|
41
|
+
- Rakefile
|
42
|
+
- lib/multi_logger.rb
|
43
|
+
- lib/multi_logger/version.rb
|
44
|
+
- multi_logger.gemspec
|
45
|
+
homepage: https://github.com/lulalala/multi_logger
|
46
|
+
licenses: []
|
47
|
+
post_install_message:
|
48
|
+
rdoc_options: []
|
49
|
+
require_paths:
|
50
|
+
- lib
|
51
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
52
|
+
none: false
|
53
|
+
requirements:
|
54
|
+
- - ! '>='
|
55
|
+
- !ruby/object:Gem::Version
|
56
|
+
version: '0'
|
57
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
58
|
+
none: false
|
59
|
+
requirements:
|
60
|
+
- - ! '>='
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '0'
|
63
|
+
requirements: []
|
64
|
+
rubyforge_project:
|
65
|
+
rubygems_version: 1.8.24
|
66
|
+
signing_key:
|
67
|
+
specification_version: 3
|
68
|
+
summary: Provide helper to define loggers and access them. Each logger will log into
|
69
|
+
a different file under the log folder.
|
70
|
+
test_files: []
|
71
|
+
has_rdoc:
|