geminstaller 0.2.5 → 0.3.0

data/lib/geminstaller/gem_interaction_handler.rb

@@ -4,6 +4,10 @@ module GemInstaller
     DEPENDENCY_PROMPT = 'Install required dependency'
     
     def handle_ask_yes_no(question)
+      if GemInstaller::RubyGemsVersionChecker.matches?('>=0.9.5')
+        # gem_interaction_handler is not used for RubyGems >= 0.9.5
+        raise RuntimeError.new("Internal GemInstaller Error: GemInteractionHandler should not be used for RubyGems >= 0.9.5")
+      end
       return unless question.index(DEPENDENCY_PROMPT)
       message = "Error: RubyGems is prompting to install a required dependency, and you have not " +
                 "specified the '--install-dependencies' option for the current gem.  You must modify your " +
@@ -13,6 +17,10 @@ module GemInstaller
     end
     
     def handle_choose_from_list(question, list, noninteractive_chooser = nil)
+      if GemInstaller::RubyGemsVersionChecker.matches?('>=0.9.5')
+        # gem_interaction_handler is not used for RubyGems >= 0.9.5
+        raise RuntimeError.new("Internal GemInstaller Error: GemInteractionHandler should not be used for RubyGems >= 0.9.5")
+      end
       noninteractive_chooser ||= @noninteractive_chooser_class.new
       valid_platforms = nil
       if dependent_gem_with_platform_specified?(list, noninteractive_chooser) or noninteractive_chooser.uninstall_list_type?(question)

data/lib/geminstaller/gem_list_checker.rb

@@ -23,7 +23,7 @@ module GemInstaller
       end
 
       if matched_lines.size == 0
-        error_message = "Error: Could not find remote gem to install.  Gem name = '#{gem.name}', install options = '#{gem.install_options}'"
+        error_message = "Error: Could not find remote gem to install.  Gem name = '#{gem.name}', Gem version = '#{gem.version}', install options = '#{gem.install_options}'"
         raise GemInstaller::GemInstallerError.new(error_message)
       end
 

data/lib/geminstaller/gem_runner_proxy.rb

@@ -27,7 +27,7 @@ module GemInstaller
     end
     
     def create_gem_runner
-      if Gem::RubyGemsVersion.index('0.8') == 0
+      if GemInstaller::RubyGemsVersionChecker.matches?('< 0.9')
         @gem_runner_class.new()
       else
         @gem_runner_class.new(:command_manager => @gem_cmd_manager_class)

data/lib/geminstaller/gem_spec_manager.rb

@@ -1,18 +1,13 @@
 module GemInstaller
   class GemSpecManager
-    attr_writer :gem_source_index_proxy, :valid_platform_selector, :output_filter
+    attr_writer :source_index_search_adapter, :valid_platform_selector, :output_filter
 
-    def search(gem_pattern, version_requirement)
-      @gem_source_index_proxy.refresh!
-      @gem_source_index_proxy.search(gem_pattern, version_requirement)
-    end
-    
     def is_gem_installed?(gem)
       return local_matching_gems(gem).size > 0
     end
     
     def all_local_gems
-      all_local_specs = search('',GemInstaller::RubyGem.default_version)
+      all_local_specs = @source_index_search_adapter.all_local_specs
       return [] unless all_local_specs
       all_local_gems = all_local_specs.collect do |spec|
         gem = GemInstaller::RubyGem.new(spec.name, :version  => spec.version.version)
@@ -21,18 +16,35 @@ module GemInstaller
     end
     
     def local_matching_gems(gem, exact_platform_match = true)
-      gem_name_regexp = /^#{gem.regexp_escaped_name}$/
-      found_gem_specs = search(gem_name_regexp,gem.version)
+      found_gem_specs = @source_index_search_adapter.search(gem,gem.version)
       return [] unless found_gem_specs
-      matching_gem_specs = found_gem_specs.select do |gem_spec|
-        valid_platforms = @valid_platform_selector.select(gem.platform, exact_platform_match)
-        valid_platforms.include?(gem_spec.platform)
+
+      if GemInstaller::RubyGemsVersionChecker.matches?('<=0.9.4')
+        found_gem_specs = found_gem_specs.select do |gem_spec|
+          valid_platforms = @valid_platform_selector.select(gem.platform, exact_platform_match)
+          valid_platforms.include?(gem_spec.platform)
+        end
+      else
+        # TODO: this is a hack because source_index#search doesn't allow specification of platform
+        if exact_platform_match
+          found_gem_specs = found_gem_specs.delete_if do |spec|
+            !spec_platform_matches?(spec, gem.platform)
+          end
+        end
       end
