rabal 0.0.1 → 0.1.0

data/lib/rabal/usage.rb

@@ -1,4 +1,5 @@
-require 'main'
+require 'rabal'
+
 module Rabal
 
     # Rabal has unique Usage output requirements and as such the default
@@ -24,11 +25,13 @@ module Rabal
         # to dump, or rename
         def to_s
             u = ::Main::Usage.new
-            # just transfer directly over these
-            %w[name synopsis description].each do |chunk|
+            # just transfer directly over these chunks
+            %w[name synopsis].each do |chunk|
                 u[chunk.dup] = old_usage[chunk].to_s
             end
 
+            u['description'] = ::Main::Util.columnize(old_usage['description'].to_s, :indent => 6, :width => 78)
+
             arguments       = app.main.parameters.select{|p| p.type == :argument}
             global_options  = app.main.parameters.select{|p| p.type == :option and app.global_option_names.include?(p.name) }
             load_options    = app.main.parameters.select{|p| p.type == :option and app.plugin_load_option_names.include?(p.name) }
@@ -47,7 +50,7 @@ module Rabal
             app.plugin_manager.plugins.sort_by{|c,p| c}.each do |cat,plugins|
                  plugins.each do |key,plugin|
                      pre = "  " + (plugin.use_always? ? "*" : " ")
-                     s << option_format(pre,"#{plugin.use_name} (#{plugin.register_path})",plugin.description,30,32,78)
+                     s << option_format(pre,"#{plugin.use_name} (#{plugin.register_path})",plugin.description,40,43,78)
                      s << "\n"
 
                      # create the module options for this one, if the
@@ -92,7 +95,7 @@ module Rabal
             end
             list.sort_by{|p| p.name}.collect do |p|
                 ps = ""
-                ps << option_format(pre,p.short_synopsis,p.description,35,39,78)
+                ps << option_format(pre,p.short_synopsis,p.description,42,45,78)
                 ps
             end.join("\n")
         end

data/lib/rabal/util.rb

@@ -1,5 +1,5 @@
-require 'ostruct'
-require 'main'
+require 'rabal'
+
 module Rabal
     module Util
         def replace_known_words(str)

data/lib/rabal/version.rb

@@ -1,13 +1,16 @@
+require 'rabal'
+
 module Rabal
     class Version
-        MAJOR   = 0 
-        MINOR   = 0 
-        BUILD   = 1 
+        MAJOR   = 0
+        MINOR   = 1 
+        BUILD   = 0
 
         class << self
             def to_a
                 [MAJOR, MINOR, BUILD]
             end
+
             def to_s
                 to_a.join(".")
             end

data/resources/trees/bin/rabal.project

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
 
 begin
-    require '<%= project %>'
+    require '<%= project_name %>'
 rescue LoadError => le
     $: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
-    require '<%= project %>'
+    require '<%= project_name %>'
 end
 
-puts "I am the killer app <%= project %> at version #{<%= project.camelize %>::VERSION}!"
+puts "I am the killer app <%= project_name %> at version #{<%= project_name.camelize %>::VERSION}!"

data/resources/trees/core/{CHANGES → CHANGES.erb}

@@ -1,4 +1,4 @@
-= <%= root.name %> Changelog
+= <%= project_name %> Changelog
 === Version 0.0.1
 
 * Initial public release

data/resources/trees/core/{README → README.erb}

@@ -1,4 +1,4 @@
-== <%= root.name %>
+== <%= project_name %>
 
 * Homepage
 * rubyforge project

data/resources/trees/core/Rakefile.erb

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'rake/rdoctask'
+
+$: << File.join(File.dirname(__FILE__),"lib")
+require '<%= project_name.underscore %>'
+
+# load all the extra tasks for the project
+TASK_DIR = File.join(File.dirname(__FILE__),"tasks")
+FileList[File.join(TASK_DIR,"*.rb")].each do |tasklib|
+    require "tasks/#{File.basename(tasklib)}"
+end
+
+task :default => "test:default"
+
+#-----------------------------------------------------------------------
+# Documentation
+#-----------------------------------------------------------------------
+namespace :doc do
+
+    # 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 "View the RDoc documentation locally"
+    task :view => :rdoc do
+        show_files <%= project_name.camelize %>::SPEC.local_rdoc_dir
+    end
+
+end
+
+#-----------------------------------------------------------------------
+# Packaging and Distribution
+#-----------------------------------------------------------------------
+namespace :dist do
+
+    GEM_SPEC = eval(<%= project_name.camelize %>:::SPEC.to_ruby)
+
+    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
+    end
+
+    desc "Install as a gem"
+    task :install => [:clobber, :package] do
+        sh "sudo gem install pkg/#{<%= project_name.camelize %>::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"
+    end
+
+    desc "dump gemspec"
+    task :gemspec do
+        puts <%= project_name.camelize %>::SPEC.to_ruby
+    end
+
+    desc "reinstall gem"
+    task :reinstall => [:install, :uninstall]
+
+end

data/resources/trees/core/lib/rabal.project.rb.erb

@@ -1,6 +1,4 @@
 module <%= project_name.camelize %>
-    AUTHOR          = "<%= author %>"
-    AUTHOR_EMAIL    = "<%= email %>"
     
     ROOT_DIR        = File.expand_path(File.join(File.dirname(__FILE__),".."))
     LIB_DIR         = File.join(ROOT_DIR,"lib").freeze

data/resources/trees/core/lib/rabal.project/gemspec.rb.erb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require '<%= project_name %>/specification'
+require '<%= project_name %>/version'
+require 'rake'
+
+# The Gem Specification plus some extras for <%= project_name %>.
+module <%= project_name.camelize %>
+    SPEC = <%= project_name.camelize %>::Specification.new do |spec|
+                spec.name               = "<%= project_name %>"
+                spec.version            = <%= project_name.camelize %>::VERSION
+                spec.rubyforge_project  = "<%= project_name %>"
+                spec.author             = "<%= root.author %>"
+                spec.email              = "<%= root.email %>"
+                spec.homepage           = "http://<%= project_name %>.rubyforge.org/"
+
+                spec.summary            = "A Summary of <%= project_name %>."
+                spec.description        = <<-DESC
+                A longer more detailed description of <%= project_name %>.
+                DESC
+
+                spec.extra_rdoc_files   = FileList["[A-Z]*"]
+                spec.has_rdoc           = true
+                spec.rdoc_main          = "README"
+                spec.rdoc_options       = [ "--line-numbers" , "--inline-source" ]
+
+                spec.test_files         = FileList["spec/**/*.rb", "test/**/*.rb"]
+                spec.files              = spec.test_files + spec.extra_rdoc_files + 
+                                          FileList["lib/**/*.rb", "resources/**/*"]
+                <% if root.has_subtree?(["bin"]) then %>
+                spec.executable         = spec.name
+                <% end %>
+
+                # add dependencies
+                # spec.add_dependency("somegem", ">= 0.4.2")
+                <% if root.has_subtree?(["ext"]) then %>
+                spec.add_dependency("mkrf")
+                spec.extensions << "ext/<%= project_name %>/ext/mkrf_conf.rb"
+                <% end %>
+                spec.platform           = Gem::Platform::RUBY
+
+                spec.local_rdoc_dir     = "doc/rdoc"
+                spec.remote_rdoc_dir    = "#{spec.name}/rdoc"
+                spec.local_coverage_dir = "doc/coverage"
+                spec.remote_coverage_dir= "#{spec.name}/coverage"
+
+                spec.remote_site_dir    = "#{spec.name}/"
+
+           end
+end
+
+

data/resources/trees/core/lib/rabal.project/specification.rb.erb

