setup 5.0.1 → 5.1.0

data/lib/setup/session.rb

@@ -5,7 +5,7 @@ require 'setup/configuration'
 require 'setup/compiler'
 require 'setup/installer'
 require 'setup/tester'
-require 'setup/documentor'
+#require 'setup/documentor'
 require 'setup/uninstaller'
 
 module Setup
@@ -24,6 +24,15 @@ module Setup
 
     # #  O P T I O N S  # #
 
+    ## Reset configuration?
+    #def reset?
+    #  @options[:reset]
+    #end
+
+    #def reset=(value)
+    #  @options[:reset] = value
+    #end
+
     #
     def io
       @options[:io]
@@ -44,11 +53,13 @@ module Setup
 
     #
     def trial?; @options[:trial]; end
+    alias_method :dryrun?, :trial?
 
     #
     def trial=(val)
       @options[:trial] = val
     end
+    alias_method :dryrun=, :trial=
 
     #
     def quiet?; @options[:quiet]; end
@@ -77,54 +88,56 @@ module Setup
     #
     # * config
     # * make
-    # * test      (if selected)
+    # * test      (optional)
     # * 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 compile?
+        config
+        compile
+      #end
       if configuration.test?
         ok = test
         exit 1 unless ok
       end
       install
-      if configuration.ri?
-        document
-      end
+      #if configuration.ri?
+      #  document
+      #end
     end
 
     #
     def config
-      log_header('Configure')
+      log_header('Preconfig')
+      #if reset?
+      #  @configuration = Configuration.new(:reset=>true)
+      #end
       if configuration.save_config
-        io.puts "Configuration saved." unless quiet?
+        io.print "#{CONFIG_FILE} was saved. " unless quiet?
       else
-        io.puts "Configuration current." unless quiet?
+        io.print "#{CONFIG_FILE} is current. " unless quiet?
       end
+      io.puts "Edit to customize configuration." unless quiet?
       puts configuration if trace? && !quiet?
-      compiler.configure if compile? #compiler.compiles?
     end
 
     #
-    def make
-      abort "must run 'setup config' first" unless configuration.exist?
-      log_header('Compile')
-      compiler.compile
+    def compile
+      if compile?
+        log_header('Compile')
+        compiler.configure
+        #abort "must run 'setup config' first" unless configuration.exist?
+        compiler.compile
+      end
     end
 
     # What #make used to be called.
+    alias_method :make, :compile
     alias_method :setup, :make
 
     #
     def install
-      abort "must run 'setup config' first" unless configuration.exist?
+      #abort "must run 'setup config' first" unless configuration.exist?
       log_header('Install')
       installer.install
     end
@@ -137,11 +150,11 @@ module Setup
     end
 
     #
-    def document
-      #return unless configuration.doc?
-      log_header('Document')
-      documentor.document
-    end
+    #def document
+    #  #return unless configuration.doc?
+    #  log_header('Document')
+    #  documentor.document
+    #end
 
     #
     def clean
@@ -195,9 +208,9 @@ module Setup
       @tester ||= Tester.new(project, configuration, options)
     end
     #
-    def documentor
-      @documentor ||= Documentor.new(project, configuration, options)
-    end
+    #def documentor
+    #  @documentor ||= Documentor.new(project, configuration, options)
+    #end
     #
     def uninstaller
       @uninstaller ||= Uninstaller.new(project, configuration, options)

data/lib/setup/version.rb

@@ -0,0 +1,4 @@
+module Setup
+  VERSION = '5.1.0'  #:erb: VERSION = '<%= version %>'
+end
+

data/meta/authors

@@ -1,3 +1,5 @@
-Minero Aoki <aamine@loveruby.net>
-7rans <transfire@gmail.com>
+---
+- 7rans <transfire@gmail.com>
+- Minero Aoki <aamine@loveruby.net>
+
 

data/meta/copyrights

@@ -0,0 +1,4 @@
+---
+- 2009 Rubyworks   (BSD-2-Clause)
+- 2005 Minero Aoki (LGPL-2.0+)
+

data/meta/description

@@ -1,6 +1,6 @@
 Every Rubyist is aware of Minero Aoki's ever useful
 setup.rb script. It's how most of us used to install
