rabal 0.2.3 → 0.3.3

data/resources/trees/core/tasks/config.rb.erb

@@ -0,0 +1,107 @@
+require 'configuration'
+
+require 'rake'
+require 'tasks/utils'
+
+#-----------------------------------------------------------------------
+# General project configuration
+#-----------------------------------------------------------------------
+Configuration.for('project') {
+  name          "FIXME: NAME"
+  version       "FIXME: 0.0.0"
+  author        "FIXME: The Author"
+  email         "FIXME: author@example.com"
+  homepage      "FIXME: http://project.example.com"
+  description   Utils.section_of("README", "description")
+  summary       description.split(".").first
+  history       "HISTORY"
+  license       FileList["LICENSE", "COPYING"]
+  readme        "README"
+}
+
+#-----------------------------------------------------------------------
+# Packaging 
+#-----------------------------------------------------------------------
+Configuration.for('packaging') {
+  # files in the project 
+  proj_conf = Configuration.for('project')
+  files {
+    bin       FileList["bin/*"]
+    ext       FileList["ext/*.{c,h,rb}"]
+    lib       FileList["lib/**/*.rb"]
+    test      FileList["spec/**/*.rb", "test/**/*.rb"]
+    data      FileList["data/**/*"]
+    tasks     FileList["tasks/**/*.r{ake,b}"]
+    rdoc      FileList[proj_conf.readme, proj_conf.history,
+                       proj_conf.license] + lib
+    all       bin + ext + 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
+  main_page   files.first
+  title       Configuration.for('project').name
+  options     %w[ --line-numbers --inline-source ]
+  output_dir  "doc"
+}
+
+#-----------------------------------------------------------------------
+# Extensions
+#-----------------------------------------------------------------------
+Configuration.for('extension') {
+  configs   Configuration.for('packaging').files.ext.find_all { |x| 
+                %w[ mkrf_conf.rb extconf.rb ].include?( File.basename(x) ) 
+            }
+}
+#-----------------------------------------------------------------------
+# Rubyforge 
+#-----------------------------------------------------------------------
+Configuration.for('rubyforge') {
+  project       "FIXME: rubyforge project"
+  user          "FIXME: username"
+  host          "rubyforge.org"
+  rdoc_location "#{user}@#{host}:/var/www/gforge-projects/#{project}"
+}
+
+

data/resources/trees/core/tasks/distribution.rake.erb

@@ -1,32 +1,38 @@
-#-----------------------------------------------------------------------
+require 'tasks/config'
+
+#-------------------------------------------------------------------------------
 # Distribution and Packaging
-#-----------------------------------------------------------------------
-namespace :dist do
+#-------------------------------------------------------------------------------
+if pkg_config = Configuration.for_if_exist?("packaging") then
+
+  require 'gemspec'
+  require 'rake/gempackagetask'
+  require 'rake/contrib/sshpublisher'
 
-    GEM_SPEC = eval(<%= project_name.camelize %>::SPEC.to_ruby)
+  namespace :dist do
 
-    Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
-        pkg.need_tar = <%= project_name.camelize %>::SPEC.need_tar
-        pkg.need_zip = <%= project_name.camelize %>::SPEC.need_zip
+    Rake::GemPackageTask.new(<%= project_name.camelize %>::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 pkg/#{<%= project_name.camelize %>::SPEC.full_name}.gem"
+      sh "sudo gem install pkg/#{<%= project_name.camelize %>::GEM_SPEC.full_name}.gem"
     end
 
-    # uninstall the gem and all executables
     desc "Uninstall gem"
     task :uninstall do 
-        sh "sudo gem uninstall #{<%= project_name.camelize %>::SPEC.name} -x"
+      sh "sudo gem uninstall -x #{<%= project_name.camelize %>::GEM_SPEC.name}"
     end
 
     desc "dump gemspec"
     task :gemspec do
-        puts <%= project_name.camelize %>::SPEC.to_ruby
+      puts <%= project_name.camelize %>::GEM_SPEC.to_ruby
     end
 
     desc "reinstall gem"
-    task :reinstall => [:uninstall, :install]
+    task :reinstall => [:uninstall, :repackage, :install]
 
-end
+ end
+end

data/resources/trees/core/tasks/documentation.rake.erb

@@ -1,25 +1,31 @@
+require 'tasks/config'
+
 #-----------------------------------------------------------------------
 # Documentation
 #-----------------------------------------------------------------------
 
-namespace :doc do
-    
+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   = <%= project_name.camelize %>::SPEC.local_rdoc_dir
-        rdoc.options    = <%= project_name.camelize %>::SPEC.rdoc_options 
-        rdoc.rdoc_files = <%= project_name.camelize %>::SPEC.rdoc_files
-    end
-
-    desc "Deploy the RDoc documentation to #{<%= project_name.camelize %>::SPEC.remote_rdoc_location}"
-    task :deploy => :rerdoc do
-        sh "rsync -zav --delete #{<%= project_name.camelize %>::SPEC.local_rdoc_dir}/ #{<%= project_name.camelize %>::SPEC.remote_rdoc_location}"
-    end
-
-    if HAVE_HEEL then
-        desc "View the RDoc documentation locally"
-        task :view => :rdoc do
-            sh "heel --root  #{<%= project_name.camelize %>::SPEC.local_rdoc_dir}"
-        end
-    end
-end
+      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/resources/trees/core/tasks/utils.rb.erb

@@ -0,0 +1,80 @@
+require '<%= project_name %>/version'
+
+#-------------------------------------------------------------------------------
+# Additions to the Configuration class that are useful
+#-------------------------------------------------------------------------------
+class Configuration
+  class << self
+    def exist?( name )
+      Configuration::Table.has_key?( name )
+    end
+
+    def for_if_exist?( name )
+      if self.exist?( name ) then
+        self.for( name )
+      end
+    end
+  end
+end
+
+#-------------------------------------------------------------------------------
+# some useful utilitiy methods for the tasks
+#-------------------------------------------------------------------------------
+module Utils
+  class << self
+
+    # Try to load the given _library_ using the built-in require, but do not
+    # raise a LoadError if unsuccessful. Returns +true+ if the _library_ was
+    # successfully loaded; returns +false+ otherwise.
+    #
+    def try_require( lib ) 
+      require lib
+      true 
+    rescue LoadError 
+      false 
+    end 
+
+    # partition an rdoc file into sections, and return the text of the section
+    # given.  
+    def section_of(file, section_name) 
+      File.read(file).split(/^(?==)/).each do |section|
+        lines = section.split("\n")
+        return lines[1..-1].join("\n").strip if lines.first =~ /#{section_name}/i
+      end
+      nil
+    end
+
+    # Get an array of all the changes in the application for a particular
+    # release.  This is done by looking in the history file and grabbing the
+    # information for the most recent release.  The history file is assumed to
+    # be in RDoc format and version release are 2nd tier sections separated by
+    # '== Version X.Y.Z'
+    #
+    # returns:: A hash of notes keyed by version number
+    #
+    def release_notes_from(history_file)
+      releases = {}
+      File.read(history_file).split(/^(?==)/).each do |section|
+        lines = section.split("\n")
+        md = %r{Version ((\w+\.)+\w+)}.match(lines.first)
+        next unless md
+        releases[md[1]] = lines[1..-1].join("\n").strip
+      end
+      return releases
+    end
+
+    # return a hash of useful information for the latest release
+    # urls, subject, title, description and latest release notes
+    #
+    def announcement
+      cfg = Configuration.for("project") 
+      { 
+        :subject        => "#{cfg.name} #{<%= project_name.camelize %>::VERSION} Released",
+        :title          => "#{cfg.name} version #{<%= project_name.camelize %>::VERSION} has been released.",
+        :urls           => "#{cfg.homepage}",
+        :description    => "#{cfg.description.rstrip}",
+        :release_notes  => Utils.release_notes_from(cfg.history)[<%= project_name.camelize %>::VERSION].rstrip 
+      }
+    end
+  end
+end # << self

data/resources/trees/ext/tasks/extension.rake.erb

@@ -1,15 +1,47 @@
-namespace :extension do  
+require 'tasks/config'
+require 'pathname'
+
+#-----------------------------------------------------------------------
+# Extensions
+#-----------------------------------------------------------------------
+if ext_config = Configuration.for_if_exist?('extension') then
+
+  namespace :ext do  
     desc "Build the extension(s)"
     task :build do
-        <%= project_name.camelize %>::SPEC.extensions.each do |extension|
-            path = Pathname.new(extension)
-            parts = path.split
-            conf = parts.last
-            Dir.chdir(path.dirname) do |d| 
-                ruby conf.to_s
-                sh "rake default"
-            end
-        end
+      ext_config.configs.each do |extension|
+        path = Pathname.new(extension)
+        parts = path.split
+        conf = parts.last
+        Dir.chdir(path.dirname) do |d| 
+          ruby conf.to_s
+          sh "rake default"
+        end 
+      end 
+    end 
+
+    task :clean do
+      ext_config.configs.each do |extension|
+        path = Pathname.new(extension)
+        parts = path.split
+        conf = parts.last
+        Dir.chdir( path.dirname )do |d| 
+          sh "rake clean"
+        end 
+      end 
     end 
+
+    task :clobber do
+      ext_config.configs.each do |extension|
+        path = Pathname.new(extension)
+        parts = path.split
+        conf = parts.last
+        Dir.chdir( path.dirname )do |d| 
+          sh "rake clobber"
+        end 
+      end 
+    end 
+
+  end
 end
 

data/resources/trees/rubyforge/tasks/rubyforge.rake.erb

@@ -1,43 +1,51 @@
-if HAVE_RUBYFORGE then
-    require 'rubyforge'
-    
-    #-----------------------------------------------------------------------
-    # Rubyforge additions to the task library
-    #-----------------------------------------------------------------------
-    namespace :dist do
-        desc "Release files to rubyforge"
-        task :rubyforge => [:clean, :package] do
-
-            rubyforge = RubyForge.new
-
-            # make sure this release doesn't already exist
-            releases = rubyforge.autoconfig['release_ids']
-            if releases.has_key?(<%= project_name.camelize %>::SPEC.name) and releases[<%= project_name.camelize %>::SPEC.name][<%= project_name.camelize %>::VERSION] then
-                abort("Release #{<%= project_name.camelize %>::VERSION} already exists! Unable to release.")
-            end
-
-            config = rubyforge.userconfig
-            config["release_notes"]     = <%= project_name.camelize %>::SPEC.description
-            config["release_changes"]   = last_changeset
-            config["Prefomatted"]       = true
-
-            puts "Uploading to rubyforge..."
-            files = FileList[File.join("pkg","#{<%= project_name.camelize %>::SPEC.name}-#{<%= project_name.camelize %>::VERSION}*.*")].to_a
-            rubyforge.login
-            rubyforge.add_release(<%= project_name.camelize %>::SPEC.rubyforge_project, <%= project_name.camelize %>::SPEC.name, <%= project_name.camelize %>::VERSION, *files)
-            puts "done."
-            end
-    end
+require 'tasks/config'    
+
+#-----------------------------------------------------------------------
+# Rubyforge additions to the task library
+#-----------------------------------------------------------------------
+if rf_conf = Configuration.for_if_exist?("rubyforge") then
+
+  abort("rubyforge gem not installed 'gem install rubyforge'") unless Utils.try_require('rubyforge')
+  
+  proj_conf = Configuration.for('project')
+
+  namespace :dist do
+    desc "Release files to rubyforge"
+    task :rubyforge => [:clean, :package] do
+
+      rubyforge = RubyForge.new
 
-    namespace :announce do
-        desc "Post news of #{<%= project_name.camelize %>::SPEC.name} to #{<%= project_name.camelize %>::SPEC.rubyforge_project} on rubyforge"
-        task :rubyforge do
-            subject, title, body, urls = announcement
-            rubyforge = RubyForge.new
-            rubyforge.login
-            rubyforge.post_news(<%= project_name.camelize %>::SPEC.rubyforge_project, subject, "#{title}\n\n#{urls}\n\n#{body}")
-            puts "Posted to rubyforge"
-        end
+      config = {}
+      config["release_notes"]     = proj_conf.description
+      config["release_changes"]   = Utils.release_notes_from(proj_conf.history)[<%= project_name.camelize %>::VERSION]
+      config["Prefomatted"]       = true
 
+      rubyforge.configure
+
+      # make sure this release doesn't already exist
+      releases = rubyforge.autoconfig['release_ids']
+      if releases.has_key?(<%= project_name.camelize %>::GEM_SPEC.name) and releases[<%= project_name.camelize %>::GEM_SPEC.name][<%= project_name.camelize %>::VERSION] then
+        abort("Release #{<%= project_name.camelize %>::VERSION} already exists! Unable to release.")
+      end
+
+      puts "Uploading to rubyforge..."
+      files = FileList[File.join("pkg","#{<%= project_name.camelize %>::GEM_SPEC.name}-#{<%= project_name.camelize %>::VERSION}*.*")].to_a
+      rubyforge.login
+      rubyforge.add_release(<%= project_name.camelize %>::GEM_SPEC.rubyforge_project, <%= project_name.camelize %>::GEM_SPEC.name, <%= project_name.camelize %>::VERSION, *files)
+      puts "done."
     end
-end
+  end
+
+  namespace :announce do
+    desc "Post news of #{proj_conf.name} to #{rf_conf.project} on rubyforge"
+    task :rubyforge do
+      info = Utils.announcement
+      rubyforge = RubyForge.new
+      rubyforge.configure
+      rubyforge.login
+      rubyforge.post_news(rf_conf.project, info[:subject], "#{info[:title]}\n\n#{info[:urls]}\n\n#{info[:release_notes]}")
+      puts "Posted to rubyforge"
+    end
+
+  end
+end

data/resources/trees/spec/spec/rabal.project_spec.rb.erb

@@ -1,16 +1,16 @@
-require File.join(File.dirname(__FILE__),"spec_helper.rb")
+require File.expand_path(File.join(File.dirname(__FILE__),"spec_helper.rb"))
 
 describe <%= project_name.camelize %> do
-    before(:each) do
-        # some setup
-    end
+  before(:each) do
+    # some setup
+  end
 
-    after(:each) do
-        # some cleanup
-    end
+  after(:each) do
+    # some cleanup
+  end
 
-    it "should have some tests" do
-        violated("I just want to be tested... is that so wrong?")
-    end
+  it "should have some tests" do
+    violated("I just want to be tested... is that so wrong?")
+  end
 
 end