bones 1.3.0 → 1.3.1

data/History.txt

@@ -1,4 +1,20 @@
-== 1.3.0 /
+== 1.3.1 / 2008-02-01
+
+* 4 minor enhancements
+  - Updated the "ensure_in_path" method to take more than one path
+  - Added an "in_directory" method for executing shell tasks in a
+    different directory
+  - Fleshed out a spec_helper and a better default project spec file
+  - By default the project changes, description, and summary will be
+    loaded from the History and README files
+* 3 bug fixes
+  - RSpec tasks were not including the user defined project libraries
+    such as "ext" or anything besides "lib"
+  - Tweaked the gem install/uninstall tasks to remove installed binaries
+    and to install paltform specific gem versions
+  - Fixed a bug where the RDoc task was ignore the PROJ.rdoc_opts
+
+== 1.3.0 / 2008-01-04
 
 * 2 minor enhancements
   - Added a few more methods to the default framework

data/Manifest.txt

@@ -9,11 +9,13 @@ data/README.txt.erb
 data/Rakefile.erb
 data/bin/NAME.erb
 data/lib/NAME.rb.erb
-data/spec/NAME_spec.rb
+data/spec/NAME_spec.rb.erb
+data/spec/spec_helper.rb.erb
 data/tasks/annotations.rake
 data/tasks/doc.rake
 data/tasks/gem.rake
 data/tasks/manifest.rake
+data/tasks/post_load.rake
 data/tasks/rubyforge.rake
 data/tasks/setup.rb
 data/tasks/spec.rake
@@ -27,6 +29,7 @@ tasks/annotations.rake
 tasks/doc.rake
 tasks/gem.rake
 tasks/manifest.rake
+tasks/post_load.rake
 tasks/rubyforge.rake
 tasks/setup.rb
 tasks/spec.rake

data/README.txt

@@ -3,7 +3,7 @@ Mr Bones
     http://codeforpeople.rubyforge.org/bones
 
 == 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
@@ -28,6 +28,7 @@ Mr Bones provides the following rake tasks:
   gem:release      # Package and upload to RubyForge
   gem:repackage    # Force a rebuild of the package files
   gem:uninstall    # Uninstall the gem
+  manifest         # Alias to manifest:check
   manifest:check   # Verify the manifest
   manifest:create  # Create a new manifest
   notes            # Enumerate all annotations
@@ -180,7 +181,7 @@ name and the derived class name into template files. The file must end in an
 ".erb" suffix for ERB substitutions to take place. The ".erb" suffix is
 stripped from the file during project generation. Therefore, your ERB files
 should have two suffixes -- the ".erb" suffix that will be stripped, and the
-suffix you want the resulting project file to have. 
+suffix you want the resulting project file to have.
 
 Only two values can be substituted into files using ERB -- the project name and
 the derived class name.

data/Rakefile

@@ -1,4 +1,4 @@
-# $Id: Rakefile 460 2008-01-04 20:53:46Z tim_pease $
+# $Id: Rakefile 489 2008-02-01 17:32:57Z tim_pease $
 
 $:.unshift('lib')
 
@@ -8,12 +8,9 @@ require 'bones'
 task :default => 'spec:run'
 
 PROJ.name = 'bones'
-PROJ.summary = 'Mr Bones is a handy tool that builds a skeleton for your new Ruby projects'
 PROJ.authors = 'Tim Pease'
 PROJ.email = 'tim.pease@gmail.com'
 PROJ.url = 'http://codeforpeople.rubyforge.org/bones'
-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'
 PROJ.version = Bones::VERSION

data/data/README.txt.erb

@@ -3,11 +3,11 @@
     FIXME (url)
 
 == DESCRIPTION:
-  
+
 FIXME (describe your package)
 
 == FEATURES/PROBLEMS:
-  
+
 * FIXME (list of features or problems)
 
 == SYNOPSIS:

data/data/Rakefile.erb

@@ -10,12 +10,9 @@ require '<%= name %>'
 task :default => 'spec:run'
 
 PROJ.name = '<%= name %>'
-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 %>'
 
 PROJ.spec_opts << '--color'

data/data/spec/NAME_spec.rb.erb

@@ -0,0 +1,8 @@
+# $Id$
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe <%= classname %> do
+end
+
+# EOF

