bones 1.3.5 → 2.0.0

data/tasks/bones.rake

@@ -1,7 +1,6 @@
 # $Id$
 
-require 'pp'
-require 'stringio'
+if HAVE_BONES
 
 namespace :bones do
 
@@ -10,31 +9,13 @@ namespace :bones do
     atr = if ARGV.length == 2
       t.application.top_level_tasks.pop
     end
-    sio = StringIO.new
-    sep = "\n" + ' '*27
-    fmt = "%23s => %s"
 
-    if atr
-      PP.pp(PROJ.send(atr.to_sym), sio, 49)
-      sio.seek 0
-      val = sio.read
-      val = val.split("\n").join(sep)
-
-      puts fmt % [atr, val]
-    else
-      h = PROJ.instance_variable_get(:@table)
-      h.keys.map {|k| k.to_s}.sort.each do |k|
-        sio.truncate 0
-        PP.pp(h[k.to_sym], sio, 49)
-        sio.seek 0
-        val = sio.read
-        val = val.split("\n").join(sep)
-
-        puts fmt % [k, val]
-      end
-    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

@@ -1,87 +1,89 @@
-# $Id$
+# $Id: gem.rake 585 2008-04-07 20:15:39Z tim_pease $
 
 require 'rake/gempackagetask'
 
 namespace :gem do
 
-  PROJ.spec = Gem::Specification.new do |s|
+  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.post_install_message = PROJ.post_install_message
+    s.rubyforge_project = PROJ.rubyforge.name
 
     s.description = PROJ.description
 
-    PROJ.dependencies.each do |dep|
+    PROJ.gem.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.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]
+    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|
+    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.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
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
     else
-      s.test_files = PROJ.tests.to_a
+      s.test_files = PROJ.test.files.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
+    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 do
-    puts PROJ.spec.to_ruby
+  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.need_tar
-    pkg.need_zip = PROJ.need_zip
-    pkg.package_files += PROJ.spec.files
+    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.spec.platform == Gem::Platform::RUBY
+  gem_file = if PROJ.gem._spec.platform == Gem::Platform::RUBY
       "#{pkg.package_name}.gem"
     else
-      "#{pkg.package_name}-#{PROJ.spec.platform}.gem"
+      "#{pkg.package_name}-#{PROJ.gem._spec.platform}.gem"
     end
 
   desc "Build the gem file #{gem_file}"
-  task :package => "#{pkg.package_dir}/#{gem_file}"
+  task :package => ['gem:prereqs', "#{pkg.package_dir}/#{gem_file}"]
 
-  file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.spec.files do
+  file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.gem._spec.files do
     when_writing("Creating GEM") {
-      Gem::Builder.new(PROJ.spec).build
+      Gem::Builder.new(PROJ.gem._spec).build
       verbose(true) {
         mv gem_file, "#{pkg.package_dir}/#{gem_file}"
       }
@@ -90,14 +92,14 @@ namespace :gem do
 
   desc 'Install the gem'
   task :install => [:clobber, :package] do
-    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.full_name}"
+    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 -v '#{PROJ.version}' -i -x #{PROJ.name}"
+      sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' -I -x #{PROJ.name}"
     end
   end
 

data/tasks/notes.rake

@@ -0,0 +1,28 @@
+# $Id$
+
+if HAVE_BONES
+
+desc "Enumerate all annotations"
+task :notes do |t|
+  id = if ARGV.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 ARGV.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

@@ -3,14 +3,19 @@
 # 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)}$"
-
-PROJ.instance_variable_get(:@table).each do |key,val|
-  next unless val.instance_of? Array
-  next if key == :dependencies
-  val.flatten!
-end
+PROJ.rdoc.exclude << "^#{Regexp.escape(PROJ.manifest_file)}$"
+PROJ.exclude << "^#{Regexp.escape(PROJ.ann.file)}$"
+
+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")
 
@@ -18,15 +23,15 @@ PROJ.description ||= paragraphs_of(PROJ.readme_file, 'description').join("\n\n")
 
 PROJ.summary ||= PROJ.description.split('.').first
 
