sixarm_ruby_pro_logger 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34a5a270bef744bb89bc22bec7c69356dc0f5774
+  data.tar.gz: dba64dbde5d2c794a1b437640f9e9531df33b05b
+SHA512:
+  metadata.gz: 6d78fa563f69873550d86c308633363c284dfdcf5155ed11fdca21a3f4dad88fd03d2699ccb2335a88b555d6528b5790ea5a9f361e7fbe9993feb40c1afdc8a9
+  data.tar.gz: 43c65006a33b2c97680ccd66d3717211e49a637dcfa2db5a5257116783e480cbd4ae827626169526a137c52d720099520efcf041ed45619f79f565419369ddcc

checksums.yaml.gz.sig

@@ -0,0 +1,4 @@
+X}&b�$�{PF�w�o��ٰ�/~=x\���5m�)2�t�=�l���;��fR��ZR�S7u�%����nGH���K+���w;S���)?X�?Y���(5�&LK�9r�+J!W��л��WE�[�`�|4���V�
+k�]���l�>�S�8ܥ>ҷ)�s��xJ��^�߯9>�`s��z�u���(gs$��(
+��q��,æS�/�q�)��q��(-������V
+@��%�)�0��B

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+Thank you for contributing!
+
+If you would like to contribute a donation, an easy way is to use PayPal to sixarm@sixarm.com.
+
+If you would like to contribute help, the next section is for you.
+
+
+## Contributing to the source
+
+We love pull requests for improvments to the source code and documentation.
+
+There are three easy steps:
+
+1. Fork the repo. 
+
+  * Before you do any work please run our existing tests to make sure the code runs cleanly.
+
+2. Work as you like. 
+
+   * Please create tests. This helps us know that all your code runs cleanly.
+
+3. Push to your fork and submit a pull request.
+
+   * We'll take a look as soon as we can; this is typically within a business day.
+
+Thank you again!

data/README.md

@@ -0,0 +1,148 @@
+# SixArm.com » Ruby » <br> ProLogger custom logger with better information
+
+* Doc: <http://sixarm.com/sixarm_ruby_pro_logger/doc>
+* Gem: <http://rubygems.org/gems/sixarm_ruby_pro_logger>
+* Repo: <http://github.com/sixarm/sixarm_ruby_pro_logger>
+* Email: Joel Parker Henderson, <joel@sixarm.com>
+
+
+## Introduction
+
+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)
+
+Example setup:
+
+    Rails.logger.formatter = ProLogger.new
+
+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
+
+Intialize options:
+
+  * time_format: A format string for the `time.strftime` method.
+      Defaults to `"%Y-%m-%dT%H:%M:%SZ"` which is ISO 8601 format.
+ 
+  * progname: The running program name.
+      Default is `$PROGRAM_NAME`.
+  
+  * hostname: The server host name.
+      Default is `Socket.gethostname`.
+  
+  * pid: The process id number.
+      Default is `Process.pid`.
+  
+  * message_separator: Text to use to join mutiple messages.
+      Default is " ... ".
+  
+  * backtrace_separator: Print this between exception backtrace lines.
+      Default is " ... ".
+  
+  * line_separator: Change any message newlines to this text.
+      Default is " ... ".    
+
+Example:
+
+    Rails.logger.formatter = ProLogger.new(
+      strftime: "%Y-%m-%dT%H:%M:%SZ", 
+      progname: "my_program"
+      hostname: "my.example.com", 
+      pid: 1000,
+      line_separator: " / "
+      backtrace_separator " \"
+      message_separator: " | " 
+    )
+
+The message can be:
+
+  * a string: print the string, with leading whitespace stripped, and newlines replaced by line_separator.
+
+  * an exception: print the class, message, and backtrace items separated by backtrace_separator.
+
+  * 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.
+
+
+## Thanks
+
+Thanks to topfunky for the open source custom logger at:
+https://github.com/topfunky/hodel_3000_compliant_logger/
+
+
+## Changes
+
+* 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
+
+
+## License
+
+You may choose any of these open source licenses:
+
+  * Apache License
+  * BSD License
+  * CreativeCommons License, Non-commercial Share Alike
+  * GNU General Public License Version 2 (GPL 2)
+  * GNU Lesser General Public License (LGPL)
+  * MIT License
+  * Perl Artistic License
+  * Ruby License
+
+The software is provided "as is", without warranty of any kind, 
+express or implied, including but not limited to the warranties of 
+merchantability, fitness for a particular purpose and noninfringement. 
+
+In no event shall the authors or copyright holders be liable for any 
+claim, damages or other liability, whether in an action of contract, 
+tort or otherwise, arising from, out of or in connection with the 
+software or the use or other dealings in the software.
+
+This license is for the included software that is created by SixArm;
+some of the included software may have its own licenses, copyrights, 
+authors, etc. and these do take precedence over the SixArm license.
+
+Copyright (c) 2005-2014 Joel Parker Henderson

data/Rakefile

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/*.rb'
+end

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/lib/sixarm_ruby_pro_logger.rb

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Please see README
+=end
+
+require 'logger'
+
+class ProLogger < Logger
+
+  attr_accessor :time_format
+  attr_accessor :progname
+  attr_accessor :hostname
+  attr_accessor :pid
+  attr_accessor :message_separator
+  attr_accessor :backtrace_separator
+  attr_accessor :line_separator
+
+  # Initialize the Rails logger formatter.
+  #
+  # Options:
+  #
+  #   * time_format: A format string for the `time.strftime` method.
+  #       Default is `"%Y-%m-%dT%H:%M:%SZ"` which is ISO 8601 format.
+  #
+  #   * progname: The running program name.
+  #       Default is `$PROGRAM_NAME`.
+  #
+  #   * hostname: The server host name.
+  #       Default is `Socket.gethostname`.
+  #
+  #   * pid: The process id number.
+  #       Default is `Process.pid`.
+  #
+  #   * message_separator: Text to use to join mutiple messages.
+  #       Default is " ... ".
+  #
+  #   * backtrace_separator: Print this between exception backtrace lines.
+  #       Default is " ... ".
+  #
+  #   * line_separator: Change any message newlines to this text.
+  #       Default is " ... ".
+  #   
+  # @param [Hash] options
+  #
+  def initialize(options={})
+    @time_format = (options[:time_format] || "%Y-%m-%dT%H:%M:%SZ").to_s
+    @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
+  end
+
+  # Call the formatter.
+  #
+  # All of the params will be converted to strings;
+  # it's fine to send objects instead of strings.
+  #
+  # We strip the message of extraneous whitespace.
+  #
+  # See #initialize for the defaults.
+  #
+  # @param severity [String] the severity object, such as `"INFO"`. 
+  # @param time [Time] the time, typically `Time.now.utc`.
+  # @param progname [String] the program name, which is anything you like.
+  # @param msg [String] the message.
+  #
+  def call(severity, time, progname, msg)
+    "#{time_string(time)} #{progname_string(progname)} #{hostname} #{pid} #{severity_string(severity)} #{message_string(msg)}\n"
+  end
+
+  def time_string(time)
+    time.utc.strftime(time_format)
+  end
+
+  def progname_string(progname)
+    (progname || self.progname).to_s
+  end
+
+  def severity_string(severity)
+    (severity || self.severity).to_s
+  end
+
+  def message_string(msg)
+    s = \
+    case msg
+    when ::String
+      message_string_when_string(msg)
+    when ::Exception
+      message_string_when_exception(msg)
+    when ::Array
+      message_string_when_array(msg)
+    else
+      message_string_when_object(msg)
+    end
+    return s.gsub(/\n/, line_separator).lstrip
+  end
+  
+  def message_string_when_string(msg)
+    msg
+  end
+
+  def message_string_when_array(msg)
+    msg.map{|item| message_string(item)}.join(message_separator)
+  end
+
+  def message_string_when_exception(msg)
+    "#{msg.class} #{msg.message}: " + (msg.backtrace || []).join(backtrace_separator)
+  end
+
+  def message_string_when_object(msg)
+    msg.inspect
+  end
+
+end

data/test/sixarm_ruby_pro_logger_test.rb

@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+require 'minitest/autorun'
+require 'simplecov'
+SimpleCov.start
+require 'sixarm_ruby_pro_logger'
+
+class ProLoggerTest < Minitest::Test
+
+  def test_initialize
+    x = ProLogger.new(
+      :time_format => "my_time_format",
+      :progname => "my_progname",
+      :hostname => "my_hostname",
+      :pid => "my_pid",
+      :message_separator => "my_message_separator",
+      :backtrace_separator => "my_backtrace_separator",
+      :line_separator => "my_line_separator",
+    )
+    assert_equal("my_time_format", x.time_format)
+    assert_equal("my_progname", x.progname)
+    assert_equal("my_hostname", x.hostname)
+    assert_equal("my_pid", x.pid)
+    assert_equal("my_message_separator", x.message_separator)
+    assert_equal("my_backtrace_separator", x.backtrace_separator)
+    assert_equal("my_line_separator", x.line_separator)
+  end
+
+  LOGGER = ProLogger.new
+
+  def test_format_message
+    LOGGER.hostname = "my_hostname"
+    LOGGER.pid = "my_pid"
+    severity = "my_severity"
+    time = Time.now
+    progname = "my_progname"
+    msg = "my_msg"
+    s = LOGGER.call(severity, time, progname, msg)
+    assert(s=~/^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ my_progname my_hostname my_pid my_severity my_msg\n$/, s)
+  end
+
+  def test_time_string
+   assert_match(/^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$/, LOGGER.time_string(Time.now))
+  end
+
+  def test_message_string_when_string
+    msg = "foo"
+    assert_equal("foo", LOGGER.message_string(msg))
+  end
+
+  def test_message_string_when_string_with_leading_whitespace
+    msg = "   foo"
+    assert_equal("foo", LOGGER.message_string(msg))
+  end
+
+  def test_message_string_when_string_with_multiple_lines
+    sep = LOGGER.line_separator
+    msg = "abc\ndef\nghi"
+    assert_equal("abc#{sep}def#{sep}ghi", LOGGER.message_string(msg))
+  end
+
+  def test_message_string_when_array
+    sep = LOGGER.message_separator
+    msg = ['abc','def','ghi']
+    assert_equal("abc#{sep}def#{sep}ghi", LOGGER.message_string(msg))
+  end
+
+  def test_message_string_when_exception
+    msg = RuntimeError.new("hello")
+    msg.set_backtrace(['abc:1','def:2','ghi:3'])
+    sep = LOGGER.backtrace_separator
+    assert_equal("RuntimeError hello: abc:1#{sep}def:2#{sep}ghi:3", LOGGER.message_string_when_exception(msg))
+  end
+
+  def test_message_string_when_object_using_inspect_on_a_number
+    msg = 123
+    assert_equal("123", LOGGER.message_string_when_object(msg))
+  end
+
+  def test_message_string_when_object_using_inspect_on_a_hash
+    msg = {:a => :b}
+    assert_equal("{:a=>:b}", LOGGER.message_string_when_object(msg))
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: sixarm_ruby_pro_logger
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- SixArm
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDbDCCAlSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQ8wDQYDVQQDDAZzaXhh
+  cm0xFjAUBgoJkiaJk/IsZAEZFgZzaXhhcm0xEzARBgoJkiaJk/IsZAEZFgNjb20w
+  HhcNMTQwMzEzMDQyMjE4WhcNMTUwMzEzMDQyMjE4WjA+MQ8wDQYDVQQDDAZzaXhh
+  cm0xFjAUBgoJkiaJk/IsZAEZFgZzaXhhcm0xEzARBgoJkiaJk/IsZAEZFgNjb20w
+  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC5MZYB72Amo9DyeqBdJeEx
+  r4togM0+diNuL1nCH2FSO/+LX5L9mTPEEW5gexYCasmlOfmk5255EToJNtu1JUM/
+  dMqUbNS5LZ1srFVcyDzIe/wQ9f2OSmb+lAGmlnFLfYSpduMv9fPNISlcs5nFYSR9
+  mpS0kTWcXQPLNDl2cfnkYYjDsuyJ8FmDyG7TTF0c4OWJNLxNDE8To2n8GmmDSwr3
+  0K71F278CJlFoIaSSjnhKxkH8/l+z/Vs58KkjX/7M6nwNgNZMQaFBIO02UDtCi2F
+  ICVtDuWdK0YLv3JnIzvSQPQsfArrw2s8RVKjXlelPMeHJIcCEZcS4K6HIg7vQCkP
+  AgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQrbLvF
+  TNv9r72z+hpCl3BkTPbzwTAcBgNVHREEFTATgRFzaXhhcm1Ac2l4YXJtLmNvbTAc
+  BgNVHRIEFTATgRFzaXhhcm1Ac2l4YXJtLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEA
+  H08J7cTJyfm4mXpdM0FFr/f/syQSl2ymJWtcosuKA79A/vYMZ+n9B1gpuJmegjNt
+  lmYByeU50jJJ7JNdkvkTagHCZaxtzclWx6AR5gTd8V/sBKbTWtHe72pOWz/stQs2
+  xD8tQZvdAuBtRXx4ys6e3vigvYjdmTHUR9tT/NGCwmWj7KTk3mwNKBmuQGWTVWrV
+  h6r4cFMt3X5Zu+euYxHqDuwWyub9hp4s30/ea38CoYNdIZcSFtpGuvhwVDU0x5dg
+  sWRVEyjnjnNuAeLP9zv43IDXjS22L2efhap7IOinYjcecpfXJgQaU+6BFAY4sdkQ
+  S1STYSfs3qySBxxAeEyZTw==
+  -----END CERTIFICATE-----
+date: 2014-03-15 00:00:00.000000000 Z
+dependencies: []
+description: Logs more information than the typical Ruby logger.
+email: sixarm@sixarm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemtest"
+- CONTRIBUTING.md
+- README.md
+- Rakefile
+- VERSION
+- lib/sixarm_ruby_pro_logger.rb
+- test/sixarm_ruby_pro_logger_test.rb
+homepage: http://sixarm.com/
+licenses:
+- BSD
+- GPL
+- MIT
+- PAL
+- Various
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: SixArm.com » Ruby » ProLogger custom logger for Rails
+test_files:
+- test/sixarm_ruby_pro_logger_test.rb
+has_rdoc: true