dokkit 0.2.0 → 0.3.0

data/tasks/gem.rake

@@ -0,0 +1,89 @@
+# $Id$
+
+require 'rake/gempackagetask'
+
+namespace :gem do
+
+  PROJ.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.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    s.files = PROJ.files
+    s.executables = PROJ.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.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.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.tests.to_a
+    end
+
+    # Do any extra stuff the user wants
+#   spec_extras.each do |msg, val|
+#     case val
+#     when Proc
+#       val.call(s.send(msg))
+#     else
+#       s.send "#{msg}=", val
+#     end
+#   end
+  end
+
+  desc 'Show information about the gem'
+  task :debug do
+    puts PROJ.spec.to_ruby
+  end
+
+  Rake::GemPackageTask.new(PROJ.spec) do |pkg|
+    pkg.need_tar = PROJ.need_tar
+    pkg.need_zip = PROJ.need_zip
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, :package] do
+    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.file_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' #{PROJ.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/manifest.rake

@@ -0,0 +1,41 @@
+# $Id$
+
+require 'find'
+
+namespace :manifest do
+
+  desc 'Verify the manifest'
+  task :check do
+    fn = 'Manifest.tmp'
+    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
+
+    File.open(fn, 'w') {|fp| fp.puts files.sort}
+    system "#{DIFF} -du Manifest.txt #{fn}"
+    rm fn rescue nil
+  end
+
+  desc 'Create a new manifest'
+  task :create do
+    fn = 'Manifest.txt'
+    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 << fn unless test ?f, fn
+    File.open(fn, 'w') {|fp| fp.puts files.sort}
+  end
+end
+
+# EOF

data/tasks/rubyforge.rake

