GunnyLog 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 772e6881f38897b22ad442e76899e08311574f7d
-  data.tar.gz: 66316fcbe57363e372430524c3ad8daf3aecddbf
+  metadata.gz: 73d2ba22a9990c09f32fd64d272808bad6fef44a
+  data.tar.gz: 1473871267f074e583165595d87deff8952474e3
 SHA512:
-  metadata.gz: f3838e3812c1acca1a4e50bf68ab67f89685d137202c3f4b17f3c4fcd22b9f06ae5c24d801a4202e30b3af417d54c380b1dd9db5defd30581ecba6aca9dcf538
-  data.tar.gz: fb42181161be2d5f92f2ea139fcb4a94889b4c2669a173ff10ad0fdee518fdeb800675936d3a35431773a32ad5e88a9db261bc4b86f6e05bac789fa53234d6c4
+  metadata.gz: 759b45c1e539fb8e08448c36c01b8d30085f1a0a85802d85b6dd4fbc6499f6cd6d806510af35fb2545e8ed6a86fd0cfdfae91a5e8bd4e37f7ed360f37be1870d
+  data.tar.gz: 42a0318e63af4e9f96402bb4d5ea743bee0f302ed616a3f906d189df5b3f40ad7bc8bf2aaf0718655464f3163cf6a99bffc72b1d8f46accdd2fb046b59c0cdee

data/README.md

