dokkit 0.4.4 → 0.5.0

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

@@ -6,36 +6,44 @@ 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
+    fn = PROJ.manifest_file + '.tmp'
+    files = manifest_files
 
-    File.open(fn, 'w') {|fp| fp.puts files.sort}
-    system "#{DIFF} -du Manifest.txt #{fn}"
+    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
-    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
+    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
 
-    files << fn unless test ?f, fn
-    File.open(fn, 'w') {|fp| fp.puts files.sort}
+  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
+
+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/{doc.rake → rdoc.rake}

@@ -6,13 +6,13 @@ namespace :doc do
 
   desc 'Generate RDoc documentation'
   Rake::RDocTask.new do |rd|
-    rd.main = PROJ.rdoc_main
-    rd.options << '-d' if !WIN32 and `which dot` =~ %r/\/dot/
-    rd.rdoc_dir = PROJ.rdoc_dir
+    rdoc = PROJ.rdoc
+    rd.main = rdoc.main
+    rd.rdoc_dir = rdoc.dir
 
-    incl = Regexp.new(PROJ.rdoc_include.join('|'))
-    excl = Regexp.new(PROJ.rdoc_exclude.join('|'))
-    files = PROJ.files.find_all do |fn|
+    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
@@ -21,9 +21,12 @@ namespace :doc do
     rd.rdoc_files.push(*files)
 
     title = "#{PROJ.name}-#{PROJ.version} Documentation"
-    title = "#{PROJ.rubyforge_name}'s " + title if PROJ.rubyforge_name != title
+
+    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'
@@ -31,7 +34,6 @@ namespace :doc do
     sh "#{RDOC} --ri -o ri ."
   end
 
-  desc 'Remove ri products'
   task :clobber_ri do
     rm_r 'ri' rescue nil
   end
@@ -44,6 +46,6 @@ 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 doc:clobber_ri)
+remove_desc_for_task %w(doc:clobber_rdoc)
 
 # EOF

data/tasks/rubyforge.rake

@@ -1,23 +1,23 @@
-# $Id$
 
-if PROJ.rubyforge_name && HAVE_RUBYFORGE
+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, :package] do |t|
+  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.spec.full_name}"
+    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\""
+      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
 
@@ -26,12 +26,12 @@ namespace :gem do
     c['release_changes'] = PROJ.changes if PROJ.changes
     c['preformatted'] = true
 
-    files = [(PROJ.need_tar ? "#{pkg}.tgz" : nil),
-             (PROJ.need_zip ? "#{pkg}.zip" : nil),
+    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
+    rf.add_release PROJ.rubyforge.name, PROJ.name, PROJ.version, *files
   end
 end  # namespace :gem
 
@@ -44,9 +44,9 @@ namespace :doc do
     )
 
     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
+    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

data/tasks/setup.rb

@@ -2,76 +2,123 @@
 
 require 'rubygems'
 require 'rake'
+require 'rake/clean'
 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}
+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
+  ),
 
-# 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'
+  # 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
-Dir.glob('tasks/*.rake').sort.each {|fn| import fn}
+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/win32/ =~ RUBY_PLATFORM unless defined? WIN32
+WIN32 = %r/djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM unless defined? WIN32
 
 DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
 
@@ -83,6 +130,7 @@ def quiet( &block )
 ensure
   STDOUT.reopen io.first
   STDERR.reopen io.last
+  $stdout, $stderr = STDOUT, STDERR
 end
 
 DIFF = if WIN32 then 'diff.exe'
@@ -97,10 +145,11 @@ SUDO = if WIN32 then ''
          else '' end
        end
 
-RCOV = WIN32 ? 'rcov.cmd'  : 'rcov'
-GEM  = WIN32 ? 'gem.cmd'   : 'gem'
+RCOV = WIN32 ? 'rcov.bat' : 'rcov'
+RDOC = WIN32 ? 'rdoc.bat' : 'rdoc'
+GEM  = WIN32 ? 'gem.bat'  : 'gem'
 
-%w(rcov spec/rake/spectask rubyforge bones).each do |lib|
+%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}
@@ -108,6 +157,10 @@ GEM  = WIN32 ? 'gem.cmd'   : 'gem'
     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.
@@ -115,8 +168,28 @@ end
 #    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)
+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
@@ -127,14 +200,19 @@ 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}"])
+  PROJ.gem.dependencies << case version
+    when nil; [name]
+    when %r/^\d/; [name, ">= #{version}"]
+    else [name, version] end
 end
 
-# Adds the given _path_ to the include path if it is not already there
+# Adds the given arguments to the include path if they are not already there
 #
-def ensure_in_path( path )
-  path = File.expand_path(path)
-  $:.unshift(path) if test(?d, path) and not $:.include?(path)
+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
@@ -148,4 +226,43 @@ def remove_desc_for_task( names )
   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