unibanner 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a987a90282931e2839767ae60f520bcca07c7635f3e66f2481c4e2ce8bae9f59
-  data.tar.gz: 7804309c159b11547855b6cbc3e1083b05c0e6ca1a2914344079c58c0d99f176
+  metadata.gz: 58a771632011edf9b9aab923a1173216d7c4c57269627fe5fd819576a01d3500
+  data.tar.gz: 06067e95b9fd1eeb8fa36cfe7f528fa1d8e9b795a850c02fe7546d9c58a52ab5
 SHA512:
-  metadata.gz: d6e62892ca52da8cca98641430088d06233fc6b9e4739f6dfbff3686a9c11ef9e4404dea3f759f72fefc7be01cfc6a34a1eddf09255086c6a04e60fb7cd467a2
-  data.tar.gz: 7d32bb8ce10aa2351bf336407030e2c9734624eba46aac6f2bca675b36cb7b6d0ef884cca002d2783ba96f3d6916abff4c3093745ba0aaaf7571de36060e1c57
+  metadata.gz: 4895c3e4337c8119f6bf8fb6c7af5003fb27e21121f54c72d66d7ce41bc35945fe800dc059e36b5421728857e829216123cc8ba5e00daf566a3af79488100eef
+  data.tar.gz: 987566c59b26a5a79b43e99b078e4854794bff0788d2aa97cadf287ba642b7bb9e26b390319487f3ab6a4a633fff1e827f9276f8d23c65f0161e9ab752a75df2

data/lib/unibanner/logger.rb

@@ -3,13 +3,19 @@ require 'paint'
 module Logging
   class Logger
 
+
     def incoming?( ); true; end
+
+    # log an incoming line
+    # @param [String] data line to log
     def incoming( data = nil )
       data = yield if block_given?
       log_event(::Logging::LogEvent.new(@name, 1, " #{Paint['->', 'green']} #{data}", @caller_tracing))
       true
     end
     def outgoing?( ); true; end
+    # log an outgoing line
+    # @param [String] data line to log
     def outgoing( data = nil )
       data = yield if block_given?
       log_event(::Logging::LogEvent.new(@name, 1, " #{Paint['<-', 'red']} #{data}", @caller_tracing))
@@ -46,16 +52,25 @@ module Unibanner
     @@loggers[self] = Logging.logger[self]
     @@instance = Logging::Repository.instance
 
+    # create a new Unibanner::Logger instance
+    # @param [Object] name an object returning a valid name for the logger
     def initialize(name)
       @@loggers[name] = Logging.logger[name]
     end
 
+    # update the loggers
     def update
       @@instance = Logging::Repository.instance
     end
+    # return the loggers list
+    # @return [Array] loggers list
     def loggers
       @@loggers
     end
+
+    # grab a logger from the list for use
+    # @param [Object] key name of logger
+    # @return [Unibanner::Logger] logger instance
     def self.[](key)
       @@loggers[key]
     end

data/lib/unibanner/version.rb

@@ -1,3 +1,3 @@
 module Unibanner
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unibanner
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ken Spencer