bones 2.0.3 → 2.1.0

data/data/spec/NAME_spec.rb.erb

@@ -1,4 +1,3 @@
-# $Id$
 
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 

data/data/spec/spec_helper.rb.erb

@@ -1,4 +1,3 @@
-# $Id$
 
 require File.expand_path(
     File.join(File.dirname(__FILE__), %w[.. lib <%= name %>]))

data/lib/bones.rb

@@ -1,9 +1,8 @@
-# $Id$
 
 module Bones
 
   # :stopdoc:
-  VERSION = '2.0.3'
+  VERSION = '2.1.0'
   PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
   WIN32 = %r/win32/ =~ RUBY_PLATFORM
   DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
@@ -14,7 +13,7 @@ module Bones
   # <tt>File.join</tt>.
   #
   def self.path( *args )
-    args.empty? ? PATH : File.join(PATH, *args)
+    args.empty? ? PATH : File.join(PATH, args.flatten)
   end
 
   # call-seq:
@@ -28,20 +27,34 @@ module Bones
   def self.require_all_libs_relative_to( fname, dir = nil )
     dir ||= File.basename(fname, '.*')
     search_me = File.expand_path(
-        File.join(File.dirname(fname), dir, '**', '*.rb'))
+        File.join(File.dirname(fname), dir, '*.rb'))
 
     Dir.glob(search_me).sort.each {|rb| require rb}
   end
 
+  #
+  #
+  def self.setup
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+
+    if test(?e, local_setup)
+      load local_setup
+      return
+    end
+
+    bones_setup = ::Bones.path %w[lib bones tasks setup.rb]
+    load bones_setup
+
+    rakefiles = Dir.glob(File.join(Dir.pwd, %w[tasks *.rake])).sort
+    import(*rakefiles)
+  end
+
   # TODO: fix file lists for Test::Unit and RSpec
   #       these guys are just grabbing whatever is there and not pulling
   #       the filenames from the manifest
 
-  # TODO: create some tasks to generate e-mails / announcements
-  
 end  # module Bones
 
-
-Bones.require_all_libs_relative_to __FILE__
+Bones.require_all_libs_relative_to(__FILE__)
 
 # EOF

data/lib/bones/annotation_extractor.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 begin
   require 'facets/ansicode'
@@ -85,7 +84,7 @@ class AnnotationExtractor
 
       text = m[2]
       if text =~ @id_rgxp
-        text.gsub!(@id_rgxp) {|str| Console::ANSICode.green(str)} if HAVE_COLOR
+        text.gsub!(@id_rgxp) {|str| ANSICode.green(str)} if HAVE_COLOR
         list << Annotation.new(lineno, m[1], text)
       end
       list

data/lib/bones/debug.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 require 'pp'
 require 'stringio'

data/lib/bones/main.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 require 'fileutils'
 require 'optparse'
@@ -7,102 +6,161 @@ require 'erb'
 module Bones
 class Main
 
-  attr_writer :update
-  attr_accessor :name, :data, :verbose, :output_dir
+  attr_reader :options
 
   # 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
+    bones.parse(args)
+    bones.run
+  end
+
+  # Create a new main instance using _io_ for standard output and _err_ for
+  # error messages.
+  #
+  def initialize( io = STDOUT, err = STDERR )
+    @io = io
+    @err = err
+    @options = {
+      :skeleton_dir => File.join(mrbones_dir, 'data'),
+      :with_tasks => false,
+      :verbose => false,
+      :name => nil,
+      :output_dir => nil,
+      :action => nil
+    }
+    @options[:skeleton_dir] = ::Bones.path('data') unless test(?d, skeleton_dir)
+  end
+
+  # The output directory where files will be written.
+  #
+  def output_dir
+    options[:output_dir]
+  end
 
