setup 5.1.0 → 5.2.0

data/HISTORY.rdoc

@@ -1,5 +1,21 @@
 = RELEASE HISTORY
 
+== 5.2.0 / 2012-12-20
+
+This release makes a couple of important changes. First the `.ruby` file
+is no longer the supported metadata file. While the format is basically
+the same, the file is now called `.index`. See the {Indexer}[http://github.com/rubyworks/indexer]
+project for more details. One can still use `.setup/name`, `.setup/version`
+and `.setup/loadpath` files instead. In addition, `.setup/testrc.rb` has been
+renamed to `.setup/test.rb`, and for shell-based command use `.setup/test.sh`.
+
+Changes:
+
+* Use .index instead of .ruby for metadata.
+* Testing is handled by either .setup/test.rb or .setup/test.sh.
+* Automatic RI documentation generation is deprecated for good.
+
+
 == 5.1.0 / 2012-03-20
 
 With this release `bin/setup.rb` is now the all-in-one bundled script.
@@ -10,15 +26,10 @@ more descriptive of it's purpose for the general user.
 
 Changes:
 
-* Major Enhancements
-
-    * Rename `make` phase to `compile`.
-    * So called "MetaConfig" is handled via `.setup/metaconfig.rb`.
-    * The `bin/setup.rb` script is now the full-on bundled script.
-
-* Bug Fixes
-
-    * The `--prefix` option works with `all` command.
+* Rename `make` phase to `compile`.
+* So called "MetaConfig" is handled via `.setup/metaconfig.rb`.
+* The `bin/setup.rb` script is now the full-on bundled script.
+* The `--prefix` option works with `all` command.
 
 
 == 5.0.1 / 2010-02-07
@@ -28,13 +39,8 @@ and makes some minor adjusemnt to exit error messages.
 
 Changes:
 
-* 1 Bug Fix
-
-    * Fixed parsing of ruby install parameters on systems with custom configurations.
-
-* 1 Minor Enhancement
-
-    * Use 'abort $!.message' instead of 'exit 1' when exiting on error.
+* Fixed parsing of ruby install parameters on systems with custom configurations.
+* Use 'abort $!.message' instead of 'exit 1' when exiting on error.
 
 
 == 5.0.0 / 2010-01-12
@@ -50,19 +56,14 @@ through them performing the required action.
 
 Changes:
 
-* 5 Major Changes
-
-    * Split script into distinct classes, one for each setup phase.
-    * Testing is handled by optional script/test or .setup/testrc.rb file.
-    * Renamed 'setup' phase to 'make' phase.
-    * Deprecated MetaConfig API; support singleton extensions instead.
-    * Deprecated support for Ruby versions older than v1.6.2.
-
-* 3 Minor Changes
-
-    * Returned to using InstalledFiles for record installation and improved.
-    * Use SetupConfig instead of .cache/setup/config to store system configuration.
-    * Improved configuration options (eg. can use --type instead of --installdirs)
+* Split script into distinct classes, one for each setup phase.
+* Testing is handled by optional script/test or .setup/testrc.rb file.
+* Renamed 'setup' phase to 'make' phase.
+* Deprecated MetaConfig API; support singleton extensions instead.
+* Deprecated support for Ruby versions older than v1.6.2.
+* Returned to using InstalledFiles for record installation and improved.
+* Use SetupConfig instead of .cache/setup/config to store system configuration.
+* Improved configuration options (eg. can use --type instead of --installdirs)
 
 
 == 4.2.1 / 2009-08-26
@@ -73,9 +74,7 @@ in Facets to install both lib/more and lib/core.
 
 Changes:
 
-* 1 Major Enhancement
-
-    * meta/loadpath is now supported if you have multiple paths to install.
+* meta/loadpath is now supported if you have multiple paths to install.
 
 
 == 4.2.0 / 2009-08-26
@@ -89,19 +88,14 @@ below for more details.
 
 Changes:
 
-* 7 Major Enhancements
-
-    * relocated all user configuration files to meta/ and meta/setup
-    * meta/package must exist for doc to be installed.
-    * meta/setup/test.rb must be provided to run tests.
-    * meta/setup/doc.rb can be provided as alternate for generating docs.
-    * meta/setup/metaconfig.rb is now where meta-configuration goes.
-    * documentation is installed to <system-doc-dir>/ruby-<package>/.
-    * documentation generation shells out (for now, b/c of issues with using API)
-
-* 1 Minor Addition
-
-    * Notice the setup.rb file in the project repo. Guess what that is! ;)
+* relocated all user configuration files to meta/ and meta/setup
+* meta/package must exist for doc to be installed.
+* meta/setup/test.rb must be provided to run tests.
+* meta/setup/doc.rb can be provided as alternate for generating docs.
+* meta/setup/metaconfig.rb is now where meta-configuration goes.
+* documentation is installed to <system-doc-dir>/ruby-<package>/.
+* documentation generation shells out (for now, b/c of issues with using API)
+* Notice the setup.rb file in the project repo. Guess what that is! ;)
 
 
 == 4.1.0 / 2008-11-16
