color_debug_messages 1.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,4 @@
+rdoc
+pkg
+
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brent Sanders
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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.

data/README.rdoc

@@ -0,0 +1,60 @@
+= NAME
+
+Color Debug Messages - A way to add nicer output to your script.
+
+= DESCRIPTION
+
+I got tired of plain output on STDOUT, and wanted a nicer way
+to add debug/informational messages to my scripts. This works
+with the idea that it is easier for our eyes to notice changes
+in color than changes in glyph/shape. A red error message is
+notices more easily than a "*****" prefix or similar.
+
+To get this effect, we rely on Term::ANSIColor
+
+== Install
+
+  gem install color_debug_messages
+
+== Usage
+
+The basic use of this script is very simple - you just include
+the module into your class, and call the various "puts" wrappers.
+
+    class Foo
+      include ColorDebugMessages
+      def bar(baz)
+        debug "This is a debug message!"
+      end
+    end
+
+Which produces:
+
+    [Foo#bar] >>> This is a debug message!
+
+The part in square-brackets at the beginning will be in read, which
+I unfortunately am having a hard time making RDoc produce.
+
+The available message types, by default, are:
+    
+    debug(msg)  # ">>>" prefix, in cyan
+    warn(msg)   # "**>" prefix, in red
+    info(msg)   # "-->" prefix, in green
+
+These can be changed by adding lines like this to the top of your class:
+
+    class Foo
+      include ColorDebugMessages
+      color_debug_message_type :quux, '~', :blue
+
+      def bar
+        quux "Test message!"
+      end
+    end
+
+Which will produce yellow output, with the <tt>"~~>"</tt> prefix instead.
+
+= COPYRIGHT
+
+Copyright (c) 2010 Brent Sanders. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "color_debug_messages"
+    gem.summary = "Easy to read output on STDOUT"
+    gem.description = "Module to add colorful debug messages to a class."
+    gem.email = "gem-color_debug_messages@thoughtnoise.net"
+    gem.homepage = "http://github.com/pdkl95/color_debug_messages"
+    gem.authors = ["Brent Sanders"]
+    gem.add_development_dependency "term-ansicolor", ">= 1.0.4"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "color_debug_messages #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/color_debug_messages.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{color_debug_messages}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brent Sanders"]
+  s.date = %q{2010-01-02}
+  s.description = %q{Module to add colorful debug messages to a class.}
+  s.email = %q{gem-color_debug_messages@thoughtnoise.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "color_debug_messages.gemspec",
+     "lib/color_debug_messages.rb",
+     "test/helper.rb",
+     "test/test_color_debug_messages.rb"
+  ]
+  s.homepage = %q{http://github.com/pdkl95/color_debug_messages}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Easy to read output on STDOUT}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_color_debug_messages.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<term-ansicolor>, [">= 1.0.4"])
+    else
+      s.add_dependency(%q<term-ansicolor>, [">= 1.0.4"])
+    end
+  else
+    s.add_dependency(%q<term-ansicolor>, [">= 1.0.4"])
+  end
+end
+

data/lib/color_debug_messages.rb

@@ -0,0 +1,147 @@
+require 'term/ansicolor'
+
+# Include this module into your class to get access to the
+# debug helper functions.
+module ColorDebugMessages
+  # if you specify nothing else, you get full-messages, nothing hidden
+  DEFAULT_DEBUG_FLAGS = {
+    :info        => true,
+    :debug       => true,
+    :warn        => true,
+    :class_only  => false,
+    :prefix_only => false
+  }
+
+  # You can change the option flags globally by setting this to a hash
+  # of flags. For example, to only have 'info' and 'warn' level
+  # messages, with only class names and no function names, you could do:
+  #
+  #     ColorDebugMessages.debug_flags = {
+  #       :debug      => false,
+  #       :class_only => true
+  #     }
+  #
+  # The hash is merged with the existing one, so it is not necessary
+  # to name things that are already set the way you want.
+  def self.debug_flags=(opts)
+    debug_flags.merge! opts
+  end
+  
+  # returns the global flags
+  def self.debug_flags
+    @debug_flags ||= DEFAULT_DEBUG_FLAGS
+  end
+  
+  # This is the same as ColorDebugMessages#debug_flags but on a
+  # per-instance level, if you need to locally change things for some
+  # reason. This hash starts out blank, and any missing entries are
+  # looked up in the global hash.  
+  def debug_flags=(opts)
+    debug_flags.merge! opts
+  end
+
+  # returns the per-instance flag overrides
+  def debug_flags
+    @color_debug_message_options ||= Hash.new
+  end
+  
+  # returns +true+ if the flag is true in either the local instance
+  # or the global hash.
+  def debug_flag_active?(name)
+    if debug_flags.has_key?(name)
+      debug_flags
+    else
+      ColorDebugMessages.debug_flags
+    end[name]
+  end
+  
+  # returns the prefix to tag on debug messages for a class.
+  # This normally reflects the class name itself, and appends
+  # the function name (caller[1]) of what cause this message.
+  # It can be overridden in your class to whatever you want,
+  # if necessary. Just return a string.
+  def debug_message_prefix
+    return self.class.to_s if debug_flag_active?(:class_only)
+
+    name = self.class.to_s + '#'
+    if /`(.*)'/ =~ caller[1]
+      name + $1
+    else
+      name + "[unknown]"
+    end
+  end
+
+  class ColorDebugMsg # :nodoc:all
+    include Term::ANSIColor
+    attr_reader :color, :mark, :calling_method_name, :msg
+    
+    def initialize(msg, prefix=nil, mark=nil, color=nil)
+      @color  = color
+      @mark   = mark
+      @prefix = prefix
+      @msg    = msg
+    end
+
+    def to_s
+      str = ''
+      if @prefix
+        if @color
+          str += send @color, bold('[')
+          str += send @color, @prefix
+          str += send @color, bold('] ')
+        else
+          str += "[#{@prefix}] "
+        end
+      end
+
+      if @mark
+        mark_str = @mark + @mark + '> '
+        if @color
+          str += send @color, bold(mark_str)
+        else
+          str += mark_str
+        end
+      end
+
+      str += reset if @color
+      str += @msg
+    end
+  end
+  
+  # returns a string with the ANSI *bold* flag set, for usage in
+  # the middle of debug statements.
+  #
+  #     debug "This is a " + bold("fancy") + "message!"
+  def bold(string_to_bold)
+    Term::ANSIColor.bold string_to_bold
+  end
+  
+  # Meta-generator for the actual debug message calls. At the core,
+  # these are all just a fancy wrapper around Kernel#puts with
+  # the color output. They always add the newline "\n" character to
+  # the end as a convenience, and usually prefix the line with an
+  # identifying mark, so we know what generated the message.
+  #
+  # === Options:
+  # <tt>:name</tt>::        (Symbol) The name of the function to
+  #                         create. Existing functions can be
+  #                         overwritten to change their color/prefix.
+  # <tt>:prefix_char</tt>:: (String) A character to use as a separator
+  #                         for messages of this type.
+  # <tt>:color</tt>::       (Symbol) The color to use for the
+  #                         prefix. This must be a valid function in
+  #                         the Term::ANSIColor library.
+  def self.color_debug_message_type(name, prefix_char, color)
+    define_method(name) do |msg|
+      if debug_flag_active?(name)
+        caller_prefix = debug_message_prefix
+        caller_prefix = nil if debug_flag_active?(:prefix_only)
+        puts ColorDebugMsg.new(msg, caller_prefix, prefix_char, color)
+      end
+    end
+  end
+
+  color_debug_message_type :debug, '>', :cyan
+  color_debug_message_type :warn,  '*', :red
+  color_debug_message_type :info,  '-', :green  
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'color_debug_messages'
+
+class Test::Unit::TestCase
+end

data/test/test_color_debug_messages.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestColorDebugMessages < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: color_debug_messages
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Brent Sanders
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-02 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+description: Module to add colorful debug messages to a class.
+email: gem-color_debug_messages@thoughtnoise.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- color_debug_messages.gemspec
+- lib/color_debug_messages.rb
+- test/helper.rb
+- test/test_color_debug_messages.rb
+has_rdoc: true
+homepage: http://github.com/pdkl95/color_debug_messages
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Easy to read output on STDOUT
+test_files: 
+- test/helper.rb
+- test/test_color_debug_messages.rb