rabal 0.0.1 → 0.1.0

data/CHANGES

@@ -0,0 +1,13 @@
+= rabal Changelog
+=== Version 0.1.0 
+
+* Support for building ruby C extensions
+* Highline prompting for arguments missed on the commandline
+* logfile and verbosity options works
+* Refactored generated rakefile tasks into namespaces
+** rubyforge support
+** rspec and ruby unit templates
+
+=== Version 0.0.1
+
+* Initial public release

data/README.PLUGIN

@@ -168,7 +168,7 @@ happening.
    validate that all of a plugins +parameters+ have a non-nil value.
 9. Access the directory within the plugin containing the files that this
    plugin will use.  In this case that directory happens to be
-   +gem_directory/resources/trees/license/+
+   <tt>gem_directory/resources/trees/license/</tt>
 10. Every Plugin is required to have a +@tree+ instance variable.  This
     creates a new DirectoryTree instance and associates it with the "."
     directory within the resulting project structure.  This in effect
@@ -212,7 +212,7 @@ options.
 
 At the core of rabal are the resource trees utilized by the plugins to
 generate an output directory/file structure.  These tree _templates_ are
-stored within your gem under the +resources/trees+ directory from
+stored within your gem under the <tt>resources/trees</tt> directory from
 withing your gem. 
 
 You can get a jump start on your plugin project with:
@@ -236,8 +236,8 @@ returned from the nested calls:
 
     resource_by_name(my_main_tree_name)
 
-+my_main_tree_name+ returns +trees/xyzzy+ and +resource_by_name+ will
-return +/path/to/gem/resources/trees/xyzzy+.
++my_main_tree_name+ returns <tt>trees/xyzzy</tt> and +resource_by_name+ will
+return <tt>/path/to/gem/resources/trees/xyzzy</tt>.
 
 A later release of rabal will include a rabal plugin generation plugin
 to simplify the creation of rabal plugins.  
@@ -247,7 +247,7 @@ to simplify the creation of rabal plugins.
 The internal mechanisms of rabal use a Tree data structure to represent
 the directories and files that are created by rabal.  Each node in the
 tree is represented by a Tree or child class such as DirectoryTree or
-FileTree.  Each Tree has a +@parameters+ instance variable, which is
+FileTree.  Each Tree has a +parameters+ instance variable, which is
 by convention an instance of OpenStruct. It can be any object though.
 
 Any Tree instance or erb template when it is evaluated has access to any
@@ -257,7 +257,7 @@ the *root* of the Tree which is created by Rabal::Plugin::Core.
 Essentially, in a Tree instance or in an ERB template +method_missing+
 is defined such that the method call cascades up the Tree data structure
 until a Tree node is found that either responds to that method or has a
-+@parameters+ instance variable that responds to the method call.  
++parameters+ instance variable that responds to the method call.  
 
 If the call cascades all the way to the *root* and nothing responds to
 it, then NoMethodError is raised.  
@@ -265,10 +265,10 @@ it, then NoMethodError is raised.
 === Core Parameters
 
 Since Rabal::Plugin::Core is the plugin that creates the root of the
-entire tree, its +@parameters+ are available.  Currently these are
+entire tree, its +parameters+ are available.  Currently these are
 available during tree generation as:
 
-* *root.name* - the name of the project from the command line
+* <b>root.name</b> - the name of the project from the command line
 * *author* - the author of the project from the <tt>--core-author</tt> option
 * *email* - the email address of the author from the <tt>--core-email</tt> option
 

data/Rakefile

