rabal 0.2.3 → 0.3.3

data/{CHANGES → HISTORY}

@@ -1,24 +1,40 @@
-=  Changelog
-=== Version 0.2.3
+=  Release Notes
+== Version 0.3.3
+
+* update rubyforge templates to fix bugs 
+* update announce templates to include gem install instructions
+
+== Version 0.3.2
+
+* fix extension templates
+* update gemspec to use extension Configuration
+
+== Version 0.3.0
+
+* rework templates to use Configuration and pull gemspec out of the project
+  code itself
+* switch from attributes to fattr
+
+== Version 0.2.3
 
 * fix compatibility bug with main 2.8.0
 
-=== Version 0.2.2
+== Version 0.2.2
 
 * put in missing init.rb stub to avoid GemPlugin confusion
 
-=== Version 0.2.1
+== Version 0.2.1
 
 * fix bug wherein some templates get lost for subdirectories when multiple modules are in use.
 
-=== Version 0.2.0
+== Version 0.2.0
 
 * create conditional tasks based upon the availability of libraries (webby, heel, rubyforge)
 * added in site plugin and associated tasks
 * moved all rake tasks to .rake files
 * added tasks to show website and rdoc if heel is installed
 
-=== Version 0.1.0 
+== Version 0.1.0 
 
 * Support for building ruby C extensions
 * Highline prompting for arguments missed on the commandline
@@ -27,6 +43,6 @@
 * rubyforge support
 * rspec and ruby unit templates
 
-=== Version 0.0.1
+== Version 0.0.1
 
 * Initial public release

data/README

@@ -28,137 +28,165 @@ For example, the +core+ plugin that is the base main required plugin of
 rabal is defined by the parameters +author+ and +email+ and the
 following directory/file template:
 
-   ./core/
-   ./core/lib
-   ./core/lib/rabal.project
-   ./core/lib/rabal.project.rb.erb
-   ./core/lib/rabal.project/version.rb.erb
-   ./core/CHANGES
-   ./core/INSTALL
-   ./core/README
-   ./core/Rakefile
+    ./core/CHANGES.erb
+    ./core/lib/rabal.project
+    ./core/lib/rabal.project/gemspec.rb.erb
+    ./core/lib/rabal.project/specification.rb.erb
+    ./core/lib/rabal.project/version.rb.erb
+    ./core/lib/rabal.project.rb.erb
+    ./core/Rakefile.erb
+    ./core/README.erb
+    ./core/tasks/announce.rake.erb
+    ./core/tasks/distribution.rake.erb
+    ./core/tasks/documentation.rake.erb
+    ./core/tasks/setup.rb.erb
 
 From this template with 'example' as the project the following structure
 was created:
 
-    ./example/
-    ./example/lib
-    ./example/lib/example
-    ./example/lib/example.rb
-    ./example/lib/example/version.rb
     ./example/CHANGES
-    ./example/INSTALL
-    ./example/README
+    ./example/lib/example/gemspec.rb
+    ./example/lib/example/specification.rb
+    ./example/lib/example/version.rb
+    ./example/lib/example.rb
+    ./example/LICENSE
     ./example/Rakefile
+    ./example/README
+    ./example/tasks/announce.rake
+    ./example/tasks/distribution.rake
+    ./example/tasks/documentation.rake
+    ./example/tasks/setup.rb
 
 Rabal currently ships with plugins for:
 
-* core - core functionality and baseline information need by every  project
+* bin - command line application
+* core - core functionality and baseline information need by every project
+* ext - ruby C extensions 
 * license - indicate under what license your project is released.  Has
   templates for BSD, GPL, LGPL, MIT and Ruby License
-* bin - command line application
 * spec - an RSpec starting point
 * test - a Test::Unit starting point
+* website - a website starting point (using webby framework)
 
 You are highly encouraged to write your own plugins and distribute them.
 See the README.PLUGIN for information on how to develop your own.
 
 == EXAMPLE
 
