britt-geminstaller 0.5.2 → 0.5.2.1

data/lib/geminstaller/output_filter.rb

@@ -0,0 +1,49 @@
+module GemInstaller
+  class OutputFilter
+    attr_writer :output_proxy, :options
+    
+    def rubygems_output(type, message)
+      return if @options[:silent]
+      return unless rubygems_output_type_matches?(type)
+      output(:rubygems, type, message)
+    end
+      
+    def geminstaller_output(type, message)
+      return if @options[:silent]
+      return unless geminstaller_output_type_matches?(type)
+      output(:geminstaller, type, message)
+    end
+      
+    def output(source, type, message)
+      message = format_rubygems_message(type,message) if source == :rubygems
+      if (source == :geminstaller and type == :error)
+        @output_proxy.syserr(message)
+        
+      else
+        @output_proxy.sysout(message)
+      end
+    end
+    
+    def format_rubygems_message(type, message)
+      prefix = case type
+      when :stdout : "[RubyGems:stdout] "
+      when :stderr : "[RubyGems:stderr] "
+      end
+      "#{prefix}#{message}"
+    end
+
+    def rubygems_output_type_matches?(type)
+      return false unless @options[:rubygems_output]
+      return true if @options[:rubygems_output].include?(:all)
+      return true if @options[:rubygems_output].include?(type)
+      return false
+    end
+
+    def geminstaller_output_type_matches?(type)
+      return false unless @options[:geminstaller_output]
+      return true if @options[:geminstaller_output].include?(:all)
+      return true if @options[:geminstaller_output].include?(type)
+      return false
+    end
+  end
+end

data/lib/geminstaller/output_listener.rb

@@ -0,0 +1,33 @@
+dir = File.dirname(__FILE__)
+require File.expand_path("#{dir}/requires.rb")
+
+module GemInstaller
+  class OutputListener
+    attr_writer :output_filter
+    
+    def initialize
+      @messages = []
+      @output_filter = nil
+    end
+    
+    def notify(msg, stream = :stdout)
+      @messages.push(msg)
+      return unless @output_filter
+      if stream == :stdout or stream == :stderr
+        @output_filter.rubygems_output(stream, msg)
+      else
+        raise GemInstaller::GemInstallerError.new("Invalid stream specified: #{@stream}")
+      end
+    end
+    
+    def read
+      @messages.dup
+    end
+
+    def read!
+      messages = @messages.dup
+      @messages.clear
+      messages
+    end
+  end
+end

data/lib/geminstaller/output_observer.rb

@@ -0,0 +1,36 @@
+module GemInstaller
+  class OutputObserver
+    attr_writer :stream
+    # TODO: GemRunnerProxy should raise exception if listener still has any leftover output when run is invoked. 
+    def initialize
+      @stream = :stdout
+      @listeners = []
+    end
+
+    def register(listener)
+      listener = [listener] unless listener.is_a?(Array)
+      @listeners += listener
+    end
+    
+    def unregister(listener)
+      @listeners.delete(listener)
+    end
+    
+    def print(output)
+      @listeners.each do |listener|
+        listener.notify(output, @stream)
+      end
+    end
+    
+    def puts(output)
+      print("#{output}\n")
+    end
+
+    def tty?
+      false
+    end
+    
+    def flush
+    end
+  end
+end

data/lib/geminstaller/output_proxy.rb

@@ -0,0 +1,36 @@
+module GemInstaller
+  class OutputProxy
+    attr_writer :options
+    def default_stream=(stream)
+      raise GemInstaller::GemInstallerError.new("Invalid default stream: #{stream}") unless stream == :stderr or stream == :stdout
+      @default_stream = stream
+    end
+
+    def sysout(out)
+      return if silent?
+      $stdout.print out
+    end
+
+    def syserr(err)
+      return if silent?
+      if @options[:redirect_stderr_to_stdout]
+        $stdout.print err
+      else
+        $stderr.print err
+      end
+    end
+    
+    # TODO: should remove this, make callers explicitly choose.
+    def output(output)
+      if @default_stream == :stdout
+        sysout(output)
+      else
+        syserr(output)
+      end
+    end
+    
+    def silent?
+      @options && @options[:silent]
+    end
+  end
+end

