zlog 0.6

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 7e0874b0c865dbecbde95076b656da15049f7f5b
4
+ data.tar.gz: 01ee824593c7c3e6d13bb0cce36b68b9b3a347c6
5
+ SHA512:
6
+ metadata.gz: a6c09ba6d320c44e90d83042c4f7bb8b0aa5a0e889ef6726347bfd4d2b45fb289891878eb082f50a8dba32ec1c5c5ac52c187064d47d1e81f53daffd3053c663
7
+ data.tar.gz: 95808d8600e37ef8eefb302b36ca787a9fea72d133f0c5086476f74c7c7648c5a0502e9d3d30a6a157c665781cd6f6d95960b5bd36293c8b6bfb4c878f2fa1bd
data/.gitignore ADDED
@@ -0,0 +1,3 @@
1
+ *.gem
2
+ experiments
3
+ Gemfile.lock
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ language: ruby
2
+ script: "bundle exec rake"
3
+ rvm:
4
+ - "1.9.3"
5
+ - "2.0.0"
6
+ - "jruby-19mode"
7
+ - "rbx-19mode"
data/CHANGELOG.md ADDED
@@ -0,0 +1,28 @@
1
+ ## 0.6
2
+
3
+ * improvement: fixed versions of gem file dependencies
4
+ * bugfix: deprecated ruby 1.9.2
5
+
6
+ ## 0.5
7
+
8
+ * improvement: added test suite with rake, minitest, spec, turn and travis
9
+
10
+ ## 0.4
11
+
12
+ * feature: added abort( message, exit_code ) to call a fatal log message and exit
13
+ * improvement: added changelog
14
+ * bugfix: removed highline as dependency, it is not necessary anymore
15
+
16
+ ## 0.3
17
+
18
+ * feature: switched to logging framework for ruby; this is now a formatter/styler on top of it
19
+ * bugfix: removed prefix zeros from 256-colors ansi calls to blue and green
20
+
21
+ ## 0.2
22
+
23
+ * improvement: made debug logging slightly lighter to be more readable
24
+ * bugfix: removed color-mode detection, using 256-colors by default now
25
+
26
+ ## 0.1
27
+
28
+ * feature: initial stable release
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+ gem 'logging', '~> 1.8.1'
3
+
4
+ group :development do
5
+ gem 'rake', '~> 10.1.0'
6
+ gem 'turn', '~> 0.9.6'
7
+ end
data/LICENSE ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
data/README.md ADDED
@@ -0,0 +1,39 @@
1
+ # zlog
2
+ [![Gem Version](https://badge.fury.io/rb/zlog.png)](http://badge.fury.io/rb/zlog)
3
+ [![Build Status](https://travis-ci.org/arlimus/zlog.png)](https://travis-ci.org/arlimus/zlog)
4
+
5
+ Logging configuration on top of ruby's `logging` gem (see [github](https://github.com/TwP/logging)).
6
+
7
+ * colorful default logging to stdout
8
+ * supports continuous logging (eg progress indicators which you don't want to clutter your commandline)
9
+ * added section and ok log types
10
+
11
+ # requirements
12
+
13
+ * gems:
14
+ * logging
15
+
16
+ # installation
17
+
18
+ gem build *.gemspec && gem install *gem
19
+
20
+ # example
21
+
22
+ Code:
23
+
24
+ require "zlog"
25
+ Zlog.init_stdout loglevel: :debug
26
+
27
+ l = Logging.logger["main"]
28
+ l.section "log demonstration"
29
+ l.ok "ok me"
30
+ l.debug "debug me"
31
+ l.info "info me"
32
+ l.warn "warn me"
33
+ l.error "error me"
34
+ l.fatal "fatal me"
35
+
36
+
37
+ See the `example` folder for more.
38
+
39
+ ![Example image in example/example.output.png](https://raw.github.com/arlimus/zlog/master/example/example.output.png)
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ require "rake/testtask"
2
+ Rake::TestTask.new do |t|
3
+ t.libs << "test"
4
+ t.pattern = "test/classes/*_spec.rb"
5
+ t.verbose = true
6
+ end
7
+
8
+ task default: [:test]
Binary file
@@ -0,0 +1,35 @@
1
+ #!/bin/ruby
2
+ require_relative '../lib/zlog'
3
+
4
+ Zlog.init_stdout loglevel: :debug
5
+
6
+ logger = Logging.logger["zlog"]
7
+ logger.section "zlog"
8
+ logger.ok "ok me"
9
+ logger.debug "debug me"
10
+ logger.info "info me"
11
+ logger.warn "warn me"
12
+ logger.error "error me"
13
+ logger.fatal "fatal me"
14
+
15
+ logger.section "continuous logging"
16
+ (1..50).each do |len|
17
+ logger.debug( logger.cont "o"*len+"k" )
18
+ sleep 0.01
19
+ end
20
+ logger.info "back to normal"
21
+
22
+ logger.section "logging with hierarchies"
23
+ Zlog.init_stdout named: true, loglevel: :debug
24
+ foo = Logging.logger['Foo']
25
+ bar = Logging.logger['Foo::Bar']
26
+ baz = Logging.logger['Foo::Baz']
27
+ foo.debug 'foo will send a warning soon'
28
+ foo.warn 'this is a warning, not a ticket'
29
+ bar.info 'this message will not be logged'
30
+ baz.info 'nor will this message'
31
+ bar.ok 'bar ís ok'
32
+ bar.error 'but this error message will be logged'
33
+
34
+ logger.section "show logger configuration"
35
+ Logging.show_configuration
data/lib/zlog.rb ADDED
@@ -0,0 +1,4 @@
1
+ require 'logging'
2
+ require 'zlog/zlog'
3
+ require 'zlog/logging'
4
+ require 'zlog/layouts'
@@ -0,0 +1,4 @@
1
+ module Zlog::Layouts
2
+ end
3
+
4
+ require 'zlog/simple_layouts'
@@ -0,0 +1,17 @@
1
+ # custom log level
2
+ # http://stackoverflow.com/questions/2281490/how-to-add-a-custom-log-level-to-logger-in-ruby
3
+ module Logging
4
+ class Logger
5
+ def ok msg; add 5, msg end
6
+ def section msg; add 6, msg end
7
+ def abort msg, exit_code = 1
8
+ fatal msg
9
+ exit exit_code
10
+ end
11
+
12
+ def cont msg
13
+ "\r" + msg
14
+ end
15
+
16
+ end
17
+ end
@@ -0,0 +1,122 @@
1
+
2
+ module Zlog::Layouts::SimpleCore
3
+ def format_simple event, print_name = false, pallette = STDOUT_PATTERN_256COLORS
4
+ # Logging::LogEvent logger="zlog", level=2, data="warn me", time=2013-09-29 23:36:12 +0200, file="", line="", method=""
5
+ level = LOGLEVEL2NAME[event.level]
6
+ pattern = pallette[level]
7
+ # get the core message
8
+ mkmsg = lambda{ |data|
9
+ obj = format_obj(data)
10
+ if print_name
11
+ (pallette[:name] % event.logger) + ( pattern % obj )
12
+ else
13
+ pattern % obj
14
+ end
15
+ }
16
+ # handle continuous logging lines
17
+ if (event.data.start_with? "\r")
18
+ # this is a continuous message
19
+ # there are 2 cases which need to be covered:
20
+ # A: the last line was a regular log line,
21
+ # the cursor caret is at position 0
22
+ # B: the last line was a continuous log line,
23
+ # the cursor caret is at the end of the last message
24
+ # For case B we want to go back to the beginning of the line (via "\r")
25
+ # then insert the message and the amount of white space needed to
26
+ # overwrite any visible characters from the last message
27
+ msg = mkmsg.(event.data[1..-1])
28
+ # determine the length of the last message
29
+ len = (@has_last_line_newline == false) ? @last.length : 0
30
+ # calculate the amount of white spaces we need to overwrite
31
+ # remnants of the last log message
32
+ rem_len = len - msg.length
33
+ rem_len = 0 if rem_len < 0
34
+ # create the resulting string
35
+ ret = "\r" + msg + (' '*rem_len)
36
+ # make sure to update state parameters
37
+ @last = msg
38
+ @has_last_line_newline = false
39
+ # return the result
40
+ ret
41
+ else
42
+ # format the object
43
+ msg = mkmsg.(event.data)
44
+ # check if we need to add a newline at the start of the line
45
+ # this only happens when the last message was a continuous message
46
+ # and thus didn't set a \n at the end
47
+ sl =
48
+ if (@has_last_line_newline == false)
49
+ @has_last_line_newline = true
50
+ "\n"
51
+ else "" end
52
+ # return the resulting pattern
53
+ sl + msg + "\n"
54
+ end
55
+ end
56
+
57
+ # standard order: ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"]
58
+
59
+ LOGLEVEL2NAME = [:debug, :info, :warning, :error, :fatal, :ok, :section]
60
+
61
+ STDOUT_PATTERN_NOCOLORS = {
62
+ :debug => ".. %s",
63
+ :info => "-- %s",
64
+ :warning => "ww %s",
65
+ :error => "ee %s",
66
+ :fatal => "ff %s",
67
+ :ok => "++ %s",
68
+ :section => "\n== %s",
69
+ :name => "%s: "
70
+ }
71
+
72
+ STDOUT_PATTERN_8COLORS = {
73
+ :debug => "\033[37m.. %s\033[0m",
74
+ :info => "\033[0m-- %s\033[0m",
75
+ :warning => "\033[1;33mww %s\033[0m",
76
+ :error => "\033[1;31mee %s\033[0m",
77
+ :fatal => "\033[1;41mff\033[0m\033[1;31 %s\033[0m",
78
+ :ok => "\033[1;32m++ %s\033[0m",
79
+ :section => "\n\033[1;34m== %s\033[0m",
80
+ :name => "\033[37m%s: "
81
+ }
82
+
83
+ STDOUT_PATTERN_256COLORS = {
84
+ :debug => "\033[38;5;246m.. %s\033[0m",
85
+ :info => "\033[38;5;255m-- %s\033[0m",
86
+ :warning => "\033[38;5;226mww %s\033[0m",
87
+ :error => "\033[38;5;196mee %s\033[0m",
88
+ :fatal => "\033[48;5;196mff\033[0m\033[38;5;196m %s\033[0m",
89
+ :ok => "\033[38;5;46m++ %s\033[0m",
90
+ :section => "\n\033[38;5;33m== %s\033[0m",
91
+ :name => "\033[38;5;246m%s: "
92
+ }
93
+ end
94
+
95
+ module Zlog::Layouts
96
+ # Accessor / Factory for Simple layout
97
+ def self.simple( *args )
98
+ ::Zlog::Layouts::Simple.new(*args)
99
+ end
100
+
101
+ def self.named( *args )
102
+ ::Zlog::Layouts::SimpleNamed.new(*args)
103
+ end
104
+
105
+ # Simple layout for easy readability
106
+ class Simple < ::Logging::Layout
107
+ include Zlog::Layouts::SimpleCore
108
+ # format log events
109
+ def format( event )
110
+ format_simple event, false
111
+ end
112
+ end
113
+
114
+ # Simple layout for easy readability
115
+ class SimpleNamed < ::Logging::Layout
116
+ include Zlog::Layouts::SimpleCore
117
+ # format log events
118
+ def format( event )
119
+ format_simple event, true
120
+ end
121
+ end
122
+ end
data/lib/zlog/zlog.rb ADDED
@@ -0,0 +1,11 @@
1
+ module Zlog
2
+ VERSION = "0.6"
3
+
4
+ def self.init_stdout opts = {named: false, loglevel: nil}
5
+ Logging.logger.root.appenders = Logging.appenders.stdout(
6
+ level: opts[:loglevel],
7
+ layout: (opts[:named]) ? Zlog::Layouts.named : Zlog::Layouts.simple
8
+ )
9
+ Logging.logger.root.level = opts[:loglevel] if not opts[:loglevel].nil?
10
+ end
11
+ end
@@ -0,0 +1,23 @@
1
+ require 'minitest_helper'
2
+
3
+ describe Logging::Logger do
4
+ before :each do
5
+ @log = Logging.logger["main"]
6
+ end
7
+
8
+ it "provides a method for logging 'ok' messages" do
9
+ @log.must_respond_to :ok
10
+ end
11
+
12
+ it "provides a method for logging 'section's" do
13
+ @log.must_respond_to :section
14
+ end
15
+
16
+ it "provides a method for logging 'abort's" do
17
+ @log.must_respond_to :abort
18
+ end
19
+
20
+ it "provides a method for logging 'cont'inuous messages" do
21
+ @log.must_respond_to :cont
22
+ end
23
+ end
@@ -0,0 +1,70 @@
1
+ require 'minitest_helper'
2
+
3
+ describe Zlog::Layouts::Simple do
4
+ before :each do
5
+ @layout = Zlog::Layouts.simple
6
+ @logger = Logging.logger["main"]
7
+ end
8
+
9
+ def event level, data = "yelloo"
10
+ Logging::LogEvent.new("SpecLog", level, data, nil)
11
+ end
12
+
13
+ def format level, data = "yelloo"
14
+ @layout.format(event(level, data))
15
+ end
16
+
17
+ def pattern_for name, data = "yelloo"
18
+ Zlog::Layouts::SimpleCore::STDOUT_PATTERN_256COLORS[name] % data
19
+ end
20
+
21
+ it "can be initialized via simple method" do
22
+ Zlog::Layouts.simple.must_be_instance_of Zlog::Layouts::Simple
23
+ end
24
+
25
+ it "must add debug events" do
26
+ format(0).must_equal (pattern_for :debug) + "\n"
27
+ end
28
+
29
+ it "must add info events" do
30
+ format(1).must_equal (pattern_for :info) + "\n"
31
+ end
32
+
33
+ it "must add warning events" do
34
+ format(2).must_equal (pattern_for :warning) + "\n"
35
+ end
36
+
37
+ it "must add error events" do
38
+ format(3).must_equal (pattern_for :error) + "\n"
39
+ end
40
+
41
+ it "must add fatal events" do
42
+ format(4).must_equal (pattern_for :fatal) + "\n"
43
+ end
44
+
45
+ it "must add ok events" do
46
+ format(5).must_equal (pattern_for :ok) + "\n"
47
+ end
48
+
49
+ it "must add section events" do
50
+ format(6).must_equal (pattern_for :section) + "\n"
51
+ end
52
+
53
+ it "must support continuous loggin, 1 step" do
54
+ (format(1, @logger.cont("conti"))).
55
+ must_equal "\r" + (pattern_for :info, "conti")
56
+ end
57
+
58
+ it "must support continuous logging, 1 step + normal" do
59
+ (format(1, @logger.cont("conti")) + format(1)).
60
+ must_equal "\r" + (pattern_for :info, "conti") + "\n" + (pattern_for :info) + "\n"
61
+ end
62
+
63
+ it "must support continuous logging, 2 steps + normal" do
64
+ c = format(1, @logger.cont("conti"))
65
+ oc = (pattern_for :info, "conti")
66
+ ( c + c + format(1)).
67
+ must_equal "\r" + oc + "\r" + oc + "\n" + (pattern_for :info) + "\n"
68
+ end
69
+ end
70
+
@@ -0,0 +1,12 @@
1
+ require 'minitest_helper'
2
+
3
+ describe Zlog::Layouts::SimpleCore do
4
+ before :each do
5
+ @iclass = Class.new do include Zlog::Layouts::SimpleCore end
6
+ @i = @iclass.new
7
+ end
8
+
9
+ it "must provide a method for creating simple log messages" do
10
+ @i.must_respond_to :format_simple
11
+ end
12
+ end
@@ -0,0 +1,70 @@
1
+ require 'minitest_helper'
2
+
3
+ describe Zlog::Layouts::SimpleNamed do
4
+ before :each do
5
+ @layout = Zlog::Layouts.named
6
+ @logger = Logging.logger["main"]
7
+ end
8
+
9
+ def event level, data = "yelloo"
10
+ Logging::LogEvent.new("SpecLog", level, data, nil)
11
+ end
12
+
13
+ def format level, data = "yelloo"
14
+ @layout.format(event(level, data))
15
+ end
16
+
17
+ def pattern_for name, data = "yelloo", logger = "SpecLog"
18
+ (Zlog::Layouts::SimpleCore::STDOUT_PATTERN_256COLORS[:name] % logger) +
19
+ (Zlog::Layouts::SimpleCore::STDOUT_PATTERN_256COLORS[name] % data)
20
+ end
21
+
22
+ it "can be initialized via simple method" do
23
+ Zlog::Layouts.named.must_be_instance_of Zlog::Layouts::SimpleNamed
24
+ end
25
+
26
+ it "must add debug events" do
27
+ format(0).must_equal (pattern_for :debug) + "\n"
28
+ end
29
+
30
+ it "must add info events" do
31
+ format(1).must_equal (pattern_for :info) + "\n"
32
+ end
33
+
34
+ it "must add warning events" do
35
+ format(2).must_equal (pattern_for :warning) + "\n"
36
+ end
37
+
38
+ it "must add error events" do
39
+ format(3).must_equal (pattern_for :error) + "\n"
40
+ end
41
+
42
+ it "must add fatal events" do
43
+ format(4).must_equal (pattern_for :fatal) + "\n"
44
+ end
45
+
46
+ it "must add ok events" do
47
+ format(5).must_equal (pattern_for :ok) + "\n"
48
+ end
49
+
50
+ it "must add section events" do
51
+ format(6).must_equal (pattern_for :section) + "\n"
52
+ end
53
+
54
+ it "must support continuous loggin, 1 step" do
55
+ (format(1, @logger.cont("conti"))).
56
+ must_equal "\r" + (pattern_for :info, "conti")
57
+ end
58
+
59
+ it "must support continuous logging, 1 step + normal" do
60
+ (format(1, @logger.cont("conti")) + format(1)).
61
+ must_equal "\r" + (pattern_for :info, "conti") + "\n" + (pattern_for :info) + "\n"
62
+ end
63
+
64
+ it "must support continuous logging, 2 steps + normal" do
65
+ c = format(1, @logger.cont("conti"))
66
+ oc = (pattern_for :info, "conti")
67
+ ( c + c + format(1)).
68
+ must_equal "\r" + oc + "\r" + oc + "\n" + (pattern_for :info) + "\n"
69
+ end
70
+ end
@@ -0,0 +1,7 @@
1
+ require 'minitest_helper'
2
+
3
+ describe Zlog do
4
+ it "can initialize itself to STDOUT" do
5
+ Zlog.must_respond_to :init_stdout
6
+ end
7
+ end
@@ -0,0 +1,21 @@
1
+ require 'minitest/autorun'
2
+ require 'zlog'
3
+
4
+ begin
5
+ require 'turn'
6
+ Turn.config do |c|
7
+ # use one of output formats:
8
+ # :outline - turn's original case/test outline mode [default]
9
+ # :progress - indicates progress with progress bar
10
+ # :dotted - test/unit's traditional dot-progress mode
11
+ # :pretty - new pretty reporter
12
+ # :marshal - dump output as YAML (normal run mode only)
13
+ # :cue - interactive testing
14
+ c.format = :pretty
15
+ # turn on invoke/execute tracing, enable full backtrace
16
+ # c.trace = true
17
+ # use humanized test names (works only with :outline format)
18
+ c.natural = true
19
+ end
20
+ rescue LoadError
21
+ end
data/zlog.gemspec ADDED
@@ -0,0 +1,22 @@
1
+ lib = File.expand_path('../lib/', __FILE__)
2
+ $:.unshift lib unless $:.include?(lib)
3
+ require 'zlog'
4
+
5
+ spec = Gem::Specification.new do |s|
6
+ s.name = 'zlog'
7
+ s.version = Zlog::VERSION
8
+ s.platform = Gem::Platform::RUBY
9
+ s.summary = "rudimentary simple logging for ruby"
10
+ s.description = s.summary
11
+ s.author = "Dominik Richter"
12
+ s.email = "dominik.richter@googlemail.com"
13
+ s.licenses = ["MPLv2"]
14
+ s.homepage = "https://github.com/arlimus/zlog"
15
+ s.required_ruby_version = '>= 1.9.3'
16
+
17
+ s.add_dependency 'logging', '~> 1.8.1'
18
+
19
+ s.files = `git ls-files`.split("\n")
20
+ s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
21
+ s.require_paths = ["lib"]
22
+ end
metadata ADDED
@@ -0,0 +1,79 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: zlog
3
+ version: !ruby/object:Gem::Version
4
+ version: '0.6'
5
+ platform: ruby
6
+ authors:
7
+ - Dominik Richter
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2013-10-05 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: logging
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: 1.8.1
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: 1.8.1
27
+ description: rudimentary simple logging for ruby
28
+ email: dominik.richter@googlemail.com
29
+ executables: []
30
+ extensions: []
31
+ extra_rdoc_files: []
32
+ files:
33
+ - .gitignore
34
+ - .travis.yml
35
+ - CHANGELOG.md
36
+ - Gemfile
37
+ - LICENSE
38
+ - README.md
39
+ - Rakefile
40
+ - example/example.output.png
41
+ - example/example.rb
42
+ - lib/zlog.rb
43
+ - lib/zlog/layouts.rb
44
+ - lib/zlog/logging.rb
45
+ - lib/zlog/simple_layouts.rb
46
+ - lib/zlog/zlog.rb
47
+ - test/classes/logger_spec.rb
48
+ - test/classes/zlog_layouts_simple_spec.rb
49
+ - test/classes/zlog_layouts_simplecore_spec.rb
50
+ - test/classes/zlog_layouts_simplenamed_spec.rb
51
+ - test/classes/zlog_spec.rb
52
+ - test/minitest_helper.rb
53
+ - zlog.gemspec
54
+ homepage: https://github.com/arlimus/zlog
55
+ licenses:
56
+ - MPLv2
57
+ metadata: {}
58
+ post_install_message:
59
+ rdoc_options: []
60
+ require_paths:
61
+ - lib
62
+ required_ruby_version: !ruby/object:Gem::Requirement
63
+ requirements:
64
+ - - '>='
65
+ - !ruby/object:Gem::Version
66
+ version: 1.9.3
67
+ required_rubygems_version: !ruby/object:Gem::Requirement
68
+ requirements:
69
+ - - '>='
70
+ - !ruby/object:Gem::Version
71
+ version: '0'
72
+ requirements: []
73
+ rubyforge_project:
74
+ rubygems_version: 2.0.3
75
+ signing_key:
76
+ specification_version: 4
77
+ summary: rudimentary simple logging for ruby
78
+ test_files: []
79
+ has_rdoc: