Sha256: 8e949e5b586db6f57c4fd2e830e4e2fddfdff64e4f2fe6fbbece7b70bfaebcd0

Contents?: true

Size: 748 Bytes

Versions: 39

Compression:

Stored size: 748 Bytes

Contents

class Pry::Command::GemReadme < Pry::ClassCommand
  match 'gem-readme'
  description 'Show the readme bundled with a rubygem'
  group 'Gems'
  command_options argument_required: true
  banner <<-BANNER
    gem-readme gem
    Show the readme bundled with a rubygem
  BANNER

  def process(name)
    spec = Gem::Specification.find_by_name(name)
    glob = File.join(spec.full_gem_path, 'README*')
    readme = Dir[glob][0]
    if File.exist?(readme.to_s)
      _pry_.pager.page File.read(readme)
    else
      raise Pry::CommandError, "Gem '#{name}' doesn't appear to have a README"
    end
  rescue Gem::LoadError
    raise Pry::CommandError, "Gem '#{name}' wasn't found. Are you sure it is installed?"
  end

  Pry::Commands.add_command(self)
end

Version data entries

39 entries across 39 versions & 14 rubygems

Version Path
argon-1.3.1 vendor/bundle/ruby/2.7.0/gems/pry-0.12.2/lib/pry/commands/gem_readme.rb
symbolic_enum-1.1.5 vendor/bundle/ruby/2.7.0/gems/pry-0.12.2/lib/pry/commands/gem_readme.rb
honeybadger-4.5.3 vendor/bundle/ruby/2.6.0/gems/pry-0.12.2/lib/pry/commands/gem_readme.rb
chatops-rpc-0.0.2 fixtures/chatops-controller-example/vendor/bundle/ruby/2.5.0/gems/pry-0.12.2/lib/pry/commands/gem_readme.rb
chatops-rpc-0.0.1 fixtures/chatops-controller-example/vendor/bundle/ruby/2.5.0/gems/pry-0.12.2/lib/pry/commands/gem_readme.rb
dadapush_client-1.0.1 vendor/bundle/ruby/2.3.0/gems/pry-0.11.3/lib/pry/commands/gem_readme.rb
chess_engine-0.0.2 vendor/bundle/gems/pry-0.12.2/lib/pry/commands/gem_readme.rb
chess_engine-0.0.1 vendor/bundle/gems/pry-0.12.2/lib/pry/commands/gem_readme.rb
xaiml-0.1.3 vendor/bundle/ruby/2.5.0/gems/pry-0.11.3/lib/pry/commands/gem_readme.rb
alimentos-alu0100945645-0.1.0 vendor/bundle/ruby/2.3.0/gems/pry-0.12.2/lib/pry/commands/gem_readme.rb
alimentos-alu0100945645-1.0.0 vendor/bundle/ruby/2.3.0/gems/pry-0.12.2/lib/pry/commands/gem_readme.rb
xaiml-0.1.2 vendor/bundle/ruby/2.5.0/gems/pry-0.11.3/lib/pry/commands/gem_readme.rb
pry-0.12.2-java lib/pry/commands/gem_readme.rb
pry-0.12.2 lib/pry/commands/gem_readme.rb
pry-0.12.1 lib/pry/commands/gem_readme.rb
pry-0.12.1-java lib/pry/commands/gem_readme.rb
pry-0.12.0 lib/pry/commands/gem_readme.rb
pry-0.12.0-java lib/pry/commands/gem_readme.rb
xaiml-0.1.1 vendor/bundle/ruby/2.5.0/gems/pry-0.11.3/lib/pry/commands/gem_readme.rb
xaiml-0.1.0 vendor/bundle/ruby/2.5.0/gems/pry-0.11.3/lib/pry/commands/gem_readme.rb