highlogger 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-10-15
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,4 @@
+Originally copyright (c) 2007 Noah Gibbs
+
+This code may be used for any purpose.  It is released into the public
+domain by its author in 2007.

data/Manifest.txt

@@ -0,0 +1,24 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/highlogger.rb
+lib/highlogger/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_highlogger.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,20 @@
+HighLogger
+
+This is a simple heirarchical component-based logging system based on
+Ruby's standard "Logger".  Component-based means that you call the
+logging function with a component such as a filename in addition to the
+severity.  This allows HighLogger to be configured from a file to
+filter each component by severity.  Thus, you could filter output from
+one file to only errors and up, while another file that you just added
+will log every message of every severity.  This is useful for debugging
+larger projects, and adding new components to projects of any size.
+
+HighLogger is heirarchical because if a component has one or more
+colons in the name, they are treated as separators.  For instance, the
+component name "Math:DiffEQ:Integrator:Cash-Karp" has four levels.  If
+a severity setting isn't given for the full name, each sub-name will
+be checked in turn.  For the above example, "Math:DiffEQ:Integrator"
+would be checked next, then "Math:DiffEQ", then "Math".  So if there
+were no setting for the first three of those but "Math" was set to log
+fatal errors only, then log messages directed to component
+"Math:DiffEQ:Integrator:Cash-Karp" would be recorded only if fatal.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'highlogger/version'
+
+AUTHOR = 'Noah Gibbs'
+EMAIL = "angelbob@nospam.users.sourceforge.net"
+DESCRIPTION = "A heirarchical component-based logging system"
+GEM_NAME = 'highlogger'
+RUBYFORGE_PROJECT = 'ab-ext'
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Highlogger::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'highlogger documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'highlogger'

data/lib/highlogger/version.rb

@@ -0,0 +1,9 @@
+module Highlogger #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/highlogger.rb

@@ -0,0 +1,171 @@
+$:.unshift File.dirname(__FILE__)
+
+require "logger"
+
+module LogSource
+  @logger = nil
+
+  def set_logger(logger_obj)
+    @logger = logger_obj
+  end
+
+  def log(severity, *strings, &block)
+    caller_str = caller()[0]
+    matchobj = /([^\/]+)\.rb/.match(caller_str)
+    raise "Call set_logger before logging!" if(not @logger)
+    @logger.add(matchobj[1], severity, *strings, &block)
+  end
+end # module LogSource
+
+# This class implements a simple heirarchical logging system.
+#
+class HighLogger < Logger
+  def initialize(*super_args)
+    super(*super_args)
+    @logmap = {}
+    @default_level = Logger::WARN
+  end
+
+  def add(component, severity, message = nil, progname = nil, &block)
+    return if severity == :none
+
+    level = level_for_component(component)
+    return if level and severity < level
+
+    # Logic copied from Logger class
+    if message.nil?
+      if block_given?
+	message = yield
+      else
+	message = progname
+	progname = @progname
+      end
+    end
+
+    super(severity, component + ": " + message, progname, &block);
+  end
+
+  alias log add
+
+  def debug?(*args)
+    return super() if args.empty?
+    @logmap[args[0]] <= Logger::DEBUG
+  end
+
+  def info?(*args)
+    return super() if args.empty?
+    @logmap[args[0]] <= Logger::INFO
+  end
+
+  def warn?(*args)
+    return super() if args.empty?
+    @logmap[args[0]] <= Logger::WARN
+  end
+
+  def error?(*args)
+    return super() if args.empty?
+    @logmap[args[0]] <= Logger::ERROR
+  end
+
+  def fatal?(*args)
+    return super() if args.empty?
+    @logmap[args[0]] <= Logger::FATAL
+  end
+
+  def debug(component, progname = nil, &block)
+    add(component, Logger::DEBUG, nil, progname, &block)
+  end
+
+  def info(component, progname = nil, &block)
+    add(component, Logger::INFO, nil, progname, &block)
+  end
+
+  def warn(component, progname = nil, &block)
+    add(component, Logger::WARN, nil, progname, &block)
+  end
+
+  def error(component, progname = nil, &block)
+    add(component, Logger::ERROR, nil, progname, &block)
+  end
+
+  def fatal(component, progname = nil, &block)
+    add(component, Logger::FATAL, nil, progname, &block)
+  end
+
+  def unknown(component, progname = nil, &block)
+    add(component, Logger::UNKNOWN, nil, progname, &block)
+  end
+
+
+  # Have this logger read a configuration file to determine
+  # what components will log at what levels.
+  #
+  def read_config_file(filename)
+    f = File.new(filename)
+    buf = f.read()
+    read_config_buffer(buf)
+  end
+
+  # Have this logger read a configuration buffer to determine
+  # what components will log at what levels.
+  #
+  def read_config_buffer(buf)
+    buf.each_line do |line|
+      mobj = /^\s*([A-Za-z0-9_:]+)\s*=\s*(.*?)\s*$/.match(line)
+      raise "Can't parse config line '#{line}'!" unless mobj
+
+      loglevel = parse_loglevel(mobj[2])
+      if mobj[1] =~ /default/i
+        @default_level = loglevel
+	parent.level = loglevel
+	next
+      end
+
+      @logmap[mobj[1]] = loglevel
+    end
+  end
+
+  private
+
+  def parse_loglevel(string)
+    if string =~ /debug/i
+      return Logger::DEBUG
+    end
+    if string =~ /info/i
+      return Logger::INFO
+    end
+    if string =~ /warn/i or string =~ /warning/i
+      return Logger::WARN
+    end
+    if string =~ /err/i or string =~ /error/i
+      return Logger::ERROR
+    end
+    if string =~ /fatal/i
+      return Logger::FATAL
+    end
+    if string =~ /all/i or string =~ /any/i
+      return Logger::DEBUG
+    end
+    if string =~ /unknown/i
+      return Logger::UNKNOWN
+    end
+    if string =~ /none/i
+      return :none
+    end
+    raise "Can't parse logging level from '#{string}'!"
+  end
+
+  def level_for_component(component)
+    return @logmap[component] if @logmap[component]
+
+    complist = component.split(/:/)
+    begin
+      complist = complist[0..-2]
+      this_comp = complist.join(":")
+      return @logmap[this_comp] if @logmap[this_comp]
+    end while not complist.empty?
+
+    @default_level
+  end
+
+end # class HighLogger

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/highlogger/version.rb'
+
+version  = Highlogger::VERSION::STRING
+download = 'http://rubyforge.org/projects/highlogger'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)