log_switch 0.3.0 → 0.4.0

data/History.rdoc

@@ -1,3 +1,11 @@
+=== 0.4.0 / 2012-11-12
+
+* Improvements:
+  * gh-4[https://github.com/turboladen/log_switch/issues/4]: Added ability to
+    toggle the prepending of the class name to log messages.  This lets you
+    know which class/object is logging each message--useful for when you have
+    a number of different classes logging.
+
 === 0.3.0 / 2012-02-03
 
 * Improvements:

data/README.rdoc

@@ -132,6 +132,34 @@ use +MyThing::Logger.log+:
 This lets you still use a single logger throughout your classes, but shortens
 the amount of typing you have to do.
 
+=== Prepend class name of #log caller to the message
+
+When you've got a bunch of different classes doing logging, it's easy to get
+lost in all the text.  Adding the class name of the class that's logging a
+message can make this easier to read.  Now log_switch will do that for you, if
+you use its Mixin.
+
+  # lib/my_thing/logger.rb
+  class MyThing::Logger
+    extend LogSwitch
+  end
+
+  MyThing::Logger.log_class_name = true
+
+  # lib/my_thing/barrel_roller.rb
+  class MyThing::BarrelRoller
+    include LogSwitch::Mixin
+
+    def do_one
+      log "I did a barrel roll!"
+    end
+  end
+
+  # somewhere else...
+  barrel_roller = MyThing::BarrelRoller.new
+  barrel_roller.do_one      # => D, [2012-11-12T21:11:32.133414 #16645] DEBUG -- : <MyThing::BarrelRoller> I did a barrel roll!
+
+
 == REQUIREMENTS
 
 * Rubies (tested):

data/Rakefile

@@ -2,12 +2,9 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'yard'
 
-# Load all extra rake task definitions
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].each { |ext| load ext }
-
 YARD::Rake::YardocTask.new do |t|
   t.files = %w(lib/**/*.rb - History.rdoc)