data/lib/geminstaller/registry.rb

@@ -0,0 +1,127 @@
+module GemInstaller
+  class Registry
+    attr_accessor :file_reader, :yaml_loader, :output_proxy, :config_builder, :gem_source_index, :gem_runner_proxy
+    attr_accessor :gem_runner, :gem_command_manager, :gem_list_checker, :app, :arg_parser, :options
+    attr_accessor :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, :source_index_search_adapter
+    
+    if GemInstaller::RubyGemsVersionChecker.matches?('<=0.9.4')
+      attr_accessor :gem_interaction_handler, :noninteractive_chooser
+    end
+
+    def initialize
+      @options = {}
+      @arg_parser = GemInstaller::ArgParser.new
+      @arg_parser.options = @options
+      
+      @file_reader = GemInstaller::FileReader.new
+      @yaml_loader = GemInstaller::YamlLoader.new
+      @gem_arg_processor = GemInstaller::GemArgProcessor.new
+      @version_specifier = GemInstaller::VersionSpecifier.new
+      @output_proxy = GemInstaller::OutputProxy.new
+      @output_proxy.options = @options
+      @output_filter = GemInstaller::OutputFilter.new
+      @output_filter.options = @options
+      @output_filter.output_proxy = @output_proxy
+      
+
+      @output_listener = GemInstaller::OutputListener.new
+      @output_listener.output_filter = @output_filter
+
+      @valid_platform_selector = GemInstaller::ValidPlatformSelector.new
+      @valid_platform_selector.output_filter = @output_filter
+      @valid_platform_selector.options = @options
+
+      @config_builder = GemInstaller::ConfigBuilder.new
+      @config_builder.file_reader = @file_reader
+      @config_builder.yaml_loader = @yaml_loader
+      @config_builder.output_filter = @output_filter
+
+      @gem_source_index = Gem::SourceIndex.from_installed_gems
+      @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
+
+      @outs_output_observer = GemInstaller::OutputObserver.new
+      @outs_output_observer.stream = :stdout
+      @outs_output_observer.register(@output_listener)
+      @errs_output_observer = GemInstaller::OutputObserver.new
+      @errs_output_observer.stream = :stderr
+      @errs_output_observer.register(@output_listener)
+      
+      @enhanced_stream_ui = GemInstaller::EnhancedStreamUI.new
+      @enhanced_stream_ui.outs = @outs_output_observer
+      @enhanced_stream_ui.errs = @errs_output_observer
+
+      @gem_runner_class = Gem::GemRunner
+      @gem_cmd_manager_class = Gem::CommandManager
+      @exact_match_list_command = GemInstaller::ExactMatchListCommand.new
+      @gem_runner_proxy = GemInstaller::GemRunnerProxy.new
+      @gem_runner_proxy.gem_runner_class = @gem_runner_class
+      @gem_runner_proxy.gem_cmd_manager_class = @gem_cmd_manager_class
+      @gem_runner_proxy.output_listener = @output_listener
+      @gem_runner_proxy.enhanced_stream_ui = @enhanced_stream_ui
+      @gem_runner_proxy.options = @options
+      @gem_runner_proxy.output_filter = @output_filter
+      @gem_runner_proxy.exact_match_list_command = @exact_match_list_command
+  
+      @gem_spec_manager = GemInstaller::GemSpecManager.new
+      @gem_spec_manager.valid_platform_selector = @valid_platform_selector
+      @gem_spec_manager.source_index_search_adapter = @source_index_search_adapter
+      @gem_spec_manager.output_filter = @output_filter
+        
+      @gem_command_manager = GemInstaller::GemCommandManager.new
+      @gem_command_manager.gem_spec_manager = @gem_spec_manager
+      @gem_command_manager.gem_runner_proxy = @gem_runner_proxy
+        
+      @rogue_gem_finder = GemInstaller::RogueGemFinder.new
+      @rogue_gem_finder.gem_command_manager = @gem_command_manager
+      @rogue_gem_finder.gem_spec_manager = @gem_spec_manager
+      @rogue_gem_finder.output_proxy = @output_proxy
+      
+      @autogem = GemInstaller::Autogem.new
+      @autogem.gem_command_manager = @gem_command_manager
+      @autogem.gem_source_index_proxy = @gem_source_index_proxy
+
+      @gem_list_checker = GemInstaller::GemListChecker.new
+      @gem_list_checker.gem_command_manager = @gem_command_manager
+      @gem_list_checker.gem_arg_processor = @gem_arg_processor
+      @gem_list_checker.version_specifier = @version_specifier
+
+      @missing_dependency_finder = GemInstaller::MissingDependencyFinder.new
+      @missing_dependency_finder.gem_command_manager = @gem_command_manager
+      @missing_dependency_finder.gem_spec_manager = @gem_spec_manager
+      @missing_dependency_finder.gem_arg_processor = @gem_arg_processor
+      @missing_dependency_finder.output_filter = @output_filter
+
+      @install_processor = GemInstaller::InstallProcessor.new
+      @install_processor.options = @options
+      @install_processor.gem_list_checker = @gem_list_checker
+      @install_processor.gem_command_manager = @gem_command_manager
+      @install_processor.gem_spec_manager = @gem_spec_manager
+      @install_processor.missing_dependency_finder = @missing_dependency_finder
+      @install_processor.output_filter = @output_filter
+      
+      if GemInstaller::RubyGemsVersionChecker.matches?('<=0.9.4')
+        @gem_interaction_handler = GemInstaller::GemInteractionHandler.new
+        @noninteractive_chooser_class = GemInstaller::NoninteractiveChooser
+        @gem_interaction_handler.noninteractive_chooser_class = @noninteractive_chooser_class
+        @gem_interaction_handler.valid_platform_selector = @valid_platform_selector
+        @gem_command_manager.gem_interaction_handler = @gem_interaction_handler
+        @enhanced_stream_ui.gem_interaction_handler = @gem_interaction_handler
+      end
+
+      @app = GemInstaller::Application.new
+      @app.autogem = @autogem
+      @app.rogue_gem_finder = @rogue_gem_finder
+      @app.options = @options
+      @app.arg_parser = @arg_parser
+      @app.config_builder = @config_builder
+      @app.install_processor = @install_processor
+      @app.output_filter = @output_filter
+    end
+  end
+end

