reap 9.3.5 → 9.4.0

data/meta/version

@@ -0,0 +1 @@
+9.4.0 beta (2008-04-02)

data/setup.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+
 # Setup.rb v3.5.0
 # Copyright (c) 2008 Minero Aoki, Trans
 #
@@ -6,9 +7,11 @@
 # You can distribute/modify this program under the terms of
 # the GNU LGPL, Lesser General Public License version 2.1.
 
-# Need the package name, and whether to generate documentation.
-PACKAGE = File.read(Dir.glob('{.,meta/}unixname{,.txt}', File::FNM_CASEFOLD).first).strip
-GENERATE_RDOCS = true # package developer may need to deactivate
+# Need the package name. This is used to install docs in system doc/ruby-{name}/ location.
+PACKAGE_NAME = File.read(Dir.glob('{.,meta/}unixname{,.txt}', File::FNM_CASEFOLD).first).strip
+
+# Generate rdocs? Package developer may want to deactivate this.
+GENERATE_RDOC = true
 
 require 'optparse'
 require 'rbconfig'
@@ -19,6 +22,9 @@ class SetupError < StandardError; end
 #
 #   $ ./setup.rb
 #
+# Which is the same al
+#
+#
 #   -- or --
 #
 #   $ ./setup.rb config
@@ -33,7 +39,8 @@ class SetupError < StandardError; end
 # TODO: Make cleaning more comprehensive (?)
 
 module Setup
-  Version   = "3.5.0"
+
+  Version   = "3.5.1"
 
   Copyright = "Copyright (c) 2000,2008 Minero Aoki, Trans"
 
@@ -252,6 +259,7 @@ module Setup
 
       parameterize = lambda do |path|
         val = RBCONFIG[path]