-    if bones.update? then bones.update
-    else bones.create end
+  # The directory where the project skeleton is located.
+  #
+  def skeleton_dir
+    options[:skeleton_dir]
+  end
+
+  # The project name from the command line.
+  #
+  def name
+    options[:name]
+  end
+
+  # Returns the project name but converted to be usable as a Ruby class
+  # name.
+  #
+  def classname
+    name.tr('-','_').split('_').map {|x| x.capitalize}.join
+  end
+
+  # Returns +true+ if we are updating an already existing project. Returns
+  # +false+ if we are creating a new project.
+  #
+  def update?
+    test(?e, output_dir) and with_tasks?
+  end
+
+  # Returns +true+ if we are going to copy the Mr Bones tasks into the
+  # destination directory. Normally this will return +false+.
+  #
+  def with_tasks?
+    options[:with_tasks]
+  end
+
+  # Returns +true+ if the user has requested verbose messages.
+  #
+  def verbose?
+    options[:verbose]
   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(mrbones_dir, 'data')
-    self.data = ::Bones.path('data') unless test(?d, data)
-    self.update = false
-    self.verbose = 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.on('-v', '--verbose',
-            'enable verbose output') {self.verbose = true}
+    opts.on('-v', '--verbose', 'enable verbose output') {
+      options[:verbose] = true
+    }
     opts.on('-d', '--directory DIRECTORY', String,
-            'project directory to create',
-            '(defaults to project_name)') {|dir| self.output_dir = dir}
+            'project directory to create', '(defaults to project_name)') {|dir|
+      options[:output_dir] = dir
+    }
     opts.on('-s', '--skeleton NAME', String,
-            'project skeleton to use') do |name|
-        path = File.join(mrbones_dir, name)
+            'project skeleton to use') do |skeleton_name|
+        path = File.join(mrbones_dir, skeleton_name)
         if test(?d, path)
-          self.data = path 
-        elsif test(?d, name)
-          self.data = name
+          options[:skeleton_dir] = path 
+        elsif test(?d, skeleton_name)
+          options[:skeleton_dir] = skeleton_name
         else
-          STDOUT.puts "    unknown skeleton '#{name}'"
+          @io.puts "    unknown skeleton '#{skeleton_name}'"
           exit
         end
       end
+    opts.on('--with-tasks', 'copy rake tasks to the project folder') {
+      options[:with_tasks] = true
+    }
 
     opts.separator ''
-    opts.on('--freeze', 'freeze the project skeleton') {freeze; exit}
-    opts.on('--unfreeze', 'use the standard project skeleton') {unfreeze; exit}
-    opts.on('-i', '--info',
-            'report on the project skeleton being used') do
-      STDOUT.puts "the project skeleton will be copied from"
-      STDOUT.write "    "
-      STDOUT.puts data
-      exit
-    end
+    opts.on('--freeze', 'freeze the project skeleton') {
+      options[:action] = :freeze
+    }
+    opts.on('--unfreeze', 'use the standard project skeleton') {
+      options[:action] = :unfreeze
+    }
+    opts.on('-i', '--info', 'report on the project skeleton being used') {
+      options[:action] = :info
+    }
 
     opts.separator ''
     opts.separator 'common options:'
-
-    opts.on_tail( '-h', '--help', 'show this message' ) do
-      STDOUT.puts opts
+    opts.on_tail( '-h', '--help', 'show this message' ) {
+      @io.puts opts
       exit
-    end
-
-    opts.on_tail( '--version', 'show version' ) do
-      STDOUT.puts "Mr Bones #{::Bones::VERSION}"
+    }
+    opts.on_tail( '--version', 'show version' ) {
+      @io.puts "Mr Bones #{::Bones::VERSION}"
       exit
-    end
+    }
 
     # parse the command line arguments
     opts.parse! args
-    self.name = args.empty? ? nil : args.join('_')
+    options[:name] = args.empty? ? nil : args.join('_')
 
-    if name.nil?
-      STDOUT.puts opts
+    if options[:action].nil? and name.nil?
+      @io.puts opts
       ::Kernel.abort
     end
 
-    self.output_dir = name if output_dir.nil?
+    options[:output_dir] = name if output_dir.nil?
     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 usable as a Ruby class
-  # name.
+  # Run the main application.
   #
-  def classname
-    name.tr('-','_').split('_').map {|x| x.capitalize}.join
+  def run
+    case options[:action]
+    when :freeze
+      freeze
+    when :unfreeze
+      unfreeze
+    when :info
+      @io.puts "the project skeleton will be copied from"
+      @io.write "    "
+      @io.puts skeleton_dir
+    else
+      if update? then update
+      else create end
+    end
   end
 
   # Create a new project from the bones/data project template.