data/data/spec/spec_helper.rb.erb

@@ -0,0 +1,17 @@
+# $Id$
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib <%= name %>]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+
+# EOF

data/data/tasks/doc.rake

@@ -7,7 +7,6 @@ namespace :doc do
   desc 'Generate RDoc documentation'
   Rake::RDocTask.new do |rd|
     rd.main = PROJ.rdoc_main
-    rd.options << '-d' if !WIN32 and `which dot` =~ %r/\/dot/
     rd.rdoc_dir = PROJ.rdoc_dir
 
     incl = Regexp.new(PROJ.rdoc_include.join('|'))
@@ -24,6 +23,7 @@ namespace :doc do
     title = "#{PROJ.rubyforge_name}'s " + title if PROJ.rubyforge_name != title
 
     rd.options << "-t #{title}"
+    rd.options.concat(PROJ.rdoc_opts)
   end
 
   desc 'Generate ri locally for testing'

data/data/tasks/gem.rake

@@ -69,12 +69,12 @@ namespace :gem do
 
   desc 'Install the gem'
   task :install => [:clobber, :package] do
-    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.file_name}"
+    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.full_name}"
   end
 
   desc 'Uninstall the gem'
   task :uninstall do
-    sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' #{PROJ.name}"
+    sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' -x #{PROJ.name}"
   end
 
 end  # namespace :gem

data/data/tasks/manifest.rake

@@ -36,6 +36,9 @@ namespace :manifest do
     files << fn unless test ?f, fn
     File.open(fn, 'w') {|fp| fp.puts files.sort}
   end
-end
+end  # namespace :manifest
+
+desc 'Alias to manifest:check'
+task :manifest => 'manifest:check'
 
 # EOF

data/data/tasks/post_load.rake

@@ -0,0 +1,18 @@
+# $Id$
+
+# This file does not define any rake tasks. It is used to load some project
+# settings if they are not defined by the user.
+
+unless PROJ.changes
+  PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+unless PROJ.description
+  PROJ.description = paragraphs_of('README.txt', 'description').join("\n\n")
+end
+
+unless PROJ.summary
+  PROJ.summary = PROJ.description.split('.').first
+end
+
+# EOF

data/data/tasks/setup.rb

@@ -68,7 +68,9 @@ PROJ.svn_tags = 'tags'
 PROJ.svn_branches = 'branches'
 
 # Load the other rake files in the tasks folder
-Dir.glob('tasks/*.rake').sort.each {|fn| import fn}
+rakefiles = Dir.glob('tasks/*.rake').sort
+rakefiles.unshift(rakefiles.delete('tasks/post_load.rake')).compact!
+import(*rakefiles)
 
 # Setup some constants
 WIN32 = %r/win32/ =~ RUBY_PLATFORM unless defined? WIN32
@@ -115,8 +117,28 @@ end
 #    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)
+def paragraphs_of( path, *paragraphs )
+  title = String === paragraphs.first ? paragraphs.shift : nil
+  ary = File.read(path).delete("\r").split(/\n\n+/)
+
+  result = if title
+    tmp, matching = [], false
+    rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
+    paragraphs << (0..-1) if paragraphs.empty?
+
+    ary.each do |val|
+      if val =~ rgxp
+        break if matching
+        matching = true
+        rgxp = %r/^=+/i
+      elsif matching
+        tmp << val
+      end
+    end
+    tmp
+  else ary end
+
+  result.values_at(*paragraphs)
 end
 
 # Adds the given gem _name_ to the current project's dependency list. An
@@ -130,11 +152,13 @@ def depend_on( name, version = nil )
   PROJ.dependencies << (version.nil? ? [name] : [name, ">= #{version}"])
 end
 
-# Adds the given _path_ to the include path if it is not already there
+# Adds the given arguments to the include path if they are not already there
 #
-def ensure_in_path( path )
-  path = File.expand_path(path)
-  $:.unshift(path) if test(?d, path) and not $:.include?(path)
+def ensure_in_path( *args )
+  args.each do |path|
+    path = File.expand_path(path)
+    $:.unshift(path) if test(?d, path) and not $:.include?(path)
+  end
 end
 
 # Find a rake task using the task name and remove any description text. This
