setup 4.0.0 → 4.1.0

data/doc/{manual/doc.en → note}/news.html

@@ -1,3 +1,5 @@
+<div id="content">
+
 <h1>NEWS</h1>
 <h2>3.4.1 (2005-11-20)</h2>
 <ul>
@@ -187,3 +189,6 @@ install.rb/setup.rb from source file.</li>
 <ul>
 <li>first release</li>
 </ul>
+
+</div>
+

data/doc/note/release-4.0.0.txt

@@ -0,0 +1,26 @@
+= NEWS
+
+== 4.1.0 // 2008-09-06
+
+Change the location of the cache files to .cache/setup/.
+
+
+== 4.0.0 // 2008-08-16
+
+This is the initial release of Setup. As such it is
+getting the label "betaware" until enough people put
+it through it's paces. However, since it is predominantly
+setup.rb 3.4.1 code, and that it works to install 
+itself ;) it certainly is a usable product.
+
+Please report any problems so we can fix them ASAP.
+
+Currently Setup does not support Aoki's Metaconfig API.
+It's usefulness seems limited to me, but we can 
+reconsider adding it back in a furture version.
+
+Multi-package support has also been removed.
+
+--
+Website: http://setup.rubyforge.org
+

data/lib/setup.rb

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

data/lib/setup/command.rb

@@ -30,7 +30,8 @@ module Setup
 
     #
     def run
-      installer = Setup::Installer.new
+      config    = ConfigTable.new
+      installer = Installer.new(config)
 
       task = ARGV.find{ |a| a !~ /^[-]/ }
       task = 'all' unless task
@@ -40,14 +41,14 @@ module Setup
         exit 1
       end
 
-      opts = OptionParser.new
+      opts   = OptionParser.new
 
       opts.banner = "Usage: #{File.basename($0)} [task] [options]"
 
       if task == 'config' or task == 'all'
         opts.separator ""
-        opts.separator "Config options:"   
-        ConfigTable::DESCRIPTIONS.each do |name, type, desc|
+        opts.separator "Config options:"
+        config.descriptions.each do |name, type, desc|
           opts.on("--#{name} #{type.to_s.upcase}", desc) do |val|
             ENV[name.to_s] = val.to_s
           end
@@ -61,17 +62,21 @@ module Setup
         opts.on("--prefix PATH", "Installation prefix") do |val|
           installer.install_prefix = val
         end
-      end
 
-      if task == 'test'
-        opts.separator ""
-        opts.separator "Install options:"
-
-        opts.on("--runner TYPE", "Test runner (auto|console|gtk|gtk2|tk)") do |val|
-          installer.config.testrunner = val
+        opts.on("--no-test", "Do not run tests") do |val|
+          installer.install_no_test = true
         end
       end
 
+      #if task == 'test'
+      #  opts.separator ""
+      #  opts.separator "Install options:"
+      #
+      #  opts.on("--runner TYPE", "Test runner (auto|console|gtk|gtk2|tk)") do |val|
+      #    installer.config.testrunner = val
+      #  end
+      #end
+
       # common options
       opts.separator ""
       opts.separator "General options:"

data/lib/setup/config.rb

@@ -1,4 +1,5 @@
 require 'rbconfig'
+require 'fileutils'
 require 'setup/rubyver'
 require 'setup/error'
 
@@ -10,7 +11,7 @@ module Setup
 
     RBCONFIG  = ::Config::CONFIG
 
