geminstaller 0.2.0

data/lib/geminstaller/ruby_gem.rb

@@ -0,0 +1,44 @@
+module GemInstaller
+  class RubyGem
+    include Comparable
+    attr_accessor :name, :version, :platform, :install_options, :check_for_upgrade, :fix_dependencies, :no_autogem, :prefer_binary_platform
+
+    def initialize(name, opts={})
+      @name = name
+      #TODO: the following logic could probably be more concise, but I'm not sure right now
+      @version = GemInstaller::RubyGem.default_version
+      if opts[:version] != "" && opts[:version] != nil 
+        @version = opts[:version] 
+      end
+      @platform = 'ruby'
+      if opts[:platform] != "" && opts[:platform] != nil 
+        @platform = opts[:platform]
+      end
+      @install_options = opts[:install_options] ||= []
+      @check_for_upgrade = opts[:check_for_upgrade] == true ? true : false
+      @fix_dependencies = opts[:fix_dependencies] == true ? true : false
+      @no_autogem = opts[:no_autogem] == true ? true : false
+      @prefer_binary_platform = opts[:prefer_binary_platorm] == false ? false : true
+    end
+
+    def self.default_version
+      '> 0.0.0'
+    end
+    
+    def self.default_platform
+      Gem::Platform::RUBY
+    end    
+
+    def <=>(other)
+      compare = @name <=> other.name
+      return compare if compare != 0
+      compare = @version <=> other.version
+      return compare if compare != 0
+      return @platform <=> other.platform
+    end
+    
+    def regexp_escaped_name
+      Regexp.escape(@name)
+    end
+  end
+end

data/lib/geminstaller/rubygems_exit.rb

@@ -0,0 +1,5 @@
+module GemInstaller
+  class RubyGemsExit < RuntimeError
+    # This is an exception which helps override the normal (no error) system 'exit' call in RubyGems' terminate_interaction 
+  end
+end

data/lib/geminstaller/rubygems_extensions.rb

@@ -0,0 +1,5 @@
+module Gem
+  class GemRunner
+    public :do_configuration
+  end
+end

data/lib/geminstaller/unauthorized_dependency_prompt_error.rb

@@ -0,0 +1,4 @@
+module GemInstaller
+  class UnauthorizedDependencyPromptError < GemInstaller::GemInstallerError
+  end
+end

data/lib/geminstaller/unexpected_prompt_error.rb

@@ -0,0 +1,4 @@
+module GemInstaller
+  class UnexpectedPromptError < GemInstaller::GemInstallerError
+  end
+end

data/lib/geminstaller/valid_platform_selector.rb

@@ -0,0 +1,44 @@
+module GemInstaller
+  class ValidPlatformSelector
+    attr_writer :options, :ruby_platform, :output_filter
+    
+    def select(gem_platform = nil, exact_platform_match = false)
+      @ruby_platform ||= RUBY_PLATFORM
+      return [@ruby_platform] if gem_platform == Gem::Platform::CURRENT
+      return [gem_platform] if exact_platform_match
+      valid_platforms = []
+      valid_platforms += binary_platform_substring if binary_platform_substring
+      if @options[:prefer_binary_platform] == false
+        # put ruby first if prefer_binary_platform is false
+        valid_platforms.unshift('ruby')
+      else
+        # leave binary platform first if prefer_binary_platform is false or nil
+        valid_platforms << 'ruby'
+      end
+      if gem_platform and 
+        !valid_platforms.include?(gem_platform)
+        # only prepend the gem_platform as the first choice if
+        # 1. it is not nil
+        # 2. it is not already in the list
+        # 3. it is not 'ruby'
+        valid_platforms.unshift(gem_platform)
+      end
+      message = "Selecting valid platform(s): @ruby_platform='#{@ruby_platform}', gem_platform='#{gem_platform}', valid_platforms='#{valid_platforms.inspect}'"
+      @output_filter.geminstaller_output(:debug,"#{message}\n")
+      valid_platforms
+    end
+    
+    def binary_platform_substring
+      return ['686-darwin'] if @ruby_platform =~ /686-darwin/
+      return ['cygwin'] if @ruby_platform =~ /cygwin/
+      return ['powerpc'] if @ruby_platform =~ /powerpc/
+      return ['i386-mswin32','mswin32'] if @ruby_platform =~ /mswin/
+      return ['386-linux'] if @ruby_platform =~ /386-linux/
+      return ['486-linux'] if @ruby_platform =~ /486-linux/
+      return ['586-linux'] if @ruby_platform =~ /586-linux/
+      return ['686-linux'] if @ruby_platform =~ /686-linux/
+      return ['solaris'] if @ruby_platform =~ /solaris/
+      return nil
+    end
+  end
+end

