bones 1.2.1 → 1.3.0

data/History.txt

@@ -1,4 +1,13 @@
-== 1.2.1 /
+== 1.3.0 /
+
+* 2 minor enhancements
+  - Added a few more methods to the default framework
+  - Added tasks to support tagging releases in SVN
+* 1 bug fix
+  - Fixed a nil value error for the remote rdoc directory
+    (patch supplied by Chris Shea)
+
+== 1.2.1 / 2008-01-02
 
 * 2 bug fixes
   - With no arguments, the bones command was not showing the help message

data/Manifest.txt

@@ -17,6 +17,7 @@ data/tasks/manifest.rake
 data/tasks/rubyforge.rake
 data/tasks/setup.rb
 data/tasks/spec.rake
+data/tasks/svn.rake
 data/tasks/test.rake
 data/test/test_NAME.rb
 lib/bones.rb
@@ -29,4 +30,5 @@ tasks/manifest.rake
 tasks/rubyforge.rake
 tasks/setup.rb
 tasks/spec.rake
+tasks/svn.rake
 tasks/test.rake

data/README.txt

@@ -22,7 +22,7 @@ Mr Bones provides the following rake tasks:
   doc:ri           # Generate ri locally for testing
   gem              # Alias to gem:package
   gem:debug        # Show information about the gem
-  gem:gem          # Build the gem file bones-1.2.0.gem
+  gem:gem          # Build the gem file bones-1.3.0.gem
   gem:install      # Install the gem
   gem:package      # Build all the packages
   gem:release      # Package and upload to RubyForge
@@ -38,6 +38,8 @@ Mr Bones provides the following rake tasks:
   spec:rcov        # Run all specs with RCov
   spec:run         # Run all specs with basic output
   spec:specdoc     # Run all specs with text output
+  svn:create_tag   # Create a new tag in the SVN repository
+  svn:show_tags    # Show tags from the SVN repository
   test             # Alias to test:run
   test:rcov        # Run rcov on the unit tests
   test:run         # Run tests for run
@@ -99,8 +101,9 @@ the Rakefile for the Mr Bones gem itself:
   PROJ.rdoc_remote_dir = 'bones'
   PROJ.version = Bones::VERSION
 
-  PROJ.exclude << '^doc'
   PROJ.rdoc_exclude << '^data'
+  PROJ.annotation_exclude = %w(^README\.txt$ ^data/)
+  PROJ.svn = 'bones'
 
   PROJ.spec_opts << '--color'
 
@@ -123,8 +126,8 @@ directories, backup files, or anything else you don't want gumming up the
 works. The files to exclude are given as an array of regular expression
 patterns; a file is excluded if it matches any of the patterns.
 
-  PROJ.exclude = %w(tmp$ bak$ ~$ CVS \.svn ^pkg)
-  PROJ.exclude << '^doc'
+  PROJ.exclude = %w(tmp$ bak$ ~$ CVS \.svn ^pkg ^doc)
+  PROJ.exclude << '^tags$'
 
 If your project depends on other gems, use the +depend_on+ command in your
 Rakefile to declare the dependency. If you do not specify a version, the

data/Rakefile

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: Rakefile 460 2008-01-04 20:53:46Z tim_pease $
 
 $:.unshift('lib')
 
@@ -18,8 +18,9 @@ PROJ.rubyforge_name = 'codeforpeople'
 PROJ.rdoc_remote_dir = 'bones'
 PROJ.version = Bones::VERSION
 
-PROJ.rdoc_exclude << '^data'
-PROJ.annotation_exclude = %w(^README\.txt$ ^data\/)
+PROJ.rdoc_exclude << '^data/'
+PROJ.annotation_exclude = %w(^README\.txt$ ^data/)
+PROJ.svn = 'bones'
 
 PROJ.spec_opts << '--color'
 

data/data/lib/NAME.rb.erb

@@ -1,7 +1,56 @@
 # $Id$
 
-class <%= classname %>
+# Equivalent to a header guard in C/C++
+# Used to prevent the class/module from being loaded more than once
+unless defined? <%= classname %>
+
+module <%= classname %>
+
+  # :stopdoc:
   VERSION = '1.0.0'
-end
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
+  end
+
+  # Returns the lpath for the module. 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
+
+  # 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
+
+end  # module <%= classname %>
+
+<%= classname %>.require_all_libs_relative_to __FILE__
+
+end  # unless defined?
 
 # EOF

data/data/tasks/rubyforge.rake

@@ -45,7 +45,7 @@ namespace :doc do
 
     host = "#{config['username']}@rubyforge.org"
     remote_dir = "/var/www/gforge-projects/#{PROJ.rubyforge_name}/"
-    remote_dir << PROJ.rdoc_remote_dir || PROJ.name
+    remote_dir << PROJ.rdoc_remote_dir if PROJ.rdoc_remote_dir
     local_dir = PROJ.rdoc_dir
 
     Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload

data/data/tasks/setup.rb

