bones 1.0.0 → 1.1.0

data/History.txt

@@ -1,3 +1,10 @@
+== 1.1.0 / 2007-12-29
+
+* 3 minor enhancements
+  * Output message when files are created or updated
+  * Directory cleanup if project creation fails
+  * Pulled the rails source annotation extractor into Mr Bones
+
 == 1.0.0 / 2007-12-28
 
 * 1 major enhancement

data/Manifest.txt

@@ -20,6 +20,8 @@ data/tasks/spec.rake
 data/tasks/test.rake
 data/test/test_NAME.rb
 lib/bones.rb
+lib/bones/annotation_extractor.rb
+lib/bones/main.rb
 tasks/annotations.rake
 tasks/doc.rake
 tasks/gem.rake

data/README.txt

@@ -66,7 +66,6 @@ following gems installed you will not get all that Mr Bones has to offer.
 * rubyforge - for easy gem publishing to rubyforge.org
 * rcov - for code coverage testing
 * rspec - if that's the way you roll
-* rails - for source annotation extractor (notes)
 
 == INSTALL:
 
@@ -132,6 +131,13 @@ most current version number for the installed gem is used.
   depend_on 'logging'
   depend_on 'rake', '0.7.3'
 
+== ACKNOWLEDGEMENTS:
+
+Ryan Davis and Eric Hodel and their Hoe gem (from which much of the Mr Bones
+rake tasks have been stolen). The rails team and their source annotation
+extractor. Bruce Williams for help in coming up with the project name. Ara
+T. Howard for letting me squat in the codeforpeople rubyforge project.
+
 == LICENSE:
 
 MIT License

data/Rakefile

@@ -12,7 +12,7 @@ PROJ.summary = 'Mr Bones is a handy tool that builds a skeleton for your new Rub
 PROJ.authors = 'Tim Pease'
 PROJ.email = 'tim.pease@gmail.com'
 PROJ.url = 'http://codeforpeople.rubyforge.org/bones'
-PROJ.description = paragraphs_of('README.txt', 3).join("\n\n")
+PROJ.description = paragraphs_of('README.txt', 1).join("\n\n")
 PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
 PROJ.rubyforge_name = 'codeforpeople'
 PROJ.rdoc_remote_dir = 'bones'

data/data/README.txt.erb

@@ -1,32 +1,32 @@
 <%= name %>
-    by FIX (your name)
-    FIX (url)
+    by FIXME (your name)
+    FIXME (url)
 
 == DESCRIPTION:
   
-FIX (describe your package)
+FIXME (describe your package)
 
 == FEATURES/PROBLEMS:
   
-* FIX (list of features or problems)
+* FIXME (list of features or problems)
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+  FIXME (code sample of usage)
 
 == REQUIREMENTS:
 
-* FIX (list of requirements)
+* FIXME (list of requirements)
 
 == INSTALL:
 
-* FIX (sudo gem install, anything else)
+* FIXME (sudo gem install, anything else)
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2007 FIX
+Copyright (c) 2007 FIXME (different license?)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/data/Rakefile.erb

@@ -10,11 +10,11 @@ require '<%= name %>'
 task :default => 'spec:run'
 
 PROJ.name = '<%= name %>'
-PROJ.summary = 'FIX'
-PROJ.authors = 'FIX'
-PROJ.email = 'FIX'
-PROJ.url = 'FIX'
-PROJ.description = paragraphs_of('README.txt', 3).join("\n\n")
+PROJ.summary = 'FIXME (summary of your project)'
+PROJ.authors = 'FIXME (who is writing this software)'
+PROJ.email = 'FIXME (your e-mail)'
+PROJ.url = 'FIXME (project homepage)'
+PROJ.description = paragraphs_of('README.txt', 1).join("\n\n")
 PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
 PROJ.rubyforge_name = '<%= name %>'
 

data/data/tasks/annotations.rake

@@ -1,29 +1,29 @@
 # $Id$
 
-if HAVE_SOURCE_ANNOTATION_EXTRACTOR
+if HAVE_BONES
 
 desc "Enumerate all annotations"
 task :notes do
-  SourceAnnotationExtractor.enumerate "OPTIMIZE|FIXME|TODO", :tag => true
+  Bones::AnnotationExtractor.enumerate "OPTIMIZE|FIXME|TODO", :tag => true
 end
 
 namespace :notes do
   desc "Enumerate all OPTIMIZE annotations"
   task :optimize do
