setup 5.0.1 → 5.1.0

data/lib/setup.rb

@@ -1,3 +1,4 @@
-module Setup
-  VERSION   = '5.0.1'
-end
+require 'yaml'
+require 'setup/version'
+require 'setup/session'
+

data/lib/setup/base.rb

@@ -44,7 +44,7 @@ module Setup
     # according to the name of the class. For instance to 
     # augment the behavior of the Installer, use:
     #
-    #   script/.setup/installer.rb
+    #   .setup/installer.rb
     #
     def initialize_hooks
       file = META_EXTENSION_DIR + "/#{self.class.name.downcase}.rb"

data/lib/setup/command.rb

@@ -32,16 +32,15 @@ module Setup
       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"
 
     # Run command.
 
@@ -54,6 +53,8 @@ module Setup
       task = ARGV.find{ |a| a !~ /^[-]/ }
       task = 'all' unless task
 
+      #task = 'doc' if task == 'document'
+
       unless task_names.include?(task)
         $stderr.puts "Not a valid task -- #{task}"
         exit 1
@@ -66,12 +67,14 @@ module Setup
 
       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)
 
@@ -87,6 +90,12 @@ module Setup
 
       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
@@ -120,14 +129,12 @@ module Setup
 
     def optparse_all(parser, options)
       optparse_config(parser, options)
-      #optparse_install(parser, options)
-      #parser.on("-t", "--[no-]test", "run tests") do |val|
+      optparse_compile(parser, options)
+      optparse_install(parser, options)  # TODO: why was this remarked out ?
+      #parser.on("-t", "--[no-]test", "run tests (default is --no-test)") 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|
+      #parser.on("--[no-]doc", "generate ri/yri documentation (default is --doc)") do |val|
       #  configuration.no_doc = val
       #end
     end
@@ -137,6 +144,9 @@ module Setup
     def optparse_config(parser, options)
       parser.separator ""
       parser.separator "Configuration options:"
+      #parser.on('--reset', 'reset configuration to default settings') do
+      #  session.reset = true
+      #end
       configuration.options.each do |args|
         args = args.dup
         desc = args.pop
@@ -160,7 +170,8 @@ 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
@@ -168,15 +179,27 @@ module Setup
       end
     end
 
+    #
+    def optparse_compile(parser, options)
+    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
+      parser.separator ''
+      parser.separator 'Install options:'
+      # install prefix overrides target prefix when installing
+      parser.on('--prefix PATH', 'install to alternate root location') do |val|
         configuration.install_prefix = val
       end
+      # type can override config
+      parser.on('--type TYPE', "install location mode (site,std,home)") do |val|
+        configuration.type = val
+      end
+      # test can be override config
+      parser.on('-t', '--[no-]test', "run pre-installation tests") do |bool|
+        configuration.test = bool
+      end
     end
 
     # Setup options for +test+ task.

data/lib/setup/configuration.rb

@@ -15,11 +15,11 @@ module Setup
     # Ruby System Configuration
     RBCONFIG  = ::Config::CONFIG
 
-    # Confgiuration file
-    CONFIG_FILE = 'SetupConfig'  # '.cache/setup/config'
+    ## Confgiuration file
+    #CONFIG_FILE = 'SetupConfig'  # '.cache/setup/config'
 
     # Custom configuration file.
-    META_CONFIG_FILE = META_EXTENSION_DIR + '/configuration.rb'
+    META_CONFIG_FILE = META_EXTENSION_DIR + '/metaconfig.rb'
 
     #
     def self.options
@@ -59,7 +59,8 @@ module Setup
     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'
+    # TODO: remove no_ri option in future version
+    #option :no_ri,   :d     , :bool, 'generate ri documentation (deprecated and ignored)'
     option :no_doc          , :bool, 'install doc/ directory'
     option :no_ext          , :bool, 'compile/install ruby extentions'
 
@@ -110,9 +111,10 @@ 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
 
     #
@@ -130,7 +132,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
       #@rbdir = siterubyver      #'$siterubyver'
       #@sodir = siterubyverarch  #'$siterubyverarch'
