rabal 0.2.3 → 0.3.3

data/resources/trees/spec/tasks/rspec.rake.erb

@@ -1,24 +1,29 @@
-require 'spec/rake/spectask'
 
-#-----------------------------------------------------------------------
-# Testing - this is either test or spec, include the appropriate one
-#-----------------------------------------------------------------------
-namespace :test do
+require 'tasks/config'
 
-    task :default => :spec
+#--------------------------------------------------------------------------------
+# configuration for running rspec.  This shows up as the test:default task
+#--------------------------------------------------------------------------------
+if spec_config = Configuration.for_if_exist?("test") then
+  if spec_config.mode == "spec" then
+    namespace :test do
 
-    Spec::Rake::SpecTask.new do |r| 
-        r.rcov      = true
-        r.rcov_dir  = <%= project_name.camelize %>::SPEC.local_coverage_dir
-        r.libs      = <%= project_name.camelize %>::SPEC.require_paths
-        r.spec_opts = %w(--format specdoc --color)
-    end
+      task :default => :spec
+
+      require 'spec/rake/spectask'
+      Spec::Rake::SpecTask.new do |r| 
+        r.ruby_opts   = spec_config.ruby_opts
+        r.libs        = [ <%= project_name.camelize %>.lib_path, 
+                          <%= project_name.camelize %>.root_dir ]
+        r.spec_files  = spec_config.files 
+        r.spec_opts   = spec_config.options
 
-    if HAVE_HEEL then
-        desc "View the code coverage report locally"
-        task :coverage => [:spec] do
-            sh "heel --root #{<%= project_name.camelize %>::SPEC.local_coverage_dir}"
-        end 
+        if rcov_config = Configuration.for_if_exist?('rcov') then
+          r.rcov      = true
+          r.rcov_dir  = rcov_config.output_dir
+          r.rcov_opts = rcov_config.rcov_opts
+        end
+      end
     end
-    
+  end
 end

data/resources/trees/test/tasks/testunit.rake.erb

@@ -1,14 +1,19 @@
-require 'rake/testtask'
-#-----------------------------------------------------------------------
-# Testing - this is either test or spec, include the appropriate one
-#-----------------------------------------------------------------------
-namespace :test do
+require 'tasks/config'
+#-------------------------------------------------------------------------------
+# configuration for running unit tests.  This shows up as the test:default task
+#-------------------------------------------------------------------------------
 
-    task :default => :test
+if test_config = Configuration.for_if_exist?('test') then
+  if test_config.mode == "testunit" then
+    namespace :test do
 
-    Rake::TestTask.new do |t| 
-        t.libs      = <%= project_name.camelize %>::SPEC.require_paths
+      task :default => :test
+
+      require 'rake/testtask'
+      Rake::TestTask.new do |t| 
+        t.libs      = <%= project_name.camelize %>.lib_path
         t.test_files= FileList["test/**/*.rb"]
+      end
     end
-
+  end
 end

data/resources/trees/test/test/rabal.project_test.rb.erb

@@ -1,10 +1,10 @@
-require File.join(File.dirname(__FILE__),"test_helper.rb")
+require File.expand_path(File.join(File.dirname(__FILE__),"test_helper.rb"))
 
 class Test<%= project_name.camelize %> < Test::Unit::TestCase
-    def setup
-    end
+  def setup
+  end
 
-    def test_has_tests
-        flunk("Oh Please test me!")
-    end
+  def test_has_tests
+    flunk("Oh Please test me!")
+  end
 end

data/resources/trees/website/tasks/site.rake.erb

@@ -6,12 +6,12 @@ namespace :site do
     
     desc "Remove all the files from the local deployment of the site"
     task :clobber do
-        rm_rf <%= project_name.camelize %>::SPEC.local_site_dir
+        rm_rf <%= project_name.camelize %>::GEM_SPEC.local_site_dir
     end
 
-    desc "Update the website on #{<%= project_name.camelize %>::SPEC.remote_site_location}"
+    desc "Update the website on #{<%= project_name.camelize %>::GEM_SPEC.remote_site_location}"
     task :deploy => :build do
