bones 1.3.5 → 2.0.0

data/data/tasks/svn.rake

@@ -1,32 +1,36 @@
 # $Id$
 
+if HAVE_SVN
 
-if PROJ.svn and system("svn --version 2>&1 > #{DEV_NULL}")
-
-unless PROJ.svn_root
+unless PROJ.svn.root
   info = %x/svn info ./
   m = %r/^Repository Root:\s+(.*)$/.match(info)
-  PROJ.svn_root = (m.nil? ? '' : m[1])
+  PROJ.svn.root = (m.nil? ? '' : m[1])
 end
-PROJ.svn_root = File.join(PROJ.svn_root, PROJ.svn) if String === PROJ.svn
+PROJ.svn.root = File.join(PROJ.svn.root, PROJ.svn.path) unless PROJ.svn.path.empty?
 
 namespace :svn do
 
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
   desc 'Show tags from the SVN repository'
-  task :show_tags do |t|
-    tags = %x/svn list #{File.join(PROJ.svn_root, PROJ.svn_tags)}/
+  task :show_tags => 'svn:prereqs' do |t|
+    tags = %x/svn list #{File.join(PROJ.svn.root, PROJ.svn.tags)}/
     tags.gsub!(%r/\/$/, '')
+    tags = tags.split("\n").sort {|a,b| b <=> a}
     puts tags
   end
 
   desc 'Create a new tag in the SVN repository'
-  task :create_tag do |t|
+  task :create_tag => 'svn: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
 
-    trunk = File.join(PROJ.svn_root, PROJ.svn_trunk)
+    svn = PROJ.svn
+    trunk = File.join(svn.root, svn.trunk)
     tag = "%s-%s" % [PROJ.name, PROJ.version]
-    tag = File.join(PROJ.svn_root, PROJ.svn_tags, tag)
+    tag = File.join(svn.root, svn.tags, tag)
     msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
 
     puts "Creating SVN tag '#{tag}'"
@@ -39,6 +43,6 @@ end  # namespace :svn
 
 task 'gem:release' => 'svn:create_tag'
 
-end  # if PROJ.svn
+end  # if PROJ.svn.path
 
 # EOF

data/data/tasks/test.rake

@@ -6,19 +6,19 @@ 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.test_files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+                   else PROJ.test.files end
     t.ruby_opts += PROJ.ruby_opts
-    t.ruby_opts += PROJ.test_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.dup << '-o' << PROJ.rcov_dir
+      opts = PROJ.rcov.opts.dup << '-o' << PROJ.rcov.dir
       opts = opts.join(' ')
-      files = if test(?f, PROJ.test_file) then [PROJ.test_file]
-              else PROJ.tests end
+      files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+              else PROJ.test.files end
       files = files.join(' ')
       sh "#{RCOV} #{files} #{opts}"
     end

data/lib/bones.rb

@@ -1,14 +1,22 @@
-# $Id: bones.rb 558 2008-02-27 19:46:32Z tim_pease $
+# $Id: bones.rb 571 2008-03-12 04:30:45Z tim_pease $
 
 module Bones
 
   # :stopdoc:
-  VERSION = '1.3.5'
+  VERSION = '2.0.0'
   PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
   WIN32 = %r/win32/ =~ RUBY_PLATFORM
   DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
   # :startdoc:
 
+  # Returns the path for Mr Bones. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : File.join(PATH, *args)
+  end
+
   # call-seq:
   #    Bones.require_all_libs_relative_to( filename, directory = nil )
   #

data/lib/bones/annotation_extractor.rb

@@ -1,4 +1,11 @@
-# $Id: annotation_extractor.rb 431 2007-12-31 21:24:37Z tim_pease $
+# $Id: annotation_extractor.rb 588 2008-04-07 20:43:07Z tim_pease $
+
+begin
+  require 'facets/ansicode'
+  HAVE_COLOR = true
+rescue LoadError
+  HAVE_COLOR = false
+end
 
 module Bones
 
@@ -23,20 +30,26 @@ class AnnotationExtractor
   # will search for all athe annotations and display them on standard
   # output.
   #
-  def self.enumerate( project, tag, opts = {} )
-    extractor = new(project, tag)
+  def self.enumerate( project, tag, id = nil, opts = {} )
+    extractor = new(project, tag, id)
     extractor.display(extractor.find, opts)
   end
 
-  attr_reader :tag, :project
+  attr_reader :tag, :project, :id
 
   # Creates a new annotation extractor configured to use the _project_ open
   # strcut and to search for the given _tag_ (which can be more than one tag
   # via a regular expression 'or' operation -- i.e. THIS|THAT|OTHER)
   #
-  def initialize( project, tag )
+  def initialize( project, tag, id) 
     @project = project
     @tag = tag
