123456789_123456789_123456789_123456789_123456789_

Module: Gem::UpdateSuggestion

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
Commands::InstallCommand
Defined in: lib/rubygems/update_suggestion.rb

Overview

Mixin methods for Command to promote available RubyGems update

Constant Summary

Instance Attribute Summary

Instance Method Summary

  • #update_suggestion

    Message to promote available RubyGems update with related gem update command.

Instance Attribute Details

#ci? ⇒ Boolean (readonly)

[ GitHub ] 

  


# File 'lib/rubygems/update_suggestion.rb', line 66



def ci?
  CI_ENV_VARS.any? {|var| ENV.include?(var) }
end


  








  

    #eglible_for_update?  ⇒ Boolean  (readonly)
  



  

    

Determines if current environment is eglible for update suggestion.


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/update_suggestion.rb', line 33



def eglible_for_update?
  # explicit opt-out
  return false if Gem.configuration[:prevent_update_suggestion]
  return false if ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"]

  # focus only on human usage of final RubyGems releases
  return false unless Gem.ui.tty?
  return false if Gem.rubygems_version.prerelease?
  return false if Gem.disable_system_update_message
  return false if ci?

  # check makes sense only when we can store timestamp of last try
  # otherwise we will not be able to prevent "annoying" update message
  # on each command call
  return unless Gem.configuration.state_file_writable?

  # load time of last check, ensure the difference is enough to repeat the suggestion
  check_time = Time.now.to_i
  last_update_check = Gem.configuration.last_update_check
  return false if (check_time - last_update_check) < ONE_WEEK

  # compare current and latest version, this is the part where
  # latest rubygems spec is fetched from remote
  (Gem.rubygems_version < Gem.latest_rubygems_version).tap do |eglible|
    # store the time of last successful check into state file
    Gem.configuration.last_update_check = check_time

    return eglible
  end
rescue # don't block install command on any problem
  false
end


  







Instance Method Details



  

    #update_suggestion  
  



  

    

Message to promote available RubyGems update with related gem update command.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/update_suggestion.rb', line 21



def update_suggestion
  <<-MESSAGE

A new release of RubyGems is available: #{Gem.rubygems_version} → #{Gem.latest_rubygems_version}!
Run `gem update --system #{Gem.latest_rubygems_version}` to update your installation.

  MESSAGE
end