-  % rabal --use-all --core-author="Ruby Programmer" --core-email="rp@example.com"  --license-flavor=Ruby myproj
+  % rabal --use-all myproj
+  Author of the project (full name) ? Ruby Programmer
+  Email address of the author ? rp@example.com
+  Name of the resulting .so file (e.g.  myext) ? myprojext
+  Check for the existence of this method in the library ? main
+  Library to link against (e.g. libsomething) ? libmyproj
+  Flavor of License for your project: BSD, GPL, LGPL, MIT, RUBY ? RUBY
   [...]
   % find ./myproj
-  ./myproj/
-  ./myproj/LICENSE
+  ./myproj
+  ./myproj/bin
+  ./myproj/bin/myproj
+  ./myproj/CHANGES
   ./myproj/COPYING
-  ./myproj/README
+  ./myproj/ext
+  ./myproj/ext/myproj
+  ./myproj/ext/myproj/ext
+  ./myproj/ext/myproj/ext/mkrf_conf.rb
   ./myproj/lib
   ./myproj/lib/myproj
+  ./myproj/lib/myproj/gemspec.rb
+  ./myproj/lib/myproj/specification.rb
   ./myproj/lib/myproj/version.rb
   ./myproj/lib/myproj.rb
+  ./myproj/LICENSE
   ./myproj/Rakefile
-  ./myproj/INSTALL
-  ./myproj/CHANGES
+  ./myproj/README
   ./myproj/spec
-  ./myproj/spec/spec_helper.rb
   ./myproj/spec/myproj_spec.rb
-  ./myproj/bin
-  ./myproj/bin/myproj
+  ./myproj/spec/spec_helper.rb
+  ./myproj/tasks
+  ./myproj/tasks/announce.rake
+  ./myproj/tasks/distribution.rake
+  ./myproj/tasks/documentation.rake
+  ./myproj/tasks/extension.rake
+  ./myproj/tasks/rspec.rake
+  ./myproj/tasks/rubyforge.rake
+  ./myproj/tasks/setup.rb
+  ./myproj/tasks/site.rake
+  ./myproj/tasks/testunit.rake
+  ./myproj/test
+  ./myproj/test/myproj_test.rb
+  ./myproj/test/test_helper.rb
+
 
 == SYNOPSIS
 
     NAME
-      rabal v0.0.1
+      rabal v0.2.3
 
     SYNOPSIS
       rabal project [options]+
 
     DESCRIPTION
-      Ruby Architecture for Building Applications and Libraries.
-      
-      Rabal is a command line application for bootstrapping, packaging and
-      distributing ruby projects.
+      Ruby Architecture for Building Applications and Libraries. Rabal is a 
+      commandline application for bootstrapping, packaging and distributing 
+      ruby projects. 
 
     GLOBAL OPTIONS
-      --directory=directory, -d          - The directory in which to create the 
-                                           project directory. 
-      --help, -h                       
-      --logfile=logfile, -l              - The location of the logfile 
-      --use-all, -a                      - Use all available plugins. 
-      --verbosity=verbosity, -v          - One of : DEBUG, INFO, WARN, ERROR, 
-                                           FATAL, ANY 
-      --version, -V                      - Display the version number 
+      --directory=directory, -d                - The directory in which to 
+                                                 create the project directory. 
+      --help, -h                              
+      --logfile=logfile, -l                    - The location of the logfile 
+      --use-all, -a                            - Use all available plugins. 
+      --verbosity=verbosity, -v                - One of : DEBUG, INFO, WARN, 
+                                                 ERROR, FATAL, ANY 
 
     AVAILABLE MODULES
       Force any module to be used by giving the --use-[modulename] option. 
       Modules with a '*' next to them are always used. 
       
