optional_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 354caeb0cca2eda91b7927e823369b519733d69d
+  data.tar.gz: 07589eb6bdf45bf32ac43bf27b1c5141dcbf67d6
+SHA512:
+  metadata.gz: 8ca684990bc9d4015ecf21204ae0819d08ccbb4803aff29a45ff102dcb63cf598cb29c5704d046b9a9710f23b12b264c78fe8afaaca04124df9b8a29844b460f
+  data.tar.gz: 07f03c04e2aa3eb55c8e5bf111d5100c8b494dbc26e95833535226f0adc2618cf8a857e9732e39ceb0b7fd6ef0b8a1c8b5abef5af8f2befa43f616df0f9257d8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cyphactor@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in optional_logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Acorns Grow, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# OptionalLogger
+
+Easily support application loggers in your gems.
+
+**Note:** At the moment the following is what is under HEAVY development. The
+Usage is currently written based on the planned usage. I will remove this notice
+and udpate the Usage documentation once we have finalized the API and release
+v1.0.0.
+
+## Why?
+
+OptionalLogger was built out of the need to be able to easily support logging
+inside of gems while still allowing the application to control the logger.
+
+Generally, applications have to make a few decisions about a particular logger.
+
+1. What log level should it be logging at?
+2. Where should the logger be logging?
+3. What format should this logger log in?
+
+It is impossible for a gem to appropriately make these decisions as they are
+strictly application level concerns that are made when constructing a `Logger`
+instance.
+
+OptionalLogger is a foundational component that enables gems to easily support
+logging through an application managed logger. It does so by allowing the gem
+authors to optionally receive a application managed Logger instance via
+dependency injection and handles the optionality of the logger. This frees the
+gem authors up from having to worry about checking for the existence of the
+logger each time they want to log something. It also protects you from
+accidentally altering the applications logger.
+
+## Installation
+
+Add this line to your gem's gemspec file:
+
+```ruby
+spec.add_dependency 'optional_logger', '~> 0.1'
+```
+
+Or install it yourself as:
+
+```text
+$ gem install optional_logger
+```
+
+## Usage
+
+The assumption with the usage of OptionalLogger is that your gem some how
+receives an application managed Logger instance via dependency injection.
+OptionalLogger does NOT prescribe how you receive the logger. Therefore, the
+following examples will refer to the received application managed logger
+instance as `received_logger`.
+
+```ruby
+require 'optional_logger'
+
+logger = OptionalLogger.new(received_logger)
+
+logger.info("some info log message")
+logger.info("Program Name") { "some expensive info log message" }
+logger.info? # => Returns true if the current severity level allows for the printing of INFO messages.
+
+logger.warn("some warn log message")
+logger.warn("Program Name") { "some expensive warn log message" }
+logger.warn? # => Returns true if the current severity level allows for the printing of WARN messages.
+
+logger.debug("some debug log message")
+logger.debug("Program Name") { "some expensive debug log message" }
+logger.debug? # => Returns true if the current severity level allows for the printing of DEBUG messages.
+
+logger.error("some error log message")
+logger.error("Program Name") { "some expensive error log message" }
+logger.error? # => Returns true if the current severity level allows for the printing of ERROR messages.
+
+logger.fatal("some fatal log message")
+logger.fatal("Program Name") { "some expensive fatal log message" }
+logger.fatal? # => Returns true if the current severity level allows for the printing of FATAL messages.
+
+logger.unknown("some unknown log message")
+logger.unknown("Program Name") { "Some expensive unknown log message" }
+
+logger.add(Logger::FATAL, nil, "Program Name") { "some expensive message" }
+logger.add(Logger::FATAL, "some message", "Program Name")
+
+logger.log(Logger::FATAL, nil, "Program Name") { "some expensive message" }
+logger.log(Logger::FATAL, "some message", "Program Name")
+```
+
+**Note:** You don't have to worry about setting up or cleaning up after the
+logger as it is managed by the application that is using your library.
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/Acornsgrow/optional_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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "optional_logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/optional_logger.rb

@@ -0,0 +1,5 @@
+require "optional_logger/version"
+
+module OptionalLogger
+  # Your code goes here...
+end

data/lib/optional_logger/version.rb

@@ -0,0 +1,3 @@
+module OptionalLogger
+  VERSION = "0.1.0"
+end

data/optional_logger.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'optional_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "optional_logger"
+  spec.version       = OptionalLogger::VERSION
+  spec.authors       = ["Andrew De Ponte"]
+  spec.email         = ["cyphactor@gmail.com"]
+
+  spec.summary       = %q{Logger proxy to handle optionality of presence of a logger}
+  spec.description   = %q{Logger proxy to handle optionality of presence of a logger}
+  spec.homepage      = "http://github.com/Acornsgrow/optional_logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: optional_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew De Ponte
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Logger proxy to handle optionality of presence of a logger
+email:
+- cyphactor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/optional_logger.rb
+- lib/optional_logger/version.rb
+- optional_logger.gemspec
+homepage: http://github.com/Acornsgrow/optional_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Logger proxy to handle optionality of presence of a logger
+test_files: []