setup 4.2.0 → 5.0.0

data/HISTORY

@@ -1,5 +1,46 @@
 = RELEASE HISTORY
 
+== 5.0.0 / 2010-01-12
+
+Version 5 represents a major milestone in Setup.rb's development.
+While the 4.x series focused on improving on aspects of the
+orginal 3.4.1 code base by Minero Aoki, this version takes the next step
+and reworks the entire script into an truly object-oriented design.
+In so doing, the system no longer traverses project directories
+one-by-one installing or compiling files as they are come across,
+but instead collects a list of files to handle up front, then iterates
+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)
+
+
+== 4.2.1 / 2009-08-26
+
+This release add support for multiple loadpaths. Add a list of them
+to meta/loadpath, and they will be installed. For example, the is used
+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.
+
+
 == 4.2.0 / 2009-08-26
 
 This release finally gets rdoc generation and doc installation working.
@@ -68,10 +109,13 @@ Changes:
 == 4.0.0 / 2008-08-15
 
 This is the first whack at making setup.rb a stand-alone application.
+Basically I have reverse engineered Aoki's 3.4.1 version of setup.rb,
+and then reworked some of the code to make it more modern, including 
+retro-fitting it to use OptionParser. Some features of the original
+are no longer supported, such a metaconfig and multi-package installs.
 
 Changes:
 
-* 3 Other Enhancements
-
-    * Initial checkin.
+* Same basic code as 3.4.1, but many parts have been refit.
+* Initial checkin to git repostitory.
 

data/MANIFEST

@@ -1,31 +1,64 @@
 COPYING
 HISTORY
 MANIFEST
-README
-RELEASE
-bin
+README.rdoc
 bin/setup.rb
-lib
 lib/setup
 lib/setup.rb
-lib/setup/build.rb
+lib/setup/base.rb
 lib/setup/command.rb
-lib/setup/config.rb
-lib/setup/error.rb
-lib/setup/install.rb
+lib/setup/compiler.rb
+lib/setup/configuration.rb
+lib/setup/constants.rb
+lib/setup/core_ext.rb
+lib/setup/documentor.rb
+lib/setup/installer.rb
+lib/setup/project.rb
 lib/setup/rake.rb
-lib/setup/rubyver.rb
-meta
-meta/abstract
+lib/setup/session.rb
+lib/setup/tester.rb
+lib/setup/uninstaller.rb
+meta/active
 meta/authors
+meta/collection
 meta/contact
 meta/created
+meta/description
 meta/homepage
-meta/package
+meta/name
 meta/released
-meta/setup
-meta/setup/metaconfig.rb
+meta/repository
+meta/ruby
 meta/summary
 meta/version
-test
-test/test_installer.rb
+script/bstrap
+script/bundle
+script/setup
+script/test
+test/cases
+test/cases/installer.rb
+test/features
+test/features/config.feature
+test/features/document.feature
+test/features/install.feature
+test/features/make.feature
+test/features/step_definitions
+test/features/step_definitions/common_steps.rb
+test/features/step_definitions/config_steps.rb
+test/features/step_definitions/env.rb
+test/features/step_definitions/install_steps.rb
+test/features/step_definitions/setup_steps.rb
+test/features/step_definitions/uninstall_steps.rb
+test/features/test.feature
+test/features/uninstall.feature
+test/fixtures
+test/fixtures/faux-project
+test/fixtures/faux-project/bin
+test/fixtures/faux-project/bin/faux
+test/fixtures/faux-project/ext
+test/fixtures/faux-project/ext/faux
+test/fixtures/faux-project/ext/faux/extconf.rb
+test/fixtures/faux-project/ext/faux/faux.c
+test/fixtures/faux-project/lib
+test/fixtures/faux-project/lib/faux.rb
+test/fixtures/faux-project/script

data/README.rdoc