@@ -0,0 +1,79 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'rake/rdoctask'
+
+# since we have directories named 'core' remove that from CLEAN
+CLEAN.exclude("**/core")
+
+$: << File.join(File.dirname(__FILE__),"lib")
+require 'rabal'
+
+# 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 |ns|
+
+    # generating documentation locally
+    Rake::RDocTask.new do |rdoc|
+        rdoc.rdoc_dir   = Rabal::SPEC.local_rdoc_dir
+        rdoc.options    = Rabal::SPEC.rdoc_options 
+        rdoc.rdoc_files = Rabal::SPEC.rdoc_files
+    end
+
+    #desc "View the RDoc documentation locally"
+    task :view => :rdoc do
+        show_files Rabal::SPEC.local_rdoc_dir
+    end
+end
+
+#-----------------------------------------------------------------------
+# Packaging and Distribution
+#-----------------------------------------------------------------------
+namespace :dist do
+
+    GEM_SPEC = eval(Rabal::SPEC.to_ruby)
+
+    Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+        pkg.need_tar = Rabal::SPEC.need_tar
+        pkg.need_zip = Rabal::SPEC.need_zip
+    end
+    
+    desc "Install as a gem"
+    task :install => [:clobber_package, :package] do
+        sh "sudo gem install pkg/#{Rabal::SPEC.full_name}.gem"
+    end
+
+    # uninstall the gem and all executables
+    desc "Uninstall gem"
+    task :uninstall do 
+        sh "sudo gem uninstall #{Rabal::SPEC.name} -x"
+    end
+
+    desc "dump gemspec"
+    task :gemspec do
+        puts Rabal::SPEC.to_ruby
+    end
+
+    desc "reinstall gem"
+    task :reinstall => [:install, :uninstall]
+
+end
+
+#-----------------------------------------------------------------------
+# update the top level clobber task to depend on all possible sub-level
+# tasks that have a name like ':clobber'  in other namespaces
+#-----------------------------------------------------------------------
+Rake.application.tasks.each do |t|
+    if t.name =~ /:clobber/ then
+        task :clobber => [t.name]
+    end
+end

data/lib/rabal.rb

@@ -1,37 +1,19 @@
-module Rabal
-    AUTHOR          = "Jeremy Hinegardner".freeze
-    AUTHOR_EMAIL    = "jeremy@hinegardner.org".freeze
-    HOMEPAGE        = "http://copiousfreetime.rubyforge.org/rabal/"
-    COPYRIGHT       = "2007 #{AUTHOR}".freeze
-    DESCRIPTION     = <<DESC
-Ruby Architecture for Building Applications and Libraries.
+require 'find'
+require 'erb'
+require 'logger'
+require 'ostruct'
+
+require 'rubygems'
+require 'main'
 
-Rabal is a commandline application for bootstrapping, packaging and
-distributing ruby projects.
-DESC
+module Rabal
 
     ROOT_DIR        = File.expand_path(File.join(File.dirname(__FILE__),".."))
     LIB_DIR         = File.join(ROOT_DIR,"lib").freeze
     KNOWN_WORDS     = {
-        "rabal.project" => lambda { |tree| tree.root.name }
+        "rabal.project" => lambda { |tree| tree.root.project_name }
     }
 
-    #
-    # Utility method to require all files ending in .rb that lie in the
-    # directory below this file that has the same name as the filename
-    # passed in.
-    #
-    def require_all_libs_relative_to(fname)
-        search_me = File.join(File.dirname(fname),File.basename(fname,".*"))
-        
-        Dir.entries(search_me).each do |rb|
-            if File.extname(rb) == ".rb" then
-                require File.join(search_me,rb)
-            end
-        end
-    end 
-    module_function :require_all_libs_relative_to
-
     #
     # Module singleton methods, allow for accessing a single rabal
     # application from anywhere
@@ -46,4 +28,20 @@ DESC
         end
     end
 end
-Rabal.require_all_libs_relative_to(__FILE__)
+
+# require all the files
+require 'rabal/action_tree'
+require 'rabal/application'
+require 'rabal/directory_tree'
+require 'rabal/error'
+require 'rabal/file_tree'
+require 'rabal/gemspec'
+require 'rabal/logger'
+require 'rabal/plugin'
+require 'rabal/plugin_tree'
+require 'rabal/project_tree'
+require 'rabal/specification'
+require 'rabal/tree'
+require 'rabal/usage'
+require 'rabal/util'
+require 'rabal/version'

data/lib/rabal/application.rb