@@ -147,7 +149,7 @@ module Setup
 
     # Load configuration.
     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)
@@ -181,6 +183,8 @@ module Setup
     #  end
     #end
 
+    attr_accessor :reset
+
     # #  B A S E  D I R E C T O R I E S  # #
 
     #
@@ -266,13 +270,12 @@ module Setup
       end
     end
 
-    #
+    # Alias for `#type`.
     alias_method :installdirs, :type
 
-    #
+    # Alias for `#type=`.
     alias_method :installdirs=, :type=
 
-
     #
     alias_method :install_prefix, :root
 
@@ -529,16 +532,18 @@ module Setup
       @no_doc = boolean(val)
     end
 
-    #
+
+    # @deprecated Will be remove in future version. Currently ignored.
     def no_ri
       @no_ri
     end
 
-    #
+    # @deprecated Will be remove in future version. Currently ignored.
     def no_ri=(val)
       @no_ri = boolean(val)
     end
 
+
     #def rdoc            = 'no'
     #def rdoctemplate    = nil
     #def testrunner      = 'auto' # needed?
@@ -554,9 +559,9 @@ module Setup
     end
 
     # Generate ri documentation?
-    def ri?
-      !no_ri
-    end
+    #def ri?
+    #  !no_ri
+    #end
 
     # Install doc directory?
     def doc?

data/lib/setup/constants.rb

@@ -7,6 +7,9 @@ module Setup
   FILETYPES = %w( bin lib ext data etc man doc )
 
   #
-  INSTALL_RECORD = 'InstalledFiles'  #'.cache/setup/installedfiles'
+  INSTALL_RECORD = 'SetupReceipt'
+
+  #
+  CONFIG_FILE = 'SetupConfig'
 
 end

data/lib/setup/documentor.rb

@@ -2,57 +2,68 @@ require 'setup/base'
 
 module Setup
 
+  # As of v0.5.1 Setup.rb no longer support the document phase at all. The
+  # document phase would generate *ri* documentation for a project, adding in
+  # with the rest of ri documentation. After careful consideration, it has
+  # become clear that it is better for documentation to be left up to dedicated
+  # tools. For example, you could easily document your Ruby install site
+  # location yourself with
+  #
+  #   $ rdoc --ri-site /usr/local/lib/site_ruby
+  #
+  # Using of course, whichever path is appropriate to your system.
+  #
+  # This descision also allows setup.rb to be less Ruby-specific, and useful
+  # as a more general install tool.
+  #
+  # @deprecated Setup.rb no longer generate ri documentation, ever.
   #
   class Documentor < Base
 
     #
     def document
       return if config.no_doc
-      exec_ri
 
-      #if file = DOCSCRIPT
-      #  ruby(file)
-      #else
-      #  exec_rdoc
-      #end
+      exec_ri
+      exec_yri
     end
 
     # Generate ri documentation.
-    #++
-    # TODO: call rdoc programmatically.
-    #--
+    #
+    # @todo Should we run rdoc programmatically instead of shelling out?
+    #
     def exec_ri
       case config.type #installdirs
-      when 'std', 'ruby'
-        #output = "--ri-system" # no longer supported?
-        output  = "--ri-site"
-      when 'site'
-        output = "--ri-site"
       when 'home'
         output = "--ri"
+      when 'site'
+        output = "--ri-site"
+      when 'std', 'ruby'
+        output  = "--ri-site"
       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 }
-      #elsif File.exist?('meta/loadpath')
-      else
-        files = []
-        files << 'lib' if File.directory?('lib')
-        files << 'ext' if File.directory?('ext')
-      end
-
       opt = []
       opt << "-U"
       opt << "-q" #if quiet?
       #opt << "-D" #if $DEBUG
       opt << output
-      opt << files
 
-      opt = opt.flatten
+      unless project.document
+        files = []
+        files << 'lib' if project.find('lib')
+        files << 'ext' if project.find('ext')
+      else
+        files = []
+        #files = File.read('.document').split("\n")
+        #files.reject!{ |l| l =~ /^\s*[#]/ || l !~ /\S/ }
+        #files.collect!{ |f| f.strip }
+      end
+
+      opt.concat(files)
+
+      opt.flatten!
 
       cmd = "rdoc " + opt.join(' ')
 
