setup 4.1.0 → 4.2.0

data/HISTORY

@@ -0,0 +1,77 @@
+= RELEASE HISTORY
+
+== 4.2.0 / 2009-08-26
+
+This release finally gets rdoc generation and doc installation working.
+Note that rdoc generation is shelled-out at the moment b/c of issues with
+loading the new verison of RDoc vs. the old version included with Ruby
+(which bombs). In the process of doding this, all configuration files
+have now been located in meta/ and meta/setup (or .meta/). See the changes
+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! ;)
+
+
+== 4.1.0 / 2008-11-16
+
+Ruby Setup is a fork or Minero Aokoi's setup.rb script. Whereas setup.rb
+had to be copied into every project that used it, Ruby Setup is a stand
+alone application.
+
+The API is largely the same, with a only few distinctions. Most importantly,
+multi-package support has been removed. Also the underlying system has been
+made more object-oriented. For instance, what was ToplevelInstaller is now
+Setup::Installer. Finally configuration files are saved to .cache/setup and
+metaconfig should be placed in .config/setup, rather then directly into
+the root project directory.
+
+I still consider this and "early" release of Ruby Setup, that is until enough
+people put it through it's paces. However, since it is predominantly
+setup.rb 3.4.1 code, and since it works well enough to install itself ;)
+it certainly is a usable product.
+
+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
+
+
+== 4.0.0 / 2008-08-15
+
+This is the first whack at making setup.rb a stand-alone application.
+
+Changes:
+
+* 3 Other Enhancements
+
+    * Initial checkin.
+

data/MANIFEST

@@ -1,64 +1,31 @@
-doc
-doc/guide
-doc/guide/doc.en
-doc/guide/doc.en/devel.html
-doc/guide/doc.en/usage.html
-doc/guide/doc.en/custom.css
-doc/guide/doc.en/index.html
-doc/guide/doc.en/hookapi.html
-doc/guide/doc.en/metaconfapi.html
-doc/guide/doc.ja
-doc/guide/doc.ja/devel.html
-doc/guide/doc.ja/usage.html
-doc/guide/doc.ja/index.html
-doc/guide/doc.ja/hookapi.html
-doc/guide/doc.ja/news.html
-doc/guide/doc.ja/metaconfapi.html
-doc/assets
-doc/assets/styles
-doc/assets/styles/custom.css
-doc/assets/images
-doc/assets/images/setup.png
-doc/assets/images/setup-small.png
-doc/note
-doc/note/changelog-3.4.1.txt
-doc/note/TODO
-doc/note/release-4.0.0.txt
-doc/note/news.html
-doc/index.html
-doc/log
-doc/log/stats.log
-doc/log/notes.xml
-doc/log/bstats
-doc/log/bstats/stats.html
-doc/log/syntax.log
-doc/log/testunit.log
+COPYING
+HISTORY
 MANIFEST
-test
-test/test_installer.rb
-CHANGES
-RELEASE
 README
-meta
-meta/created
-meta/homepage
-meta/summary
-meta/abstract
-meta/authors
-meta/contact
-task
-task/install
+RELEASE
+bin
+bin/setup.rb
 lib
-lib/setup.rb
 lib/setup
-lib/setup/install.rb
-lib/setup/rake.rb
-lib/setup/command.rb
+lib/setup.rb
 lib/setup/build.rb
+lib/setup/command.rb
 lib/setup/config.rb
-lib/setup/rubyver.rb
 lib/setup/error.rb
-VERSION
-bin
-bin/setup.rb
-COPYING
+lib/setup/install.rb
+lib/setup/rake.rb
+lib/setup/rubyver.rb
+meta
+meta/abstract
+meta/authors
+meta/contact
+meta/created
+meta/homepage
+meta/package
+meta/released
+meta/setup
+meta/setup/metaconfig.rb
+meta/summary
+meta/version
+test
+test/test_installer.rb

data/lib/setup.rb

@@ -1,5 +1,3 @@
 module Setup
-  VERSION = '4.1.0'
-  COPYRIGHT = 'Copyright (c) 2002,2008 Minero Aoki & Thomas Sawyer'
-end
-
+  VERSION   = '4.1.1'
+end

data/lib/setup/command.rb

@@ -1,35 +1,38 @@
 require 'setup/config'
 require 'setup/build'
 require 'setup/install'
+require 'setup/error'
 
 module Setup
 
-  # CLI for setup.
-  #
+  # CLI for Setup.rb
   class Command
 
     TASKS = %w(all config show setup test install uninstall rdoc ri clean distclean)
 
     TASK_DESCRIPTIONS = [
-      [ 'all',      'do config, setup, then install' ],
-      [ 'config',   'saves your configurations' ],
-      [ 'show',     'shows current configuration' ],
-      [ 'setup',    'compiles ruby extentions and others' ],
-      [ 'rdoc',     'generate rdoc documentation' ],
-      [ 'ri',       'generate ri documentation' ],
-      [ 'install',  'installs files' ],
-      [ 'test',     'run all tests in test/' ],
-      [ 'clean',    "does `make clean' for each extention" ],
-      [ 'distclean',"does `make distclean' for each extention" ]
+      [ 'all',       "do config, setup, then install" ],
+      [ 'config',    "saves your configurations" ],
+      [ 'show',      "shows current configuration" ],
+      [ 'setup',     "compiles ruby extentions and others" ],
+      [ 'rdoc',      "generate rdoc documentation" ],
+      [ 'ri',        "generate ri documentation" ],
+      [ 'install',   "installs files" ],
+      [ 'uninstall', "uninstalls files" ],
+      [ 'test',      "run all tests in test/" ],
+      [ 'clean',     "does `make clean' for each extention" ],
+      [ 'distclean', "does `make distclean' for each extention" ]
     ]
 
     #
-    def self.run
-      new.run
+    def self.run(*argv)
+      new.run(*argv)
     end
 
     #
-    def run
+    def run(*argv)
+      ARGV.replace(argv) unless argv.empty?
+
       config    = ConfigTable.new
       installer = Installer.new(config)
 
@@ -89,11 +92,11 @@ module Setup
         installer.verbose = val
       end
 
-      opts.on("-n", "--no-write", "Do not write to disk") do |val|
+      opts.on("--no-write", "Do not write to disk") do |val|
         installer.no_harm = !val
       end
 
-      opts.on("--dryrun", "Same as --no-write") do |val|
+      opts.on("-n", "--dryrun", "Same as --no-write") do |val|
         installer.no_harm = val
       end
 
@@ -126,7 +129,7 @@ module Setup
 
       begin
         installer.__send__("exec_#{task}")
-      rescue SetupError
+      rescue Error
         raise if $DEBUG
         $stderr.puts $!.message
         $stderr.puts "Try 'ruby #{$0} --help' for detailed usage."
@@ -134,9 +137,9 @@ module Setup
       end
     end
 
-    # Generate help text.
+    # Generate help text
     def help
-      fmt = " " * 10 + "%-10s       %s"
+    fmt = " " * 10 + "%-10s       %s"
       commands = TASK_DESCRIPTIONS.collect do |k,d|
         (fmt % ["#{k}", d])
       end.join("\n").strip
@@ -164,11 +167,8 @@ module Setup
             -n --no-write                 Do not write to disk
 
       END
-
       text.gsub(/^ \ \ \ \ \ /, '')
     end
 
   end
-
 end
-

data/lib/setup/config.rb

@@ -34,8 +34,8 @@ module Setup
       [:rubyprog        , :prog, 'ruby program used for installation'],
       [:makeprog        , :prog, 'make program to compile ruby extentions'],
       [:extconfopt      , :name, 'options to pass-thru to extconf.rb'],
