bones 1.3.5 → 2.0.0

data/History.txt

@@ -1,4 +1,25 @@
-== 1.3.5 / 2008-02
+== 2.0.0 / 2008-03-
+
+* 2 major enhancements
+  - Reworked the PROJ open struct to use nested open struct
+    objects
+  - Renamed a few of the .rake files to match the namespaces
+    they define
+* 4 minor enhancements
+  - Selectable project skeleton when creating a new project
+  - Added an empty 'prereqs' task to several of the namespaces
+      (can be used for running code before any of the
+       tasks in that namespace are invoked)
+  - Extra refinement on notes
+      rake notes TwP       #=> all notes for TwP
+      rake notes:todo TwP  #=> all todos for TwP
+  - Insalling a gem will no longer try to update the gem
+    sources from RubyForge
+* 1 bug fix
+  - On some systems, the quiet method was not reopening
+    stdout and stderr correctly
+
+== 1.3.5 / 2008-02-27
 
 * 2 minor enhancements
   - Added a bones:debug task to inspect the PROJ open struct or

data/Manifest.txt

@@ -12,12 +12,12 @@ data/lib/NAME.rb.erb
 data/spec/NAME_spec.rb.erb
 data/spec/spec_helper.rb.erb
 data/tasks/ann.rake
-data/tasks/annotations.rake
 data/tasks/bones.rake
-data/tasks/doc.rake
 data/tasks/gem.rake
 data/tasks/manifest.rake
+data/tasks/notes.rake
 data/tasks/post_load.rake
+data/tasks/rdoc.rake
 data/tasks/rubyforge.rake
 data/tasks/setup.rb
 data/tasks/spec.rake
@@ -26,15 +26,16 @@ data/tasks/test.rake
 data/test/test_NAME.rb
 lib/bones.rb
 lib/bones/annotation_extractor.rb
+lib/bones/debug.rb
 lib/bones/main.rb
 lib/bones/smtp_tls.rb
 tasks/ann.rake
-tasks/annotations.rake
 tasks/bones.rake
-tasks/doc.rake
 tasks/gem.rake
 tasks/manifest.rake
+tasks/notes.rake
 tasks/post_load.rake
+tasks/rdoc.rake
 tasks/rubyforge.rake
 tasks/setup.rb
 tasks/spec.rake

data/README.txt

@@ -10,7 +10,75 @@ 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).
 
-== FEATURES/PROBLEMS:
+== VERSION 2.0.0 CHANGES:
+
+Version 2.0.0 of Mr Bones introduces backwards incompatibilities. Here is
+what you need to update in order for your current projects to work with
+this latest release.
+
+Perform an update the tasks in your project directory:
+
+  bones -u your/project/directory
+
+The following .rake files have been renamed in Mr Bones 2.0.0 (the old
+name is on the left and the new name is on the right). You will need to
+delete the old version and use only the new version.
+
+  doc.rake          => rdoc.rake
+  annotations.rake  => notes.rake
+
+The PROJ openstruct has been amended to contain a collection of nested
+openstructs. This will affect any settings you might have in the
+top-level Rakefile for your project. Here is the translation key (old
+names on the left and new names on the right).
+
+  rubyforge_name        => rubyforge.name
+
+  specs                 => spec.files
+  spec_opts             => spec.opts
+
+  tests                 => test.files
+  test_file             => test.file
+  test_opts             => test.opts
+
+  rcov_dir              => rcov.dir
+  rcov_opts             => rcov.opts
+  rcov_threshold        => rcov.threshold
+  rcov_threshold_exact  => rcov.threshold_exact
+
+  rdoc_opts             => rdoc.opts
+  rdoc_include          => rdoc.include
+  rdoc_exclude          => rdoc.exclude
+  rdoc_main             => rdoc.main
+  rdoc_dir              => rdoc.dir
+  rdoc_remote_dir       => rdoc.remote_dir
+
+  dependencies          => gem.dependencies
+  executables           => gem.executables
+  extensions            => gem.extensions
+  files                 => gem.files
+  need_tar              => gem.need_tar
+  need_zip              => gem.need_zip
+  post_install_message  => gem.extras['post_install_message']
+
+  annotation_exclude    => notes.exclude
+  annotation_extensions => notes.extensions
+  annotation_tags       => notes.tags      
+
+  svn                   => svn.path
+  svn_root              => svn.root
+  svn_trunk             => svn.trunk
+  svn_tags              => svn.tags
+  svn_branches          => svn.branches
+
+  ann_file              => ann.file
+  ann_text              => ann.text
+  ann_paragraphs        => ann.paragraphs
+  ann_email             => ann.email     
+
+And of course, each name should be prepended with PROJ in your Rakefile.
+
+== FEATURES:
 
 Mr Bones provides the following rake tasks:
 
