bones 2.0.3 → 2.1.0

data/spec/bones_spec.rb

@@ -0,0 +1,18 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe Bones do
+
+  before :all do
+    @root_dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  end
+
+  it "finds things releative to 'root'" do
+    Bones.path(%w[lib bones debug]).
+        should == File.join(@root_dir, %w[lib bones debug])
+  end 
+    
+end  # describe Bones
+
+# EOF

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# Equivalent to a header guard in C/C++
+# Used to prevent the spec helper from being loaded more than once
+unless defined? BONES_SPEC_HELPER
+BONES_SPEC_HELPER = true
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib bones]))
+
+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
+
+end  # unless defined?
+
+# EOF

data/tasks/ann.rake

@@ -1,4 +1,3 @@
-# $Id$
 
 begin
   require 'bones/smtp_tls'

data/tasks/bones.rake

@@ -1,4 +1,3 @@
-# $Id$
 
 if HAVE_BONES
 

data/tasks/gem.rake

@@ -1,6 +1,92 @@
-# $Id$
 
-require 'rake/gempackagetask'
+require 'find'
+require 'rake/packagetask'
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
+
+module Bones
+class GemPackageTask < Rake::PackageTask
+  # Ruby GEM spec containing the metadata for this package.  The
+  # name, version and package_files are automatically determined
+  # from the GEM spec and don't need to be explicitly provided.
+  #
+  attr_accessor :gem_spec
+
+  # Tasks from the Bones gem directory
+  attr_reader :bones_files
+
+  # Create a GEM Package task library.  Automatically define the gem
+  # if a block is given.  If no block is supplied, then +define+
+  # needs to be called to define the task.
+  #
+  def initialize(gem_spec)
+    init(gem_spec)
+    yield self if block_given?
+    define if block_given?
+  end
+
+  # Initialization tasks without the "yield self" or define
+  # operations.
+  #
+  def init(gem)
+    super(gem.name, gem.version)
+    @gem_spec = gem
+    @package_files += gem_spec.files if gem_spec.files
+    @bones_files = []
+
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+    if !test(?e, local_setup)
+      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+    end
+  end
+
+  # Create the Rake tasks and actions specified by this
+  # GemPackageTask.  (+define+ is automatically called if a block is
+  # given to +new+).
+  #
+  def define
+    super
+    task :prereqs
+    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
+    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
+      when_writing("Creating GEM") {
+        chdir(package_dir_path) do
+          Gem::Builder.new(gem_spec).build
+          verbose(true) {
+            mv gem_file, "../#{gem_file}"
+          }
+        end
+      }
+    end
+
+    file package_dir_path => bones_files do
+      mkdir_p package_dir rescue nil
+      bones_files.each do |fn|
+        base_fn = File.join('tasks', File.basename(fn))
+        f = File.join(package_dir_path, base_fn)
+        fdir = File.dirname(f)
+        mkdir_p(fdir) if !File.exist?(fdir)
+        if File.directory?(fn)
+          mkdir_p(f)
+        else
+          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
+          safe_ln(fn, f)
+        end
+      end
+    end
+  end
+  
+  def gem_file
+    if @gem_spec.platform == Gem::Platform::RUBY
+      "#{package_name}.gem"
+    else
+      "#{package_name}-#{@gem_spec.platform}.gem"
+    end
+  end
+end  # class GemPackageTask
+end  # module Bones
 
 namespace :gem do
 
@@ -19,6 +105,10 @@ namespace :gem do
       s.add_dependency(*dep)
     end
 
+    PROJ.gem.development_dependencies.each do |dep|
+      s.add_development_dependency(*dep)
+    end
+
     s.files = PROJ.gem.files
     s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
     s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
@@ -57,37 +147,14 @@ namespace :gem do
     end
   end  # Gem::Specification.new
 
-  # A prerequisites task that all other tasks depend upon
-  task :prereqs
-
-  desc 'Show information about the gem'
-  task :debug => 'gem:prereqs' do
-    puts PROJ.gem._spec.to_ruby
-  end
-
-  pkg = Rake::PackageTask.new(PROJ.name, PROJ.version) do |pkg|
+  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
     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.gem._spec.platform == Gem::Platform::RUBY
-      "#{pkg.package_name}.gem"
-    else
-      "#{pkg.package_name}-#{PROJ.gem._spec.platform}.gem"
-    end
 
