#!/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. # 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 # 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 Version = "3.5.0" Copyright = "Copyright (c) 2000,2008 Minero Aoki, Trans" # 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) reslv = "(none)" if String===reslv && reslv.empty? printf fmt, name, reslv if value 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 # Installer class handles the actual install procedure, # as well as the other tasks, such as testing. class Installer MANIFEST = '.installedfiles' FILETYPES = %w( bin lib ext data conf man doc ) TASK_DESCRIPTIONS = [ [ 'all', 'do config, setup, then install' ], [ 'config', 'saves your configurations' ], [ 'show', 'shows current configuration' ], [ 'setup', 'compiles ruby extentions and others' ], [ 'doc', 'generate html documentation' ], [ 'index', 'generate index 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) # Configuration attr :config attr_writer :no_harm attr_writer :verbose attr_writer :quiet attr_accessor :install_prefix # New Installer. def initialize #:yield: srcroot = '.' objroot = '.' @config = ConfigTable.new @srcdir = File.expand_path(srcroot) @objdir = File.expand_path(objroot) @currdir = '.' 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 # Are we running an installation? def installation?; @installation; end def installation!; @installation = true; end def no_harm?; @no_harm; end def verbose?; @verbose; end def quiet?; @quiet; end def verbose_off #:yield: begin save, @verbose = verbose?, false yield ensure @verbose = save end end # Rake task handlers def rake_define require 'rake/clean' desc 'Config, setup and then install' task :all => [:config, :setup, :install] desc 'Saves your configurations' task :config do exec_config end desc 'Compiles ruby extentions' task :setup do exec_setup end desc 'Generate html api docs' task :doc do exec_doc end desc 'Generate api index docs' task :index do exec_index end desc 'Installs files' task :install do exec_install end desc 'Uninstalls files' task :uninstall do exec_uninstall end #desc "Does `make clean' for each extention" task :makeclean do exec_clean end task :clean => [:makeclean] #desc "Does `make distclean' for each extention" task :distclean do exec_distclean end task :clobber => [:distclean] desc 'Shows current configuration' task :show do exec_show end end # Added these for future use in simplificaiton of design. def extensions @extensions ||= Dir['ext/**/extconf.rb'] end def compiles? !extensions.empty? end # def noop(rel); end # # Hook Script API bases # def srcdir_root @srcdir end def objdir_root @objdir end def relpath @currdir end # # Task all # 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_install end # # TASK config # def exec_config config.env_config config.save_config config.show unless quiet? puts("Configuration saved.") unless quiet? exec_task_traverse 'config' end alias config_dir_bin noop alias config_dir_lib noop def config_dir_ext(rel) extconf if extdir?(curr_srcdir()) end alias config_dir_data noop alias config_dir_conf noop alias config_dir_man noop alias config_dir_doc noop def extconf ruby "#{curr_srcdir()}/extconf.rb", config.extconfopt end # # TASK show # def exec_show config.show end # # TASK setup # # FIXME: Update shebang at time of install not before. # for now I've commented it out the shebang. def exec_setup exec_task_traverse 'setup' end def setup_dir_bin(rel) files_of(curr_srcdir()).each do |fname| #update_shebang_line "#{curr_srcdir()}/#{fname}" end end alias setup_dir_lib noop def setup_dir_ext(rel) make if extdir?(curr_srcdir()) end alias setup_dir_data noop alias setup_dir_conf noop alias setup_dir_man noop alias setup_dir_doc noop def update_shebang_line(path) return if no_harm? return if config.shebang == 'never' old = Shebang.load(path) if old if old.args.size > 1 $stderr.puts "warning: #{path}" $stderr.puts "Shebang line has too many args." $stderr.puts "It is not portable and your program may not work." end new = new_shebang(old) return if new.to_s == old.to_s else return unless config.shebang == 'all' new = Shebang.new(config.rubypath) end $stderr.puts "updating shebang: #{File.basename(path)}" if verbose? open_atomic_writer(path) {|output| File.open(path, 'rb') {|f| f.gets if old # discard output.puts new.to_s output.print f.read } } end def new_shebang(old) if /\Aruby/ =~ File.basename(old.cmd) Shebang.new(config.rubypath, old.args) elsif File.basename(old.cmd) == 'env' and old.args.first == 'ruby' Shebang.new(config.rubypath, old.args[1..-1]) else return old unless config.shebang == 'all' Shebang.new(config.rubypath) end end def open_atomic_writer(path, &block) tmpfile = File.basename(path) + '.tmp' begin File.open(tmpfile, 'wb', &block) File.rename tmpfile, File.basename(path) ensure File.unlink tmpfile if File.exist?(tmpfile) end end class Shebang def Shebang.load(path) line = nil File.open(path) {|f| line = f.gets } return nil unless /\A#!/ =~ line parse(line) end def Shebang.parse(line) cmd, *args = *line.strip.sub(/\A\#!/, '').split(' ') new(cmd, args) end def initialize(cmd, args = []) @cmd = cmd @args = args end attr_reader :cmd attr_reader :args def to_s "#! #{@cmd}" + (@args.empty? ? '' : " #{@args.join(' ')}") end end # # TASK test # # TODO: Add spec support. def exec_test $stderr.puts 'Running tests...' if verbose? runner = config.testrunner case runner when 'auto' 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 else # use testrb 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 end end # MAYBE: We could traverse and run each test independently (?) #def test_dir_test #end # # TASK doc # def exec_doc output = File.join('doc', PACKAGE, 'rdoc') title = (PACKAGE.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 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"] end 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 end # # TASK index # # TODO: Totally deprecate stadard ri support in favor of fastri. def exec_index begin require 'fastri/version' fastri = true rescue LoadError fastri = false end if fastri if no_harm? $stderr.puts "fastri-server -b" else system "fastri-server -b" end 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 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 #sh "rdoc #{opt.join(' ').strip}" require 'rdoc/rdoc' ::RDoc::RDoc.new.document(opt) end end end # # TASK install # def exec_install installation! # were are installing #rm_f MANIFEST # we'll append rather then delete! exec_task_traverse 'install' end def install_dir_bin(rel) install_files targetfiles(), "#{config.bindir}/#{rel}", 0755 end def install_dir_lib(rel) install_files libfiles(), "#{config.rbdir}/#{rel}", 0644 end def install_dir_ext(rel) return unless extdir?(curr_srcdir()) install_files rubyextentions('.'), "#{config.sodir}/#{File.dirname(rel)}", 0555 end def install_dir_data(rel) install_files targetfiles(), "#{config.datadir}/#{rel}", 0644 end def install_dir_conf(rel) # FIXME: should not remove current config files # (rename previous file to .old/.org) install_files targetfiles(), "#{config.sysconfdir}/#{rel}", 0644 end def install_dir_man(rel) install_files targetfiles(), "#{config.mandir}/#{rel}", 0644 end def install_dir_doc(rel) return if config.without_doc? install_files targetfiles(), "#{config.docdir}/#{rel}", 0644 end def install_files(list, dest, mode) mkdir_p dest, install_prefix list.each do |fname| install fname, dest, mode, install_prefix end end def libfiles glob_reject(%w(*.y *.output), targetfiles()) end def rubyextentions(dir) ents = glob_select("*.#{dllext}", targetfiles()) if ents.empty? setup_rb_error "no ruby extention exists: 'ruby #{$0} setup' first" end ents end def dllext RBCONFIG['DLEXT'] end def targetfiles mapdir(existfiles() - hookfiles()) end def mapdir(ents) ents.map {|ent| if File.exist?(ent) then ent # objdir else "#{curr_srcdir()}/#{ent}" # srcdir end } end # picked up many entries from cvs-1.11.1/src/ignore.c JUNK_FILES = %w( core RCSLOG tags TAGS .make.state .nse_depinfo #* .#* cvslog.* ,* .del-* *.olb *~ *.old *.bak *.BAK *.orig *.rej _$* *$ *.org *.in .* ) def existfiles glob_reject(JUNK_FILES, (files_of(curr_srcdir()) | files_of('.'))) end def hookfiles %w( pre-%s post-%s pre-%s.rb post-%s.rb ).map {|fmt| %w( config setup install clean ).map {|t| sprintf(fmt, t) } }.flatten end def glob_select(pat, ents) re = globs2re([pat]) ents.select {|ent| re =~ ent } end def glob_reject(pats, ents) re = globs2re(pats) ents.reject {|ent| re =~ ent } end GLOB2REGEX = { '.' => '\.', '$' => '\$', '#' => '\#', '*' => '.*' } def globs2re(pats) /\A(?:#{ pats.map {|pat| pat.gsub(/[\.\$\#\*]/) {|ch| GLOB2REGEX[ch] } }.join('|') })\z/ end # # TASK uninstall # def exec_uninstall paths = File.read(MANIFEST).split("\n") dirs, files = paths.partition{ |f| File.dir?(f) } files.each do |file| next if /^\#/ =~ file # skip comments rm_f(file) if File.exist?(file) end dirs.each do |dir| # okay this is over kill, but playing it safe... empty = Dir[File.join(dir,'*')].empty? begin if no_harm? $stderr.puts "rmdir #{dir}" else rmdir(dir) if empty end rescue Errno::ENOTEMPTY $stderr.puts "may not be empty -- #{dir}" if verbose? end end rm_f(MANIFEST) end # # TASK clean # def exec_clean exec_task_traverse 'clean' rm_f ConfigTable::CONFIGFILE #rm_f MANIFEST # only on clobber! end alias clean_dir_bin noop alias clean_dir_lib noop alias clean_dir_data noop alias clean_dir_conf noop alias clean_dir_man noop alias clean_dir_doc noop def clean_dir_ext(rel) return unless extdir?(curr_srcdir()) make 'clean' if File.file?('Makefile') end # # TASK distclean # def exec_distclean exec_task_traverse 'distclean' rm_f ConfigTable::CONFIGFILE rm_f MANIFEST end alias distclean_dir_bin noop alias distclean_dir_lib noop def distclean_dir_ext(rel) return unless extdir?(curr_srcdir()) make 'distclean' if File.file?('Makefile') end alias distclean_dir_data noop alias distclean_dir_conf noop alias distclean_dir_man noop def distclean_dir_doc(rel) if GENERATE_RDOCS rm_rf('rdoc') if File.directory?('rdoc') end end # # Traversing # def exec_task_traverse(task) run_hook "pre-#{task}" FILETYPES.each do |type| if type == 'ext' and config.without_ext == 'yes' $stderr.puts 'skipping ext/* by user option' if verbose? next end traverse task, type, "#{task}_dir_#{type}" end run_hook "post-#{task}" end def traverse(task, rel, mid) dive_into(rel) { run_hook "pre-#{task}" __send__ mid, rel.sub(%r[\A.*?(?:/|\z)], '') directories_of(curr_srcdir()).each do |d| traverse task, "#{rel}/#{d}", mid end run_hook "post-#{task}" } end def dive_into(rel) return unless File.dir?("#{@srcdir}/#{rel}") dir = File.basename(rel) Dir.mkdir dir unless File.dir?(dir) prevdir = Dir.pwd Dir.chdir dir $stderr.puts '---> ' + rel if verbose? @currdir = rel yield Dir.chdir prevdir $stderr.puts '<--- ' + rel if verbose? @currdir = File.dirname(rel) end def run_hook(id) path = [ "#{curr_srcdir()}/#{id}", "#{curr_srcdir()}/#{id}.rb" ].detect {|cand| File.file?(cand) } return unless path begin instance_eval File.read(path), path, 1 rescue raise if $DEBUG setup_rb_error "hook #{path} failed:\n" + $!.message end end # File Operations # # This module requires: #verbose?, #no_harm? def binread(fname) File.open(fname, 'rb'){ |f| return f.read } end def mkdir_p(dirname, prefix = nil) dirname = prefix + File.expand_path(dirname) if prefix $stderr.puts "mkdir -p #{dirname}" if verbose? return if no_harm? # Does not check '/', it's too abnormal. dirs = File.expand_path(dirname).split(%r<(?=/)>) if /\A[a-z]:\z/i =~ dirs[0] disk = dirs.shift dirs[0] = disk + dirs[0] end dirs.each_index do |idx| path = dirs[0..idx].join('') Dir.mkdir path unless File.dir?(path) record_installation(path) # also record directories made end end def rm_f(path) $stderr.puts "rm -f #{path}" if verbose? return if no_harm? force_remove_file path end def rm_rf(path) $stderr.puts "rm -rf #{path}" if verbose? return if no_harm? remove_tree path end def rmdir(path) $stderr.puts "rmdir #{path}" if verbose? return if no_harm? Dir.rmdir path end def remove_tree(path) if File.symlink?(path) remove_file path elsif File.dir?(path) remove_tree0 path else force_remove_file path end end def remove_tree0(path) Dir.foreach(path) do |ent| next if ent == '.' next if ent == '..' entpath = "#{path}/#{ent}" if File.symlink?(entpath) remove_file entpath elsif File.dir?(entpath) remove_tree0 entpath else force_remove_file entpath end end begin Dir.rmdir path rescue Errno::ENOTEMPTY # directory may not be empty end end def move_file(src, dest) force_remove_file dest begin File.rename src, dest rescue File.open(dest, 'wb') {|f| f.write binread(src) } File.chmod File.stat(src).mode, dest File.unlink src end end def force_remove_file(path) begin remove_file path rescue end end def remove_file(path) File.chmod 0777, path File.unlink path end def install(from, dest, mode, prefix = nil) $stderr.puts "install #{from} #{dest}" if verbose? return if no_harm? realdest = prefix ? prefix + File.expand_path(dest) : dest realdest = File.join(realdest, File.basename(from)) if File.dir?(realdest) str = binread(from) if diff?(str, realdest) verbose_off { rm_f realdest if File.exist?(realdest) } File.open(realdest, 'wb') {|f| f.write str } File.chmod mode, realdest if prefix path = realdest.sub(prefix, '') else path = realdest end record_installation(path) end end def record_installation(path) File.open("#{objdir_root()}/#{MANIFEST}", 'a') do |f| f.puts(path) end end def diff?(new_content, path) return true unless File.exist?(path) new_content != binread(path) end def command(*args) $stderr.puts args.join(' ') if verbose? system(*args) or raise RuntimeError, "system(#{args.map{|a| a.inspect }.join(' ')}) failed" end def ruby(*args) command config.rubyprog, *args end def make(task = nil) command(*[config.makeprog, task].compact) end def extdir?(dir) File.exist?("#{dir}/MANIFEST") or File.exist?("#{dir}/extconf.rb") end def files_of(dir) Dir.open(dir) {|d| return d.select {|ent| File.file?("#{dir}/#{ent}") } } end DIR_REJECT = %w( . .. CVS SCCS RCS CVS.adm .svn ) def directories_of(dir) Dir.open(dir) {|d| return d.select {|ent| File.dir?("#{dir}/#{ent}") } - DIR_REJECT } end # # Hook Script API # # These require: #srcdir_root, #objdir_root, #relpath # # def get_config(key) config.__send__(key) end # obsolete: use metaconfig to change configuration # TODO: what to do with? def set_config(key, val) config[key] = val end # # srcdir/objdir (works only in the package directory) # def curr_srcdir "#{srcdir_root()}/#{relpath()}" end def curr_objdir "#{objdir_root()}/#{relpath()}" end def srcfile(path) "#{curr_srcdir()}/#{path}" end def srcexist?(path) File.exist?(srcfile(path)) end def srcdirectory?(path) File.dir?(srcfile(path)) end def srcfile?(path) File.file?(srcfile(path)) end def srcentries(path = '.') Dir.open("#{curr_srcdir()}/#{path}") {|d| return d.to_a - %w(. ..) } end def srcfiles(path = '.') srcentries(path).select {|fname| File.file?(File.join(curr_srcdir(), path, fname)) } end def srcdirectories(path = '.') srcentries(path).select {|fname| File.dir?(File.join(curr_srcdir(), path, fname)) } end end # CLI runner. def self.run_cli installer = Setup::Installer.new task = ARGV.find{ |a| a !~ /^[-]/ } task = 'all' unless task unless Setup::Installer::TASKS.include?(task) $stderr.puts "Not a valid task -- #{task}" exit 1 end opts = OptionParser.new opts.banner = "Usage: #{File.basename($0)} [task] [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 # Generate help text. def self.help fmt = " " * 10 + "%-10s %s" commands = Installer::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 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 END text.gsub(/^ \ \ \ \ \ /, '') end # def self.run_rake installer = Setup::Installer.new installer.rake_define end end # # Ruby Extensions # unless File.respond_to?(:read) # Ruby 1.6 and less def File.read(fname) open(fname) {|f| return f.read } end end unless Errno.const_defined?(:ENOTEMPTY) # Windows? module Errno class ENOTEMPTY # We do not raise this exception, implementation is not needed. end end end # for corrupted Windows' stat(2) def File.dir?(path) File.directory?((path[-1,1] == '/') ? path : path + '/') end # # Runners # if $0 == __FILE__ Setup.run_cli elsif defined?(Rake) Setup.run_rake end