@@ -0,0 +1,57 @@
+# $Id$
+
+if PROJ.rubyforge_name && HAVE_RUBYFORGE
+
+require 'rubyforge'
+require 'rake/contrib/sshpublisher'
+
+namespace :gem do
+  desc 'Package and upload to RubyForge'
+  task :release => [:clobber, :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.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
+    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.need_tar ? "#{pkg}.tgz" : nil),
+             (PROJ.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,151 @@
+# $Id$
+
+require 'rubygems'
+require 'rake'
+require 'fileutils'
+require 'ostruct'
+
+PROJ = OpenStruct.new
+
+PROJ.name = nil
+PROJ.summary = nil
+PROJ.description = nil
+PROJ.changes = nil
+PROJ.authors = nil
+PROJ.email = nil
+PROJ.url = nil
+PROJ.version = ENV['VERSION'] || '0.0.0'
+PROJ.rubyforge_name = nil
+PROJ.exclude = %w(tmp$ bak$ ~$ CVS .svn/ ^pkg/ ^doc/)
+
+# Rspec
+PROJ.specs = FileList['spec/**/*_spec.rb']
+PROJ.spec_opts = []
+
+# Test::Unit
+PROJ.tests = FileList['test/**/test_*.rb']
+PROJ.test_file = 'test/all.rb'
+PROJ.test_opts = []
+
+# Rcov
+PROJ.rcov_opts = ['--sort', 'coverage', '-T']
+
+# Rdoc
+PROJ.rdoc_opts = []
+PROJ.rdoc_include = %w(^lib/ ^bin/ ^ext/ .txt$)
+PROJ.rdoc_exclude = %w(extconf.rb$ ^Manifest.txt$)
+PROJ.rdoc_main = 'README.txt'
+PROJ.rdoc_dir = 'doc'
+PROJ.rdoc_remote_dir = nil
+
+# Extensions
+PROJ.extensions = FileList['ext/**/extconf.rb']
+PROJ.ruby_opts = %w(-w)
+PROJ.libs = []
+%w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
+
+# Gem Packaging
+PROJ.files =
+  if test ?f, 'Manifest.txt'
+    files = File.readlines('Manifest.txt').map {|fn| fn.chomp.strip}
+    files.delete ''
+    files
+  else [] end
+PROJ.executables = PROJ.files.find_all {|fn| fn =~ %r/^bin/}
+PROJ.dependencies = []
+PROJ.need_tar = true
+PROJ.need_zip = false
+
+# File Annotations
+PROJ.annotation_exclude = []
+PROJ.annotation_extensions = %w(.txt .rb .erb) << ''
+
+# Subversion Repository
+PROJ.svn = false
+PROJ.svn_root = nil
+PROJ.svn_trunk = 'trunk'
+PROJ.svn_tags = 'tags'
+PROJ.svn_branches = 'branches'
+
+# Load the other rake files in the tasks folder
+Dir.glob('tasks/*.rake').sort.each {|fn| import fn}
+
+# Setup some constants
+WIN32 = %r/win32/ =~ 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
+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.cmd'  : 'rcov'
+GEM  = WIN32 ? 'gem.cmd'   : 'gem'
+
+%w(rcov spec/rake/spectask rubyforge bones).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
+
+# 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)
+  File.read(path).delete("\r").split(/\n\n+/).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.dependencies << (version.nil? ? [name] : [name, ">= #{version}"])
+end
+
+# Adds the given _path_ to the include path if it is not already there
+#
+def ensure_in_path( path )
+  path = File.expand_path(path)
+  $:.unshift(path) if test(?d, path) and not $:.include?(path)
+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
+
+# EOF

data/tasks/spec.rake

@@ -0,0 +1,40 @@
+# $Id$
+
+if HAVE_SPEC_RAKE_SPECTASK
+
+namespace :spec do
+
+  desc 'Run all specs with basic output'
+  Spec::Rake::SpecTask.new(:run) do |t|
+    t.spec_opts = PROJ.spec_opts
+    t.spec_files = PROJ.specs
+  end
+
+  desc 'Run all specs with text output'
+  Spec::Rake::SpecTask.new(:specdoc) do |t|
+    t.spec_opts = PROJ.spec_opts + ['--format', 'specdoc']
+    t.spec_files = PROJ.specs
+  end
+
+  if HAVE_RCOV
+    desc 'Run all specs with RCov'
+    Spec::Rake::SpecTask.new(:rcov) do |t|
+      t.spec_opts = PROJ.spec_opts
+      t.spec_files = PROJ.specs
+      t.rcov = true
+      t.rcov_opts = PROJ.rcov_opts + ['--exclude', 'spec']
+    end
+  end
+
+end  # namespace :spec
+
+desc 'Alias to spec:run'
+task :spec => 'spec:run'
+
+task :clobber => 'spec:clobber_rcov' if HAVE_RCOV
+
+remove_desc_for_task %w(spec:clobber_rcov)
+
+end  # if HAVE_SPEC_RAKE_SPECTASK
+
+# EOF

data/tasks/svn.rake

@@ -0,0 +1,44 @@
+# $Id$
+
+
+if PROJ.svn and system("svn --version 2>&1 > #{DEV_NULL}")
+
+unless PROJ.svn_root
+  info = %x/svn info ./
+  m = %r/^Repository Root:\s+(.*)$/.match(info)
+  PROJ.svn_root = (m.nil? ? '' : m[1])
+end
+PROJ.svn_root = File.join(PROJ.svn_root, PROJ.svn) if String === PROJ.svn
+
+namespace :svn do
+
+  desc 'Show tags from the SVN repository'
+  task :show_tags do |t|
+    tags = %x/svn list #{File.join(PROJ.svn_root, PROJ.svn_tags)}/
+    tags.gsub!(%r/\/$/, '')
+    puts tags
+  end
+
+  desc 'Create a new tag in the SVN repository'
+  task :create_tag 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
+
+    trunk = File.join(PROJ.svn_root, PROJ.svn_trunk)
+    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    tag = File.join(PROJ.svn_root, PROJ.svn_tags, tag)
+    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+    puts "Creating SVN tag '#{tag}'"
+    unless system "svn cp -m '#{msg}' #{trunk} #{tag}"
+      abort "Tag creation failed" 
+    end
+  end
+
+end  # namespace :svn
+
+task 'gem:release' => 'svn:create_tag'
+
+end  # if PROJ.svn
+
+# EOF

data/tasks/test.rake

@@ -0,0 +1,40 @@
+# $Id$
+
+require 'rake/testtask'
+
+namespace :test do
+
+  Rake::TestTask.new(:run) do |t|
+    t.libs = PROJ.libs
+    t.test_files = if test ?f, PROJ.test_file then [PROJ.test_file]
+                   else PROJ.tests end
+    t.ruby_opts += PROJ.ruby_opts
+    t.ruby_opts += PROJ.test_opts
+  end
+
+  if HAVE_RCOV
+    desc 'Run rcov on the unit tests'
+    task :rcov => :clobber_rcov do
+      opts = PROJ.rcov_opts.join(' ')
+      files = if test ?f, PROJ.test_file then [PROJ.test_file]
+              else PROJ.tests end
+      files = files.join(' ')
+      sh "#{RCOV} #{files} #{opts}"
+    end
+
+    desc 'Remove rcov products'
+    task :clobber_rcov do
+      rm_r 'coverage' rescue nil
+    end
+  end
+
+end  # namespace :test
+
+desc 'Alias to test:run'
+task :test => 'test:run'
+
+task :clobber => 'test:clobber_rcov' if HAVE_RCOV
+
+remove_desc_for_task %w(test:clobber_rcov)
+
+# EOF