@@ -0,0 +1,128 @@
+require 'rubygems'
+require 'rubygems/specification'
+require 'rake'
+
+module <%= project_name.camelize %> 
+    # Add some additional items to Gem::Specification
+    # A <%= project_name.camelize %>::Specification adds additional pieces of information the
+    # typical gem specification
+    class Specification 
+
+        RUBYFORGE_ROOT = "/var/www/gforge-projects/"
+      
+        # user that accesses remote site
+        attr_accessor :remote_user
+
+        # remote host, default 'rubyforge.org'
+        attr_accessor :remote_host
+
+        # name the rdoc main
+        attr_accessor :rdoc_main
+
+        # local directory in development holding the generated rdoc
+        # default 'doc'
+        attr_accessor :local_rdoc_dir
+
+        # remote directory for storing rdoc, default 'doc'
+        attr_accessor :remote_rdoc_dir
+
+        # local directory for coverage report
+        attr_accessor :local_coverage_dir
+        
+        # remote directory for storing coverage reports
+        # This defaults to 'coverage'
+        attr_accessor :remote_coverage_dir
+
+        # local directory for generated website, default +site/public+
+        attr_accessor :local_site_dir
+       
+        # remote directory relative to +remote_root+ for the website.
+        # website.
+        attr_accessor :remote_site_dir
+
+        # is a .tgz to be created?, default 'true'
+        attr_accessor :need_tar
+
+        # is a .zip to be created, default 'true'
+        attr_accessor :need_zip
+
+
+        def initialize
+            @remote_user = nil
+            @remote_host = "rubyforge.org"
+
+            @rdoc_main              = "README"
+            @local_rdoc_dir         = "doc"
+            @remote_rdoc_dir        = "doc"
+            @local_coverage_dir     = "coverage"
+            @remote_coverage_dir    = "coverage"
+            @local_site_dir         = "site/public"
+            @remote_site_dir        = "."
+            
+            @need_tar   = true
+            @need_zip   = true
+
+            @spec                   = Gem::Specification.new
+
+            yield self if block_given?
+
+            # update rdoc options to take care of the rdoc_main if it is
+            # there, and add a default title if one is not given
+            if not @spec.rdoc_options.include?("--main") then
+                @spec.rdoc_options.concat(["--main", rdoc_main])
+            end
+
+            if not @spec.rdoc_options.include?("--title") then
+                @spec.rdoc_options.concat(["--title","'#{name} -- #{summary}'"])
+            end
+        end
+
+        # if this gets set then it overwrites what would be the
+        # rubyforge default.  If rubyforge project is not set then use
+        # name.  If rubyforge project and name are set, but they are
+        # different then assume that name is a subproject of the
+        # rubyforge project
+        def remote_root 
+            if rubyforge_project.nil? or 
+                rubyforge_project == name then
+                return RUBYFORGE_ROOT + "#{name}/"
+            else
+                return RUBYFORGE_ROOT + "#{rubyforge_project}/#{name}/"
+            end
+        end
+
+        # rdoc files is the same as what would be generated during gem
+        # installation. That is, everything in the require paths plus
+        # the rdoc_extra_files
+        #
+        def rdoc_files 
+            flist = extra_rdoc_files.dup
+            @spec.require_paths.each do |rp|
+                flist << FileList["#{rp}/**/*.rb"]
+            end
+            flist.flatten.uniq
+        end
+
+        # calculate the remote directories
+        def remote_root_location
+            "#{remote_user}@#{remote_host}:#{remote_root}"
+        end
+           
+        def remote_rdoc_location
+            remote_root_location + @remote_rdoc_dir
+        end
+
+        def remote_coverage_location
+            remote_root_loation + @remote_coverage_dir
+        end
+
+        def remote_site_location
+            remote_root_location + @remote_site_dir
+        end
+
+        # we delegate any other calls to spec
+        def method_missing(method_id,*params,&block)
+            @spec.send method_id, *params, &block
+        end
+    end
+end