@@ -1,4 +1,4 @@
-require 'main'
+require 'rabal/logger'
 
 module Rabal
     #
@@ -6,6 +6,8 @@ module Rabal
     #
     class Application
 
+        include Log
+
         attr_accessor :main
         attr_accessor :plugin_manager
         attr_accessor :plugin_load_option_names
@@ -13,7 +15,17 @@ module Rabal
         attr_accessor :global_option_names
         attr_accessor :app_argv
 
-        def initialize
+        # used for testing mainly
+        attr_reader     :stdin
+        attr_reader     :stdout
+        attr_reader     :stderr
+
+
+        def initialize(stdin = $stdin, stdout = $stdout, stderr = $stderr)
+            @stdin = stdin
+            @stdout = stdout
+            @stderr = stderr
+
             @main = nil
             @plugin_manager = GemPlugin::Manager.instance
             @plugin_option_names = []
@@ -65,9 +77,9 @@ module Rabal
                         # present in the global main, they won't
                         # actually get displayed in the --help
                         plugin.parameters.each do |pname,pconf|
-                            p_option_name = "#{plugin_load_name}-#{pconf[0]}=[p]"
+                            p_option_name = "#{plugin_load_name}-#{pconf[:name]}=[p]"
                             pons << p_option_name
-                            option(p_option_name) { description pconf[1] } 
+                            option(p_option_name) { description pconf[:desc] } 
                         end
                     } 
                     plugin_option_names.concat(pons)
@@ -81,8 +93,8 @@ module Rabal
         def main
             return @main if @main
             @main = Main.new(app_argv) {
-                description Rabal::DESCRIPTION
-                author      Rabal::AUTHOR
+                description Rabal::SPEC.description
+                author      Rabal::SPEC.author
                 version     Rabal::VERSION
 
                 # Project, the whole reason rabal exists
@@ -104,8 +116,9 @@ module Rabal
                 }
 
                 option("verbosity=v","v") {
-                    validate    { |p| Logger::SEV_LABEL.include?(p.upcase) }
-                    description "One of : #{Logger::SEV_LABEL.join(", ")}"
+                    validate    { |p| ::Logger::SEV_LABEL.include?(p.upcase) }
+                    description "One of : #{::Logger::SEV_LABEL.join(", ")}"
+                    default     "INFO"
 
                 }
 
@@ -136,8 +149,8 @@ module Rabal
                 main.usage u
                 main.run 
             rescue ::Main::Parameter::Error => mpe
-                puts "Parameter Error: #{File.basename($0)}: #{mpe.message}"
-                puts "Try `#{File.basename($0)} --help' for more information."
+                stderr.puts "Parameter Error: #{File.basename($0)}: #{mpe.message}"
+                stderr.puts "Try `#{File.basename($0)} --help' for more information."
                 exit 1
             end
         end
@@ -147,24 +160,38 @@ module Rabal
         # parsed, plugins loaded, some activate, etc.  
         #
         def rabalize
-            # create the core plugin to start things off
+            logfile_and_level_if_necessary
+
+            # save our current directory for returning
             pwd = Dir.pwd
             begin
-                core_params = params_for_plugin(Rabal::Plugin::Core)
-                core_params[:project] = main.params[:project].value
-                core = Rabal::Plugin::Core.new(core_params)
+                Log.debug("Loading plugins")
+
+                # create the core plugin to start things off
+                core_params             = params_for_plugin(Rabal::Plugin::Core)
+                core_params[:project]   = main.params[:project].value
+                core                    = Rabal::Plugin::Core.new(core_params)
+
                 using_plugins.each do |p|
                     next if p == Rabal::Plugin::Core
+                    Log.debug("processing #{p.name} plugin")
                     pi = p.new(params_for_plugin(p))
+                    Log.debug("getting tree #{pi.tree.inspect}")
                     core.tree << pi.tree
                 end
 
                 # not using chdir blocks, as that raises
                 # warning: conflicting chdir during another chdir block
+                # hence our saving of pwd before begin
                 Dir.chdir(File.expand_path(main.params[:directory].value))
