noddy 0.0.2
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 +48 -0
- data/Rakefile +1 -0
- data/lib/noddy/constants.rb +15 -0
- data/lib/noddy/string.rb +39 -0
- data/lib/noddy/version.rb +3 -0
- data/lib/noddy.rb +54 -0
- data/noddy.gemspec +23 -0
- metadata +89 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 Dave Avent
|
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,48 @@
|
|
1
|
+
# Noddy
|
2
|
+
|
3
|
+
Noddy Logger is a very simple library to quickly outputs from your scripts and applications.
|
4
|
+
|
5
|
+
This is very much a work in progress, but is still usable.
|
6
|
+
|
7
|
+
TODO:
|
8
|
+
|
9
|
+
- Specify log output e.g. STDERR, STDOUT, File
|
10
|
+
- Sepcifiy log format
|
11
|
+
|
12
|
+
## Installation
|
13
|
+
|
14
|
+
Add this line to your application's Gemfile:
|
15
|
+
|
16
|
+
gem 'noddy'
|
17
|
+
|
18
|
+
And then execute:
|
19
|
+
|
20
|
+
$ bundle
|
21
|
+
|
22
|
+
Or install it yourself as:
|
23
|
+
|
24
|
+
$ gem install noddy
|
25
|
+
|
26
|
+
## Usage
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require "noddy"
|
30
|
+
|
31
|
+
Noddy.log_level = Noddy::DEBUG # Default: Noddy::INFO
|
32
|
+
Noddy.colour = true # Default: false
|
33
|
+
Noddy.timestamp = false # Default: true
|
34
|
+
|
35
|
+
Noddy.debug "I am just a debug message"
|
36
|
+
Noddy.info "I am an info message"
|
37
|
+
Noddy.warning "I am a warning message"
|
38
|
+
Noddy.error "I am am error message"
|
39
|
+
Noddy.critical "Oh dear, I am a critical message"
|
40
|
+
```
|
41
|
+
|
42
|
+
## Contributing
|
43
|
+
|
44
|
+
1. Fork it ( http://github.com/<my-github-username>/noddy/fork )
|
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
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/lib/noddy/string.rb
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
class String
|
2
|
+
|
3
|
+
def colour!( log_level )
|
4
|
+
replace colour log_level
|
5
|
+
end
|
6
|
+
|
7
|
+
def colour( log_level = @colour )
|
8
|
+
case log_level
|
9
|
+
when Noddy::DEBUG
|
10
|
+
@colour = "\e[0;34m" # blue
|
11
|
+
when Noddy::INFO
|
12
|
+
@colour = "\e[0;32m" # green
|
13
|
+
when Noddy::WARNING
|
14
|
+
@colour = "\e[0;33m" # yellow
|
15
|
+
when Noddy::ERROR
|
16
|
+
@colour = "\e[0;31m" # red
|
17
|
+
when Noddy::CRITICAL
|
18
|
+
@colour = "\e[0;35m" # magenta
|
19
|
+
else
|
20
|
+
@colour = "\e[0;37m" # white
|
21
|
+
end
|
22
|
+
@end_colour = "\e[0m"
|
23
|
+
|
24
|
+
@colour + self + @end_colour
|
25
|
+
end
|
26
|
+
|
27
|
+
def timestamp!
|
28
|
+
replace timestamp
|
29
|
+
end
|
30
|
+
|
31
|
+
def timestamp
|
32
|
+
if @colour
|
33
|
+
@colour + '[' + Time.now.to_s + '] ' + self + @end_colour
|
34
|
+
else
|
35
|
+
'[' + Time.now.to_s + '] ' + self
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
end
|
data/lib/noddy.rb
ADDED
@@ -0,0 +1,54 @@
|
|
1
|
+
require "noddy/version"
|
2
|
+
require "noddy/constants"
|
3
|
+
require "noddy/string"
|
4
|
+
|
5
|
+
module Noddy
|
6
|
+
class << self
|
7
|
+
def log_level=( level )
|
8
|
+
@level = level
|
9
|
+
end
|
10
|
+
|
11
|
+
def log_message( msg )
|
12
|
+
level = @level || DEFAULT_LEVEL
|
13
|
+
end
|
14
|
+
|
15
|
+
def self.debug( msg )
|
16
|
+
log_message( msg, DEBUG )
|
17
|
+
end
|
18
|
+
|
19
|
+
def info( msg )
|
20
|
+
log_message( msg, INFO )
|
21
|
+
end
|
22
|
+
|
23
|
+
def warning( msg )
|
24
|
+
log_message( msg, WARNING )
|
25
|
+
end
|
26
|
+
|
27
|
+
def error( msg )
|
28
|
+
log_message( msg, ERROR )
|
29
|
+
end
|
30
|
+
|
31
|
+
def critical( msg )
|
32
|
+
log_message( msg, CRITICAL )
|
33
|
+
end
|
34
|
+
|
35
|
+
|
36
|
+
def colour=( colour )
|
37
|
+
@colour = colour
|
38
|
+
end
|
39
|
+
|
40
|
+
def timestamp=( timestamp )
|
41
|
+
@timestamp = timestamp
|
42
|
+
end
|
43
|
+
|
44
|
+
private
|
45
|
+
def log_message( msg, level )
|
46
|
+
|
47
|
+
msg.colour!( level ) if @colour || COLOUR_DEFAULT
|
48
|
+
|
49
|
+
msg.timestamp! if @timestamp || TIMESTAMP_DEFAULT
|
50
|
+
|
51
|
+
puts msg if level <= @level
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
data/noddy.gemspec
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'noddy/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "noddy"
|
8
|
+
spec.version = Noddy::VERSION
|
9
|
+
spec.authors = ["Dave Avent"]
|
10
|
+
spec.email = ["davent@lumux.co.uk"]
|
11
|
+
spec.summary = %q{Noddy Logger logging library.}
|
12
|
+
spec.description = %q{Noddy Logger is a very simple library to quickly output logs from your scripts and applications using colours, timestamps etc.}
|
13
|
+
spec.homepage = "https://github.com/davent/noddy"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.5"
|
22
|
+
spec.add_development_dependency "rake"
|
23
|
+
end
|
metadata
ADDED
@@ -0,0 +1,89 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: noddy
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.2
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Dave Avent
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2014-07-10 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '1.5'
|
22
|
+
type: :development
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '1.5'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: rake
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
type: :development
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '0'
|
46
|
+
description: Noddy Logger is a very simple library to quickly output logs from your
|
47
|
+
scripts and applications using colours, timestamps etc.
|
48
|
+
email:
|
49
|
+
- davent@lumux.co.uk
|
50
|
+
executables: []
|
51
|
+
extensions: []
|
52
|
+
extra_rdoc_files: []
|
53
|
+
files:
|
54
|
+
- .gitignore
|
55
|
+
- Gemfile
|
56
|
+
- LICENSE.txt
|
57
|
+
- README.md
|
58
|
+
- Rakefile
|
59
|
+
- lib/noddy.rb
|
60
|
+
- lib/noddy/constants.rb
|
61
|
+
- lib/noddy/string.rb
|
62
|
+
- lib/noddy/version.rb
|
63
|
+
- noddy.gemspec
|
64
|
+
homepage: https://github.com/davent/noddy
|
65
|
+
licenses:
|
66
|
+
- MIT
|
67
|
+
post_install_message:
|
68
|
+
rdoc_options: []
|
69
|
+
require_paths:
|
70
|
+
- lib
|
71
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
72
|
+
none: false
|
73
|
+
requirements:
|
74
|
+
- - ! '>='
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: '0'
|
77
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
78
|
+
none: false
|
79
|
+
requirements:
|
80
|
+
- - ! '>='
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
requirements: []
|
84
|
+
rubyforge_project:
|
85
|
+
rubygems_version: 1.8.23
|
86
|
+
signing_key:
|
87
|
+
specification_version: 3
|
88
|
+
summary: Noddy Logger logging library.
|
89
|
+
test_files: []
|