@@ -16,7 +16,7 @@ PROJ.email = nil
 PROJ.url = nil
 PROJ.version = ENV['VERSION'] || '0.0.0'
 PROJ.rubyforge_name = nil
-PROJ.exclude = %w(tmp$ bak$ ~$ CVS \.svn ^pkg ^doc)
+PROJ.exclude = %w(tmp$ bak$ ~$ CVS .svn/ ^pkg/ ^doc/)
 
 # Rspec
 PROJ.specs = FileList['spec/**/*_spec.rb']
@@ -32,8 +32,8 @@ PROJ.rcov_opts = ['--sort', 'coverage', '-T']
 
 # Rdoc
 PROJ.rdoc_opts = []
-PROJ.rdoc_include = %w(^lib ^bin ^ext txt$)
-PROJ.rdoc_exclude = %w(extconf\.rb$ ^Manifest\.txt$)
+PROJ.rdoc_include = %w(^lib/ ^bin/ ^ext/ .txt$)
+PROJ.rdoc_exclude = %w(extconf.rb$ ^Manifest.txt$)
 PROJ.rdoc_main = 'README.txt'
 PROJ.rdoc_dir = 'doc'
 PROJ.rdoc_remote_dir = nil
@@ -60,6 +60,13 @@ PROJ.need_zip = false
 PROJ.annotation_exclude = []
 PROJ.annotation_extensions = %w(.txt .rb .erb) << ''
 
+# Subversion Repository
+PROJ.svn = false
+PROJ.svn_root = nil
+PROJ.svn_trunk = 'trunk'
+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}
 

data/data/tasks/svn.rake

@@ -0,0 +1,44 @@
+# $Id$
+
+
+if PROJ.svn and system("svn --version 2>&1 > #{DEV_NULL}")
+
+unless PROJ.svn_root
+  info = %x/svn info ./
+  m = %r/^Repository Root:\s+(.*)$/.match(info)
+  PROJ.svn_root = (m.nil? ? '' : m[1])
+end
+PROJ.svn_root = File.join(PROJ.svn_root, PROJ.svn) if String === PROJ.svn
+
+namespace :svn do
+
+  desc 'Show tags from the SVN repository'
+  task :show_tags do |t|
+    tags = %x/svn list #{File.join(PROJ.svn_root, PROJ.svn_tags)}/
+    tags.gsub!(%r/\/$/, '')
+    puts tags
+  end
+
+  desc 'Create a new tag in the SVN repository'
+  task :create_tag 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)
+    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    tag = File.join(PROJ.svn_root, PROJ.svn_tags, tag)
+    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+    puts "Creating SVN tag '#{tag}'"
+    unless system "svn cp -m '#{msg}' #{trunk} #{tag}"
+      abort "Tag creation failed" 
+    end
+  end
+
+end  # namespace :svn
+
+task 'gem:release' => 'svn:create_tag'
+
+end  # if PROJ.svn
+
+# EOF

data/lib/bones.rb

@@ -1,9 +1,9 @@
-# $Id: bones.rb 448 2008-01-02 16:40:37Z tim_pease $
+# $Id: bones.rb 449 2008-01-04 17:54:36Z tim_pease $
 
 module Bones
 
   # :stopdoc:
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
   PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
   WIN32 = %r/win32/ =~ RUBY_PLATFORM
   DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'

data/lib/bones/main.rb

@@ -1,4 +1,4 @@
-# $Id: main.rb 448 2008-01-02 16:40:37Z tim_pease $
+# $Id: main.rb 462 2008-01-04 20:56:16Z tim_pease $
 
 require 'fileutils'
 require 'optparse'
@@ -55,7 +55,7 @@ class Main
 
     opts.on_tail( '-h', '--help', 'show this message' ) {puts opts; exit}
     opts.on_tail( '--version', 'show version' ) do
-      puts "Bones #{::Bones::VERSION}"
+      puts "Mr Bones #{::Bones::VERSION}"
       exit
     end
 

data/tasks/annotations.rake

@@ -1,4 +1,4 @@
-# $Id: annotations.rake 431 2007-12-31 21:24:37Z tim_pease $
+# $Id$
 
 if HAVE_BONES
 

data/tasks/doc.rake

@@ -1,4 +1,4 @@
-# $Id: doc.rake 428 2007-12-31 17:55:51Z tim_pease $
+# $Id$
 
 require 'rake/rdoctask'
 

data/tasks/gem.rake

@@ -1,4 +1,4 @@
-# $Id: gem.rake 428 2007-12-31 17:55:51Z tim_pease $
+# $Id$
 
 require 'rake/gempackagetask'
 

data/tasks/manifest.rake

@@ -1,4 +1,4 @@
-# $Id: manifest.rake 419 2007-12-29 04:39:36Z tim_pease $
+# $Id$
 
 require 'find'
 

data/tasks/rubyforge.rake

@@ -1,4 +1,4 @@
-# $Id: rubyforge.rake 417 2007-12-29 03:21:48Z tim_pease $
+# $Id$
 
 if PROJ.rubyforge_name && HAVE_RUBYFORGE
 
