Class: Pry::Config

Inherits:

OpenStruct

• Object
• OpenStruct
• Pry::Config

show all

Defined in:

lib/pry/config.rb

Instance Attribute Summary (collapse)

• - (Boolean) auto_indent

  Whether or not code should be indented using Pry::Indent.

• - (Boolean) collision_warning

  Whether or not a warning will be displayed when a command name collides with a method/local in the current context.

• - (Boolean) color

  Toggle Pry color on and off.

• - (String) command_prefix

  A string that must precede all Pry commands (e.g., if command_prefix is set to "%", the "cd" command must be invoked as "%cd").

• - (Pry::CommandBase) commands

  Get/Set the object to use for commands by default by all Pry instances.

• - (Proc) control_d_handler

  The proc that manages ^D presses in the REPL.

• - (Boolean) correct_indent

  Whether or not indentation should be corrected after hitting enter.

• - (Fixnum) default_window_size

  The number of lines of context to show before and after exceptions, etc.

• - (Boolean) disable_auto_reload

  Determines whether to disable edit-method's auto-reloading behavior.

• - (String, #call) editor

  The default editor to use.

• - (Proc) exception_handler

  Pry.config.exception_handler is an option determining the exception handler object - the Proc responsible for dealing with exceptions raised by user input to the REPL.

• - (Array) exception_whitelist

  The classes of exception that will not be caught by Pry.

• - (Hash) extra_sticky_locals

  Additional sticky locals (to the standard ones) to use in Pry sessions.

• - (OpenStruct) gist

  Config option for gist.

• - (OpenStruct) history

  Config option for history.

• - (Pry::Hooks) hooks

  Get/Set the Pry::Hooks instance that defines Pry hooks used by default by all Pry instances.

• - (#readline) input

  Get/Set the object to use for input by default by all Pry instances.

• - (Array) input_stack

  Get/Set the stack of input objects that a Pry instance switches to when its current input object encounters EOF.

• - (Integer) memory_size

  Amount of results that will be stored into out.

• - (#puts) output

  Get/Set the object to use for output by default by all Pry instances.

• - (Boolean) pager

  Toggle paging on and off.

• - (OpenStruct) plugins

  Config option for plugins: sub-options include: plugins.strict_loading (Boolean) which toggles whether referring to a non-existent plugin should raise an exception (defaults to false).

• - (Proc) print

  Get/Set the Proc to use for printing by default by all Pry instances.

• - (Array<Proc>, Proc) prompt

  Get the array of Procs (or single Proc) to be used for the prompts by default by all Pry instances.

• - (Array<String>) requires

  Ruby files to be required after loading any plugins.

• - (Boolean) should_load_plugins

  Determines whether plugins should be loaded.

• - (Boolean) should_load_rc

  Determines whether the rc file (~/.pryrc) should be loaded.

• - (Boolean) should_load_requires

  Determines whether to load files specified with the -r flag.

• - (Boolean) should_trap_interrupts

  Determines whether Pry should trap SIGINT and cause it to raise an Interrupt exception.

• - (Proc) system

  The proc that runs system commands The proc is passed the pry output object, the command string to eval, and a reference to the pry instance.

200
201
202

# File 'lib/pry/config.rb', line 200

def auto_indent
  @auto_indent
end

208
209
210

# File 'lib/pry/config.rb', line 208

def collision_warning
  @collision_warning
end

139
140
141

# File 'lib/pry/config.rb', line 139

def color
  @color
end

136
137
138

# File 'lib/pry/config.rb', line 136

def command_prefix
  @command_prefix
end

Pry.config.commands = Pry::CommandSet.new do
            import_from Pry::Commands, "ls"

              command "greet" do |name|
              output.puts "hello #{name}"
            end
          end

37
38
39

# File 'lib/pry/config.rb', line 37

def commands
  @commands
end

191
192
193

# File 'lib/pry/config.rb', line 191

def control_d_handler
  @control_d_handler
end

204
205
206

# File 'lib/pry/config.rb', line 204

def correct_indent
  @correct_indent
end

Pry.config.default_window_size = 10

75
76
77

# File 'lib/pry/config.rb', line 75

def default_window_size
  @default_window_size
end

158
159
160

# File 'lib/pry/config.rb', line 158

def disable_auto_reload
  @disable_auto_reload
end

Pry.config.editor = "emacsclient"

Pry.config.editor = proc { |file, line| "emacsclient #{file} +#{line}" }

Pry.config.editor = proc { |file, line, reloading| "subl #{'--wait' if reloading} #{file}:#{line}" }

131
132
133

# File 'lib/pry/config.rb', line 131

def editor
  @editor
end

Pry.config.exception_handler = proc do |output, exception, _|
  output.puts "#{exception.class}: #{exception.message}"
  output.puts "from #{exception.backtrace.first}"
end

64
65
66

# File 'lib/pry/config.rb', line 64

def exception_handler
  @exception_handler
end

Pry.config.exception_whitelist = [SystemExit, SignalException]

69
70
71

# File 'lib/pry/config.rb', line 69

def exception_whitelist
  @exception_whitelist
end

Pry.config.extra_sticky_locals = { :random_number => proc {
rand(10) } }

226
227
228

# File 'lib/pry/config.rb', line 226

def extra_sticky_locals
  @extra_sticky_locals
end

Pry.config.gist.inspecter = proc { |v| v.pretty_inspect }

Pry.config.gist.inspecter = proc &:inspect

220
221
222

# File 'lib/pry/config.rb', line 220

def gist
  @gist
end

175
176
177

# File 'lib/pry/config.rb', line 175

def history
  @history
end

Pry.config.hooks = Pry::Hooks.new.add_hook(:before_session,
:default) {  |output, target, _pry_| output.puts "Good morning!" }

83
84
85

# File 'lib/pry/config.rb', line 83

def hooks
  @hooks
end

Pry.config.input = StringIO.new("@x = 10\nexit")

14
15
16

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

def input
  @input
end

Pry.config.input_stack = [StringIO.new("puts 'hello world'\nexit")]

102
103
104

# File 'lib/pry/config.rb', line 102

def input_stack
  @input_stack
end

187
188
189

# File 'lib/pry/config.rb', line 187

def memory_size
  @memory_size
end

Pry.config.output = StringIO.new

24
25
26

# File 'lib/pry/config.rb', line 24

def output
  @output
end

142
143
144

# File 'lib/pry/config.rb', line 142

def pager
  @pager
end

181
182
183

# File 'lib/pry/config.rb', line 181

def plugins
  @plugins
end

Pry.config.print = proc { |output, value| output.puts "=> #{value.inspect}" }

49
50
51

# File 'lib/pry/config.rb', line 49

def print
  @print
end

Pry.config.prompt = proc { |obj, nest_level, _pry_| "#{obj}:#{nest_level}> " }

113
114
115

# File 'lib/pry/config.rb', line 113

def prompt
  @prompt
end

184
185
186

# File 'lib/pry/config.rb', line 184

def requires
  @requires
end

150
151
152

# File 'lib/pry/config.rb', line 150

def should_load_plugins
  @should_load_plugins
end

146
147
148

# File 'lib/pry/config.rb', line 146

def should_load_rc
  @should_load_rc
end

154
155
156

# File 'lib/pry/config.rb', line 154

def should_load_requires
  @should_load_requires
end

164
165
166

# File 'lib/pry/config.rb', line 164

def should_trap_interrupts
  @should_trap_interrupts
end

196
197
198

# File 'lib/pry/config.rb', line 196

def system
  @system
end