footprint-log 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c8637e5e2c1b95ee77829c19ad6964dc2544d56
-  data.tar.gz: 06668e5f8f3ec83b851b640a284493469bde85ed
+  metadata.gz: 37401f9e0d7fde7d558dd7e1c61eac9453d53036
+  data.tar.gz: 43dade513b5c0270bae125ce185fd50938cd73ae
 SHA512:
-  metadata.gz: 9049f9476114f701c7660320daec216b0adca41452fac4ccb5c4208c7d581e053b1260ea242ecca35c7bfdda2b231a40840489652a7dcd11f277ab3c92a128f7
-  data.tar.gz: 18dfed8dd26460a1511a84f4c8d6e4b39226336bd9d45c13e72550f303b375e258f489334a2cc1af866f67bdf57a043982e0e27f42669c5eefc009ef3ea1ea15
+  metadata.gz: 18157ff1383339f8c1a22a9d0f087cd0d9edbc5c37aeeae327ad51f0905247f7238773633805e7dac4feccb8bb16c6b87f53a47da25fa7a0522300abaaf23526
+  data.tar.gz: fdd8c67dbd744379188e0621db5f873a3351aebdaaaabe31c6e6b8b0f693ec316a59cb9ba52757d4938d4b4cd3b74f47666e9e8eef427eb5b65d94000e812c15

data/README.rdoc

@@ -1,4 +1,4 @@
-= Footprint (Beta)
+= Footprint
 Rack Application Logging Tools
 
 {<img src="https://badge.fury.io/rb/footprint-log.svg" alt="Gem Version" />}[http://badge.fury.io/rb/footprint-log]
@@ -66,7 +66,7 @@ In that case we can do something like this:
     end
 
 
-Let's assume we want to use the following custom Logger class, initialized with log_device as STDOUT and level as 5.
+Let's assume we want to use the following custom Logger class, initialized with log_device as STDOUT and level as 1 (that is INFO level).
 
     class MyAwesomeLogger < Logger
 

data/lib/footprint/log/basic.rb

@@ -6,12 +6,31 @@ module Footprint
 
     # 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.
+    # Does nothing extra except setting the default logdev as nil 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
+      #
+      # === Synopsis
+      #
+      #   Footprint::Log::Basic.new(name, shift_age = 7, shift_size = 1048576)
+      #   Footprint::Log::Basic.new(name, shift_age = 'weekly')
+      #
+      # === Args
+      #
+      # +logdev+::
+      #   The log device.  This is a filename (String) or IO object (typically
+      #   +STDOUT+, +STDERR+, or an open file, defaults to nil).
+      # +shift_age+::
+      #   Number of old log files to keep, *or* frequency of rotation (+daily+,
+      #   +weekly+ or +monthly+).
+      # +shift_size+::
+      #   Maximum logfile size (only applies when +shift_age+ is a number).
+      #
+      # === Description
+      #
+      # Create an instance with logdev as nil.
+      #
       def initialize logdev = nil, shift_age = 0, shift_size = 1048576
         super
       end

data/lib/footprint/log/error_file.rb

@@ -11,7 +11,24 @@ module Footprint
     # write in log.
     class ErrorFile < Basic
 
+      #
+      # === Synopsis
+      #
+      #   write 'My dummy error log message'
+      #
+      # === Args
+      #
+      # +message+::
+      #   The log message.  A String or Exception.
+      #
+      # === Return
+      #
+      # +true+ if successful, +false+ otherwise.
+      #
+      # === Description
+      #
       # Logs the message on error level on logger.
+      #
       def write(message)
         error message
       end

data/lib/footprint/log/out_file.rb

@@ -11,7 +11,24 @@ module Footprint
     # write in log.
     class OutFile < Basic
 
+      #
+      # === Synopsis
+      #
+      #   write 'My dummy info log message'
+      #
+      # === Args
+      #
+      # +message+::
+      #   The log message.  A String or Exception.
+      #
+      # === Return
+      #
+      # +true+ if successful, +false+ otherwise.
+      #
+      # === Description
+      #
       # Logs the message on info level on logger.
+      #
       def write(message)
         info message
       end

data/lib/footprint/middleware/logger.rb

@@ -8,19 +8,50 @@ module Footprint
   # 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
+    # The instance of the Rack +app+ that uses this middleware.
+    attr_accessor :app
 
-    # Initialize the Middleware with the app that uses this
-    # Middleware and an optional block.
+    # The instance of the +logger+ used to decorate the Rack application.
+    attr_accessor :logger
+
+
+
+    #
+    # === Synopsis
+    #
+    # Basic Middleware usage:
+    #
+    #   use Footprint::Middleware
+    #
+    # Advanced Middleware usage:
+    #
+    #   use Footprint::Middleware do
+    #     set Logger, STDOUT
+    #   end
+    #
+    # Clazz init:
+    #
+    #   Footprint::Middleware.new app # => #<Footprint::Middleware>
+    #
+    # === Args
+    #
+    # +app+::
+    #   Rack application instance.
+    # +block+::
+    #   Optional block, used to instance_eval (defaults to nil)
+    #
+    # === Description
+    #
+    # 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,
+    # 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.
+    # If any +block+ is given, a instance_eval is called.
+    #
     def initialize(app, &block)
 
       @app = app
@@ -35,19 +66,57 @@ module Footprint
       self.instance_eval &block if block
     end
 
-
+    #
+    # === Synopsis
+    #
+    #   Footprint:Middleware.call env # => env
+    #
+    # === Args
+    #
+    # +env+::
+    #   Rack request environment.
+    #
+    # === Return
+    #
+    # +env+ returned always.
+    #
+    # === Description
+    #
     # 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
 
+    #
+    # === Synopsis
+    #
+    # Basic usage:
+    #
+    #   Footprint.Middleware.set Logger, STDOUT # => logger
+    #
+    # === Args
+    #
+    # +clazz+::
+    #   Any Logger class that has the default Logger methods.
+    #
+    # +args+::
+    #   Optional array of arguments passed to the Logger class for initialize (defaults to nil)
+    #
+    # === Return
+    #
+    # +logger+ returned always.
+    #
+    # === Description
+    #
     # 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: footprint-log
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Puiu Ionut
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-03 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gelf