setup 4.2.0 → 5.0.0

data/lib/setup/command.rb

@@ -1,174 +1,278 @@
-require 'setup/config'
-require 'setup/build'
-require 'setup/install'
-require 'setup/error'
+require 'setup/session'
+require 'optparse'
 
 module Setup
 
-  # CLI for Setup.rb
+  # Command-line interface 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" ],
-      [ 'uninstall', "uninstalls files" ],
-      [ 'test',      "run all tests in test/" ],
-      [ 'clean',     "does `make clean' for each extention" ],
-      [ 'distclean', "does `make distclean' for each extention" ]
-    ]
+    # Initialize and run.
 
-    #
     def self.run(*argv)
       new.run(*argv)
     end
 
-    #
+    # Hash of <tt>task => description</tt>.
+
+    def self.tasks
+      @tasks ||= {}
+    end
+
+    # Task names listed in order of information.
+
+    def self.order
+      @order ||= []
+    end
+
+    # Define a task.
+
+    def self.task(name, description)
+      tasks[name] = description
+      order << name
+    end
+
+    task 'all'      , "config, setup, test, install"
+    task 'config'   , "saves your configuration"
+    task 'show'     , "show current configuration"
+    task 'make'     , "compile ruby extentions"
+    task 'test'     , "run test suite"
+    task 'doc'      , "generate ri documentation"
+    task 'install'  , "install project files"
+    task 'uninstall', "uninstall previously installed files"
+    task 'clean'    , "does `make clean' for each extention"
+    task 'distclean', "does `make distclean' for each extention"
+
+    # Run command.
+
     def run(*argv)
       ARGV.replace(argv) unless argv.empty?
 
-      config    = ConfigTable.new
-      installer = Installer.new(config)
+      #session = Session.new(:io=>$stdio)
+      #config  = session.configuration
 
       task = ARGV.find{ |a| a !~ /^[-]/ }
       task = 'all' unless task
 
-      unless TASKS.include?(task)
+      unless task_names.include?(task)
         $stderr.puts "Not a valid task -- #{task}"
         exit 1
       end
 
-      opts   = OptionParser.new
+      parser  = OptionParser.new
+      options = {}
 
-      opts.banner = "Usage: #{File.basename($0)} [task] [options]"
+      parser.banner = "Usage: #{File.basename($0)} [TASK] [OPTIONS]"
 
-      if task == 'config' or task == 'all'
-        opts.separator ""
-        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
-        end
+      optparse_header(parser, options)
+      case task
+      when 'all'
+        optparse_all(parser, options)
+      when 'config'
+        optparse_config(parser, options)
+      when 'install'
+        optparse_install(parser, options)
       end
+      optparse_common(parser, options)
 
-      if task == 'install'
-        opts.separator ""
-        opts.separator "Install options:"
+      begin
+        parser.parse!(ARGV)
+      rescue OptionParser::InvalidOption
+        $stderr.puts $!.to_s.capitalize
+        exit 1
+      end
 
-        opts.on("--prefix PATH", "Installation prefix") do |val|
-          installer.install_prefix = val
-        end
+      # This ensures we are in a project directory.
+      rootdir = session.project.rootdir
 
-        opts.on("--no-test", "Do not run tests") do |val|
-          installer.install_no_test = true
-        end
+      print_header
+
+      begin
+        session.__send__(task)
+      rescue Error
+        raise if $DEBUG
+        $stderr.puts $!.message
+        $stderr.puts "Try 'setup.rb --help' for detailed usage."
+        exit 1
       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
+      puts unless session.quiet?
+    end
+
+    # Setup session.
+
+    def session
+      @session ||= Session.new(:io=>$stdout)
+    end
+
+    # Setup configuration. This comes from the +session+ object.
+
+    def configuration
+      @configuration ||= session.configuration
+    end
+
+    #
+    def optparse_header(parser, options)
+      parser.banner = "USAGE: #{File.basename($0)} [command] [options]"
+    end
+
+    # Setup options for +all+ task.
+
+    def optparse_all(parser, options)
+      optparse_config(parser, options)
+      #optparse_install(parser, options)
+      #parser.on("-t", "--[no-]test", "run tests") do |val|
+      #  configuration.no_test = val
+      #end
+      #parser.on("--[no-]ri", "generate ri documentation") do |val|
+      #  configuration.no_doc = val
       #end
