geminstaller 0.2.5 → 0.3.0

data/History.txt

@@ -1,5 +1,13 @@
 == 0.x.y / yyyy-mm-dd
 
+== 0.3.0 / 2008-01-01
+* Changes to work with RubyGems >= 0.9.5 and take advantage of new platform and auto-install features.  See notes at http://geminstaller.rubyforge.org/code/index.html#rubygems_compatibility
+* On Linux/Mac, you can now specify a RUBYGEMS_VERSION environment var to test against a specific version of RubyGems.
+* Improved smoketest.rb and autogem_test.rb
+* Tests now run on windows (only against latest rubygems, with it installed, and only via test/test_all.rb, not rake)
+* deprecated/disabled prefer_binary_platform
+* many other small cleanups
+
 == 0.2.5 / 2007-10-24
 * Add 'include_config' directive to yaml config file, allowing other files to be included via ERB.
 * Fix broken links in docs - patch from  Maciej Kozak (macio)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006 Chad Woolley
+Copyright (c) 2008 Chad Woolley
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest.txt

@@ -7,7 +7,11 @@ README.txt
 Rakefile
 TODO.txt
 bin/geminstaller
-ci/cruisecontrol
+ci/README_CI.txt
+ci/cruise
+cruise_config.rb
+focused_spec.sh
+focused_spec_debug.sh
 geminstaller.yml
 lib/geminstaller.rb
 lib/geminstaller/application.rb
@@ -21,7 +25,6 @@ lib/geminstaller/enhanced_stream_ui.rb
 lib/geminstaller/exact_match_list_command.rb
 lib/geminstaller/file_reader.rb
 lib/geminstaller/gem_arg_processor.rb
-lib/geminstaller/gem_command_line_proxy.rb
 lib/geminstaller/gem_command_manager.rb
 lib/geminstaller/gem_interaction_handler.rb
 lib/geminstaller/gem_list_checker.rb
@@ -45,6 +48,7 @@ lib/geminstaller/ruby_gem.rb
 lib/geminstaller/rubygems_exit.rb
 lib/geminstaller/rubygems_extensions.rb
 lib/geminstaller/rubygems_version_checker.rb
+lib/geminstaller/source_index_search_adapter.rb
 lib/geminstaller/unauthorized_dependency_prompt_error.rb
 lib/geminstaller/unexpected_prompt_error.rb
 lib/geminstaller/valid_platform_selector.rb

data/README.txt

@@ -13,10 +13,12 @@ GemInstaller provides automated management of RubyGems.  It uses a simple YAML c
 * Automatically install the correct versions of all required gems wherever your app runs.
 * Automatically ensure installed gems and versions are consistent across multiple applications, machines, platforms, and environments 
 * Automatically add correct versions of gems to the ruby load path when your app runs ('require_gem'/'gem')
-* Automatically reinstall missing dependency gems
-* Automatically guess at correct platform to install for multi-platform gems
+* Automatically reinstall missing dependency gems (built in to RubyGems > 1.0)
+* Automatically detect correct platform to install for multi-platform gems (built in to RubyGems > 1.0)
 * Print YAML for "rogue gems" which are not specified in the current config, to easily bootstrap your config file, or find gems that were manually installed without GemInstaller.
-* Avoid the "works on demo, broken on production" syndrome
+* Allow for common configs to be reused across projects or environments by supporting multiple config files, including common config file snippets, and defaults with overrides.
+* Allow for dynamic selection of gems, versions, and platforms to be used based on environment vars or any other logic.
+* Avoid the "works on demo, breaks on production" syndrome
 
 == SYNOPSYS:
 
@@ -38,7 +40,7 @@ See http://geminstaller.rubyforge.org/documentation/index.html
 
 (The MIT License)
 
-Copyright (c) 2006 Chad Woolley
+Copyright (c) 2008 Chad Woolley
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/TODO.txt

@@ -1,29 +1,40 @@
+
 =============== Unfiled =============
-* Dynamically detect posix platform and check if gem repo is completely writeable.  Ignorable prompt?
-* Figure out how to suppress webrick messages from embedded gem server
-* Allow array or eval'able string of gems to be passed as --gems arg or instead of args
-* Add @options[:gems], should be parsed from command line
-* Add warning that environment is not passed via sudo
-* document include_config in yaml
-=============== 0.2.6
-* Understand environment.rb vs boot.rb (bottom line: env is not processed before Initializer, so can't be used to load rails gems).  Add doc references.
-* docs - clean up sudo section.  Should be clearer about sudoers entry, and make sure that NOPASSWD is the last entry.
-* Faq - mention sudo
-* Faq - mention Zed's questions
-* design - dependency management is good.  Maven got it right, if not for the jelly...
-* Investigate gem_plugin.  Plugin for mongrel???
-================ 0.2.8 release ===================
-* Rename API: deprecate 'autogem' and rename to 'loadgems'; change current 'run' to 'install'; add new 'run' which automatically calls both 'install' and 'gem', add 'no-loadgems' option (only applicable when invoked programatically) to supress automatic 'loadgems
-================ 0.3.0 release =====================
-* update docs with details on how to handle unmet dependencies when -y is not specified
-* tutorial: using common or shared config files, with different configs for different environments - test (rspec) vs. dev (capistrano) vs. demo/staging/prod
+* release with support for rubygems >= 0.9.5
+================ 0.3.0 release ===================
+* turn smoketest into rake task, with correct return code handling, and hook up to cruise
+* look into and explain mongrel/webrick installation errors
+* add top-level method for uninstall of gems, and document (requested by Alex Chaffee and others)
+* Rename API: deprecate 'autogem' and rename to 'load'; change current 'run' to 'install'; add new 'run' which automatically calls both 'install' and 'load', add 'no-load' option (only applicable when invoked programatically) to supress automatic 'load'
+
+* docs - add example of using environment variable to control gem version without changing code (Rails)
+* docs - document and add sample file for preinitializer boot hook.  Explain why it can't be in environment.rb vs boot.rb or prinitializer (bottom line: env is not processed before Initializer, so can't be used to load rails gems)
+* tutorial: using common or shared config files, with different configs for different environments - test (rspec) vs. dev (capistrano) vs. demo/staging/prod, mention include_config option and pros/cons of different approaches
+* docs - rename "Documentation" page to "Manual"
+* rogue gems config generation - add warning and instructions for cleaning up auto-generated file.  For example, deleting rails dependencies
+* faq - mention 'cannot load error' from load, and why it happens (rubygems can only load one version)
+* faq - mention tradeoffs of optimistic version requirement (>=) vs pessimistic (=), specifically how mongrel specifies its dependencies
+* put mongrel/rails startup bug in tracker, add link in "known bugs" section on home page.
 * tutorial: running via capistrano
 * crossreference front page, tutorials, and docs
-* put mongrel/rails startup bug in tracker, add link in "known bugs" section on home page.
-* links - rspec, rubygems
-* Set up cruise
-================ 0.3.1 finishing website ===================
-* make valid_platform_selector use data from tattle
+================ 0.3.1 release ===================
+* Namespace remaining un-namespaced constants
+* Allow array or eval'able string of gems to be passed as --gems arg or instead of args
+* Add @options[:gems], should be parsed from command line* root-owned gems: add -S | --sudo-only-if-allowed option, will only invoke sudo if GEMINSTALLER_ALLOW(S)_SUDO env var is set
+* root-owned gems: add automatic re-invoke with sudo option (with warning message) if permission error is caught
+* root-owned gems: Dynamically detect posix platform and check if gem repo is completely writeable.  Ignorable prompt?
+* docs - clean up sudo section.  Should be clearer about sudoers entry, and make sure that NOPASSWD is the last entry.  Rename from #dealing_with_sudo to #dealing_with_root_owned_gems, rewrite to reflect new best practices (different GEM_PATH or auto-sudo via capistrano)
+* tutorial: update running via capistrano to reference new sudo docs
+================ 0.3.2 release ===================
+* handle installation of gem from file (requested by Alex Chaffee)
+* Investigate gem_plugin.  Plugin for mongrel???
+* Investigate making a Rails plugin
+================ 0.3.3 release ===================
+* Why does RubyGems reinstall BlueCloth even though it is already installed?!?!? (remove from FAQ after solved)
+* Figure out how to suppress webrick messages from embedded gem server
+* add option to warn if any rogue gems are found
+================ 0.3.4 release =====================
+================ 0.3.5 finishing website ===================
 * autogem and run args can be passed as string or array
 * better test coverage for --sudo and --exception options
 * use rspec context_setup
@@ -69,25 +80,20 @@
 * reconcile methods for testing error messages - manually vs proc_should_raise_with_message.  Probably should patch rspec.
 * remove test_gem_home.reset from geminstaller_spec.rb WITHOUT breaking the test suite.
 * tests fail on windows - seems to be related to test_gem_home running twice.  smoketest still passes.
-* Use rubygems executables from test_gem_home.  In order to do this, we must run test_gem_home and ensure it is on the load path BEFORE the system installation of rubygems ever gets initialized.  We will also have to manually include all geminstaller test dependency gems in test_gem_home or on the path.  Tried this once and failed, patch on linux box...
-* clean up spec_utils - remove duplication of class and instance methods
-* spec_utils global teardown method which uninstalls all gems
 * can't run binary out of source dir unless running it via ruby
 * running binary via ruby out of bin dir will pick up gem first on load path if it is installed
 * verify that >= version spec works with a specific platform, if that platform is not available for the highest version
 * Check for write access, and exit with warning to use sudo if there is no write access.
 * store rubygems dist as a tar, and untar it on demand
 * Add spec file name to all contexts (or see if rspec can do it automatically)
-* Make GemInstaller.run take a parameter to not fail if there is any error
 * Embedded gem_server process doesn't get killed on windows during tests - need to use ruby services, see comment in embedded_gem_server.rb
 * Embedded gem_server ports aren't handled correctly on linux during tests - port conflict on startup, open ports die off slowly after tests finish
 * Do a port check before starting embedded gem server, give option to kill process or at least exit with a descriptive warning.
-* Clean up spec_helper, find out simplest way to invoke rspec via test_unit, and still provide proper return codes/output
 * remove cruft from test output - intercept output streams from gem_server and rubygems setup
 * enhance DependencyInjector - allow items to be substituted prior to initialization - then geminstaller_spec could simply set a mock output_proxy on the registry instead of explicitly setting it every place it is used.
 * ensure --debug install option works as expected
 * fix all Zentest warnings
-* Rename RubyGem class to RubyGemAction, add install vs. uninstall actions in config (install is default)
+* Rename RubyGem class to RubyGemAction (or maybe RubyGemDependency to match 1.x)
 * Automate process for creating a stubgem
 * Give nice error message if gem server is unavailable (check socket)
 * Make tests run under RadRails debugger
@@ -97,5 +103,4 @@
 * make verbose option specify --backtrace on all gem commands
 * Add support, syntax, and options for uninstalling gems - completely, or down to highest specified version.
 * add feature to automatically warn if there is a more recent version of the gem available and check_for_upgrade == false.  Use "gem outdated" command
-* auto-generate geminstaller.yml files (possibly by parsing source, or based on all gems installed locally)
 ================ 0.later.1 Unprioritized ===================

data/ci/README_CI.txt

@@ -0,0 +1,22 @@
+Use these steps to run GemInstaller under CruiseControl.rb:
+
+* Create project with name 'geminstaller_using_rubygems_x-y-z', where 'x-y-z' is the version of RubyGems to test against.
+
+* symlink geminstaller/ci/cruise to /etc/init.d/cruise and follow instructions it contains to hook up init script and update-rc.d.
+
+* gem install mongrel and daemons (TODO: add these to geminstaller config)
+
+* Edit ~/.cruise/site_config.rb to have the following entries:
+
+# builds must run in serial for now, to prevent conflicts
+Configuration.serialize_builds = true
+ 
+# use dedicated gmail account for mailing
+ActionMailer::Base.smtp_settings = {
+  :address =>        "smtp.gmail.com",
+  :port =>           587,
+  :domain =>         "thewoolleyweb.com",
+  :authentication => :plain,
+  :user_name =>      "thewoolleyweb.smtp",
+  :password =>       "????"
+}

data/ci/cruise

@@ -0,0 +1,50 @@
+#!/usr/local/bin/ruby
+
+ENV['PATH']="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/bin/X11"
+
+# in order to make cruise run as daemon, you need:
+# 1. cp $CCRB_HOME/daemon/cruise.sample $CCRB_HOME/daemon/cruise
+# 2. specify your cruise_path to $CCRB_HOME in $CCRB_HOME/daemon/cruise file
+# 3. ln -s $CCRB_HOME/daemon/cruise /etc/init.d/cruise (you may need to 'sudo' this)
+# 4. update-rc.d cruise (you may want to choose options by yourself, and you may need to 'sudo' this)
+# 5. it's done :>
+
+require "fileutils"
+include FileUtils
+
+require "rubygems"
+
+begin
+  gem 'mongrel'
+rescue => e
+  puts "Error: daemon mode of CC.rb requires mongrel installed"
+  exit 1
+end
+
+def cruise_path
+  "/home/woolley/workspace/cruisecontrolrb"
+end
+
+def cruise_user
+  "woolley"
+end
+
+command = ARGV.shift
+
+case command
+when 'start'
+  #cd cruise_path
+  system "su - woolley -c 'cd #{cruise_path} && ./cruise start -d'"
+  exit 0
+when 'stop'
+  system "mongrel_rails stop -P #{cruise_path}/tmp/pids/mongrel.pid"
+  Dir["#{cruise_path}/tmp/pids/builders/*.pid"].each do |pid_file|
+    pid = File.open(pid_file){|f| f.read }
+    system "kill -9 #{pid}"
+    rm pid_file
+  end
+  exit 0
+else
+  p "Usage: /etc/init.d/cruise start|stop"
+  exit 1
+end

data/cruise_config.rb

@@ -0,0 +1,11 @@
+# Project-specific configuration for CruiseControl.rb
+require 'fileutils'
+
+Project.configure do |project|
+  project.email_notifier.emails = ['thewoolleyman@gmail.com']
+  if project.name =~ /rubygems[_-](.*)$/ # geminstaller_using_rubygems_0-9-4
+    rubygems_version = $1
+    rubygems_version.gsub!('-','.')
+    ENV['RUBYGEMS_VERSION'] = rubygems_version
+  end
+end

data/focused_spec.sh

@@ -0,0 +1,2 @@
+# warning - experimental
+ruby -I spec/fixture/rubygems_dist/rubygems-1.0.1/lib/ /usr/local/bin/spec $1 --line=$2

data/focused_spec_debug.sh

@@ -0,0 +1,2 @@
+# warning - experimental
+rdebug -I spec/fixture/rubygems_dist/rubygems-1.0.0/lib/ /usr/local/bin/spec -- $1 --line=$2

data/geminstaller.yml

@@ -7,7 +7,7 @@ gems:
 - name: diff-lcs
   version: '>= 1.1.2'
 - name: hoe
-  version: '>= 1.1.6'
+  version: '>= 1.4.0'
 - name: rake
   version: '>= 0.7.1'
 - name: rcov
@@ -16,14 +16,16 @@ gems:
 - name: RedCloth
   version: '>= 3.0.4'
 - name: rspec
-  version: '>= 1.0.8'
+  version: '>= 1.1.1'
 - name: cmdparse
   version: '>= 2.0.2'
+- name: ruby-debug
+  version: '>= 0.9.3'
 - name: webgen
   version: '>= 0.4.2'
 <% if RUBY_PLATFORM =~ /mswin/ %>
 - name: win32-process
-  version: '>= 0.5.0'
+  version: '>= 0.5.5'
   platform: 'mswin32'
 - name: win32console
   version: '>= 1.0.8'

data/lib/geminstaller.rb

@@ -29,7 +29,7 @@ module GemInstaller
   end
 
   def self.version
-    "0.2.5"
+    "0.3.0"
   end
 
   def self.create_application(args = [], registry = nil)

data/lib/geminstaller/autogem.rb

@@ -1,6 +1,6 @@
 module GemInstaller
   class Autogem
-    attr_writer :gem_command_manager, :gem_spec_manager, :gem_source_index_proxy
+    attr_writer :gem_command_manager, :gem_source_index_proxy
     def autogem(gems)
       @gem_source_index_proxy.refresh!
       @completed_names = []
@@ -20,7 +20,7 @@ module GemInstaller
     end
     
     def invoke_require_gem_command(name, version)
-      if Gem::RubyGemsVersion.index('0.8') == 0
+      if GemInstaller::RubyGemsVersionChecker.matches?('< 0.9')
         require_gem(name, version)
       else
         # TODO: should we check true/false result of gem method?

data/lib/geminstaller/backward_compatibility.rb

@@ -1,7 +1,7 @@
 # this file supports backward compatibility for prior versions of RubyGems
 
 # 0.9.3 reorganized commands to Gem::Commands:: module from Gem::
-if RUBYGEMS_VERSION_CHECKER.less_than?('0.9.3')
+if GemInstaller::RubyGemsVersionChecker.matches?('<0.9.3')
   LIST_COMMAND_CLASS = Gem::ListCommand
   QUERY_COMMAND_CLASS = Gem::QueryCommand
 else

data/lib/geminstaller/dependency_injector.rb

@@ -15,7 +15,7 @@ module GemInstaller
     attr_accessor :gem_runner, :gem_command_manager, :gem_list_checker, :app, :arg_parser, :options, :noninteractive_chooser
     attr_accessor :gem_interaction_handler, :install_processor, :missing_dependency_finder, :valid_platform_selector
     attr_accessor :output_listener, :outs_output_observer, :errs_output_observer, :output_filter, :autogem, :rogue_gem_finder
-    attr_accessor :gem_spec_manager
+    attr_accessor :gem_spec_manager, :source_index_search_adapter
 
     def initialize
       @options = {}
@@ -49,6 +49,9 @@ module GemInstaller
       @gem_source_index_proxy = GemInstaller::GemSourceIndexProxy.new
       @gem_source_index_proxy.gem_source_index = @gem_source_index
 
+      @source_index_search_adapter = GemInstaller::SourceIndexSearchAdapter.new
+      @source_index_search_adapter.gem_source_index_proxy = @gem_source_index_proxy
+
       @gem_interaction_handler = GemInstaller::GemInteractionHandler.new
       @noninteractive_chooser_class = GemInstaller::NoninteractiveChooser
       @gem_interaction_handler.noninteractive_chooser_class = @noninteractive_chooser_class
@@ -80,7 +83,7 @@ module GemInstaller
   
       @gem_spec_manager = GemInstaller::GemSpecManager.new
       @gem_spec_manager.valid_platform_selector = @valid_platform_selector
-      @gem_spec_manager.gem_source_index_proxy = @gem_source_index_proxy
+      @gem_spec_manager.source_index_search_adapter = @source_index_search_adapter
       @gem_spec_manager.output_filter = @output_filter
         
       @gem_command_manager = GemInstaller::GemCommandManager.new
@@ -96,7 +99,6 @@ module GemInstaller
       @autogem = GemInstaller::Autogem.new
       @autogem.gem_command_manager = @gem_command_manager
       @autogem.gem_source_index_proxy = @gem_source_index_proxy
-      @autogem.gem_spec_manager = @gem_spec_manager
 
       @gem_list_checker = GemInstaller::GemListChecker.new
       @gem_list_checker.gem_command_manager = @gem_command_manager

data/lib/geminstaller/enhanced_stream_ui.rb

@@ -7,12 +7,15 @@ module GemInstaller
     end
     
     def ask_yes_no(question, default=nil)
-      begin
-        @gem_interaction_handler.handle_ask_yes_no(question)
-      rescue Exception => e
-        @outs.print(question)
-        @outs.flush
-        raise e
+      if GemInstaller::RubyGemsVersionChecker.matches?('<=0.9.4')
+        # Using defaults, we expect no interactive prompts RubyGems >= 0.9.5
+        begin
+          @gem_interaction_handler.handle_ask_yes_no(question)
+        rescue Exception => e
+          @outs.print(question)
+          @outs.flush
+          raise e
+        end
       end
       raise_unexpected_prompt_error(question)
     end
@@ -22,7 +25,14 @@ module GemInstaller
     end
     
     def choose_from_list(question, list)
-      @gem_interaction_handler.handle_choose_from_list(question, list)
+      if GemInstaller::RubyGemsVersionChecker.matches?('<=0.9.4')
+        # Using defaults, we expect no interactive prompts RubyGems >= 0.9.5
+        @gem_interaction_handler.handle_choose_from_list(question, list)
+      else
+        list_string = list.join("\n")
+        question_and_list = "#{question}\n#{list_string}"
+        raise_unexpected_prompt_error(question_and_list)
+      end
     end
 
     def terminate_interaction!(status=-1)

data/lib/geminstaller/gem_command_manager.rb

@@ -3,7 +3,7 @@ module GemInstaller
     attr_writer :gem_spec_manager, :gem_runner_proxy, :gem_interaction_handler
     
     def list_remote_gem(gem, additional_options)
-      run_args = ["list",gem.name,"--remote"]
+      run_args = ["list",gem.name,"--remote","--details"]
       run_args += additional_options
       @gem_runner_proxy.run(run_args)
     end
@@ -11,21 +11,21 @@ module GemInstaller
     def uninstall_gem(gem)
       return if !@gem_spec_manager.is_gem_installed?(gem)
       @gem_interaction_handler.dependent_gem = gem
-      run_gem_command('uninstall',gem)
+      run_gem_command('uninstall', gem, gem.uninstall_options)
     end
 
-    def install_gem(gem)
-      return if @gem_spec_manager.is_gem_installed?(gem)
+    def install_gem(gem, force_reinstall = false)
+      return [] if @gem_spec_manager.is_gem_installed?(gem) && !force_reinstall
       @gem_interaction_handler.dependent_gem = gem
-      run_gem_command('install',gem)
+      run_gem_command('install', gem, gem.install_options)
     end
     
     def dependency(name, version, additional_options = [])
-      # it would be great to use the dependency --pipe option, but unfortunately, rubygems has a bug
-      # up to at least 0.9.2 where the pipe options uses 'puts', instead of 'say', so we can't capture it
-      # with enhanced_stream_ui.  Patch submitted: 
-      # http://rubyforge.org/tracker/index.php?func=detail&aid=9020&group_id=126&atid=577
-      run_args = ["dependency",/^#{name}$/,"--version",version]
+      # rubygems has bug up to 0.9.4 where the pipe options uses 'puts', instead of 'say', so we can't capture it
+      # with enhanced_stream_ui.  Patched: http://rubyforge.org/tracker/index.php?func=detail&aid=9020&group_id=126&atid=577
+      # TODO: use pipe option on later versions which support it
+      
+      run_args = ["dependency","^#{name}$","--version",version]
       run_args += additional_options
       output_lines = @gem_runner_proxy.run(run_args)
       # dependency output has all lines in the first element
@@ -48,9 +48,12 @@ module GemInstaller
       end
     end
 
-    def run_gem_command(gem_command,gem)
+    def run_gem_command(gem_command, gem, options)
       run_args = [gem_command,gem.name,"--version", "#{gem.version}"]
-      run_args += gem.install_options
+      if GemInstaller::RubyGemsVersionChecker.matches?('>=0.9.5')
+        run_args += ['--platform', "#{gem.platform}"]
+      end
+      run_args += options
       @gem_runner_proxy.run(run_args)
     end
   end