@@ -148,4 +172,18 @@ def remove_desc_for_task( names )
   end
 end
 
+# Change working directories to _dir_, call the _block_ of code, and then
+# change back to the original working directory (the current directory when
+# this method was called).
+#
+def in_directory( dir, &block )
+  curdir = pwd
+  begin
+    cd dir
+    return block.call
+  ensure
+    cd curdir
+  end
+end
+
 # EOF

data/data/tasks/spec.rake

@@ -8,12 +8,14 @@ namespace :spec do
   Spec::Rake::SpecTask.new(:run) do |t|
     t.spec_opts = PROJ.spec_opts
     t.spec_files = PROJ.specs
+    t.libs += PROJ.libs
   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
+    t.libs += PROJ.libs
   end
 
   if HAVE_RCOV
@@ -21,6 +23,7 @@ namespace :spec do
     Spec::Rake::SpecTask.new(:rcov) do |t|
       t.spec_opts = PROJ.spec_opts
       t.spec_files = PROJ.specs
+      t.libs += PROJ.libs
       t.rcov = true
       t.rcov_opts = PROJ.rcov_opts + ['--exclude', 'spec']
     end

data/lib/bones.rb

@@ -1,9 +1,9 @@
-# $Id: bones.rb 449 2008-01-04 17:54:36Z tim_pease $
+# $Id: bones.rb 483 2008-01-24 18:46:49Z tim_pease $
 
 module Bones
 
   # :stopdoc:
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
   PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
   WIN32 = %r/win32/ =~ RUBY_PLATFORM
   DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
@@ -25,6 +25,10 @@ module Bones
     Dir.glob(search_me).sort.each {|rb| require rb}
   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
+
 end  # module Bones
 
 

data/tasks/doc.rake

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: doc.rake 486 2008-01-27 04:14:41Z tim_pease $
 
 require 'rake/rdoctask'
 
@@ -7,7 +7,6 @@ namespace :doc do
   desc 'Generate RDoc documentation'
   Rake::RDocTask.new do |rd|
     rd.main = PROJ.rdoc_main
-    rd.options << '-d' if !WIN32 and `which dot` =~ %r/\/dot/
     rd.rdoc_dir = PROJ.rdoc_dir
 
     incl = Regexp.new(PROJ.rdoc_include.join('|'))
@@ -24,6 +23,7 @@ namespace :doc do
     title = "#{PROJ.rubyforge_name}'s " + title if PROJ.rubyforge_name != title
 
     rd.options << "-t #{title}"
+    rd.options.concat(PROJ.rdoc_opts)
   end
 
   desc 'Generate ri locally for testing'

data/tasks/gem.rake

@@ -69,12 +69,12 @@ namespace :gem do
 
   desc 'Install the gem'
   task :install => [:clobber, :package] do
-    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.file_name}"
+    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.full_name}"
   end
 
   desc 'Uninstall the gem'
   task :uninstall do
-    sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' #{PROJ.name}"
+    sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' -x #{PROJ.name}"
   end
 
 end  # namespace :gem

data/tasks/manifest.rake

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: manifest.rake 489 2008-02-01 17:32:57Z tim_pease $
 
 require 'find'
 
@@ -36,6 +36,9 @@ namespace :manifest do
     files << fn unless test ?f, fn
     File.open(fn, 'w') {|fp| fp.puts files.sort}
   end
-end
+end  # namespace :manifest
+
+desc 'Alias to manifest:check'
+task :manifest => 'manifest:check'
 
 # EOF

data/tasks/post_load.rake

@@ -0,0 +1,18 @@
+# $Id: post_load.rake 497 2008-02-01 18:19:50Z tim_pease $
+
+# This file does not define any rake tasks. It is used to load some project
+# settings if they are not defined by the user.
+
+unless PROJ.changes
+  PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+unless PROJ.description
+  PROJ.description = paragraphs_of('README.txt', 'description').join("\n\n")
+end
+
+unless PROJ.summary
+  PROJ.summary = PROJ.description.split('.').first
+end
+
+# EOF

data/tasks/setup.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: setup.rb 497 2008-02-01 18:19:50Z tim_pease $
 
 require 'rubygems'
 require 'rake'