+        raise "Unknown path -- #{path}" if val.nil?
         val.sub(/\A#{Regexp.quote(prefix)}/, '$prefix')
       end
 
@@ -321,8 +329,15 @@ module Setup
       OPTIONS.each do |name|
         value = self[name]
         reslv = __send__(name)
-        reslv = "(none)" if String===reslv && reslv.empty?
-        printf fmt, name, reslv if value
+        case reslv
+        when String
+          reslv = "(none)" if reslv.empty?
+        when false, nil
+          reslv = "no"
+        when true
+          reslv = "yes"
+        end
+        printf fmt, name, reslv
       end
     end
 
@@ -373,15 +388,15 @@ module Setup
       [ 'config',   'saves your configurations' ],
       [ 'show',     'shows current configuration' ],
       [ 'setup',    'compiles ruby extentions and others' ],
-      [ 'doc',      'generate html documentation' ],
-      [ 'index',    'generate index documentation' ],
+      [ '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" ]
     ]
 
-    TASKS = %w(all config show setup test install uninstall doc index clean distclean)
+    TASKS = %w(all config show setup test install uninstall rdoc ri clean distclean)
 
     # Configuration
     attr :config
@@ -447,11 +462,11 @@ module Setup
       desc 'Runs unit tests'
       task :test do exec_test end
 
-      desc 'Generate html api docs'
-      task :doc do exec_doc end
+      desc 'Generate rdoc documentation'
+      task :rdoc do exec_rdoc end
 
-      desc 'Generate api index docs'
-      task :index do exec_index end
+      desc 'Generate ri documentation'
+      task :ri do exec_ri end
 
       desc 'Installs files'
       task :install do exec_install end
@@ -509,8 +524,9 @@ module Setup
     def exec_all
       exec_config
       exec_setup
-      exec_test     # TODO: we need to stop here if tests fail (how?)
-      exec_doc      if GENERATE_RDOCS && !config.without_doc?
+      exec_test      # TODO: we need to stop here if tests fail (how?)
+      exec_rdoc      unless config.without_doc? if GENERATE_RDOC
+      exec_ri        unless config.without_doc?
       exec_install
     end
 
@@ -706,12 +722,12 @@ module Setup
     #end
 
     #
-    # TASK doc
+    # TASK rdoc
     #
 
-    def exec_doc
-      output    = File.join('doc', PACKAGE, 'rdoc')
-      title     = (PACKAGE.capitalize + " API").strip
+    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'
 
@@ -744,57 +760,49 @@ module Setup
       end
     end
 
-    #
-    # TASK index
-    #
-    # TODO: Totally deprecate stadard ri support in favor of fastri.
+    # TASK ri
 
-    def exec_index
-      begin
-        require 'fastri/version'
-        fastri = true
-      rescue LoadError
-        fastri = false
+    def exec_ri
+      case config.installdirs
+      when 'std'
+        output = "--ri-system"
+      when 'site'
+        output = "--ri-site"
+      when 'home'
+        output = "--ri"
+      else
+        abort "bad config: sould not be possible -- installdirs = #{config.installdirs}"
       end
-      if fastri
-        if no_harm?
-          $stderr.puts "fastri-server -b"
-        else
-          system "fastri-server -b"
-        end
+
+      if File.exist?('.document')
+        files = File.read('.document').split("\n")
+        files.reject!{ |l| l =~ /^\s*[#]/ || l !~ /\S/ }
+        files.collect!{ |f| f.strip }
       else
-        case config.installdirs
-        when 'std'
-          output = "--ri-system"
-        when 'site'
-          output = "--ri-site"
-        when 'home'
-          output = "--ri"
-        else
-          abort "bad config: sould not be possible -- installdirs = #{config.installdirs}"
-        end
+        files = ["lib", "ext"]
+      end
 
-        if File.exist?('.document')
-          files = File.read('.document').split("\n")
-          files.reject!{ |l| l =~ /^\s*[#]/ || l !~ /\S/ }
-          files.collect!{ |f| f.strip }
-        else
-          files = ["lib", "ext"]
-        end
+      opt = []
+      opt << "-U"
+      opt << output
+      opt << files
+      opt = opt.flatten
 
+      if no_harm?
+        puts "rdoc #{opt.join(' ').strip}"
+      else
+        # Generate in system location specified
+        #sh "rdoc #{opt.join(' ').strip}"
+        require 'rdoc/rdoc'
+        ::RDoc::RDoc.new.document(opt)
+
+        # Now in local directory
         opt = []
         opt << "-U"
-        opt << output
+        opt << "--ri --op 'doc/ri'"
         opt << files
         opt = opt.flatten
-
-        if no_harm?
-          puts "rdoc #{opt.join(' ').strip}"
-        else
-          #sh "rdoc #{opt.join(' ').strip}"
-          require 'rdoc/rdoc'
-          ::RDoc::RDoc.new.document(opt)
-        end
+        ::RDoc::RDoc.new.document(opt)
       end
     end
 
@@ -836,9 +844,11 @@ module Setup
       install_files targetfiles(), "#{config.mandir}/#{rel}", 0644
     end
 
+    # doc installs to directory named: "ruby-#{package}"
     def install_dir_doc(rel)
       return if config.without_doc?
-      install_files targetfiles(), "#{config.docdir}/#{rel}", 0644
+      dir = "#{config.docdir}/ruby-#{PACKAGE_NAME}/#{rel}" # "#{config.docdir}/#{rel}"
+      install_files targetfiles(), dir, 0644
     end
 
     def install_files(list, dest, mode)
@@ -861,7 +871,7 @@ module Setup
     end
 
     def dllext
-      RBCONFIG['DLEXT']
+      ConfigTable::RBCONFIG['DLEXT']
     end
 
     def targetfiles
@@ -994,7 +1004,7 @@ module Setup
     alias distclean_dir_man noop
 
     def distclean_dir_doc(rel)
-      if GENERATE_RDOCS
+      if GENERATE_RDOC
         rm_rf('rdoc') if File.directory?('rdoc')
       end
     end

data/task/allshare.rb

@@ -0,0 +1,109 @@
+# Need the package name, and whether to generate documentation.
+PACKAGE = File.read(Dir.glob('{.,meta/}unixname{,.txt}', File::FNM_CASEFOLD).first).strip
+GENERATE_RDOCS = true # package developer may need to deactivate
+
+require 'optparse'
+require 'rbconfig'
+
+class SetupError < StandardError; end
+
+#
+
+module Setup
+
+  #
+  # CLI runner
+  #
+
+  def self.run_cli(task)
+    opts = OptionParser.new
+
+    opts.banner = "Usage: #{File.basename($0)} [options]"
+
+    if task == 'config' or task == 'all'
+      opts.separator ""
+      opts.separator "Config options:"   
+      Setup::ConfigTable::DESCRIPTIONS.each do |name, type, desc|
+        opts.on("--#{name} #{type.to_s.upcase}", desc) do |val|
+          ENV[name.to_s] = val.to_s
+        end
+      end
+    end
+
+    if task == 'install'
+      opts.separator ""
+      opts.separator "Install options:"
+
+      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
+      end
+    end
+
+    # common options
+    opts.separator ""
+    opts.separator "General options:"
+
+    opts.on("-q", "--quiet", "Silence output") do |val|
+      installer.quiet = val
+    end
+
+    opts.on("--verbose", "Provide verbose output") do |val|
+      installer.verbose = val
+    end
+
+    opts.on("-n", "--no-write", "Do not write to disk") do |val|
+      installer.no_harm = !val
+    end
+
+    opts.on("--dryrun", "Same as --no-write") do |val|
+      installer.no_harm = val
+    end
+
+    # common options
+    opts.separator ""
+    opts.separator "Inform options:"
+
+    # Tail options (eg. commands in option form)
+    opts.on_tail("-h", "--help", "display this help information") do
+      puts Setup.help
+      exit
+    end
+
+    opts.on_tail("--version", "Show version") do
+      puts File.basename($0) + ' v' + Setup::Version.join('.')
+      exit
+    end
+
+    opts.on_tail("--copyright", "Show copyright") do
+      puts Setup::Copyright
+      exit
+    end
+
+    begin
+      opts.parse!(ARGV)
+    rescue OptionParser::InvalidOption
+      $stderr.puts $!.to_s.capitalize
+      exit 1
+    end
+
+    begin
+      installer.__send__("exec_#{task}")
+    rescue SetupError
+      raise if $DEBUG
+      $stderr.puts $!.message
+      $stderr.puts "Try 'ruby #{$0} --help' for detailed usage."
+      exit 1
+    end
+  end
+
+end
+

data/task/clean

@@ -0,0 +1,13 @@
+require 'fileutils'
+
+CLEAN = ['**/*.o', '**/*.bak']
+
+def clean
+  fu = ARGV.include?('--dryrun') ? FileUtils::DryRun : FileUtils
+  CLEAN.each do |glob|
+    Dir[glob].each do |path|
+      fu.rm_rf(path)
+    end
+  end
+end
+

data/task/compile

@@ -0,0 +1,28 @@
+module Setup
+
+  def self.compile
+    makefiles = Dir['ext/**/Makefile')
+    makefiles.each do |makefile|
+      cd File.dirname(extconf) do
+        system "make"
+      end
+    end
+  end
+
+end
+
+
+#
+# Runners
+#
+
+if $0 == __FILE__
+
+  Setup::ConfigTable.run_cli(:compile)
+
+elsif defined?(Rake)
+
+  Setup::ConfigTable.run_rake
+
+end
+

data/task/configure

@@ -0,0 +1,372 @@
+#!/usr/bin/env ruby
+# Setup.rb v3.5.0
+# Copyright (c) 2008 Minero Aoki, Trans
+#
+# This program is free software.
+# You can distribute/modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+
+require File.dirname(__FILE__) + "/common.rb"
+
+# Typical installation procedure:
+#
+#   $ ./setup.rb
+#
+#   -- or --
+#
+#   $ ./setup.rb config
+#   $ ./setup.rb setup
+#   $ ./setup.rb install
+#
+# @all@ and @install@ may require root privileges.
+#
+# This update only works with Ruby 1.6.3 and above.
+#
+# TODO: Update shebangs on install of binaries.
+# TODO: Make cleaning more comprehensive (?)
+
+module Setup
+
+  # ConfigTable stores platform information.
+
+  class ConfigTable
+
+    RBCONFIG  = ::Config::CONFIG
+
+    CONFIGFILE = '.config'
+
+    DESCRIPTIONS = [
+      [:prefix          , :path, 'path prefix of target environment'],
+      [:bindir          , :path, 'directory for commands'],
+      [:libdir          , :path, 'directory for libraries'],
+      [:datadir         , :path, 'directory for shared data'],
+      [:mandir          , :path, 'directory for man pages'],
+      [:docdir          , :path, 'Directory for documentation'],
+      [:sysconfdir      , :path, 'directory for system configuration files'],
+      [:localstatedir   , :path, 'directory for local state data'],
+      [:libruby         , :path, 'directory for ruby libraries'],
+      [:librubyver      , :path, 'directory for standard ruby libraries'],
+      [:librubyverarch  , :path, 'directory for standard ruby extensions'],
+      [:siteruby        , :path, 'directory for version-independent aux ruby libraries'],
+      [:siterubyver     , :path, 'directory for aux ruby libraries'],
+      [:siterubyverarch , :path, 'directory for aux ruby binaries'],
+      [: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'],
+      [: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'],
+      [: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)'],
+      [:installdirs     , :pick, 'install location mode (std,site,home :: libruby,site_ruby,$HOME)']
+    ]
+
+    # List of configurable options.
+    OPTIONS = DESCRIPTIONS.collect{ |(k,t,v)| k.to_s }
+
+    # Pathname attribute. Pathnames are automatically expanded
+    # unless they start with '$', a path variable.
+    def self.attr_pathname(name)
+      class_eval %{
+        def #{name}
+          @#{name}.gsub(%r<\\$([^/]+)>){ self[$1] }
+        end
+        def #{name}=(path)
+          raise SetupError, "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.
+    def self.attr_pathlist(name)
+      class_eval %{
+        def #{name}
+          @#{name}
+        end
+        def #{name}=(pathlist)
+          case pathlist
+          when Array
+            @#{name} = pathlist
+          else
+            @#{name} = pathlist.to_s.split(/[:;,]/)
+          end
+        end
+      }   
+    end
+
+    # Adds boolean support.
+    def self.attr_accessor(*names)
+      bools, attrs = names.partition{ |name| name.to_s =~ /\?$/ }
+      attr_boolean *bools
+      super *attrs
+    end
+
+    # Boolean attribute. Can be assigned true, false, nil, or
+    # a string matching yes|true|y|t or no|false|n|f.
+    def self.attr_boolean(*names)
+      names.each do |name|
+        name = name.to_s.chomp('?')
+        attr_reader name  # MAYBE: Deprecate
+        code = %{
+          def #{name}?; @#{name}; end
+          def #{name}=(val)
+            case val
+            when true, false, nil
+              @#{name} = val
+            else
+              case val.to_s.downcase
+              when 'y', 'yes', 't', 'true'
+                 @#{name} = true
+              when 'n', 'no', 'f', 'false'
+                 @#{name} = false
+              else
+                raise SetupError, "bad config: use #{name.upcase}=(yes|no) [\#{val}]"
+              end
+            end
+          end
+        }
+        class_eval code
+      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?
+
+    # # don't actually write files to system
+    # attr_accessor :no_harm?
+
+    # shebang has only three options.
+    def shebang=(val)
+      if %w(all ruby never).include?(val)
+        @shebang = val
+      else
+        raise SetupError, "bad config: use SHEBANG=(all|ruby|never) [#{val}]"
+      end
+    end
+
+    # installdirs has only three options; and it has side-effects.
+    def installdirs=(val)
+      @installdirs = val
+      case val.to_s
+      when 'std'
+        self.rbdir = '$librubyver'
+        self.sodir = '$librubyverarch'
+      when 'site'
+        self.rbdir = '$siterubyver'
+        self.sodir = '$siterubyverarch'
+      when 'home'
+        raise SetupError, '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}]"
+      end
+    end
+
+    # New ConfigTable
+    def initialize(values=nil)
+      initialize_defaults
+      if values
+        values.each{ |k,v| __send__("#{k}=", v) }
+      end
+      yeild(self) if block_given?
+      load_config if File.file?(CONFIGFILE)
+    end
+
+    # Assign CONFIG defaults
+    #
+    # TODO: Does this handle 'nmake' on windows?
+    def initialize_defaults
+      prefix = RBCONFIG['prefix']
+
+      rubypath = File.join(RBCONFIG['bindir'], RBCONFIG['ruby_install_name'] + RBCONFIG['EXEEXT'])
+
+      major = RBCONFIG['MAJOR'].to_i
+      minor = RBCONFIG['MINOR'].to_i
+      teeny = RBCONFIG['TEENY'].to_i
+      version = "#{major}.#{minor}"
+
+      # ruby ver. >= 1.4.4?
+      newpath_p = ((major >= 2) or
+                   ((major == 1) and
+                    ((minor >= 5) or
+                     ((minor == 4) and (teeny >= 4)))))
+
+      if RBCONFIG['rubylibdir']
+        # V > 1.6.3
+        libruby         = "#{prefix}/lib/ruby"
+        librubyver      = RBCONFIG['rubylibdir']
+        librubyverarch  = RBCONFIG['archdir']
+        siteruby        = RBCONFIG['sitedir']
+        siterubyver     = RBCONFIG['sitelibdir']
+        siterubyverarch = RBCONFIG['sitearchdir']
+      elsif newpath_p
+        # 1.4.4 <= V <= 1.6.3
+        libruby         = "#{prefix}/lib/ruby"
+        librubyver      = "#{prefix}/lib/ruby/#{version}"
+        librubyverarch  = "#{prefix}/lib/ruby/#{version}/#{c['arch']}"
+        siteruby        = RBCONFIG['sitedir']
+        siterubyver     = "$siteruby/#{version}"
+        siterubyverarch = "$siterubyver/#{RBCONFIG['arch']}"
+      else
+        # V < 1.4.4
+        libruby         = "#{prefix}/lib/ruby"
+        librubyver      = "#{prefix}/lib/ruby/#{version}"
+        librubyverarch  = "#{prefix}/lib/ruby/#{version}/#{c['arch']}"
+        siteruby        = "#{prefix}/lib/ruby/#{version}/site_ruby"
+        siterubyver     = siteruby
+        siterubyverarch = "$siterubyver/#{RBCONFIG['arch']}"
+      end
+
+      if arg = RBCONFIG['configure_args'].split.detect {|arg| /--with-make-prog=/ =~ arg }
+        makeprog = arg.sub(/'/, '').split(/=/, 2)[1]
+      else
+        makeprog = 'make'
+      end
+
+      parameterize = lambda do |path|
+        val = RBCONFIG[path]
+        val.sub(/\A#{Regexp.quote(prefix)}/, '$prefix')
+      end
+
+      self.prefix          = prefix
+      self.bindir          = parameterize['bindir']
+      self.libdir          = parameterize['libdir']
+      self.datadir         = parameterize['datadir']
+      self.mandir          = parameterize['mandir']
+      self.docdir          = File.dirname(parameterize['docdir'])  # b/c of trailing $(PACKAGE)
+      self.sysconfdir      = parameterize['sysconfdir']
+      self.localstatedir   = parameterize['localstatedir']
+      self.libruby         = libruby
+      self.librubyver      = librubyver
+      self.librubyverarch  = librubyverarch
+      self.siteruby        = siteruby
+      self.siterubyver     = siterubyver
+      self.siterubyverarch = siterubyverarch
+      self.rbdir           = '$siterubyver'
+      self.sodir           = '$siterubyverarch'
+      self.rubypath        = rubypath
+      self.rubyprog        = rubypath
+      self.makeprog        = makeprog
+      self.extconfopt      = ''
+      self.shebang         = 'ruby'
+      self.without_ext     = 'no'
+      self.without_doc     = 'yes'
+      self.doctemplate     = 'html'
+      self.testrunner      = 'auto'
+      self.installdirs     = 'site'
+    end
+
+    # Get configuration from environment.
+    def env_config
+      OPTIONS.each do |name|
+        if value = ENV[name]
+          __send__("#{name}=",value)
+        end
+      end
+    end
+
+    # Load configuration.
+    def load_config
+      #if File.file?(CONFIGFILE)
+        begin
+          File.foreach(CONFIGFILE) do |line|
+            k, v = *line.split(/=/, 2)
+            __send__("#{k}=",v.strip) #self[k] = v.strip
+          end
+        rescue Errno::ENOENT
+          raise SetupError, $!.message + "\n#{File.basename($0)} config first"
+        end
+      #end
+    end
+
+    # Save configuration.
+    def save_config
+      File.open(CONFIGFILE, 'w') do |f|
+        OPTIONS.each do |name|
+          val = self[name]
+          f << "#{name}=#{val}\n"
+        end
+      end
+    end
+
+    def show
+      fmt = "%-20s %s\n"
+      OPTIONS.each do |name|
+        value = self[name]
+        reslv = __send__(name)
+        case reslv
+        when String
+          reslv = "(none)" if reslv.empty?
+        when false, nil
+          reslv = "no"
+        when true
+          reslv = "yes"
+        end
+        printf fmt, name, reslv
+      end
+    end
+
+    #
+
+    def extconfs
+      @extconfs ||= Dir['ext/**/extconf.rb']
+    end
+
+    def extensions
+      @extensions ||= extconfs.collect{ |f| File.dirname(f) }
+    end
+
+    def compiles?
+      !extensions.empty?
+    end
+
+    private
+
+    # Get unresloved attribute.
+    def [](name)
+      instance_variable_get("@#{name}")
+    end
+
+    # Set attribute.
+    def []=(name, value)
+      instance_variable_set("@#{name}", value)
+    end
+
+    # Resolved attribute. (for paths)
+    #def resolve(name)
+    #  self[name].gsub(%r<\\$([^/]+)>){ self[$1] }
+    #end
+
+  end
+
+end
+
+
+
+#
+# Runners
+#
+
+if $0 == __FILE__
+  Setup::ConfigTable.run_cli
+elsif defined?(Rake)
+  Setup::ConfigTable.run_rake
+end
+