-our ruby programs before RubyGems came along.And it's
+our ruby programs before RubyGems came along. And it's
 still mighty useful in certain scenarios, not the least
 of which is the job of the distribution package managers.
 Setup converts setup.rb into a stand-alone application.

data/meta/organization

@@ -0,0 +1 @@
+rubyworks

data/meta/repositories

@@ -0,0 +1,2 @@
+---
+upstream: git://github.com/rubyworks/setup.git

data/meta/requirements

@@ -0,0 +1,4 @@
+---
+- detroit  (build)
+- cucumber (test)
+- ae       (test)

data/meta/resources

@@ -0,0 +1,6 @@
+---
+home: http://rubyworks.github.com/setup
+code: http://github.com/rubyworks/setup
+bugs: http://github.com/rubyworks/setup/issues
+old : http://setup.rubyforge.org
+

data/meta/version

@@ -1 +1 @@
-5.0.1
+5.1.0

data/script/bundle

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+require 'fileutils'
+
 raise "Not the right place #{Dir.pwd}" unless File.directory?('lib')
 
 #scripts = (Dir['lib/*.rb'] + Dir['lib/**/*']).uniq
@@ -17,23 +19,30 @@ scripts = %w{
   lib/setup/base.rb
   lib/setup/compiler.rb
   lib/setup/configuration.rb
-  lib/setup/documentor.rb
   lib/setup/installer.rb
   lib/setup/tester.rb
   lib/setup/uninstaller.rb
   lib/setup/command.rb
-  bin/setup.rb
 }
 
+version = YAML.load_file('.ruby')['version']
+
 comment = <<-HERE
-#
-# Setup.rb, #{Time.now.strftime("%Y-%m-%d %H:%M:%S")}
+# Setup.rb v#{version}
 #
 # This is a stand-alone bundle of the setup.rb application.
 # You can place it in your projects script/ directory, or
-# rename it to 'setup.rb' and place it in your project's
+# call it 'setup.rb' and place it in your project's
 # root directory (just like old times).
 #
+# NOTE: As of version 5.1.0 this bundled rendition is also
+# being used for the bin/setup.rb exe. Rather than the previous:
+#
+#   require 'setup/command'
+#   Setup::Command.run
+#
+# By doing so, +rvm+ should be able to use it across all rubies
+# without issue and without needing to install it for each.
 HERE
 
 #
@@ -44,6 +53,7 @@ scripts.each do |script|
   bundle << "\n\n# %-16s #{"#" * 60}\n\n" % File.basename(script)
   bundle << File.read(script)
 end
