log_switch 0.4.0 → 1.1.0

data/README.rdoc

@@ -1,192 +0,0 @@
-= log_switch
-
-http://github.com/turboladen/log_switch
-
-== DESCRIPTION
-
-While developing other gems that required a single class/singleton style logger,
-I got tired of repeating the code to create that logger and mix it in to my base
-class.  I just wanted to be able to require something, then be able to do:
-
-  MyLib.log "some message"
-
-I also wanted to be able to programmatically turn on/off logging by doing something
-like:
-
-  MyLib.log = false
-
-This gem allows just that.  Well, almost...
-
-== FEATURES/PROBLEMS
-
-Features:
-
-* +require+ and +extend+ to mix in to your class/module to get a single point of logging
-* Switch on/off logging
-* Use whatever Logger you want
-
-== SYNOPSIS
-
-=== Basic Use
-
-Get your app logging with a single point of logging:
-
-  require 'log_switch'
-
-  class MyThing
-    extend LogSwitch
-  end
-
-  MyThing.log "I like you, Ruby."  # => D, [2011-10-07T14:40:26.697084 #30080] DEBUG -- : I like you, Ruby.
-
-...and then you can simply switch off logging by doing:
-
-  MyThing.log = false
-  MyThing.log "You're my favorite." # => No logging occurs!
-
-By default, LogSwitch sets the log level to +:debug+.  You can change the default
-log level as you go:
-
-  MyThing.log_level = :warn
-  MyThing.log "Crap!"           # => W, [2011-10-07T15:30:54.012502 #32892]  WARN -- : Crap!
-
-You can pass in the log level for your Logger type too:
-
-  MyThing.log "Stuff!", :info      # => I, [2011-10-07T15:28:49.480741 #32892]  INFO -- : Stuff!
-  MyThing.log "Meow", :fatal       # => F, [2011-10-07T15:32:21.207867 #32892] FATAL -- : Meow
-
-If you have another Logger object you want to write to, no problem:
-
-  some_other_logger = Logger.new 'log.txt'
-  MyThing.logger = some_other_logger
-  MyThing.log "hi!"
-  File.open('log.txt', 'r').read    # => Logfile created on 2011-10-07 15:50:19 -0700 by logger.rb/25413
-                                    #    D, [2011-10-07T15:51:16.385798 #34026] DEBUG -- : hi!
-
-=== Hooks
-
-You can also make sure code gets executed before each call to +.log+.  While
-this really only makes sense when you're logging from multiple places and/or
-you're not sure when the first call to your logger will occur (unlike this
-example), say you want to makes sure your log directory exists before trying
-to write the log file to it:
-
-  log_directory = File.expand_path('my_log_dir')
-
-  MyThing.before do
-    FileUtils.mkdir_p(full_directory) unless Dir.exists? log_directory
-  end
-
-  log_file = log_directory + "/sweet_log_bro.txt"
-  MyThing.logger = Logger.new(log_file)
-  MyThing.log "Thanks brah!"            # This calls the #before hook, thus
-                                        # creating the directory.
-  MyThing.log "I'm hungry..."           # This also calls the #before hook...
-
-You might just want want a one-time before hook--in that case, +.log+ will call
-a plain old block that you pass to it, right before writing to the log file.
-Here's the above example, using the one-timer:
-
-  log_directory = File.expand_path('my_log_dir')
-
-  log_file = log_directory + "/sweet_log_bro.txt"
-  MyThing.logger = Logger.new(log_file)
-
-  MyThing.log("Thanks brah!") do
-    FileUtils.mkdir_p(full_directory) unless Dir.exists? log_directory
-  end
-
-  # No block gets called here (assuming the +#before+ hook from above hasn't been defined)
-  MyThing.log "I'm hungry..."
-
-=== Mixin for lazy people like me
-
-All that stuff above describes how you can extend some class of yours to make it
-a singleton logger (well, not that you can't have it do other stuff too...).  If
-you're using this in a sizeable project, however, it can get tiresome typing out
-<tt>MyThing.log "message"</tt> over and over again; for me, it's usually more
-like <tt>MyThing::Logger.log "message"</tt>.  The {LogSwitch::Mixin} mixin
-lets you shorten things up.
-
-If you've extended {LogSwitch} into a class...
-
-  class MyThing
-    class Logger
-      extend LogSwitch
-    end
-  end
-
-...then you can mix in {LogSwitch::Mixin} to your other classes that you want to
-use +MyThing::Logger.log+:
-
-  class MyThing
-    class WidgetMaker
-      include LogSwitch::Mixin
-
-      def make_widget
-        log "Making widget...", :info    # This will delegate to MyThing::Logger.log
-      end
-    end
-  end
-
-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):
-  * MRI 1.9.3
-  * MRI 1.9.2
-  * MRI 1.8.7
-  * ree 1.8.7-2011.03
-  * JRuby 1.6.5
-  * Rubinius 1.2.4
-* RubyGems:
-  * None!
-
-== INSTALL
-
-  $ gem install log_switch
-
-== DEVELOPERS
-
-After checking out the source, run:
-
-  $ bundle install
-
-This task will install any missing dependencies for you.
-
-== THANKS
-
-I need to thank the http://github.com/rubiii/savon project for most of the code
-here.  Somehow I ran across how they do logging and started following suit.  The
-code in +log_switch+ is almost identical to Savon's logging.
-

data/lib/log_switch/mixin.rb

@@ -1,31 +0,0 @@
-module LogSwitch
-  module Mixin
-
-    # When this module is included, this method gets called and defines a +#log+
-    # method on the including class.
-    #
-    # @param [Class] klass The class that's including this module.
-    # @raise [RuntimeError] If {LogSwitch.extender} isn't set (which gets set
-    #    when you +extend+ your class with {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
-        raise "No class has been extended by LogSwitch yet."
-      end
-    end
-  end
-end

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

@@ -1,88 +0,0 @@
-$(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();
-});