optional_logger 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1fac6b9d6d29180865ac0937c8c39f86c716af25
-  data.tar.gz: 3f70c78f17966bad92edbe300ec90d27491f5a8b
+SHA256:
+  metadata.gz: 70264edb7234d677c984a9ced39cc95eede2375bd912a2103921f3f77aa68baf
+  data.tar.gz: 3b5ebe069df89f3342aff5d800decd9f2ee95d7a342fc0bdc1bebec714294514
 SHA512:
-  metadata.gz: e5ce7f7db093856ecdf3f0c22d61876baff65597cb30310a91e6b75b43febe323a1ba72b60ed604eca08a6f621e133581aeb88c0f3ec09a50e6d7a322b7d1e31
-  data.tar.gz: 324833b641124a2c9bf694d1a81b7a4230497cbe25e2b6ed54d066954d98ee0f033970c7072277d8ab12dae3dea96c5b535443687df6988e043b25c3dba0c13f
+  metadata.gz: 654c1d134b2adf2f8888176d424c7d5383869b99184dbe71a11909e67907a21e5b717bcc4dc94cff7f4585300a2b9f816603371a3ea18d1c993cb8a69be40cff
+  data.tar.gz: 562e509789c3cb4e87125b92af7593846e6df4acefe946509f2c59d97a2d91b02e2182b200859ba932b385a1d6379e1d79928b54e0061738656fb7978661aea6

data/.ruby-version

@@ -0,0 +1 @@
+3.3.3

data/.travis.yml

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

data/CHANGELOG.md

@@ -2,15 +2,23 @@
 
 The following are lists of the notable changes included with each release.
 This is intended to help keep people informed about notable changes between
