injectedlogger 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c397eed4509dee6f22849d012f405627ec44d0b
-  data.tar.gz: ffb8aef686ebfb15a7d94586d254b0ebe31ed50e
+  metadata.gz: 5dd3d22d80668b023317badf017352dd0f0abf70
+  data.tar.gz: d31bae1ac80c58e7bd389d7337c8fe0f16932cf6
 SHA512:
-  metadata.gz: 9d042ff0938ab25cdec8af039da44d9ef276f2a6b7458f80c573ec5d892adf769cf081d8422d34dd4def747dd9b7aa7c038678d417568e81a654c60abd6e3feb
-  data.tar.gz: 00655caa8274a8713e7adb4de3672da75c90958c435e5ffb119fe8d59e4f2d2507f3f6aba656b63b73457c0bb73d4ec51ac9409505469ba099f5417378f829e0
+  metadata.gz: a32adcb1e875e2d82d57e4bc906f09e0f565e5233009e6e320b99a0b42d7e88f538584b77e20f00ac8b8107a529c31f47b347b36d70ae3761977e7b79d4bb1ac
+  data.tar.gz: 2e22f22c43ef4ad755edd660cbd4be03fe8326bf2fa7dd56fd5b9c4b5b67899fd4470bd143df46a52b15e017972b3b3ee23a5c118820f79f852c7041781c82dd

data/README.md

@@ -4,25 +4,19 @@ This gem can be used to inject a logger in your Ruby code.
 
 It will try to support as many methods and levels as the underlying object supports, and fall back to a supported level in case some levels are not available
 
-## Usage
+## Usage examples
 
-```ruby
-logger = InjectedLogger::Logger.inject somelogger
-raise 'No info :(' unless logger.level_info[:supported].include? :info
-logger.info 'You now have a logger!'
-```
-
-or you can set-up a default injection for your logger in case no one else sets it up before you need to log something:
+### On your code, which receives a logger from some foreign caller:
 
 ```ruby
 module MyLogger
-  InjectedLogger.declare required: [:debug, :info] do
+  InjectedLogger.use :debug, :info, :invented do
     # this gets executed if no logger has been injected at use time
     require 'logger'
-    { logger: Logger.new(STDERR), prefix: '[mylogger]' }
+    { logger: Logger.new(STDERR) }
   end
   InjectedLogger.after_injection do |logger|
-    logger.info 'ok' # you can also force your prefix with logger.prefix = str
+    logger.prefix = '[myproject]'
   end
 end
 
@@ -30,7 +24,7 @@ class WantsLogging
   include MyLogger
 
   def some_method_needing_logging
-    logger.info 'some_info'
+    logger.info 'some info'
   end
 end
 
@@ -38,11 +32,17 @@ class ThisAlsoWantsIt
   include MyLogger
 
   def some_other_method_with_debug_logging
-    logger.debug 'some_debug_info'
+    logger.invented 'some invented info'
   end
 end
 ```
 
+### On the code injecting a logger:
+
+```ruby
+InjectedLogger.inject somelogger
+```
+
 ## Generating the gem
 
 Both bundler and rspec are required to build the gem:

data/lib/injectedlogger.rb

@@ -6,7 +6,7 @@ module InjectedLogger
   # inject a default logger in case no one has set one for you:
   #
   # module MyLogger
-  #   InjectedLogger.inject do
+  #   InjectedLogger.use :info, :debug, :invented do
   #     require 'logger'
   #     # parameters are inject() params, none is required, but if
   #     # logger is not present, a default one will be used.
@@ -20,6 +20,12 @@ module InjectedLogger
   #   def some_method_needing_logging
   #     logger.info 'some info'
   #   end
+  #
+  #   def some_method_with_invented_level_logging
+  #     logger.invented do
+  #       'some invented logging'
+  #     end
+  #   end
   # end
   #
   # This will only run the block passed to inject IFF there was no logger set
@@ -27,7 +33,7 @@ module InjectedLogger
   # logger method is called, so that it does not 'require' anything if it is not
   # needed. :)
 
-  def self.declare(on: nil, required: [], method_name: :logger, &blk)
+  def self.use(*required, on: nil, method_name: :logger, &blk)
     if on.nil?
       raise InjectedLogger::DefaultInjectionBlockMissing if blk.nil?
       on = blk.binding.eval 'self'
@@ -37,13 +43,17 @@ module InjectedLogger
     on.send :define_method, method_name do
       # avoid recursion if someone calls logger in the block
       on.send :remove_method, method_name
-      unless InjectedLogger::Logger.injected?
+      unless InjectedLogger.injected?
         args = blk ? blk.call : nil
         InjectedLogger.inject_logger args, required
       end
       required.uniq!
       required -= InjectedLogger::Logger.level_info[:supported]
-      raise InjectedLogger::UnsupportedLevels.new(required) if not required.empty?
+      unless required.empty?
+        InjectedLogger::Logger.add_levels(*required)
+        required -= InjectedLogger::Logger.level_info[:supported]
+        raise InjectedLogger::UnsupportedLevels.new(required) unless required.empty?
+      end
       on.send :define_method, method_name do
         InjectedLogger::Logger
       end
@@ -77,6 +87,6 @@ module InjectedLogger
       args[:levels].push(required).flatten!
       args[:levels].uniq!
     end
-    InjectedLogger::Logger.inject(logger, args)
+    InjectedLogger.inject(logger, args)
   end
 end

data/lib/injectedlogger/logger.rb

@@ -2,6 +2,18 @@ require 'injectedlogger/errors'
 require 'injectedlogger/delegator'
 
 module InjectedLogger
+  def self.injected?
+    Logger.injected?
+  end
+
+  def self.inject(*args)
+    Logger.inject(*args)
+  end
+
+  def self.inject!(*args)
+    Logger.inject!(*args)
+  end
+
   module Logger
     UNKNOWN = :unknown
     LOGLEVELS = [:debug, :verbose, :notice, :info, :warn, :error, :critical, :fatal, :unknown]
@@ -39,6 +51,12 @@ module InjectedLogger
         add_methods
       end
 
+      def add_levels(*levels)
+        lvls = self.levels + levels
+        lvls.uniq!
+        self.levels = lvls
+      end
+
       def fallback=(level)
         set_fallback level
         add_methods

data/lib/injectedlogger/version.rb

@@ -1,3 +1,3 @@
 module InjectedLogger
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: injectedlogger
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Alejandro Martinez Ruiz