footprint-log 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16e9a0ab8e49d29636aeb605dd7d00ef1fbf3acb
-  data.tar.gz: f4190272a1e0004f7bf69576f9811b62e6854473
+  metadata.gz: 4848d46a5d4b1bcea985f3421eaca78df8c57ede
+  data.tar.gz: 7feb5f3a3a136ba103ed951709c446e284edee85
 SHA512:
-  metadata.gz: df4b20166ee7ae7f01ae130c8f5eee0aa0aa63aac080ff7905128a09b1f5933070dc24e818a398ac140b5808cf01a011233d0f23fe41a3b01952b57194962fd3
-  data.tar.gz: fff6a86deba84a232a3d9fcbe7fe2d9b958d7646914e9de4547648919f2ffdd0374672cdec3f93da9197fcd58a52075ce9a64975d50d8097fb6e363b0dcb1334
+  metadata.gz: 54d1c47b19db6adfccdc5fd5395a506221415b5b171efdc3e0dfd597bf9f03ec91d7711235523d8c7fcf6ea2efa7131972eb05b84f0a694f6e829c8004a572b2
+  data.tar.gz: b6b2d6063e95fd804f4935f636512bf83d43a8d1c64bf99f66cf7eb57653044d7fc335eca67ad93369a53b0336b83fa7793ce987d6b9d15151402fb5adcbbb24

data/lib/footprint.rb

@@ -1,9 +1,9 @@
-require_relative 'footprint/log'
-
-module Footprint
+#
+# Module that wraps the Footprint gem content.
+#
+module Footprint; end
 
-  attr_accessor :logger
-
-end
+require_relative 'footprint/log'
+require_relative 'footprint/middleware'
 
 

data/lib/footprint/log.rb

@@ -1,3 +1,12 @@
+module Footprint
+
+  #
+  # Module that wraps the Footprint Loggers content.
+  #
+  module Log; end
+
+end
+
 require_relative 'log/basic'
 require_relative 'log/error_file'
 require_relative 'log/out_file'

data/lib/footprint/log/basic.rb

@@ -4,8 +4,14 @@ module Footprint
 
   module Log
 
+    # Class that extends the Ruby Logger.
+    #
+    # Does nothing extra for now but will be used to add generic
+    # configuration in the future since other Footprint::Log
+    # classes extend this.
     class Basic < Logger
 
+      # Sets the default logdev as nil
       def initialize logdev = nil, shift_age = 0, shift_size = 1048576
         super
       end

data/lib/footprint/log/error_file.rb

@@ -4,8 +4,14 @@ module Footprint
 
   module Log
 
+    # Class that extends the Footprint::Log::Basic and
+    # adds a write method which logs on error level.
+    #
+    # This Class can be used as a File instance to
+    # write in log.
     class ErrorFile < Basic
 
+      # Logs the message on error level on logger.
       def write(message)
         error message
       end

data/lib/footprint/log/gelf.rb

@@ -4,6 +4,11 @@ module Footprint
 
   module Log
 
+    # Class that extends the GELF::Logger.
+    #
+    # Does nothing extra for now but will be used to add generic
+    # configuration in the future since other Footprint::Log
+    # classes will extend this.
     class Gelf < GELF::Logger
 
     end

data/lib/footprint/log/out_file.rb

@@ -4,8 +4,14 @@ module Footprint
 
   module Log
 
+    # Class that extends the Footprint::Log::Basic and
+    # adds a write method which logs on info level.
+    #
+    # This Class can be used as a File instance to
+    # write in log.
     class OutFile < Basic
 
+      # Logs the message on info level on logger.
       def write(message)
         info message
       end

data/lib/footprint/middleware.rb

@@ -1 +1,10 @@
+module Footprint
+
+  #
+  # Module that wraps the Footprint Middleware content.
+  #
+  module Middleware; end
+
+end
+
 require_relative 'middleware/logger'

data/lib/footprint/middleware/logger.rb

@@ -3,10 +3,25 @@ require_relative '../log'
 
 module Footprint
 
+  #
+  # Class that is actually the Middleware we use to decorate
+  # the application with loggers, taking advantage of the @env.
+  #
   class Middleware
 
+    # @app = the instance of the application that uses this middleware.
+    # @logger = the instance of the logger used to decorate the Rack application.
     attr_accessor :app, :logger
 
+    # Initialize the Middleware with the app that uses this
+    # Middleware and an optional block.
+    #
+    # Sets as the default logger a Footprint::Log::Basic on STDOUT.
+    #
+    # Decorate the given app with a new method called logger,
+    # that will return the instance of the logger from the env.
+    #
+    # If any block is given, a instance_eval is called.
     def initialize(app, &block)
 
       @app = app
@@ -21,11 +36,19 @@ module Footprint
       self.instance_eval &block if block
     end
 
+
+    # The current instance of the logger is set on env[:footprint_logger]
+    # and the app is called further with the enriched env.
     def call(env)
       env[:footprint_logger] = @logger
       @app.call env
     end
 
+    # Initialize the current instance of the logger with
+    # a new instance of the class given as parameter.
+    #
+    # The initialization of the class given is done using
+    # the second parameter.
     def set clazz, *args
       @logger = clazz.send(:new, *args)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: footprint-log
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Puiu Ionut