data/lib/geminstaller/requires.rb

@@ -0,0 +1,81 @@
+dir = File.dirname(__FILE__)
+
+# require for rubygems package
+require 'rubygems'
+
+# backward compability and version-checking stuff - must be required before it is used
+require File.expand_path("#{dir}/rubygems_version_checker")
+require File.expand_path("#{dir}/rubygems_version_warnings")
+GemInstaller::RubyGemsVersionWarnings.print_warnings
+
+# requires for rubygems internal classes
+require 'rubygems/doc_manager'
+require 'rubygems/config_file'
+if GemInstaller::RubyGemsVersionChecker.matches?('<0.9.3')
+  require 'rubygems/cmd_manager'
+else
+  require 'rubygems/command_manager'
+end
+require 'rubygems/gem_runner'
+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 GemInstaller::RubyGemsVersionChecker.matches?('<0.9.3')
+  require 'rubygems/commands/query_command'
+  require 'rubygems/commands/list_command'
+end
+
+# backward compability support for prior rubygems versions 
+require File.expand_path("#{dir}/backward_compatibility")
+
+# third party libs
+require 'erb'
+require 'optparse'
+require 'yaml'
+require 'fileutils'
+
+# third party lib extensions
+require File.expand_path("#{dir}/rubygems_extensions")
+
+# internal files
+require File.expand_path("#{dir}/../geminstaller")
+require File.expand_path("#{dir}/application")
+require File.expand_path("#{dir}/arg_parser")
+require File.expand_path("#{dir}/autogem")
+require File.expand_path("#{dir}/config")
+require File.expand_path("#{dir}/config_builder")
+require File.expand_path("#{dir}/registry")
+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_manager")
+require File.expand_path("#{dir}/gem_interaction_handler")
+require File.expand_path("#{dir}/gem_list_checker")
+require File.expand_path("#{dir}/gem_runner_proxy")
+require File.expand_path("#{dir}/gem_source_index_proxy")
+require File.expand_path("#{dir}/gem_spec_manager")
+require File.expand_path("#{dir}/geminstaller_error")
+require File.expand_path("#{dir}/geminstaller_access_error")
+require File.expand_path("#{dir}/install_processor")
+require File.expand_path("#{dir}/missing_dependency_finder")
+require File.expand_path("#{dir}/missing_file_error")
+require File.expand_path("#{dir}/noninteractive_chooser")
+require File.expand_path("#{dir}/output_filter")
+require File.expand_path("#{dir}/output_listener")
+require File.expand_path("#{dir}/output_observer")
+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")
+require File.expand_path("#{dir}/version_specifier")
+require File.expand_path("#{dir}/yaml_loader")
+