-      [:without_ext     , :bool, 'do not compile/install ruby extentions'],
-      [:without_doc     , :bool, 'do not generate html documentation'],
+      [:withoutext      , :bool, 'do not compile/install ruby extentions'],
+      [:withoutdoc      , :bool, 'do not generate documentation'],
       [:shebang         , :pick, 'shebang line (#!) editing mode (all,ruby,never)'],
       [:doctemplate     , :pick, 'document template to use (html|xml)'],
       [:testrunner      , :pick, 'Runner to use for testing (auto|console|tk|gtk|gtk2)'],
@@ -53,10 +53,10 @@ module Setup
           @#{name}.gsub(%r<\\$([^/]+)>){ self[$1] }
         end
         def #{name}=(path)
-          raise SetupError, "bad config: #{name.to_s.upcase} requires argument" unless path
+          raise Error, "bad config: #{name.to_s.upcase} requires argument" unless path
           @#{name} = (path[0,1] == '$' ? path : File.expand_path(path))
         end
-      }   
+      }
     end
 
     # List of pathnames. These are not expanded though.
@@ -73,7 +73,7 @@ module Setup
             @#{name} = pathlist.to_s.split(/[:;,]/)
           end
         end
-      }   
+      }
     end
 
     # Adds boolean support.
@@ -102,7 +102,7 @@ module Setup
               when 'n', 'no', 'f', 'false'
                  @#{name} = false
               else
-                raise SetupError, "bad config: use #{name.upcase}=(yes|no) [\#{val}]"
+                raise Error, "bad config: use #{name.upcase}=(yes|no) [\#{val}]"
               end
             end
           end
@@ -133,7 +133,7 @@ module Setup
       if %w(all ruby never).include?(val)
         @shebang = val
       else
-        raise SetupError, "bad config: use SHEBANG=(all|ruby|never) [#{val}]"
+        raise Error, "bad config: use SHEBANG=(all|ruby|never) [#{val}]"
       end
     end
 
@@ -148,12 +148,12 @@ module Setup
         self.rbdir = '$siterubyver'
         self.sodir = '$siterubyverarch'
       when 'home'
-        raise SetupError, 'HOME is not set.' unless ENV['HOME']
+        raise Error, 'HOME is not set.' unless ENV['HOME']
         self.prefix = ENV['HOME']
         self.rbdir = '$libdir/ruby'
         self.sodir = '$libdir/ruby'
       else
-        raise SetupError, "bad config: use INSTALLDIRS=(std|site|home|local) [#{val}]"
+        raise Error, "bad config: use INSTALLDIRS=(std|site|home|local) [#{val}]"
       end
     end
 
@@ -270,10 +270,10 @@ module Setup
       self.makeprog        = makeprog
       self.extconfopt      = ''
       self.shebang         = 'ruby'
-      self.without_ext     = 'no'
-      self.without_doc     = 'yes'
-      self.doctemplate     = 'html'
-      self.testrunner      = 'auto'
+      self.withoutext      = 'no'
+      self.withoutdoc      = 'no'
+      self.doctemplate     = nil
+      self.testrunner      = 'auto' # needed?
       self.installdirs     = 'site'
     end
 
@@ -296,7 +296,7 @@ module Setup
             __send__("#{k}=",v.strip) #self[k] = v.strip
           end
         rescue Errno::ENOENT
-          raise SetupError, $!.message + "\n#{File.basename($0)} config first"
+          raise Error, $!.message + "\n#{File.basename($0)} config first"
         end
       #end
     end
@@ -330,7 +330,6 @@ module Setup
     end
 
     #
-
     def extconfs
       @extconfs ||= Dir['ext/**/extconf.rb']
     end
@@ -362,7 +361,7 @@ module Setup
 
     # Metaconfig file is '.config/setup/metaconfig{,.rb}'.
     def load_meta_config
-      path = Dir.glob('.config/setup/metaconfig{,.rb}').first 
+      path = Dir.glob('.config/setup/metaconfig{,.rb}').first
       if path && File.file?(path)
         MetaConfigEnvironment.new(self).instance_eval(File.read(path), path)
       end

data/lib/setup/error.rb

@@ -1 +1,4 @@
-class SetupError < StandardError; end
+module Setup
+  class Error < StandardError; end
+end
+

