itz_logger 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +8 -0
- data/.tool-versions +1 -0
- data/.travis.yml +5 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/LICENSE.txt +21 -0
- data/README.md +43 -0
- data/Rakefile +10 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/itz_logger.gemspec +36 -0
- data/lib/itz_logger/formatter.rb +18 -0
- data/lib/itz_logger/log_strategy.rb +11 -0
- data/lib/itz_logger/log_terminal.rb +28 -0
- data/lib/itz_logger/logger.rb +50 -0
- data/lib/itz_logger/message.rb +26 -0
- data/lib/itz_logger/message_type.rb +24 -0
- data/lib/itz_logger/version.rb +3 -0
- data/lib/itz_logger.rb +5 -0
- metadata +106 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 1719138a3b2a5606d96fd6ed08c9792c294a923e6a9125b86bd06d2c852df851
|
4
|
+
data.tar.gz: 7c6707c5939ec37d2d6733f791729d7355150bd94192c1820a9490b2244962cc
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 0e6c25c4c92cb34e30e69efc30f1bcdb2e0e20fb627eda7da862966c807ba94efe86ea3af5016026efc9c29c8a1d0b2b7e249180b2e9e730dca2df068dfc88d3
|
7
|
+
data.tar.gz: 06300acd4025308fbc76cc8df1e2d6acf08168b7e648d1137dbdcebedf5d8d3d4f2107c041675f1728972ae185dc424bc8a1bda4473ca5b98d00c891aadc0f3e
|
data/.gitignore
ADDED
data/.tool-versions
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
ruby 2.5.1
|
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at michael.schaarschmidt@itz.uni-halle.de. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2018 Michael Schaarschmidt
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,43 @@
|
|
1
|
+
# ItzLogger
|
2
|
+
|
3
|
+
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/itz_logger`. To experiment with that code, run `bin/console` for an interactive prompt.
|
4
|
+
|
5
|
+
TODO: Delete this and the text above, and describe your gem
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'itz_logger'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install itz_logger
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
TODO: Write usage instructions here
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
30
|
+
|
31
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/schaary/itz_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
36
|
+
|
37
|
+
## License
|
38
|
+
|
39
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
40
|
+
|
41
|
+
## Code of Conduct
|
42
|
+
|
43
|
+
Everyone interacting in the ItzLogger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/schaary/itz_logger/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "itz_logger"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/itz_logger.gemspec
ADDED
@@ -0,0 +1,36 @@
|
|
1
|
+
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "itz_logger/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "itz_logger"
|
8
|
+
spec.version = ItzLogger::VERSION
|
9
|
+
spec.authors = ["Michael Schaarschmidt"]
|
10
|
+
spec.email = ["michael.schaarschmidt@itz.uni-halle.de"]
|
11
|
+
|
12
|
+
spec.summary = "Ruby logging service"
|
13
|
+
spec.description = " Ruby logging service"
|
14
|
+
spec.homepage = ""
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
18
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
19
|
+
if spec.respond_to?(:metadata)
|
20
|
+
spec.metadata["allowed_push_host"] = "https://rubygems.org"
|
21
|
+
else
|
22
|
+
raise "RubyGems 2.0 or newer is required to protect against " \
|
23
|
+
"public gem pushes."
|
24
|
+
end
|
25
|
+
|
26
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
27
|
+
f.match(%r{^(test|spec|features)/})
|
28
|
+
end
|
29
|
+
spec.bindir = "exe"
|
30
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
31
|
+
spec.require_paths = ["lib"]
|
32
|
+
|
33
|
+
spec.add_development_dependency "bundler", "~> 1.16"
|
34
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
35
|
+
spec.add_development_dependency "minitest", "~> 5.0"
|
36
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
|
2
|
+
# Basic formating of messages
|
3
|
+
#
|
4
|
+
# The formatter sets a template around the message, to show the message
|
5
|
+
# type, a timestamp and maybe some coloring additional to the core of
|
6
|
+
# the message
|
7
|
+
|
8
|
+
module ItzLogger
|
9
|
+
class Formatter
|
10
|
+
|
11
|
+
def self.format(message)
|
12
|
+
puts "#{message.type.to_s.upcase} |" +
|
13
|
+
" #{message.created_at} |" +
|
14
|
+
" #{message.message}"
|
15
|
+
end
|
16
|
+
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,28 @@
|
|
1
|
+
|
2
|
+
require_relative "./message"
|
3
|
+
require_relative "./formatter"
|
4
|
+
|
5
|
+
module ItzLogger
|
6
|
+
class LogTerminal
|
7
|
+
|
8
|
+
@log_level = nil
|
9
|
+
|
10
|
+
attr_reader :log_level
|
11
|
+
|
12
|
+
def initialize(log_level = ItzLogger::MessageType::INFO)
|
13
|
+
@log_level = log_level
|
14
|
+
end
|
15
|
+
|
16
|
+
def write(log_level, message)
|
17
|
+
return nil if !ItzLogger::MessageType.equals(@log_level, log_level)
|
18
|
+
message = ItzLogger::Message.new(message, log_level)
|
19
|
+
ItzLogger::Formatter.format(message)
|
20
|
+
end
|
21
|
+
|
22
|
+
def log_level=(log_level)
|
23
|
+
if ItzLogger::MessageType::TYPES.include?(log_level)
|
24
|
+
@log_level = log_level
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
@@ -0,0 +1,50 @@
|
|
1
|
+
|
2
|
+
require_relative "./log_terminal"
|
3
|
+
require_relative "./log_strategy"
|
4
|
+
|
5
|
+
module ItzLogger
|
6
|
+
|
7
|
+
class Logger
|
8
|
+
|
9
|
+
@log_strategy = nil
|
10
|
+
|
11
|
+
def initialize(log_level, strategy)
|
12
|
+
|
13
|
+
case strategy
|
14
|
+
when ItzLogger::LogStrategy::LOG_TERMINAL
|
15
|
+
@log_strategy = ItzLogger::LogTerminal.new(log_level)
|
16
|
+
else
|
17
|
+
@log_strategy = ItzLogger::LogTerminal.new(log_level)
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
def write(log_level, message)
|
22
|
+
@log_strategy.write(log_level, message)
|
23
|
+
end
|
24
|
+
|
25
|
+
def info(message)
|
26
|
+
@log_strategy.write(ItzLogger::MessageType::INFO, message)
|
27
|
+
end
|
28
|
+
|
29
|
+
def warn(message)
|
30
|
+
@log_strategy.write(ItzLogger::MessageType::WARN, message)
|
31
|
+
end
|
32
|
+
|
33
|
+
def debug(message)
|
34
|
+
@log_strategy.write(ItzLogger::MessageType::DEBUG, message)
|
35
|
+
end
|
36
|
+
|
37
|
+
def verbose(message)
|
38
|
+
@log_strategy.write(ItzLogger::MessageType::VERBOSE, message)
|
39
|
+
end
|
40
|
+
|
41
|
+
def log_level=(log_level)
|
42
|
+
@log_strategy.log_level = log_level
|
43
|
+
end
|
44
|
+
|
45
|
+
def log_level
|
46
|
+
@log_strategy.log_level
|
47
|
+
end
|
48
|
+
|
49
|
+
end
|
50
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
|
2
|
+
# The core message class
|
3
|
+
#
|
4
|
+
# The message class encapsulates a message. It creates a read-only created_at
|
5
|
+
# timestamp in utc.
|
6
|
+
|
7
|
+
require "securerandom"
|
8
|
+
|
9
|
+
require_relative "./message_type"
|
10
|
+
|
11
|
+
module ItzLogger
|
12
|
+
|
13
|
+
class Message
|
14
|
+
|
15
|
+
attr_reader :id, :message, :type, :created_at
|
16
|
+
|
17
|
+
def initialize(message, type = ItzLogger::MessageType::INFO)
|
18
|
+
|
19
|
+
@id = SecureRandom.uuid
|
20
|
+
@message = message
|
21
|
+
@type = type
|
22
|
+
@created_at = Time.now.utc
|
23
|
+
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
|
2
|
+
# Types of the log messages
|
3
|
+
|
4
|
+
module ItzLogger
|
5
|
+
class MessageType
|
6
|
+
INFO = :info
|
7
|
+
DEBUG = :debug
|
8
|
+
WARN = :warn
|
9
|
+
VERBOSE = :verbose
|
10
|
+
|
11
|
+
TYPES = [INFO, DEBUG ,WARN, VERBOSE]
|
12
|
+
|
13
|
+
@hierarchies = [
|
14
|
+
info: [:info],
|
15
|
+
debug: [:info, :debug],
|
16
|
+
warn: [:info, :debug, :warn],
|
17
|
+
verbose: [:info, :debug, :warn, :verbose]
|
18
|
+
]
|
19
|
+
|
20
|
+
def self.equals(current_level, message_type)
|
21
|
+
@hierarchies[0][current_level].include?(message_type)
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
data/lib/itz_logger.rb
ADDED
metadata
ADDED
@@ -0,0 +1,106 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: itz_logger
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Michael Schaarschmidt
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-08-20 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.16'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.16'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: minitest
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '5.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '5.0'
|
55
|
+
description: " Ruby logging service"
|
56
|
+
email:
|
57
|
+
- michael.schaarschmidt@itz.uni-halle.de
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- ".gitignore"
|
63
|
+
- ".tool-versions"
|
64
|
+
- ".travis.yml"
|
65
|
+
- CODE_OF_CONDUCT.md
|
66
|
+
- Gemfile
|
67
|
+
- LICENSE.txt
|
68
|
+
- README.md
|
69
|
+
- Rakefile
|
70
|
+
- bin/console
|
71
|
+
- bin/setup
|
72
|
+
- itz_logger.gemspec
|
73
|
+
- lib/itz_logger.rb
|
74
|
+
- lib/itz_logger/formatter.rb
|
75
|
+
- lib/itz_logger/log_strategy.rb
|
76
|
+
- lib/itz_logger/log_terminal.rb
|
77
|
+
- lib/itz_logger/logger.rb
|
78
|
+
- lib/itz_logger/message.rb
|
79
|
+
- lib/itz_logger/message_type.rb
|
80
|
+
- lib/itz_logger/version.rb
|
81
|
+
homepage: ''
|
82
|
+
licenses:
|
83
|
+
- MIT
|
84
|
+
metadata:
|
85
|
+
allowed_push_host: https://rubygems.org
|
86
|
+
post_install_message:
|
87
|
+
rdoc_options: []
|
88
|
+
require_paths:
|
89
|
+
- lib
|
90
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
91
|
+
requirements:
|
92
|
+
- - ">="
|
93
|
+
- !ruby/object:Gem::Version
|
94
|
+
version: '0'
|
95
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
96
|
+
requirements:
|
97
|
+
- - ">="
|
98
|
+
- !ruby/object:Gem::Version
|
99
|
+
version: '0'
|
100
|
+
requirements: []
|
101
|
+
rubyforge_project:
|
102
|
+
rubygems_version: 2.7.6
|
103
|
+
signing_key:
|
104
|
+
specification_version: 4
|
105
|
+
summary: Ruby logging service
|
106
|
+
test_files: []
|