-    CONFIGFILE = '.config'
+    CONFIGFILE = '.cache/setup/config'
 
     DESCRIPTIONS = [
       [:prefix          , :path, 'path prefix of target environment'],
@@ -30,7 +31,7 @@ module Setup
       [:rbdir           , :path, 'directory for ruby scripts'],
       [:sodir           , :path, 'directory for ruby extentions'],
       [:rubypath        , :prog, 'path to set to #! line'],
-      [:rubyprog        , :prog, 'ruby program using for installation'],
+      [: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'],
@@ -110,16 +111,16 @@ module Setup
       end
     end
 
-    DESCRIPTIONS.each do |k,t,d|
-      case t
-      when :path
-        attr_pathname k
-      when :bool
-        attr_boolean k
-      else
-        attr_accessor k
-      end
-    end
+    #DESCRIPTIONS.each do |k,t,d|
+    #  case t
+    #  when :path
+    #    attr_pathname k
+    #  when :bool
+    #    attr_boolean k
+    #  else
+    #    attr_accessor k
+    #  end
+    #end
 
     # # provide verbosity (default is true)
     # attr_accessor :verbose?
@@ -158,6 +159,7 @@ module Setup
 
     # New ConfigTable
     def initialize(values=nil)
+      initialize_attributes
       initialize_defaults
       if values
         values.each{ |k,v| __send__("#{k}=", v) }
@@ -166,9 +168,33 @@ module Setup
       load_config if File.file?(CONFIGFILE)
     end
 
+    #
+    def initialize_attributes
+      load_meta_config
+      desc = descriptions
+      (class << self; self; end).class_eval do
+        desc.each do |k,t,d|
+          case t
+          when :path
+              attr_pathname k
+          when :bool
+            attr_boolean k
+          else
+            attr_accessor k
+          end
+        end
+      end
+    end
+
+    #
+    def descriptions
+      @descriptions ||= DESCRIPTIONS
+    end
+
     # Assign CONFIG defaults
     #
     # TODO: Does this handle 'nmake' on windows?
+    #
     def initialize_defaults
       prefix = RBCONFIG['prefix']
 
@@ -277,6 +303,7 @@ module Setup
 
     # Save configuration.
     def save_config
+      FileUtils.mkdir_p(File.dirname(CONFIGFILE))
       File.open(CONFIGFILE, 'w') do |f|
         OPTIONS.each do |name|
           val = self[name]
@@ -333,7 +360,94 @@ module Setup
     #  self[name].gsub(%r<\\$([^/]+)>){ self[$1] }
     #end
 
-  end
+    # Metaconfig file is '.config/setup/metaconfig{,.rb}'.
+    def load_meta_config
+      path = Dir.glob('.config/setup/metaconfig{,.rb}').first 
+      if path && File.file?(path)
+        MetaConfigEnvironment.new(self).instance_eval(File.read(path), path)
+      end
+    end
+
+    #= Meta Configuration
+    # This works a bit differently from 3.4.1.
+    # Defaults are currently not supported but remain in the method interfaces.
+    class MetaConfigEnvironment
+      def initialize(config) #, installer)
+        @config    = config
+        #@installer = installer
+      end
+
+      #
+      def config_names
+        @config.descriptions.collect{ |n, t, d| n.to_s }
+      end
+
+      #
+      def config?(name)
+        @config.descriptions.find do |sym, type, desc|
+          sym.to_s == name.to_s
+        end
+      end
+
+      #
+      def bool_config?(name)
+        @config.descriptions.find do |sym, type, desc|
+          sym.to_s == name.to_s && type == :bool
+        end
+        #@config.lookup(name).config_type == 'bool'
+      end
+
+      #
+      def path_config?(name)
+        @config.descriptions.find do |sym, type, desc|
+          sym.to_s == name.to_s && type == :path
+        end
+        #@config.lookup(name).config_type == 'path'
+      end
+
+      #
+      def value_config?(name)
+        @config.descriptions.find do |sym, type, desc|
+          sym.to_s == name.to_s && type != :prog
+        end
+        #@config.lookup(name).config_type != 'exec'
+      end
+
+      #
+      def add_config(name, default, desc)
+        @config.descriptions << [name.to_sym, nil, desc]
+        #@config.add item
+      end
+
+      #
+      def add_bool_config(name, default, desc)
+        @config.descriptions << [name.to_sym, :bool, desc]
+        #@config.add BoolItem.new(name, 'yes/no', default ? 'yes' : 'no', desc)
+      end
+
+      #
+      def add_path_config(name, default, desc)
+        @config.descriptions << [name.to_sym, :path, desc]
+        #@config.add PathItem.new(name, 'path', default, desc)
+      end
+
+      #
+      def set_config_default(name, default)
+        @config[name] = default
+      end
+
+      #
+      def remove_config(name)
+        item = @config.descriptions.find do |sym, type, desc|
+          sym.to_s == name.to_s
+        end
+        index = @config.descriptions.index(item)
+        @config.descriptions.delete(index)
+        #@config.remove(name)
+      end
+    end
+
+  end #class ConfigTable
 
-end
+end #module Setup
 

data/lib/setup/install.rb

@@ -21,7 +21,7 @@ module Setup
 
   class Installer
 
-    MANIFEST  = '.installedfiles'
+    MANIFEST  = '.cache/setup/installedfiles'
 
     FILETYPES = %w( bin lib ext data etc man doc )
 
@@ -33,13 +33,14 @@ module Setup
     attr_writer :quiet
 
     attr_accessor :install_prefix
+    attr_accessor :install_no_test
 
     # New Installer.
-    def initialize #:yield:
+    def initialize(config=nil) #:yield:
       srcroot = '.'
       objroot = '.'
 
-      @config = ConfigTable.new
+      @config = config || ConfigTable.new
 
       @srcdir = File.expand_path(srcroot)
       @objdir = File.expand_path(objroot)
@@ -60,9 +61,9 @@ module Setup
     def installation?; @installation; end
     def installation!; @installation = true; end
 
-    def no_harm?; @no_harm; end
-    def verbose?; @verbose; end
-    def quiet?; @quiet; end
+    def no_harm? ; @no_harm ; end
+    def verbose? ; @verbose ; end
+    def quiet?   ; @quiet   ; end
 
     def verbose_off #:yield:
       begin
@@ -98,7 +99,7 @@ module Setup
     #
     def noop(rel); end
 
-    #
+    ##
     # Hook Script API bases
     #
 
@@ -114,19 +115,19 @@ module Setup
       @currdir
     end
 
-    #
+    ##
     # Task all
     #
 
     def exec_all
       exec_config
       exec_setup
-      exec_test     # TODO: stop here if fail (?)
+      exec_test
       exec_doc
       exec_install
     end
 
-    #
+    ##
     # TASK config
     #
 
@@ -155,7 +156,7 @@ module Setup
       ruby "#{curr_srcdir()}/extconf.rb", config.extconfopt
     end
 
-    #
+    ##
     # TASK show
     #
 
@@ -163,7 +164,7 @@ module Setup
       config.show
     end
 
-    #
+    ##
     # TASK setup
     #
     # FIXME: Update shebang at time of install not before.
@@ -268,60 +269,77 @@ module Setup
       end
     end
 
-    #
+    ##
     # TASK test
     #
-    # TODO: Add spec support.
-
+    # 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.
+    #
     def exec_test
-      report_header('test')
-      runner = config.testrunner
-      case runner
-      when 'testrb'  # TODO: needs work
-        opt = []
-        opt << " -v" if verbose?
-        opt << " --runner #{runner}"
-        if File.file?('test/suite.rb')
-          notests = false
-          opt << "test/suite.rb"
-        else
-          notests = Dir["test/**/*.rb"].empty?
-          lib = ["lib"] + config.extensions.collect{ |d| File.dirname(d) }
-          opt << "-I" + lib.join(':')
-          opt << Dir["test/**/{test,tc}*.rb"]
-        end
-        opt = opt.flatten.join(' ').strip
-        # run tests
-        if notests
-          $stderr.puts 'no test in this package' if verbose?
-        else
-          cmd = "testrb #{opt}"
-          $stderr.puts cmd if verbose?
-          system cmd  #config.ruby "-S tesrb", opt
-        end
-      else # autorunner
-        unless File.directory?('test')
-          $stderr.puts 'no test in this package' if verbose?
-          return
-        end
-        begin
-          require 'test/unit'
-        rescue LoadError
-          setup_rb_error 'test/unit cannot loaded.  You need Ruby 1.8 or later to invoke this task.'
-        end
-        autorunner = Test::Unit::AutoRunner.new(true)
-        autorunner.to_run << 'test'
-        autorunner.run
+      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
+      if file
+        report_header('test')
+        ruby(file)
       end
     end
 
+    ### DEPRECATED
+    #def exec_test
+      #runner = config.testrunner
+      #case runner
+      #when 'testrb'  # TODO: needs work
+      #  opt = []
+      #  opt << " -v" if verbose?
+      #  opt << " --runner #{runner}"
+      #  if File.file?('test/suite.rb')
+      #    notests = false
+      #    opt << "test/suite.rb"
+      #  else
+      #    notests = Dir["test/**/*.rb"].empty?
+      #    lib = ["lib"] + config.extensions.collect{ |d| File.dirname(d) }
+      #    opt << "-I" + lib.join(':')
+      #    opt << Dir["test/**/{test,tc}*.rb"]
+      #  end
+      #  opt = opt.flatten.join(' ').strip
+      #  # run tests
+      #  if notests
+      #    $stderr.puts 'no test in this package' if verbose?
+      #  else
+      #    cmd = "testrb #{opt}"
+      #    $stderr.puts cmd if verbose?
+      #    system cmd  #config.ruby "-S testrb", opt
+      #  end
+      #else # autorunner
+      #  unless File.directory?('test')
+      #    $stderr.puts 'no test in this package' if verbose?
+      #    return
+      #  end
+      #  begin
+      #    require 'test/unit'
+      #  rescue LoadError
+      #    setup_rb_error 'test/unit cannot loaded.  You need Ruby 1.8 or later to invoke this task.'
+      #  end
+      #  lib = ["lib"] + config.extensions.collect{ |d| File.dirname(d) }
+      #  lib.each{ |l| $LOAD_PATH << l }
+      #  autorunner = Test::Unit::AutoRunner.new(true)
+      #  autorunner.to_run << 'test'
+      #  autorunner.run
+      #end
+    #end
+
     # MAYBE: We could traverse and run each test independently (?)
     #def test_dir_test
     #end
 
+    ##
+    # TASK doc
     #
-    #
-    #
+    # NOT USED YET.
 
     def exec_doc
       return if config.without_doc?
@@ -330,9 +348,7 @@ module Setup
       exec_ri      
     end
 
-    # TASK rdoc
-    #
-    # NOTE USED YET.
+    # Generate rdocs.
 
     def exec_rdoc
       output    = File.join('doc', 'rdoc')
@@ -369,7 +385,7 @@ module Setup
       end
     end
 
-    # TASK ri
+    # Generate ri documentation.
 
     def exec_ri
       case config.installdirs
@@ -415,7 +431,7 @@ module Setup
       end
     end
 
-    #
+    ##
     # TASK install
     #
 
@@ -544,7 +560,7 @@ module Setup
       })\z/
     end
 