+
                 core.tree.process
             rescue ::Rabal::StandardError => rse
-                puts "Application Error: #{rse.message}"
+                stderr.puts "Application Error: #{rse.message}"
+                exit 1
+            rescue Interrupt => ie
+                stderr.puts
+                stderr.puts "Interrupted"
                 exit 1
             ensure
                 Dir.chdir(pwd)
@@ -205,5 +232,16 @@ module Rabal
             end
             plugin_hash
         end
+
+        #
+        # if the params for the logfile were given then open them up and
+        # 
+        def logfile_and_level_if_necessary
+            if main.params["logfile"].given? then
+                Log.logger = main.params["logfile"].value
+            end
+            Log.logger.level = ::Logger::SEV_LABEL.index(main.params["verbosity"].value)
+            Log.info "Logger initialized"
+        end
     end
 end

data/lib/rabal/directory_tree.rb

@@ -1,5 +1,6 @@
-require 'rabal/action_tree'
 require 'rabal/util'
+require 'rabal/tree'
+require 'rabal/logger'
 
 module Rabal
     include Util
@@ -9,7 +10,7 @@ module Rabal
     # parent of the directory this DirectoryTree represents.
     #
     class DirectoryTree < ActionTree
-        
+
         # basename of the directory this Tree represents
         attr_accessor :dir_name
 
@@ -17,7 +18,6 @@ module Rabal
         # this DirectoryTree represents.
         attr_accessor :parent_dir
 
-
         # Create a DirectoryTree based up a name, or another directory.
         # Only the last portion of the directory is used.  That is
         # +File.basename+ is called upon name.

data/lib/rabal/error.rb

@@ -1,3 +1,5 @@
+require 'rabal'
+
 module Rabal
     class StandardError < ::StandardError; end
     class TemplateNotFoundError < Rabal::StandardError ; end 

data/lib/rabal/file_tree.rb

@@ -1,6 +1,4 @@
-require 'rabal/action_tree'
-require 'rabal/util'
-require 'erb'
+require 'rabal'
 
 module Rabal
     include Util
@@ -67,7 +65,14 @@ module Rabal
         #
         def before_action
             info("creating content for #{file_name}")
-            @file_contents = ERB.new(template).result(binding)
+            begin 
+                @file_contents = ERB.new(template).result(binding)
+            rescue Exception => e
+                error("Error evaluating template #{file_name}")
+                e.message.split("\n").each do |m|
+                    error(m)
+                end
+            end
         end
 
         #

data/lib/rabal/gemspec.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rabal/specification'
+require 'rabal/version'
+require 'rake'
+
+module Rabal
+    SPEC = Rabal::Specification.new do |spec|
+                spec.name               = "rabal"
+                spec.version            = Rabal::VERSION
+                spec.rubyforge_project  = "copiousfreetime"
+                spec.author             = "Jeremy Hinegardner"
+                spec.email              = "jeremy@hinegardner.org"
+                spec.homepage           = "http://copiousfreetime.rubyforge.org/rabal/"
+
+                spec.summary            = "A tool for bootstrapping project development"
+                spec.description        = <<-DESC
+                Ruby Architecture for Building Applications and
+                Libraries.
+
+                Rabal is a commandline application for bootstrapping,
+                packaging and distributing ruby projects.
+                DESC
+
+                spec.extra_rdoc_files   = FileList["[A-Z]*"] - FileList["TODO"]
+                spec.has_rdoc           = true
+                spec.rdoc_main          = "README"
+                spec.rdoc_options       = [ "--line-numbers" , "--inline-source" ]
+
+                spec.test_files         = FileList["spec/**/*.rb"]
+                spec.executable         = spec.name
+                spec.files              = spec.test_files + spec.extra_rdoc_files + 
+                                          FileList["lib/**/*.rb", "resources/**/*"]
+
+                spec.add_dependency("main", ">= 0.0.2")
+                spec.add_dependency("gem_plugin", ">= 0.2.1")
+                spec.add_dependency("highline", ">= 1.2.9")
+
+                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
+
+