jellog 1.0.14 → 1.0.17

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGM0ZjQyNmVkMzRiMDMyZjM4MzI2YjFjN2UxODQ0NTk3ODc3OGUwZA==
+  data.tar.gz: !binary |-
+    ZmE5YjYzYzZlODBjZTFiN2FlMzYxYmUyMWE1MTYzNTQ1NWEyZWE2MQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDE2MGQ5NzllZjg1MzEzNTBiOWNlODJhODk0NjMwZDc3OGZkYzQ5MGUxMWJl
+    ZmYxZWIwZjgwOTg4M2I3NzE2OGNjMzZiYTE0YTFkMjNmZDVmMDhlYmNlMTY5
+    MWJkZTdmMmFkZTNmMmRmZTZhNTA2ZTM1NDcwYmQ4ZTc2MGUzMTA=
+  data.tar.gz: !binary |-
+    ZWJhOWI5ZTg4ZjhjOGQ3MDVlOTQ5OWFmMmI2OGJjNTFlNWQ5N2NiNzBiODRm
+    MGMyY2UzMDBhN2EwZWM5MTcwN2E5MTA5NzY3MDBjYzg2NjIwZDMyN2JlMTc5
+    YTRhYjQ1ZGNiNjNhZGRkY2M5YTA2MTZkYTI3ZDE3YjBhZDhiYWQ=

data/History.txt

@@ -1,5 +1,17 @@
 == History
 
+[jellog-1.0.17 02-Aug-2013]
+
+  Ensuring 1.9 compliance (just changed the shebang on the pointless bin file)
+
+[jellog-1.0.16 02-Aug-2013]
+
+  Add :suppress option to block messages other than :warn, :error, :fatal and :exception
+
+[jellog-1.0.15 19-Jul-2013]
+
+  Add a proxy logger to enable logging to either a full logger or to a display
+
 [jellog-1.0.14 17-Nov-2012]
 
   Revert to /var/log/jerbil

data/README.md

@@ -12,7 +12,8 @@ adds a few features that may be useful:
 * provides a 'puts' method to enable apps to output to either console or log (e.g foreground
   vs background);
 * returns logged messages, e.g. to cascade into exceptions