@@ -70,24 +81,20 @@ module Setup
           $stderr.puts "command was: '#{cmd}'"
           #$stderr.puts "proceeding with install..."
         end
-
-        # Now in local directory
-        #opt = []
-        #opt << "-U"
-        #opt << "--ri --op 'doc/ri'"
-        #opt << files
-        #opt = opt.flatten
-        #::RDoc::RDoc.new.document(opt)
       end
     end
 
-    # Generate rdocs.
     #
-    # Needs <tt>meta/name</tt> or <tt>.meta/name</tt>.
+    # Generate YARD Ruby Index documention.
     #
-    # NOTE: This is not being used. It's here in case we decide
-    # to add this feature, though it is quite possible that
-    # we may never do so.
+    def exec_yri
+
+    end
+
+    # Generate rdocs. Needs project <tt>name</tt>.
+    #
+    # @deprecated This is not being used. It's here in case we decide
+    #   to add the feature back in the future.
     #
     def exec_rdoc
       main = Dir.glob("README{,.*}", File::FNM_CASEFOLD).first
@@ -146,4 +153,3 @@ module Setup
   end
 
 end
-

data/lib/setup/installer.rb

@@ -96,7 +96,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)
       #io.puts "* doc -> #{dir}" unless quiet?
       files = files('doc')
@@ -136,7 +136,7 @@ module Setup
         File.extname(file) == ".#{dllext}"
       end
       if ents.empty? && !files.empty?
-        raise Error, "ruby extention not compiled: 'setup.rb make' first"
+        raise Error, "ruby extention not compiled: 'setup.rb compile' first"
       end
       ents
     end

data/lib/setup/project.rb

@@ -1,53 +1,83 @@
 module Setup
 
-  # The Project class encapsulates information
-  # about the project/package setup is effecting.
-
+  # The Project class encapsulates information about the project/package
+  # setup is handling.
+  #
+  # To inform Setup.rb of the project's name, version and
+  # load path --information it can use to provide additional
+  # features, create a file in you project's root directory
+  # called `.ruby`. This is a YAML file with at minimum the
+  # entries:
+  #
+  #     ---
+  #     name: foo
+  #     version: 1.0.0
+  #     load_path: [lib]
+  #
+  # As of v5.1.0, Setup.rb no longer recognizes the VERSION file
+  # or the `.setup/name`, `.setup/version` and `.setup/loadpath` files.
+  # The `.ruby` file better serves this purpose and is a more widely
+  # recognized standard.
+  #
   class Project
 
     # Match used to determine the root dir of a project.
-    ROOT_MARKER = '{setup.rb,script/setup,meta/,MANIFEST,lib/}'
+    ROOT_MARKER = '{.ruby,setup.rb,.setup,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
+    #
+    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
+
     # 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
+    attr :name
 
-    # 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
+    # Current version number of project.
+    attr :version
+
+    #
+    attr :loadpath
+
+    alias load_path loadpath
+
+    # Locate project root.
+    def rootdir
+      @rootdir ||= (
+        root = Dir.glob(File.join(Dir.pwd, ROOT_MARKER), File::FNM_CASEFOLD).first
+        if !root
+          raise Error, "not a project directory"
         else
-          nil
+          Dir.pwd
         end
       )
     end
 
-    #
+    # Setup.rb uses `ext/**/extconf.rb` as convention for the location of
+    # compiled scripts.
     def extconfs
       @extconfs ||= Dir['ext/**/extconf.rb']
     end
@@ -62,7 +92,27 @@ module Setup
       !extensions.empty?
     end
 
+    #
+    def yardopts
+      Dir.glob(File.join(rootdir, '.yardopts')).first
+    end
+
+    #
+    def document
+      Dir.glob(File.join(rootdir, '.document')).first
+    end
+
+    # Find a file relative to project's root directory.
+    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
-