-  desc "Build the gem file #{gem_file}"
-  task :package => ['gem:prereqs', "#{pkg.package_dir}/#{gem_file}"]
-
-  file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.gem._spec.files do
-    when_writing("Creating GEM") {
-      Gem::Builder.new(PROJ.gem._spec).build
-      verbose(true) {
-        mv gem_file, "#{pkg.package_dir}/#{gem_file}"
-      }
-    }
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
   end
 
   desc 'Install the gem'
@@ -113,14 +180,13 @@ namespace :gem do
   task :cleanup do
     sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
   end
-
 end  # namespace :gem
 
+
 desc 'Alias to gem:package'
 task :gem => 'gem:package'
 
 task :clobber => 'gem:clobber_package'
-
-remove_desc_for_task %w(gem:clobber_package)
+remove_desc_for_task 'gem:clobber_package'
 
 # EOF

data/tasks/git.rake

@@ -1,4 +1,3 @@
-# $Id$
 
 if HAVE_GIT
 

data/tasks/manifest.rake

@@ -1,4 +1,3 @@
-# $Id$
 
 require 'find'
 
@@ -15,9 +14,9 @@ namespace :manifest do
       lines.map! do |line|
         case line
         when %r/^(-{3}|\+{3})/; nil
-        when %r/^@/; Console::ANSICode.blue line
-        when %r/^\+/; Console::ANSICode.green line
-        when %r/^\-/; Console::ANSICode.red line
+        when %r/^@/; ANSICode.blue line
+        when %r/^\+/; ANSICode.green line
+        when %r/^\-/; ANSICode.red line
         else line end
       end
     end

data/tasks/notes.rake

@@ -1,4 +1,3 @@
-# $Id$
 
 if HAVE_BONES
 

data/tasks/post_load.rake

