bones 2.5.1 → 3.0.0

data/lib/bones/tasks/bones.rake

@@ -1,20 +0,0 @@
-
-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/lib/bones/tasks/gem.rake

@@ -1,201 +0,0 @@
-
-require 'find'
-require 'rake/packagetask'
-require 'rubygems/user_interaction'
-require 'rubygems/builder'
-
-module Bones
-class GemPackageTask < Rake::PackageTask
-  # Ruby GEM spec containing the metadata for this package.  The
-  # name, version and package_files are automatically determined
-  # from the GEM spec and don't need to be explicitly provided.
-  #
-  attr_accessor :gem_spec
-
-  # Tasks from the Bones gem directory
-  attr_reader :bones_files
-
-  # Create a GEM Package task library.  Automatically define the gem
-  # if a block is given.  If no block is supplied, then +define+
-  # needs to be called to define the task.
-  #
-  def initialize(gem_spec)
-    init(gem_spec)
-    yield self if block_given?
-    define if block_given?
-  end
-
-  # Initialization tasks without the "yield self" or define
-  # operations.
-  #
-  def init(gem)
-    super(gem.name, gem.version)
-    @gem_spec = gem
-    @package_files += gem_spec.files if gem_spec.files
-    @bones_files = []
-
-    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
-    if !test(?e, local_setup)
-      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
-    end
-  end
-
-  # Create the Rake tasks and actions specified by this
-  # GemPackageTask.  (+define+ is automatically called if a block is
-  # given to +new+).
-  #
-  def define
-    super
-    task :prereqs
-    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
-    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
-      when_writing("Creating GEM") {
-        chdir(package_dir_path) do
-          Gem::Builder.new(gem_spec).build
-          verbose(true) {
-            mv gem_file, "../#{gem_file}"
-          }
-        end
-      }
-    end
-
-    file package_dir_path => bones_files do
-      mkdir_p package_dir rescue nil
-
-      gem_spec.files = (gem_spec.files +
-          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
-
-      bones_files.each do |fn|
-        base_fn = File.join('tasks', File.basename(fn))
-        f = File.join(package_dir_path, base_fn)
-        fdir = File.dirname(f)
-        mkdir_p(fdir) if !File.exist?(fdir)
-        if File.directory?(fn)
-          mkdir_p(f)
-        else
-          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
-          safe_ln(fn, f)
-        end
-      end
-    end
-  end
-  
-  def gem_file
-    if @gem_spec.platform == Gem::Platform::RUBY
-      "#{package_name}.gem"
-    else
-      "#{package_name}-#{@gem_spec.platform}.gem"
-    end
-  end
-end  # class GemPackageTask
-end  # module Bones
-
-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
-
-    PROJ.gem.development_dependencies.each do |dep|
-      s.add_development_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
-
-  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
-    pkg.need_tar = PROJ.gem.need_tar
-    pkg.need_zip = PROJ.gem.need_zip
-  end
-
-  desc 'Show information about the gem'
-  task :debug => 'gem:prereqs' do
-    puts PROJ.gem._spec.to_ruby
-  end
-
-  desc 'Write the gemspec '
-  task :spec => 'gem:prereqs' do
-    File.open("#{PROJ.name}.gemspec", 'w') do |f|
-      f.write PROJ.gem._spec.to_ruby
-    end
-  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 'gem:clobber_package'
-
-# EOF

data/lib/bones/tasks/git.rake

@@ -1,40 +0,0 @@
-
-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/lib/bones/tasks/notes.rake

@@ -1,27 +0,0 @@
-
-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/lib/bones/tasks/post_load.rake

@@ -1,34 +0,0 @@
-
-# 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.exclude << ["^#{Regexp.escape(PROJ.ann.file)}$",
-                 "^#{Regexp.escape(PROJ.ignore_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 \
-           or key == :development_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 ||= manifest
-
-PROJ.gem.executables ||= PROJ.gem.files.find_all {|fn| fn =~ %r/^bin/}
-
-PROJ.rdoc.main ||= PROJ.readme_file
-
-# EOF

data/lib/bones/tasks/rdoc.rake

@@ -1,51 +0,0 @@
-
-require 'rake/rdoctask'
-
-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)
-
-    name    = PROJ.name
-    rf_name = PROJ.rubyforge.name
-
-    title = "#{name}-#{PROJ.version} Documentation"
-    title = "#{rf_name}'s " + title if rf_name.valid? and rf_name != name
-
-    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/lib/bones/tasks/rubyforge.rake

@@ -1,55 +0,0 @@
-
-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'] 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 = Dir.glob("#{pkg}*.*")
-
-    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/lib/bones/tasks/setup.rb

@@ -1,292 +0,0 @@
-
-require 'rubygems'
-require 'rake'
-require 'rake/clean'
-require 'fileutils'
-require 'ostruct'
-require 'find'
-
-class OpenStruct; undef :gem if defined? :gem; end 
-
-# TODO: make my own openstruct type object that includes descriptions
-# TODO: use the descriptions to output help on the available bones options
-
-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',
-  :readme_file => 'README.txt',
-  :ignore_file => '.bnsignore',
-
-  # 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 => [],
-    :development_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 .rdoc) << '',
-    :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$ \.rdoc$),
-    :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
-tasks_dir = File.expand_path(File.dirname(__FILE__))
-post_load_fn = File.join(tasks_dir, 'post_load.rake')
-rakefiles = Dir.glob(File.join(tasks_dir, '*.rake')).sort
-rakefiles.unshift(rakefiles.delete(post_load_fn)).compact!
-import(*rakefiles)
-
-# Setup the project libraries
-%w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
-
-# Setup some constants
-DEV_NULL = File.exist?('/dev/null') ? '/dev/null' : 'NUL:'
-
-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 system("gdiff '#{__FILE__}' '#{__FILE__}' > #{DEV_NULL} 2>&1") then 'gdiff'
-       else 'diff' end unless defined? DIFF
-
-SUDO = if system("which sudo > #{DEV_NULL} 2>&1") then 'sudo'
-       else '' end unless defined? SUDO
-
-RCOV = "#{RUBY} -S rcov"
-RDOC = "#{RUBY} -S rdoc"
-GEM  = "#{RUBY} -S gem"
-
-%w(rcov spec/rake/spectask rubyforge bones facets/ansicode zentest).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}"))
-
-# Add bones as a development dependency
-#
-if HAVE_BONES
-  PROJ.gem.development_dependencies << ['bones', ">= #{Bones::VERSION}"]
-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 )
-  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 = []
-  exclude = PROJ.exclude.dup
-  comment = %r/^\s*#/
- 
-  # process the ignore file and add the items there to the exclude list
-  if test(?f, PROJ.ignore_file)
-    ary = []
-    File.readlines(PROJ.ignore_file).each do |line|
-      next if line =~ comment
-      line.chomp!
-      line.strip!
-      next if line.nil? or line.empty?
-
-      glob = line =~ %r/\*\./ ? File.join('**', line) : line
-      Dir.glob(glob).each {|fn| ary << "^#{Regexp.escape(fn)}"}
-    end
-    exclude.concat ary
-  end
-
-  # generate a regular expression from the exclude list
-  exclude = Regexp.new(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