@@ -0,0 +1,148 @@
+= Ruby Setup
+
+* http://protuils.github.com/setup
+* http://github.com/protuils/setup
+
+
+== 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
+came along. And it's still mighty useful in certain scenarios, not the
+least of which is the job of the distro package maintainer.
+
+Ruby Setup converts setup.rb into a stand-alone application. No longer
+requiring the distribution of the setup.rb script with every Ruby package.
+Just instruct one's users to install Ruby Setup (gem install setup) and go
+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
+
+There a couple very important difference between the old 3.4.1 verison
+of the setup.rb and Ruby Setup.
+
+* The directory convention 'conf' has been change to 'etc'.
+* Multi-package project layouts are no longer supported.
+* Metaconfig and Hooks are handled via singleton extensions.
+* No longer supports versions of Ruby older than v1.6.3.
+* The +setup+ phase has been renamed to the +make+ phase.
+
+=== STATUS
+
+Version 5 is a major re-engineering of setup.rb. Although it is fairly well
+tested, as such, it should be considered betaware until it accumulates
+enough use in the field. I will update this message when I feel a new status
+has been achieved (likely accompanied by an updated release).
+
+
+== INSTALLATION
+
+The easy way to install is via RubyGems.
+
+  $ sudo gem install setup
+
+To install Setup manually you need to "boot-strap" it. Download the tarball,
+and from the decompressed package directory run:
+
+  $ ruby script/setup
+
+
+== HOW TO USE
+
+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
+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.)
+
+Usage is as simple as:
+
+  $ setup.rb
+
+This is the same as using the <tt>all</tt> subcommand.
+
+  $ setup.rb all
+
+And is equivalent to running the three main phases in sequence.
+
+  $ setup.rb config
+  $ setup.rb make
+  $ setup.rb install
+
+Where +config+ determines the configuration of your Ruby distribution,
++make+ compiles any extensions and +install+ copies project files to
+the appropriate places on your system.
+
+Setup.rb also supports two optional phases, +test+ and +document+.
+
+  $ setup.rb test
+
+This will run tests if a test script is provided. If should be run after
++make+, 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 if desired.
+
+The +document+ phase is used to generate ri documentation for a package.
+
+  $ setup.rb document
+
+This generates *ri* documents for the program and automatically
+places the documentation in the appropriate system location. Documenting
+is not part of the default sequence due to the way ri documentation is
+handled by the +rdoc+ tool. It is not possible to uninstall it. So this
+phase must be run seperate from the others. Please only use the +document+
+command when you are ceratin that you want the documentation in your ri
+system. (Hopefully this can be fixed in the near future.)
+
+If you later decide you want to remove a program from your system, use
++uninstall+.
+
+  $ setup.rb uninstall
+
+This will remove all files previously installed via the setup.rb command.
+Uninstalling is made possible by the 'InstalledFiles' 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).
+
+During the make phase, by-product files are generally created.
+You can clean up any of these by-products with:
+
+  $ setup.rb clean
+
+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
+
+Copyright (c) 2002,2005 Minero Aoki
+
+GNU LGPL, Lesser General Public License version 2.1.
+
+For details of LGPL, see the COPYING file.
+
+
+
+                                               7trans
+                                  transfire@gmail.com
+                           http://proutils.github.com
+
+
+                                          Minero Aoki
+                                  aamine@loveruby.net
+                                http://i.loveruby.net
+
+

data/bin/setup.rb

@@ -1,7 +1,3 @@
-#!/usr/bin/env ruby
-
+#! /usr/bin/ruby1.8
 require 'setup/command'
-
 Setup::Command.run
-
-

data/lib/setup.rb

@@ -1,3 +1,3 @@
 module Setup
-  VERSION   = '4.1.1'
-end
+  VERSION   = '5.0.0'
+end

data/lib/setup/base.rb

@@ -0,0 +1,143 @@
+require 'setup/core_ext'
+require 'setup/constants'
+
+module Setup
+
+  # Common base class for all Setup build classes.
+  # 
+  class Base
+
+    #
+    attr :project
+
+    #
+    attr :config
+
+    #
+    attr_accessor :trial
+
+    #
+    attr_accessor :trace
+
+    #
+    attr_accessor :quiet
+
+    #
+    attr_accessor :force
+
+    #
+    attr_accessor :io
+
+    #
+    def initialize(project, configuration, options={})
+      @project = project
+      @config  = configuration
+
+      initialize_hooks
+
+      options.each do |k,v|
+        __send__("#{k}=", v) if respond_to?("#{k}=")
+      end
+    end
+
+    # Hooking into the setup process, use extension scripts
+    # according to the name of the class. For instance to 
+    # augment the behavior of the Installer, use:
+    #
+    #   script/.setup/installer.rb
+    #
+    def initialize_hooks
+      file = META_EXTENSION_DIR + "/#{self.class.name.downcase}.rb"
+      if File.exist?(file)
+        script = File.read(file)
+        (class << self; self; end).class_eval(script)
+      end
+    end
+
+    #
+    def trial? ; @trial ; end
+
+    #
+    def trace? ; @trace ; end
+
+    #
+    def quiet? ; @quiet ; end
+
+    #
+    def force? ; @force ; end
+
+    #
+    def rootdir
+      project.rootdir
+    end
+
+    # Shellout executation.
+    def bash(*args)
+      $stderr.puts args.join(' ') if trace?
+      system(*args) or raise RuntimeError, "system(#{args.map{|a| a.inspect }.join(' ')}) failed"
+    end
+
+    # DEPRECATE
+    alias_method :command, :bash
+
+    # Shellout a ruby command.
+    def ruby(*args)
+      bash(config.rubyprog, *args)
+    end
+
+    # Ask a question of the user.
+    #def ask(question, answers=nil)
+    #  $stdout.puts "#{question}"
+    #  $stdout.puts " [#{answers}] " if answers
+    #  until inp = $stdin.gets ; sleep 1 ; end
+    #  inp.strip
+    #end
+
+    #
+    def trace_off #:yield:
+      begin
+        save, @trace = trace?, false
+        yield
+      ensure
+        @trace = save
+      end
+    end
+
+    # F I L E  U T I L I T I E S
+
+    #
+    def rm_f(path)
+      io.puts "rm -f #{path}" if trace? or trial?
+      return if trial?
+      force_remove_file(path)
+    end
+
+    #
+    def force_remove_file(path)
+      begin
+        remove_file(path)
+      rescue
+      end
+    end
+
+    #
+    def remove_file(path)
+      File.chmod 0777, path
+      File.unlink(path)
+    end
+
+    #
+    def rmdir(path)
+      io.puts "rmdir #{path}" if trace? or trial?
+      return if trial?
+      Dir.rmdir(path)
+    end
+
+  end
+
+  #
+  class Error < StandardError
+  end
+
+end
+