@@ -0,0 +1,38 @@
+# GunnyLog
+
+Ruby logfile class
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'GunnyLog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install GunnyLog
+
+## Usage
+
+See test/testapp01.rb for examples
+
+## Documentation
+
+http://rubydoc.info/gems/GunnyLog/frames/index
+
+## Contributing
+
+1. Fork it ( https://github.com/gunnyhwy/GunnyLog/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Thanks!
+Gunny

data/lib/GunnyLog.rb

@@ -4,6 +4,7 @@ require 'GunnyLog/exceptions'
 require 'singleton'
 require 'date'
 
+
 # GunnyLog logs messages to stdout, stderr, or a file. It defaults
 # to stdout. GunnyLog is a singleton and uses the instance method.
 # For example you can use GunnyLog.instance.msg('Error message')
@@ -17,11 +18,11 @@ class GunnyLog
     class << self;
       # Logging flag on and off (default=on)
       private
-      attr_accessor :_is_logging_enabled
+      attr_accessor :logging_enabled
     end
 
     # @return [bool] is logging enabled
-    attr_reader :_is_logging_enabled
+    attr_reader :logging_enabled
 
     class << self;
       # The location that the message was from
@@ -37,7 +38,7 @@ class GunnyLog
     class << self;
       # Is file open flag
       private
-      attr_accessor :_is_file_open
+      attr_accessor :file_open
     end
 
     class << self;
@@ -51,14 +52,14 @@ class GunnyLog
     # Set logging on and off
     # @param flag [bool] switch for on or off
     def set_logging_enabled(flag)
-      @_is_logging_enabled = flag
+      @logging_enabled = flag
     end
 
     # Set logging on and off
     # @deprecated Use {#set_logging_enabled} instead
     # @param flag [bool] switch for on or off
     def set_switch(flag)
-        @_is_logging_enabled = flag
+        @logging_enabled = flag
     end
 
     # Set message was logged from message_location
@@ -76,7 +77,7 @@ class GunnyLog
 
     # Set output to STDOUT, default
     def set_output_stdout
-      if @_is_file_open
+      if @file_open
         self.close
       end
       @logging_file = STDOUT
@@ -84,7 +85,7 @@ class GunnyLog
 
     # Set output to STDERR
     def set_output_stderr
-      if @_is_file_open
+      if @file_open
         self.close
       end
       @logging_file = STDERR
@@ -95,9 +96,9 @@ class GunnyLog
     def open(filename = 'gunnylog.log')
       begin
         @logging_file = File.open(filename, 'a+')
-        @_is_file_open = true
-      rescue SystemCallError
-        raise GunnyLogException.new('Error opening file: ' + filename)
+        @file_open = true
+      rescue SystemCallError => exc
+        handle_exception(exc)
       end
     end
 
@@ -105,9 +106,7 @@ class GunnyLog
     # @param pathname [string] path of the logfile
     # @param filename [string] name of the logfile
     # @param extension [string] extension of the logfile
-    def open_with_info(pathname = nil,
-                       filename = 'gunnylog',
-                       extension = 'log')
+    def open_file(pathname = nil, filename = 'gunnylog', extension = 'log')
       if pathname == nil
         self.open(filename  + '.' + extension)
       else
@@ -115,24 +114,33 @@ class GunnyLog
       end
     end
 
+    # Open the logfile with path, name, and extension
+    # @param pathname [string] path of the logfile
+    # @param filename [string] name of the logfile
+    # @param extension [string] extension of the logfile
+    # @deprecated Use {#open_file} instead
+    def open_with_info(pathname = nil, filename = 'gunnylog', extension = 'log')
+      self.open_file(pathname, filename, extension)
+    end
+
     # Close the logfile
     def close
       begin
         @logging_file.close
-        @_is_file_open = false
+        @file_open = false
         @logging_file = STDOUT
-      rescue SystemCallError
-        raise GunnyLogException.new('Error closing file')
+      rescue SystemCallError => exc
+        handle_exception(exc)
       end
     end
 
-    # Write message to file
+    # Write message to logfile
     # @param msg [string] message string
     def msg(msg)
       message(nil, msg)
     end
 
-    # Write message to file
+    # Write message to logfile
     # @param loc [string] message message_location, optional
     # @param msg [string] message string
     def message(loc = nil, msg)
@@ -143,7 +151,7 @@ class GunnyLog
     # @param loc [string] message message_location, optional
     # @param msg [string] message format string
     # @param args [arg or array of args]
-    def formatted_message(loc = nil, msg, args)
+    def message_formatted(loc = nil, msg, args)
         formatted = sprintf(msg, *args)
         message(loc, formatted)
     end
@@ -152,19 +160,51 @@ class GunnyLog
     # @param loc [string] message message_location
     # @param msg [string] message format string
     # @param args [variable number of args]
-    def formatted_message_vars(loc, msg, *args)
+    def message_formatted_vars(loc, msg, *args)
         formatted = sprintf(msg, *args)
         message(loc, formatted)
     end
 
+    # Write exception to logfile
+    # @param exc [exception] exception to log
+    def msg_exception(exc)
+      write_msg(@logging_file, @message_location, exc.message)
+    end
+
+    # Write exception to logfile
+    # @param exc [exception] exception to log
+    def message_exception(loc = nil, exc)
+      write_msg(@logging_file, loc, exc.message)
+    end
+
+    # Write formatted message with single arg or array of args
+    # @param loc [string] message message_location, optional
+    # @param msg [string] message format string
+    # @param args [arg or array of args]
+    # @deprecated Use {#message_formatted} instead
+    def formatted_message(loc = nil, msg, args)
+      formatted = sprintf(msg, *args)
+      message(loc, formatted)
+    end
+
+    # Write formatted message with variable number of args
+    # @param loc [string] message message_location
+    # @param msg [string] message format string
+    # @param args [variable number of args]
+    # @deprecated Use {#message_formatted_vars} instead
+    def formatted_message_vars(loc, msg, *args)
+      formatted = sprintf(msg, *args)
+      message(loc, formatted)
+    end
+
     # private instance methods
     private
 
     # initailize
     def initialize
-      @_is_logging_enabled = true
+      @logging_enabled = true
       @message_location = 'MainMethod'
-      @_is_file_open = false
+      @file_open = false
       @logging_file = STDOUT
     end
 
@@ -175,7 +215,7 @@ class GunnyLog
         else
           @message_location = loc
         end
-        if @_is_logging_enabled
+        if @logging_enabled
             output.puts "#{date_str}|#{$0}|#{loc}|#{msg}"
         end
     end
@@ -186,9 +226,15 @@ class GunnyLog
         d.strftime('%m/%d/%Y|%I:%M:%S%p')
     end
 
+    # log exception and raise
+    def handle_exception(exc)
+      self.message_exception('***GunnyLog***', exc)
+      raise GunnyLogException.new(exc.message)
+    end
+
 end
 
 
-# @deprecated Use {#GunnyLog} instead
+# @deprecated Use {GunnyLog} instead
 class GunnyLogFile < GunnyLog
 end

data/lib/GunnyLog/version.rb

@@ -1,3 +1,3 @@
 class GunnyLog
-  VERSION = '1.0.9'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: GunnyLog
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.0
 platform: ruby
 authors:
 - GunnyHwy
@@ -19,6 +19,7 @@ files:
 - lib/GunnyLog.rb
 - lib/GunnyLog/version.rb
 - lib/GunnyLog/exceptions.rb
+- README.md
 homepage: http://rubygems.org/gems/GunnyLog
 licenses:
 - GPL v3