Class: Pry::REPL

Inherits:

Object

• Object
• Pry::REPL

Extended by:

Forwardable

Defined in:

lib/pry/repl.rb

Instance Attribute Summary

• #pry ⇒ Pry

  The instance of Pry that the user is controlling.

Class Method Summary

• .start(options) ⇒ Object

  Instantiate a new Pry instance with the given options, then start a REPL instance wrapping it.

Instance Method Summary

• #initialize(pry, options = {}) ⇒ REPL constructor

  Create an instance of REPL wrapping the given Pry.

• #start ⇒ Object?

  Start the read-eval-print loop.

Methods included from Forwardable

def_private_delegators

Constructor Details

#initialize(pry, options = {}) ⇒ REPL

Create an instance of Pry::REPL wrapping the given Pry.

Parameters:

• pry (Pry) —

  The instance of Pry that this Pry::REPL will control.

• options (Hash) (defaults to: {}) —

  Options for this Pry::REPL instance.

Options Hash (options):

• :target (Object) —

  The initial target of the session.

# File 'lib/pry/repl.rb', line 22

def initialize(pry, options = {})
  @pry    = pry
  @indent = Pry::Indent.new(pry)

  @readline_output = nil

  @pry.push_binding options[:target] if options[:target]
end

Instance Attribute Details

#pry ⇒ Pry

Returns The instance of Pry that the user is controlling.

Returns:

• (Pry) —

  The instance of Pry that the user is controlling.

# File 'lib/pry/repl.rb', line 9

def pry
  @pry
end

Class Method Details

.start(options) ⇒ Object

Instantiate a new Pry instance with the given options, then start a Pry::REPL instance wrapping it.

Parameters:

• options (Hash) —

  a customizable set of options

Options Hash (options):

• See (Pry#initialize)

# File 'lib/pry/repl.rb', line 14

def self.start(options)
  new(Pry.new(options)).start
end

Instance Method Details

#start ⇒ Object?

Start the read-eval-print loop.

Returns:

• (Object?) —

  If the session throws ‘:breakout`, return the value thrown with it.

Raises:

• (Exception) —

  If the session throws ‘:raise_up`, raise the exception thrown with it.

# File 'lib/pry/repl.rb', line 36

def start
  prologue
  Pry::InputLock.for(:all).with_ownership { repl }
ensure
  epilogue
end