@@ -101,13 +169,15 @@ the Rakefile for the Mr Bones gem itself:
   PROJ.authors = 'Tim Pease'
   PROJ.email = 'not.real@fake.com'
   PROJ.url = 'http://codeforpeople.rubyforge.org/bones'
-  PROJ.rubyforge_name = 'codeforpeople'
-  PROJ.rdoc_remote_dir = 'bones'
   PROJ.version = Bones::VERSION
+  PROJ.rubyforge.name = 'codeforpeople'
+
+  PROJ.rdoc.remote_dir = 'bones'
+  PROJ.rdoc.exclude << '^data'
+
+  PROJ.notes.exclude = %w(^README\.txt$ ^data/)
 
-  PROJ.rdoc_exclude << '^data'
-  PROJ.annotation_exclude = %w(^README\.txt$ ^data/)
-  PROJ.svn = 'bones'
+  PROJ.svn.path = 'bones'
 
   PROJ.spec_opts << '--color'
 

data/Rakefile

@@ -1,4 +1,4 @@
-# $Id: Rakefile 562 2008-02-28 04:36:33Z tim_pease $
+# $Id: Rakefile 587 2008-04-07 20:28:43Z tim_pease $
 
 $:.unshift('lib')
 
@@ -9,44 +9,48 @@ PROJ.name = 'bones'
 PROJ.authors = 'Tim Pease'
 PROJ.email = 'tim.pease@gmail.com'
 PROJ.url = 'http://codeforpeople.rubyforge.org/bones'
-PROJ.rubyforge_name = 'codeforpeople'
-PROJ.rdoc_remote_dir = 'bones'
 PROJ.version = Bones::VERSION
-PROJ.release_name = 'Skeletor'
+PROJ.release_name = 'Pygmy Orchestra'
 
-PROJ.rdoc_exclude << '^data/'
-PROJ.annotation_exclude = %w(^README\.txt$ ^data/ ^tasks/setup.rb$)
-PROJ.svn = 'bones'
+PROJ.rubyforge.name = 'codeforpeople'
 
-PROJ.spec_opts << '--color'
+PROJ.rdoc.remote_dir = 'bones'
+PROJ.rdoc.exclude << '^data/'
+PROJ.notes.exclude = %w(^README\.txt$ ^data/ ^tasks/setup.rb$)
+PROJ.svn.path = 'bones'
 
-PROJ.ann_email[:server] = 'smtp.gmail.com'
-PROJ.ann_email[:port] = 587
+PROJ.spec.opts << '--color'
 
-PROJ.post_install_message = <<-MSG
+PROJ.ann.email[:server] = 'smtp.gmail.com'
+PROJ.ann.email[:port] = 587
+
+PROJ.gem.extras[:required_rubygems_version] = '>= 1.1.0'
+PROJ.gem.extras[:post_install_message] = <<-MSG
 --------------------------
  Keep rattlin' dem bones!
 --------------------------
 MSG
 
-PROJ.ann_paragraphs = %w[install synopsis features requirements]
-PROJ.ann_text = <<-ANN
+PROJ.ann.paragraphs = %w[install synopsis].unshift('version 2.0.0 changes')
+#PROJ.ann.paragraphs = %w[install synopsis features requirements].unshift('version 2.0.0 changes')
+PROJ.ann.text = <<-ANN
 == FUN FACT
 
-90% of New York City cab drivers are recently arrived immigrants.
+The number of left-handed men is double that of left-handed women.
 
 == POST SCRIPT
 
 Blessings,
 TwP
 
-#{PROJ.post_install_message}
+#{PROJ.gem.extras[:post_install_message]}
 ANN
 
 task :default => 'spec:run'
 task 'gem:package' => 'manifest:assert'
-task(:titlize) {PROJ.name = 'Mr Bones'}
-task 'ann:announcement' => :titlize
+task 'ann:prereqs' do
+  PROJ.name = 'Mr Bones'
+end
 
 depend_on 'rake'
 

data/data/Rakefile.erb

@@ -13,8 +13,8 @@ PROJ.name = '<%= name %>'
 PROJ.authors = 'FIXME (who is writing this software)'
 PROJ.email = 'FIXME (your e-mail)'
 PROJ.url = 'FIXME (project homepage)'