-    SourceAnnotationExtractor.enumerate "OPTIMIZE"
+    Bones::AnnotationExtractor.enumerate "OPTIMIZE"
   end
 
   desc "Enumerate all FIXME annotations"
   task :fixme do
-    SourceAnnotationExtractor.enumerate "FIXME"
+    Bones::AnnotationExtractor.enumerate "FIXME"
   end
 
   desc "Enumerate all TODO annotations"
   task :todo do
-    SourceAnnotationExtractor.enumerate "TODO"
+    Bones::AnnotationExtractor.enumerate "TODO"
   end
 end
 
-end  # if HAVE_SOURCE_ANNOTATION_EXTRACTOR
+end  # if HAVE_BONES
 
 # EOF

data/data/tasks/setup.rb

@@ -89,7 +89,7 @@ SUDO = if WIN32 then ''
 RCOV = WIN32 ? 'rcov.cmd'  : 'rcov'
 GEM  = WIN32 ? 'gem.cmd'   : 'gem'
 
-%w(rcov spec rubyforge source_annotation_extractor).each do |lib|
+%w(rcov spec rubyforge bones).each do |lib|
   begin
     require lib
     Object.instance_eval {const_set "HAVE_#{lib.upcase}", true}

data/lib/bones.rb

@@ -1,177 +1,33 @@
-# $Id: bones.rb 420 2007-12-29 04:45:29Z tim_pease $
-
-require 'fileutils'
-require 'optparse'
-require 'erb'
+# $Id: bones.rb 423 2007-12-29 18:32:34Z tim_pease $
 
 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}
+  # :stopdoc:
+  VERSION = '1.1.0'
+  PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  WIN32 = %r/win32/ =~ RUBY_PLATFORM unless defined? WIN32
+  DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
+  # :startdoc:
+
+  # call-seq:
+  #    Bones.require_all_libs_relative_to( filename, directory = nil )
+  #
+  # Utility method used to rquire all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  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'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
 
-      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
+end  # module Bones
 
-      ary.compact!
-      ary.sort!
-      ary
-    end
 
-  end  # class Main
-end  # module Bones
+Bones.require_all_libs_relative_to __FILE__
 
 # EOF

data/lib/bones/annotation_extractor.rb