@@ -126,21 +120,16 @@ Please report any problems so I can fix them ASAP. Thanks.
 
 Changes:
 
-* 5 Major Enhancements
-
-    * testing only runs if a test script if provided
-    * cache files are now stored in .cache/setup/
-    * Renamed binary from rubysetup to setup.rb.
-      * Hoping that the use of a dot in the name is not a problem on Windows.
-      * By using setup.rb for the binary, it matches exactly the name of the old script.
-      * Other developers could do likewise, eg. setup.py; akin to mkfs.ext3 and friends. 
-    * Added script/install as a bootstrap installer.
-    * restored metaconfig
-
-* 2 Minor Enhancements
-
-    * added test from original (needs work)
-    * removed test/suite.rb option from testing
+* Testing only runs if a test script if provided
+* Cache files are now stored in .cache/setup/
+* Renamed binary from rubysetup to setup.rb.
+  * Hoping that the use of a dot in the name is not a problem on Windows.
+  * By using setup.rb for the binary, it matches exactly the name of the old script.
+  * Other developers could do likewise, eg. setup.py; akin to mkfs.ext3 and friends. 
+* Added script/install as a bootstrap installer.
+* Restored metaconfig
+* Added test from original (needs work)
+* Removed test/suite.rb option from testing
 
 
 == 4.0.0 / 2008-08-15

data/README.rdoc

