setup 4.2.0 → 5.0.0

data/lib/setup/project.rb

@@ -0,0 +1,68 @@
+module Setup
+
+  # The Project class encapsulates information
+  # about the project/package setup is effecting.
+
+  class Project
+
+    # Match used to determine the root dir of a project.
+    ROOT_MARKER = '{setup.rb,script/setup,meta/,MANIFEST,lib/}'
+
+    # TODO: locate project root via some marker
+    def rootdir
+      @rootdir ||= (
+        root = Dir[File.join(Dir.pwd, ROOT_MARKER)].first
+        if !root
+          raise Error, "not a project directory"
+        else
+          Dir.pwd
+        end
+      )
+    end
+
+    # 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.
+    def name
+      @name = (
+        if file = Dir["{script/setup,meta,.meta}/name"].first
+          File.read(file).strip
+        else
+          nil
+        end
+      )
+    end
+
+    # This is needed if a project has loadpaths other than the standard lib/.
+    # Note the routine is designed to handle YAML arrays or line by line list.
+    def loadpath
+      @loadpath ||= (
+        if file = Dir.glob('{script/setup,meta,.meta}/loadpath').first
+          raw = File.read(file).strip.chomp(']')
+          raw.split(/[\n,]/).map do |e|
+            e.strip.sub(/^[\[-]\s*/,'')
+          end
+        else
+          nil
+        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
+
+  end
+
+end
+

data/lib/setup/rake.rb

@@ -1,62 +1,61 @@
 require 'setup/install'
 require 'rake/clean'
 
-setup = Setup::Installer.new
-
-desc 'Config, setup and then install'
-task :all => [:config, :setup, :install]
-
-desc 'Saves your configurations'
-task :config do
-  setup.exec_config
+def session
+  @session ||= Setup::Session.new(:io=>$stdout)
 end
 
-desc 'Compiles ruby extentions'
-task :setup do
-  setup.exec_setup
-end
+namespace :setup do
 
-desc 'Runs unit tests'
-task :test do
-  setup.exec_test
-end
+  desc 'Config, setup and then install'
+  task :all => [:config, :setup, :install]
 
-desc 'Generate rdoc documentation'
-task :rdoc do
-  setup.exec_rdoc
-end
+  desc 'Saves your configurations'
+  task :config do
+    session.config
+  end
 
-desc 'Generate ri documentation'
-task :ri do
-  setup.exec_ri
-end
+  desc 'Compiles ruby extentions'
+  task :make do
+    session.make
+  end
 
-desc 'Installs files'
-task :install do
-  setup.exec_install
-end
+  desc 'Runs unit tests'
+  task :test do
+    session.test
+  end
 
-desc 'Uninstalls files'
-task :uninstall do
-  setup.exec_uninstall
-end
+  desc 'Generate ri documentation'
+  task :rdoc do
+    session.document
+  end
 
-#desc "Does `make clean' for each extention"
-task :makeclean do
-  setup.exec_clean
-end
+  desc 'Installs files'
+  task :install do
+    session.install
+  end
 
-task :clean => [:makeclean]
+  desc 'Uninstalls files'
+  task :uninstall do
+    session.uninstall
+  end
 
-#desc  "Does `make distclean' for each extention"
-task :distclean do
-  exec_distclean
-end
+  desc "Does `make clean' for each extention"
+  task :clean do
+    session.clean
+  end
 
-task :clobber => [:distclean]
+  desc  "Does `make distclean' for each extention"
+  task :distclean do
+    session.distclean
+  end
 
-desc 'Shows current configuration'
-task :show do
-  setup.exec_show
+  desc 'Shows current configuration'
+  task :show do
+    session.show
+  end
 end
 
+task :clean   => ['setup:clean']
+task :clobber => ['setup:distclean']
+

data/lib/setup/session.rb

@@ -0,0 +1,233 @@
+require 'setup/core_ext'
+require 'setup/constants'
+require 'setup/project'
+require 'setup/configuration'
+require 'setup/compiler'
+require 'setup/installer'
+require 'setup/tester'
+require 'setup/documentor'
+require 'setup/uninstaller'
+
+module Setup
+
+  #
+  class Session
+
+    # Session options.
+    attr :options
+
+    # New Session
+    def initialize(options={})
+      @options = options
+      self.io ||= StringIO.new  # log instead ?
+    end
+
+    # #  O P T I O N S  # #
+
+    #
+    def io
+      @options[:io]
+    end
+
+    #
+    def io=(anyio)
+      @options[:io] = anyio
+    end
+
+    #
+    def trace?; @options[:trace]; end
+
+    #
+    def trace=(val)
+      @options[:trace] = val
+    end
+
+    #
+    def trial?; @options[:trial]; end
+
+    #
+    def trial=(val)
+      @options[:trial] = val
+    end
+
+    #
+    def quiet?; @options[:quiet]; end
+
+    #
+    def quiet=(val)
+      @options[:quiet] = val
+    end
+
+    #
+    def force?; @options[:force]; end
+
+    #
+    def force=(val)
+      @options[:force] = val
+    end
+
+    #
+    def compile?
+      configuration.compile? && project.compiles?
+    end
+
+    # #  S E T U P  T A S K S  # #
+
+    # Run all tasks in sequence.
+    #
+    # * config
+    # * make
+    # * test      (if selected)
+    # * install
+    # * document  (if selected)
+    #
+    # Note that ri documentation is not easy to uninstall.
+    # So use the --ri option knowledgably. You can alwasy
+    # Use <tt>setup.rb document</tt> at a later time.
+    #
+    def all
+      config
+      if compile?
+        make
+      end
+      if configuration.test?
+        ok = test
+        exit 1 unless ok
+      end
+      install
+      if configuration.ri?
+        document
+      end
+    end
+
+    #
+    def config
+      log_header('Configure')
+      if configuration.save_config
+        io.puts "Configuration saved." unless quiet?
+      else
+        io.puts "Configuration current." unless quiet?
+      end
+      puts configuration if trace? && !quiet?
+      compiler.configure if compile? #compiler.compiles?
+    end
+
+    #
+    def make
+      abort "must setup config first" unless configuration.exist?
+      log_header('Compile')
+      compiler.compile
+    end
+
+    # What #make used to be called.
+    alias_method :setup, :make
+
+    #
+    def install
+      abort "must setup config first" unless configuration.exist?
+      log_header('Install')
+      installer.install
+    end
+
+    #
+    def test
+      return true unless tester.testable?
+      log_header('Test')
+      tester.test
+    end
+
+    #
+    def document
+      #return unless configuration.doc?
+      log_header('Document')
+      documentor.document
+    end
+
+    #
+    def clean
+      log_header('Clean')
+      compiler.clean
+    end
+
+    #
+    def distclean
+      log_header('Distclean')
+      compiler.distclean
+    end
+
+    #
+    def uninstall
+      if !File.exist?(INSTALL_RECORD)
+        io.puts "Nothing is installed."
+        return
+      end
+      log_header('Uninstall')
+      uninstaller.uninstall
+      io.puts('Ok.')
+    end
+
+    #
+    def show
+      #configuration.show
+      puts configuration
+    end
+
+    # #  C O N T R O L L E R S / M O D E L S  # #
+
+    #
+    def project
+      @project ||= Project.new
+    end
+    #
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    #
+    def compiler
+      @compiler ||= Compiler.new(project, configuration, options)
+    end
+    #
+    def installer
+      @installer ||= Installer.new(project, configuration, options)
+    end
+    #
+    def tester
+      @tester ||= Tester.new(project, configuration, options)
+    end
+    #
+    def documentor
+      @documentor ||= Documentor.new(project, configuration, options)
+    end
+    #
+    def uninstaller
+      @uninstaller ||= Uninstaller.new(project, configuration, options)
+    end
+
+    # #  S U P P O R T  # #
+  
+    #
+    def log_header(phase)
+      return if quiet?
+      if trial?
+        str = "#{phase.upcase} (trail run)"
+      else
+        str = "#{phase.upcase}"
+      end
+      line = "- " * 35
+      line[0..str.size+3] = str
+      io.puts("\n- - #{line}\n\n")
+    end
+
+    #   #center = "            "
+    #   #c = (center.size - phase.size) / 2
+    #   #center[c,phase.size] = phase.to_s.upcase
+    #   line = '- ' * 4 + ' -' * 28
+    #   #c = (line.size - phase.size) / 2
+    #   line[5,phase.size] = " #{phase.to_s.upcase} "
+    #   io.puts "\n" + line + "\n\n"
+    #end
+
+  end
+
+end
+

data/lib/setup/tester.rb

@@ -0,0 +1,92 @@
+require 'setup/constants'
+
+module Setup
+
+  # Complexities arise in trying to figure out what test framework
+  # is used, and how to run tests. To simplify the process, this
+  # class simply looks for a special script, this can be  a shell
+  # script at <tt>script/test</tt>, or a ruby script that
+  # <tt>.setup/testrc.rb</tt> will be used instead if it exists.
+
+  class Tester < Base
+
+    RUBYSCRIPT  = META_EXTENSION_DIR + '/testrc.rb'
+
+    SHELLSCRIPT = 'script/test'
+
+    #
+    def testable?
+      return false if config.no_test
+      return true  if File.exist?(RUBYSCRIPT)
+      return true  if File.exist?(SHELLSCRIPT)
+      false
+    end
+
+    #
+    def test
+      return true if !testable?
+      if File.exist?(RUBYSCRIPT)
+        test_rubyscript
+      elsif File.exist?(SHELLSCRIPT)
+        test_shellscript
+      end
+    end
+
+    #
+    def test_shellscript
+      bash(SHELLSCRIPT)
+    end
+
+    #
+    def test_rubyscript
+      ruby(RUBYSCRIPT)
+    end
+
+
+    # DEPRECATED
+    #def test
+      #runner = config.testrunner
+      #case runner
+      #when 'testrb'  # TODO: needs work
+      #  opt = []
+      #  opt << " -v" if trace?
+      #  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 trace?
+      #  else
+      #    cmd = "testrb #{opt}"
+      #    $stderr.puts cmd if trace?
+      #    system cmd  #config.ruby "-S testrb", opt
+      #  end
+      #else # autorunner
+      #  unless File.directory?('test')
+      #    $stderr.puts 'no test in this package' if trace?
+      #    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
+
+  end
+
+end