bones 2.0.3 → 2.1.0

data/lib/bones/smtp_tls.rb

@@ -1,4 +1,3 @@
-# $Id$
 
 # This code enables SMTPTLS authentication requireed for sending mail
 # via the gmail servers. I found this code via a blog entry from James

data/{data → lib/bones}/tasks/ann.rake

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

data/{data → lib/bones}/tasks/bones.rake

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

data/lib/bones/tasks/gem.rake

@@ -0,0 +1,192 @@
+
+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
+
+  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.description = PROJ.description
+
+    PROJ.gem.dependencies.each do |dep|
+      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$/
+
+    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]
+    excl = Regexp.new(excl.join('|'))
+    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.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
+    else
+      s.test_files = PROJ.test.files.to_a
+    end
+
+    # Do any extra stuff the user wants
+    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
+
+  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+  end
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, 'gem:package'] do
+    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
+
+    # use this version of the command for rubygems > 1.0.0
+    #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 --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
+  desc 'Cleanup the gem'
+  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 'gem:clobber_package'
+
+# EOF

data/{data → lib/bones}/tasks/git.rake

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

data/{data → lib/bones}/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/{data → lib/bones}/tasks/notes.rake

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

data/{data → lib/bones}/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/{data → lib/bones}/tasks/rdoc.rake

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

data/{data → lib/bones}/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/{data → lib/bones}/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/{data → lib/bones}/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/{data → lib/bones}/tasks/svn.rake

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

data/{data → lib/bones}/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

data/spec/bones/main_spec.rb

@@ -0,0 +1,157 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. spec_helper]))
+
+describe Bones::Main do
+
+  before :each do
+    @main = Bones::Main.new
+    @skeleton_dir = File.join(@main.mrbones_dir, 'data')
+    @skeleton_dir = Bones.path('data') unless test(?e, @skeleton_dir)
+  end
+
+  it 'has some defaults when initialized' do
+    @main.options.should == {
+      :skeleton_dir => @skeleton_dir,
+      :with_tasks => false,
+      :verbose => false,
+      :name => nil,
+      :output_dir => nil,
+      :action => nil
+    }
+  end
+
+  it 'provides access to the output_dir' do
+    @main.output_dir.should be_nil
+    @main.options[:output_dir] = 'foo'
+    @main.output_dir.should == 'foo'
+  end
+
+  it 'provides access to the skeleton_dir' do
+    @main.skeleton_dir.should == @skeleton_dir
+    @main.options[:skeleton_dir] = 'bar'
+    @main.skeleton_dir.should == 'bar'
+  end
+
+  it 'provides access to the project name' do
+    @main.name.should be_nil
+    @main.options[:name] = 'baz'
+    @main.name.should == 'baz'
+  end
+
+  it 'provides access to the project classname' do
+    @main.options[:name] = 'foo-bar'
+    @main.classname.should == 'FooBar'
+  end
+
+  it 'determines if a project should be updated' do
+    @main.options[:output_dir] = Bones.path
+    @main.update?.should == false
+
+    @main.options[:with_tasks] = true
+    @main.update?.should == true
+
+    @main.options[:output_dir] = Bones.path(%w[foo bar baz buz tmp])
+    @main.update?.should == false
+  end
+
+  # ------------------------------------------------------------------------
+  describe 'when parsing command line options' do
+
+    before :each do
+      @main.stub!(:mrbones_dir).and_return(Bones.path(%w[spec data]))
+    end
+
+    it 'parses the project name' do
+      @main.parse %w[foo-bar]
+      @main.name.should == 'foo-bar'
+      @main.output_dir.should == 'foo-bar'
+    end
+
+    it 'parses the verbose flag' do
+      @main.parse %w[-v foo-bar]
+      @main.name.should == 'foo-bar'
+      @main.verbose?.should == true
+
+      @main = Bones::Main.new
+      @main.parse %w[--verbose foo-bar]
+      @main.name.should == 'foo-bar'
+      @main.verbose?.should == true
+    end
+
+    it 'parses the directory flag' do
+      @main.parse %w[-d blah foo-bar]
+      @main.name.should == 'foo-bar'
+      @main.output_dir.should == 'blah'
+
+      @main = Bones::Main.new
+      @main.parse %w[--directory blah foo-bar]
+      @main.name.should == 'foo-bar'
+      @main.output_dir.should == 'blah'
+    end
+
+    it 'parses the directory flag' do
+      @main.parse %w[-d blah foo-bar]
+      @main.name.should == 'foo-bar'
+      @main.output_dir.should == 'blah'
+
+      @main = Bones::Main.new
+      @main.parse %w[--directory blah foo-bar]
+      @main.name.should == 'foo-bar'
+      @main.output_dir.should == 'blah'
+    end
+
+    it 'parses the skeleton to use flag' do
+      @main.stub!(:mrbones_dir).and_return(Bones.path(%w[spec data]))
+      @main.parse %w[-s data foo-bar]
+      @main.name.should == 'foo-bar'
+      @main.skeleton_dir.should == Bones.path(%w[spec data data])
+
+      @main = Bones::Main.new
+      @main.stub!(:mrbones_dir).and_return(Bones.path(%w[spec data]))
+      @main.parse %w[--skeleton foo foo-bar]
+      @main.name.should == 'foo-bar'
+      @main.skeleton_dir.should == Bones.path(%w[spec data foo])
+    end
+
+    it 'parses the with-tasks flag' do
+      @main.parse %w[--with-tasks foo-bar]
+      @main.name.should == 'foo-bar'
+      @main.with_tasks?.should == true
+    end
+
+    it 'parses the freeze flag' do
+      @main.parse %w[--freeze]
+      @main.name.should be_nil
+      @main.options[:action].should == :freeze
+
+      @main = Bones::Main.new
+      @main.parse %w[--freeze foo-bar]
+      @main.name.should == 'foo-bar'
+      @main.options[:action].should == :freeze
+    end
+
+    it 'parses the unfreeze flag' do
+      @main.parse %w[--unfreeze]
+      @main.name.should be_nil
+      @main.options[:action].should == :unfreeze
+    end
+
+    it 'parses the info flag' do
+      @main.parse %w[--info]
+      @main.name.should be_nil
+      @main.options[:action].should == :info
+
+      @main = Bones::Main.new
+      @main.parse %w[-i]
+      @main.name.should be_nil
+      @main.options[:action].should == :info
+    end
+  end
+
+  # ------------------------------------------------------------------------
+  #describe 'when archiving tasks'
+
+end  # describe Bones::Main
+
+# EOF