data/lib/setup/install.rb

@@ -1,18 +1,32 @@
 require 'optparse'
 require 'setup/config'
 
-# TODO: we need to abort install if tests fail (how?)
-#       We will also need to add a force install option then.
-# TODO: Need to get name setting from where?
-# TODO: Add support for rdoc once project name issue is worked out. (see RDOC HERE.)
-# TODO: Generate rdocs? Package developer may want to deactivate this.
+# TODO: we need to abort install if tests fail (check return code of TESTER)
+#       We will also need to add a force install option then to by pass failed tests.
+#
+# TODO: Generate rdocs... Package developer may want to deactivate this. How?
+#
+# TODO: Should be using Rdoc programmatically, but load issue arose and an error
+#       was being generated on ri generation. Reverting back to shelling out for now.
+
+# The name of the package, used to install docs in system doc/ruby-{name}/ location.
+# The information must be provided in a file called meta/package.
+PACKAGE =(
+  if file = Dir["{meta,.meta}/package"].first
+    File.read(file).strip
+  else
+    nil
+  end
+)
+
+# A ruby script that instructs setup how to run tests, located at meta/setup/test.rb
+# If the tests fail, the script should exit with a fail status (eg. -1).
+TESTER = Dir.glob('{meta,.meta}/setup/test{,rc}.rb', File::FNM_CASEFOLD).first
 
-# Need the package name. This is used to install docs in system doc/ruby-{name}/ location.
-PACKAGE_NAME = ""
+# A ruby script that instructs setup how to generate docs, located at meta/setup/doc.rb
+# NOTE: Docs must be generate into the doc/ for them to be installed.
+DOCTOR = Dir.glob('{meta,.meta}/setup/doc{,rc}.rb', File::FNM_CASEFOLD).first
 
-#--
-#File.read(Dir.glob('{.,meta/}unixname{,.txt}', File::FNM_CASEFOLD).first).strip
-#++
 
 module Setup
 
@@ -46,13 +60,14 @@ module Setup
       @objdir = File.expand_path(objroot)
       @currdir = '.'
 
-      self.quiet   = ENV['quiet'] if ENV['quiet']
+      self.quiet   = ENV['quiet']   if ENV['quiet']
       self.verbose = ENV['verbose'] if ENV['verbose']
       self.no_harm = ENV['nowrite'] if ENV['nowrite']
 
       yield(self) if block_given?
     end
 
+    #
     def inspect
       "#<#{self.class} #{File.basename(@srcdir)}>"
     end
@@ -167,10 +182,7 @@ module Setup
     ##
     # TASK setup
     #
-    # FIXME: Update shebang at time of install not before.
-    # for now I've commented out the shebang.
-    #
-
+    # FIXME: Update shebang on install rather than before.
     def exec_setup
       report_header('setup')
       exec_task_traverse 'setup'
@@ -179,7 +191,7 @@ module Setup
 
     def setup_dir_bin(rel)
       files_of(curr_srcdir()).each do |fname|
-        #update_shebang_line "#{curr_srcdir()}/#{fname}"  # HERE
+        update_shebang_line "#{curr_srcdir()}/#{fname}"  # MOVE TO INSTALL (BUT HOW?)
       end
     end
 
@@ -274,18 +286,17 @@ module Setup
     #
     # Complexities arise in trying to figure out what test framework
     # is used, and how to run tests. To simplify the process, this
-    # method simply looks for a script, either '.config/setup/testrc.rb',
-    # or 'script/test' or 'task/test' and runs it if found.
+    # simply looks for a script in meta/setup called testrc.rb,
+    # or just test.rb.
     #
     def exec_test
       return if install_no_test
-      file   = nil
-      file ||= Dir.glob('.config/setup/test{,rc}{,.rb}', File::FNM_CASEFOLD).first
-      file ||= Dir.glob('{script,task}/test', File::FNM_CASEFOLD).first
+      file = TESTER
       if file
         report_header('test')
         ruby(file)
       end