-      matching_gems = matching_gem_specs.map do |gem_spec|
+      matching_gems = found_gem_specs.map do |gem_spec|
         GemInstaller::RubyGem.new(gem_spec.name, {:version => gem_spec.version.version, :platform => gem_spec.platform })
       end
       return matching_gems
     end
+
+    def spec_platform_matches?(spec, platform)
+      spec_platform = Gem::Platform.new(spec.platform)
+      if spec_platform.is_a?(String)
+        return spec_platform == platform
+      end
+      return spec_platform =~ platform
+    end
   end
 end
 

data/lib/geminstaller/install_processor.rb

@@ -14,19 +14,34 @@ module GemInstaller
         already_specified = true
       end
       gem_is_installed = @gem_spec_manager.is_gem_installed?(gem)
-      if gem_is_installed 
+      if gem_is_installed
         @output_filter.geminstaller_output(:debug,"Gem #{gem.name}, version #{gem.version} is already installed.\n")
       else
-        @gem_list_checker.verify_and_specify_remote_gem!(gem) unless already_specified
-        @output_filter.geminstaller_output(:install,"Invoking gem install for #{gem.name}, version #{gem.version}.\n")
-        output_lines = @gem_command_manager.install_gem(gem)
-        print_dependency_install_messages(gem, output_lines) unless @options[:silent]
+        perform_install(gem, already_specified)
+        installation_performed = true
       end
       if gem.fix_dependencies
-        fix_dependencies(gem)
+        if GemInstaller::RubyGemsVersionChecker.matches?('>=0.9.5')
+          # RubyGems >=0.9.5 automatically handles missing dependencies, so just perform an install
+          unless installation_performed
+            @output_filter.geminstaller_output(:install,"The 'fix_dependencies' option was specified for #{gem.name}, version #{gem.version}, so it will be reinstalled to fix any missing dependencies.\n")
+            perform_install(gem, already_specified, true)
+          end
+        else
+          # RubyGems <=0.9.4 does not automatically handles missing dependencies, so GemInstaller must find them
+          # manually with missing_dependency_finder
+          fix_dependencies(gem)
+        end
       end
     end
     
+    def perform_install(gem, already_specified, force_install = false)
+      @gem_list_checker.verify_and_specify_remote_gem!(gem) unless already_specified
+      @output_filter.geminstaller_output(:install,"Invoking gem install for #{gem.name}, version #{gem.version}.\n")
+      output_lines = @gem_command_manager.install_gem(gem, force_install)
+      print_dependency_install_messages(gem, output_lines) unless @options[:silent]
+    end
+    
     def print_dependency_install_messages(gem, output_lines)
       output_lines.each do |line|
         line =~ /Successfully installed /

data/lib/geminstaller/missing_dependency_finder.rb

@@ -2,6 +2,11 @@ module GemInstaller
   class MissingDependencyFinder
     attr_writer :gem_command_manager, :gem_spec_manager, :gem_arg_processor, :output_filter
     def find(dependent_gem)
+      if GemInstaller::RubyGemsVersionChecker.matches?('>=0.9.5')
+        # missing_dependency_finder is not used for RubyGems >= 0.9.5
+        raise RuntimeError.new("Internal GemInstaller Error: MissingDependencyFinder should not be used for RubyGems >= 0.9.5")
+      end
+      
       # NOTE: this doesn't resolve platforms, there's currently no way to know what
       # platform should be selected for a dependency gem.  Best-effort handling
       # of ambiguous platforms on dependency gems will be handled elsewhere

data/lib/geminstaller/requires.rb

@@ -1,28 +1,38 @@
 dir = File.dirname(__FILE__)
 
-
 # require for rubygems package
 require 'rubygems'
 
 # backward compability and version-checking stuff - must be required before it is used
-require 'rubygems/rubygems_version'
 require File.expand_path("#{dir}/rubygems_version_checker")
 
+unless defined? ALLOW_UNSUPPORTED_RUBYGEMS_VERSION or GemInstaller::RubyGemsVersionChecker.matches?('>=0.9.5')
+  print "\n\n----------------------------------------------------------------\n" + 
+            "WARNING: You are using RubyGems version #{Gem::RubyGemsVersion}.\n" +
+            "You should update to RubyGems version 1.0.1 or above,\n" +
+            "because gems created for newer RubyGems versions\n" +
+            "might be incompatible.\n" +
+            "To update rubygems (recommended), use 'gem update --system'.\n" +
+            "----------------------------------------------------------------\n\n"
+end
+
 # requires for rubygems internal classes
 require 'rubygems/doc_manager'
 require 'rubygems/config_file'
-if RUBYGEMS_VERSION_CHECKER.less_than?('0.9.3')
+if GemInstaller::RubyGemsVersionChecker.matches?('<0.9.3')
   require 'rubygems/cmd_manager'
 else
   require 'rubygems/command_manager'
 end
 require 'rubygems/gem_runner'
-require 'rubygems/remote_installer'
+if GemInstaller::RubyGemsVersionChecker.matches?('<1.0.0')
+  require 'rubygems/remote_installer'
+end
 require 'rubygems/installer'
 require 'rubygems/validator'
 
 # these are order-dependent.  Any better way???
-unless RUBYGEMS_VERSION_CHECKER.less_than?('0.9.3')
+unless GemInstaller::RubyGemsVersionChecker.matches?('<0.9.3')
   require 'rubygems/commands/query_command'
   require 'rubygems/commands/list_command'
 end
@@ -52,7 +62,6 @@ require File.expand_path("#{dir}/enhanced_stream_ui")
 require File.expand_path("#{dir}/exact_match_list_command")
 require File.expand_path("#{dir}/file_reader")
 require File.expand_path("#{dir}/gem_arg_processor")
-require File.expand_path("#{dir}/gem_command_line_proxy")
 require File.expand_path("#{dir}/gem_command_manager")
 require File.expand_path("#{dir}/gem_interaction_handler")
 require File.expand_path("#{dir}/gem_list_checker")
@@ -72,6 +81,7 @@ require File.expand_path("#{dir}/output_proxy")
 require File.expand_path("#{dir}/rogue_gem_finder")
 require File.expand_path("#{dir}/rubygems_exit")
 require File.expand_path("#{dir}/ruby_gem")
+require File.expand_path("#{dir}/source_index_search_adapter")
 require File.expand_path("#{dir}/unexpected_prompt_error")
 require File.expand_path("#{dir}/unauthorized_dependency_prompt_error")
 require File.expand_path("#{dir}/valid_platform_selector")

data/lib/geminstaller/ruby_gem.rb

@@ -1,7 +1,7 @@
 module GemInstaller
   class RubyGem
     include Comparable
-    attr_accessor :name, :version, :platform, :install_options, :check_for_upgrade, :fix_dependencies, :no_autogem, :prefer_binary_platform
+    attr_accessor :name, :version, :platform, :install_options, :check_for_upgrade, :fix_dependencies, :no_autogem, :prefer_binary_platform, :uninstall_options
 
     def initialize(name, opts={})
       @name = name
@@ -15,10 +15,15 @@ module GemInstaller
         @platform = opts[:platform]
       end
       @install_options = opts[:install_options] ||= []
+      @uninstall_options = opts[:uninstall_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
+      if GemInstaller::RubyGemsVersionChecker.matches?('>=0.9.5')
+        warn("The 'prefer_binary_platform' option is deprecated on RubyGems >= 0.9.5, and has no effect") unless opts[:prefer_binary_platorm].nil?
+      else
+        @prefer_binary_platform = opts[:prefer_binary_platorm] == false ? false : true
+      end
     end
 
     def self.default_version

data/lib/geminstaller/rubygems_version_checker.rb

@@ -1,9 +1,15 @@
+require 'rubygems/rubygems_version'
+
 module GemInstaller
   class RubyGemsVersionChecker
-    def less_than?(compare_version, rubygems_version = Gem::RubyGemsVersion)
-      Gem::Version::Requirement.new(["< #{compare_version}"]).satisfied_by?(Gem::Version.new(rubygems_version))
+    def self.matches?(version_spec, options = {})
+      version_spec = [version_spec] unless version_spec.kind_of?(Array)
+      # TODO: if rubygems has already been initialized before GemInstaller overrides the rubygems version,
+      # (for example, by running rspec), then Gem::RubyGemsVersion could be initialized to the incorrect
+      # system-rubygems version instead of the geminstaller-overridden version.  Need to figure out how
+      # to re-parse 'rubygems/rubygems_version' and let it redefine 'Gem::RubyGemsVersion'
+      rubygems_version = options[:rubygems_version] ||= Gem::RubyGemsVersion
+      Gem::Version::Requirement.new(version_spec).satisfied_by?(Gem::Version.new(rubygems_version))
     end
   end
-end
-
-RUBYGEMS_VERSION_CHECKER = GemInstaller::RubyGemsVersionChecker.new
+end

data/lib/geminstaller/source_index_search_adapter.rb

@@ -0,0 +1,41 @@
+module GemInstaller
+  class SourceIndexSearchAdapter
+    attr_writer :gem_source_index_proxy
+    
+    def all_local_specs
+      if GemInstaller::RubyGemsVersionChecker.matches?('<=0.9.4')
+        search_less_than_or_equal_0_9_4('',GemInstaller::RubyGem.default_version)
+      else
+        dependency = Gem::Dependency.new('', GemInstaller::RubyGem.default_version)
+        @gem_source_index_proxy.refresh!
+        @gem_source_index_proxy.search(dependency, false)
+      end
+    end
+
+    def search(gem, version_requirement, platform_only = false)
+      if GemInstaller::RubyGemsVersionChecker.matches?('<=0.9.4')
+        gem_pattern = /^#{gem.regexp_escaped_name}$/
+        search_less_than_or_equal_0_9_4(gem_pattern, version_requirement)
+      else
+        search_greater_than_0_9_4(gem, version_requirement, platform_only)
+      end
+    end
+    
+    def search_less_than_or_equal_0_9_4(gem_pattern, version_requirement)
+      @gem_source_index_proxy.refresh!
+      @gem_source_index_proxy.search(gem_pattern, version_requirement)
+    end
+    
+    def search_greater_than_0_9_4(gem, version_requirement, platform_only = false)
+      dependency = Gem::Dependency.new(gem.name, version_requirement)
+      @gem_source_index_proxy.refresh!
+      @gem_source_index_proxy.search(dependency, platform_only)
+    end
+
+  end
+end
+
+
+
+
+

data/lib/geminstaller/valid_platform_selector.rb

@@ -3,6 +3,11 @@ module GemInstaller
     attr_writer :options, :ruby_platform, :output_filter
     
     def select(gem_platform = nil, exact_platform_match = false)
+      if GemInstaller::RubyGemsVersionChecker.matches?('>=0.9.5')
+        # valid_platform_selector is not used for RubyGems >= 0.9.5
+        raise RuntimeError.new("Internal GemInstaller Error: ValidPlatformSelector should not be used for RubyGems >= 0.9.5")
+      end
+
       @ruby_platform ||= RUBY_PLATFORM
       return [@ruby_platform] if gem_platform == Gem::Platform::CURRENT
       return [gem_platform] if exact_platform_match

data/start_local_gem_server.sh

@@ -1 +1 @@
-gem_server --dir=./spec/fixture/gems --port=9909
+gem server --dir=./spec/fixture/gems --port=9909

data/test/test_all.rb

@@ -1,14 +1,15 @@
-# 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?
+print "\nRunning all GemInstaller Tests, ENV['RUBYGEMS_VERSION'] == '#{ENV['RUBYGEMS_VERSION']}'\n\n"
 
 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])
+test_gem_home_path = Dir.glob("#{specdir}/functional/test_gem_home_spec.rb")[0]
+spec_files.delete(test_gem_home_path)
+spec_files.unshift(test_gem_home_path)
 spec_files.uniq
 
 args = spec_files
@@ -18,14 +19,18 @@ args << "specdoc"
 args << "--diff"
 args << "unified"
 
-$behaviour_runner  = ::Spec::Runner::OptionParser.new.create_behaviour_runner(args, STDERR, STDOUT, false)
+# append generated args to ARGV.  THis may break if incompatible args are specified, 
+# but I don't know a better way to invoke Rspec 1.1.1 programatically and check the return value
+ARGV.concat(args)
 
-retval = 1
+success = false
 begin
-  retval = $behaviour_runner.run(args, false)
+  require 'spec'
+  success = ::Spec::Runner::CommandLine.run(rspec_options)
 ensure
-  $server_was_stopped = GemInstaller::EmbeddedGemServer.stop
   GemInstaller::TestGemHome.reset
 end
-retval ||= 0
-raise "Specs failed, return value = #{retval}" unless retval == 0
+# not sure what Spec::Runner::CommandLine.run can return, but fail if it's not boolean as expected
+raise "unexpected non-boolean return value from Spec::Runner::CommandLine.run(rspec_options)" unless success == true || success == false
+
+raise "Specs failed" unless success

data/website/metainfo.yaml

@@ -57,16 +57,22 @@ community/rubyforge.html:
   title: Rubyforge
   orderInfo: 40
 
+code/ci:
+  url: http://ci.thewoolleyweb.com
+  inMenu: true
+  title: CI
+  orderInfo: 20
+
 code/rdoc:
   url: rdoc/index.html
   inMenu: true
   title: Rdoc
-  orderInfo: 20
+  orderInfo: 30
 
 code/coverage:
   url: coverage/index.html
   inMenu: true
   title: Coverage
-  orderInfo: 30
+  orderInfo: 40
 
 

data/website/src/code/index.page

@@ -1,6 +1,7 @@
 ---
 title: Design
 ---
+<span id="release_process"/>
 h1. Design Notes
 
 These are some notes on the underlying design of GemInstaller, and the current state of development:
@@ -21,5 +22,51 @@ These are some notes on the underlying design of GemInstaller, and the current s
 *** 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 :)
+* The tests are "harder" on Windows (but run fine on mac/linux).  The app should work fine, but testing is pretty tricky.  I have all tests working against the latest rubygems (1.0.1).  Here's what does and doesn't work with tests against latest rubygems on windows:
+  * smoketest.rb and autogem_test.rb work
+  * ruby test/test_all.rb works
+  * rake default test task does not work (this seems to be a problem with hoe on windows)
+  * Sometimes test suite still hangs after a while, this is probably some orphaned EmbeddedGemServer process somewhere.  A reboot should fix it - this is windows, after all!
+* 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 :)
+
+<span id="rubygems_compatibility"/>
+h1. Maintaining forward and backward compatibility with multiple RubyGems versions
+
+* I've put a lot of effort into ensuring that GemInstaller works with older versions of RubyGems.  As of now (2008-01-01) all specs (not smoketests) are green on mac/linux against RubyGems versions 0.8.11, 0.9.4, 0.9.5, 1.0.0, and 1.0.1.  On Windows, smoketests and specs are green against 1.0.1.  I haven't figured out how to automate testing against older RubyGems versions without a reinstall on Windows, so let me know if something is broken (or just upgrade).
+
+* This wasn't as hard as it seems.  The hardest part was figuring out what was different between versions.  Once you understand that, you can add switch statements to perform different logic or tests depending on the version (which is easy if you use rubygems built in Version Requirement support - see GemInstaller::RubygemsVersionChecker).
+
+* To run against different RubyGems versions, I have a RUBYGEMS_VERSION environment variable which causes the correct version or RubyGems in spec/fixture/rubygems_dist to be put on the load path and used for the test run.
+
+* RubyGems 0.9.5 was a major upgrade, the preview release for 1.0.  It introduced support for platforms, auto-install of missing dependencies, and many other things that GemInstaller already did.
+
+* Here are the main differences in GemInstaller when running on RubyGems >=0.9.5:
+** Don't use missing dependency finder (auto-install of missing dependencies is now built in)
+** Don't use valid platform selector, use --platform option (auto-selection of platform is now built in)
+** GemInteractionHandler should throw error on any interactive prompt (since dependencies and platforms are now handled automatically by default)
+** The "<code>prefer_binary_platform</code> config property":../documentation/documentation.html#prefer_binary_platform_config_property no longer applies, and has no effect.
+
+<span id="release_process"/>
+h1. Release Process
+
+Yeah, it's too manual.  Notes for improvement below.
+
+* Add section and entries for new release to History.txt
+* Add same history info to history section on homepage.
+* Update version in geminstaller.rb
+* rake update_manifest
+* Run tests:
+  * CI should be green for all versions
+  * smoketest.rb and autogem_test.rb should pass for all RubyGems versions on mac/linux
+  * test_all, smoketest.rb and autogem_test.rb should pass for latest RubyGems version on windows
+* Make sure everything is checked in
+* Make a tag in svn
+* rake clean package
+* Upload gem to rubyforge
+* rake publish_website
+
+Here's the improvements I need to make to the release process:
+
+* Avoid duplication of history file to display on home page
+* Make CI automatically build and tag a gem/package with next version + revision: x.y.z.<svn revision>
+* Rake task to automatically tag and release latest build from CI and tag