-        sh "rsync -zav --delete #{<%= project_name.camelize %>::SPEC.local_site_dir}/ #{<%= project_name.camelize %>::SPEC.remote_site_location}"
+        sh "rsync -zav --delete #{<%= project_name.camelize %>::GEM_SPEC.local_site_dir}/ #{<%= project_name.camelize %>::GEM_SPEC.remote_site_location}"
     end
 
     if HAVE_WEBBY then
@@ -32,8 +32,8 @@ namespace :site do
     if HAVE_HEEL then
         desc "View the website locally"
         task :view => :build do
-            sh "heel --root #{<%= project_name.camelize %>::SPEC.local_site_dir}"
+            sh "heel --root #{<%= project_name.camelize %>::GEM_SPEC.local_site_dir}"
         end
     end
 
-end
+end

data/spec/application_spec.rb

@@ -6,9 +6,9 @@ describe Rabal::Application do
     before(:each) do 
         @working_dir = my_temp_dir
         @before      = Dir.pwd
-        @base_tree   = Set.new(%w[README Rakefile CHANGES LICENSE 
-                                  lib lib/spec-proj lib/spec_proj.rb lib/spec-proj/version.rb lib/spec-proj/specification.rb lib/spec-proj/gemspec.rb
-                                  tasks tasks/announce.rake tasks/distribution.rake tasks/documentation.rake tasks/setup.rb])
+        @base_tree   = Set.new(%w[README Rakefile HISTORY LICENSE 
+                                  lib lib/spec-proj lib/spec_proj.rb lib/spec-proj/version.rb gemspec.rb
+                                  tasks tasks/announce.rake tasks/distribution.rake tasks/documentation.rake tasks/config.rb tasks/utils.rb ])
         @stdin       = StringIO.new
         @stdout      = StringIO.new
         @stderr      = StringIO.new

data/spec/bin_plugin_spec.rb

@@ -5,7 +5,7 @@ describe Rabal::Plugin::Bin do
         @working_dir = my_temp_dir
         @before      = Dir.pwd
         @core        = Rabal::Plugin::Core.new({:project => "new-spec-proj", :author => "Foo Bar", :email => "foobar@example.com"})
-        @base_tree   = Set.new(%w(README Rakefile CHANGES lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb bin bin/new_spec_proj lib/new-spec-proj/specification.rb lib/new-spec-proj/gemspec.rb tasks tasks/setup.rb tasks/announce.rake tasks/distribution.rake tasks/documentation.rake))
+        @base_tree   = Set.new(%w(README Rakefile HISTORY lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb bin bin/new_spec_proj gemspec.rb tasks tasks/config.rb tasks/announce.rake tasks/distribution.rake tasks/documentation.rake tasks/utils.rb ))
         Dir.chdir(@working_dir)
     end
 

data/spec/core_plugin_spec.rb

@@ -4,7 +4,7 @@ describe Rabal::Plugin::Core do
         @working_dir = my_temp_dir
         @before      = Dir.pwd
         @core        = Rabal::Plugin::Core.new({:project => "new-spec-proj", :author => "Foo Bar", :email => "foobar@example.com"})
-        @base_tree   = Set.new(%w(README Rakefile CHANGES lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb lib/new-spec-proj/specification.rb lib/new-spec-proj/gemspec.rb tasks tasks/setup.rb tasks/announce.rake tasks/distribution.rake tasks/documentation.rake))
+        @base_tree   = Set.new(%w(README Rakefile HISTORY lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb gemspec.rb tasks tasks/config.rb tasks/announce.rake tasks/utils.rb tasks/distribution.rake tasks/documentation.rake))
         Dir.chdir(@working_dir)
     end
 

data/spec/license_plugin_spec.rb

@@ -4,7 +4,7 @@ describe Rabal::Plugin::License do
         @working_dir = my_temp_dir
         @before      = Dir.pwd
         @core        = Rabal::Plugin::Core.new({:project => "new-spec-proj", :author => "Foo Bar", :email => "foobar@example.com"})