data/lib/geminstaller/rogue_gem_finder.rb

@@ -0,0 +1,195 @@
+module GemInstaller
+  class RogueGemFinder
+    attr_writer :output_proxy, :gem_command_manager, :gem_spec_manager, :boilerplate_lines, :preinstalled_gem_names, :preinstalled_comment
+
+    def print_rogue_gems(config_gems, config_file_paths)
+      @boilerplate_lines ||= default_boilerplate_lines(config_gems, config_file_paths)
+      @preinstalled_gem_names ||= default_preinstalled_gem_names
+      @preinstalled_comment ||= default_preinstalled_comment
+      @config_gems_with_dependencies = []
+      config_gems.each do |config_gem|
+        process_gem(config_gem)
+      end
+      all_local_gems = @gem_spec_manager.all_local_gems
+      rogue_gems = []
+      all_local_gems.each do |local_gem|
+        config_match_found_for_local = false
+        @config_gems_with_dependencies.each do |config_gem|
+          name_matches = config_gem.name == local_gem.name
+          config_gem_version_requirement = Gem::Version::Requirement.new [config_gem.version]
+          local_gem_version = Gem::Version.new(local_gem.version)
+          version_matches = config_gem_version_requirement.satisfied_by?(local_gem_version)
+          if (name_matches and version_matches)
+            config_match_found_for_local = true
+            break
+          end
+        end
+        rogue_gems << local_gem unless config_match_found_for_local
+      end
+      yaml = format_to_yaml(rogue_gems)
+      
+      handle_output(yaml)
+    end
+    
+    def default_boilerplate_lines(config_gems, config_file_paths)
+      boilerplate = []
+      boilerplate <<  [
+        "#",
+        "# This is a GemInstaller config file (http://geminstaller.rubyforge.org)",
+        "# It was generated using the 'geminstaller --print-rogue-gems' option on #{Time.now}",
+        "#",
+        "# You can bootstrap your config by piping the output to a file: ",
+        "#   'geminstaller --print-rogue-gems > geminstaller.yml'",
+        "#",
+        "# You can then install these gems on another system by running geminstaller with this file.",
+        "#"
+      ]
+      
+      if config_file_paths.size == 0
+        boilerplate << "# Since there was no config file specified, the 'gems:' section below lists all gems on your system."
+      else
+        boilerplate << "# The following config file(s) and gems were already specified:"
+        boilerplate << "#   Files:"
+        config_file_paths.each do |config_file_path|
+          boilerplate << "#     * " + config_file_path
+        end
+        boilerplate << "#   Gems:"
+        if config_gems.size > 0
+          config_gems.each do |config_gem|
+            boilerplate << "#     * #{config_gem.name} #{config_gem.version}"
+          end
+        else
+          boilerplate << "#     No Gems"
+        end
+      end
+      boilerplate << "#"
+      boilerplate << "defaults:"
+      boilerplate << "  install_options: --include-dependencies"
+      return boilerplate
+    end
+    
+    def default_preinstalled_gem_names
+      # This is the list of preinstalled gems from the Ruby windows 1-click installer, v186-25
+      # 
+      # fxri (0.3.6)
+      #     Graphical interface to the RI documentation, with search engine.
+      # 
+      # fxruby (1.6.6)
+      #     FXRuby is the Ruby binding to the FOX GUI toolkit.
+      # 
+      # hpricot (0.4)
+      #     a swift, liberal HTML parser with a fantastic library
+      # 
+      # log4r (1.0.5)
+      #     Log4r is a comprehensive and flexible logging library for Ruby.
+      # 
+      # rake (0.7.2)
+      #     Ruby based make-like utility.
+      # 
+      # sources (0.0.1)
+      #     This package provides download sources for remote gem installation
+      # 
+      # win32-clipboard (0.4.1)
+      #     A package for interacting with the Windows clipboard
+      # 
+      # win32-dir (0.3.1)
+      #     Extra constants and methods for the Dir class on Windows.
+      # 
+      # win32-eventlog (0.4.3)
+      #     Interface for the MS Windows Event Log.
+      # 
+      # win32-file (0.5.3)
+      #     Extra or redefined methods for the File class on Windows.
+      # 
+      # win32-file-stat (1.2.3)
+      #     A File::Stat class tailored to MS Windows
+      # 
+      # win32-process (0.5.1)
+      #     Adds fork, wait, wait2, waitpid, waitpid2 and a special kill method
+      # 
+      # win32-sapi (0.1.3)
+      #     An interface to the MS SAPI (Sound API) library.
+      # 
+      # win32-sound (0.4.0)
+      #     A package for playing with sound on Windows.
+      # 
+      # windows-pr (0.6.2)
+      #     Windows functions and constants predefined via Win32API
+
+      if RUBY_PLATFORM =~ /mswin/
+        return [
+          'fxri',
+          'fxruby',
+          'hpricot',
+          'log4r',
+          'rake',
+          'sources',
+          'win32-clipboard',
+          'win32-dir',
+          'win32-eventlog',
+          'win32-file',
+          'win32-file-stat',
+          'win32-process',
+          'win32-sapi',
+          'win32-sound',
+          'windows-pr'
+        ]
+      end
+      return ['sources']
+    end
+    
+    def default_preinstalled_comment
+      "# NOTE: This gem may have been automatially installed with Ruby, and not actually be used by your app(s)."
+    end
+    
+    def handle_output(yaml)
+      yaml_lines = yaml.split("\n")
+      yaml_doc_separator = yaml_lines.delete_at(0)
+      
+      output = []
+      output.push(yaml_doc_separator)
+      
+      output << @boilerplate_lines
+      
+      yaml_lines.each do |yaml_line| 
+        name_parser_regexp = /- name: (.*)/
+        yaml_line =~  name_parser_regexp
+        gem_name = $1
+        preinstalled_comment = ''
+        if @preinstalled_gem_names.include?(gem_name)
+          preinstalled_comment = " " + @preinstalled_comment
+        end
+        output.push yaml_line + preinstalled_comment
+      end
+      
+      output_string = output.join("\n")
+      @output_proxy.sysout output_string
+      output_string
+    end
+    
+    def process_gem(gem)
+      @config_gems_with_dependencies << gem
+      process_gem_dependencies(gem)
+    end
+
+    def process_gem_dependencies(gem)
+      # TODO: this method is duplicated in autogem  Should abstract and take a block
+      matching_gems = @gem_spec_manager.local_matching_gems(gem)
+      matching_gems.each do |matching_gem|
+        dependency_gems = @gem_command_manager.dependency(matching_gem.name, matching_gem.version.to_s)
+        dependency_gems.each do |dependency_gem|
+          process_gem(dependency_gem)
+        end
+      end
+    end
+
+    def format_to_yaml(gems)
+      names_and_versions = []
+      gems.each do |gem|
+        names_and_versions << {'name' => gem.name, 'version' => gem.version}
+      end
+      hash_for_yaml = {'gems' => names_and_versions}
+      YAML.dump(hash_for_yaml)
+    end
+  end
+end