data/lib/geminstaller/version_specifier.rb

@@ -0,0 +1,24 @@
+module GemInstaller
+  class VersionSpecifier
+    # NOTE: available_versions should be sorted in descending order (highest versions first)
+    # This method will return the first matching version
+    def specify(version_requirement, available_versions, gem_name = nil)
+      rubygems_version_requirement = Gem::Version::Requirement.new [version_requirement]
+      if available_versions.respond_to? :to_str
+        available_versions = available_versions.split(', ')
+      end
+      available_versions.each do |available_version_string|
+        available_version = Gem::Version.new(available_version_string)
+        if rubygems_version_requirement.satisfied_by?(available_version)
+          return available_version.to_s
+        end
+      end
+      gem_name_msg = ''
+      if gem_name
+        gem_name_msg = "for gem '#{gem_name}' "
+      end
+      error_msg = "The specified version requirement '#{version_requirement}' #{gem_name_msg}is not met by any of the available versions: #{available_versions.join(', ')}."
+      raise GemInstaller::GemInstallerError.new(error_msg)
+    end
+  end
+end

data/lib/geminstaller/yaml_loader.rb

@@ -0,0 +1,22 @@
+module GemInstaller
+  class YamlLoader
+    def load(yaml_text)
+      yaml = nil
+      begin
+        yaml = YAML.load(yaml_text)
+      rescue Exception => e
+        message = e.message
+        error = <<-STRING_END
+Error: Received error while attempting to parse YAML from yaml text:
+  #{message}
+Please ensure this is valid YAML:
+
+#{yaml_text}\n\n"
+STRING_END
+
+        raise GemInstaller::GemInstallerError.new(error)
+      end
+      return yaml
+    end
+  end
+end

data/lib/geminstaller.rb

@@ -0,0 +1,102 @@
+dir = File.dirname(__FILE__)
+require File.expand_path("#{dir}/geminstaller/requires.rb")
+
+module GemInstaller
+  def self.run(args = [], geminstaller_executable = nil)
+    args_copy = args.dup
+    args_copy = args_copy.split(' ') unless args.respond_to? :join
+    # recursively call script with sudo, if --sudo option is specified
+    if platform_supports_sudo? and (args_copy.include?("-s") or args_copy.include?("--sudo"))
+      result = reinvoke_with_sudo(args_copy, geminstaller_executable)
+      if result != 0 and (args_copy.include?("-e") or args_copy.include?("--exceptions"))
+        message = "Error: GemInstaller failed while being invoked with --sudo option.  See prior output for error, and use '--geminstaller-output=all --rubygems-output=all' options to get more details."
+        raise GemInstaller::GemInstallerError.new(message)
+      end
+      return result
+    else
+      app = create_application(args_copy)
+      app.run
+    end
+  end 
+  
+  def self.autogem(args = [])
+    args_copy = args.dup
+    args_copy = args_copy.split(' ') unless args.respond_to? :join
+    # TODO: should explicitly remove all args not applicable to autogem (anything but config, silent, and geminstaller_output)
+    args_without_sudo = strip_sudo(args_copy)
+    app = create_application(args_without_sudo)
+    app.autogem
+  end
+
+  def self.version
+    "0.2.0"
+  end
+
+  def self.create_application(args = [], registry = nil)
+    registry ||= create_registry
+    app = registry.app
+    app.args = args
+    app
+  end
+  
+  def self.create_registry
+    dependency_injector = GemInstaller::DependencyInjector.new
+    dependency_injector.registry
+  end
+  
+  def self.parse_config_paths(config_paths)
+    return nil unless config_paths
+    return config_paths unless config_paths.respond_to? :join
+    return config_paths.join(',')
+  end
+  
+  def self.platform_supports_sudo?
+    return true unless RUBY_PLATFORM =~ /mswin/
+    return false
+  end
+  
+  def self.reinvoke_with_sudo(args, geminstaller_executable)
+    # TODO: this sudo support seems like a hack, but I don't have a better idea right now.  Ideally, we would
+    # invoke rubygems from the command line inside geminstaller.  However, we can't do that because rubygems
+    # currently doesn't provide a way to specify platform from the command line - it always pops up the list
+    # for multi-platform gems, and we have to extend/hack rubygems to manage that.
+    # Feel free to comment or improve it, this seems to work for now...
+    geminstaller_executable ||= find_geminstaller_executable
+    args_without_sudo = strip_sudo(args)
+    args_without_sudo << '--redirect-stderr-to-stdout'
+    cmd = "sudo ruby #{geminstaller_executable} #{args_without_sudo.join(' ')}"
+    # TODO: this eats any output.  There currently is no standard way to get a return code AND stdin AND stdout.
+    # Some non-standard packages like Open4 handle this, but not synchronously.  The Simplest Thing That Could
+    # Possibly Work s to have a command line option which will cause all stderr output to be redirected to stdout.
+    result = system(cmd)
+    return 1 unless result
+    return $?.exitstatus
+  end
+  
+  def self.strip_sudo(args)
+    return args.reject {|arg| arg == "-s" || arg == "--sudo"}
+  end
+  
+  def self.find_geminstaller_executable
+    possible_locations = [
+      'ruby -S geminstaller',
+      'ruby /usr/local/bin/geminstaller',
+      'ruby /usr/bin/geminstaller',
+      'ruby ./bin/geminstaller'
+      ]
+    path_key = 'geminstaller_exec_path='
+    possible_locations.each do |possible_location|
+      cmd = "#{possible_location} --geminstaller-exec-path"
+
+      $stderr_backup = $stderr.dup
+      $stderr.reopen("/dev/null", "w")
+      io = IO.popen(cmd)
+      $stderr = $stderr_backup.dup
+      output = io.read
+      next unless output =~ /#{path_key}/
+      path = output.sub(path_key,'')
+      return path
+    end
+    raise GemInstaller::GemInstallerError.new("Error: Unable to locate the geminstaller executable.  Specify it explicitly, or don't use the sudo option.")
+  end
+end

data/start_local_gem_server.sh

@@ -0,0 +1 @@
+gem_server --dir=./spec/fixture/gems --port=9909

data/test/test_all.rb

@@ -0,0 +1,31 @@
+# TODO: This is the only thing I could hack together in order to run the specs after upgrading
+# to Rspec 0.9.3.  Need to be back to all specs being runnable via 'rake' or 'test_all'
+# Are there any good examples of running rspec for a non-rails project, and allowing post-suite hooks?
+
+dir = File.dirname(__FILE__)
+specdir = File.expand_path("#{dir}/../spec")
+require File.expand_path("#{specdir}/helper/spec_helper")
+
+spec_files = Dir.glob("#{specdir}/**/*_spec.rb")
+# put test_gem_home_spec first so we only have to perform the install once
+spec_files.unshift(Dir.glob("#{specdir}/unit/test_gem_home_spec.rb")[0])
+spec_files.uniq
+
+args = spec_files
+args << "--color"
+args << "--format"
+args << "specdoc"
+args << "--diff"
+args << "unified"
+
+$behaviour_runner  = ::Spec::Runner::OptionParser.new.create_behaviour_runner(args, STDERR, STDOUT, false)
+
+retval = 1
+begin
+  retval = $behaviour_runner.run(args, false)
+ensure
+  $server_was_stopped = GemInstaller::EmbeddedGemServer.stop
+  GemInstaller::TestGemHome.reset
+end
+retval ||= 0
+raise "Specs failed, return value = #{retval}" unless retval == 0

data/website/config.yaml

@@ -0,0 +1,2 @@
+# Configuration file for webgen
+# Used to set the parameters of the plugins

data/website/metainfo.yaml

@@ -0,0 +1,72 @@
+index.page:
+  inMenu: true
+  orderInfo: 10
+
+documentation:
+  title: Documentation
+  orderInfo: 20
+
+download.page:
+  inMenu: true
+  orderInfo: 30
+
+faq.page:
+  inMenu: true
+  orderInfo: 40
+
+community:
+  title: Community
+  orderInfo: 50
+
+code:
+  title: Code
+  orderInfo: 60
+
+documentation/index.page:
+  inMenu: true
+  orderInfo: 10
+
+documentation/tutorials.page:
+  title: Tutorials
+  inMenu: true
+  orderInfo: 20
+
+documentation/documentation.page:
+  title: Documentation
+  inMenu: true
+  orderInfo: 30
+
+community/index.page:
+  inMenu: true
+  orderInfo: 10
+
+community/links.page:
+  title: Links
+  inMenu: true
+  orderInfo: 30
+
+code/index.page:
+  title: Design
+  inMenu: true
+  orderInfo: 10
+
+---
+community/rubyforge.html:
+  url: http://rubyforge.org/projects/geminstaller/
+  inMenu: true
+  title: Rubyforge
+  orderInfo: 40
+
+code/rdoc:
+  url: rdoc/index.html
+  inMenu: true
+  title: Rdoc
+  orderInfo: 20
+
+code/coverage:
+  url: coverage/index.html
+  inMenu: true
+  title: Coverage
+  orderInfo: 30
+
+

data/website/src/code/index.page

@@ -0,0 +1,25 @@
+---
+title: Design
+---
+h1. Design Notes
+
+These are some notes on the underlying design of GemInstaller, and the current state of development:
+
+* GemInstaller was developed from nothing but a concept, using "Behavior-Driven Development":http://behaviour-driven.org and "Rspec":http://rspec.rubyforge.org/.
+* GemInstaller uses "Dependency Injection", an architecture which has many benefits, including testability and enabling "loose coupling and high cohesion":http://www.c2.com/cgi/wiki?CouplingAndCohesion.  I originally started with "Needle":http://rubyforge.org/projects/needle/, a Ruby Dependency Injection framework, but switched to a simple home-grown approach in other to not have a dependency on the Needle gem.  Read more about Dependency Injection here:
+** "http://onestepback.org/index.cgi/Tech/Ruby/DependencyInjectionInRuby.rdoc":http://onestepback.org/index.cgi/Tech/Ruby/DependencyInjectionInRuby.rdoc
+** "http://onestepback.org/articles/depinj/":http://onestepback.org/articles/depinj/
+** "http://martinfowler.com/bliki/InversionOfControl.html":http://martinfowler.com/bliki/InversionOfControl.html 
+** "http://martinfowler.com/articles/injection.html":http://martinfowler.com/articles/injection.html
+** "http://www.theserverside.com/tt/articles/article.tss?l=IOCBeginners":http://www.theserverside.com/tt/articles/article.tss?l=IOCBeginners
+** "http://www.ibm.com/developerworks/edu/j-dw-java-springswing-i.html":http://www.ibm.com/developerworks/edu/j-dw-java-springswing-i.html
+* A lot of effort has gone into supporting isolated functional testing.  Every run of a functional spec or the spec suite creates a new "Test Gem Home" sandbox installation of RubyGems.  This creates a new GEM_HOME on the fly for each run.  This allows me to test actual gem installation without being connected to a network, and avoid mucking with (or having false failures due to) my actual local RubyGems gem repository.  Unfortunately, the Ruby load path still uses the executables from the system installation of RubyGems.  I plan on fixing that too (which will allow me to test multiple RubyGems versions), but that seems to be a much trickier task than just having a different GEM_HOME.
+* Spec/Test Philosophy:
+** GemInstaller's specs are grouped into distinct categories.  This and other testing approaches I use are heavily influenced by this fine article at GroboUtils: "Naming Your Junit Tests":http://groboutils.sourceforge.net/testing-junit/art_naming.html 
+** Unit vs. Functional: Many classes have two identically-named spec files associated with them, under unit and functional.  
+*** Unit Specs:  The Unit specs for the most part test only a single class in isolation, usually using mock objects, so they run very fast.  Many of them are vestiges of my initial BDD approach when I started from nothing.  I incur a little bit of overhead cost to maintain them as the app evolves, but I don't mind that as much as some people :).  They also come in very handy when I want to BDD some new behavior and don't want to have the high "Test Gem Home" fixture creation overhead that the functional specs have.
+*** Functional Specs:  These also have a one-to-one relationship with classes for the most part - geminstaller_spec is an exception.  Most of these test how groups of classes interact together at various levels.  Most of them use the "Test Gem Home" fixture approach.  This is effective, but adds several seconds to the startup of each run.  There is also overlap between some of them, especially at high levels of the API, which adds some maintenance overhead, but is worth it to me since it helps catch integration bugs.
+*** Smoke Tests: There are some tests under /spec/smoketests which I run manually.  These are really coarse grained scripts, and don't use Rspec or Test::Unit.  They hit the live rubygems.org gem repository, and install/uninstall actual gems.  They are used as a periodic check to ensure that my "Test Gem Home" fixture approach is not masking any real-life bugs.
+* I'm a proponent of high code coverage.  I check periodically to ensure I maintain close to 100% code coverage, not counting platform- and version-specific code blocks (and I'll get around to those some day).  Also, the sudo recursive invocation stuff still needs some tests, but that's a bit tricky to automate.
+* The tests are flaky on Windows (but run fine on mac/linux).  The app itself runs fine, so I believe it's something related to spawning processes for the test GEM_HOME and EmbeddedGemServer.  I plan to look at this too, eventually.
+* One of my motivations for creating GemInstaller was as an exercise to help me learn Ruby better.  If you see me doing anything obviously dumb or inefficient in the code or design, please let me know. Some of them I already know about, but haven't fixed, most I'm probably not aware of :)

data/website/src/community/index.page

@@ -0,0 +1,14 @@
+---
+title: Feedback
+---
+h1. Feedback, Bugs, and Source Code
+
+h2. Rubyforge Bug/Feature Tracker and Mailing Lists
+
+* "RubyForge Page":http://rubyforge.org/projects/geminstaller/
+* "Bug/Feature Tracker":http://rubyforge.org/tracker/?group_id=1902
+* "Mailing Lists":http://rubyforge.org/mail/?group_id=1902
+
+h2. Source Code
+
+* Subversion Repository: svn://rubyforge.org/var/svn/geminstaller/trunk

data/website/src/community/links.page

@@ -0,0 +1,9 @@
+
+h1. Links
+
+* Chad's links:
+** "Chad's Home Page":http://www.thewoolleyweb.com
+** "Pivotal Labs":http://pivotallabs.com - where Chad works
+** "DiabeticMommy.com":http://www.diabeticmommy.com - Support site for women with diabetes, created and edited by Chad's wife
+* RubyGems
+** "RubyGems Homepage":http://rubygems.org

data/website/src/default.css

@@ -0,0 +1,168 @@
+/* andreas09 v1.0 (Dec 10th 2005) - An open source template by Andreas Viklund - http://andreasviklund.com. Free to use for any purpose as long as the proper credits are given to the original author. */
+
+body {
+background:#FFFFFF;
+color:#303030;
+font:90% Verdana,Tahoma,Arial,sans-serif;
+margin:0;
+padding:0;
+text-align:center;
+}s
+
+a {
+color:#505050;
+font-weight:bold;
+text-decoration:none;
+}
+
+a:hover {
+color:#808080;
+text-decoration:underline;
+}
+
+p {
+line-height:1.5em;
+margin:0 0 15px;
+}
+
+code,pre {
+font-size:1.3em;
+}
+
+/*** Main container ***/
+
+#container {
+background:#CCCCCC;
+color:#303030;
+margin:0;
+min-width:770px;
+padding:0;
+text-align:left;
+width:100%;
+}
+
+/*** Header section ***/
+
+#header {
+background:#000000;
+padding-bottom:10px;
+}
+
+#sitename {
+color:#ffffff;
+margin:0 20px 10px 40px;
+text-align:left;
+}
+
+#sitename h1,#sitename h2 {
+letter-spacing:7px;
+margin:0;
+padding:0;
+}
+
+#sitename h1 {
+font-size:2.6em;
+padding-top:18px;
+}
+
+#sitename h2 {
+font-size:1.8em;
+}
+
+
+
+#navigation {
+  text-align:left;
+  margin:0 18px 10px auto;
+  padding:0;
+	font-size:1.4em;
+	line-height:.3em;
+}
+#navigation li {
+  margin:0;
+  padding-right: 10px;
+  list-style:none;
+  display:inline;
+}
+#navigation li a {
+  margin:0 1px 0 1px;
+  color:#666;
+  text-decoration:none;
+  font-weight:bold;
+}
+#navigation li a:hover {
+  color:#AA2233;
+}
+#navigation li.webgen-menu-item-selected a, #naviation li.webgen-menu-item-selected a:hover {
+    color: #000;
+}
+
+
+/*** Content wrap ***/
+
+#wrap {
+background:#FFFFFF;
+clear:both;
+font-size:1.1em;
+padding-top:10px;
+}
+
+/*** Content ***/
+#content {
+padding:0px 20px 5px;
+}
+
+#content {
+	margin-top: 10px;
+  margin-left: 20px;
+  margin-right: 20px;
+}
+
+#content h1,#content h2,#content h3 {
+background-color:inherit;
+color:#606060;
+font-size:1.8em;
+font-weight:bold;
+letter-spacing:-1px;
+margin:0 0 10px;
+padding:0;
+}
+
+#content h2 {
+font-size:1.6em;
+margin-bottom:10px;
+}
+
+#content h3 {
+font-size:1.4em;
+margin-bottom:10px;
+}
+
+#content img {
+border:1px solid #b0b0b0;
+float:left;
+margin:5px 15px 6px;
+padding:5px;
+}
+
+/*** Footer ***/
+
+#footer {
+background:#FFFFFF;
+clear:both;
+color:#d0d0d0;
+font-size:1.0em;
+font-weight:bold;
+margin:0;
+padding:20px 0;
+text-align:center;
+width:100%;
+}
+
+#footer a {
+color:#d0d0d0;
+font-weight:bold;
+}
+
+
+/*** End of file ***/

data/website/src/default.template

@@ -0,0 +1,41 @@
+--- content, html
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang:}">
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <meta name="description" content="geminstaller.rubyforge.org" />
+    <meta name="keywords" content="ruby,gems,rubygems" />
+    <meta name="author" content="Chad Woolley / Original design by Andreas Viklund - http://andreasviklund.com" />
+    <meta name="generator" content="webgen - http://webgen.rubyforge.org" />
+    <link rel="stylesheet" href="{relocatable: default.css}" type="text/css" media="screen" />
+    <link rel="stylesheet" href="{resource: webgen-css}" type="text/css" media="screen" />
+    <title>{title:}</title>
+  </head>
+
+  <body>
+    <div id="container">
+
+      <div id="header">
+        <div id="sitename">
+          <h1>GemInstaller</h1>
+          <h2>Automate Ruby Gems!</h2>
+        </div>
+      </div>
+
+      <div id="navigation">
+          {menu: {menuStyle: horizontal}}
+      </div>
+
+      <div id="wrap">
+
+        <div id="content">
+          {block:}
+        </div>
+
+      </div>
+    </div>
+
+    <div id="footer">&copy; 2007 Chad Woolley | Generated by <a href="http://webgen.rubyforge.org">webgen</a></div>
+  </body>
+</html>