@@ -68,7 +68,9 @@ PROJ.svn_tags = 'tags'
 PROJ.svn_branches = 'branches'
 
 # Load the other rake files in the tasks folder
-Dir.glob('tasks/*.rake').sort.each {|fn| import fn}
+rakefiles = Dir.glob('tasks/*.rake').sort
+rakefiles.unshift(rakefiles.delete('tasks/post_load.rake')).compact!
+import(*rakefiles)
 
 # Setup some constants
 WIN32 = %r/win32/ =~ RUBY_PLATFORM unless defined? WIN32
@@ -115,8 +117,28 @@ end
 #    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)
+def paragraphs_of( path, *paragraphs )
+  title = String === paragraphs.first ? paragraphs.shift : nil
+  ary = File.read(path).delete("\r").split(/\n\n+/)
+
+  result = if title
+    tmp, matching = [], false
+    rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
+    paragraphs << (0..-1) if paragraphs.empty?
+
+    ary.each do |val|
+      if val =~ rgxp
+        break if matching
+        matching = true
+        rgxp = %r/^=+/i
+      elsif matching
+        tmp << val
+      end
+    end
+    tmp
+  else ary end
+
+  result.values_at(*paragraphs)
 end
 
 # Adds the given gem _name_ to the current project's dependency list. An
@@ -130,11 +152,13 @@ def depend_on( name, version = nil )
   PROJ.dependencies << (version.nil? ? [name] : [name, ">= #{version}"])
 end
 
-# Adds the given _path_ to the include path if it is not already there
+# Adds the given arguments to the include path if they are not already there
 #
-def ensure_in_path( path )
-  path = File.expand_path(path)
-  $:.unshift(path) if test(?d, path) and not $:.include?(path)
+def ensure_in_path( *args )
+  args.each do |path|
+    path = File.expand_path(path)
+    $:.unshift(path) if test(?d, path) and not $:.include?(path)
+  end
 end
 
 # Find a rake task using the task name and remove any description text. This
@@ -148,4 +172,18 @@ def remove_desc_for_task( names )
   end
 end
 
+# Change working directories to _dir_, call the _block_ of code, and then
+# change back to the original working directory (the current directory when
+# this method was called).
+#
+def in_directory( dir, &block )
+  curdir = pwd
+  begin
+    cd dir
+    return block.call
+  ensure
+    cd curdir
+  end
+end
+
 # EOF

data/tasks/spec.rake

@@ -1,4 +1,4 @@
-# $Id: spec.rake 461 2008-01-04 20:55:37Z tim_pease $
+# $Id$
 
 if HAVE_SPEC_RAKE_SPECTASK
 
@@ -8,12 +8,14 @@ namespace :spec do
   Spec::Rake::SpecTask.new(:run) do |t|
     t.spec_opts = PROJ.spec_opts
     t.spec_files = PROJ.specs
+    t.libs += PROJ.libs
   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
+    t.libs += PROJ.libs
   end
 
   if HAVE_RCOV
@@ -21,6 +23,7 @@ namespace :spec do
     Spec::Rake::SpecTask.new(:rcov) do |t|
       t.spec_opts = PROJ.spec_opts
       t.spec_files = PROJ.specs
+      t.libs += PROJ.libs
       t.rcov = true
       t.rcov_opts = PROJ.rcov_opts + ['--exclude', 'spec']
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bones
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-04 00:00:00 -07:00
+date: 2008-02-01 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-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)."
+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
@@ -35,11 +35,13 @@ files:
 - data/Rakefile.erb
 - data/bin/NAME.erb
 - data/lib/NAME.rb.erb
-- data/spec/NAME_spec.rb
+- data/spec/NAME_spec.rb.erb
+- data/spec/spec_helper.rb.erb
 - data/tasks/annotations.rake
 - data/tasks/doc.rake
 - data/tasks/gem.rake
 - data/tasks/manifest.rake
+- data/tasks/post_load.rake
 - data/tasks/rubyforge.rake
 - data/tasks/setup.rb
 - data/tasks/spec.rake
@@ -53,6 +55,7 @@ files:
 - tasks/doc.rake
 - tasks/gem.rake
 - tasks/manifest.rake
+- tasks/post_load.rake
 - tasks/rubyforge.rake
 - tasks/setup.rb
 - tasks/spec.rake