rubyw_helper 0.1.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 / 2008-12-24
+
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,21 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/rubyw_helper.rb
+spec/.bacon
+spec/helper.rb
+spec/runner
+spec/spec_rubyw_helper.rb
+tasks/ann.rake
+tasks/autospec.rake
+tasks/bacon.rake
+tasks/bones.rake
+tasks/gem.rake
+tasks/git.rake
+tasks/manifest.rake
+tasks/notes.rake
+tasks/post_load.rake
+tasks/rdoc.rake
+tasks/rubyforge.rake
+tasks/setup.rb

data/README.txt

@@ -0,0 +1,88 @@
+rubyw_helper
+    by James Tucker
+    http://ra66i.org
+    http://github.com/raggi/rubyw_helper
+
+== DESCRIPTION:
+
+A simple redirector for use when you just want to safely redirect stdio.
+Simply encapsulates a few different safety mechanisms when redirecting stdio,
+with the primary goal of making it easier to write apps that run under
+rubyw.exe, where ruby loads with stdio closed.
+
+Whilst the primary intention for use is under win32, and was actually
+developed as an external helper for specifically win32-service usage, this gem
+may be useful to some other folks on other platforms. It is not win32 
+specific.
+
+== FEATURES/PROBLEMS:
+
+* Lacking any tertiary logging infrastructure specific to any platform.
+
+== SYNOPSIS:
+
+The following parameters are also the defaults:
+
+  stdout = File.join(Dir.pwd, 'logs', "#{app_name}.stdout.log"),
+  stderr = File.join(Dir.pwd, 'logs', "#{app_name}.stderr.log")
+  stdin  = case RUBY_PLATFORM
+           when /mingw|mswin/
+             'NUL:'
+           else
+             '/dev/null'
+           end
+
+  helper = RubywHelper.new(stdout, stderr, stdin)
+
+You achieve basic redirection if you wrap your runner for your program in the
+with_redirection block:
+
+  helper.with_redirection do
+    puts "hello logfile!"
+  end
+  
+Or you can simply just redirect them:
+
+  helper.redirect_stdio!
+
+For your convenience, there is also a method which attempts to see if it may
+be a good idea to redirect stdio, in other words, it returns true if all of 
+stdio is closed:
+
+  helper.stdio_danger?
+
+This typically returns true under rubyw.exe and any equivalents.
+
+== REQUIREMENTS:
+
+* Ruby
+* gem inst exception_string
+
+== INSTALL:
+
+* gem inst rubyw_helper
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 James Tucker
+
+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/Rakefile

@@ -0,0 +1,16 @@
+load 'tasks/setup.rb'
+
+ensure_in_path 'lib'
+require 'rubyw_helper'
+
+task :default => 'spec:run'
+
+PROJ.name = 'rubyw_helper'
+PROJ.authors = 'James Tucker'
+PROJ.email = 'raggi@rubyforge.org'
+PROJ.url = 'http://github.com/raggi/rubyw_helper'
+PROJ.rubyforge.name = 'libraggi'
+PROJ.version = RubywHelper.version
+
+PROJ.exclude = %w(tmp$ bak$ ~$ CVS \.git \.hg \.svn ^pkg ^doc \.DS_Store \.cvs
+  \.svn \.hgignore \.gitignore \.dotest \.swp$ ~$ \.bin$ \.h$ \.rc$ \.res$)

data/lib/rubyw_helper.rb

