bones 1.0.0

data/data/tasks/manifest.rake

@@ -0,0 +1,41 @@
+# $Id$
+
+require 'find'
+
+namespace :manifest do
+
+  desc 'Verify the manfiest'
+  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/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 || PROJ.name
+    local_dir = PROJ.rdoc_dir
+
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+end  # namespace :doc
+
+end  # if HAVE_RUBYFORGE
+
+# EOF

data/data/tasks/setup.rb

@@ -0,0 +1,129 @@
+# $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)
+
+# 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
+
+# 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 rubyforge source_annotation_extractor).each do |lib|
+  begin
+    require lib
+    Object.instance_eval {const_set "HAVE_#{lib.upcase}", true}
+  rescue LoadError
+    Object.instance_eval {const_set "HAVE_#{lib.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
+
+# EOF

data/data/tasks/spec.rake

@@ -0,0 +1,37 @@
+# $Id$
+
+if HAVE_SPEC
+
+require '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
+
+task :clobber => 'spec:clobber_rcov' if HAVE_RCOV
+
+end  # if HAVE_SPEC
+
+# EOF

data/data/tasks/test.rake

@@ -0,0 +1,35 @@
+# $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
+
+task :clobber => 'test:clobber_rcov' if HAVE_RCOV
+
+# EOF

data/lib/bones.rb

@@ -0,0 +1,177 @@
+# $Id: bones.rb 420 2007-12-29 04:45:29Z tim_pease $
+
+require 'fileutils'
+require 'optparse'
+require 'erb'
+
+module Bones
+
+  VERSION = '1.0.0'    # :nodoc:
+  PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))  # :nodoc:
+
+  class Main
+
+    attr_writer :update
+    attr_accessor :name, :data
+
+    # Create a new instance of Main, and run the +bones+ application given
+    # the command line _args_.
+    #
+    def self.run( args )
+      bones = self.new
+      bones.parse args
+
+      if bones.update? then bones.update
+      else bones.create end
+    end
+
+    # Parse the command line arguments and store the values for later use by
+    # the +create+ and +update+ methods.
+    #
+    def parse( args )
+      self.data = File.join(::Bones::PATH, 'data')
+      self.update = false
+
+      opts = OptionParser.new
+      opts.banner << ' project_name'
+
+      opts.separator ''
+      opts.on('-u', '--update',
+              'update the rake tasks for the project') {self.update = true}
+
+      opts.separator ''
+      opts.separator 'common options:'
+
+      opts.on_tail( '-h', '--help', 'show this message' ) {puts opts; exit}
+      opts.on_tail( '--version', 'show version' ) do
+        puts "Bones #{::Bones::VERSION}"
+        exit
+      end
+
+      # parse the command line arguments
+      opts.parse! args
+      self.name = args.shift
+
+      if name.nil?
+        puts opts
+        ::Kernel.abort
+      end
+      nil
+    end
+
+    # Returns +true+ if we are updating an already existing project. Returns
+    # +false+ if we are creating a new project.
+    #
+    def update?
+      @update
+    end
+
+    # Returns the project name but converted to be useable as a Ruby class
+    # name.
+    #
+    def classname
+      name.split('_').map {|x| x.capitalize}.join
+    end
+
+    #
+    #
+    def create
+      # see if the directory already exists
+      abort "'#{name}' already exists" if test ?e, name
+
+      files_to_copy.each {|fn| cp fn}
+
+      pwd = File.expand_path(FileUtils.pwd)
+      begin
+        FileUtils.cd name
+        system "rake manifest:create 2>&1 > /dev/null"
+      ensure
+        FileUtils.cd pwd
+      end
+
+      # * copy files from either
+      #   1) the user's '.bones/data' directory or
+      #   2) the Bones 'data' directory
+      #
+      # TODO - figure out if this really is the best way of doing this
+      #        should I just use either the .bones data or the gem data, not
+      #        both
+    end
+    
+    # Archive any existing tasks in the project's tasks folder, and then
+    # copy in new tasks from the bones/data directory.
+    #
+    def update
+      abort "'#{name}' does no exist" unless test ?e, name
+
+      task_dir = File.join(name, 'tasks')
+      abort "no tasks directory found in '#{name}'" unless test ?d, task_dir
+
+      archive_dir = File.join(task_dir, 'archive')
+      FileUtils.rm_rf archive_dir
+      FileUtils.mkdir archive_dir
+
+      Dir.glob(File.join(task_dir, '*')).each do |fn|
+        next if fn == archive_dir
+        FileUtils.cp fn, archive_dir
+      end
+
+      files_to_copy.each do |fn|
+        next unless 'tasks' == File.basename(File.dirname(fn))
+        cp fn
+      end
+    end
+
+
+    private
+
+    # Copy a file from the Bones prototype project location to the user
+    # specified project location. A message will be displayed to the screen
+    # indicating tha the file is being created.
+    #
+    def cp( file )
+      dir = File.join(name, File.dirname(file))
+      dst = File.join(dir,  File.basename(file, '.erb').sub('NAME', name))
+      src = File.join(data, file)
+
+      FileUtils.mkdir_p(dir)
+
+      if '.erb' == File.extname(file)
+        txt = ERB.new(File.read(src), nil, '-').result(binding)
+        File.open(dst, 'w') {|fd| fd.write(txt)}
+      else
+        FileUtils.cp src, dst
+      end
+
+      FileUtils.chmod(File.stat(src).mode, dst)
+    end
+
+    # Prints an abort _msg_ to the screen and then exits the Ruby interpreter.
+    #
+    def abort( msg )
+      STDERR.puts msg
+      exit 1
+    end
+
+    # Returns a list of the files to copy from the bones/data directory to
+    # the new project directory
+    #
+    def files_to_copy
+      rgxp = %r/\A#{data}\/?/o
+      exclude = %r/tmp$|bak$|~$|CVS|\.svn/o
+
+      ary = Dir.glob(File.join(data, '**', '*')).map do |filename|
+        next if exclude =~ filename
+        next if test(?d, filename)
+        filename.sub rgxp, ''
+      end
+
+      ary.compact!
+      ary.sort!
+      ary
+    end
+
+  end  # class Main
+end  # module Bones
+
+# EOF