+      #parser.on("--[no-]doc", "do not install documentation") do |val|
+      #  configuration.no_doc = val
+      #end
+    end
+
+    # Setup options for +config+ task.
+
+    def optparse_config(parser, options)
+      parser.separator ""
+      parser.separator "Configuration options:"
+      configuration.options.each do |args|
+        args = args.dup
+        desc = args.pop
+        type = args.pop
+        name, shortcut = *args
+        #raise ArgumentError unless name, type, desc
+        optname = name.to_s.gsub('_', '-')
+        case type
+        when :bool
+          if optname.index('no-') == 0
+            optname = "[no-]" + optname.sub(/^no-/, '')
+            opts = shortcut ? ["-#{shortcut}", "--#{optname}", desc] : ["--#{optname}", desc]
+            parser.on(*opts) do |val|
+              configuration.__send__("#{name}=", !val)
+            end
+          else
+            optname = "[no-]" + optname.sub(/^no-/, '')
+            opts = shortcut ? ["-#{shortcut}", "--#{optname}", desc] : ["--#{optname}", desc]
+            parser.on(*opts) do |val|
+              configuration.__send__("#{name}=", val)
+            end
+          end
+        else
+          opts = shortcut ? ["-#{shortcut}", "--#{optname} #{type.to_s.upcase}", desc] : ["--#{optname} #{type.to_s.upcase}", desc]
+          parser.on(*opts) do |val|
+            configuration.__send__("#{name}=", val)
+          end
+        end
+      end
+    end
+
+    # Setup options for +install+ task.
+
+    def optparse_install(parser, options)
+      parser.separator ""
+      parser.separator "Install options:"
+      parser.on("--prefix PATH", "Installation prefix") do |val|
+        #session.options[:install_prefix] = val
+        configuration.install_prefix = val
+      end
+    end
+
+    # Setup options for +test+ task.
+
+    #def optparse_test(parser, options)
+    #  parser.separator ""
+    #  parser.separator "Test options:"
+    #  parser.on("--runner TYPE", "Test runner (auto|console|gtk|gtk2|tk)") do |val|
+    #    ENV['RUBYSETUP_TESTRUNNER'] = val
+    #  end
+    #end
+
+    # Setup options for +uninstall+ task.
+
+    #def optparse_uninstall(parser, options)
+    #  parser.separator ""
+    #  parser.separator "Uninstall options:"
+    #  parser.on("--prefix [PATH]", "Installation prefix") do |val|
+    #    session.options[:install_prefix] = val
+    #  end
+    #end
+
+    # Common options for every task.
 
-      # common options
-      opts.separator ""
-      opts.separator "General options:"
+    def optparse_common(parser, options)
+      parser.separator ""
+      parser.separator "General options:"
 
-      opts.on("-q", "--quiet", "Silence output") do |val|
-        installer.quiet = val
+      parser.on("-q", "--quiet", "Suppress output") do
+        session.quiet = true
       end
 
-      opts.on("--verbose", "Provide verbose output") do |val|
-        installer.verbose = val
+      parser.on("-f", "--force", "Force operation") do
+        session.force = true
       end
 
-      opts.on("--no-write", "Do not write to disk") do |val|
-        installer.no_harm = !val
+      parser.on("--trace", "--verbose", "Watch execution") do |val|
+        session.trace = true
       end
 
-      opts.on("-n", "--dryrun", "Same as --no-write") do |val|
-        installer.no_harm = val
+      parser.on("--trial", "--no-harm", "Do not write to disk") do |val|
+        session.trial = true
       end
 
-      # common options
-      opts.separator ""
-      opts.separator "Inform options:"
+      parser.on("--debug", "Turn on debug mode") do |val|
+        $DEBUG = true
+      end
+
+      parser.separator ""
+      parser.separator "Inform options:"
 
       # Tail options (eg. commands in option form)