-PROJ.rubyforge_name = '<%= name %>'
+PROJ.rubyforge.name = '<%= name %>'
 
-PROJ.spec_opts << '--color'
+PROJ.spec.opts << '--color'
 
 # EOF

data/data/tasks/ann.rake

@@ -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

data/data/tasks/bones.rake

@@ -1,7 +1,6 @@
 # $Id$
 
-require 'pp'
-require 'stringio'
+if HAVE_BONES
 
 namespace :bones do
 
@@ -10,31 +9,13 @@ namespace :bones do
     atr = if ARGV.length == 2
       t.application.top_level_tasks.pop
     end
-    sio = StringIO.new
-    sep = "\n" + ' '*27
-    fmt = "%23s => %s"
 
-    if atr
-      PP.pp(PROJ.send(atr.to_sym), sio, 49)
-      sio.seek 0
-      val = sio.read
-      val = val.split("\n").join(sep)
-
-      puts fmt % [atr, val]
-    else
-      h = PROJ.instance_variable_get(:@table)
-      h.keys.map {|k| k.to_s}.sort.each do |k|
-        sio.truncate 0
-        PP.pp(h[k.to_sym], sio, 49)
-        sio.seek 0
-        val = sio.read
-        val = val.split("\n").join(sep)
-
-        puts fmt % [k, val]
-      end
-    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/data/tasks/gem.rake

@@ -4,84 +4,86 @@ require 'rake/gempackagetask'
 
 namespace :gem do
 
-  PROJ.spec = Gem::Specification.new do |s|
+  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.post_install_message = PROJ.post_install_message
+    s.rubyforge_project = PROJ.rubyforge.name
 
     s.description = PROJ.description
 
-    PROJ.dependencies.each do |dep|
+    PROJ.gem.dependencies.each do |dep|
       s.add_dependency(*dep)
     end
 
-    s.files = PROJ.files
-    s.executables = PROJ.executables.map {|fn| File.basename(fn)}
-    s.extensions = PROJ.files.grep %r/extconf\.rb$/
+    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]
+    incl = Regexp.new(PROJ.rdoc.include.join('|'))
+    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
     excl = Regexp.new(excl.join('|'))
-    rdoc_files = PROJ.files.find_all do |fn|
+    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.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
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
     else
-      s.test_files = PROJ.tests.to_a
+      s.test_files = PROJ.test.files.to_a
     end
 
     # Do any extra stuff the user wants
-#   spec_extras.each do |msg, val|
-#     case val
-#     when Proc
-#       val.call(s.send(msg))
-#     else
-#       s.send "#{msg}=", val
-#     end
-#   end
-  end
+    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
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
 
   desc 'Show information about the gem'
-  task :debug do
-    puts PROJ.spec.to_ruby
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
   end
 
   pkg = Rake::PackageTask.new(PROJ.name, PROJ.version) do |pkg|
-    pkg.need_tar = PROJ.need_tar
-    pkg.need_zip = PROJ.need_zip
-    pkg.package_files += PROJ.spec.files
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+    pkg.package_files += PROJ.gem._spec.files
   end
   Rake::Task['gem:package'].instance_variable_set(:@full_comment, nil)
 
-  gem_file = if PROJ.spec.platform == Gem::Platform::RUBY
+  gem_file = if PROJ.gem._spec.platform == Gem::Platform::RUBY
       "#{pkg.package_name}.gem"
     else
-      "#{pkg.package_name}-#{PROJ.spec.platform}.gem"
+      "#{pkg.package_name}-#{PROJ.gem._spec.platform}.gem"
     end
 
   desc "Build the gem file #{gem_file}"
-  task :package => "#{pkg.package_dir}/#{gem_file}"
+  task :package => ['gem:prereqs', "#{pkg.package_dir}/#{gem_file}"]
 
-  file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.spec.files do
+  file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.gem._spec.files do
     when_writing("Creating GEM") {
-      Gem::Builder.new(PROJ.spec).build
+      Gem::Builder.new(PROJ.gem._spec).build
       verbose(true) {
         mv gem_file, "#{pkg.package_dir}/#{gem_file}"
       }
@@ -90,14 +92,14 @@ namespace :gem do
 
   desc 'Install the gem'
   task :install => [:clobber, :package] do
-    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.full_name}"
+    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 -v '#{PROJ.version}' -i -x #{PROJ.name}"
+      sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' -I -x #{PROJ.name}"
     end
   end