-        @base_tree   = Set.new(%w(README Rakefile CHANGES COPYING LICENSE lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb lib/new-spec-proj/gemspec.rb lib/new-spec-proj/specification.rb tasks tasks/setup.rb tasks/announce.rake tasks/distribution.rake tasks/documentation.rake))
+        @base_tree   = Set.new(%w(README Rakefile HISTORY COPYING LICENSE lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb gemspec.rb tasks tasks/config.rb tasks/announce.rake tasks/distribution.rake tasks/documentation.rake tasks/utils.rb ))
         Dir.chdir(@working_dir)
     end
 

data/spec/plugin_tree_spec.rb

@@ -8,7 +8,7 @@ describe Rabal::PluginTree do
         @tree        = ProjectTree.new('new-spec-proj', {:author => "Some Author", :email => "author@example.com"})
         @tree        << PluginTree.new({:data1 => "some_data" },resource_handle("core"))
 
-        @base_tree   = Set.new(%w(README Rakefile CHANGES lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb lib/new-spec-proj/gemspec.rb lib/new-spec-proj/specification.rb tasks tasks/announce.rake tasks/distribution.rake tasks/documentation.rake tasks/setup.rb))
+        @base_tree   = Set.new(%w(README Rakefile HISTORY lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb gemspec.rb tasks tasks/utils.rb tasks/announce.rake tasks/distribution.rake tasks/documentation.rake tasks/config.rb))
     
         @before = Dir.pwd
         Dir.chdir(@working_dir)

data/spec/spec_helper.rb

@@ -1,9 +1,6 @@
-begin
-    require 'rabal'
-rescue LoadError
-    $: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
-    require 'rabal'
-end
+$: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
+require 'rabal'
+
 require 'set'
 require 'rubygems'
 require 'tmpdir'

data/spec/spec_plugin_spec.rb

@@ -5,7 +5,7 @@ describe Rabal::Plugin::Spec do
         @working_dir = my_temp_dir
         @before      = Dir.pwd
         @core        = Rabal::Plugin::Core.new({:project => "new-spec-proj", :author => "Foo Bar", :email => "foobar@example.com"})
-        @base_tree   = Set.new(%w(README Rakefile CHANGES lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb spec spec/new_spec_proj_spec.rb spec/spec_helper.rb lib/new-spec-proj/specification.rb lib/new-spec-proj/gemspec.rb tasks tasks/rspec.rake tasks/announce.rake tasks/distribution.rake tasks/documentation.rake tasks/setup.rb))
+        @base_tree   = Set.new(%w(README Rakefile HISTORY lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb spec spec/new_spec_proj_spec.rb spec/spec_helper.rb gemspec.rb tasks tasks/utils.rb tasks/rspec.rake tasks/announce.rake tasks/distribution.rake tasks/documentation.rake tasks/config.rb))
         Dir.chdir(@working_dir)
     end
 

data/spec/test_plugin_spec.rb

@@ -5,7 +5,7 @@ describe Rabal::Plugin::Test do
         @working_dir = my_temp_dir
         @before      = Dir.pwd
         @core        = Rabal::Plugin::Core.new({:project => "new-spec-proj", :author => "Foo Bar", :email => "foobar@example.com"})
-        @base_tree   = Set.new(%w(README Rakefile CHANGES lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb test test/new_spec_proj_test.rb test/test_helper.rb lib/new-spec-proj/specification.rb lib/new-spec-proj/gemspec.rb tasks tasks/testunit.rake tasks/announce.rake tasks/distribution.rake tasks/documentation.rake tasks/setup.rb ))
+        @base_tree   = Set.new(%w(README Rakefile HISTORY lib lib/new-spec-proj lib/new_spec_proj.rb lib/new-spec-proj/version.rb test test/new_spec_proj_test.rb test/test_helper.rb gemspec.rb tasks tasks/testunit.rake tasks/announce.rake tasks/distribution.rake tasks/documentation.rake tasks/config.rb tasks/utils.rb ))
         Dir.chdir(@working_dir)
     end
 

data/tasks/announce.rake

