Class: PantographCore::UpdateChecker

Inherits:
Object
  • Object
show all
Defined in:
pantograph_core/lib/pantograph_core/update_checker/update_checker.rb

Overview

Verifies, the user runs the latest version of this gem

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.start_time ⇒ Object (readonly)

Returns the value of attribute start_time.



32
33
34
 
# File 'pantograph_core/lib/pantograph_core/update_checker/update_checker.rb', line 32

def start_time
  @start_time
end

Class Method Details

.ensure_rubygems_source ⇒ Object

Check if RubyGems is set as a gem source on some machines that might not be the case and then users can’t find the update when running the specified command



89
90
91
92
93
94
95
96
97
 
# File 'pantograph_core/lib/pantograph_core/update_checker/update_checker.rb', line 89

def self.ensure_rubygems_source
  return if Helper.contained_pantograph?
  return if `gem sources`.include?("https://rubygems.org")
  puts("")
  UI.error("RubyGems is not listed as your Gem source")
  UI.error("You can run `gem sources` to see all your sources")
  UI.error("Please run the following command to fix this:")
  UI.command("gem sources --add https://rubygems.org")
end

.fetch_latest(gem_name) ⇒ Object 



99
100
101
 
# File 'pantograph_core/lib/pantograph_core/update_checker/update_checker.rb', line 99

def self.fetch_latest(gem_name)
  JSON.parse(Excon.get(generate_fetch_url(gem_name)).body)["version"]
end

.generate_fetch_url(gem_name) ⇒ Object 



103
104
105
 
# File 'pantograph_core/lib/pantograph_core/update_checker/update_checker.rb', line 103

def self.generate_fetch_url(gem_name)
  "https://rubygems.org/api/v1/gems/#{gem_name}.json"
end

.server_results ⇒ Object 



27
28
29
 
# File 'pantograph_core/lib/pantograph_core/update_checker/update_checker.rb', line 27

def self.server_results
  @results ||= {}
end

.show_update_message(gem_name, current_version) ⇒ Object

Show a message to the user to update to a new version of pantograph (or a sub-gem) Use this method, as this will detect the current Ruby environment and show an appropriate message to the user



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'pantograph_core/lib/pantograph_core/update_checker/update_checker.rb', line 49

def self.show_update_message(gem_name, current_version)
  available = server_results[gem_name]
  puts("")
  puts('#######################################################################')
  if available
    puts("# #{gem_name} #{available} is available. You are on #{current_version}.")
  else
    puts("# An update for #{gem_name} is available. You are on #{current_version}.")
  end
  puts("# You should use the latest version.")
  puts("# Please update using `#{self.update_command(gem_name: gem_name)}`.")

  puts("# To see what's new, open https://github.com/urbanquakers/#{gem_name}/releases.") if PantographCore::Env.truthy?("PANTOGRAPH_HIDE_CHANGELOG")

  if !Helper.bundler? && !Helper.contained_pantograph? && Random.rand(5) == 1
    # We want to show this message from time to time, if the user doesn't use bundler, nor bundled pantograph
    puts('#######################################################################')
    puts("# Run `gem cleanup` from time to time to speed up pantograph")
  end
  puts('#######################################################################')
  Changelog.show_changes(gem_name, current_version, update_gem_command: UpdateChecker.update_command(gem_name: gem_name)) unless PantographCore::Env.truthy?("PANTOGRAPH_HIDE_CHANGELOG")

  ensure_rubygems_source
end

.show_update_status(gem_name, current_version) ⇒ Object 



40
41
42
43
44
 
# File 'pantograph_core/lib/pantograph_core/update_checker/update_checker.rb', line 40

def self.show_update_status(gem_name, current_version)
  if update_available?(gem_name, current_version)
    show_update_message(gem_name, current_version)
  end
end

.start_looking_for_update(gem_name) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'pantograph_core/lib/pantograph_core/update_checker/update_checker.rb', line 12

def self.start_looking_for_update(gem_name)
  return if Helper.test?
  return if PantographCore::Env.truthy?("PANTOGRAPH_SKIP_UPDATE_CHECK")

  @start_time = Time.now

  Thread.new do
    begin
      server_results[gem_name] = fetch_latest(gem_name)
    rescue
      # we don't want to show a stack trace if something goes wrong
    end
  end
end

.update_available?(gem_name, current_version) ⇒ Boolean

Returns:



35
36
37
38
 
# File 'pantograph_core/lib/pantograph_core/update_checker/update_checker.rb', line 35

def self.update_available?(gem_name, current_version)
  latest = server_results[gem_name]
  return (latest and Gem::Version.new(latest) > Gem::Version.new(current_version))
end

.update_command(gem_name: "pantograph") ⇒ Object

The command that the user should use to update their mac



75
76
77
78
79
80
81
82
83
 
# File 'pantograph_core/lib/pantograph_core/update_checker/update_checker.rb', line 75

def self.update_command(gem_name: "pantograph")
  if Helper.bundler?
    "bundle update #{gem_name.downcase}"
  elsif Helper.contained_pantograph? || Helper.homebrew?
    "pantograph update_pantograph"
  else
    "gem install #{gem_name.downcase}"
  end
end