-PROJ.files ||=
+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.executables ||= PROJ.files.find_all {|fn| fn =~ %r/^bin/}
+PROJ.gem.executables ||= PROJ.gem.files.find_all {|fn| fn =~ %r/^bin/}
 
-PROJ.rdoc_main ||= PROJ.readme_file
+PROJ.rdoc.main ||= PROJ.readme_file
 
 # EOF

data/tasks/{doc.rake → rdoc.rake}

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: rdoc.rake 584 2008-04-07 19:46:38Z tim_pease $
 
 require 'rake/rdoctask'
 
@@ -6,12 +6,13 @@ namespace :doc do
 
   desc 'Generate RDoc documentation'
   Rake::RDocTask.new do |rd|
-    rd.main = PROJ.rdoc_main
-    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
@@ -20,10 +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(PROJ.rdoc_opts)
+    rd.options.concat(rdoc.opts)
   end
 
   desc 'Generate ri locally for testing'

data/tasks/rubyforge.rake

@@ -1,6 +1,6 @@
-# $Id$
+# $Id: rubyforge.rake 590 2008-04-07 20:52:22Z tim_pease $
 
-if PROJ.rubyforge_name && HAVE_RUBYFORGE
+if PROJ.rubyforge.name.valid? && HAVE_RUBYFORGE
 
 require 'rubyforge'
 require 'rake/contrib/sshpublisher'
@@ -10,11 +10,11 @@ namespace :gem do
   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}"
+    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
@@ -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

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: setup.rb 584 2008-04-07 19:46:38Z tim_pease $
 
 require 'rubygems'
 require 'rake'
@@ -6,92 +6,117 @@ 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/)
-PROJ.release_name = ENV['RELEASE']
-PROJ.history_file = 'History.txt'
-PROJ.manifest_file = 'Manifest.txt'
-PROJ.readme_file = 'README.txt'
-
-# 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_dir = 'coverage'
-PROJ.rcov_opts = %w[--sort coverage -T]
-PROJ.rcov_threshold = 90.0
-PROJ.rcov_threshold_exact = false
-
-# Rdoc
-PROJ.rdoc_opts = []
-PROJ.rdoc_include = %w(^lib/ ^bin/ ^ext/ .txt$)
-PROJ.rdoc_exclude = %w(extconf.rb$)
-PROJ.rdoc_main = nil
-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/ ^pkg/ ^doc/),
+  :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"
+  ),
 
-# Gem Packaging
-PROJ.files = nil
-PROJ.executables = nil
-PROJ.dependencies = []
-PROJ.need_tar = true
-PROJ.need_zip = false
-PROJ.post_install_message = nil
-
-# File Annotations
-PROJ.annotation_exclude = %w(^tasks/setup.rb$)
-PROJ.annotation_extensions = %w(.txt .rb .erb) << ''
-PROJ.annotation_tags = %w(FIXME OPTIMIZE TODO)
-
-# Subversion Repository
-PROJ.svn = false
-PROJ.svn_root = nil
-PROJ.svn_trunk = 'trunk'
-PROJ.svn_tags = 'tags'
-PROJ.svn_branches = 'branches'
-
-# Announce
-PROJ.ann_file = 'announcement.txt'
-PROJ.ann_text = nil
-PROJ.ann_paragraphs = []
-PROJ.ann_email = {
-  :from     => nil,
-  :to       => %w(ruby-talk@ruby-lang.org),
-  :server   => 'localhost',
-  :port     => 25,
-  :domain   => ENV['HOSTNAME'],
-  :acct     => nil,
-  :passwd   => nil,
-  :authtype => :plain
-}
+  # 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
 
@@ -105,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'
@@ -120,6 +146,7 @@ SUDO = if WIN32 then ''
        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|
@@ -130,6 +157,8 @@ GEM  = WIN32 ? 'gem.bat'  : '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}"))
 
 # Reads a file at +path+ and spits out an array of the +paragraphs+
 # specified.
@@ -169,7 +198,7 @@ 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 << case version
+  PROJ.gem.dependencies << case version
     when nil; [name]
     when %r/^\d/; [name, ">= #{version}"]
     else [name, version] end
@@ -224,4 +253,14 @@ def manifest_files
   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