@@ -113,17 +171,18 @@ class Main
 
     begin
       files_to_copy.each {|fn| cp fn}
+      copy_tasks(File.join(output_dir, 'tasks')) if with_tasks?
 
       pwd = File.expand_path(FileUtils.pwd)
       msg = "created '#{name}'"
       msg << " in directory '#{output_dir}'" if name != output_dir
-      STDOUT.puts msg
+      @io.puts msg
 
       if test(?f, File.join(output_dir, 'Rakefile'))
         begin
           FileUtils.cd output_dir
           system "rake manifest:create 2>&1 > #{::Bones::DEV_NULL}"
-          STDOUT.puts "now you need to fix these files"
+          @io.puts "now you need to fix these files"
           system "rake notes"
         ensure
           FileUtils.cd pwd
@@ -144,7 +203,7 @@ class Main
     abort "'#{output_dir}' does not exist" unless test ?e, output_dir
 
     task_dir = File.join(output_dir, 'tasks')
-    abort "no tasks directory found in '#{output_dir}'" unless test ?d, task_dir
+    FileUtils.mkdir_p(task_dir) unless test(?d, task_dir)
 
     archive_dir = File.join(task_dir, 'archive')
     FileUtils.rm_rf archive_dir
@@ -155,14 +214,11 @@ class Main
       FileUtils.cp fn, archive_dir
     end
 
-    files_to_copy.each do |fn|
-      next unless %r/^tasks\// =~ fn
-      cp fn
-    end
+    copy_tasks(task_dir)
 
     msg = "updated tasks for '#{name}'"
     msg << " in directory '#{output_dir}'" if name != output_dir
-    STDOUT.puts msg
+    @io.puts msg
   end
 
   # Freeze the project skeleton to the current Mr Bones gem. If the project
@@ -173,41 +229,28 @@ class Main
   # Bones skeleton will be copied to the user's data directory.
   #
   def freeze
-    self.data = ::Bones.path('data')
-    data_dir = File.join(mrbones_dir, 'data')
-    archive_dir = File.join(mrbones_dir, 'archive')
-    tasks_only = false
-
-    if test(?d, data_dir)
-      STDOUT.puts "archiving #{data_dir}" if verbose
-      FileUtils.rm_rf(archive_dir)
-      FileUtils.mkdir(archive_dir)
-      FileUtils.cp_r(File.join(data_dir, '.'), archive_dir)
-      tasks_only = true
-    else
-      FileUtils.mkdir_p(data_dir)
-    end
+    options[:skeleton_dir] = ::Bones.path('data')
+    options[:name]         = 'data' if name.nil?
+    options[:output_dir]   = File.join(mrbones_dir, name)
 
