optional_logger 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fac6b9d6d29180865ac0937c8c39f86c716af25
-  data.tar.gz: 3f70c78f17966bad92edbe300ec90d27491f5a8b
+  metadata.gz: 62568107e4c9f159c14814070e453409e32339f8
+  data.tar.gz: 22acaf432e1f2f0334f47193dc5da8b61a759a17
 SHA512:
-  metadata.gz: e5ce7f7db093856ecdf3f0c22d61876baff65597cb30310a91e6b75b43febe323a1ba72b60ed604eca08a6f621e133581aeb88c0f3ec09a50e6d7a322b7d1e31
-  data.tar.gz: 324833b641124a2c9bf694d1a81b7a4230497cbe25e2b6ed54d066954d98ee0f033970c7072277d8ab12dae3dea96c5b535443687df6988e043b25c3dba0c13f
+  metadata.gz: c1be9cfb63e6e23c961458ccb3f3f31b5d65887ad2d923c45f020c66d54a7dae9f68731718d5570d4c8354e78b0379cdf11917c6997c89ab3f44cffcffcd6118
+  data.tar.gz: f49aa48f270edb72dc4e6ae3bfc9a922627423317da3bdc341990816c049e74bb6f5ea4d90ab81f4bd0bcecae15285dd807c179afa7d02da1c07211fbcee8551

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/README.md

@@ -36,7 +36,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 +95,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 +121,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.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optional_logger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Andrew De Ponte
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2016-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler