libgems 0.0.1

data/lib/libgems/install_update_options.rb

@@ -0,0 +1,125 @@
+#--
+# Copyright 2006 by Chad Fowler, Rich Kilmer, Jim Weirich and others.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+require 'libgems'
+require 'libgems/security'
+
+##
+# Mixin methods for install and update options for LibGems::Commands
+
+module LibGems::InstallUpdateOptions
+
+  ##
+  # Add the install/update options to the option parser.
+
+  def add_install_update_options
+    OptionParser.accept LibGems::Security::Policy do |value|
+      value = LibGems::Security::Policies[value]
+      valid = LibGems::Security::Policies.keys.sort
+      message = "#{value} (#{valid.join ', '} are valid)"
+      raise OptionParser::InvalidArgument, message if value.nil?
+      value
+    end
+
+    add_option(:"Install/Update", '-i', '--install-dir DIR',
+               'Gem repository directory to get installed',
+               'gems') do |value, options|
+      options[:install_dir] = File.expand_path(value)
+    end
+
+    add_option(:"Install/Update", '-n', '--bindir DIR',
+	       'Directory where binary files are',
+	       'located') do |value, options|
+      options[:bin_dir] = File.expand_path(value)
+    end
+
+    add_option(:"Install/Update", '-d', '--[no-]rdoc',
+               'Generate RDoc documentation for the gem on',
+               'install') do |value, options|
+      options[:generate_rdoc] = value
+    end
+
+    add_option(:"Install/Update", '--[no-]ri',
+               'Generate RI documentation for the gem on',
+               'install') do |value, options|
+      options[:generate_ri] = value
+    end
+
+    add_option(:"Install/Update", '-E', '--[no-]env-shebang',
+               "Rewrite the shebang line on installed",
+               "scripts to use /usr/bin/env") do |value, options|
+      options[:env_shebang] = value
+    end
+
+    add_option(:"Install/Update", '-f', '--[no-]force',
+               'Force gem to install, bypassing dependency',
+               'checks') do |value, options|
+      options[:force] = value
+    end
+
+    add_option(:"Install/Update", '-t', '--[no-]test',
+               'Run unit tests prior to installation') do |value, options|
+      options[:test] = value
+    end
+
+    add_option(:"Install/Update", '-w', '--[no-]wrappers',
+               'Use bin wrappers for executables',
+               'Not available on dosish platforms') do |value, options|
+      options[:wrappers] = value
+    end
+
+    add_option(:"Install/Update", '-P', '--trust-policy POLICY',
+               LibGems::Security::Policy,
+               'Specify gem trust policy') do |value, options|
+      options[:security_policy] = value
+    end
+
+    add_option(:"Install/Update", '--ignore-dependencies',
+               'Do not install any required dependent gems') do |value, options|
+      options[:ignore_dependencies] = value
+    end
+
+    add_option(:"Install/Update", '-y', '--include-dependencies',
+               'Unconditionally install the required',
+               'dependent gems') do |value, options|
+      options[:include_dependencies] = value
+    end
+
+    add_option(:"Install/Update",       '--[no-]format-executable',
+               'Make installed executable names match ruby.',
+               'If ruby is ruby18, foo_exec will be',
+               'foo_exec18') do |value, options|
+      options[:format_executable] = value
+    end
+
+    add_option(:"Install/Update",       '--[no-]user-install',
+               'Install in user\'s home directory instead',
+               'of GEM_HOME.') do |value, options|
+      options[:user_install] = value
+    end
+
+    add_option(:"Install/Update", "--development",
+                "Install any additional development",
+                "dependencies") do |value, options|
+      options[:development] = true
+    end
+
+    add_option(:"Install/Update", "--conservative",
+                "Don't attempt to upgrade gems already",
+                "meeting version requirement") do |value, options|
+      options[:conservative] = true
+    end
+  end
+
+  ##
+  # Default options for the gem install command.
+
+  def install_update_defaults_str
+    '--rdoc --no-force --no-test --wrappers'
+  end
+
+end
+

data/lib/libgems/installer.rb

@@ -0,0 +1,604 @@
+#--
+# Copyright 2006 by Chad Fowler, Rich Kilmer, Jim Weirich and others.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+require 'fileutils'
+require 'rbconfig'
+
+require 'libgems/format'
+require 'libgems/ext'
+require 'libgems/require_paths_builder'
+
+##
+# The installer class processes RubyGem .gem files and installs the files
+# contained in the .gem into the LibGems.path.
+#
+# LibGems::Installer does the work of putting files in all the right places on the
+# filesystem including unpacking the gem into its gem dir, installing the
+# gemspec in the specifications dir, storing the cached gem in the cache dir,
+# and installing either wrappers or symlinks for executables.
+#
+# The installer fires pre and post install hooks.  Hooks can be added either
+# through a rubygems_plugin.rb file in an installed gem or via a
+# rubygems/defaults/#{RUBY_ENGINE}.rb or rubygems/defaults/operating_system.rb
+# file.  See LibGems.pre_install and LibGems.post_install for details.
+
+class LibGems::Installer
+
+  ##
+  # Paths where env(1) might live.  Some systems are broken and have it in
+  # /bin
+
+  ENV_PATHS = %w[/usr/bin/env /bin/env]
+
+  ##
+  # Raised when there is an error while building extensions.
+  #
+  class ExtensionBuildError < LibGems::InstallError; end
+
+  include LibGems::UserInteraction
+
+  include LibGems::RequirePathsBuilder
+
+  ##
+  # The directory a gem's executables will be installed into
+
+  attr_reader :bin_dir
+
+  ##
+  # The gem repository the gem will be installed into
+
+  attr_reader :gem_home
+
+  ##
+  # The LibGems::Specification for the gem being installed
+
+  attr_reader :spec
+
+  ##
+  # The options passed when the LibGems::Installer was instantiated.
+  
+  attr_accessor :options
+
+  @path_warning = false
+
+  class << self
+
+    ##
+    # True if we've warned about PATH not including LibGems.bindir
+
+    attr_accessor :path_warning
+
+    attr_writer :exec_format
+
+    # Defaults to use Ruby's program prefix and suffix.
+    def exec_format
+      @exec_format ||= LibGems.default_exec_format
+    end
+
+  end
+
+  ##
+  # Constructs an Installer instance that will install the gem located at
+  # +gem+.  +options+ is a Hash with the following keys:
+  #
+  # :env_shebang:: Use /usr/bin/env in bin wrappers.
+  # :force:: Overrides all version checks and security policy checks, except
+  #          for a signed-gems-only policy.
+  # :ignore_dependencies:: Don't raise if a dependency is missing.
+  # :install_dir:: The directory to install the gem into.
+  # :format_executable:: Format the executable the same as the ruby executable.
+  #                      If your ruby is ruby18, foo_exec will be installed as
+  #                      foo_exec18.
+  # :security_policy:: Use the specified security policy.  See LibGems::Security
+  # :wrappers:: Install wrappers if true, symlinks if false.
+
+  def initialize(gem, options={})
+    @gem = gem
+    @options = options
+    process_options
+    load_gem_file
+    
+    if options[:user_install] and not options[:unpack] then
+      @gem_home = LibGems.user_dir
+      check_that_user_bin_dir_is_in_path
+    end
+
+    verify_gem_home(options[:unpack])
+
+    @spec = @format.spec
+
+    @gem_dir = File.join(@gem_home, "gems", @spec.full_name).untaint
+  end
+
+  ##
+  # Installs the gem and returns a loaded LibGems::Specification for the installed
+  # gem.
+  #
+  # The gem will be installed with the following structure:
+  #
+  #   @gem_home/
+  #     cache/<gem-version>.gem #=> a cached copy of the installed gem
+  #     gems/<gem-version>/... #=> extracted files
+  #     specifications/<gem-version>.gemspec #=> the LibGems::Specification
+
+  def install
+    # If we're forcing the install then disable security unless the security
+    # policy says that we only install singed gems.
+    @security_policy = nil if @force and @security_policy and
+                              not @security_policy.only_signed
+
+    unless @force
+      ensure_required_ruby_version_met
+      ensure_required_rubygems_version_met
+      ensure_dependencies_met unless @ignore_dependencies
+    end
+
+    LibGems.pre_install_hooks.each do |hook|
+      result = hook.call self
+
+      if result == false then
+        location = " at #{$1}" if hook.inspect =~ /@(.*:\d+)/
+
+        message = "pre-install hook#{location} failed for #{spec.full_name}"
+        raise LibGems::InstallError, message
+      end
+    end
+    
+    LibGems.ensure_gem_subdirectories @gem_home
+
+    FileUtils.mkdir_p @gem_dir
+
+    extract_files
+    build_extensions
+    
+    LibGems.post_build_hooks.each do |hook|
+      result = hook.call self
+
+      if result == false then
+        FileUtils.rm_rf @gem_dir
+
+        location = " at #{$1}" if hook.inspect =~ /@(.*:\d+)/
+
+        message = "post-build hook#{location} failed for #{spec.full_name}"
+        raise LibGems::InstallError, message
+      end
+    end
+    
+    generate_bin
+    write_spec
+
+    write_require_paths_file_if_needed
+
+    # HACK remove?  Isn't this done in multiple places?
+    cached_gem = File.join @gem_home, "cache", @gem.split(/\//).pop
+    unless File.exist? cached_gem then
+      FileUtils.cp @gem, File.join(@gem_home, "cache")
+    end
+
+    unless @spec.post_install_message.nil?
+      # Only for SlimGems
+      if @spec.name == LibGems::GEM_NAME
+        lines = @spec.post_install_message.split("\n")
+        lines.shift if lines.first.include?("Upgraded from #{LibGems::NAME}")
+        say lines.join("\n")
+      else
+        say @spec.post_install_message
+      end
+    end
+
+    @spec.loaded_from = File.join(@gem_home, 'specifications', @spec.spec_name)
+
+    @source_index.add_spec @spec
+
+    LibGems.post_install_hooks.each do |hook|
+      hook.call self
+    end
+
+    return @spec
+  rescue Zlib::GzipFile::Error
+    raise LibGems::InstallError, "gzip error installing #{@gem}"
+  end
+
+  ##
+  # Ensure that the dependency is satisfied by the current installation of
+  # gem.  If it is not an exception is raised.
+  #
+  # spec       :: LibGems::Specification
+  # dependency :: LibGems::Dependency
+
+  def ensure_dependency(spec, dependency)
+    unless installation_satisfies_dependency? dependency then
+      raise LibGems::InstallError, "#{spec.name} requires #{dependency}"
+    end
+    true
+  end
+
+  ##
+  # True if the gems in the source_index satisfy +dependency+.
+
+  def installation_satisfies_dependency?(dependency)
+    @source_index.find_name(dependency.name, dependency.requirement).size > 0
+  end
+
+  ##
+  # Unpacks the gem into the given directory.
+
+  def unpack(directory)
+    @gem_dir = directory
+    @format = LibGems::Format.from_file_by_path @gem, @security_policy
+    extract_files
+  end
+
+  ##
+  # Writes the .gemspec specification (in Ruby) to the gem home's
+  # specifications directory.
+
+  def write_spec
+    rubycode = @spec.to_ruby
+
+    file_name = File.join @gem_home, 'specifications', @spec.spec_name
+
+    file_name.untaint
+
+    File.open(file_name, "w") do |file|
+      file.puts rubycode
+    end
+  end
+
+  ##
+  # Creates windows .bat files for easy running of commands
+
+  def generate_windows_script(filename, bindir)
+    if LibGems.win_platform? then
+      script_name = filename + ".bat"
+      script_path = File.join bindir, File.basename(script_name)
+      File.open script_path, 'w' do |file|
+        file.puts windows_stub_script(bindir, filename)
+      end
+
+      say script_path if LibGems.configuration.really_verbose
+    end
+  end
+
+  def generate_bin
+    return if @spec.executables.nil? or @spec.executables.empty?
+
+    # If the user has asked for the gem to be installed in a directory that is
+    # the system gem directory, then use the system bin directory, else create
+    # (or use) a new bin dir under the gem_home.
+    bindir = @bin_dir ? @bin_dir : LibGems.bindir(@gem_home)
+
+    Dir.mkdir bindir unless File.exist? bindir
+    raise LibGems::FilePermissionError.new(bindir) unless File.writable? bindir
+
+    @spec.executables.each do |filename|
+      filename.untaint
+      bin_path = File.expand_path "#{@spec.bindir}/#{filename}", @gem_dir
+      mode = File.stat(bin_path).mode | 0111
+      File.chmod mode, bin_path
+
+      if @wrappers then
+        generate_bin_script filename, bindir
+      else
+        generate_bin_symlink filename, bindir
+      end
+    end
+  end
+
+  ##
+  # Creates the scripts to run the applications in the gem.
+  #--
+  # The Windows script is generated in addition to the regular one due to a
+  # bug or misfeature in the Windows shell's pipe.  See
+  # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/193379
+
+  def generate_bin_script(filename, bindir)
+    bin_script_path = File.join bindir, formatted_program_filename(filename)
+
+    File.join @gem_dir, @spec.bindir, filename
+
+    # HACK some gems don't have #! in their executables, restore 2008/06
+    #if File.read(exec_path, 2) == '#!' then
+      FileUtils.rm_f bin_script_path # prior install may have been --no-wrappers
+
+      File.open bin_script_path, 'w', 0755 do |file|
+        file.print app_script_text(filename)
+      end
+
+      say bin_script_path if LibGems.configuration.really_verbose
+
+      generate_windows_script filename, bindir
+    #else
+    #  FileUtils.rm_f bin_script_path
+    #  FileUtils.cp exec_path, bin_script_path,
+    #               :verbose => LibGems.configuration.really_verbose
+    #end
+  end
+
+  ##
+  # Creates the symlinks to run the applications in the gem.  Moves
+  # the symlink if the gem being installed has a newer version.
+
+  def generate_bin_symlink(filename, bindir)
+    if LibGems.win_platform? then
+      alert_warning "Unable to use symlinks on Windows, installing wrapper"
+      generate_bin_script filename, bindir
+      return
+    end
+
+    src = File.join @gem_dir, 'bin', filename
+    dst = File.join bindir, formatted_program_filename(filename)
+
+    if File.exist? dst then
+      if File.symlink? dst then
+        link = File.readlink(dst).split File::SEPARATOR
+        cur_version = LibGems::Version.create(link[-3].sub(/^.*-/, ''))
+        return if @spec.version < cur_version
+      end
+      File.unlink dst
+    end
+
+    FileUtils.symlink src, dst, :verbose => LibGems.configuration.really_verbose
+  end
+
+  ##
+  # Generates a #! line for +bin_file_name+'s wrapper copying arguments if
+  # necessary.
+
+  def shebang(bin_file_name)
+    ruby_name = LibGems::ConfigMap[:ruby_install_name] if @env_shebang
+    path = File.join @gem_dir, @spec.bindir, bin_file_name
+    first_line = File.open(path, "rb") {|file| file.gets}
+
+    if /\A#!/ =~ first_line then
+      # Preserve extra words on shebang line, like "-w".  Thanks RPA.
+      shebang = first_line.sub(/\A\#!.*?ruby\S*(?=(\s+\S+))/, "#!#{LibGems.ruby}")
+      opts = $1
+      shebang.strip! # Avoid nasty ^M issues.
+    end
+
+    if not ruby_name then
+      "#!#{LibGems.ruby}#{opts}"
+    elsif opts then
+      "#!/bin/sh\n'exec' #{ruby_name.dump} '-x' \"$0\" \"$@\"\n#{shebang}"
+    else
+      # Create a plain shebang line.
+      @env_path ||= ENV_PATHS.find {|env_path| File.executable? env_path }
+      "#!#{@env_path} #{ruby_name}"
+    end
+  end
+
+  def ensure_required_ruby_version_met
+    if rrv = @spec.required_ruby_version then
+      unless rrv.satisfied_by? LibGems.ruby_version then
+        raise LibGems::InstallError, "#{@spec.name} requires Ruby version #{rrv}."
+      end
+    end
+  end
+  
+  def ensure_required_rubygems_version_met
+    if rrgv = @spec.required_rubygems_version then
+      unless rrgv.satisfied_by? LibGems::Version.new(LibGems::GEM_VERSION) then
+        raise LibGems::InstallError,
+          "#{@spec.name} requires #{LibGems::NAME} version #{rrgv}. " +
+          "Try 'gem update --system' to update #{LibGems::NAME} itself."
+      end
+    end    
+  end
+  
+  def ensure_dependencies_met
+    deps = @spec.runtime_dependencies
+    deps |= @spec.development_dependencies if @development
+
+    deps.each do |dep_gem|
+      ensure_dependency @spec, dep_gem
+    end
+  end
+
+  def process_options
+    self.options = {
+      :bin_dir      => nil,
+      :env_shebang  => false,
+      :exec_format  => false,
+      :force        => false,
+      :install_dir  => LibGems.dir,
+      :source_index => LibGems.source_index,
+    }.merge options
+
+    @env_shebang         = options[:env_shebang]
+    @force               = options[:force]
+    gem_home             = options[:install_dir]
+    @gem_home            = File.expand_path(gem_home)
+    @ignore_dependencies = options[:ignore_dependencies]
+    @format_executable   = options[:format_executable]
+    @security_policy     = options[:security_policy]
+    @wrappers            = options[:wrappers]
+    @bin_dir             = options[:bin_dir]
+    @development         = options[:development]
+    @source_index        = options[:source_index]
+  end
+  
+  def load_gem_file
+    begin
+      @format = LibGems::Format.from_file_by_path @gem, @security_policy
+    rescue LibGems::Package::FormatError
+      raise LibGems::InstallError, "invalid gem format for #{@gem}"
+    end
+  end
+  
+  def check_that_user_bin_dir_is_in_path
+    user_bin_dir = File.join(@gem_home, 'bin')
+    unless ENV['PATH'].split(File::PATH_SEPARATOR).include? user_bin_dir then
+      unless self.class.path_warning then
+        alert_warning "You don't have #{user_bin_dir} in your PATH,\n\t  gem executables will not run."
+        self.class.path_warning = true
+      end
+    end
+  end
+  
+  def verify_gem_home(unpack = false)
+    FileUtils.mkdir_p @gem_home
+    raise LibGems::FilePermissionError, @gem_home unless
+      unpack or File.writable? @gem_home
+  end
+  
+  ##
+  # Return the text for an application file.
+
+  def app_script_text(bin_file_name)
+    <<-TEXT
+#{shebang bin_file_name}
+#
+# This file was generated by LibGems.
+#
+# The application '#{@spec.name}' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'libgems'
+
+version = "#{LibGems::Requirement.default}"
+
+if ARGV.first =~ /^_(.*)_$/ and LibGems::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem '#{@spec.name}', version
+load LibGems.bin_path('#{@spec.name}', '#{bin_file_name}', version)
+TEXT
+  end
+
+  ##
+  # return the stub script text used to launch the true ruby script
+
+  def windows_stub_script(bindir, bin_file_name)
+    <<-TEXT
+@ECHO OFF
+IF NOT "%~f0" == "~f0" GOTO :WinNT
+@"#{File.basename(LibGems.ruby).chomp('"')}" "#{File.join(bindir, bin_file_name)}" %1 %2 %3 %4 %5 %6 %7 %8 %9
+GOTO :EOF
+:WinNT
+@"#{File.basename(LibGems.ruby).chomp('"')}" "%~dpn0" %*
+TEXT
+  end
+
+  ##
+  # Builds extensions.  Valid types of extensions are extconf.rb files,
+  # configure scripts and rakefiles or mkrf_conf files.
+
+  def build_extensions
+    return if @spec.extensions.empty?
+    unless @spec.name == LibGems::GEM_NAME
+      say "Building native extensions.  This could take a while..."
+    end
+    start_dir = Dir.pwd
+    dest_path = File.join @gem_dir, @spec.require_paths.first
+    ran_rake = false # only run rake once
+
+    @spec.extensions.each do |extension|
+      break if ran_rake
+      results = []
+
+      builder = case extension
+                when /extconf/ then
+                  LibGems::Ext::ExtConfBuilder
+                when /configure/ then
+                  LibGems::Ext::ConfigureBuilder
+                when /rakefile/i, /mkrf_conf/i then
+                  ran_rake = true
+                  LibGems::Ext::RakeBuilder
+                else
+                  results = ["No builder for extension '#{extension}'"]
+                  nil
+                end
+
+      begin
+        Dir.chdir File.join(@gem_dir, File.dirname(extension))
+        results = builder.build(extension, @gem_dir, dest_path, results)
+
+        say results.join("\n") if LibGems.configuration.really_verbose
+
+      rescue
+        results = results.join "\n"
+
+        File.open('gem_make.out', 'wb') { |f| f.puts results }
+
+        message = <<-EOF
+ERROR: Failed to build gem native extension.
+
+#{results}
+
+Gem files will remain installed in #{@gem_dir} for inspection.
+Results logged to #{File.join(Dir.pwd, 'gem_make.out')}
+        EOF
+
+        raise ExtensionBuildError, message
+      ensure
+        Dir.chdir start_dir
+      end
+    end
+  end
+
+  ##
+  # Reads the file index and extracts each file into the gem directory.
+  #
+  # Ensures that files can't be installed outside the gem directory.
+
+  def extract_files
+    @gem_dir = File.expand_path @gem_dir
+
+    raise ArgumentError, "format required to extract from" if @format.nil?
+
+    dirs = []
+
+    @format.file_entries.each do |entry, file_data|
+      path = entry['path'].untaint
+
+      if path =~ /\A\// then # for extra sanity
+        raise LibGems::InstallError,
+              "attempt to install file into #{entry['path'].inspect}"
+      end
+
+      path = File.expand_path File.join(@gem_dir, path)
+
+      if path !~ /\A#{Regexp.escape @gem_dir}/ then
+        msg = "attempt to install file into %p under %p" %
+                [entry['path'], @gem_dir]
+        raise LibGems::InstallError, msg
+      end
+
+      FileUtils.rm_rf(path) if File.exists?(path)
+
+      dir = File.dirname(path)
+      if !dirs.include?(dir)
+        dirs << dir
+        FileUtils.mkdir_p dir
+      end
+
+      File.open(path, "wb") do |out|
+        out.write file_data
+      end
+
+      FileUtils.chmod entry['mode'], path
+
+      say path if LibGems.configuration.really_verbose
+    end
+  end
+
+  ##
+  # Prefix and suffix the program filename the same as ruby.
+
+  def formatted_program_filename(filename)
+    if @format_executable then
+      self.class.exec_format % File.basename(filename)
+    else
+      filename
+    end
+  end
+
+end
+