-    files_to_copy.each do |file|
-      next if tasks_only && !(%r/^tasks\// =~ file)
+    archive(output_dir, "#{output_dir}.archive")
+    FileUtils.mkdir_p(output_dir)
 
-      src = File.join(data, file)
-      dst = File.join(data_dir, file)
+    files_to_copy.each do |file|
+      src = File.join(skeleton_dir, file)
+      dst = File.join(output_dir, file)
 
-      STDOUT.puts "freezing #{dst}" if verbose
+      @io.puts "freezing #{dst}" if verbose?
       FileUtils.mkdir_p(File.dirname(dst))
       FileUtils.cp(src, dst)
     end
 
+    copy_tasks(File.join(output_dir, 'tasks'), 'freezing') if with_tasks?
+
     File.open(frozen_version_file, 'w') {|fd| fd.puts ::Bones::VERSION}
 
-    if tasks_only
-      STDOUT.puts "project skeleton tasks have been updated " <<
-                  "from Mr Bones #{::Bones::VERSION}"
-    else
-      STDOUT.puts "project skeleton has been frozen " <<
+    @io.puts "project skeleton has been frozen " <<
                   "to Mr Bones #{::Bones::VERSION}"
-    end
   end
 
   # Unfreeze the project skeleton. The default Mr Bones skeleton will be
@@ -215,20 +258,14 @@ class Main
   # one exists.
   #
   def unfreeze
-    data_dir = File.join(mrbones_dir, 'data')
-    archive_dir = File.join(mrbones_dir, 'archive')
-
-    if test(?d, data_dir)
-      STDOUT.puts "archiving #{data_dir}" if verbose
-      FileUtils.rm_rf(archive_dir)
-      FileUtils.mkdir(archive_dir)
-      FileUtils.cp_r(File.join(data_dir, '.'), archive_dir)
-      FileUtils.rm_rf(data_dir)
-
-      STDOUT.puts "project skeleton has been unfrozen"
-      STDOUT.puts "(default Mr Bones #{::Bones::VERSION} sekeleton will be used)"
+    options[:name]       = 'data' if name.nil?
+    options[:output_dir] = File.join(mrbones_dir, name)
+
+    if archive(output_dir, "#{output_dir}.archive")
+      @io.puts "project skeleton has been unfrozen"
+      @io.puts "(default Mr Bones #{::Bones::VERSION} skeleton will be used)"
     else
-      STDOUT.puts "project skeleton is not frozen (no action taken)"
+      @io.puts "project skeleton is not frozen (no action taken)"
     end
     FileUtils.rm_f frozen_version_file
   end
@@ -237,10 +274,10 @@ class Main
   # the new project directory
   #
   def files_to_copy
-    rgxp = %r/\A#{data}\/?/o
+    rgxp = %r/\A#{skeleton_dir}\/?/o
     exclude = %r/tmp$|bak$|~$|CVS|\.svn/o
 
-    ary = Dir.glob(File.join(data, '**', '*')).map do |filename|
+    ary = Dir.glob(File.join(skeleton_dir, '**', '*')).map do |filename|
       next if exclude =~ filename
       next if test(?d, filename)
       filename.sub rgxp, ''
@@ -251,9 +288,6 @@ class Main
     ary
   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 that the file is being created.
@@ -262,9 +296,9 @@ class Main
     dir = File.dirname(file).sub('NAME', name)
     dir = (dir == '.' ? output_dir : File.join(output_dir, dir))
     dst = File.join(dir,  File.basename(file, '.erb').sub('NAME', name))
-    src = File.join(data, file)
+    src = File.join(skeleton_dir, file)
 
-    STDOUT.puts(test(?e, dst) ? "updating #{dst}" : "creating #{dst}") if verbose
+    @io.puts(test(?e, dst) ? "updating #{dst}" : "creating #{dst}") if verbose?
     FileUtils.mkdir_p(dir)
 
     if '.erb' == File.extname(file)
@@ -277,10 +311,50 @@ class Main
     FileUtils.chmod(File.stat(src).mode, dst)
   end
 
+  # Archive the contents of the _from_ directory into the _to_ directory.
+  # The _to_ directory will be deleted if it currently exists. After the
+  # copy the _from_ directory will be deleted.
+  #
+  # Returns +true+ if the directory was archived. Returns +false+ if the
+  # directory was not archived.
+  #
+  def archive( from, to )
+    if test(?d, from)
+      @io.puts "archiving #{from}" if verbose?
+      FileUtils.rm_rf(to)
+      FileUtils.mkdir(to)
+      FileUtils.cp_r(File.join(from, '.'), to)
+      FileUtils.rm_rf(from)
+      true
+    else
+      false
+    end
+  end
+
+  # Copy the Mr Bones tasks into the _to_ directory. If we are in verbose
+  # mode, then a message will be displayed to the user. This message can be
+  # passed in as the _msg_ argument. The current file being copied is
+  # appened to the end of the message.
+  #
+  def copy_tasks( to, msg = nil )
+    Dir.glob(::Bones.path(%w[lib bones tasks *])).sort.each do |src|
+      dst = File.join(to, File.basename(src))
+
+      if msg
+        @io.puts "#{msg} #{dst}" if verbose?
+      else
+        @io.puts(test(?e, dst) ? "updating #{dst}" : "creating #{dst}") if verbose?
+      end
+
+      FileUtils.mkdir_p(File.dirname(dst))
+      FileUtils.cp(src, dst)
+    end
+  end
+
   # Prints an abort _msg_ to the screen and then exits the Ruby interpreter.
   #
   def abort( msg )
-    STDERR.puts msg
+    @err.puts msg
     exit 1
   end