data/resources/trees/core/lib/rabal.project/version.rb.erb

@@ -1,4 +1,4 @@
-module <%= root.name.capitalize %>
+module <%= project_name.camelize %>
     class Version
         MAJOR   = 0
         MINOR   = 0
@@ -8,6 +8,7 @@ module <%= root.name.capitalize %>
             def to_a
                 [MAJOR, MINOR, BUILD]
             end
+
             def to_s
                 to_a.join(".")
             end

data/resources/trees/ext/ext/rabal.project/ext/mkrf_conf.rb.erb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'mkrf'
+Mkrf::Generator.new('<%= soname %>') do |g|
+    g.logger.level = Logger::DEBUG
+    g.include_library('<%= lib_name %>','<%= lib_method %>')
+    g.include_header('<%= lib_name %>.h')
+end

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

@@ -0,0 +1,15 @@
+namespace :extension 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
+    end 
+end
+

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

@@ -0,0 +1,105 @@
+require 'rubyforge'
+
+#-----------------------------------------------------------------------
+# Documentation - pushing documentation to rubyforge
+#-----------------------------------------------------------------------
+namespace :doc do
+    desc "Deploy the RDoc documentation to rubyforge"
+    task :deploy => :rerdoc do
+        sh "rsync -zav --delete #{<%= project_name.camelize %>::SPEC.local_rdoc_dir}/ #{<%= project_name.camelize %>::SPEC.rubyforge_rdoc_dest}"
+    end
+end
+
+#-----------------------------------------------------------------------
+# Packaging and Distribution - push to rubyforge
+#-----------------------------------------------------------------------
+namespace :dist do
+    desc "Release files to rubyforge"
+    task :release => [: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
+
+#-----------------------------------------------------------------------
+# Announcements - Create an email text file, and post news to rubyforge
+#-----------------------------------------------------------------------
+def changes
+    change_file = File.expand_path(File.join(File.basename(__FILE__),"..","CHANGES"))
+    sections    = File.read(change_file).split(/^(?===)/)
+end
+def last_changeset
+    changes[1]
+end
+
+def announcement
+    urls    = "  #{<%= project_name.camelize %>::SPEC.homepage}"
+    subject = "#{<%= project_name.camelize %>::SPEC.name} #{<%= project_name.camelize %>::VERSION} Released"
+    title   = "#{<%= project_name.camelize %>::SPEC.name} version #{<%= project_name.camelize %>::VERSION} has been released."
+    body    = <<BODY
+#{<%= project_name.camelize %>::SPEC.description.rstrip}
+
+{{ Changelog for Version #{<%= project_name.camelize %>::VERSION} }}
+
+#{last_changeset.rstrip}
+
+BODY
+
+    return subject, title, body, urls
+end
+
+namespace :announce do
+    desc "create email for ruby-talk"
+    task :email do
+        subject, title, body, urls = announcement
+
+        File.open("email.txt", "w") do |mail|
+            mail.puts "From: #{<%= project_name.camelize %>::SPEC.author} <#{<%= project_name.camelize %>::SPEC.email}>"
+            mail.puts "To: ruby-talk@ruby-lang.org"
+            mail.puts "Date: #{Time.now.rfc2822}"
+            mail.puts "Subject: [ANN] #{subject}"
+            mail.puts
+            mail.puts title
+            mail.puts
+            mail.puts urls
+            mail.puts 
+            mail.puts body
+            mail.puts 
+            mail.puts urls
+        end
+        puts "Created the following as email.txt:"
+        puts "-" * 72
+        puts File.read("email.txt")
+        puts "-" * 72
+    end
+    
+    CLOBBER << "email.txt"
+
+    desc "Post news of #{<%= project_name.camelize %>::SPEC.name} to #{<%= project_name.camelize %>::SPEC.rubyforge_project} on rubyforge"
+    task :post_news 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
+
+end