Sha256: 956e474d7231b11e03d129e0fa6372763c42418be1d7bf09891670eef26e1c45

Contents?: true

Size: 1.37 KB

Versions: 79

Compression:

Stored size: 1.37 KB

Contents

class Pry
  class Command::Ri < Pry::ClassCommand
    match 'ri'
    group 'Introspection'
    description 'View ri documentation.'

    banner <<-'BANNER'
      Usage: ri [spec]

      View ri documentation. Relies on the "rdoc" gem being installed.
      See also "show-doc" command.

      ri Array#each
    BANNER

    def process(spec)
      # Lazily load RI
      require 'rdoc/ri/driver'

      unless defined? RDoc::RI::PryDriver

        # Subclass RI so that it formats its output nicely, and uses `lesspipe`.
        subclass = Class.new(RDoc::RI::Driver) # the hard way.

        subclass.class_eval do
          def page
            paging_text = StringIO.new
            yield paging_text
            Pry::Pager.page(paging_text.string)
          end

          def formatter(io)
            if @formatter_klass then
              @formatter_klass.new
            else
              RDoc::Markup::ToAnsi.new
            end
          end
        end

        RDoc::RI.const_set :PryDriver, subclass   # hook it up!
      end

      # Spin-up an RI insance.
      ri = RDoc::RI::PryDriver.new :use_stdout => true, :interactive => false

      begin
        ri.display_names [spec]  # Get the documentation (finally!)
      rescue RDoc::RI::Driver::NotFoundError => e
        output.puts "error: '#{e.name}' not found"
      end
    end
  end

  Pry::Commands.add_command(Pry::Command::Ri)
end

Version data entries

79 entries across 79 versions & 5 rubygems

Version Path
asana2flowdock-1.0.0 vendor/bundle/ruby/1.9.1/gems/pry-0.9.12.6/lib/pry/commands/ri.rb
pry-0.9.12.6 lib/pry/commands/ri.rb
pry-0.9.12.6-i386-mswin32 lib/pry/commands/ri.rb
pry-0.9.12.6-i386-mingw32 lib/pry/commands/ri.rb
pry-0.9.12.6-java lib/pry/commands/ri.rb
pry-0.9.12.5 lib/pry/commands/ri.rb
pry-0.9.12.5-i386-mswin32 lib/pry/commands/ri.rb
pry-0.9.12.5-i386-mingw32 lib/pry/commands/ri.rb
pry-0.9.12.5-java lib/pry/commands/ri.rb
pry-0.9.12.4 lib/pry/commands/ri.rb
pry-0.9.12.4-i386-mswin32 lib/pry/commands/ri.rb
pry-0.9.12.4-i386-mingw32 lib/pry/commands/ri.rb
pry-0.9.12.4-java lib/pry/commands/ri.rb
pry-0.9.12.3 lib/pry/commands/ri.rb
pry-0.9.12.3-i386-mswin32 lib/pry/commands/ri.rb
pry-0.9.12.3-i386-mingw32 lib/pry/commands/ri.rb
pry-0.9.12.3-java lib/pry/commands/ri.rb
torquebox-console-0.3.0 vendor/bundle/jruby/1.9/gems/pry-0.9.12-java/lib/pry/commands/ri.rb
sshp-0.0.2 vendor/ruby/1.9.1/gems/pry-0.9.12.2/lib/pry/commands/ri.rb
sshp-0.0.1 vendor/ruby/1.9.1/gems/pry-0.9.12.2/lib/pry/commands/ri.rb