injectedlogger 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6145235cf44a5de4aa3d8ba7bd99ac587ce3264f
-  data.tar.gz: 973b5556e555eabb22f035a389fdf8a2c9167610
+  metadata.gz: 76e0c6ca83edad8369e89640d915741e7c0243c8
+  data.tar.gz: ca24a98f8a4ad30d4d3982b641b3ac7b589e4bb2
 SHA512:
-  metadata.gz: 790e2ba277d2019c95f04c742c1cbcd233c76a7ce69c0be77c30aa40af5e227ec2a47c13047501039d15acb49daf66d3bcce20577cf9a1beba5ba20b132d2f49
-  data.tar.gz: 15f2473bdc1ecb1ba3a3401db0bc21d2f41202985850be832d5e44be516d84a5af8ee8ead2f367d4f22511100427a595c85c67c5be1e5443fb3c063a574d89e6
+  metadata.gz: df9f53955854e96a865c6de34db278e401eb24e232d9e5e14c341c32ba7605d0c6ff2074211f6ff71ca1fe0719213be9af96b473c3a086553d4a30348853415e
+  data.tar.gz: 1b701f337395fe562fb3c4523402f4d589ab7d504c1a1128c38164af1c44e0d2733f23a959ee0f6460bffd79e13e46e464d30144de85f3e89c3e4fda48cdb0e7

data/README.md

@@ -12,6 +12,30 @@ 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:
+
+```ruby
+module MyLogger
+  InjectedLogger.inject self, required: [:debug, :info] do
+    require 'logger'
+    { logger: Logger.new(STDERR), prefix: '[mylogger]' }
+  end
+end
+
+class WantsLogging
+  include MyLogger
+
+  def some_method_needing_logging
+    logger.info 'some_info'
+  end
+end
+
+class ThisAlsoWantsIt
+  include MyLogger
+  ...
+end
+```
+
 ## Generating the gem
 
 Both bundler and rspec are required to build the gem:

data/lib/injectedlogger/errors.rb

@@ -0,0 +1,10 @@
+module InjectedLogger
+  Error = Class.new StandardError
+  InUse = Class.new Error
+  UnsupportedLevels = Class.new Error do
+    def initalize(levels)
+      super("logger does not support required levels #{levels.join ', '}")
+    end
+  end
+end
+

data/lib/injectedlogger/logger.rb

@@ -1,12 +1,10 @@
+require 'injectedlogger/errors'
 require 'injectedlogger/delegator'
 
 module InjectedLogger
   module Logger
-    Error = Class.new StandardError
-    InUse = Class.new Error
-
     UNKNOWN = :unknown
-    LOGLEVELS = [:debug, :verbose, :info, :notice, :warn, :error, :critical, :fatal, :unknown]
+    LOGLEVELS = [:debug, :verbose, :notice, :info, :warn, :error, :critical, :fatal, :unknown]
 
     class << self
       attr_reader :prefix, :levels, :level_info, :fallback
@@ -15,19 +13,20 @@ module InjectedLogger
         not logger.nil?
       end
 
-      def use(logger_obj, levels: LOGLEVELS, fallback: UNKNOWN)
+      def use(logger_obj, levels: LOGLEVELS, fallback: UNKNOWN, prefix: nil)
         if logger and logger != logger_obj
           raise InUse, "#{self} was already using logger #{logger}"
         end
         use! logger_obj, levels: levels, fallback: fallback
       end
 
-      def use!(logger_obj, levels: LOGLEVELS, fallback: UNKNOWN)
+      def use!(logger_obj, levels: LOGLEVELS, fallback: UNKNOWN, prefix: nil)
         self.logger = logger_obj
-        set_prefix '[core]'
+        set_prefix prefix
         set_levels levels
         set_fallback fallback
         add_methods
+        self
       end
 
       def prefix=(prefix)
@@ -49,6 +48,10 @@ module InjectedLogger
         logger.send method, *args, &blk
       end
 
+      def respond_to_missing?(method, priv = false)
+        logger.respond_to_missing?(method, priv)
+      end
+
       private
 
       attr_accessor :logger

data/lib/injectedlogger/version.rb

@@ -1,3 +1,3 @@
 module InjectedLogger
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/injectedlogger.rb

@@ -1,2 +1,51 @@
+require 'injectedlogger/errors'
 require 'injectedlogger/logger'
-require 'injectedlogger/version'
+require 'injectedlogger/version'
+
+module InjectedLogger
+  # inject a default logger in case no one has set one for you:
+  #
+  # module MyLogger
+  #   InjectedLogger.inject self do
+  #     require 'logger'
+  #     # logger is required, the rest are other use() params
+  #     { logger: Logger.new(STDERR), prefix: '[mylogger]', ... }
+  #   end
+  # end
+  #
+  # class WantsLogging
+  #   include MyLogger
+  #
+  #   def some_method_needing_logging
+  #     logger.info 'some info'
+  #   end
+  # end
+  #
+  # This will only run the block passed to inject IFF there was no logger set
+  # up to be used by InjectedLogger, and it will only happen the first time the
+  # logger method is called, so that it does not 'require' anything if it is not
+  # needed. :)
+
+  def self.inject(klass, required: [], method_name: :logger, &blk)
+    klass.send :remove_method, method_name rescue nil
+    klass.send :define_method, method_name do
+      unless InjectedLogger::Logger.in_use?
+        args = blk.call
+        logger = args.delete :logger
+        unless required.empty?
+          args[:levels] ||= []
+          args[:levels].push(required).flatten!.uniq!
+        end
+        InjectedLogger::Logger.use(logger, args)
+      end
+      required.uniq!
+      required -= InjectedLogger::Logger.level_info[:supported]
+      raise InjectedLogger::UnsupportedLevels.new(required) if not required.empty?
+      klass.send :remove_method, method_name
+      klass.send :define_method, method_name do
+        InjectedLogger::Logger
+      end
+      InjectedLogger::Logger
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: injectedlogger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alejandro Martinez Ruiz
@@ -69,6 +69,7 @@ files:
 - injectedlogger.gemspec
 - lib/injectedlogger.rb
 - lib/injectedlogger/delegator.rb
+- lib/injectedlogger/errors.rb
 - lib/injectedlogger/logger.rb
 - lib/injectedlogger/version.rb
 - spec/helpers.rb