-    #
+    ##
     # TASK uninstall
     #
 
@@ -574,7 +590,7 @@ module Setup
       rm_f(MANIFEST)
     end
 
-    #
+    ##
     # TASK clean
     #
 
@@ -596,7 +612,7 @@ module Setup
       make 'clean' if File.file?('Makefile')
     end
 
-    #
+    ##
     # TASK distclean
     #
 
@@ -622,7 +638,7 @@ module Setup
       #rm_rf('rdoc') if File.directory?('rdoc')  # RDOC HERE
     end
 
-    #
+    ##
     # Traversing
     #
 
@@ -649,6 +665,7 @@ module Setup
       }
     end
 
+    #
     def dive_into(rel)
       return unless File.dir?("#{@srcdir}/#{rel}")
 
@@ -664,6 +681,7 @@ module Setup
       @currdir = File.dirname(rel)
     end
 
+    #
     def run_hook(id)
       path = [ "#{curr_srcdir()}/#{id}",
                "#{curr_srcdir()}/#{id}.rb" ].detect {|cand| File.file?(cand) }
@@ -676,6 +694,7 @@ module Setup
       end
     end
 
+    ##
     # File Operations
     #
     # This module requires: #verbose?, #no_harm?
@@ -804,6 +823,7 @@ module Setup
     end
 
     def record_installation(path)
+      FileUtils.mkdir_p(File.dirname("#{objdir_root()}/#{MANIFEST}"))
       File.open("#{objdir_root()}/#{MANIFEST}", 'a') do |f|
         f.puts(path)
       end
@@ -846,7 +866,7 @@ module Setup
       }
     end
 
-    #
+    ##
     # Hook Script API
     #
     # These require: #srcdir_root, #objdir_root, #relpath
@@ -854,7 +874,7 @@ module Setup
 
     #
     def get_config(key)
-      config.__send__(key)
+      config[key]
     end
 
     # obsolete: use metaconfig to change configuration
@@ -863,10 +883,12 @@ module Setup
       config[key] = val
     end
 
-    #
     # srcdir/objdir (works only in the package directory)
     #
+    # TODO: Since package directory has been deprecated these 
+    # probably can be worked out of the system. ?
 
+    #
     def curr_srcdir
       "#{srcdir_root()}/#{relpath()}"
     end