@@ -45,7 +45,7 @@ namespace :doc do
 
     host = "#{config['username']}@rubyforge.org"
     remote_dir = "/var/www/gforge-projects/#{PROJ.rubyforge_name}/"
-    remote_dir << PROJ.rdoc_remote_dir || PROJ.name
+    remote_dir << PROJ.rdoc_remote_dir if PROJ.rdoc_remote_dir
     local_dir = PROJ.rdoc_dir
 
     Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload

data/tasks/setup.rb

@@ -1,4 +1,4 @@
-# $Id: setup.rb 431 2007-12-31 21:24:37Z tim_pease $
+# $Id$
 
 require 'rubygems'
 require 'rake'
@@ -16,7 +16,7 @@ PROJ.email = nil
 PROJ.url = nil
 PROJ.version = ENV['VERSION'] || '0.0.0'
 PROJ.rubyforge_name = nil
-PROJ.exclude = %w(tmp$ bak$ ~$ CVS \.svn ^pkg ^doc)
+PROJ.exclude = %w(tmp$ bak$ ~$ CVS .svn/ ^pkg/ ^doc/)
 
 # Rspec
 PROJ.specs = FileList['spec/**/*_spec.rb']
@@ -32,8 +32,8 @@ PROJ.rcov_opts = ['--sort', 'coverage', '-T']
 
 # Rdoc
 PROJ.rdoc_opts = []
-PROJ.rdoc_include = %w(^lib ^bin ^ext txt$)
-PROJ.rdoc_exclude = %w(extconf\.rb$ ^Manifest\.txt$)
+PROJ.rdoc_include = %w(^lib/ ^bin/ ^ext/ .txt$)
+PROJ.rdoc_exclude = %w(extconf.rb$ ^Manifest.txt$)
 PROJ.rdoc_main = 'README.txt'
 PROJ.rdoc_dir = 'doc'
 PROJ.rdoc_remote_dir = nil
@@ -60,6 +60,13 @@ PROJ.need_zip = false
 PROJ.annotation_exclude = []
 PROJ.annotation_extensions = %w(.txt .rb .erb) << ''
 
+# Subversion Repository
+PROJ.svn = false
+PROJ.svn_root = nil
+PROJ.svn_trunk = 'trunk'
+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}
 

data/tasks/spec.rake

@@ -1,4 +1,4 @@
-# $Id: spec.rake 428 2007-12-31 17:55:51Z tim_pease $
+# $Id: spec.rake 461 2008-01-04 20:55:37Z tim_pease $
 
 if HAVE_SPEC_RAKE_SPECTASK
 
@@ -35,6 +35,6 @@ task :clobber => 'spec:clobber_rcov' if HAVE_RCOV
 
 remove_desc_for_task %w(spec:clobber_rcov)
 
-end  # if HAVE_SPEC
+end  # if HAVE_SPEC_RAKE_SPECTASK
 
 # EOF

data/tasks/svn.rake

@@ -0,0 +1,44 @@
+# $Id$
+
+
+if PROJ.svn and system("svn --version 2>&1 > #{DEV_NULL}")
+
+unless PROJ.svn_root
+  info = %x/svn info ./
+  m = %r/^Repository Root:\s+(.*)$/.match(info)
+  PROJ.svn_root = (m.nil? ? '' : m[1])
+end
+PROJ.svn_root = File.join(PROJ.svn_root, PROJ.svn) if String === PROJ.svn
+
+namespace :svn do
+
+  desc 'Show tags from the SVN repository'
+  task :show_tags do |t|
+    tags = %x/svn list #{File.join(PROJ.svn_root, PROJ.svn_tags)}/
+    tags.gsub!(%r/\/$/, '')
+    puts tags
+  end
+
+  desc 'Create a new tag in the SVN repository'
+  task :create_tag 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)
+    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    tag = File.join(PROJ.svn_root, PROJ.svn_tags, tag)
+    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+    puts "Creating SVN tag '#{tag}'"
+    unless system "svn cp -m '#{msg}' #{trunk} #{tag}"
+      abort "Tag creation failed" 
+    end
+  end
+
+end  # namespace :svn
+
+task 'gem:release' => 'svn:create_tag'
+
+end  # if PROJ.svn
+
+# EOF

data/tasks/test.rake

@@ -1,4 +1,4 @@
-# $Id: test.rake 428 2007-12-31 17:55:51Z tim_pease $
+# $Id$
 
 require 'rake/testtask'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bones
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-02 00:00:00 -07:00
+date: 2008-01-04 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -43,6 +43,7 @@ files:
 - data/tasks/rubyforge.rake
 - data/tasks/setup.rb
 - data/tasks/spec.rake
+- data/tasks/svn.rake
 - data/tasks/test.rake
 - data/test/test_NAME.rb
 - lib/bones.rb
@@ -55,6 +56,7 @@ files:
 - tasks/rubyforge.rake
 - tasks/setup.rb
 - tasks/spec.rake
+- tasks/svn.rake
 - tasks/test.rake
 has_rdoc: true
 homepage: http://codeforpeople.rubyforge.org/bones