-      opts.on_tail("-h", "--help", "display this help information") do
-        puts help
+      parser.on_tail("-h", "--help", "display this help information") do
+        #puts help
+        puts parser
         exit
       end
 
-      opts.on_tail("--version", "Show version") do
+      parser.on_tail("--version", "-v", "Show version") do
         puts File.basename($0) + ' v' + Setup::VERSION #Version.join('.')
         exit
       end
 
-      opts.on_tail("--copyright", "Show copyright") do
+      parser.on_tail("--copyright", "Show copyright") do
         puts Setup::COPYRIGHT #opyright
         exit
       end
-
-      begin
-        opts.parse!(ARGV)
-      rescue OptionParser::InvalidOption
-        $stderr.puts $!.to_s.capitalize
-        exit 1
-      end
-
-      begin
-        installer.__send__("exec_#{task}")
-      rescue Error
-        raise if $DEBUG
-        $stderr.puts $!.message
-        $stderr.puts "Try 'ruby #{$0} --help' for detailed usage."
-        exit 1
-      end
     end
 
-    # Generate help text
-    def help
-    fmt = " " * 10 + "%-10s       %s"
-      commands = TASK_DESCRIPTIONS.collect do |k,d|
-        (fmt % ["#{k}", d])
-      end.join("\n").strip
-
-      fmt = " " * 13 + "%-20s       %s"
-      configs = ConfigTable::DESCRIPTIONS.collect do |k,t,d|
-        (fmt % ["--#{k}", d])
-      end.join("\n").strip
+    # List of task names.
+    #--
+    # TODO: shouldn't this use +self.class.order+ ?
+    #++
 
-      text = <<-END
-        USAGE: #{File.basename($0)} [command] [options]
-
-        Commands:
-            #{commands}
-
-        Options for CONFIG:
-               #{configs}
-
-        Options for INSTALL:
-               --prefix                   Set the install prefix
-
-        Options in common:
-            -q --quiet                    Silence output
-               --verbose                  Provide verbose output
-            -n --no-write                 Do not write to disk
+    def task_names
+      #self.class.order
+      self.class.tasks.keys
+    end
 
-      END
-      text.gsub(/^ \ \ \ \ \ /, '')
+    # Output Header.
+    #
+    # TODO: This is not yet used. It might be nice to have,
+    # but not sure what it should contain or look like.
+
+    def print_header
+      #unless session.quiet?
+      #  if session.project.name
+      #    puts "= #{session.project.name} (#{rootdir})"
+      #  else
+      #    puts "= #{rootdir}"
+      #  end
+      #end
+      #$stderr << "#{session.options.inspect}\n" if session.trace? or session.trial?
     end
 
   end
+
 end
+

data/lib/setup/compiler.rb

@@ -0,0 +1,69 @@
+require 'setup/base'
+
+module Setup
+
+  #
+  class Compiler < Base
+
+    #
+    def compiles?
+      !extdirs.empty?
+      #extdirs.any?{ |dir| File.exist?(File.join(dir, 'extconf.rb')) }
+    end
+
+    #
+    def configure
+      extdirs.each do |dir|
+        Dir.chdir(dir) do
+          if File.exist?('extconf.rb') && !FileUtils.uptodate?('Makefile', ['extconf.rb'])
+            #load("extconf.rb", true)
+            ruby("extconf.rb")
+          end
+        end
+      end
+    end
+
+    #
+    def compile
+      extdirs.each do |dir|
+        Dir.chdir(dir) do
+          make
+        end
+      end
+    end
+
+    #
+    def clean
+      extdirs.each do |dir|
+        Dir.chdir(dir) do
+          make('clean')
+        end
+      end
+    end
+
+    #
+    def distclean
+      extdirs.each do |dir|
+        Dir.chdir(dir) do
+          make('distclean')
+        end
+      end
+    end
+
+    # TODO: get from project
+    def extdirs
+      Dir['ext/**/*/{MANIFEST,extconf.rb}'].map do |f|
+        File.dirname(f)
+      end.uniq
+    end
+
+    #
+    def make(task=nil)
+      return unless File.exist?('Makefile')
+      bash(*[config.makeprog, task].compact)
+    end
+
+  end
+
+end
+