-         bin (/rabal/bin)           - Add a command line application. 
-        *core (/rabal/core)         - The core functionality and baseline 
-                                      information needed by every project. 
-        *license (/rabal/license)   - Indicate under what license your project is 
-                                      released. 
-         spec (/rabal/spec)         - Add an RSpec framework. 
-         test (/rabal/test)         - Add a Test::Unit framework. 
-
-    MODULE OPTIONS - BIN
-      No options available
+         bin (/rabal/bin)                      - Add a commandline application. 
+        *core (/rabal/core)                    - The core functionality and 
+                                                 baseline information needed by 
+                                                 every project. 
+         ext (/rabal/ext)                      - Add a ruby extension 
+        *license (/rabal/license)              - Indicate under what license your 
+                                                 project is released. 
+         rubyforge (/rabal/rubyforge)          - Add rubyforge support 
+         spec (/rabal/spec)                    - Add an RSpec framework. 
+         test (/rabal/test)                    - Add a Test::Unit framework. 
+         website (/rabal/website)              - Add a website for your 
+                                                 application. 
 
     MODULE OPTIONS - CORE
-      --core-author=[core-author]        - Author of the project 
-      --core-email=[core-email]          - Email address of the author 
+      --core-author=[core-author]              - Author of the project (full 
+                                                 name) 
+      --core-email=[core-email]                - Email address of the author 
 
     MODULE OPTIONS - LICENSE
-      --license-flavor=[license-flavor]  - Flavor of License for your project: 
-                                           BSD, GPL, LGPL, MIT, Ruby 
-
-    MODULE OPTIONS - SPEC
-      No options available
-
-    MODULE OPTIONS - TEST
-      No options available
+      --license-flavor=[license-flavor]        - Flavor of License for your 
+                                                 project: BSD, GPL, LGPL, MIT, 
+                                                 RUBY 
 
     AUTHOR
-      Jeremy Hinegardner 
+      Jeremy Hinegardner
 
+  
 
 == REQUIREMENTS
+
 === For running
 * main
 * gem_plugin
+* rake
 
 === For development
-* rake
 * rspec
 * rcov
 * mktemp
 
 == BUGS
 
