optional_logger 0.1.0

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: 354caeb0cca2eda91b7927e823369b519733d69d
4
+ data.tar.gz: 07589eb6bdf45bf32ac43bf27b1c5141dcbf67d6
5
+ SHA512:
6
+ metadata.gz: 8ca684990bc9d4015ecf21204ae0819d08ccbb4803aff29a45ff102dcb63cf598cb29c5704d046b9a9710f23b12b264c78fe8afaaca04124df9b8a29844b460f
7
+ data.tar.gz: 07f03c04e2aa3eb55c8e5bf111d5100c8b494dbc26e95833535226f0adc2618cf8a857e9732e39ceb0b7fd6ef0b8a1c8b5abef5af8f2befa43f616df0f9257d8
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.13.2
@@ -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 cyphactor@gmail.com. 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
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in optional_logger.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Acorns Grow, Inc.
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,116 @@
1
+ # OptionalLogger
2
+
3
+ Easily support application loggers in your gems.
4
+
5
+ **Note:** At the moment the following is what is under HEAVY development. The
6
+ Usage is currently written based on the planned usage. I will remove this notice
7
+ and udpate the Usage documentation once we have finalized the API and release
8
+ v1.0.0.
9
+
10
+ ## Why?
11
+
12
+ OptionalLogger was built out of the need to be able to easily support logging
13
+ inside of gems while still allowing the application to control the logger.
14
+
15
+ Generally, applications have to make a few decisions about a particular logger.
16
+
17
+ 1. What log level should it be logging at?
18
+ 2. Where should the logger be logging?
19
+ 3. What format should this logger log in?
20
+
21
+ It is impossible for a gem to appropriately make these decisions as they are
22
+ strictly application level concerns that are made when constructing a `Logger`
23
+ instance.
24
+
25
+ OptionalLogger is a foundational component that enables gems to easily support
26
+ logging through an application managed logger. It does so by allowing the gem
27
+ authors to optionally receive a application managed Logger instance via
28
+ dependency injection and handles the optionality of the logger. This frees the
29
+ gem authors up from having to worry about checking for the existence of the
30
+ logger each time they want to log something. It also protects you from
31
+ accidentally altering the applications logger.
32
+
33
+ ## Installation
34
+
35
+ Add this line to your gem's gemspec file:
36
+
37
+ ```ruby
38
+ spec.add_dependency 'optional_logger', '~> 0.1'
39
+ ```
40
+
41
+ Or install it yourself as:
42
+
43
+ ```text
44
+ $ gem install optional_logger
45
+ ```
46
+
47
+ ## Usage
48
+
49
+ The assumption with the usage of OptionalLogger is that your gem some how
50
+ receives an application managed Logger instance via dependency injection.
51
+ OptionalLogger does NOT prescribe how you receive the logger. Therefore, the
52
+ following examples will refer to the received application managed logger
53
+ instance as `received_logger`.
54
+
55
+ ```ruby
56
+ require 'optional_logger'
57
+
58
+ logger = OptionalLogger.new(received_logger)
59
+
60
+ logger.info("some info log message")
61
+ logger.info("Program Name") { "some expensive info log message" }
62
+ logger.info? # => Returns true if the current severity level allows for the printing of INFO messages.
63
+
64
+ logger.warn("some warn log message")
65
+ logger.warn("Program Name") { "some expensive warn log message" }
66
+ logger.warn? # => Returns true if the current severity level allows for the printing of WARN messages.
67
+
68
+ logger.debug("some debug log message")
69
+ logger.debug("Program Name") { "some expensive debug log message" }
70
+ logger.debug? # => Returns true if the current severity level allows for the printing of DEBUG messages.
71
+
72
+ logger.error("some error log message")
73
+ logger.error("Program Name") { "some expensive error log message" }
74
+ logger.error? # => Returns true if the current severity level allows for the printing of ERROR messages.
75
+
76
+ logger.fatal("some fatal log message")
77
+ logger.fatal("Program Name") { "some expensive fatal log message" }
78
+ logger.fatal? # => Returns true if the current severity level allows for the printing of FATAL messages.
79
+
80
+ logger.unknown("some unknown log message")
81
+ logger.unknown("Program Name") { "Some expensive unknown log message" }
82
+
83
+ logger.add(Logger::FATAL, nil, "Program Name") { "some expensive message" }
84
+ logger.add(Logger::FATAL, "some message", "Program Name")
85
+
86
+ logger.log(Logger::FATAL, nil, "Program Name") { "some expensive message" }
87
+ logger.log(Logger::FATAL, "some message", "Program Name")
88
+ ```
89
+
90
+ **Note:** You don't have to worry about setting up or cleaning up after the
91
+ logger as it is managed by the application that is using your library.
92
+
93
+ ## Development
94
+
95
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run
96
+ `rake spec` to run the tests. You can also run `bin/console` for an interactive
97
+ prompt that will allow you to experiment.
98
+
99
+ To install this gem onto your local machine, run `bundle exec rake install`. To
100
+ release a new version, update the version number in `version.rb`, and then run
101
+ `bundle exec rake release`, which will create a git tag for the version, push
102
+ git commits and tags, and push the `.gem` file to
103
+ [rubygems.org](https://rubygems.org).
104
+
105
+ ## Contributing
106
+
107
+ Bug reports and pull requests are welcome on GitHub at
108
+ https://github.com/Acornsgrow/optional_logger. This project is intended to be a
109
+ safe, welcoming space for collaboration, and contributors are expected to adhere
110
+ to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
111
+
112
+ ## License
113
+
114
+ The gem is available as open source under the terms of the [MIT
115
+ License](http://opensource.org/licenses/MIT).
116
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "optional_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
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,5 @@
1
+ require "optional_logger/version"
2
+
3
+ module OptionalLogger
4
+ # Your code goes here...
5
+ end
@@ -0,0 +1,3 @@
1
+ module OptionalLogger
2
+ VERSION = "0.1.0"
3
+ end
@@ -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 'optional_logger/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "optional_logger"
8
+ spec.version = OptionalLogger::VERSION
9
+ spec.authors = ["Andrew De Ponte"]
10
+ spec.email = ["cyphactor@gmail.com"]
11
+
12
+ spec.summary = %q{Logger proxy to handle optionality of presence of a logger}
13
+ spec.description = %q{Logger proxy to handle optionality of presence of a logger}
14
+ spec.homepage = "http://github.com/Acornsgrow/optional_logger"
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.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.13"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ end
metadata ADDED
@@ -0,0 +1,99 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: optional_logger
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Andrew De Ponte
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-10-08 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
+ description: Logger proxy to handle optionality of presence of a logger
56
+ email:
57
+ - cyphactor@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
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
+ - lib/optional_logger.rb
73
+ - lib/optional_logger/version.rb
74
+ - optional_logger.gemspec
75
+ homepage: http://github.com/Acornsgrow/optional_logger
76
+ licenses:
77
+ - MIT
78
+ metadata: {}
79
+ post_install_message:
80
+ rdoc_options: []
81
+ require_paths:
82
+ - lib
83
+ required_ruby_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - ">="
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ requirements: []
94
+ rubyforge_project:
95
+ rubygems_version: 2.5.1
96
+ signing_key:
97
+ specification_version: 4
98
+ summary: Logger proxy to handle optionality of presence of a logger
99
+ test_files: []