@@ -0,0 +1,70 @@
+# $Id: annotation_extractor.rb 423 2007-12-29 18:32:34Z tim_pease $
+
+module Bones
+class AnnotationExtractor
+
+  class Annotation < Struct.new(:line, :tag, :text)
+    def to_s(options={})
+      s = "[%3d] " % line
+      s << "[#{tag}] " if options[:tag]
+      s << text
+    end
+  end
+
+  def self.enumerate(tag, options={})
+    extractor = new(tag)
+    extractor.display(extractor.find, options)
+  end
+
+  attr_reader :tag
+
+  def initialize(tag)
+    @tag = tag
+  end
+
+  def find(dirs=%w(app lib test))
+    dirs.inject({}) { |h, dir| h.update(find_in(dir)) }
+  end
+
+  def find_in(dir)
+    results = {}
+
+    Dir.glob("#{dir}/*") do |item|
+      next if File.basename(item)[0] == ?.
+
+      if File.directory?(item)
+        results.update(find_in(item))
+      elsif item =~ /\.(builder|(r(?:b|xml|js)))$/
+        results.update(extract_annotations_from(item, /#\s*(#{tag}):?\s*(.*)$/))
+      elsif item =~ /\.(rhtml|erb)$/
+        results.update(extract_annotations_from(item, /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/))
+      end
+    end
+
+    results
+  end
+
+  def extract_annotations_from(file, pattern)
+    lineno = 0
+    result = File.readlines(file).inject([]) do |list, line|
+      lineno += 1
+      next list unless line =~ pattern
+      list << Annotation.new(lineno, $1, $2)
+    end
+    result.empty? ? {} : { file => result }
+  end
+
+  def display(results, options={})
+    results.keys.sort.each do |file|
+      puts "#{file}:"
+      results[file].each do |note|
+        puts "  * #{note.to_s(options)}"
+      end
+      puts
+    end
+  end
+
+end  # class AnnotationExtractor
+end  # module Bones
+
+# EOF

data/lib/bones/main.rb

@@ -0,0 +1,187 @@
+# $Id: main.rb 423 2007-12-29 18:32:34Z tim_pease $
+
+require 'fileutils'
+require 'optparse'
+require 'erb'
+
+module Bones
+class Main
+
+  attr_writer :update
+  attr_accessor :name, :data, :verbose
+
+  # 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
+    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.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
+
+  # Create a new project from the bones/data project template.
+  #
+  def create
+    # * 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
+
+    # see if the directory already exists
+    abort "'#{name}' already exists" if test ?e, name
+
+    begin
+      files_to_copy.each {|fn| cp fn}
+
+      pwd = File.expand_path(FileUtils.pwd)
+      begin
+        FileUtils.cd name
+        system "rake manifest:create 2>&1 > #{::Bones::DEV_NULL}"
+      ensure
+        FileUtils.cd pwd
+      end
+    rescue Exception => err
+      FileUtils.rm_rf name
+      abort "could not create '#{name}'"
+    end
+
+    STDOUT.puts "created '#{name}'"
+  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
+
+    STDOUT.puts "updated tasks for '#{name}'"
+  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.dirname(file)
+    dir = (dir == '.' ? name : File.join(name, dir))
+    dst = File.join(dir,  File.basename(file, '.erb').sub('NAME', name))
+    src = File.join(data, file)
+
+    puts (test(?e, dst) ? "updating #{dst}" : "creating #{dst}") if verbose
+    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

data/tasks/annotations.rake

@@ -1,29 +1,29 @@
-# $Id: annotations.rake 419 2007-12-29 04:39:36Z tim_pease $
+# $Id: annotations.rake 423 2007-12-29 18:32:34Z tim_pease $
 
-if HAVE_SOURCE_ANNOTATION_EXTRACTOR
+if HAVE_BONES
 
 desc "Enumerate all annotations"
 task :notes do
-  SourceAnnotationExtractor.enumerate "OPTIMIZE|FIXME|TODO", :tag => true
+  Bones::AnnotationExtractor.enumerate "OPTIMIZE|FIXME|TODO", :tag => true
 end
 
 namespace :notes do
   desc "Enumerate all OPTIMIZE annotations"
   task :optimize do
-    SourceAnnotationExtractor.enumerate "OPTIMIZE"
+    Bones::AnnotationExtractor.enumerate "OPTIMIZE"
   end
 
   desc "Enumerate all FIXME annotations"
   task :fixme do
-    SourceAnnotationExtractor.enumerate "FIXME"
+    Bones::AnnotationExtractor.enumerate "FIXME"
   end
 
   desc "Enumerate all TODO annotations"
   task :todo do
-    SourceAnnotationExtractor.enumerate "TODO"
+    Bones::AnnotationExtractor.enumerate "TODO"
   end
 end
 
-end  # if HAVE_SOURCE_ANNOTATION_EXTRACTOR
+end  # if HAVE_BONES
 
 # EOF

data/tasks/setup.rb

@@ -1,4 +1,4 @@
-# $Id: setup.rb 419 2007-12-29 04:39:36Z tim_pease $
+# $Id: setup.rb 423 2007-12-29 18:32:34Z tim_pease $
 
 require 'rubygems'
 require 'rake'
@@ -89,7 +89,7 @@ SUDO = if WIN32 then ''
 RCOV = WIN32 ? 'rcov.cmd'  : 'rcov'
 GEM  = WIN32 ? 'gem.cmd'   : 'gem'
 
-%w(rcov spec rubyforge source_annotation_extractor).each do |lib|
+%w(rcov spec rubyforge bones).each do |lib|
   begin
     require lib
     Object.instance_eval {const_set "HAVE_#{lib.upcase}", true}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bones
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2007-12-28 00:00:00 -07:00
+date: 2007-12-29 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: "Mr Bones provides the following rake tasks:"
+description: "== DESCRIPTION:  Mr Bones is a handy tool that builds a skeleton for your new Ruby projects. The skeleton contains some starter code and a collection of rake tasks to ease the management and deployment of your source code. Mr Bones is not viral -- all the code your project needs is included in the skeleton (no gem dependency required)."
 email: tim.pease@gmail.com
 executables: 
 - bones
@@ -46,6 +46,8 @@ files:
 - data/tasks/test.rake
 - data/test/test_NAME.rb
 - lib/bones.rb
+- lib/bones/annotation_extractor.rb
+- lib/bones/main.rb
 - tasks/annotations.rake
 - tasks/doc.rake
 - tasks/gem.rake