-* simple log level control.
+* simple log level control;
+* proxy class that responds to same methods and outputs to stderr
 
 
 **GitHub:** [https://github.com/osburn-sharp/jellog](https://github.com/osburn-sharp/jellog)
@@ -94,6 +95,24 @@ to the logger only. Check out the Jeckyl class method #intersection to get these
     nonlog_opts = full_opts.complement(log_opts)
     
 More details of Jeckyl can be found on [GitHub](https://github.com/osburn-sharp/jeckyl).
+
+### Using the Proxy Logger
+
+There may be times when you want to write code that can log to a full logger or just to the 
+display, depending on who calls it. Logging everything with puts may work but is very limited.
+The proxy logger allows you to substitute a logger that responds to all the same methods 
+but outputs messages to the display - with colours but without timestamps. 
+
+For example, a module may be used by a service, in which case it would log messages to the
+service's log using the service's logger. Or it may be used by a CLI, in which case you want the
+same messages to go straight to the display.
+
+    proxy = Jellog::ProxyLogger.new(appname, options)
+    proxy.system "A system message"
+    
+Proxy responds to all the same methods. It does not log anything to syslog. By adding a
+:suppress flag to the options, you can stop Proxy from producing anything other than
+error messages.
     
 ## Code Walkthrough
 

data/bin/jellog

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby18
+#!/usr/bin/env ruby
 #
 # Description
 #

data/lib/jellog/proxy.rb

@@ -0,0 +1,90 @@
+#
+#
+# = Jellog Stdout Logger
+#
+# == Looks like Jellog but outputs to stdout
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2013 Robert Sharp
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file copyright.txt. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+#
+# 
+#
+require 'jellog'
+
+module Jellog
+  
+  # A proxy for a conventional logger that outputs
+  # everything to stdout/stderr
+  #
+  class ProxyLogger < Jellog::Logger
+    
+    # create a proxy logger
+    #
+    # can be used instead of {Jellog::Logger} to output logs to the
+    # display
+    #
+    # @params [String] appname to display in the log
+    # @params [Hash] log_opts hash of options
+    # @option [Symbol] :log_level to log to (:system, :verbose, :debug)
+    # @option [Boolean] :log_coloured
+    # @option [Boolean] :suppress messages unless warn, error or fatal
+    # @return [Jellog::ProxyLogger] self
+    def initialize(appname, log_opts={})
+      
+      @appname = appname
+      #@log_opts = LogOpts.merge(log_opts)
+      
+      @log_level = log_opts.delete(:log_level) || :system
+      @mark = log_opts[:log_mark] || ' *** MARK ***'
+      
+      @logger = Jellog::Plogger.new(appname, log_opts[:log_coloured], log_opts[:suppress])
+      
+    end
+    
+  end
+  
+  # internal logger used by the proxy to send everything to stderr
+  class Plogger < Jellog::Slogger
+    
+    # create a proxy output logger using stderr
+    #
+    # @params [String] appname to display in the log
+    # @params [Boolean] coloured or not
+    # @return [Jellog::Plogger] self
+    def initialize(appname, coloured, suppress)
+      # don't need a time stamp, so use the format string to prefix the appname
+      @format_str = appname
+      @coloured = coloured
+      @suppress = suppress
+      @colours = Levels
+      @logger = $stderr
+    end
+    
+    # when suppress is enabled, ignore messages that are suppressed
+    def method_missing(meth, msg)
+      
+      return if @suppress && suppressed_msgs.include?(meth)
+      
+      super(meth, msg)
+      
+    end
+    
+    # defines suppressed messages
+    def suppressed_msgs
+      [:system, :info, :verbose, :debug]
+    end
+    
+    # ensure a user does not accidentally close stderr
+    def close
+      # do nothing
+    end
+    
+  end
+  
+end

data/lib/jellog/version.rb

@@ -1,13 +1,13 @@
 # Created by Jevoom
 #
-# 17-Nov-2012
-#   Revert to /var/log/jerbil
+# 02-Aug-2013
+#   Ensuring 1.9 compliance (just changed the shebang on the pointless bin file)
 
 module Jellog
-  # version set to 1.0.14
-  Version = '1.0.14'
-  # date set to 17-Nov-2012
-  Version_Date = '17-Nov-2012'
-  #ident string set to: jellog-1.0.14 17-Nov-2012
-  Ident = 'jellog-1.0.14 17-Nov-2012'
+  # version set to 1.0.17
+  Version = '1.0.17'
+  # date set to 02-Aug-2013
+  Version_Date = '02-Aug-2013'
+  #ident string set to: jellog-1.0.17 02-Aug-2013
+  Ident = 'jellog-1.0.17 02-Aug-2013'
 end

data/spec/jellog_logger_spec.rb

@@ -15,6 +15,8 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 # most of these tests require you to check the log file
 
+puts RUBY_VERSION
+
 describe 'Logger' do
   
   before(:each) do

data/test/jellogtest.log

@@ -1,6 +1,6 @@
-[2012-10-02 14:30:47] INFO - Hello
-[2012-10-02 14:30:47] DEBUG - This should be green
-[2012-10-02 14:30:47] WARN - This should be yellow
-[2012-10-02 14:30:47] ERROR - This should be red
-[2012-10-02 14:30:47] FATAL - This should be red and bold
-[2012-10-02 14:30:47] SYSTEM - This should be blue
+[2013-08-23 08:48:26] INFO - Hello
+[2013-08-23 08:48:26] DEBUG - This should be green
+[2013-08-23 08:48:26] WARN - This should be yellow
+[2013-08-23 08:48:26] ERROR - This should be red
+[2013-08-23 08:48:26] FATAL - This should be red and bold
+[2013-08-23 08:48:26] SYSTEM - This should be blue

data/test/jellogtest1.log

@@ -1,6 +1,6 @@
-[2012-10-02 14:30:47] INFO - Hello
-[2012-10-02 14:30:47] DEBUG - This should be white
-[2012-10-02 14:30:47] WARN - This should be white
-[2012-10-02 14:30:47] ERROR - This should be white
-[2012-10-02 14:30:47] FATAL - This should be white
-[2012-10-02 14:30:47] SYSTEM - This should be white
+[2013-08-23 08:48:26] INFO - Hello
+[2013-08-23 08:48:26] DEBUG - This should be white
+[2013-08-23 08:48:26] WARN - This should be white
+[2013-08-23 08:48:26] ERROR - This should be white
+[2013-08-23 08:48:26] FATAL - This should be white
+[2013-08-23 08:48:26] SYSTEM - This should be white

data/test/jellogtest2.log

@@ -1,6 +1,6 @@
-[2012-10-02 14:30:47] INFO - Hello
-[2012-10-02 14:30:47] DEBUG - This should be red
-[2012-10-02 14:30:47] WARN - This should be yellow
-[2012-10-02 14:30:47] ERROR - This should be red
-[2012-10-02 14:30:47] FATAL - This should be red and bold
-[2012-10-02 14:30:47] SYSTEM - This should be green
+[2013-08-23 08:48:26] INFO - Hello
+[2013-08-23 08:48:26] DEBUG - This should be red
+[2013-08-23 08:48:26] WARN - This should be yellow
+[2013-08-23 08:48:26] ERROR - This should be red
+[2013-08-23 08:48:26] FATAL - This should be red and bold
+[2013-08-23 08:48:26] SYSTEM - This should be green

data/test/proxy_test.rb

@@ -0,0 +1,60 @@
+#
+#
+# = Test Stdout
+#
+# == SubTitle
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2013 Robert Sharp
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file copyright.txt. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+#
+# 
+#
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+
+require 'jellog/proxy'
+
+logger = Jellog::ProxyLogger.new('tester', :log_coloured=>true, :log_level=>:debug)
+
+logger.system "System Message"
+logger.info "Information Message"
+logger.verbose "Verbose Message"
+logger.debug "Debug Message"
+logger.warn "Warning Message"
+logger.error "Error Message"
+logger.fatal "Fatal Message"
+
+begin
+  raise ArgumentError, "Wrong argument"
+rescue Exception => e
+  logger.exception(e)
+end
+
+logger.puts "A plain old bit of text to finish"
+logger.mark
+
+logger = Jellog::ProxyLogger.new('tester', :log_coloured=>true, :log_level=>:debug, :suppress=>true)
+
+logger.system "System Message"
+logger.info "Information Message"
+logger.verbose "Verbose Message"
+logger.debug "Debug Message"
+logger.warn "Warning Message"
+logger.error "Error Message"
+logger.fatal "Fatal Message"
+
+begin
+  raise ArgumentError, "Wrong argument"
+rescue Exception => e
+  logger.exception(e)
+end
+
+logger.puts "A plain old bit of text to finish"

metadata

@@ -1,93 +1,95 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jellog
-version: !ruby/object:Gem::Version 
-  hash: 11
-  prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 14
-  version: 1.0.14
+version: !ruby/object:Gem::Version
+  version: 1.0.17
 platform: ruby
-authors: 
+authors:
 - Dr Robert
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-17 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    dGVybS1hbnNpY29sb3I=
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  name: term-ansicolor
-  version_requirements: *id001
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    dGhvcg==
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  name: thor
-  version_requirements: *id002
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: !binary |-
+    amVja3ls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  name: jeckyl
-  version_requirements: *id003
   prerelease: false
-description: |
-  A wrapper class around the standard Ruby logger that adds a simply logging level control
-  and the ability to log certain messages to syslog. It also adds a puts method so that the
-  logger can be used instead of stdout etc. Output can be coloured depending on the logging
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'A wrapper class around the standard Ruby logger that adds a simply
+  logging level control
+
+  and the ability to log certain messages to syslog. It also adds a puts method so
+  that the
+
+  logger can be used instead of stdout etc. Output can be coloured depending on the
+  logging
+
   level.
 
+'
 email: robert@osburn-sharp.ath.cx
-executables: 
+executables:
 - jellog
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - Bugs.rdoc
 - Intro.txt
 - LICENCE.rdoc
 - Gemfile
 - README.md
-files: 
+files:
 - History.txt
 - Bugs.rdoc
 - Intro.txt
 - LICENCE.rdoc
 - Gemfile
 - README.md
-- lib/jellog/logger.rb
 - lib/jellog/version.rb
 - lib/jellog/config.rb
 - lib/jellog/config.md
+- lib/jellog/logger.rb
+- lib/jellog/proxy.rb
 - lib/jellog.rb
 - bin/jellog
 - spec/spec.opts
@@ -95,7 +97,7 @@ files:
 - spec/slogger_spec.rb
 - spec/jellog_logger_spec.rb
 - spec/jellog_spec.rb
-- test/conf.d/jellogga.rb
+- test/conf.d/jellog.rb
 - test/log_file.log
 - test/jellytest.log
 - test/jellytest1.log
@@ -103,38 +105,30 @@ files:
 - test/jellogtest1.log
 - test/jellogtest2.log
 - test/jellogtest.log
-homepage: 
-licenses: 
+- test/proxy_test.rb
+homepage: ''
+licenses:
 - Open Software Licence v3.0
+metadata: {}
 post_install_message: Jellog is now installed. Type 'jellog' for help
-rdoc_options: 
+rdoc_options:
 - --main=README.rdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+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: 1.8.24
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Jellog is a simple Ruby logger with a few added extras
 test_files: []
-