-  t.options = %w(--title log_switch Documentation (#{LogSwitch::VERSION}))
+  t.options = %W(--title log_switch Documentation (#{LogSwitch::VERSION}))
   t.options += %w(--main README.rdoc)
 end
 
@@ -15,8 +12,18 @@ RSpec::Core::RakeTask.new do |t|
   t.ruby_opts = %w(-w)
 end
 
-# Alias for rubygems-test
-task :test => :spec
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" && RUBY_VERSION > "1.9"
+  require 'tailor/rake_task'
+
+  Tailor::RakeTask.new do |task|
+    task.file_set 'lib/**/*.rb'
+    task.file_set 'spec/**/*.rb', :specs
+  end
 
-task :default => :install
+# Alias for rubygems-test
+  task :test => [:spec, :tailor]
+else
+  task :test => :spec
+end
 
+task :default => :test

data/lib/log_switch.rb

@@ -25,27 +25,36 @@ module LogSwitch
   # Use to turn logging on or off.
   attr_writer :log
 
+  # Set this to the Logger you want to use.
+  attr_writer :logger
+
+  # Set the log level so you don't have to pass it in on your call.
+  attr_writer :log_level
+
+  # Toggle prepending the class name of the #log caller to the log message.
+  attr_writer :log_class_name
+
   # Tells whether logging is turned on or not.
   def log?
     @log != false
   end
 
-  # Set this to the Logger you want to use.
-  attr_writer :logger
-
   # Defaults to a +Logger+ writing to STDOUT.
   def logger
     @logger ||= ::Logger.new STDOUT
   end
 
-  # Set the log level so you don't have to pass it in on your call.
-  attr_writer :log_level
-
   # @return [Symbol] The current default log level.  Starts off as :debug.
   def log_level
     @log_level ||= :debug
   end
 
+  # @return [Boolean] Tells whether logging of the class name with the log
+  #   message is turned on.
+  def log_class_name?
+    @log_class_name == true
+  end
+
   # {#log} calls the block given to this method before it logs every time.
   # This, thus, acts as a hook in the case where you want to make sure some
   # code gets executed before you log a message.  Useful for making sure a file
@@ -79,6 +88,6 @@ module LogSwitch
   def reset_config!
     self.log = true
     self.logger = ::Logger.new STDOUT
-    self.log_level = :debug
+    self.log_class_name = false
   end
 end

data/lib/log_switch/mixin.rb

@@ -10,6 +10,17 @@ module LogSwitch
     def self.included(klass)
       if LogSwitch.extender
         klass.send :define_method, :log do |*args|
+          if LogSwitch.extender.log_class_name? &&
+            LogSwitch.extender.logger.class == Logger
+
+            if args.size == 1
+              args = "<#{klass}> #{args.join}"
+            else
+              msg = args.delete_at 0
+              args.unshift("<#{klass}> #{msg}")
+            end
+          end
+
           LogSwitch.extender.log *args
         end
       else

data/lib/log_switch/version.rb

@@ -1,3 +1,3 @@
 module LogSwitch
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/log_switch.gemspec

@@ -7,21 +7,31 @@ Gem::Specification.new do |s|
   s.authors = ["Steve Loveless"]
   s.homepage = %q(http://github.com/turboladen/log_switch)
   s.email = %w(steve.loveless@gmail.com)
-  s.summary = %q(Extends a class for singleton style logging that can easily be turned on and off.)
-  s.description = %q(Extends a class for singleton style logging that can easily be turned on and off.)
+  s.summary = %q(Extends a class for singleton style logging that can easily be
+                 turned on and off.)
+  s.description = %q(Extends a class for singleton style logging that can 
+                     easily be turned on and off.)
 
   s.required_rubygems_version = ">=1.8.0"
-  s.files = Dir.glob("{lib,spec}/**/*") + Dir.glob("*.rdoc") +
+  s.files = Dir.glob("{lib,spec}/**/*") +
+    Dir.glob("*.rdoc") +
     %w(.gemtest Gemfile log_switch.gemspec Rakefile)
+
   s.test_files = Dir.glob("{spec}/**/*")
-  s.require_paths = ["lib"]
+  s.require_paths = %w(lib)
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", ">= 2.6.0"
 
-  s.add_development_dependency("bundler", [">= 0"])
-  s.add_development_dependency("rake", [">= 0"])
-  s.add_development_dependency("rspec", ["~> 2.6.0"])
   if RUBY_VERSION > '1.9'
-    s.add_development_dependency("simplecov", [">= 0"])
+    s.add_development_dependency "simplecov"
+
+    if defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby"
+      s.add_development_dependency("tailor", ">=1.1.2")
+    end
   end
-  s.add_development_dependency("yard", [">= 0.7.2"])
+
+  s.add_development_dependency "yard", ">= 0.7.2"
 end
 

data/spec/coverage/assets/0.5.3/app.js

@@ -0,0 +1,88 @@
+$(document).ready(function() {
+  // Configuration for fancy sortable tables for source file groups
+  $('.file_list').dataTable({
+    "aaSorting": [[ 1, "asc" ]],
+    "bPaginate": false,
+    "bJQueryUI": true,
+    "aoColumns": [
+			null,
+		  { "sType": "percent" },
+			null,
+			null,
+			null,
+			null,
+      null
+		]
+  });
+  
+  // Syntax highlight all files up front - deactivated
+  // $('.source_table pre code').each(function(i, e) {hljs.highlightBlock(e, '  ')});
+  
+  // Syntax highlight source files on first toggle of the file view popup
+  $("a.src_link").click(function() {
+    // Get the source file element that corresponds to the clicked element
+    var source_table = $($(this).attr('href'));
+    
+    // If not highlighted yet, do it!
+    if (!source_table.hasClass('highlighted')) {
+      source_table.find('pre code').each(function(i, e) {hljs.highlightBlock(e, '  ')});
+      source_table.addClass('highlighted');
+    };
+  });
+  
+  // Set-up of popup for source file views
+  $("a.src_link").fancybox({
+		'hideOnContentClick': true,
+		'centerOnScroll': true,
+		'width': '90%',
+		'padding': 0,
+		'transitionIn': 'elastic'
+  });
+	
+	// Hide src files and file list container after load
+  $('.source_files').hide();
+  $('.file_list_container').hide();
+  
+  // Add tabs based upon existing file_list_containers
+  $('.file_list_container h2').each(function(){
+    var container_id = $(this).parent().attr('id');
+    var group_name = $(this).find('.group_name').first().html();
+    var covered_percent = $(this).find('.covered_percent').first().html();
+    
+    $('.group_tabs').append('<li><a href="#' + container_id + '">' + group_name + ' ('+ covered_percent +')</a></li>');
+  });
+
+  $('.group_tabs a').each( function() {
+    $(this).addClass($(this).attr('href').replace('#', ''));
+  });
+  
+  // Make sure tabs don't get ugly focus borders when active
+  $('.group_tabs a').live('focus', function() { $(this).blur(); });
+  
+  var favicon_path = $('link[rel="shortcut icon"]').attr('href');
+  $('.group_tabs a').live('click', function(){
+    if (!$(this).parent().hasClass('active')) {
+      $('.group_tabs a').parent().removeClass('active');
+      $(this).parent().addClass('active');
+      $('.file_list_container').hide();
+      $(".file_list_container" + $(this).attr('href')).show();
+      window.location.href = window.location.href.split('#')[0] + $(this).attr('href').replace('#', '#_');
+      
+      // Force favicon reload - otherwise the location change containing anchor would drop the favicon...
+      // Works only on firefox, but still... - Anyone know a better solution to force favicon on local file?
+      $('link[rel="shortcut icon"]').remove();
+      $('head').append('<link rel="shortcut icon" type="image/png" href="'+ favicon_path +'" />');
+    };
+    return false;
+  });
+  
+  if (jQuery.url.attr('anchor')) {
+    $('.group_tabs a.'+jQuery.url.attr('anchor').replace('_', '')).click();
+  } else {
+    $('.group_tabs a:first').click();
+  };
+  
+  $("abbr.timeago").timeago();
+  $('#loading').fadeOut();
+  $('#wrapper').show();
+});

data/spec/coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.css

@@ -0,0 +1,363 @@
+/*
+ * FancyBox - jQuery Plugin
+ * Simple and fancy lightbox alternative
+ *
+ * Examples and documentation at: http://fancybox.net
+ * 
+ * Copyright (c) 2008 - 2010 Janis Skarnelis
+ *
+ * Version: 1.3.1 (05/03/2010)
+ * Requires: jQuery v1.3+
+ *
+ * Dual licensed under the MIT and GPL licenses:
+ *   http://www.opensource.org/licenses/mit-license.php
+ *   http://www.gnu.org/licenses/gpl.html
+ */
+
+#fancybox-loading {
+	position: fixed;
+	top: 50%;
+	left: 50%;
+	height: 40px;
+	width: 40px;
+	margin-top: -20px;
+	margin-left: -20px;
+	cursor: pointer;
+	overflow: hidden;
+	z-index: 1104;
+	display: none;
+}
+
+* html #fancybox-loading {	/* IE6 */
+	position: absolute;
+	margin-top: 0;
+}
+
+#fancybox-loading div {
+	position: absolute;
+	top: 0;
+	left: 0;
+	width: 40px;
+	height: 480px;
+	background-image: url('fancybox.png');
+}
+
+#fancybox-overlay {
+	position: fixed;
+	top: 0;
+	left: 0;
+	bottom: 0;
+	right: 0;
+	background: #000;
+	z-index: 1100;
+	display: none;
+}
+
+* html #fancybox-overlay {	/* IE6 */
+	position: absolute;
+	width: 100%;
+}
+
+#fancybox-tmp {
+	padding: 0;
+	margin: 0;
+	border: 0;
+	overflow: auto;
+	display: none;
+}
+
+#fancybox-wrap {
+	position: absolute;
+	top: 0;
+	left: 0;
+	margin: 0;
+	padding: 20px;
+	z-index: 1101;
+	display: none;
+}
+
+#fancybox-outer {
+	position: relative;
+	width: 100%;
+	height: 100%;
+	background: #FFF;
+}
+
+#fancybox-inner {
+	position: absolute;
+	top: 0;
+	left: 0;
+	width: 1px;
+	height: 1px;
+	padding: 0;
+	margin: 0;
+	outline: none;
+	overflow: hidden;
+}
+
+#fancybox-hide-sel-frame {
+	position: absolute;
+	top: 0;
+	left: 0;
+	width: 100%;
+	height: 100%;
+	background: transparent;
+}
+
+#fancybox-close {
+	position: absolute;
+	top: -15px;
+	right: -15px;
+	width: 30px;
+	height: 30px;
+	background-image: url('fancybox.png');
+	background-position: -40px 0px;
+	cursor: pointer;
+	z-index: 1103;
+	display: none;
+}
+
+#fancybox_error {
+	color: #444;
+	font: normal 12px/20px Arial;
+	padding: 7px;
+	margin: 0;
+}
+
+#fancybox-content {
+	height: auto;
+	width: auto;
+	padding: 0;
+	margin: 0;
+}
+
+#fancybox-img {
+	width: 100%;
+	height: 100%;
+	padding: 0;
+	margin: 0;
+	border: none;
+	outline: none;
+	line-height: 0;
+	vertical-align: top;
+	-ms-interpolation-mode: bicubic;
+}
+
+#fancybox-frame {
+	position: relative;
+	width: 100%;
+	height: 100%;
+	border: none;
+	display: block;
+}
+
+#fancybox-title {
+	position: absolute;
+	bottom: 0;
+	left: 0;
+	font-family: Arial;
+	font-size: 12px;
+	z-index: 1102;
+}
+
+.fancybox-title-inside {
+	padding: 10px 0;
+	text-align: center;
+	color: #333;
+}
+
+.fancybox-title-outside {
+	padding-top: 5px;
+	color: #FFF;
+	text-align: center;
+	font-weight: bold;
+}
+
+.fancybox-title-over {
+	color: #FFF;
+	text-align: left;
+}
+
+#fancybox-title-over {
+	padding: 10px;
+	background-image: url('fancy_title_over.png');
+	display: block;
+}
+
+#fancybox-title-wrap {
+	display: inline-block;
+}
+
+#fancybox-title-wrap span {
+	height: 32px;
+	float: left;
+}
+
+#fancybox-title-left {
+	padding-left: 15px;
+	background-image: url('fancybox.png');
+	background-position: -40px -90px;
+	background-repeat: no-repeat;
+}
+
+#fancybox-title-main {
+	font-weight: bold;
+	line-height: 29px;
+	background-image: url('fancybox-x.png');
+	background-position: 0px -40px;
+	color: #FFF;
+}
+
+#fancybox-title-right {
+	padding-left: 15px;
+	background-image: url('fancybox.png');
+	background-position: -55px -90px;
+	background-repeat: no-repeat;
+}
+
+#fancybox-left, #fancybox-right {
+	position: absolute;
+	bottom: 0px;
+	height: 100%;
+	width: 35%;
+	cursor: pointer;
+	outline: none;
+	background-image: url('blank.gif');
+	z-index: 1102;
+	display: none;
+}
+
+#fancybox-left {
+	left: 0px;
+}
+
+#fancybox-right {
+	right: 0px;
+}
+
+#fancybox-left-ico, #fancybox-right-ico {
+	position: absolute;
+	top: 50%;
+	left: -9999px;
+	width: 30px;
+	height: 30px;
+	margin-top: -15px;
+	cursor: pointer;
+	z-index: 1102;
+	display: block;
+}
+
+#fancybox-left-ico {
+	background-image: url('fancybox.png');
+	background-position: -40px -30px;
+}
+
+#fancybox-right-ico {
+	background-image: url('fancybox.png');
+	background-position: -40px -60px;
+}
+
+#fancybox-left:hover, #fancybox-right:hover {
+	visibility: visible;    /* IE6 */
+}
+
+#fancybox-left:hover span {
+	left: 20px;
+}
+
+#fancybox-right:hover span {
+	left: auto;
+	right: 20px;
+}
+
+.fancy-bg {
+	position: absolute;
+	padding: 0;
+	margin: 0;
+	border: 0;
+	width: 20px;
+	height: 20px;
+	z-index: 1001;
+}
+
+#fancy-bg-n {
+	top: -20px;
+	left: 0;
+	width: 100%;
+	background-image: url('fancybox-x.png');
+}
+
+#fancy-bg-ne {
+	top: -20px;
+	right: -20px;
+	background-image: url('fancybox.png');
+	background-position: -40px -162px;
+}
+
+#fancy-bg-e {
+	top: 0;
+	right: -20px;
+	height: 100%;
+	background-image: url('fancybox-y.png');
+	background-position: -20px 0px;
+}
+
+#fancy-bg-se {
+	bottom: -20px;
+	right: -20px;
+	background-image: url('fancybox.png');
+	background-position: -40px -182px; 
+}
+
+#fancy-bg-s {
+	bottom: -20px;
+	left: 0;
+	width: 100%;
+	background-image: url('fancybox-x.png');
+	background-position: 0px -20px;
+}
+
+#fancy-bg-sw {
+	bottom: -20px;
+	left: -20px;
+	background-image: url('fancybox.png');
+	background-position: -40px -142px;
+}
+
+#fancy-bg-w {
+	top: 0;
+	left: -20px;
+	height: 100%;
+	background-image: url('fancybox-y.png');
+}
+
+#fancy-bg-nw {
+	top: -20px;
+	left: -20px;
+	background-image: url('fancybox.png');
+	background-position: -40px -122px;
+}
+
+/* IE */
+
+#fancybox-loading.fancybox-ie div	{ background: transparent; filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_loading.png', sizingMethod='scale'); }
+.fancybox-ie #fancybox-close		{ background: transparent; filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_close.png', sizingMethod='scale'); }
+
+.fancybox-ie #fancybox-title-over	{ background: transparent; filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_title_over.png', sizingMethod='scale'); zoom: 1; }
+.fancybox-ie #fancybox-title-left	{ background: transparent; filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_title_left.png', sizingMethod='scale'); }
+.fancybox-ie #fancybox-title-main	{ background: transparent; filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_title_main.png', sizingMethod='scale'); }
+.fancybox-ie #fancybox-title-right	{ background: transparent; filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_title_right.png', sizingMethod='scale'); }
+
+.fancybox-ie #fancybox-left-ico		{ background: transparent; filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_nav_left.png', sizingMethod='scale'); }
+.fancybox-ie #fancybox-right-ico	{ background: transparent; filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_nav_right.png', sizingMethod='scale'); }
+
+.fancybox-ie .fancy-bg { background: transparent !important; }
+
+.fancybox-ie #fancy-bg-n	{ filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_shadow_n.png', sizingMethod='scale'); }
+.fancybox-ie #fancy-bg-ne	{ filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_shadow_ne.png', sizingMethod='scale'); }
+.fancybox-ie #fancy-bg-e	{ filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_shadow_e.png', sizingMethod='scale'); }
+.fancybox-ie #fancy-bg-se	{ filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_shadow_se.png', sizingMethod='scale'); }
+.fancybox-ie #fancy-bg-s	{ filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_shadow_s.png', sizingMethod='scale'); }
+.fancybox-ie #fancy-bg-sw	{ filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_shadow_sw.png', sizingMethod='scale'); }
+.fancybox-ie #fancy-bg-w	{ filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_shadow_w.png', sizingMethod='scale'); }
+.fancybox-ie #fancy-bg-nw	{ filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='fancybox/fancy_shadow_nw.png', sizingMethod='scale'); }