+      #puts "Ok." unless quiet?
     end
 
     ### DEPRECATED
@@ -338,50 +349,76 @@ module Setup
 
     ##
     # TASK doc
-    #
-    # NOT USED YET.
 
     def exec_doc
-      return if config.without_doc?
+      return if config.withoutdoc?
       report_header('doc')
-      #exec_rdoc   unless config.without_doc?  # RDOC HERE
-      exec_ri      
+      if file = DOCTOR
+        ruby(file)
+      else
+        exec_rdoc
+      end
+      exec_ri
     end
 
     # Generate rdocs.
-
+    #
+    # NOT USED YET B/C WE WOULD HAVE TO KNOW THE NAME OF THE PROJECT
+    # TO DO THIS CORRECTLY. (WHERE DO WE GET THAT?)
+    #
+    # Answer: meta/package or .meta/package
+    #
     def exec_rdoc
-      output    = File.join('doc', 'rdoc')
-      title     = (PACKAGE_NAME.capitalize + " API").strip
-      main      = Dir.glob("README{,.txt}", File::FNM_CASEFOLD).first
-      template  = config.doctemplate || 'html'
-
-      opt = []
-      opt << "-U"
-      opt << "-S"
-      opt << "--op=#{output}"
-      opt << "--template=#{template}"
-      opt << "--title=#{title}"
-      opt << "--main=#{main}"     if main
+      main = Dir.glob("README{,.*}", File::FNM_CASEFOLD).first
 
       if File.exist?('.document')
         files = File.read('.document').split("\n")
         files.reject!{ |l| l =~ /^\s*[#]/ || l !~ /\S/ }
         files.collect!{ |f| f.strip }
-        opt << files
       else
-        opt << main               if main
-        opt << ["lib", "ext"]
+        files = []
+        files << main  if main
+        files << 'lib' if File.directory?('lib')
+        files << 'ext' if File.directory?('ext')
       end
 
+      checkfiles = (files + files.map{ |f| Dir[File.join(f,'*','**')] }).flatten.uniq
+      if FileUtils.uptodate?('doc/rdoc', checkfiles)
+        puts "RDocs look uptodate."
+        return
+      end
+
+      output    = 'doc/rdoc'
+      title     = (PACKAGE.capitalize + " API").strip
+      template  = config.doctemplate || 'html'
+
+      opt = []
+      opt << "-U"
+      opt << "-q" #if quiet?
+      opt << "--op=#{output}"
+      #opt << "--template=#{template}"
+      opt << "--title=#{title}"
+      opt << "--main=#{main}"     if main
+      #opt << "--debug"
+      opt << files
+
       opt = opt.flatten
 
+      cmd = "rdoc " + opt.join(' ')
+
       if no_harm?
-        puts "rdoc " + opt.join(' ').strip
+        puts cmd 
       else
-        #sh "rdoc {opt.join(' ').strip}"
-        require 'rdoc/rdoc'
-        ::RDoc::RDoc.new.document(opt)
+        begin
+          system(cmd)
+          #require 'rdoc/rdoc'
+          #::RDoc::RDoc.new.document(opt)
+          puts "Ok rdoc." unless quiet?
+        rescue Exception
+          puts "Fail rdoc."
+          puts "Command was: '#{cmd}'"
+          puts "Proceeding with install anyway."
+        end
       end
     end
 
@@ -404,30 +441,43 @@ module Setup
         files.reject!{ |l| l =~ /^\s*[#]/ || l !~ /\S/ }
         files.collect!{ |f| f.strip }
       else
-        files = ["lib", "ext"]
+        files = []
+        files << 'lib' if File.directory?('lib')
+        files << 'ext' if File.directory?('ext')
       end
 
       opt = []
       opt << "-U"
+      opt << "-q" #if quiet?
+      #opt << "-D" #if $DEBUG
       opt << output
       opt << files
+
       opt = opt.flatten
 
+      cmd = "rdoc " + opt.join(' ')
+
       if no_harm?
-        puts "rdoc #{opt.join(' ').strip}"
+        puts cmd
       else
         # Generate in system location specified
-        #sh "rdoc #{opt.join(' ').strip}"
-        require 'rdoc/rdoc'
-        ::RDoc::RDoc.new.document(opt)
-
+        begin
+          system(cmd)
+          #require 'rdoc/rdoc'
+          #::RDoc::RDoc.new.document(opt)
+          puts "Ok ri." unless quiet?
+        rescue Exception
+          puts "Fail ri."
+          puts "Command was: '#{cmd}'"
+          puts "Proceeding with install anyway."
+        end
         # Now in local directory
-        opt = []
-        opt << "-U"
-        opt << "--ri --op 'doc/ri'"
-        opt << files
-        opt = opt.flatten
-        ::RDoc::RDoc.new.document(opt)
+        #opt = []
+        #opt << "-U"
+        #opt << "--ri --op 'doc/ri'"
+        #opt << files
+        #opt = opt.flatten
+        #::RDoc::RDoc.new.document(opt)
       end
     end
 
@@ -473,15 +523,12 @@ module Setup
 
     # doc installs to directory named: "ruby-#{package}"
     def install_dir_doc(rel)
-      return if config.without_doc?
-      dir = "#{config.docdir}/ruby-#{PACKAGE_NAME}/#{rel}" # "#{config.docdir}/#{rel}"
+      return if config.withoutdoc?
+      return unless PACKAGE
+      dir = "#{config.docdir}/ruby-#{PACKAGE}/#{rel}" # "#{config.docdir}/#{rel}"
       install_files targetfiles(), dir, 0644
     end
 
-    # doc installs to directory named: "ruby-#{package}"
-    def install_dir_doc(rel)
-    end
-
     def install_files(list, dest, mode)
       mkdir_p dest, install_prefix
       list.each do |fname|
@@ -519,7 +566,7 @@ module Setup
     end
 
     # picked up many entries from cvs-1.11.1/src/ignore.c
-    JUNK_FILES = %w( 
+    JUNK_FILES = %w(
       core RCSLOG tags TAGS .make.state
       .nse_depinfo #* .#* cvslog.* ,* .del-* *.olb
       *~ *.old *.bak *.BAK *.orig *.rej _$* *$
@@ -568,9 +615,24 @@ module Setup
       paths = File.read(MANIFEST).split("\n")
       dirs, files = paths.partition{ |f| File.dir?(f) }
 
-      files.each do |file|
+      remove = []
+      files.uniq.each do |file|
         next if /^\#/ =~ file  # skip comments
-        rm_f(file) if File.exist?(file)
+        remove << file if File.exist?(file)
+      end
+
+      if verbose? && !no_harm?
+        puts remove.collect{ |f| "rm #{f}" }.join("\n")
+        ans = ask("Continue?", "yN")
+        case ans
+        when 'y', 'Y', 'yes'
+        else
+          return # abort?
+        end
+      end
+
+      remove.each do |file|
+        rm_f(file)
       end
 
       dirs.each do |dir|
@@ -645,7 +707,7 @@ module Setup
     def exec_task_traverse(task)
       run_hook "pre-#{task}"
       FILETYPES.each do |type|
-        if type == 'ext' and config.without_ext == 'yes'
+        if type == 'ext' and config.withoutext? #== 'yes'
           $stderr.puts 'skipping ext/* by user option' if verbose?
           next
         end
@@ -866,6 +928,14 @@ module Setup
       }
     end
 
+    # Ask a question of the user.
+    def ask(question, answers=nil)
+      $stdout << "#{question}"
+      $stdout << " [#{answers}] " if answers
+      until inp = $stdin.gets ; sleep 1 ; end
+      inp.strip
+    end
+
     ##
     # Hook Script API
     #
@@ -885,7 +955,7 @@ module Setup
 
     # srcdir/objdir (works only in the package directory)
     #
-    # TODO: Since package directory has been deprecated these 
+    # TODO: Since package directory has been deprecated these
     # probably can be worked out of the system. ?
 
     #