sixarm_ruby_pro_logger 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34a5a270bef744bb89bc22bec7c69356dc0f5774
-  data.tar.gz: dba64dbde5d2c794a1b437640f9e9531df33b05b
+  metadata.gz: 4ccb679d6502059d2e3b109b7dd77908ed632e64
+  data.tar.gz: 6a6358755e8be6ea34fd6c8474b155e509a6777a
 SHA512:
-  metadata.gz: 6d78fa563f69873550d86c308633363c284dfdcf5155ed11fdca21a3f4dad88fd03d2699ccb2335a88b555d6528b5790ea5a9f361e7fbe9993feb40c1afdc8a9
-  data.tar.gz: 43c65006a33b2c97680ccd66d3717211e49a637dcfa2db5a5257116783e480cbd4ae827626169526a137c52d720099520efcf041ed45619f79f565419369ddcc
+  metadata.gz: 2f1783453e1777bf49be337ddbedb2edd676f903e26235702da314958ec03b8e4e23d92f4085f3a94eb80517df975af30250aee8936b39cf36a801abb0a433a1
+  data.tar.gz: 223e0554d1d2601e54ef14d8f467aa66f1d564c25a79f7cd4113e058f821947c2ed87883d5f4090162070ec25f757ab8882eb1009fe64fbdf426241a7031d119

data/README.md

@@ -10,11 +10,12 @@
 
 ProLogger is a custom logger formatter for Rails that prints these:
 
-  * Time stamp
-  * Hostname
-  * Process Id
-  * Severity: Rails defines these as debug, info, warn, error, and fatal.
-  * Message: a string, exception, array, or any object that has a .inspect method)
+  * Time stamp: such as ISO 8601 format using YYYY-MM-DD and HH:MM:SS.
+  * Program name: such as `$PROGRAM_NAME`
+  * Hostname: such as `Socket.gethostname`.
+  * Process Id: such as `Process.pid`.
+  * Severity: such as debug, info, warn, error, and fatal.
+  * Message: a string, exception, array, or any object that has a `inspect` method
 
 Example setup:
 
@@ -25,38 +26,6 @@ Example use:
     logger.info("Hello")
     => "2011-12-31T12:59:59Z my_program my.example.com 1000 Hello"
 
-For docs go to <http://sixarm.com/sixarm_ruby_pro_logger/doc>
-
-Want to help? We're happy to get pull requests.
-
-
-## Install quickstart
-
-Install:
-
-    gem install sixarm_ruby_pro_logger
-
-Bundler:
-
-    gem "sixarm_ruby_pro_logger", "~>2.0.0"
-
-Require:
-
-    require "sixarm_ruby_pro_logger"
-
-
-## Install with security (optional)
-
-To enable high security for all our gems:
-
-    wget http://sixarm.com/sixarm.pem
-    gem cert --add sixarm.pem
-    gem sources --add http://sixarm.com
-
-To install with high security:
-
-    gem install sixarm_ruby_pro_logger --test --trust-policy HighSecurity
-
 
 ## Options
 
@@ -74,14 +43,14 @@ Intialize options:
   * pid: The process id number.
       Default is `Process.pid`.
   
-  * message_separator: Text to use to join mutiple messages.
-      Default is " ... ".
+  * message_separator: Print this between mutiple messages.
+      Default is "\n".
   
   * backtrace_separator: Print this between exception backtrace lines.
-      Default is " ... ".
+      Default is "\n".
   
-  * line_separator: Change any message newlines to this text.
-      Default is " ... ".    
+  * line_separator: Print this between message lines.
+      Default is "\n", which is the same as no change.
 
 Example:
 
@@ -104,6 +73,39 @@ The message can be:
   * an array of messages: print the items in the array, separated by message_separator.
  
   * any object: first convert it to a string using object.inspect, then print it as a string as above.
+ 
+For docs go to <http://sixarm.com/sixarm_ruby_pro_logger/doc>
+
+Want to help? We're happy to get pull requests.
+
+
+## Install quickstart
+
+Install:
+
+    gem install sixarm_ruby_pro_logger
+
+Bundler:
+
+    gem "sixarm_ruby_pro_logger", "~>2.0.1"
+
+Require:
+
+    require "sixarm_ruby_pro_logger"
+
+
+## Install with security (optional)
+
+To enable high security for all our gems:
+
+    wget http://sixarm.com/sixarm.pem
+    gem cert --add sixarm.pem
+    gem sources --add http://sixarm.com
+
+To install with high security:
+
+    gem install sixarm_ruby_pro_logger --test --trust-policy HighSecurity
+
 
 
 ## Thanks
@@ -114,6 +116,7 @@ https://github.com/topfunky/hodel_3000_compliant_logger/
 
 ## Changes
 
+* 2014-03-16 2.0.1 Change defaults to use newlines for readability
 * 2014-03-15 2.0.0 Upgrades to be a formatter plus new options
 * 2012-03-14 1.1.0 Update docs, tests
 * 2011-11-27 1.0.0 Publish

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.0.1

data/lib/sixarm_ruby_pro_logger.rb

@@ -31,14 +31,14 @@ class ProLogger < Logger
   #   * pid: The process id number.
   #       Default is `Process.pid`.
   #
-  #   * message_separator: Text to use to join mutiple messages.
-  #       Default is " ... ".
+  #   * message_separator: Print this between mutiple messages.
+  #       Default is "\n".
   #
   #   * backtrace_separator: Print this between exception backtrace lines.
-  #       Default is " ... ".
+  #       Default is "\n".
   #
-  #   * line_separator: Change any message newlines to this text.
-  #       Default is " ... ".
+  #   * line_separator: Print this between message lines.
+  #       Default is "\n", which is the same as no change.
   #   
   # @param [Hash] options
   #
@@ -47,9 +47,9 @@ class ProLogger < Logger
     @progname = (options[:progname] || $PROGRAM_NAME).to_s
     @hostname = (options[:hostname] || (require('socket') && Socket.gethostname)).to_s
     @pid = (options[:pid] || Process.pid).to_s
-    @message_separator = (options[:message_separator] || " ... ").to_s
-    @backtrace_separator = (options[:backtrace_separator] || " ... ").to_s
-    @line_separator = (options[:line_separator] || " ... ").to_s
+    @message_separator = (options[:message_separator] || "\n").to_s
+    @backtrace_separator = (options[:backtrace_separator] || "\n").to_s
+    @line_separator = (options[:line_separator] || "\n").to_s
   end
 
   # Call the formatter.
@@ -94,7 +94,10 @@ class ProLogger < Logger
     else
       message_string_when_object(msg)
     end
-    return s.gsub(/\n/, line_separator).lstrip
+    if line_separator && line_separator != "\n"
+      s = s.gsub!(/\n/, line_separator)
+    end
+    return s.lstrip
   end
   
   def message_string_when_string(msg)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_pro_logger
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - SixArm
@@ -30,7 +30,7 @@ cert_chain:
   sWRVEyjnjnNuAeLP9zv43IDXjS22L2efhap7IOinYjcecpfXJgQaU+6BFAY4sdkQ
   S1STYSfs3qySBxxAeEyZTw==
   -----END CERTIFICATE-----
-date: 2014-03-15 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies: []
 description: Logs more information than the typical Ruby logger.
 email: sixarm@sixarm.com