@@ -0,0 +1,106 @@
+require 'fileutils'
+require 'exception_string'
+
+class RubywHelper
+
+  Version = VERSION = '0.1.1'
+  def self.version; Version; end
+
+  app_name = File.basename($0)
+  Defaults = {
+    :out => File.join(Dir.pwd, 'logs', "#{app_name}.stdout.log"),
+    :err => File.join(Dir.pwd, 'logs', "#{app_name}.stderr.log"),
+    :in  => case RUBY_PLATFORM
+            when /mingw|mswin/
+              'NUL:'
+            else
+              '/dev/null'
+            end
+  }
+
+  attr_reader :old_out, :old_err, :old_in
+
+  # out replaces $stdout, err replaces $stderr, inn replaces $stdin, simple.
+  # provide nils / false to use the Defaults
+  def initialize(out = nil, err = nil, inn = nil)
+    @stdout, @stderr = out || Defaults[:out], err || Defaults[:err]
+    @stdin = inn || Defaults[:in]
+    @old_out, @old_err, @old_in = $stdout, $stderr, $stdin
+  end
+
+  def stdio_danger?
+    $stdout.closed? && $stderr.closed? && $stdin.closed?
+  end
+
+  # Takes a block, because under these conditions, it really helps developers
+  # if best effort is made to try and log error conditions to the files before
+  # leaving the process.
+  def with_redirection
+    ensure_files!
+    redirect_stdio!
+    yield
+    restore_stdio!
+  rescue Exception => exception
+    fatal! exception.to_s_mri
+  end
+
+  # Sets up the global IO objects to point to where we want.
+  def redirect_stdio!
+    inn, out, err = open(@stdin), open(@stdout, 'a+'), open(@stderr, 'a+')
+    no_warn do
+      $stdin   = Object.const_set(:STDIN,  inn)
+      $stdout  = Object.const_set(:STDOUT, out)
+      $stderr  = Object.const_set(:STDERR, err)
+    end
+  end
+
+  def restore_stdio!
+    no_warn do
+      $stdin   = Object.const_set(:STDIN,  @old_in)
+      $stdout  = Object.const_set(:STDOUT, @old_out)
+      $stderr  = Object.const_set(:STDERR, @old_err)
+    end
+  end
+
+  private
+  # Tries to create any containing directories, and errors out if we can't 
+  # write to the outputs or read from the input.
+  def ensure_files!
+    fatal! "Cannot read from #{@stdin}" unless File.readable? @stdin
+    [@stdout, @stderr].each do |f|
+      dir = File.dirname(f)
+      safely { FileUtils.mkdir_p(dir) unless File.directory?(dir) }
+      next if File.writable? f
+      fatal! "Cannot write to #{f}"
+    end
+  end
+
+  # For each output io, safely wrap the given block, and yield the io.
+  def safe_each
+    [$stderr, $stdout].each { |io| safely { yield io } }
+  end
+
+  # Tries real hard to log the message, then exits with failure status.
+  def fatal!(message)
+    # Not using safe_each in case that caused an error.
+    safely { $stdout.reopen(@stdout, 'a+'); $stdout.puts message }
+    safely { $stderr.reopen(@stderr, 'a+'); $stderr.puts message }
+    exit 1
+  end
+
+  # Ignores errors, which we might not be able to avoid.
+  def safely
+    yield
+  rescue Exception
+    nil
+  end
+
+  # Suppress warnings, most useful for constant redefinition.
+  def no_warn
+    verbose  = $VERBOSE
+    $VERBOSE = nil
+    yield
+  ensure
+    $VERBOSE = verbose
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,16 @@
+# Disable test/unit and rspec from running, in case loaded by broken tools.
+Test::Unit.run = false if defined?(Test) && defined?(Test::Unit)
+Spec::run = false if defined?(Spec) && Spec::respond_to?(:run=)
+
+# Setup a nice testing environment
+$DEBUG, $TESTING = true, true
+$:.push File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.uniq!
+
+%w[rubygems bacon].each { |r| require r }
+
+# Bacon doesn't do any automagic, so lets tell it to!
+Bacon.summary_on_exit
+
+require File.expand_path(
+  File.join(File.dirname(__FILE__), %w[.. lib rubyw_helper]))

data/spec/runner

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+__DIR__ = File.dirname(__FILE__)
+__APP__ = File.expand_path(__DIR__ + '/../')
+
+puts
+Dir.chdir(__APP__) do
+  files = ARGV.empty? ? Dir.glob('{test,spec}/**/{test,spec}_*.rb') : ARGV
+  files.each { |f| require f }
+end

