Class: PryGem::GemReadme

Inherits:
Pry::ClassCommand
  • Object
show all
Defined in:
lib/pry-gem/gem_readme.rb

Overview

Since:

  • 1.0.0

Instance Method Summary collapse

Instance Method Details

#process(name) ⇒ Object

Since:

  • 1.0.0



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/pry-gem/gem_readme.rb', line 13

def process(name)
  spec = Gem::Specification.find_by_name(name)
  glob = File.join(spec.full_gem_path, 'README*')
  readme = Dir[glob][0]

  unless File.exist?(readme.to_s)
    raise Pry::CommandError, "Gem '#{name}' doesn't appear to have a README"
  end

  _pry_.pager.page File.read(readme)
rescue Gem::LoadError
  raise Pry::CommandError,
        "Gem '#{name}' wasn't found. Are you sure it is installed?"
end