-Rabal is taking the release early and release often approach.  There
-are guaranteed to be bugs.  In fact, there are some known options that
-currently do nothing.  Please report all bugs in the {rubyforge bug
-tracker}[http://rubyforge.org/tracker/?atid=14326&group_id=3707&func=browse]
+Please report all bugs in the {rubyforge bug tracker}[http://rubyforge.org/tracker/?atid=14326&group_id=3707&func=browse]
 
 == CREDITS
 
@@ -171,3 +199,5 @@ rabal is inspired by:
 == LICENSE:
 
 Released under the same conditions as Ruby.  See LICENSE and COPYING
+
+Code Generated by Rabal is licensed under the conditions of your project

data/bin/rabal

@@ -1,12 +1,11 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
+#--
+# Copyright (c) 2007, 2008 Jeremy Hinegardner
+# All rights reserved.  See LICENSE and/or COPYING for details
+#++
 
-begin 
-    require 'rabal'
-rescue LoadError => e
-    $: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
-    retry
-end
+$: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
+require 'rabal'
 
 Rabal.application.run(ARGV)

data/gemspec.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rabal/version'
+require 'tasks/config'
+
+Rabal::GEM_SPEC = Gem::Specification.new do |spec|
+  proj = Configuration.for('project')
+  spec.name         = proj.name
+  spec.version      = Rabal::VERSION
+  
+  spec.author       = proj.author
+  spec.email        = proj.email
+  spec.homepage     = proj.homepage
+  spec.summary      = proj.summary
+  spec.description  = proj.description
+  spec.platform     = Gem::Platform::RUBY
+
+  
+  pkg = Configuration.for('packaging')
+  spec.files        = pkg.files.all
+  spec.executables  = pkg.files.bin.collect { |b| File.basename(b) }
+
+  # add dependencies here
+  spec.add_dependency("configuration", ">= 0.0.5")
+  spec.add_dependency("rake", ">= 0.8.1")
+  spec.add_dependency("main", ">= 2.8.1")
+  spec.add_dependency("gem_plugin", ">= 0.2.1")
+  spec.add_dependency("highline", ">= 1.2.9")
+  spec.add_dependency("fattr", ">= 1.0.3")
+   
+  
+  if rdoc = Configuration.for_if_exist?('rdoc') then
+    spec.has_rdoc         = true
+    spec.extra_rdoc_files = pkg.files.rdoc
+    spec.rdoc_options     = rdoc.options + [ "--main" , rdoc.main_page ]
+  else
+    spec.has_rdoc         = false
+  end 
+
+  if test = Configuration.for_if_exist?('testing') then
+    spec.test_files       = test.files
+  end 
+
+  if rf = Configuration.for_if_exist?('rubyforge') then
+    spec.rubyforge_project  = rf.project
+  end 
+
+end

data/lib/rabal.rb

@@ -1,3 +1,4 @@
+
 require 'find'
 require 'erb'
 require 'logger'
@@ -7,26 +8,71 @@ require 'rubygems'
 require 'main'
 
 module Rabal
+  # The root directory of the project is considered to be the parent directory
+  # of the 'lib' directory.
+  #   
+  # returns:: [String] The full expanded path of the parent directory of 'lib'
+  #           going up the path from the current file.  Trailing
+  #           File::SEPARATOR is guaranteed.
+  #   
+  def self.root_dir
+    unless @root_dir
+      path_parts = ::File.expand_path(__FILE__).split(::File::SEPARATOR)
+      lib_index  = path_parts.rindex("lib")
+      @root_dir = path_parts[0...lib_index].join(::File::SEPARATOR) + ::File::SEPARATOR
+    end 
+    return @root_dir
+  end 
+
+  # returns:: [String] The full expanded path of the +config+ directory
+  #           below _root_dir_.  All parameters passed in are joined onto the
+  #           result.  Trailing File::SEPARATOR is guaranteed if _args_ are
+  #           *not* present.
+  #   
+  def self.config_path(*args)
+    self.sub_path("config", *args)
+  end 
+
+  # returns:: [String] The full expanded path of the +resource+ directory below
+  #           _root_dir_.  All parameters passed in are joined onto the 
+  #           result. Trailing File::SEPARATOR is guaranteed if 
+  #           _*args_ are *not* present.
+  #   
+  def self.resource_path(*args)
+    self.sub_path("resources", *args)
+  end 
+
+  # returns:: [String] The full expanded path of the +lib+ directory below
+  #           _root_dir_.  All parameters passed in are joined onto the 
+  #           result. Trailing File::SEPARATOR is guaranteed if 
+  #           _*args_ are *not* present.
+  #   
+  def self.lib_path(*args)
+    self.sub_path("lib", *args)
+  end 
 
-    ROOT_DIR        = File.expand_path(File.join(File.dirname(__FILE__),".."))
-    LIB_DIR         = File.join(ROOT_DIR,"lib").freeze
-    KNOWN_WORDS     = {
+  def self.sub_path(sub,*args)
+    sp = ::File.join(root_dir, sub) + File::SEPARATOR
+    sp = ::File.join(sp, *args) if args
+  end 
+
+  KNOWN_WORDS     = {
         "rabal.project" => lambda { |tree| tree.root.project_name }
-    }
-
-    #
-    # Module singleton methods, allow for accessing a single rabal
-    # application from anywhere
-    #
-    class << self
-        def application
-            @application ||= Rabal::Application.new
-        end
-
-        def application=(app)
-            @application = app
-        end
+  }
+
+  #
+  # Module singleton methods, allow for accessing a single rabal
+  # application from anywhere
+  #
+  class << self
+    def application
+      @application ||= Rabal::Application.new
+    end
+
+    def application=(app)
+      @application = app
     end
+  end
 end
 
 # require all the files
@@ -35,12 +81,10 @@ 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'