@@ -1,4 +1,3 @@
-# $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.
@@ -10,7 +9,8 @@ PROJ.exclude << ["^#{Regexp.escape(PROJ.ann.file)}$",
 
 flatten_arrays = lambda do |this,os|
     os.instance_variable_get(:@table).each do |key,val|
-      next if key == :dependencies
+      next if key == :dependencies \
+           or key == :development_dependencies
       case val
       when Array; val.flatten!
       when OpenStruct; this.call(this,val)

data/tasks/rdoc.rake

@@ -1,4 +1,3 @@
-# $Id$
 
 require 'rake/rdoctask'
 

data/tasks/rubyforge.rake

@@ -6,7 +6,7 @@ require 'rake/contrib/sshpublisher'
 
 namespace :gem do
   desc 'Package and upload to RubyForge'
-  task :release => [:clobber, 'gem:package'] do |t|
+  task :release => [:clobber, 'gem'] 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
     pkg = "pkg/#{PROJ.gem._spec.full_name}"
@@ -26,9 +26,7 @@ namespace :gem do
     c['release_changes'] = PROJ.changes if PROJ.changes
     c['preformatted'] = true
 
-    files = [(PROJ.gem.need_tar ? "#{pkg}.tgz" : nil),
-             (PROJ.gem.need_zip ? "#{pkg}.zip" : nil),
-             "#{pkg}.gem"].compact
+    files = Dir.glob("#{pkg}*.*")
 
     puts "Releasing #{PROJ.name} v. #{PROJ.version}"
     rf.add_release PROJ.rubyforge.name, PROJ.name, PROJ.version, *files

data/tasks/setup.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 require 'rubygems'
 require 'rake'
@@ -8,6 +7,9 @@ require 'ostruct'
 
 class OpenStruct; undef :gem; end
 
+# TODO: make my own openstruct type object that includes descriptions
+# TODO: use the descriptions to output help on the available bones options
+
 PROJ = OpenStruct.new(
   # Project Defaults
   :name => nil,
@@ -48,6 +50,7 @@ PROJ = OpenStruct.new(
   # Gem Packaging
   :gem => OpenStruct.new(
     :dependencies => [],
+    :development_dependencies => [],
     :executables => nil,
     :extensions => FileList['ext/**/extconf.rb'],
     :files => nil,
@@ -110,8 +113,10 @@ PROJ = OpenStruct.new(
 )
 
 # Load the other rake files in the tasks folder
-rakefiles = Dir.glob('tasks/*.rake').sort
-rakefiles.unshift(rakefiles.delete('tasks/post_load.rake')).compact!
+tasks_dir = File.expand_path(File.dirname(__FILE__))
+post_load_fn = File.join(tasks_dir, 'post_load.rake')
+rakefiles = Dir.glob(File.join(tasks_dir, '*.rake')).sort
+rakefiles.unshift(rakefiles.delete(post_load_fn)).compact!
 import(*rakefiles)
 
 # Setup the project libraries
@@ -162,6 +167,12 @@ HAVE_SVN = (Dir.entries(Dir.pwd).include?('.svn') and
 HAVE_GIT = (Dir.entries(Dir.pwd).include?('.git') and
             system("git --version 2>&1 > #{DEV_NULL}"))
 
+# Add bones as a development dependency
+#
+if HAVE_BONES
+  PROJ.gem.development_dependencies << ['bones', ">= #{Bones::VERSION}"]
+end
+
 # Reads a file at +path+ and spits out an array of the +paragraphs+
 # specified.
 #

data/tasks/spec.rake

@@ -1,6 +1,5 @@
-# $Id$
 
-if HAVE_SPEC_RAKE_SPECTASK
+if HAVE_SPEC_RAKE_SPECTASK and not PROJ.spec.files.to_a.empty?
 require 'spec/rake/verify_rcov'
 
 namespace :spec do

data/tasks/svn.rake

@@ -0,0 +1,47 @@
+
+if HAVE_SVN
+
+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.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 => '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 => '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
+
+    svn = PROJ.svn
+    trunk = File.join(svn.root, svn.trunk)
+    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    tag = File.join(svn.root, 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.path
+
+# EOF

data/tasks/test.rake

@@ -1,5 +1,5 @@
-# $Id$
 
+if test(?e, PROJ.test.file) or not PROJ.test.files.to_a.empty?
 require 'rake/testtask'
 
 namespace :test do
@@ -35,4 +35,6 @@ task :test => 'test:run'
 
 task :clobber => 'test:clobber_rcov' if HAVE_RCOV
 
+end
+
 # EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bones
 version: !ruby/object:Gem::Version 
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,17 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-02 00:00:00 -06:00
+date: 2008-10-15 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.8.1
+        version: 0.8.2
     version: 
 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
@@ -31,6 +32,20 @@ extra_rdoc_files:
 - History.txt
 - README.txt
 - bin/bones
+- lib/bones/tasks/ann.rake
+- lib/bones/tasks/bones.rake
+- lib/bones/tasks/gem.rake
+- lib/bones/tasks/git.rake
+- lib/bones/tasks/manifest.rake
+- lib/bones/tasks/notes.rake
+- lib/bones/tasks/post_load.rake
+- lib/bones/tasks/rdoc.rake
+- lib/bones/tasks/rubyforge.rake
+- lib/bones/tasks/spec.rake
+- lib/bones/tasks/svn.rake
+- lib/bones/tasks/test.rake
+- spec/data/data/README.txt
+- spec/data/foo/README.txt
 files: 
 - History.txt
 - Manifest.txt
@@ -45,25 +60,32 @@ files:
 - data/lib/NAME.rb.erb
 - data/spec/NAME_spec.rb.erb
 - data/spec/spec_helper.rb.erb
-- data/tasks/ann.rake
-- data/tasks/bones.rake
-- data/tasks/gem.rake
-- data/tasks/git.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
-- data/tasks/svn.rake
-- 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
+- lib/bones/tasks/ann.rake
+- lib/bones/tasks/bones.rake
+- lib/bones/tasks/gem.rake
+- lib/bones/tasks/git.rake
+- lib/bones/tasks/manifest.rake
+- lib/bones/tasks/notes.rake
+- lib/bones/tasks/post_load.rake
+- lib/bones/tasks/rdoc.rake
+- lib/bones/tasks/rubyforge.rake
+- lib/bones/tasks/setup.rb
+- lib/bones/tasks/spec.rake
+- lib/bones/tasks/svn.rake
+- lib/bones/tasks/test.rake
+- spec/bones/main_spec.rb
+- spec/bones_spec.rb
+- spec/data/data/README.txt
+- spec/data/data/Rakefile
+- spec/data/foo/README.txt
+- spec/data/foo/Rakefile
+- spec/spec_helper.rb
 - tasks/ann.rake
 - tasks/bones.rake
 - tasks/gem.rake
@@ -75,6 +97,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
@@ -103,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: codeforpeople
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Mr Bones is a handy tool that builds a skeleton for your new Ruby projects