fiedl-log 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 +9 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +78 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/fiedl-log.gemspec +27 -0
- data/lib/fiedl/log.rb +12 -0
- data/lib/fiedl/log/log.rb +43 -0
- data/lib/fiedl/log/version.rb +5 -0
- metadata +113 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: c4e782e673e205f0b33c45c64b4770f8f36c28ca
|
4
|
+
data.tar.gz: fe5b2363a8969ae792ec64b76d00e8e96165dec6
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: f1f0777da381db3ad3620c3dab2c010a4e32642483cbd0d3262f7deacb5037bd4d0971fd437c99d8edaecb18674fbe46581991a0040b1aa8f6d516ab83c20840
|
7
|
+
data.tar.gz: 650e7588e9dbe262dfee9b75518f5aa83920d3e329816448eee3832afc941aa6bf2d0e59e8fc87552560d7f376867217c4df59c3814a6a78f98a08b1e1664d89
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 Sebastian Fiedlschuster
|
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,78 @@
|
|
1
|
+
# Fiedl::Log
|
2
|
+
|
3
|
+
Simple colored output helper for ruby scripts.
|
4
|
+
|
5
|
+
|
6
|
+
## Installation
|
7
|
+
|
8
|
+
Add this line to your application's Gemfile:
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
gem 'fiedl-log'
|
12
|
+
```
|
13
|
+
|
14
|
+
And then execute:
|
15
|
+
|
16
|
+
$ bundle
|
17
|
+
|
18
|
+
Or install it yourself as:
|
19
|
+
|
20
|
+
$ gem install fiedl-log
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
# ~/some_ruby_script.rb
|
26
|
+
require 'fiedl/log'
|
27
|
+
|
28
|
+
log.head "Awesome script"
|
29
|
+
log.section "Checking dependencies"
|
30
|
+
log.info "Checking if all dependencies are met."
|
31
|
+
log.success "Ok"
|
32
|
+
|
33
|
+
log.section "Checking deprecations"
|
34
|
+
log.warning "This does not work much longer ..."
|
35
|
+
|
36
|
+
log.section "Checking other stuff"
|
37
|
+
log.error "This script does nothing, yet."
|
38
|
+
raise "This script does nothing, yet, sorry!"
|
39
|
+
```
|
40
|
+
|
41
|
+
### Manually defining a log instance
|
42
|
+
|
43
|
+
This gem defines `log` unless `log` is already defined. But, of course, you may manually instantiate it:
|
44
|
+
|
45
|
+
```ruby
|
46
|
+
# ~/some_ruby_script.rb
|
47
|
+
require 'fiedl/log'
|
48
|
+
|
49
|
+
$log = Fiedl::Log::Log.new
|
50
|
+
```
|
51
|
+
|
52
|
+
### Filtering content
|
53
|
+
|
54
|
+
```ruby
|
55
|
+
# ~/some_ruby_script.rb
|
56
|
+
require 'fiedl/log'
|
57
|
+
|
58
|
+
log.filter_out("my_secret_password")
|
59
|
+
```
|
60
|
+
|
61
|
+
This will filter out any occurance of "my_secret_password" and replace it by "[...]" in the output.
|
62
|
+
|
63
|
+
|
64
|
+
## Development
|
65
|
+
|
66
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
67
|
+
|
68
|
+
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).
|
69
|
+
|
70
|
+
## Contributing
|
71
|
+
|
72
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fiedl-log.
|
73
|
+
|
74
|
+
|
75
|
+
## License
|
76
|
+
|
77
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
78
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "fiedl/log"
|
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
|
data/bin/setup
ADDED
data/fiedl-log.gemspec
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'fiedl/log/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "fiedl-log"
|
8
|
+
spec.version = Fiedl::Log::VERSION
|
9
|
+
spec.authors = ["Sebastian Fiedlschuster"]
|
10
|
+
spec.email = ["sebastian@fiedlschuster.de"]
|
11
|
+
|
12
|
+
spec.summary = %q{Simple colored output helper for ruby scripts.}
|
13
|
+
spec.description = spec.summary
|
14
|
+
spec.homepage = "https://github.com/fiedl/fiedl-log"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
18
|
+
f.match(%r{^(test|spec|features)/})
|
19
|
+
end
|
20
|
+
spec.require_paths = ["lib"]
|
21
|
+
|
22
|
+
spec.add_development_dependency "bundler", "~> 1.13"
|
23
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
24
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
25
|
+
|
26
|
+
spec.add_dependency "colored"
|
27
|
+
end
|
data/lib/fiedl/log.rb
ADDED
@@ -0,0 +1,43 @@
|
|
1
|
+
class Fiedl::Log::Log
|
2
|
+
def head(text)
|
3
|
+
info ""
|
4
|
+
info "==========================================================".blue
|
5
|
+
info text.blue
|
6
|
+
info "==========================================================".blue
|
7
|
+
end
|
8
|
+
def section(heading)
|
9
|
+
info ""
|
10
|
+
info heading.blue
|
11
|
+
info "----------------------------------------------------------".blue
|
12
|
+
end
|
13
|
+
def info(text)
|
14
|
+
self.write text
|
15
|
+
end
|
16
|
+
def success(text)
|
17
|
+
self.write text.green
|
18
|
+
end
|
19
|
+
def error(text)
|
20
|
+
self.write text.red
|
21
|
+
end
|
22
|
+
def warning(text)
|
23
|
+
self.write "Warning: ".yellow.bold + text.yellow
|
24
|
+
end
|
25
|
+
def prompt(text)
|
26
|
+
self.write "$ " + text.bold
|
27
|
+
end
|
28
|
+
def write(text)
|
29
|
+
@filter_out ||= []
|
30
|
+
@filter_out.each do |expression|
|
31
|
+
text = text.gsub(expression, "[...]")
|
32
|
+
end
|
33
|
+
print text + "\n"
|
34
|
+
end
|
35
|
+
def filter_out(expression)
|
36
|
+
@filter_out ||= []
|
37
|
+
@filter_out << expression
|
38
|
+
end
|
39
|
+
def filter(expression)
|
40
|
+
filter_out expression
|
41
|
+
end
|
42
|
+
|
43
|
+
end
|
metadata
ADDED
@@ -0,0 +1,113 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fiedl-log
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Sebastian Fiedlschuster
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-11-24 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.13'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.13'
|
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: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: colored
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
description: Simple colored output helper for ruby scripts.
|
70
|
+
email:
|
71
|
+
- sebastian@fiedlschuster.de
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".rspec"
|
78
|
+
- ".travis.yml"
|
79
|
+
- Gemfile
|
80
|
+
- LICENSE.txt
|
81
|
+
- README.md
|
82
|
+
- Rakefile
|
83
|
+
- bin/console
|
84
|
+
- bin/setup
|
85
|
+
- fiedl-log.gemspec
|
86
|
+
- lib/fiedl/log.rb
|
87
|
+
- lib/fiedl/log/log.rb
|
88
|
+
- lib/fiedl/log/version.rb
|
89
|
+
homepage: https://github.com/fiedl/fiedl-log
|
90
|
+
licenses:
|
91
|
+
- MIT
|
92
|
+
metadata: {}
|
93
|
+
post_install_message:
|
94
|
+
rdoc_options: []
|
95
|
+
require_paths:
|
96
|
+
- lib
|
97
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
98
|
+
requirements:
|
99
|
+
- - ">="
|
100
|
+
- !ruby/object:Gem::Version
|
101
|
+
version: '0'
|
102
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
103
|
+
requirements:
|
104
|
+
- - ">="
|
105
|
+
- !ruby/object:Gem::Version
|
106
|
+
version: '0'
|
107
|
+
requirements: []
|
108
|
+
rubyforge_project:
|
109
|
+
rubygems_version: 2.5.1
|
110
|
+
signing_key:
|
111
|
+
specification_version: 4
|
112
|
+
summary: Simple colored output helper for ruby scripts.
|
113
|
+
test_files: []
|