@@ -1,13 +1,13 @@
 = Ruby Setup
 
 {Website}[http://rubyworks.github.com/setup] /
+{Guide}[https://github.com/rubyworks/setup/wiki] /
 {Issues}[http://github.com/rubyworks/setup/issues] /
 {Source}[http://github.com/rubyworks/setup]
+( {<img src="https://secure.travis-ci.org/rubyworks/setup.png" />}[http://travis-ci.org/rubyworks/setup] )
 
-{<img src="https://secure.travis-ci.org/rubyworks/setup.png" />}[http://travis-ci.org/rubyworks/setup]
 
-
-== INTRODUCTION
+== Introduction
 
 Every well practiced Rubyist is aware of Minero Aoki's ever +setup.rb+
 script. It's how most of us used to install our Ruby programs before RubyGems
@@ -21,7 +21,7 @@ from there. As long as a project is setup.rb compliant, as most are,
 then there is little to nothing it's developer must do.
 
 
-=== IMPORTANT
+=== Important
 
 There a couple very important difference between the old 3.4.1 verison
 of the setup.rb and Ruby Setup.
@@ -33,7 +33,7 @@ of the setup.rb and Ruby Setup.
 * The +setup+ phase has been renamed to the +compile+ phase.
 
 
-== INSTALLATION
+== Installation
 
 The easy way to install is via RubyGems.
 
@@ -45,11 +45,11 @@ and from the decompressed package directory run:
   $ ruby script/setup
 
 
-== HOW TO USE
+== Instruction
 
 To use setup.rb, a project must conform to the setup.rb standard layout.
 Please see the documentation on the website if you need to know more about
-what this entails. Most project already follow the standard since it was
+what this entails. Most projects already follow the standard since it was
 setup.rb that originally popularized most of the current layout conventions.
 (Note that the on-line documentation is slightly out of sync with the latest
 release.)
@@ -70,25 +70,34 @@ And is equivalent to running the two main phases in sequence.
 Where +compile+ compiles any extensions and +install+ copies project
 files to the appropriate places on your system.
 
+For setup.rb to install a project's documentation and library files
+properly it is best to supply it was basic information about the project.
+In particular, the +name+, +version+ and +loadpath+ (if not the default `lib`).
+This can be done either by creating a `.index` file for the project
+(see {Indexer}[http://github.com/rubyworks/indexer]), or by adding
+<tt>.setup/name</tt>, <tt>.setup/version</tt> and <tt>.setup/loadpath</tt>
+to the project.
+
 Setup.rb also supports two optional phases, +config+ and +test+.
 
   $ setup config
 
 Configuration must be run before any other phase in order to be of
-use. Running `config` creates a `SetupConfig` file which you can then
+used. Running `config` creates a `SetupConfig` file which you can then
 edit to make any adjustments neccessary to the installation. When finished
 editing this file, use setup.rb as before and your custom configuration
-will be used in place of the standard defaults.
+will be used instead of the standard defaults.
 
   $ setup.rb test
 
-This will run tests if a test script is provided. If should be run after
+This will run tests if a test script is provided. It must be run after
 +compile+, but before +install+. Because there are now a deverse selection
 of testing tools available for Ruby, testing only happens if the developer
-has provided a test run command script (eg. <tt>.setup/testrc.rb</tt>).
-Keep in mind that testing may require support libraries such as RSpec,
-Lemon, Bacon, QED or Cucumber. When using the +all+ command, you can
-activate testing via the <tt>--test</tt> or <tt>-t</tt> option.
+has provided a test runner script, either. <tt>.setup/test.rb</tt> or 
+<tt>.setup/test.sh</tt>. Keep in mind that testing may require support
+libraries such as RSpec, Lemon, Bacon, QED or Cucumber. When using the
++all+ command, you can activate testing via the <tt>--test</tt> or
+<tt>-t</tt> option.
 
 If you later decide you want to remove a program from your system, use
 +uninstall+.
@@ -98,10 +107,10 @@ If you later decide you want to remove a program from your system, use
 This will remove all files previously installed via the setup.rb command.
 Uninstalling is made possible by the 'SetupReceipt' file that is
 generated by the install process. If that file is deleted than you
-will not be able to uninstall. (You can get around this be reinstalling
-first though).
+will not be able to uninstall. (You can usually get around this be
+reinstalling first though).
 
-During the make phase, by-product files are generally created.
+During the make phase, by-product files are typically created.
 You can clean up any of these by-products with:
 
   $ setup.rb clean
@@ -111,26 +120,20 @@ And restore them to their absolute pristine state with:
   $ setup.rb distclean
 
 For further details on using +setup.rb+, or developing a project that can
-take advantage of setup.rb's special features, please see the website.
-
-
-== COPYRIGHTS
-
-Copyright (c) 2008,2009 Thomas Sawyer
+take advantage of setup.rb's special features, please see the website
+and associated wiki.
 
-BSD-2-Clause License.
 
-                                               7trans
-                                  transfire@gmail.com
-                           http://rubyworks.github.com
+== Copyrights
 
+Setup.rb is copyrighted open source software.
 
-Copyright (c) 2002,2005 Minero Aoki
+    Copyright (c) 2008 Rubyworks (BSD-2-Clause)
 
-GNU LGPL, Lesser General Public License version 2.1+.
+It can be modified and redistributed in accordance with the **BSD-2-Clause** license.
 
-                                          Minero Aoki
-                                  aamine@loveruby.net
-                                http://i.loveruby.net
+Setup.rb is a rewrite of the original setup.rb script by {Minero Aoki}[http://i.loveruby.net].
 
+    Copyright (c) 2002 Minero Aoki (GNU LGPL 2.1+)
 
+See LICENSE.txt and NOTICE.rdoc for details.

data/bin/setup.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Setup.rb v5.1.0
+# Setup.rb v5.2.0
 #
 # This is a stand-alone bundle of the setup.rb application.
 # You can place it in your projects script/ directory, or
@@ -16,20 +16,7 @@
 # without issue and without needing to install it for each.
 require 'yaml'
 module Setup
-  DIRECTORY = File.dirname(__FILE__) + '/setup'
-  PROFILE = YAML.load(File.new(DIRECTORY + '/profile.yml'))
-  verfile = YAML.load(File.new(DIRECTORY + '/version.yml'))
-  VERSION = verfile.values_at('major','minor','patch','state','build').compact.join('.')
-  def self.const_missing(name)
-    key = name.to_s.downcase
-    if verfile.key?(key)
-      verfile[key]
-    elsif profile.key?(key)
-      PROFILE[key]
-    else
-      super(name)
-    end
-  end
+  VERSION = '5.2.0'  #:erb: VERSION = '<%= version %>'
 end
 class << File #:nodoc: all
   unless respond_to?(:read)   # Ruby 1.6 and less
@@ -55,17 +42,17 @@ module Setup
 end
 module Setup
   class Project
-    ROOT_MARKER = '{.ruby,setup.rb,.setup,lib/}'
+    ROOT_MARKER = '{.index,setup.rb,.setup,lib/}'
     def initialize
-      @dotruby_file = find('.ruby')
-      @dotruby = YAML.load_file(@dotruby_file) if @dotruby_file
+      @dotindex_file = find('.index')
+      @dotindex = YAML.load_file(@dotindex_file) if @dotindex_file
       @name     = nil
       @version  = nil
       @loadpath = ['lib']
-      if @dotruby
-        @name     = @dotruby['name']
-        @version  = @dotruby['version']
-        @loadpath = @dotruby['load_path']
+      if @dotindex
+        @name     = @dotindex['name']
+        @version  = @dotindex['version']
+        @loadpath = (@dotindex['paths'] || {})['load']
       else
         if file = find('.setup/name')
           @name = File.read(file).strip
@@ -78,7 +65,7 @@ module Setup
         end
       end
     end
-    attr :dotruby
+    attr :dotindex
     attr :name
     attr :version
     attr :loadpath
@@ -365,7 +352,7 @@ require 'yaml'
 require 'shellwords'
 module Setup
   class Configuration
-    RBCONFIG  = ::Config::CONFIG
+    RBCONFIG  = ::RbConfig::CONFIG
     META_CONFIG_FILE = META_EXTENSION_DIR + '/metaconfig.rb'
     def self.options
       @@options ||= []
@@ -402,12 +389,12 @@ module Setup
     option :root            , :path, 'install to alternate root location'
     option :installdirs     , :pick, 'install location mode (site,std,home)'  #, local)
     option :type            , :pick, 'install location mode (site,std,home)'
-    ::Config::CONFIG.each do |key,val|
+    ::RbConfig::CONFIG.each do |key,val|
       next if key == "configure_args"
       name = key.to_s.downcase
       define_method(name){ val }
     end
-    config_args = Shellwords.shellwords(::Config::CONFIG["configure_args"])
+    config_args = Shellwords.shellwords(::RbConfig::CONFIG["configure_args"])
     config_args.each do |ent|
       if ent.index("=")
         key, val = *ent.split("=")
@@ -705,8 +692,9 @@ module Setup
     end
     def save_config
       out = to_yaml
-      if not File.exist?(File.dirname(CONFIG_FILE))
-        FileUtils.mkdir_p(File.dirname(CONFIG_FILE))
+      dir = File.dirname(CONFIG_FILE)
+      unless File.exist?(dir)
+        FileUtils.mkdir_p(dir)
       end
       if File.exist?(CONFIG_FILE)
         txt = File.read(CONFIG_FILE)
@@ -895,7 +883,7 @@ module Setup
         File.extname(file) == ".#{dllext}"
       end
       if ents.empty? && !files.empty?
-        raise Error, "ruby extention not compiled: 'setup.rb make' first"
+        raise Error, "ruby extention not compiled: 'setup.rb compile' first"
       end
       ents
     end
@@ -1056,20 +1044,26 @@ module Setup
 end
 module Setup
   class Tester < Base
-    RUBYSCRIPT  = META_EXTENSION_DIR + '/testrc.rb'
-    SHELLSCRIPT = 'script/test'
+    RUBYSCRIPT  = META_EXTENSION_DIR + '/test.rb'
+    SHELLSCRIPT = META_EXTENSION_DIR + '/test.sh'
+    DEPRECATED_RUBYSCRIPT  = META_EXTENSION_DIR + '/testrc.rb'
     def testable?
+      if File.exist?(DEPRECATED_RUBYSCRIPT)
+        warn "Must use `.setup/test.rb' instead or `.setup/testrc.rb' to support testing."
+      end
       return false if config.no_test
       return true  if File.exist?(RUBYSCRIPT)
       return true  if File.exist?(SHELLSCRIPT)
       false
     end
     def test
-      return true if !testable?
+      return true unless testable?
       if File.exist?(RUBYSCRIPT)
         test_rubyscript
       elsif File.exist?(SHELLSCRIPT)
         test_shellscript
+      else
+        true
       end
     end
     def test_shellscript

data/lib/setup/configuration.rb

@@ -13,7 +13,7 @@ module Setup
   class Configuration
 
     # Ruby System Configuration
-    RBCONFIG  = ::Config::CONFIG
+    RBCONFIG  = ::RbConfig::CONFIG
 
     ## Confgiuration file
     #CONFIG_FILE = 'SetupConfig'  # '.cache/setup/config'
@@ -26,7 +26,9 @@ module Setup
       @@options ||= []
     end
 
+    #
     # TODO: better methods for path type
+    #
     def self.option(name, *args) #type, description)
       options << [name.to_s, *args] #type, description]
       attr_accessor(name)
@@ -76,7 +78,7 @@ module Setup
 
     # Turn all of CONFIG into methods.
 
-    ::Config::CONFIG.each do |key,val|
+    ::RbConfig::CONFIG.each do |key,val|
       next if key == "configure_args"
       name = key.to_s.downcase
       #name = name.sub(/^--/,'')
@@ -85,7 +87,7 @@ module Setup
     end
 
     # Turn all of CONFIG["configure_args"] into methods.
-    config_args = Shellwords.shellwords(::Config::CONFIG["configure_args"])
+    config_args = Shellwords.shellwords(::RbConfig::CONFIG["configure_args"])
     config_args.each do |ent|
       if ent.index("=")
         key, val = *ent.split("=")
@@ -593,8 +595,9 @@ module Setup
     # Save configuration.
     def save_config
       out = to_yaml
-      if not File.exist?(File.dirname(CONFIG_FILE))
-        FileUtils.mkdir_p(File.dirname(CONFIG_FILE))
+      dir = File.dirname(CONFIG_FILE)
+      unless File.exist?(dir)
+        FileUtils.mkdir_p(dir)
       end
       if File.exist?(CONFIG_FILE)
         txt = File.read(CONFIG_FILE)