data/spec/spec_rubyw_helper.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/helper'
+require 'stringio'
+require 'tempfile'
+
+describe "RubywHelper" do
+
+  def temp_io
+    stdin = case RUBY_PLATFORM
+    when /mingw|mswin/
+      'NUL:'
+    else
+      '/dev/null'
+    end
+    tmp_io = %W(
+    /tmp/rubyw_helper_test_stdout.log
+    /tmp/rubyw_helper_test_stderr.log
+    )
+    tmp_io.each { |f| open(f, 'w') {} }
+    yield tmp_io + [stdin]
+  ensure
+    tmp_io.each { |f| File.delete(f) }
+  end
+
+  should "have stdio_danger? when stdout, stderr, and stdin are closed" do
+    $stdout, $stderr, $stdin = Array.new(3) { s = StringIO.new(''); s.close; s }
+    RubywHelper.new.stdio_danger?.should.eql true
+    $stdout, $stderr, $stdin = STDOUT, STDERR, STDIN
+  end
+
+  should "restore the old stdios" do
+    oout, oerr, oin = $stdout, $stderr, $stdin
+    h = RubywHelper.new
+    $stdout, $stderr, $stdin = Array.new(3) do
+      s = StringIO.new('')
+      s.close
+      s
+    end
+    h.restore_stdio!
+    $stdout.should.eql oout
+    $stderr.should.eql oerr
+    $stdin.should.eql oin
+  end
+
+  should "redirect to the appropriate files and restore stdio afterward" do
+    oout, oerr, oin = $stdout, $stderr, $stdin
+    temp_io do |out, err, inn|
+      h = RubywHelper.new(out, err, inn)
+      h.with_redirection do
+        $stdout.path.should.eql out
+        $stderr.path.should.eql err
+        $stdin.path.should.eql inn
+        STDOUT.path.should.eql out
+        STDERR.path.should.eql err
+        STDIN.path.should.eql inn
+        $stdout.puts "1234567890"
+        $stderr.puts "1234567890"
+        [$stdin, $stderr, $stdout].each { |io| io.close unless io.closed? }
+      end
+      $stdout.should.eql oout
+      $stderr.should.eql oerr
+      $stdin.should.eql oin
+      STDOUT.should.eql oout
+      STDERR.should.eql oerr
+      STDIN.should.eql oin
+      File.read(out).should.eql("1234567890\n")
+      File.read(err).should.eql("1234567890\n")
+    end
+  end
+
+end

data/tasks/ann.rake