-versions, as well as provide a rough history.
+versions, as well as provide a rough history. Each item is prefixed with
+one of the following labels: `Added`, `Changed`, `Deprecated`,
+`Removed`, `Fixed`, `Security`. We also use [Semantic
+Versioning](http://semver.org) to manage the versions of this gem so
+that you can set version constraints properly.
 
 #### Next Release
 
-#### v1.1.0
+#### [v2.0.0] - 2016-10-24
+
+* Changed logger management to work at class or instance level
+
+#### [v1.1.0] - 2016-10-18
 
 * Added logger management module
 
-#### v1.0.0
+#### [v1.0.0] - 2016-10-11
 
 * Added documentation around all the classes, modules, constants and methods
 * Added OptionalLogger::Logger level introspection methods (#debug?, #info?,
@@ -20,3 +28,8 @@ versions, as well as provide a rough history.
 * Added OptionalLogger::Logger#add and #log methods
 * Added OptionalLogger::Logger class and constructor
 * Added OptionalLogger module skeleton
+
+[Unreleased]: https://github.com/Acornsgrow/optional_logger/compare/v2.0.0...HEAD
+[v2.0.0]: https://github.com/Acornsgrow/optional_logger/compare/v1.1.0...v2.0.0
+[v1.1.0]: https://github.com/Acornsgrow/optional_logger/compare/v1.0.0...v1.1.0
+[v1.0.0]: https://github.com/Acornsgrow/optional_logger/compare/d377eb0...v1.0.0

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
 
-gem "codeclimate-test-reporter", group: :test, require: nil
-
 # Specify your gem's dependencies in optional_logger.gemspec
 gemspec

data/README.md

@@ -1,9 +1,3 @@
-[![Build Status](https://travis-ci.org/Acornsgrow/optional_logger.svg?branch=master)](https://travis-ci.org/Acornsgrow/optional_logger)
-[![Code Climate](https://codeclimate.com/github/Acornsgrow/optional_logger/badges/gpa.svg)](https://codeclimate.com/github/Acornsgrow/optional_logger)
-[![Test Coverage](https://codeclimate.com/github/Acornsgrow/optional_logger/badges/coverage.svg)](https://codeclimate.com/github/Acornsgrow/optional_logger/coverage)
-[![Issue Count](https://codeclimate.com/github/Acornsgrow/optional_logger/badges/issue_count.svg)](https://codeclimate.com/github/Acornsgrow/optional_logger)
-[![Inline docs](http://inch-ci.org/github/Acornsgrow/optional_logger.svg?branch=master)](http://inch-ci.org/github/Acornsgrow/optional_logger)
-
 # OptionalLogger
 
 Easily support application loggers in your gems.
@@ -36,7 +30,7 @@ accidentally altering the applications logger.
 Add this line to your gem's gemspec file:
 
 ```ruby
-spec.add_dependency 'optional_logger', '~> 1.1'
+spec.add_dependency 'optional_logger', '~> 2.0'
 ```
 
 Or install it yourself as:
@@ -95,14 +89,18 @@ logger as it is managed by the application that is using your library.
 
 We also provide a small module to aid with logger management within your gem if
 you don't want to write your own logger management using the core logger
-provided above. The following is an example of how might use it if you had a gem
-called `my_foo_gem`.
+provided above. The following are a couple examples of how you might use it.
+
+#### Module/Class Level
+
+If you want to provide the logger interface at a Module/Class level. You would
+do the following.
 
 ```ruby
 require 'optional_logger'
 
 module MyFooGem
-  include OptionalLogger::LoggerManagement
+  extend OptionalLogger::LoggerManagement
 end
 ```
 
@@ -117,6 +115,41 @@ the application logger they provided within your gem as follows.
 
 ```ruby
 MyFooGem.logger # => the optional logger wrapping some_application_logger
+
+# or if you are inside the module
+
+self.logger # or simply logger
+```
+
+#### Instance Level
+
+If you want to provide the logger interface at an instance level. You would do
+the following.
+
+```ruby
+require 'optional_logger'
+
+module MyClass
+  include OptionalLogger::LoggerManagement
+end
+```
+
+The above would enable consumers of your library to set the logger as follows.
+
+```ruby
+obj = MyClass.new
+obj.logger(some_application_logger)
+```
+
+It also enables you to access an `OptionalLogger::Logger` instance that wraps
+the application logger they provided within your gem as follows.
+
+```ruby
+obj.logger # => the optional logger wrapping some_application_logger
+
+# or if you are inside the class
+
+self.logger # or simply logger
 ```
 
 ## Development

data/lib/optional_logger/logger_management.rb

@@ -2,15 +2,9 @@ require 'optional_logger'
 
 module OptionalLogger
   module LoggerManagement
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      def logger(logger = nil)
-        return @logger if @logger && logger.nil?
-        @logger = OptionalLogger::Logger.new(logger)
-      end
+    def logger(logger = nil)
+      return @logger if @logger && logger.nil?
+      @logger = OptionalLogger::Logger.new(logger)
     end
   end
 end

data/lib/optional_logger/version.rb

@@ -1,4 +1,4 @@
 module OptionalLogger
   # The version of the library
-  VERSION = "1.1.0"
+  VERSION = "2.1.0"
 end

data/optional_logger.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   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.homepage      = "http://github.com/drewdeponte/optional_logger"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "bundler", "~> 2.5"
+  spec.add_development_dependency "rake", "~> 13.2"
+  spec.add_development_dependency "rspec", "~> 3.13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optional_logger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Andrew De Ponte
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2024-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
 description: Logger proxy to handle optionality of presence of a logger
 email:
 - cyphactor@gmail.com
@@ -59,9 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -76,11 +76,11 @@ files:
 - lib/optional_logger/logger_management.rb
 - lib/optional_logger/version.rb
 - optional_logger.gemspec
-homepage: http://github.com/Acornsgrow/optional_logger
+homepage: http://github.com/drewdeponte/optional_logger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.5.14
+signing_key:
 specification_version: 4
 summary: Logger proxy to handle optionality of presence of a logger
 test_files: []

data/.codeclimate.yml

@@ -1,9 +0,0 @@
----
-engines:
-  fixme:
-    enabled: true
-  rubcop:
-    enabled: true
-ratings:
-  paths:
-  - "lib/**/*"