lapis 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d04df9ee553d521702522a912b53071aefc8152
-  data.tar.gz: 70acf1910655be53ccca0d440557b8e51ff1f531
+  metadata.gz: 8bb0850e11a2e937e6f7b3fb28cd4f01e525d7c7
+  data.tar.gz: 1a7d57ce4c871b8c794ba5d673ca7733d592c8a9
 SHA512:
-  metadata.gz: 1ea8cae4ce82f42e8d3eb5f305a898d4488f2b2dbfd2364d05aef59d61c7514f8589aad4deb98b32419ff32c4b518e343703d1486e20ab625fa70640eceb556a
-  data.tar.gz: f9e9a779c99fc672c96b31023cb53357b714c4f8f8e9ce113048b6f16774707f8fbbe9067358e25eb790b5848f91d4360bdbbfb2eb3ca8a799452aa9edee159e
+  metadata.gz: 834af6d35e9aa5243521b805e8b5fbdc08aea51b3f44259f2d52d7e06ca48083d7c6e3762b84ab8d2bf392d8b384c475473b60c5b889fea7cfc8c0f4bf2ea40f
+  data.tar.gz: 530f1ea24b6adc23ddbb764b28289bc1af2e2a2908221b6f305d85ab0b8092bb156bf3adee624e113a2a425ec3d2409466804e703c9688f5a8e7a1bd88df105e

data/lib/lapis.rb

@@ -1,7 +1,16 @@
 module Lapis
 
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 
+  # +Lapis::Logger+ is a simple, lightweight logging utility. It is fully
+  # customizable; in particular, you can customize the following:
+  #   * +levels+ -- An array of symbols, which determines the valid levels. See
+  #   its' documentation for more info.
+  #   * +formatter+ -- A lambda, used for formatting output. Upon a call to log,
+  #   this will be called with the severity of the message and the message
+  #   itself (in that order).
+  #   * +output_channel+ -- An IO object, representing the destination for all
+  #   output.
   class Logger
 
     # Special levels that will be sent to +@levels+ as method calls.
@@ -9,15 +18,19 @@ module Lapis
     
     # An array of all valid severity levels. Each levels' offset in this array
     # determines its relative importance.
+    # @return [Array<Symbol>]
     attr_accessor :levels
     
     # The minimum severity level required for printing
+    # @return [Symbol]
     attr_reader :level
 
     # A lambda, used to format the output
+    # @return [Lambda]
     attr_accessor :formatter
     
     # The IO channel to output to
+    # @return [IO]
     attr_reader :output_channel
     
     def initialize(out = $stdout, level = :info,
@@ -31,6 +44,10 @@ module Lapis
       end
     end
     
+    # A factory method for logging to files. Functions exactly as the regular
+    # +new+ method, expect instead of expecting an IO object, it expects the
+    # name of a file.
+    # @param file [String] the name of the file to log output to
     def self.open(file, level = :info,
       levels = [:debug, :info, :warn, :error, :fatal])
       new(File.open(file, "w"), level, levels)
@@ -46,23 +63,38 @@ module Lapis
       end
     end
     
+    # Determine if the specified severity level is important (i.e., will be
+    # printed when that level is called).
+    # @param severity [Symbol] the severity level to check
+    # @return [Boolean] whether the specified severity is important
     def important?(severity)
       @levels.index(severity) >= @levels.index(@level) if @levels.index(severity)
     end
 
+    # Determine if we're logging to a file.
     def file?
       @output_channel.is_a? File
     end
     
+    # Log a message. +severity+ is expected to be the name of a severity level,
+    # and +msg+ is a string denoting the message to be logged. If we're logging
+    # to a file, the file's buffer will be flushed immediately after logging.
+    # @param severity [Symbol] how severe the message is
+    # @param msg [String] the message to be logged
+    # @return [void]
     def log(severity, msg)
       @formatter.call(severity, msg) if important?(severity)
       output_channel.flush if file?
     end
+
+    private
     
+    # @api private
     def respond_to_missing?(name, include_private = false)
       @levels.include?(name) || super
     end
     
+    # @api private
     def method_missing(name, *args)
       return super unless @levels.include?(name)
       if args.length == 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lapis
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Citruxy