123456789_123456789_123456789_123456789_123456789_

Module: Gem::Molinillo::UI

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
::Gem::Resolver
Defined in: lib/rubygems/vendor/molinillo/lib/molinillo/modules/ui.rb

Overview

Conveys information about the resolution process to a user.

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#debug? ⇒ Boolean (readonly)

Whether or not debug messages should be printed. By default, whether or not the MOLINILLO_DEBUG environment variable is set.

[ GitHub ] 

  


# File 'lib/rubygems/vendor/molinillo/lib/molinillo/modules/ui.rb', line 62



def debug?
  return @debug_mode if defined?(@debug_mode)
  @debug_mode = ENV['MOLINILLO_DEBUG']
end


  







Instance Method Details



  

    #after_resolution  ⇒ void 
  



  

    
This method returns an undefined value.


Called after resolution ends (either successfully or with an error). By default, prints a newline.


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/vendor/molinillo/lib/molinillo/modules/ui.rb', line 40



def after_resolution
  output.puts
end


  








  

    #before_resolution  ⇒ void 
  



  

    
This method returns an undefined value.


Called before resolution begins.


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/vendor/molinillo/lib/molinillo/modules/ui.rb', line 32



def before_resolution
  output.print 'Resolving dependencies...'
end


  








  

    #debug(depth = 0)  ⇒ void  (readonly)
  



  

    
This method returns an undefined value.


Conveys debug information to the user.


  





  
Parameters:


    
  
  • 
    depth
    (Integer)
    (defaults to: 0)
—    
    

    the current depth of the resolution process.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/vendor/molinillo/lib/molinillo/modules/ui.rb', line 48



def debug(depth = 0)
  if debug?
    debug_info = yield
    debug_info = debug_info.inspect unless debug_info.is_a?(String)
    debug_info = debug_info.split("\n").map { |s| ":#{depth.to_s.rjust 4}: #{s}" }
    output.puts debug_info
  end
end


  








  

    #indicate_progress  ⇒ void 
  



  

    
This method returns an undefined value.


Called roughly every #progress_rate, this method should convey progress to the user.


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/vendor/molinillo/lib/molinillo/modules/ui.rb', line 17



def indicate_progress
  output.print '.' unless debug?
end


  








  

    #output  ⇒ IO 
  



  

    

The IO object that should be used to print output. STDOUT, by default.


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/vendor/molinillo/lib/molinillo/modules/ui.rb', line 9



def output
  STDOUT
end


  








  

    #progress_rate  ⇒ Float 
  



  

    

How often progress should be conveyed to the user via #indicate_progress, in seconds. A third of a second, by default.


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/vendor/molinillo/lib/molinillo/modules/ui.rb', line 25



def progress_rate
  0.33
end