logify 0.1.0

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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: f397195c1a3f20f14adfa54eaa76ad742ee0b624
4
+ data.tar.gz: 0643d3a0c5570f0fa8da7a2c9ce577f17e921929
5
+ SHA512:
6
+ metadata.gz: 3030a68c9296d02af53bb1f30236e4e182c1267da0582f011012da79f1549ad92dc6c71d9123beeeee7a0beb7c5c3691068e4b2da7625a0771f5ce4aadf743ff
7
+ data.tar.gz: 9a6041c145949efa74ed05aee71d50ad1df890c556834169603bbad70f0081729ddf6f67dec4df69c92206bcf3a736e2f2f590c56b4be980d3350402ecd2001d
@@ -0,0 +1,18 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .rspec
6
+ .yardoc
7
+ Gemfile.lock
8
+ InstalledFiles
9
+ _yardoc
10
+ coverage
11
+ doc/
12
+ lib/bundler/man
13
+ pkg
14
+ rdoc
15
+ spec/reports
16
+ test/tmp
17
+ test/version_tmp
18
+ tmp
@@ -0,0 +1,12 @@
1
+ rvm:
2
+ - 1.9.3
3
+ - 2.0.0
4
+ - 2.1
5
+
6
+ bundler_args: --jobs 7
7
+
8
+ branches:
9
+ only:
10
+ - master
11
+
12
+ script: bundle exec rake travis:ci
data/Gemfile ADDED
@@ -0,0 +1,2 @@
1
+ source 'https://rubygems.org'
2
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [YYYY] [Author]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,172 @@
1
+ Logify
2
+ ======
3
+ Logify is an incredibly light-weight Ruby logger with a developer-friendly API and no dependencies. It is intentionally very opinionated and is optimized for speed. This combination makes it perfect for command line applications.
4
+
5
+ Logify does:
6
+
7
+ - Support multithreading with inherited defaults
8
+ - Provide a very pretty debug logger
9
+ - Make logging fun again!
10
+
11
+ Logify does not:
12
+
13
+ - Depend on or inherit from Ruby's core `Logger` class
14
+ - Manage the log device - if you wish to write your logs to a file, it is your responsibility to manage the file handler, rewind, etc.
15
+
16
+
17
+ Usage
18
+ -----
19
+ Simply include the `Logify` module in each class you want to log:
20
+
21
+ ```ruby
22
+ require 'logify'
23
+
24
+ class MyClass
25
+ include Logify
26
+ end
27
+ ```
28
+
29
+ This will expose a `log` method on both the class and instance:
30
+
31
+ ```ruby
32
+ MyClass.log 'This is a class log message!'
33
+
34
+ instance = MyClass.new
35
+ instance.log 'This is an instance log message!'
36
+ ```
37
+
38
+ In debug mode, Logify is designed for developer happiness. Parameters are aligned, and visual queues are used to indicate status. The format is as follows:
39
+
40
+ ```text
41
+ MyClass | ===> Starting some command...
42
+ MyClass | x = 0
43
+ MyClass | y = 99
44
+ MyClass | **** x is 0
45
+ MyClass | >>>> Cannot divide by 0
46
+ MyClass | !!!! Ruby segfaulted
47
+ ```
48
+
49
+ Where the prefixes are:
50
+
51
+ ```ruby
52
+ FATAL #=> "!!!!"
53
+ ERROR #=> ">>>>"
54
+ WARN #=> "****"
55
+ INFO #=> "===>"
56
+ DEBUG #=> " "
57
+ ```
58
+
59
+ Class names are automatically shortened if they exceed 32 characters.
60
+
61
+ In non-debug mode, Logify is less chatty:
62
+
63
+ ```text
64
+ I: Starting some command
65
+ W: x is 0
66
+ E: Cannot divide by 0
67
+ F: Ruby segfaulted
68
+ ```
69
+
70
+ Where the letter corresponds to the log level:
71
+
72
+ ```ruby
73
+ FATAL #=> "F"
74
+ ERROR #=> "E"
75
+ WARN #=> "W"
76
+ INFO #=> "I"
77
+ ```
78
+
79
+ Configuring
80
+ -----------
81
+ Logify is configurable via the top-level `Logify` module.
82
+
83
+ Set the log level using symbol definitions:
84
+
85
+ ```ruby
86
+ Logify.level = :warn
87
+ ```
88
+
89
+ Set the output object (io). It must respond to `<<`:
90
+
91
+ ```ruby
92
+ Logify.io = StringIO.new
93
+ ```
94
+
95
+ The Logify module is thread-aware. Settings are inherited from the main thread. Changes to log levels in child threads are only persisted within the thread.
96
+
97
+ ```ruby
98
+ # Main thread configuration
99
+ Logify.level = :warn
100
+
101
+ Thread.new do
102
+ # This will persist for the duration of this thread.
103
+ # The main thread will continue to use :warn.
104
+ Logify.level = :debug
105
+
106
+ Thread.new do
107
+ # The log level is _only_ inherited from the main thread.
108
+ Logify.level #=> :warn
109
+ end
110
+ end
111
+ ```
112
+
113
+ You can disable all logging by setting the `io` device to a null object:
114
+
115
+ ```ruby
116
+ class NullLogger
117
+ def <<(*args); end
118
+ end
119
+ Logify.io = NullLogger.new
120
+ ```
121
+
122
+ Or set the `log_level` to `:none`:
123
+
124
+ ```ruby
125
+ Logify.level = :none
126
+ ```
127
+
128
+
129
+ Installation
130
+ ------------
131
+ Add this line to your application's Gemfile:
132
+
133
+ ```ruby
134
+ gem 'logify'
135
+ ```
136
+
137
+ And then execute:
138
+
139
+ $ bundle
140
+
141
+ Or install it yourself as:
142
+
143
+ $ gem install logify
144
+
145
+
146
+ Contributing
147
+ ------------
148
+ 1. Fork it
149
+ 1. Fix it
150
+ 1. Test it
151
+ 1. Pull Request it
152
+
153
+
154
+ License & Authors
155
+ -----------------
156
+ - Author: Seth Vargo (<sethvargo@gmail.com>)
157
+
158
+ ```text
159
+ Copyright 2014, Seth Vargo (sethvargo@gmail.com)
160
+
161
+ Licensed under the Apache License, Version 2.0 (the "License");
162
+ you may not use this file except in compliance with the License.
163
+ You may obtain a copy of the License at
164
+
165
+ http://www.apache.org/licenses/LICENSE-2.0
166
+
167
+ Unless required by applicable law or agreed to in writing, software
168
+ distributed under the License is distributed on an "AS IS" BASIS,
169
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
170
+ See the License for the specific language governing permissions and
171
+ limitations under the License.
172
+ ```
@@ -0,0 +1,11 @@
1
+ require 'bundler/setup'
2
+ require 'bundler/gem_tasks'
3
+
4
+ require 'rspec/core/rake_task'
5
+ RSpec::Core::RakeTask.new(:unit)
6
+
7
+ namespace :travis do
8
+ task :ci => [:unit]
9
+ end
10
+
11
+ task :default => [:unit]
@@ -0,0 +1,124 @@
1
+ require 'logify/logger'
2
+ require 'logify/version'
3
+
4
+ module Logify
5
+ # @private
6
+ LEVEL_ID = 'logify.level'
7
+
8
+ # @private
9
+ IO_ID = 'logify.io'
10
+
11
+ class << self
12
+ # @private
13
+ def included(base)
14
+ base.send(:extend, ClassMethods)
15
+ base.send(:include, InstanceMethods)
16
+ end
17
+
18
+ # @private
19
+ def logger_for(name)
20
+ loggers[name] ||= Logger.new(name)
21
+ end
22
+
23
+ #
24
+ # Reset the current loggers for all thread instances.
25
+ #
26
+ # @return [true]
27
+ #
28
+ def reset!
29
+ Thread.list.each do |thread|
30
+ thread[LEVEL_ID] = nil
31
+ thread[IO_ID] = nil
32
+ end
33
+
34
+ loggers.clear
35
+ true
36
+ end
37
+
38
+ #
39
+ # The current log level.
40
+ #
41
+ # @return [Fixnum]
42
+ #
43
+ def level
44
+ Thread.current[LEVEL_ID] || Thread.main[LEVEL_ID] || Logger::DEFAULT
45
+ end
46
+
47
+ #
48
+ # Set the global log level. All loggers in the current thread will
49
+ # immediately begin using this new log level.
50
+ #
51
+ # @example Setting the log level to +:fatal+
52
+ # Logify.level = :fatal
53
+ #
54
+ # @param [Symbol] id
55
+ # the symbol id of the logger
56
+ #
57
+ # @return [Fixnum]
58
+ #
59
+ def level=(id)
60
+ Thread.current[LEVEL_ID] = Logger::LEVEL_MAP.fetch(id, Logger::DEFAULT)
61
+ end
62
+
63
+ #
64
+ # The IO stream to log to. Default: +$stdout+.
65
+ #
66
+ # @return [IO]
67
+ #
68
+ def io
69
+ Thread.current[IO_ID] || Thread.main[IO_ID] || $stdout
70
+ end
71
+
72
+ #
73
+ # Set the global io object. All loggers in the current thread will
74
+ # immediately begin using this new IO stream. It is the user's
75
+ # responsibility to manage this IO object (like rewinding and closing).
76
+ #
77
+ # @example Setting the outputter to +$stderr+
78
+ # Logify.io = $stderr
79
+ #
80
+ # @example Using an IO object
81
+ # io = StringIO.new
82
+ # Logify.io = io
83
+ #
84
+ # @param [IO] io
85
+ # the IO object to output to
86
+ #
87
+ # @return [IO]
88
+ #
89
+ def io=(io)
90
+ Thread.current[IO_ID] = io
91
+ end
92
+
93
+ private
94
+
95
+ # @private
96
+ def loggers
97
+ @loggers ||= {}
98
+ end
99
+ end
100
+
101
+ # Class methods that get extended into any including object.
102
+ module ClassMethods
103
+ #
104
+ # Write a message to the logger for this class.
105
+ #
106
+ # @return [Logger]
107
+ #
108
+ def log
109
+ @log ||= Logify.logger_for(name)
110
+ end
111
+ end
112
+
113
+ # Instance methods that get included into any including object.
114
+ module InstanceMethods
115
+ #
116
+ # Write a message to the logger for this instance's class.
117
+ #
118
+ # @return [Logger]
119
+ #
120
+ def log
121
+ @log ||= Logify.logger_for(self.class.name)
122
+ end
123
+ end
124
+ end
@@ -0,0 +1,135 @@
1
+ require 'monitor'
2
+
3
+ module Logify
4
+ class Logger
5
+ class << self
6
+ #
7
+ # @private
8
+ #
9
+ # @macro level
10
+ # @method $1(message = nil, &block)
11
+ # Write a new $1 message to the current IO object.
12
+ #
13
+ # @example Write a +:$1+ message
14
+ # log.$1 'This is a message'
15
+ #
16
+ # @example Write a lazy evaluated +:$1+ message
17
+ # log.$1 { perform_complex_operation }
18
+ #
19
+ # @param [String] message
20
+ # the message to log
21
+ # @param [Proc] block
22
+ # the block to call that returns a string to write
23
+ #
24
+ # @return [true]
25
+ #
26
+ def level(name)
27
+ constant = name.to_s.upcase
28
+
29
+ class_eval <<-EOH, __FILE__, __LINE__ + 1
30
+ def #{name}(message = nil, &block)
31
+ if Logify.level <= #{constant}
32
+ buffer = ''
33
+
34
+ if Logify.level == #{DEBUG}
35
+ buffer << formatted_id
36
+ buffer << SEPARATOR
37
+ buffer << PREFIX_LONG_#{constant}
38
+ else
39
+ buffer << PREFIX_#{constant}
40
+ end
41
+
42
+ buffer << message if message
43
+ buffer << yield if block_given?
44
+ buffer << "#{NEWLINE}"
45
+
46
+ MONITOR.synchronize { Logify.io.write(buffer) }
47
+
48
+ true
49
+ end
50
+ end
51
+ EOH
52
+ end
53
+ end
54
+
55
+ ANONYMOUS = '(Anonymous)'
56
+ MAX_LENGTH = 32
57
+ NEWLINE = "\n"
58
+ SEPARATOR = ' | '
59
+ MONITOR = Monitor.new
60
+
61
+ NONE = 5
62
+ FATAL = 4
63
+ ERROR = 3
64
+ WARN = 2
65
+ INFO = 1
66
+ DEBUG = 0
67
+
68
+ DEFAULT = WARN
69
+
70
+ LEVEL_MAP = {
71
+ none: NONE,
72
+ fatal: FATAL,
73
+ error: ERROR,
74
+ warn: WARN,
75
+ info: INFO,
76
+ debug: DEBUG,
77
+ }.freeze
78
+
79
+ PREFIX_FATAL = 'F: '
80
+ PREFIX_ERROR = 'E: '
81
+ PREFIX_WARN = 'W: '
82
+ PREFIX_INFO = 'I: '
83
+ PREFIX_DEBUG = 'D: '
84
+
85
+ PREFIX_LONG_FATAL = '!!!! '
86
+ PREFIX_LONG_ERROR = '>>>> '
87
+ PREFIX_LONG_WARN = '**** '
88
+ PREFIX_LONG_INFO = '===> '
89
+ PREFIX_LONG_DEBUG = ' '
90
+
91
+ level :fatal
92
+ level :error
93
+ level :warn
94
+ level :info
95
+ level :debug
96
+
97
+ #
98
+ # Create a new logger object.
99
+ #
100
+ # @param [String, nil] id
101
+ # the ID of the logger object to create
102
+ #
103
+ def initialize(id)
104
+ @id = id
105
+ end
106
+
107
+ private
108
+
109
+ # @private
110
+ def formatted_id
111
+ return @formatted_id if @formatted_id
112
+
113
+ # Account for anonymous classes
114
+ id = @id ? @id.to_s : ANONYMOUS
115
+
116
+ if id.length == MAX_LENGTH
117
+ @formatted_id = id
118
+ elsif id.length < MAX_LENGTH
119
+ @formatted_id = id.rjust(MAX_LENGTH)
120
+ else
121
+ temp = id
122
+
123
+ until temp.length <= MAX_LENGTH
124
+ if temp.include?('::')
125
+ temp = temp.split('::')[1..-1].join('::')
126
+ else
127
+ temp = id[-MAX_LENGTH..-1]
128
+ end
129
+ end
130
+
131
+ @formatted_id = temp.rjust(MAX_LENGTH)
132
+ end
133
+ end
134
+ end
135
+ end
@@ -0,0 +1,8 @@
1
+ module Logify
2
+ #
3
+ # The Logify version
4
+ #
5
+ # @return [String]
6
+ #
7
+ VERSION = '0.1.0'
8
+ end
@@ -0,0 +1,34 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'logify/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'logify'
8
+ spec.version = Logify::VERSION
9
+ spec.authors = ['Seth Vargo']
10
+ spec.email = ['sethvargo@gmail.com']
11
+ spec.summary = 'Logify is a lightweight logging library for Ruby!'
12
+ spec.description = 'Logify is an incredibly light-weight Ruby logger ' \
13
+ 'with a developer-friendly API and no dependencies. ' \
14
+ 'It is intentionally very opinionated and is ' \
15
+ 'optimized for speed. This combination makes it ' \
16
+ 'perfect for command line applications.'
17
+
18
+ spec.homepage = 'https://github.com/sethvargo/logify'
19
+ spec.license = 'Apache 2.0'
20
+
21
+ spec.required_ruby_version = '>= 1.9.3'
22
+
23
+ spec.files = `git ls-files`.split($/)
24
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
25
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
26
+ spec.require_paths = ['lib']
27
+
28
+ # Development dependencies
29
+ spec.add_development_dependency 'rspec', '~> 2.14'
30
+
31
+ spec.add_development_dependency 'bundler'
32
+ spec.add_development_dependency 'rake'
33
+ spec.add_development_dependency 'ruby-prof'
34
+ end
@@ -0,0 +1,2 @@
1
+ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
2
+ require 'logify'
@@ -0,0 +1,244 @@
1
+ require 'spec_helper'
2
+
3
+ module Logify
4
+ describe Logger do
5
+ let(:io) { StringIO.new }
6
+ let(:klass) { Class.new { include Logify } }
7
+ let(:log) { klass.new.log }
8
+ let(:stdout) { io.rewind && io.read }
9
+
10
+ before do
11
+ Logify.level = :debug
12
+ Logify.io = io
13
+ end
14
+
15
+ it 'accepts a string parameter' do
16
+ expect { log.debug 'An informative message' }.to_not raise_error
17
+ expect(stdout).to include('An informative message')
18
+ end
19
+
20
+ it 'accepts a block parameter' do
21
+ expect {
22
+ log.debug { String.new('An informative message') }
23
+ }.to_not raise_error
24
+ expect(stdout).to include('An informative message')
25
+ end
26
+
27
+ context 'when the log level is :debug' do
28
+ it 'pretty aligns parameters' do
29
+ log.info 'Starting some command...'
30
+ log.debug 'x = 0'
31
+ log.debug 'y = 99'
32
+ log.warn 'x is 0'
33
+ log.error 'Cannot divide by 0'
34
+ log.fatal 'Ruby segfaulted'
35
+
36
+
37
+ expect(stdout).to include('| ===> Starting some command...')
38
+ expect(stdout).to include('| x = 0')
39
+ expect(stdout).to include('| y = 99')
40
+ expect(stdout).to include('| **** x is 0')
41
+ expect(stdout).to include('| >>>> Cannot divide by 0')
42
+ expect(stdout).to include('| !!!! Ruby segfaulted')
43
+ end
44
+
45
+ context 'when the class is < MAX_LENGTH' do
46
+ it 'uses the full class name' do
47
+ klass.stub(:name).and_return('Hello::Kitty')
48
+ log.debug 'Helpful info'
49
+
50
+ expect(stdout).to include('Hello::Kitty | Helpful info')
51
+ end
52
+ end
53
+
54
+ context 'when the class is MAX_LENGTH' do
55
+ it 'uses the full class name' do
56
+ klass.stub(:name).and_return('Hello::Kitty::Magical::Pony::Eye')
57
+ log.debug 'Helpful info'
58
+
59
+ expect(stdout).to include('Hello::Kitty::Magical::Pony::Eye | Helpful info')
60
+ end
61
+ end
62
+
63
+ context 'when the class is > MAX_LENGTH' do
64
+ it 'shortens the name by namespace' do
65
+ klass.stub(:name).and_return('Hello::Kitty::Magical::Ponies::Eye')
66
+ log.debug 'Helpful info'
67
+
68
+ expect(stdout).to include('Kitty::Magical::Ponies::Eye | Helpful info')
69
+ end
70
+
71
+ it 'just pre-truncates long names' do
72
+ klass.stub(:name).and_return('ReallyLongHelloKittyMagicalPoniesEye')
73
+ log.debug 'Helpful info'
74
+
75
+ expect(stdout).to include('gHelloKittyMagicalPoniesEye | Helpful info')
76
+ end
77
+ end
78
+ end
79
+
80
+ context 'when the log level is not :debug' do
81
+ before { Logify.level = :info }
82
+
83
+ it 'uses the shortened syntax' do
84
+ log.info 'Starting some command...'
85
+ log.debug 'x = 0'
86
+ log.debug 'y = 99'
87
+ log.warn 'x is 0'
88
+ log.error 'Cannot divide by 0'
89
+ log.fatal 'Ruby segfaulted'
90
+
91
+
92
+ expect(stdout).to include('I: Starting some command')
93
+ expect(stdout).to include('W: x is 0')
94
+ expect(stdout).to include('E: Cannot divide by 0')
95
+ expect(stdout).to include('F: Ruby segfaulted')
96
+ end
97
+ end
98
+
99
+ context 'when the log level is :info' do
100
+ before { Logify.level = :info }
101
+
102
+ it 'does not print :debug messages' do
103
+ log.debug 'This is a debug'
104
+ expect(stdout).to_not include('This is a debug')
105
+ end
106
+
107
+ it 'prints :info messages' do
108
+ log.info 'This is info'
109
+ expect(stdout).to include('This is info')
110
+ end
111
+
112
+ it 'prints :warn messages' do
113
+ log.warn 'This is a warn'
114
+ expect(stdout).to include('This is a warn')
115
+ end
116
+
117
+ it 'prints :error messages' do
118
+ log.error 'This is an error'
119
+ expect(stdout).to include('This is an error')
120
+ end
121
+
122
+ it 'prints :fatal messages' do
123
+ log.fatal 'This is a fatal'
124
+ expect(stdout).to include('This is a fatal')
125
+ end
126
+ end
127
+
128
+ context 'when the log level is :warn' do
129
+ before { Logify.level = :warn }
130
+
131
+ it 'does not print :debug messages' do
132
+ log.debug 'This is a debug'
133
+ expect(stdout).to_not include('This is a debug')
134
+ end
135
+
136
+ it 'does not print :info messages' do
137
+ log.info 'This is info'
138
+ expect(stdout).to_not include('This is info')
139
+ end
140
+
141
+ it 'prints :warn messages' do
142
+ log.warn 'This is a warn'
143
+ expect(stdout).to include('This is a warn')
144
+ end
145
+
146
+ it 'prints :error messages' do
147
+ log.error 'This is an error'
148
+ expect(stdout).to include('This is an error')
149
+ end
150
+
151
+ it 'prints :fatal messages' do
152
+ log.fatal 'This is a fatal'
153
+ expect(stdout).to include('This is a fatal')
154
+ end
155
+ end
156
+
157
+ context 'when the log level is :error' do
158
+ before { Logify.level = :error }
159
+
160
+ it 'does not print :debug messages' do
161
+ log.debug 'This is a debug'
162
+ expect(stdout).to_not include('This is a debug')
163
+ end
164
+
165
+ it 'does not print :info messages' do
166
+ log.info 'This is info'
167
+ expect(stdout).to_not include('This is info')
168
+ end
169
+
170
+ it 'does not print :warn messages' do
171
+ log.warn 'This is a warn'
172
+ expect(stdout).to_not include('This is a warn')
173
+ end
174
+
175
+ it 'prints :error messages' do
176
+ log.error 'This is an error'
177
+ expect(stdout).to include('This is an error')
178
+ end
179
+
180
+ it 'prints :fatal messages' do
181
+ log.fatal 'This is a fatal'
182
+ expect(stdout).to include('This is a fatal')
183
+ end
184
+ end
185
+
186
+ context 'when the log level is :fatal' do
187
+ before { Logify.level = :fatal }
188
+
189
+ it 'does not print :debug messages' do
190
+ log.debug 'This is a debug'
191
+ expect(stdout).to_not include('This is a debug')
192
+ end
193
+
194
+ it 'does not print :info messages' do
195
+ log.info 'This is info'
196
+ expect(stdout).to_not include('This is info')
197
+ end
198
+
199
+ it 'does not print :warn messages' do
200
+ log.warn 'This is a warn'
201
+ expect(stdout).to_not include('This is a warn')
202
+ end
203
+
204
+ it 'does not print :error messages' do
205
+ log.error 'This is an error'
206
+ expect(stdout).to_not include('This is an error')
207
+ end
208
+
209
+ it 'prints :fatal messages' do
210
+ log.fatal 'This is a fatal'
211
+ expect(stdout).to include('This is a fatal')
212
+ end
213
+ end
214
+
215
+ context 'when the log level is :none' do
216
+ before { Logify.level = :none }
217
+
218
+ it 'does not print :debug messages' do
219
+ log.debug 'This is a debug'
220
+ expect(stdout).to_not include('This is a debug')
221
+ end
222
+
223
+ it 'does not print :info messages' do
224
+ log.info 'This is info'
225
+ expect(stdout).to_not include('This is info')
226
+ end
227
+
228
+ it 'does not print :warn messages' do
229
+ log.warn 'This is a warn'
230
+ expect(stdout).to_not include('This is a warn')
231
+ end
232
+
233
+ it 'does not print :error messages' do
234
+ log.error 'This is an error'
235
+ expect(stdout).to_not include('This is an error')
236
+ end
237
+
238
+ it 'does not print :fatal messages' do
239
+ log.fatal 'This is a fatal'
240
+ expect(stdout).to_not include('This is a fatal')
241
+ end
242
+ end
243
+ end
244
+ end
@@ -0,0 +1,68 @@
1
+ require 'spec_helper'
2
+
3
+ module Logify
4
+ describe do
5
+ before { Logify.reset! }
6
+
7
+ describe '.level & .level=' do
8
+ it 'defaults to WARN' do
9
+ expect(Logify.level).to eq(Logger::WARN)
10
+ end
11
+
12
+ it 'uses the level set in the main thread' do
13
+ Logify.level = :fatal
14
+ Thread.new { Logify.level = :warn }.join
15
+ expect(Logify.level).to eq(Logger::FATAL)
16
+ end
17
+
18
+ it 'uses the level set in the current thread' do
19
+ Logify.level = :fatal
20
+ Thread.new do
21
+ Logify.level = :debug
22
+ expect(Logify.level).to eq(Logger::DEBUG)
23
+ end.join
24
+
25
+ # Make sure the parent thread isn't modified
26
+ expect(Logify.level).to eq(Logger::FATAL)
27
+ end
28
+
29
+ it 'uses the level set in the main thread' do
30
+ Logify.level = :fatal
31
+
32
+ # Set the log level in another thread
33
+ Thread.new { Logify.level }.join
34
+
35
+ # Since Logify.level = :fatal was set in the main thread,
36
+ # it should be the default moving forward
37
+ Thread.new { expect(Logify.level).to eq(Logger::FATAL) }.join
38
+ end
39
+ end
40
+
41
+ describe '.logger_for' do
42
+ it 'uses a cached logger' do
43
+ logger = double
44
+ Logify.send(:loggers)['default'] = logger
45
+ expect(Logify.logger_for('default')).to be(logger)
46
+ end
47
+
48
+ it 'creates a new logger when one does not exist' do
49
+ Logger.stub(:new)
50
+ expect(Logger).to receive(:new).with('default').once
51
+ Logify.logger_for('default')
52
+ end
53
+ end
54
+
55
+ describe '.included' do
56
+ let(:klass) { Class.new { include Logify } }
57
+ let(:instance) { klass.new }
58
+
59
+ it 'includes the instances methods' do
60
+ expect(klass).to respond_to(:log)
61
+ end
62
+
63
+ it 'includes the class methods' do
64
+ expect(klass).to respond_to(:log)
65
+ end
66
+ end
67
+ end
68
+ end
metadata ADDED
@@ -0,0 +1,118 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: logify
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Seth Vargo
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-03-14 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rspec
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.14'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.14'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: ruby-prof
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description: Logify is an incredibly light-weight Ruby logger with a developer-friendly
70
+ API and no dependencies. It is intentionally very opinionated and is optimized for
71
+ speed. This combination makes it perfect for command line applications.
72
+ email:
73
+ - sethvargo@gmail.com
74
+ executables: []
75
+ extensions: []
76
+ extra_rdoc_files: []
77
+ files:
78
+ - ".gitignore"
79
+ - ".travis.yml"
80
+ - Gemfile
81
+ - LICENSE
82
+ - README.md
83
+ - Rakefile
84
+ - lib/logify.rb
85
+ - lib/logify/logger.rb
86
+ - lib/logify/version.rb
87
+ - logify.gemspec
88
+ - spec/spec_helper.rb
89
+ - spec/unit/logify/logger_spec.rb
90
+ - spec/unit/logify_spec.rb
91
+ homepage: https://github.com/sethvargo/logify
92
+ licenses:
93
+ - Apache 2.0
94
+ metadata: {}
95
+ post_install_message:
96
+ rdoc_options: []
97
+ require_paths:
98
+ - lib
99
+ required_ruby_version: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: 1.9.3
104
+ required_rubygems_version: !ruby/object:Gem::Requirement
105
+ requirements:
106
+ - - ">="
107
+ - !ruby/object:Gem::Version
108
+ version: '0'
109
+ requirements: []
110
+ rubyforge_project:
111
+ rubygems_version: 2.2.2
112
+ signing_key:
113
+ specification_version: 4
114
+ summary: Logify is a lightweight logging library for Ruby!
115
+ test_files:
116
+ - spec/spec_helper.rb
117
+ - spec/unit/logify/logger_spec.rb
118
+ - spec/unit/logify_spec.rb