Rakefile

# encoding: UTF-8
require 'rubygems'
require 'rake/clean'
require 'rubygems/package_task'
require 'rdoc/task'
require 'rake/testtask'

# The Unix name of this project.
PKG_NAME    = 'io-like'

# The current version of this gem.  Increment for each new release.
PKG_VERSION = '0.3.0'

# The location where documentation should be created.
# NOTE: This MUST have a slash on the end or document publishing will not work
# correctly.
LOCAL_DOCS  = 'doc/'

# The location for published documents to be copied.
remote_user = ENV['REMOTE_USER'].nil? ? '' : ENV['REMOTE_USER'] + '@'
remote_host = ENV['REMOTE_HOST'].nil? ?
  'rubyforge.org:' :
  ENV['REMOTE_HOST'] + ':'
remote_path = ENV['REMOTE_PATH'].nil? ?
  "/var/www/gforge-projects/#{PKG_NAME}" :
  ENV['REMOTE_PATH']
remote_path += '/' unless remote_path[-1, 1] == '/'
REMOTE_DOCS = "#{remote_user}#{remote_host}#{remote_path}"

# The files which actually do something.
LIB_FILES   = FileList.new(
  'lib/**/*.rb'
)

# Files used to run tests.
TEST_FILES  = FileList.new(
  'test/**/*.rb'
)

# Spec files used with mspec and their support files.
SPEC_FILES  = FileList.new(
  'ruby.1.8.mspec',
  'spec_helper.rb',
  'spec/**/*'
)

# Files to be included for documentation purposes only.
DOC_FILES   = FileList.new(
  'CONTRIBUTORS',
  'HACKING',
  'LICENSE',
  'LICENSE.rubyspec',
  'GPL',
  'LEGAL',
  'NEWS',
  'README'
)

# Files which do not match another category.
MISC_FILES  = FileList.new(
  'MANIFEST'
)

# All the files which are to be included within the package.
PKG_FILES   = LIB_FILES + DOC_FILES + MISC_FILES

# Files used by the rdoc task.
RDOC_FILES  = LIB_FILES + DOC_FILES

# Make sure that :clean and :clobber will not whack the repository files.
CLEAN.exclude('.git/**')
# Vim swap files are fair game for clean up.
CLEAN.include('**/.*.sw?')

spec = Gem::Specification.new do |s|
  s.name          = PKG_NAME
  s.version       = PKG_VERSION
  s.platform      = Gem::Platform::RUBY
  s.author        = 'Jeremy Bopp'
  s.email         = 'jeremy at bopp dot net'
  s.summary       = 'A module which provides the functionality of an IO object to any class which provides a couple of simple methods.'
  s.description   = <<-EOF
The IO::Like module provides the methods of an IO object based upon on a few
simple methods provided by the including class: unbuffered_read,
unbuffered_write, and unbuffered_seek.  These methods provide the underlying
read, write, and seek support respectively, and only the method or methods
necessary to the correct operation of the IO aspects of the including class need
to be provided.  Missing functionality will cause the resulting object to appear
read-only, write-only, and/or unseekable depending on which underlying methods
are absent.

Additionally, read and write operations which are buffered in IO are buffered
with independently configurable buffer sizes.  Duplexed objects (those with
separate read and write streams) are also supported.
  EOF
  s.rubyforge_project = PKG_NAME
  s.homepage      = "http://#{PKG_NAME}.rubyforge.org"
  s.files         = PKG_FILES
  s.required_ruby_version = '>= 1.8.1'

  s.has_rdoc      = true
  s.extra_rdoc_files = DOC_FILES
  s.rdoc_options  << '--title' << 'IO::Like Documentation' <<
                     '--charset' << 'utf-8' <<
                     '--line-numbers' << '--inline-source'
end

# Ensure that the packaging tasks which will be created verify the manifest
# first.
task :gem => :check_manifest
task :package => :check_manifest

# Create the gem and package tasks.
Gem::PackageTask.new(spec) do |t|
  t.need_tar_gz = true
end

# Create the rdoc task.
RDoc::Task.new do |rdoc|
  rdoc.rdoc_dir   = LOCAL_DOCS
  rdoc.title      = 'IO::Like Documentation'
  rdoc.rdoc_files = RDOC_FILES
  rdoc.main       = 'README'

  # Set miscellaneous options to settings I like.
  rdoc.options    << '--line-numbers' << '--inline-source'
  rdoc.options    << '--charset' << 'utf-8'

  # Use the allison template if available.
  allison_path    = `allison --path 2>/dev/null`.chomp
  rdoc.template   = allison_path unless allison_path.empty?
end

desc 'Tag the current HEAD with the current version string'
task :tag do
  sh "git tag -s -m 'Release v#{PKG_VERSION}' v#{PKG_VERSION}"
end

desc 'Create the CHANGELOG file'
task :changelog do
  sh "git log > CHANGELOG"
end

desc 'Create/Update the MANIFEST file'
task :manifest do
  File.open('MANIFEST', 'w') { |f| f.puts(PKG_FILES.sort) }
end

desc 'Verify the manifest'
task :check_manifest do
  unless File.exist?('MANIFEST') then
    raise "File not found - `MANIFEST': Execute the manifest task"
  end
  manifest_files = File.readlines('MANIFEST').map { |line| line.chomp }.uniq
  pkg_files = PKG_FILES.uniq
  if manifest_files.sort != pkg_files.sort then
    common_files = manifest_files & pkg_files
    manifest_files.delete_if { |file| common_files.include?(file) }
    pkg_files.delete_if { |file| common_files.include?(file) }
    $stderr.puts('The manifest does not match package file list')
    unless manifest_files.empty? then
      $stderr.puts("  Extraneous files:\n    " + manifest_files.join("\n    "))
    end
    unless pkg_files.empty?
      $stderr.puts("  Missing files:\n    " + pkg_files.join("\n    "))
    end
    exit 1
  end
end

desc 'Publish the project documentation'
task :publish => [:rdoc] do
  sh "rsync -r --delete \"#{LOCAL_DOCS}\" \"#{REMOTE_DOCS}\""
end

# Create the test task.
desc 'Run tests'
task :test do
  sh "mspec"
end

# Clean up to a pristine state.
task :clobber => [:clobber_package, :clobber_rdoc]

desc 'An alias for the gem target'
task :default => [:gem]