optional_logger 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9053d81db875e3d007c47d17c61f451d2c5373ba
-  data.tar.gz: aec324fa8c19728d07ceee530a1dcc88a10a9b5a
+  metadata.gz: 1fac6b9d6d29180865ac0937c8c39f86c716af25
+  data.tar.gz: 3f70c78f17966bad92edbe300ec90d27491f5a8b
 SHA512:
-  metadata.gz: 000d11c38ffefad76fb1a7f3829ad21ffa359a58baea45d2c698ecf844857428de7cd761a918ae01c0d5fbf7b6715df6e451e03e4b6f99fcd5f4fcb12503d6c7
-  data.tar.gz: 85c300ccc030a4324224b8b7b89d8c0b0fb8815deeb4e67548ceecf9430df23ad6586db9e8c8d86b7c61d380a62d4fd25b2656121ca5544a3e758b0dc102a7cd
+  metadata.gz: e5ce7f7db093856ecdf3f0c22d61876baff65597cb30310a91e6b75b43febe323a1ba72b60ed604eca08a6f621e133581aeb88c0f3ec09a50e6d7a322b7d1e31
+  data.tar.gz: 324833b641124a2c9bf694d1a81b7a4230497cbe25e2b6ed54d066954d98ee0f033970c7072277d8ab12dae3dea96c5b535443687df6988e043b25c3dba0c13f

data/CHANGELOG.md

@@ -6,6 +6,10 @@ versions, as well as provide a rough history.
 
 #### Next Release
 
+#### v1.1.0
+
+* Added logger management module
+
 #### v1.0.0
 
 * Added documentation around all the classes, modules, constants and methods

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.0'
+spec.add_dependency 'optional_logger', '~> 1.1'
 ```
 
 Or install it yourself as:
@@ -91,6 +91,34 @@ 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.
 
+### Logger Management
+
+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`.
+
+```ruby
+require 'optional_logger'
+
+module MyFooGem
+  include OptionalLogger::LoggerManagement
+end
+```
+
+The above would enable consumers of your library to set the logger as follows.
+
+```ruby
+MyFooGem.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
+MyFooGem.logger # => the optional logger wrapping some_application_logger
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/optional_logger.rb

@@ -1,5 +1,6 @@
 require 'optional_logger/version'
 require 'optional_logger/logger'
+require 'optional_logger/logger_management'
 
 # Top-level namespace for a library providing an optional logger and supporting
 # functionality around it

data/lib/optional_logger/logger_management.rb

@@ -0,0 +1,16 @@
+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
+    end
+  end
+end

data/lib/optional_logger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optional_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew De Ponte
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-11 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,7 @@ files:
 - bin/setup
 - lib/optional_logger.rb
 - lib/optional_logger/logger.rb
+- lib/optional_logger/logger_management.rb
 - lib/optional_logger/version.rb
 - optional_logger.gemspec
 homepage: http://github.com/Acornsgrow/optional_logger