+bundle << "\nSetup::Command.run"
 
 # remove setup requires
 bundle.gsub!(/require\s+["']setup\/(.*?)["']\s*$/, '')
@@ -60,5 +70,12 @@ File.open('script/setup', 'w') do |f|
   f << comment
   f << bundle
 end
-
 FileUtils.chmod(0744, 'script/setup')
+
+File.open('bin/setup.rb', 'w') do |f|
+  f << "#!/usr/bin/env ruby\n"
+  f << comment
+  f << bundle
+end
+FileUtils.chmod(0744, 'bin/setup.rb')
+

data/script/setup

@@ -1,14 +1,35 @@
 #!/usr/bin/env ruby
-#
-# Setup.rb, 2010-02-07 08:33:15
+# Setup.rb v5.1.0
 #
 # This is a stand-alone bundle of the setup.rb application.
 # You can place it in your projects script/ directory, or
-# rename it to 'setup.rb' and place it in your project's
+# call it 'setup.rb' and place it in your project's
 # root directory (just like old times).
 #
+# NOTE: As of version 5.1.0 this bundled rendition is also
+# being used for the bin/setup.rb exe. Rather than the previous:
+#
+#   require 'setup/command'
+#   Setup::Command.run
+#
+# By doing so, +rvm+ should be able to use it across all rubies
+# without issue and without needing to install it for each.
+require 'yaml'
 module Setup
-  VERSION   = '5.0.1'
+  DIRECTORY = File.dirname(__FILE__) + '/setup'
+  PROFILE = YAML.load(File.new(DIRECTORY + '/profile.yml'))
+  verfile = YAML.load(File.new(DIRECTORY + '/version.yml'))
+  VERSION = verfile.values_at('major','minor','patch','state','build').compact.join('.')
+  def self.const_missing(name)
+    key = name.to_s.downcase
+    if verfile.key?(key)
+      verfile[key]
+    elsif profile.key?(key)
+      PROFILE[key]
+    else
+      super(name)
+    end
+  end
 end
 class << File #:nodoc: all
   unless respond_to?(:read)   # Ruby 1.6 and less
@@ -29,14 +50,42 @@ end
 module Setup
   META_EXTENSION_DIR = '.setup'
   FILETYPES = %w( bin lib ext data etc man doc )
-  INSTALL_RECORD = 'InstalledFiles'  #'.cache/setup/installedfiles'
+  INSTALL_RECORD = 'SetupReceipt'
+  CONFIG_FILE = 'SetupConfig'
 end
 module Setup
   class Project
-    ROOT_MARKER = '{setup.rb,script/setup,meta/,MANIFEST,lib/}'
+    ROOT_MARKER = '{.ruby,setup.rb,.setup,lib/}'
+    def initialize
+      @dotruby_file = find('.ruby')
+      @dotruby = YAML.load_file(@dotruby_file) if @dotruby_file
+      @name     = nil
+      @version  = nil
+      @loadpath = ['lib']
+      if @dotruby
+        @name     = @dotruby['name']
+        @version  = @dotruby['version']
+        @loadpath = @dotruby['load_path']
+      else
+        if file = find('.setup/name')
+          @name = File.read(file).strip
+        end
+        if file = find('.setup/version')
+          @version = File.read(file).strip
+        end
+        if file = find('.setup/loadpath')
+          @loadpath = File.read(file).strip
+        end
+      end
+    end
+    attr :dotruby
+    attr :name
+    attr :version
+    attr :loadpath
+    alias load_path loadpath
     def rootdir
       @rootdir ||= (
-        root = Dir[File.join(Dir.pwd, ROOT_MARKER)].first
+        root = Dir.glob(File.join(Dir.pwd, ROOT_MARKER), File::FNM_CASEFOLD).first
         if !root
           raise Error, "not a project directory"
         else
@@ -44,27 +93,6 @@ module Setup
         end
       )
     end
-    def name
-      @name = (
-        if file = Dir["{script/setup,meta,.meta}/name"].first
-          File.read(file).strip
-        else
-          nil
-        end
-      )
-    end
-    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
@@ -74,6 +102,21 @@ module Setup
     def compiles?
       !extensions.empty?
     end
+    def yardopts
+      Dir.glob(File.join(rootdir, '.yardopts')).first
+    end
+    def document
+      Dir.glob(File.join(rootdir, '.document')).first
+    end
+    def find(glob, flags=0)
+      case flags
+      when :casefold
+        flags = File::FNM_CASEFOLD
+      else
+        flags = flags.to_i
+      end      
+      Dir.glob(File.join(rootdir, glob), flags).first
+    end
   end
 end
 module Setup
@@ -94,9 +137,11 @@ module Setup
       @options[:trace] = val
     end
     def trial?; @options[:trial]; end
+    alias_method :dryrun?, :trial?
     def trial=(val)
       @options[:trial] = val
     end
+    alias_method :dryrun=, :trial=
     def quiet?; @options[:quiet]; end
     def quiet=(val)
       @options[:quiet] = val
@@ -109,37 +154,34 @@ module Setup
       configuration.compile? && project.compiles?
     end
     def all
-      config
-      if compile?
-        make
-      end
+        config
+        compile
       if configuration.test?
         ok = test
         exit 1 unless ok
       end
       install
-      if configuration.ri?
-        document
-      end
     end
     def config
-      log_header('Configure')
+      log_header('Preconfig')
       if configuration.save_config
-        io.puts "Configuration saved." unless quiet?
+        io.print "#{CONFIG_FILE} was saved. " unless quiet?
       else
-        io.puts "Configuration current." unless quiet?
+        io.print "#{CONFIG_FILE} is current. " unless quiet?
       end
+      io.puts "Edit to customize configuration." unless quiet?
       puts configuration if trace? && !quiet?
-      compiler.configure if compile? #compiler.compiles?
     end
-    def make
-      abort "must run 'setup config' first" unless configuration.exist?
-      log_header('Compile')
-      compiler.compile
+    def compile
+      if compile?
+        log_header('Compile')
+        compiler.configure
+        compiler.compile
+      end
     end
+    alias_method :make, :compile
     alias_method :setup, :make
     def install
-      abort "must run 'setup config' first" unless configuration.exist?
       log_header('Install')
       installer.install
     end
@@ -148,10 +190,6 @@ module Setup
       log_header('Test')
       tester.test
     end
-    def document
-      log_header('Document')
-      documentor.document
-    end
     def clean
       log_header('Clean')
       compiler.clean
@@ -187,9 +225,6 @@ module Setup
     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
@@ -331,8 +366,7 @@ require 'shellwords'
 module Setup
   class Configuration
     RBCONFIG  = ::Config::CONFIG
-    CONFIG_FILE = 'SetupConfig'  # '.cache/setup/config'
-    META_CONFIG_FILE = META_EXTENSION_DIR + '/configuration.rb'
+    META_CONFIG_FILE = META_EXTENSION_DIR + '/metaconfig.rb'
     def self.options
       @@options ||= []
     end
@@ -362,7 +396,6 @@ module Setup
     option :extconfopt      , :opts, 'options to pass-thru to extconf.rb'
     option :shebang         , :pick, 'shebang line (#!) editing mode (all,ruby,never)'
     option :no_test, :t     , :bool, 'run pre-installation tests'
-    option :no_ri,   :d     , :bool, 'generate ri documentation'
     option :no_doc          , :bool, 'install doc/ directory'
     option :no_ext          , :bool, 'compile/install ruby extentions'
     option :install_prefix  , :path, 'install to alternate root location'
@@ -393,9 +426,9 @@ module Setup
       initialize_metaconfig
       initialize_defaults
       initialize_environment
-      initialize_configfile
+      initialize_configfile unless values[:reset]
       values.each{ |k,v| __send__("#{k}=", v) }
-      yeild(self) if block_given?
+      yield(self) if block_given?
     end
     def initialize_metaconfig
       if File.exist?(META_CONFIG_FILE)
@@ -407,7 +440,7 @@ module Setup
       self.type    = 'site'
       self.no_ri   = true
       self.no_test = true
-      self.no_doc  = false
+      self.no_doc  = true
       self.no_ext  = false
     end
     def initialize_environment
@@ -418,7 +451,7 @@ module Setup
       end
     end
     def initialize_configfile
-      if File.exist?(CONFIG_FILE)
+      if exist?
         erb = ERB.new(File.read(CONFIG_FILE))
         txt = erb.result(binding)
         dat = YAML.load(txt)
@@ -436,6 +469,7 @@ module Setup
         end
       end
     end
+    attr_accessor :reset
     def base_bindir
       @base_bindir ||= subprefix('bindir')
     end
@@ -653,9 +687,6 @@ module Setup
     def test?
       !no_test
     end
-    def ri?
-      !no_ri
-    end
     def doc?
       !no_doc
     end
@@ -772,96 +803,6 @@ end #module Setup
       end
     end
 =end
-module Setup
-  class Documentor < Base
-    def document
-      return if config.no_doc
-      exec_ri
-    end
-    def exec_ri
-      case config.type #installdirs
-      when 'std', 'ruby'
-        output  = "--ri-site"
-      when 'site'
-        output = "--ri-site"
-      when 'home'
-        output = "--ri"
-      else
-        abort "bad config: should not be possible -- type=#{config.type}"
-      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 = []
-        files << 'lib' if File.directory?('lib')
-        files << 'ext' if File.directory?('ext')
-      end
-      opt = []
-      opt << "-U"
-      opt << "-q" #if quiet?
-      opt << output
-      opt << files
-      opt = opt.flatten
-      cmd = "rdoc " + opt.join(' ')
-      if trial?
-        puts cmd
-      else
-        begin
-          success = system(cmd)
-          raise unless success
-          io.puts "Ok ri." #unless quiet?
-        rescue Exception
-          $stderr.puts "ri generation failed"
-          $stderr.puts "command was: '#{cmd}'"
-        end
-      end
-    end
-    def exec_rdoc
-      main = Dir.glob("README{,.*}", File::FNM_CASEFOLD).first
-      if File.exist?('.document')
-        files = File.read('.document').split("\n")
-        files.reject!{ |l| l =~ /^\s*[#]/ || l !~ /\S/ }
-        files.collect!{ |f| f.strip }
-      else
-        files = []
-        files << main  if main
-        files << 'lib' if File.directory?('lib')
-        files << 'ext' if File.directory?('ext')
-      end
-      checkfiles = (files + files.map{ |f| Dir[File.join(f,'*','**')] }).flatten.uniq
-      if FileUtils.uptodate?('doc/rdoc', checkfiles)
-        puts "RDocs look current."
-        return
-      end
-      output    = 'doc/rdoc'
-      title     = (PACKAGE.capitalize + " API").strip if PACKAGE
-      template  = config.doctemplate || 'html'
-      opt = []
-      opt << "-U"
-      opt << "-q" #if quiet?
-      opt << "--op=#{output}"
-      opt << "--title=#{title}"
-      opt << "--main=#{main}"     if main
-      opt << files
-      opt = opt.flatten
-      cmd = "rdoc " + opt.join(' ')
-      if trial?
-        puts cmd 
-      else
-        begin
-          system(cmd)
-          puts "Ok rdoc." unless quiet?
-        rescue Exception
-          puts "Fail rdoc."
-          puts "Command was: '#{cmd}'"
-          puts "Proceeding with install anyway."
-        end
-      end
-    end
-  end
-end
 module Setup
   class Installer < Base
     def install_prefix
@@ -924,7 +865,7 @@ module Setup
       return unless config.doc?
       return unless directory?('doc')
       return unless project.name
-      dir = File.join(config.docdir, "ruby-{project.name}")
+      dir = File.join(config.docdir, "ruby-#{project.name}")
       report_transfer('doc', dir)
       files = files('doc')
       install_files('doc', files, dir, 0644)
@@ -1201,16 +1142,15 @@ module Setup
       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 'all'      , "config, compile and install"
+    task 'config'   , "save/customize configuration settings"
+    task 'compile'  , "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"
+    task 'uninstall', "uninstall previously installed files"
     def run(*argv)
       ARGV.replace(argv) unless argv.empty?
       task = ARGV.find{ |a| a !~ /^[-]/ }
@@ -1224,12 +1164,14 @@ module Setup
       parser.banner = "Usage: #{File.basename($0)} [TASK] [OPTIONS]"
       optparse_header(parser, options)
       case task
-      when 'all'
-        optparse_all(parser, options)
       when 'config'
         optparse_config(parser, options)
+      when 'compile'
+        optparse_compile(parser, options)
       when 'install'
         optparse_install(parser, options)
+      when 'all'
+        optparse_all(parser, options)
       end
       optparse_common(parser, options)
       begin
@@ -1240,6 +1182,11 @@ module Setup
       end
       rootdir = session.project.rootdir
       print_header
+      begin
+        $stderr.puts "(#{RUBY_ENGINE} #{RUBY_VERSION} #{RUBY_PLATFORM})"
+      rescue
+        $stderr.puts "(#{RUBY_VERSION} #{RUBY_PLATFORM})"
+      end
       begin
         session.__send__(task)
       rescue Error => err
@@ -1261,6 +1208,8 @@ module Setup
     end
     def optparse_all(parser, options)
       optparse_config(parser, options)
+      optparse_compile(parser, options)
+      optparse_install(parser, options)  # TODO: why was this remarked out ?
     end
     def optparse_config(parser, options)
       parser.separator ""
@@ -1287,19 +1236,28 @@ module Setup
             end
           end
         else
-          opts = shortcut ? ["-#{shortcut}", "--#{optname} #{type.to_s.upcase}", desc] : ["--#{optname} #{type.to_s.upcase}", desc]
+          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
+    def optparse_compile(parser, options)
+    end
     def optparse_install(parser, options)
-      parser.separator ""
-      parser.separator "Install options:"
-      parser.on("--prefix PATH", "Installation prefix") do |val|
+      parser.separator ''
+      parser.separator 'Install options:'
+      parser.on('--prefix PATH', 'install to alternate root location') do |val|
         configuration.install_prefix = val
       end
+      parser.on('--type TYPE', "install location mode (site,std,home)") do |val|
+        configuration.type = val
+      end
+      parser.on('-t', '--[no-]test', "run pre-installation tests") do |bool|
+        configuration.test = bool
+      end
     end
     def optparse_common(parser, options)
       parser.separator ""
@@ -1341,4 +1299,4 @@ module Setup
     end
   end
 end
-Setup::Command.run
+Setup::Command.run