@@ -0,0 +1,81 @@
+# $Id$
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  file PROJ.ann.file do
+    ann = PROJ.ann
+    puts "Generating #{ann.file}"
+    File.open(ann.file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      ann.paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts ann.text if ann.text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => ['ann:prereqs', PROJ.ann.file]
+
+  desc "Send an email announcement"
+  task :email => ['ann:prereqs', PROJ.ann.file] do
+    ann = PROJ.ann
+    from = ann.email[:from] || PROJ.email
+    to   = Array(ann.email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+    rfc822msg << File.read(ann.file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      ann.email[key]
+    end
+
+    params[3] = PROJ.email if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann.file
+
+# EOF

data/tasks/autospec.rake

@@ -0,0 +1,33 @@
+# Poor mans autotest, for when you absolutely positively, just need an autotest.
+# N.B. Uses a runner under test/ or spec/, so you can customize the runtime.
+# Thanks to manveru for this!
+desc "Run specs every time a file changes in lib or spec"
+task :autospec do
+  rb = Gem.ruby rescue nil
+  rb ||= (require 'rbconfig'; File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name']))
+  command = 'spec/runner' if test ?e, 'spec/runner'
+  command ||= 'test/runner' if test ?e, 'test/runner'
+  files = Dir.glob('{lib,spec,test}/**/*.rb')
+  mtimes = {}
+  sigtrap = proc { puts "\rDo that again, I dare you!"; trap(:INT){ exit 0 }; sleep 0.8; trap(:INT, &sigtrap) }
+  trap(:INT, &sigtrap)
+  system "#{rb} -I#{GSpec.require_path} #{command}"
+  while file = files.shift
+    begin
+      mtime = File.mtime(file)
+      mtimes[file] ||= mtime
+      if mtime > mtimes[file]
+        files = Dir.glob('{lib,spec,test}/**/*.rb') - [file] # refresh the file list.
+        puts
+        system "#{rb} -I#{GSpec.require_path} #{command} #{file}"
+        puts
+      end
+      mtimes[file] = mtime
+      files << file
+    rescue Exception
+      retry
+    end
+    # print "\rChecking: #{file.ljust((ENV['COLUMNS']||80)-11)}";$stdout.flush
+    sleep 0.2
+  end
+end

data/tasks/bacon.rake

@@ -0,0 +1,5 @@
+task :spec do
+  ruby 'spec/runner'
+end
+
+task :test => :spec

data/tasks/bones.rake

@@ -0,0 +1,21 @@
+# $Id$
+
+if HAVE_BONES
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if t.application.top_level_tasks.length == 2
+      t.application.top_level_tasks.pop
+    end
+
+    if atr then Bones::Debug.show_attr(PROJ, atr)
+    else Bones::Debug.show PROJ end
+  end
+
+end  # namespace :bones
+
+end  # HAVE_BONES
+
+# EOF

data/tasks/gem.rake

@@ -0,0 +1,126 @@
+# $Id$
+
+require 'rake/gempackagetask'
+
+namespace :gem do
+
+  PROJ.gem._spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge.name
+
+    s.description = PROJ.description
+
+    PROJ.gem.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    s.files = PROJ.gem.files
+    s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc.include.join('|'))
+    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.gem.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
+    else
+      s.test_files = PROJ.test.files.to_a
+    end
+
+    # Do any extra stuff the user wants
+    PROJ.gem.extras.each do |msg, val|
+      case val
+      when Proc
+        val.call(s.send(msg))
+      else
+        s.send "#{msg}=", val
+      end
+    end
+  end  # Gem::Specification.new
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+
+  pkg = Rake::PackageTask.new(PROJ.name, PROJ.version) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+    pkg.package_files += PROJ.gem._spec.files
+  end
+  Rake::Task['gem:package'].instance_variable_set(:@full_comment, nil)
+
+  gem_file = if PROJ.gem._spec.platform == Gem::Platform::RUBY
+      "#{pkg.package_name}.gem"
+    else
+      "#{pkg.package_name}-#{PROJ.gem._spec.platform}.gem"
+    end
+
+  desc "Build the gem file #{gem_file}"
+  task :package => ['gem:prereqs', "#{pkg.package_dir}/#{gem_file}"]
+
+  file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.gem._spec.files do
+    when_writing("Creating GEM") {
+      Gem::Builder.new(PROJ.gem._spec).build
+      verbose(true) {
+        mv gem_file, "#{pkg.package_dir}/#{gem_file}"
+      }
+    }
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, 'gem:package'] do
+    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
+
+    # use this version of the command for rubygems > 1.0.0
+    #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PROJ.name)
+    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
+      sh "#{SUDO} #{GEM} uninstall --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
+  desc 'Cleanup the gem'
+  task :cleanup do
+    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
+  end
+
+end  # namespace :gem
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+
+remove_desc_for_task %w(gem:clobber_package)
+
+# EOF

data/tasks/git.rake

@@ -0,0 +1,41 @@
+# $Id$
+
+if HAVE_GIT
+
+namespace :git do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  desc 'Show tags from the Git repository'
+  task :show_tags => 'git:prereqs' do |t|
+    puts %x/git tag/
+  end
+
+  desc 'Create a new tag in the Git repository'
+  task :create_tag => 'git:prereqs' do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+
+    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+    puts "Creating Git tag '#{tag}'"
+    unless system "git tag -a -m '#{msg}' #{tag}"
+      abort "Tag creation failed"
+    end
+
+    if %x/git remote/ =~ %r/^origin\s*$/
+      unless system "git push origin #{tag}"
+        abort "Could not push tag to remote Git repository"
+      end
+    end
+  end
+
+end  # namespace :git
+
+# task 'gem:release' => 'git:create_tag'
+
+end  # if HAVE_GIT
+
+# EOF

data/tasks/manifest.rake

@@ -0,0 +1,49 @@
+# $Id$
+
+require 'find'
+
+namespace :manifest do
+
+  desc 'Verify the manifest'
+  task :check do
+    fn = PROJ.manifest_file + '.tmp'
+    files = manifest_files
+
+    File.open(fn, 'w') {|fp| fp.puts files}
+    lines = %x(#{DIFF} -du #{PROJ.manifest_file} #{fn}).split("\n")
+    if HAVE_FACETS_ANSICODE and ENV.has_key?('TERM')
+      lines.map! do |line|
+        case line
+        when %r/^(-{3}|\+{3})/; nil
+        when %r/^@/; Console::ANSICode.blue line
+        when %r/^\+/; Console::ANSICode.green line
+        when %r/^\-/; Console::ANSICode.red line
+        else line end
+      end
+    end
+    puts lines.compact
+    rm fn rescue nil
+  end
+
+  desc 'Create a new manifest'
+  task :create do
+    files = manifest_files
+    unless test(?f, PROJ.manifest_file)
+      files << PROJ.manifest_file
+      files.sort!
+    end
+    File.open(PROJ.manifest_file, 'w') {|fp| fp.puts files}
+  end
+
+  task :assert do
+    files = manifest_files
+    manifest = File.read(PROJ.manifest_file).split($/)
+    raise "ERROR: #{PROJ.manifest_file} is out of date" unless files == manifest
+  end
+
+end  # namespace :manifest
+
+desc 'Alias to manifest:check'
+task :manifest => 'manifest:check'
+
+# EOF

data/tasks/notes.rake

@@ -0,0 +1,28 @@
+# $Id$
+
+if HAVE_BONES
+
+desc "Enumerate all annotations"
+task :notes do |t|
+  id = if t.application.top_level_tasks.length > 1
+    t.application.top_level_tasks.slice!(1..-1).join(' ')
+  end
+  Bones::AnnotationExtractor.enumerate(
+      PROJ, PROJ.notes.tags.join('|'), id, :tag => true)
+end
+
+namespace :notes do
+  PROJ.notes.tags.each do |tag|
+    desc "Enumerate all #{tag} annotations"
+    task tag.downcase.to_sym do |t|
+      id = if t.application.top_level_tasks.length > 1
+        t.application.top_level_tasks.slice!(1..-1).join(' ')
+      end
+      Bones::AnnotationExtractor.enumerate(PROJ, tag, id)
+    end
+  end
+end
+
+end  # if HAVE_BONES
+
+# EOF

data/tasks/post_load.rake

@@ -0,0 +1,39 @@
+# $Id$
+
+# This file does not define any rake tasks. It is used to load some project
+# settings if they are not defined by the user.
+
+PROJ.rdoc.exclude << "^#{Regexp.escape(PROJ.manifest_file)}$"
+PROJ.exclude << ["^#{Regexp.escape(PROJ.ann.file)}$",
+                 "^#{Regexp.escape(PROJ.rdoc.dir)}/",
+                 "^#{Regexp.escape(PROJ.rcov.dir)}/"]
+
+flatten_arrays = lambda do |this,os|
+    os.instance_variable_get(:@table).each do |key,val|
+      next if key == :dependencies
+      case val
+      when Array; val.flatten!
+      when OpenStruct; this.call(this,val)
+      end
+    end
+  end
+flatten_arrays.call(flatten_arrays,PROJ)
+
+PROJ.changes ||= paragraphs_of(PROJ.history_file, 0..1).join("\n\n")
+
+PROJ.description ||= paragraphs_of(PROJ.readme_file, 'description').join("\n\n")
+
+PROJ.summary ||= PROJ.description.split('.').first
+
+PROJ.gem.files ||=
+  if test(?f, PROJ.manifest_file)
+    files = File.readlines(PROJ.manifest_file).map {|fn| fn.chomp.strip}
+    files.delete ''
+    files
+  else [] end
+
+PROJ.gem.executables ||= PROJ.gem.files.find_all {|fn| fn =~ %r/^bin/}
+
+PROJ.rdoc.main ||= PROJ.readme_file
+
+# EOF

data/tasks/rdoc.rake

@@ -0,0 +1,55 @@
+# $Id$
+
+begin
+  require 'hanna/rdoctask'
+rescue LoadError
+  require 'rake/rdoctask'
+end
+
+namespace :doc do
+
+  desc 'Generate RDoc documentation'
+  Rake::RDocTask.new do |rd|
+    rdoc = PROJ.rdoc
+    rd.main = rdoc.main
+    rd.rdoc_dir = rdoc.dir
+
+    incl = Regexp.new(rdoc.include.join('|'))
+    excl = Regexp.new(rdoc.exclude.join('|'))
+    files = PROJ.gem.files.find_all do |fn|
+              case fn
+              when excl; false
+              when incl; true
+              else false end
+            end
+    rd.rdoc_files.push(*files)
+
+    title = "#{PROJ.name}-#{PROJ.version} Documentation"
+
+    rf_name = PROJ.rubyforge.name
+    title = "#{rf_name}'s " + title if rf_name.valid? and rf_name != title
+
+    rd.options << "-t #{title}"
+    rd.options.concat(rdoc.opts)
+  end
+
+  desc 'Generate ri locally for testing'
+  task :ri => :clobber_ri do
+    sh "#{RDOC} --ri -o ri ."
+  end
+
+  task :clobber_ri do
+    rm_r 'ri' rescue nil
+  end
+
+end  # namespace :doc
+
+desc 'Alias to doc:rdoc'
+task :doc => 'doc:rdoc'
+
+desc 'Remove all build products'
+task :clobber => %w(doc:clobber_rdoc doc:clobber_ri)
+
+remove_desc_for_task %w(doc:clobber_rdoc)
+
+# EOF

data/tasks/rubyforge.rake

@@ -0,0 +1,57 @@
+
+if PROJ.rubyforge.name.valid? && HAVE_RUBYFORGE
+
+require 'rubyforge'
+require 'rake/contrib/sshpublisher'
+
+namespace :gem do
+  desc 'Package and upload to RubyForge'
+  task :release => [:clobber, 'gem:package'] do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+    pkg = "pkg/#{PROJ.gem._spec.full_name}"
+
+    if $DEBUG then
+      puts "release_id = rf.add_release #{PROJ.rubyforge.name.inspect}, #{PROJ.name.inspect}, #{PROJ.version.inspect}, \"#{pkg}.tgz\""
+      puts "rf.add_file #{PROJ.rubyforge.name.inspect}, #{PROJ.name.inspect}, release_id, \"#{pkg}.gem\""
+    end
+
+    rf = RubyForge.new
+    rf.configure rescue nil
+    puts 'Logging in'
+    rf.login
+
+    c = rf.userconfig
+    c['release_notes'] = PROJ.description if PROJ.description
+    c['release_changes'] = PROJ.changes if PROJ.changes
+    c['preformatted'] = true
+
+    files = [(PROJ.gem.need_tar ? "#{pkg}.tgz" : nil),
+             (PROJ.gem.need_zip ? "#{pkg}.zip" : nil),
+             "#{pkg}.gem"].compact
+
+    puts "Releasing #{PROJ.name} v. #{PROJ.version}"
+    rf.add_release PROJ.rubyforge.name, PROJ.name, PROJ.version, *files
+  end
+end  # namespace :gem
+
+
+namespace :doc do
+  desc "Publish RDoc to RubyForge"
+  task :release => %w(doc:clobber_rdoc doc:rdoc) do
+    config = YAML.load(
+        File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = "/var/www/gforge-projects/#{PROJ.rubyforge.name}/"
+    remote_dir << PROJ.rdoc.remote_dir if PROJ.rdoc.remote_dir
+    local_dir = PROJ.rdoc.dir
+
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+end  # namespace :doc
+
+end  # if HAVE_RUBYFORGE
+
+# EOF

data/tasks/setup.rb

@@ -0,0 +1,268 @@
+# $Id$
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'fileutils'
+require 'ostruct'
+
+class OpenStruct; undef :gem; end
+
+PROJ = OpenStruct.new(
+  # Project Defaults
+  :name => nil,
+  :summary => nil,
+  :description => nil,
+  :changes => nil,
+  :authors => nil,
+  :email => nil,
+  :url => "\000",
+  :version => ENV['VERSION'] || '0.0.0',
+  :exclude => %w(tmp$ bak$ ~$ CVS \.svn/ \.git/ ^pkg/),
+  :release_name => ENV['RELEASE'],
+
+  # System Defaults
+  :ruby_opts => %w(-w),
+  :libs => [],
+  :history_file => 'History.txt',
+  :manifest_file => 'Manifest.txt',
+  :readme_file => 'README.txt',
+
+  # Announce
+  :ann => OpenStruct.new(
+    :file => 'announcement.txt',
+    :text => nil,
+    :paragraphs => [],
+    :email => {
+      :from     => nil,
+      :to       => %w(ruby-talk@ruby-lang.org),
+      :server   => 'localhost',
+      :port     => 25,
+      :domain   => ENV['HOSTNAME'],
+      :acct     => nil,
+      :passwd   => nil,
+      :authtype => :plain
+    }
+  ),
+
+  # Gem Packaging
+  :gem => OpenStruct.new(
+    :dependencies => [],
+    :executables => nil,
+    :extensions => FileList['ext/**/extconf.rb'],
+    :files => nil,
+    :need_tar => true,
+    :need_zip => false,
+    :extras => {}
+  ),
+
+  # File Annotations
+  :notes => OpenStruct.new(
+    :exclude => %w(^tasks/setup\.rb$),
+    :extensions => %w(.txt .rb .erb) << '',
+    :tags => %w(FIXME OPTIMIZE TODO)
+  ),
+
+  # Rcov
+  :rcov => OpenStruct.new(
+    :dir => 'coverage',
+    :opts => %w[--sort coverage -T],
+    :threshold => 90.0,
+    :threshold_exact => false
+  ),
+
+  # Rdoc
+  :rdoc => OpenStruct.new(
+    :opts => [],
+    :include => %w(^lib/ ^bin/ ^ext/ \.txt$),
+    :exclude => %w(extconf\.rb$),
+    :main => nil,
+    :dir => 'doc',
+    :remote_dir => nil
+  ),
+
+  # Rubyforge
+  :rubyforge => OpenStruct.new(
+    :name => "\000"
+  ),
+
+  # Rspec
+  :spec => OpenStruct.new(
+    :files => FileList['spec/**/*_spec.rb'],
+    :opts => []
+  ),
+
+  # Subversion Repository
+  :svn => OpenStruct.new(
+    :root => nil,
+    :path => '',
+    :trunk => 'trunk',
+    :tags => 'tags',
+    :branches => 'branches'
+  ),
+
+  # Test::Unit
+  :test => OpenStruct.new(
+    :files => FileList['test/**/test_*.rb'],
+    :file  => 'test/all.rb',
+    :opts  => []
+  )
+)
+
+# Load the other rake files in the tasks folder
+rakefiles = Dir.glob('tasks/*.rake').sort
+rakefiles.unshift(rakefiles.delete('tasks/post_load.rake')).compact!
+import(*rakefiles)
+
+# Setup the project libraries
+%w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
+
+# Setup some constants
+WIN32 = %r/djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM unless defined? WIN32
+
+DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
+
+def quiet( &block )
+  io = [STDOUT.dup, STDERR.dup]
+  STDOUT.reopen DEV_NULL
+  STDERR.reopen DEV_NULL
+  block.call
+ensure
+  STDOUT.reopen io.first
+  STDERR.reopen io.last
+  $stdout, $stderr = STDOUT, STDERR
+end
+
+DIFF = if WIN32 then 'diff.exe'
+       else
+         if quiet {system "gdiff", __FILE__, __FILE__} then 'gdiff'
+         else 'diff' end
+       end unless defined? DIFF
+
+SUDO = if WIN32 then ''
+       else
+         if quiet {system 'which sudo'} then 'sudo'
+         else '' end
+       end
+
+RCOV = WIN32 ? 'rcov.bat' : 'rcov'
+RDOC = WIN32 ? 'rdoc.bat' : 'rdoc'
+GEM  = WIN32 ? 'gem.bat'  : 'gem'
+
+%w(rcov spec/rake/spectask rubyforge bones facets/ansicode).each do |lib|
+  begin
+    require lib
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", true}
+  rescue LoadError
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", false}
+  end
+end
+HAVE_SVN = (Dir.entries(Dir.pwd).include?('.svn') and
+            system("svn --version 2>&1 > #{DEV_NULL}"))
+HAVE_GIT = (Dir.entries(Dir.pwd).include?('.git') and
+            system("git --version 2>&1 > #{DEV_NULL}"))
+
+# Reads a file at +path+ and spits out an array of the +paragraphs+
+# specified.
+#
+#    changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+#    summary, *description = paragraphs_of('README.txt', 3, 3..8)
+#
+def paragraphs_of( path, *paragraphs )
+  title = String === paragraphs.first ? paragraphs.shift : nil
+  ary = File.read(path).delete("\r").split(/\n\n+/)
+
+  result = if title
+    tmp, matching = [], false
+    rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
+    paragraphs << (0..-1) if paragraphs.empty?
+
+    ary.each do |val|
+      if val =~ rgxp
+        break if matching
+        matching = true
+        rgxp = %r/^=+/i
+      elsif matching
+        tmp << val
+      end
+    end
+    tmp
+  else ary end
+
+  result.values_at(*paragraphs)
+end
+
+# Adds the given gem _name_ to the current project's dependency list. An
+# optional gem _version_ can be given. If omitted, the newest gem version
+# will be used.
+#
+def depend_on( name, version = nil )
+  spec = Gem.source_index.find_name(name).last
+  version = spec.version.to_s if version.nil? and !spec.nil?
+
+  PROJ.gem.dependencies << case version
+    when nil; [name]
+    when %r/^\d/; [name, ">= #{version}"]
+    else [name, version] end
+end
+
+# Adds the given arguments to the include path if they are not already there
+#
+def ensure_in_path( *args )
+  args.each do |path|
+    path = File.expand_path(path)
+    $:.unshift(path) if test(?d, path) and not $:.include?(path)
+  end
+end
+
+# Find a rake task using the task name and remove any description text. This
+# will prevent the task from being displayed in the list of available tasks.
+#
+def remove_desc_for_task( names )
+  Array(names).each do |task_name|
+    task = Rake.application.tasks.find {|t| t.name == task_name}
+    next if task.nil?
+    task.instance_variable_set :@comment, nil
+  end
+end
+
+# Change working directories to _dir_, call the _block_ of code, and then
+# change back to the original working directory (the current directory when
+# this method was called).
+#
+def in_directory( dir, &block )
+  curdir = pwd
+  begin
+    cd dir
+    return block.call
+  ensure
+    cd curdir
+  end
+end
+
+# Scans the current working directory and creates a list of files that are
+# candidates to be in the manifest.
+#
+def manifest_files
+  files = []
+  exclude = Regexp.new(PROJ.exclude.join('|'))
+  Find.find '.' do |path|
+    path.sub! %r/^(\.\/|\/)/o, ''
+    next unless test ?f, path
+    next if path =~ exclude
+    files << path
+  end
+  files.sort!
+end
+
+# We need a "valid" method thtat determines if a string is suitable for use
+# in the gem specification.
+#
+class Object
+  def valid?
+    return !(self.empty? or self == "\000") if self.respond_to?(:to_str)
+    return false
+  end
+end
+
+# EOF

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: rubyw_helper
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- James Tucker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-16 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: A simple redirector for use when you just want to safely redirect stdio. Simply encapsulates a few different safety mechanisms when redirecting stdio, with the primary goal of making it easier to write apps that run under rubyw.exe, where ruby loads with stdio closed.  Whilst the primary intention for use is under win32, and was actually developed as an external helper for specifically win32-service usage, this gem may be useful to some other folks on other platforms. It is not win32  specific.
+email: raggi@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/rubyw_helper.rb
+- spec/.bacon
+- spec/helper.rb
+- spec/runner
+- spec/spec_rubyw_helper.rb
+- tasks/ann.rake
+- tasks/autospec.rake
+- tasks/bacon.rake
+- tasks/bones.rake
+- tasks/gem.rake
+- tasks/git.rake
+- tasks/manifest.rake
+- tasks/notes.rake
+- tasks/post_load.rake
+- tasks/rdoc.rake
+- tasks/rubyforge.rake
+- tasks/setup.rb
+has_rdoc: true
+homepage: http://github.com/raggi/rubyw_helper
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: libraggi
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A simple redirector for use when you just want to safely redirect stdio
+test_files: []
+