@@ -0,0 +1,40 @@
+require 'tasks/config'
+#-------------------------------------------------------------------------------
+# announcement methods
+#-------------------------------------------------------------------------------
+
+proj_config = Configuration.for('project')
+namespace :announce do
+  desc "create email for ruby-talk"
+  task :email do
+    info = Utils.announcement
+
+    File.open("email.txt", "w") do |mail|
+      mail.puts "From: #{proj_config.author} <#{proj_config.email}>"
+      mail.puts "To: ruby-talk@ruby-lang.org"
+      mail.puts "Date: #{Time.now.rfc2822}"
+      mail.puts "Subject: [ANN] #{info[:subject]}"
+      mail.puts
+      mail.puts info[:title]
+      mail.puts
+      mail.puts "  gem install #{Rabal::GEM_SPEC.name}"
+      mail.puts
+      mail.puts info[:urls]
+      mail.puts 
+      mail.puts info[:description]
+      mail.puts 
+      mail.puts "{{ Release notes for Version #{Rabal::VERSION} }}"
+      mail.puts 
+      mail.puts info[:release_notes]
+      mail.puts
+      mail.puts info[:urls]
+    end 
+    puts "Created the following as email.txt:"
+    puts "-" * 72
+    puts File.read("email.txt")
+    puts "-" * 72
+  end 
+
+  CLOBBER << "email.txt"
+end
+

data/tasks/config.rb

@@ -0,0 +1,99 @@
+require 'configuration'
+
+require 'rake'
+require 'tasks/utils'
+
+#-----------------------------------------------------------------------
+# General project configuration
+#-----------------------------------------------------------------------
+Configuration.for('project') {
+  name          "rabal"
+  version       Rabal::Version.to_s
+  author        "Jeremy Hinegardner"
+  email         "jeremy at copiousfreetime dot org"
+  homepage      "http://copiousfreetime.rubyforge.org/rabal/"
+  description   Utils.section_of("README", "description")
+  summary       description.split(".").first
+  history       "HISTORY"
+  license       FileList["LICENSE", "COPYING"]
+  readme        FileList["README", "README.PLUGIN"]
+}
+
+#-----------------------------------------------------------------------
+# Packaging 
+#-----------------------------------------------------------------------
+Configuration.for('packaging') {
+  # files in the project 
+  proj_conf = Configuration.for('project')
+  files {
+    bin       FileList["bin/*"]
+    lib       FileList["lib/**/*.rb"]
+    test      FileList["spec/**/*.rb", "test/**/*.rb"]
+    data      FileList["data/**/*", "resources/**/*"]
+    tasks     FileList["tasks/**/*.r{ake,b}"]
+    rdoc      FileList[proj_conf.readme, proj_conf.history,
+                       proj_conf.license] + lib
+    all       bin + lib + test + data + rdoc + tasks 
+  }
+
+  # ways to package the results
+  formats {
+    tgz true
+    zip true
+    gem Configuration::Table.has_key?('gem')
+  }
+}
+
+#-----------------------------------------------------------------------
+# Gem packaging
+#-----------------------------------------------------------------------
+Configuration.for("gem") {
+  spec "gemspec.rb"
+  Configuration.for('packaging').files.all << spec
+}
+
+#-----------------------------------------------------------------------
+# Testing
+#   - change mode to 'testunit' to use unit testing
+#-----------------------------------------------------------------------
+Configuration.for('test') {
+  mode      "spec"
+  files     Configuration.for("packaging").files.test
+  options   %w[ --format specdoc --color ]
+  ruby_opts %w[ ]
+}
+
+#-----------------------------------------------------------------------
+# Rcov 
+#-----------------------------------------------------------------------
+Configuration.for('rcov') {
+  output_dir  "coverage"
+  libs        %w[ lib ]
+  rcov_opts   %w[ --html ]
+  ruby_opts   %w[ ]
+  test_files  Configuration.for('packaging').files.test
+}
+
+#-----------------------------------------------------------------------
+# Rdoc 
+#-----------------------------------------------------------------------
+Configuration.for('rdoc') {
+  files       Configuration.for('packaging').files.rdoc
+  #puts "Files! : #{files.join("\n")}"
+  main_page   files.first
+  title       Configuration.for('project').name
+  options     %w[ --line-numbers --inline-source ]
+  output_dir  "doc"
+}
+
+#-----------------------------------------------------------------------
+# Rubyforge 
+#-----------------------------------------------------------------------
+Configuration.for('rubyforge') {
+  project       "copiousfreetime"
+  user          "jjh"
+  host          "rubyforge.org"
+  rdoc_location "#{user}@#{host}:/var/www/gforge-projects/#{project}/rabal/"
+}
+
+