+    @id = @id_rgxp = nil
+
+    unless id.nil? or id.empty?
+      @id = id
+      @id_rgxp = Regexp.new(Regexp.escape(id), Regexp::IGNORECASE)
+    end
   end
 
   # Iterate over all the files in the project manifest and extract
@@ -46,11 +59,12 @@ class AnnotationExtractor
   def find
     results = {}
     rgxp = %r/(#{tag}):?\s*(.*?)(?:\s*(?:-?%>|\*+\/))?$/o
-    extensions = project.annotation_extensions.dup
-    exclude = if project.annotation_exclude.empty? then nil
-              else Regexp.new(project.annotation_exclude.join('|')) end
 
-    project.files.each do |fn|
+    extensions = project.notes.extensions.dup
+    exclude = if project.notes.exclude.empty? then nil
+              else Regexp.new(project.notes.exclude.join('|')) end
+
+    project.gem.files.each do |fn|
       next if exclude && exclude =~ fn
       next unless extensions.include? File.extname(fn)
       results.update(extract_annotations_from(fn, rgxp))
@@ -66,8 +80,15 @@ class AnnotationExtractor
     lineno = 0
     result = File.readlines(file).inject([]) do |list, line|
       lineno += 1
-      next list unless line =~ pattern
-      list << Annotation.new(lineno, $1, $2)
+      next list unless m = pattern.match(line)
+      next list << Annotation.new(lineno, m[1], m[2]) unless id
+
+      text = m[2]
+      if text =~ @id_rgxp
+        text.gsub!(@id_rgxp) {|str| Console::ANSICode.green(str)} if HAVE_COLOR
+        list << Annotation.new(lineno, m[1], text)
+      end
+      list
     end
     result.empty? ? {} : { file => result }
   end

data/lib/bones/debug.rb

@@ -0,0 +1,72 @@
+# $Id: debug.rb 579 2008-03-19 18:53:22Z tim_pease $
+
+require 'pp'
+require 'stringio'
+
+module Bones
+
+# Helper module that will pretty print OpenStruct objects. It is used mainly
+# for debugging the Mr Bones project open struct.
+#
+module Debug
+
+  # :stopdoc:
+  KEY_LENGTH = 20
+  VAR_LENGTH = 78 - 6 - KEY_LENGTH
+  SEP = "\n" + ' '*(KEY_LENGTH+6)
+  FMT = "  %-#{KEY_LENGTH}s => %s"
+  # :startdoc:
+
+  # Print all the keys for the given _ostruct_ to stdout. If a _prefix_ is
+  # given, then the open struct keys will be prefixed with this string.
+  #
+  def self.show( ostruct, prefix = '' )
+    sio = StringIO.new
+
+    h = ostruct.instance_variable_get(:@table)
+    h.keys.map {|k| k.to_s}.sort.each do |k|
+      sio.truncate 0
+      next if k =~ %r/^_/o
+
+      val = h[k.to_sym]
+      if val.instance_of?(OpenStruct)
+        self.show(val, prefix + k + '.')
+      else
+        PP.pp(val, sio, VAR_LENGTH)
+        sio.seek 0
+        val = sio.read
+        val = val.split("\n").join(SEP)
+
+        key = prefix + k
+        key[(KEY_LENGTH-3)..-1] = '...' if key.length > KEY_LENGTH
+        puts(FMT % [key, val])
+      end
+    end
+  end
+
+  # Print a single attribute from the given _ostruct_ to stdout. The
+  # attributed is identified by the given _key_.
+  #
+  def self.show_attr( ostruct, key )
+    sio = StringIO.new
+
+    key = key.dup if key.frozen?
+    val = key.split('.').inject(ostruct) {|os,k| os.send(k)}
+
+    if val.instance_of?(OpenStruct)
+      self.show(val, key + '.')
+    else
+      PP.pp(val, sio, VAR_LENGTH)
+      sio.seek 0
+      val = sio.read
+      val = val.split("\n").join(SEP)
+
+      key[(KEY_LENGTH-3)..-1] = '...' if key.length > KEY_LENGTH
+      puts(FMT % [key, val])
+    end
+  end
+
+end  # module Debug
+end  # module Bones
+
+# EOF

data/lib/bones/main.rb

@@ -1,4 +1,4 @@
-# $Id: main.rb 561 2008-02-27 23:28:19Z tim_pease $
+# $Id: main.rb 579 2008-03-19 18:53:22Z tim_pease $
 
 require 'fileutils'
 require 'optparse'
@@ -26,7 +26,7 @@ class Main
   #
   def parse( args )
     self.data = File.join(mrbones_dir, 'data')
-    self.data = File.join(::Bones::PATH, 'data') unless test(?d, data)
+    self.data = ::Bones.path('data') unless test(?d, data)
     self.update = false
     self.verbose = false
 
@@ -41,6 +41,18 @@ class Main
     opts.on('-d', '--directory DIRECTORY', String,
             'project directory to create',
             '(defaults to project_name)') {|dir| self.output_dir = dir}
+    opts.on('-s', '--skeleton NAME', String,
+            'project skeleton to use') do |name|
+        path = File.join(mrbones_dir, name)
+        if test(?d, path)
+          self.data = path 
+        elsif test(?d, name)
+          self.data = name
+        else
+          STDOUT.puts "    unknown skeleton '#{name}'"
+          exit
+        end
+      end
 
     opts.separator ''
     opts.on('--freeze', 'freeze the project skeleton') {freeze; exit}
@@ -56,9 +68,13 @@ class Main
     opts.separator ''
     opts.separator 'common options:'
 
-    opts.on_tail( '-h', '--help', 'show this message' ) {puts opts; exit}
+    opts.on_tail( '-h', '--help', 'show this message' ) do
+      STDOUT.puts opts
+      exit
+    end
+
     opts.on_tail( '--version', 'show version' ) do
-      puts "Mr Bones #{::Bones::VERSION}"
+      STDOUT.puts "Mr Bones #{::Bones::VERSION}"
       exit
     end
 
@@ -67,7 +83,7 @@ class Main
     self.name = args.empty? ? nil : args.join('_')
 
     if name.nil?
-      puts opts
+      STDOUT.puts opts
       ::Kernel.abort
     end
 
@@ -154,7 +170,7 @@ class Main
   # Bones skeleton will be copied to the user's data directory.
   #
   def freeze
-    self.data = File.join(::Bones::PATH, 'data')
+    self.data = ::Bones.path('data')
     data_dir = File.join(mrbones_dir, 'data')
     archive_dir = File.join(mrbones_dir, 'archive')
     tasks_only = false
@@ -214,6 +230,24 @@ class Main
     FileUtils.rm_f frozen_version_file
   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
+
 
   private
 
@@ -227,7 +261,7 @@ class Main
     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
+    STDOUT.puts(test(?e, dst) ? "updating #{dst}" : "creating #{dst}") if verbose
     FileUtils.mkdir_p(dir)
 
     if '.erb' == File.extname(file)
@@ -247,24 +281,6 @@ class Main
     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
-
   # Returns the .bones resource directory in the user's home directory.
   #
   def mrbones_dir

data/tasks/ann.rake

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: ann.rake 585 2008-04-07 20:15:39Z tim_pease $
 
 begin
   require 'bones/smtp_tls'
@@ -9,12 +9,16 @@ require 'time'
 
 namespace :ann do
 
-  file PROJ.ann_file do
-    puts "Generating #{PROJ.ann_file}"
-    File.open(PROJ.ann_file,'w') do |fd|
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  file PROJ.ann.file do
+    ann = PROJ.ann
+    puts "Generating #{ann.file}"
+    File.open(ann.file,'w') do |fd|
       fd.puts("#{PROJ.name} version #{PROJ.version}")
       fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
-      fd.puts("    #{PROJ.url}") if PROJ.url
+      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
       fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
       fd.puts
       fd.puts("== DESCRIPTION")
@@ -23,23 +27,24 @@ namespace :ann do
       fd.puts
       fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
       fd.puts
-      PROJ.ann_paragraphs.each do |p|
+      ann.paragraphs.each do |p|
         fd.puts "== #{p.upcase}"
         fd.puts
         fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
         fd.puts
       end
-      fd.puts PROJ.ann_text if PROJ.ann_text
+      fd.puts ann.text if ann.text
     end
   end
 
   desc "Create an announcement file"
-  task :announcement => PROJ.ann_file
+  task :announcement => ['ann:prereqs', PROJ.ann.file]
 
   desc "Send an email announcement"
-  task :email => PROJ.ann_file do
-    from = PROJ.ann_email[:from] || PROJ.email
-    to   = Array(PROJ.ann_email[:to])
+  task :email => ['ann:prereqs', PROJ.ann.file] do
+    ann = PROJ.ann
+    from = ann.email[:from] || PROJ.email
+    to   = Array(ann.email[:to])
 
     ### build a mail header for RFC 822
     rfc822msg =  "From: #{from}\n"
@@ -49,11 +54,11 @@ namespace :ann do
     rfc822msg << "\n"
     rfc822msg << "Date: #{Time.new.rfc822}\n"
     rfc822msg << "Message-Id: "
-    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{PROJ.ann_email[:domain]}>\n\n"
-    rfc822msg << File.read(PROJ.ann_file)
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+    rfc822msg << File.read(ann.file)
 
     params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
-      PROJ.ann_email[key]
+      ann.email[key]
     end
 
     params[3] = PROJ.email if params[3].nil?
@@ -71,6 +76,6 @@ end  # namespace :ann
 desc 'Alias to ann:announcement'
 task :ann => 'ann:announcement'
 
-CLOBBER << PROJ.ann_file
+CLOBBER << PROJ.ann.file
 
 # EOF