data/tasks/distribution.rake

@@ -0,0 +1,45 @@
+require 'tasks/config'
+
+#-------------------------------------------------------------------------------
+# Distribution and Packaging
+#-------------------------------------------------------------------------------
+if pkg_config = Configuration.for_if_exist?("packaging") then
+
+  require 'gemspec'
+  require 'rake/gempackagetask'
+  require 'rake/contrib/sshpublisher'
+
+  namespace :dist do
+
+    Rake::GemPackageTask.new(Rabal::GEM_SPEC) do |pkg|
+      pkg.need_tar = pkg_config.formats.tgz
+      pkg.need_zip = pkg_config.formats.zip
+    end
+
+    desc "Install as a gem"
+    task :install => [:clobber, :package] do
+      sh "sudo gem install -y pkg/#{Rabal::GEM_SPEC.full_name}.gem"
+    end
+
+    desc "Uninstall gem"
+    task :uninstall do 
+      sh "sudo gem uninstall -i #{Rabal::GEM_SPEC.name} -x"
+    end
+
+    desc "dump gemspec"
+    task :gemspec do
+      puts Rabal::GEM_SPEC.to_ruby
+    end
+
+    desc "reinstall gem"
+    task :reinstall => [:uninstall, :repackage, :install]
+
+    desc "distribute copiously"
+    task :copious => [:package] do
+      Rake::SshFilePublisher.new('jeremy@copiousfreetime.org', 
+                                 '/var/www/vhosts/www.copiousfreetime.org/htdocs/gems/gems',
+                                 'pkg',"#{Rabal::GEM_SPEC.full_name}.gem").upload
+      sh "ssh jeremy@copiousfreetime.org rake -f /var/www/vhosts/www.copiousfreetime.org/htdocs/gems/Rakefile"
+    end 
+  end
+end

data/tasks/documentation.rake

@@ -0,0 +1,31 @@
+require 'tasks/config'
+
+#-----------------------------------------------------------------------
+# Documentation
+#-----------------------------------------------------------------------
+
+if rdoc_config = Configuration.for_if_exist?('rdoc') then
+
+  namespace :doc do
+
+    require 'rake/rdoctask'
+
+    # generating documentation locally
+    Rake::RDocTask.new do |rdoc|
+      rdoc.rdoc_dir   = rdoc_config.output_dir
+      rdoc.options    = rdoc_config.options
+      rdoc.rdoc_files = rdoc_config.files
+      rdoc.title      = rdoc_config.title
+      rdoc.main       = rdoc_config.main_page
+    end 
+
+    if rubyforge_config = Configuration.for_if_exist?('rubyforge') then
+      desc "Deploy the RDoc documentation to #{rubyforge_config.rdoc_location}"
+      task :deploy => :rerdoc do
+        sh "rsync -zav --delete #{rdoc_config.output_dir}/ #{rubyforge_config.rdoc_location}"
+      end 
+    end 
+
+  end 
+end
+

data/tasks/rspec.rake

@@ -0,0 +1,29 @@
+
+require 'tasks/config'
+
+#--------------------------------------------------------------------------------
+# configuration for running rspec.  This shows up as the test:default task
+#--------------------------------------------------------------------------------
+if spec_config = Configuration.for_if_exist?("test") then
+  if spec_config.mode == "spec" then
+    namespace :test do
+
+      task :default => :spec
+
+      require 'spec/rake/spectask'
+      Spec::Rake::SpecTask.new do |r| 
+        r.ruby_opts   = spec_config.ruby_opts
+        r.libs        = [ Rabal.lib_path, 
+                          Rabal.root_dir ]
+        r.spec_files  = spec_config.files 
+        r.spec_opts   = spec_config.options
+
+        if rcov_config = Configuration.for_if_exist?('rcov') then
+          r.rcov      = true
+          r.rcov_dir  = rcov_config.output_dir
+          r.rcov_opts = rcov_config.rcov_opts
+        end
+      end
+    end
+  end
+end