RubyGems - pry - Versions diffs - 0.12.2-java → 0.13.0-java - Mend

pry 0.12.2-java → 0.13.0-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (158) hide show

checksums.yaml +5 -5
data/CHANGELOG.md +110 -1
data/LICENSE +1 -1
data/README.md +331 -269
data/bin/pry +5 -0
data/lib/pry.rb +133 -119
data/lib/pry/basic_object.rb +8 -4
data/lib/pry/block_command.rb +22 -0
data/lib/pry/class_command.rb +194 -0
data/lib/pry/cli.rb +40 -31
data/lib/pry/code.rb +39 -27
data/lib/pry/code/code_file.rb +28 -24
data/lib/pry/code/code_range.rb +4 -2
data/lib/pry/code/loc.rb +15 -8
data/lib/pry/code_object.rb +40 -38
data/lib/pry/color_printer.rb +47 -46
data/lib/pry/command.rb +166 -369
data/lib/pry/command_set.rb +76 -73
data/lib/pry/command_state.rb +31 -0
data/lib/pry/commands/amend_line.rb +86 -81
data/lib/pry/commands/bang.rb +18 -14
data/lib/pry/commands/bang_pry.rb +15 -11
data/lib/pry/commands/cat.rb +61 -54
data/lib/pry/commands/cat/abstract_formatter.rb +23 -18
data/lib/pry/commands/cat/exception_formatter.rb +71 -60
data/lib/pry/commands/cat/file_formatter.rb +55 -49
data/lib/pry/commands/cat/input_expression_formatter.rb +35 -30
data/lib/pry/commands/cd.rb +40 -35
data/lib/pry/commands/change_inspector.rb +29 -22
data/lib/pry/commands/change_prompt.rb +44 -39
data/lib/pry/commands/clear_screen.rb +16 -10
data/lib/pry/commands/code_collector.rb +148 -133
data/lib/pry/commands/disable_pry.rb +23 -19
data/lib/pry/commands/easter_eggs.rb +19 -30
data/lib/pry/commands/edit.rb +184 -161
data/lib/pry/commands/edit/exception_patcher.rb +21 -17
data/lib/pry/commands/edit/file_and_line_locator.rb +34 -23
data/lib/pry/commands/exit.rb +39 -35
data/lib/pry/commands/exit_all.rb +24 -20
data/lib/pry/commands/exit_program.rb +20 -16
data/lib/pry/commands/find_method.rb +168 -160
data/lib/pry/commands/fix_indent.rb +16 -12
data/lib/pry/commands/help.rb +140 -133
data/lib/pry/commands/hist.rb +151 -150
data/lib/pry/commands/import_set.rb +20 -16
data/lib/pry/commands/jump_to.rb +25 -21
data/lib/pry/commands/list_inspectors.rb +35 -28
data/lib/pry/commands/ls.rb +124 -102
data/lib/pry/commands/ls/constants.rb +59 -42
data/lib/pry/commands/ls/formatter.rb +50 -46
data/lib/pry/commands/ls/globals.rb +38 -34
data/lib/pry/commands/ls/grep.rb +17 -13
data/lib/pry/commands/ls/instance_vars.rb +29 -27
data/lib/pry/commands/ls/interrogatable.rb +18 -12
data/lib/pry/commands/ls/jruby_hacks.rb +47 -41
data/lib/pry/commands/ls/local_names.rb +26 -22
data/lib/pry/commands/ls/local_vars.rb +38 -28
data/lib/pry/commands/ls/ls_entity.rb +47 -51
data/lib/pry/commands/ls/methods.rb +44 -43
data/lib/pry/commands/ls/methods_helper.rb +46 -42
data/lib/pry/commands/ls/self_methods.rb +23 -22
data/lib/pry/commands/nesting.rb +21 -17
data/lib/pry/commands/play.rb +93 -82
data/lib/pry/commands/pry_backtrace.rb +24 -17
data/lib/pry/commands/pry_version.rb +15 -11
data/lib/pry/commands/raise_up.rb +27 -22
data/lib/pry/commands/reload_code.rb +60 -48
data/lib/pry/commands/reset.rb +16 -12
data/lib/pry/commands/ri.rb +55 -45
data/lib/pry/commands/save_file.rb +45 -43
data/lib/pry/commands/shell_command.rb +51 -51
data/lib/pry/commands/shell_mode.rb +21 -17
data/lib/pry/commands/show_doc.rb +81 -68
data/lib/pry/commands/show_info.rb +189 -171
data/lib/pry/commands/show_input.rb +16 -11
data/lib/pry/commands/show_source.rb +109 -45
data/lib/pry/commands/stat.rb +35 -31
data/lib/pry/commands/switch_to.rb +21 -15
data/lib/pry/commands/toggle_color.rb +20 -16
data/lib/pry/commands/watch_expression.rb +89 -86
data/lib/pry/commands/watch_expression/expression.rb +32 -27
data/lib/pry/commands/whereami.rb +156 -148
data/lib/pry/commands/wtf.rb +75 -50
data/lib/pry/config.rb +311 -25
data/lib/pry/config/attributable.rb +22 -0
data/lib/pry/config/lazy_value.rb +29 -0
data/lib/pry/config/memoized_value.rb +34 -0
data/lib/pry/config/value.rb +24 -0
data/lib/pry/control_d_handler.rb +28 -0
data/lib/pry/core_extensions.rb +9 -7
data/lib/pry/editor.rb +48 -21
data/lib/pry/env.rb +18 -0
data/lib/pry/exception_handler.rb +43 -0
data/lib/pry/exceptions.rb +13 -16
data/lib/pry/forwardable.rb +5 -1
data/lib/pry/helpers.rb +2 -0
data/lib/pry/helpers/base_helpers.rb +68 -197
data/lib/pry/helpers/command_helpers.rb +50 -61
data/lib/pry/helpers/documentation_helpers.rb +20 -13
data/lib/pry/helpers/options_helpers.rb +14 -7
data/lib/pry/helpers/platform.rb +7 -5
data/lib/pry/helpers/table.rb +33 -26
data/lib/pry/helpers/text.rb +17 -14
data/lib/pry/history.rb +48 -56
data/lib/pry/hooks.rb +21 -12
data/lib/pry/indent.rb +54 -50
data/lib/pry/input_completer.rb +248 -230
data/lib/pry/input_lock.rb +8 -9
data/lib/pry/inspector.rb +36 -24
data/lib/pry/last_exception.rb +45 -45
data/lib/pry/method.rb +141 -94
data/lib/pry/method/disowned.rb +16 -4
data/lib/pry/method/patcher.rb +12 -3
data/lib/pry/method/weird_method_locator.rb +68 -44
data/lib/pry/object_path.rb +33 -25
data/lib/pry/output.rb +121 -35
data/lib/pry/pager.rb +41 -42
data/lib/pry/plugins.rb +25 -8
data/lib/pry/prompt.rb +123 -54
data/lib/pry/pry_class.rb +61 -98
data/lib/pry/pry_instance.rb +217 -215
data/lib/pry/repl.rb +18 -22
data/lib/pry/repl_file_loader.rb +27 -21
data/lib/pry/ring.rb +11 -6
data/lib/pry/slop.rb +574 -563
data/lib/pry/slop/commands.rb +164 -169
data/lib/pry/slop/option.rb +172 -168
data/lib/pry/syntax_highlighter.rb +26 -0
data/lib/pry/system_command_handler.rb +17 -0
data/lib/pry/testable.rb +59 -61
data/lib/pry/testable/evalable.rb +21 -12
data/lib/pry/testable/mockable.rb +18 -10
data/lib/pry/testable/pry_tester.rb +71 -56
data/lib/pry/testable/utility.rb +29 -21
data/lib/pry/testable/variables.rb +49 -43
data/lib/pry/version.rb +3 -1
data/lib/pry/warning.rb +27 -0
data/lib/pry/wrapped_module.rb +51 -42
data/lib/pry/wrapped_module/candidate.rb +21 -14
metadata +31 -30
data/lib/pry/commands.rb +0 -6
data/lib/pry/commands/disabled_commands.rb +0 -2
data/lib/pry/commands/gem_cd.rb +0 -26
data/lib/pry/commands/gem_install.rb +0 -32
data/lib/pry/commands/gem_list.rb +0 -33
data/lib/pry/commands/gem_open.rb +0 -29
data/lib/pry/commands/gem_readme.rb +0 -25
data/lib/pry/commands/gem_search.rb +0 -40
data/lib/pry/commands/gem_stats.rb +0 -83
data/lib/pry/commands/gist.rb +0 -102
data/lib/pry/commands/install_command.rb +0 -54
data/lib/pry/config/behavior.rb +0 -255
data/lib/pry/config/convenience.rb +0 -28
data/lib/pry/config/default.rb +0 -159
data/lib/pry/config/memoization.rb +0 -48
data/lib/pry/platform.rb +0 -91
data/lib/pry/rubygem.rb +0 -84
data/lib/pry/terminal.rb +0 -91

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4f6eb39efd0b5a9526d712978d04dded3b0200dd
-  data.tar.gz: be149199ccce2d6851d3497942995b54ffb29fd4
+SHA256:
+  metadata.gz: e3ae4ffd60475fd7653d02b380752ac8e84cd673cc6e76f232cda1e01ee303ad
+  data.tar.gz: 1b2c1619fce5542ab11e326c5ac3810237c872b1b6de26b469f61605c9c174af
 SHA512:
-  metadata.gz: c97ddbf0ea69c78fb9a449b208bf57a569a413e261eca3d565c455f4df32ca1cb8cd2fd4bee986b0c8233e02f9d4d6efa356f4c58c9e641a9c2b3c62ffa759e6
-  data.tar.gz: faad19c73cd4b222eaa13ca5aff0ea49650d37b8ad17d03f6e2e39611452fd4a800b13320fd111bb99a883b945d404adbf72c1ffa721da04c73db93ead0ded1b
+  metadata.gz: 1166e629ed40ab748089bef8665337c65b8922b05046a9b9b16c2ffab152cde437810309c8d7251c09960a916045e586d9c3783ec0e311b1d0dab43c00072af6
+  data.tar.gz: 7cc163e3363378ebaa2e28a8c1843b0c1bcbb0d7dd7fadbc5ac314df084ce47218525b807b1db827df9ae32bf794d6e301bf8c8140633b212d9af67dd2b1a7c7

data/CHANGELOG.md CHANGED

@@ -1,4 +1,112 @@
-### HEAD
+### master
+### [v0.13.0][v0.13.0] (March 21, 2020)
+#### Features
+* Added metadata to the gem (such as changelog URI, source code URI & bug
+  tracker URI), so it shows on https://rubygems.org/gems/pry
+  ([#1869](https://github.com/pry/pry/pull/1869))
+* Added ability to forward ARGV to a Pry session via `--` (or `-`) when
+  launching Pry from shell
+  ([#1902](https://github.com/pry/pry/commit/5cd65d3c0eb053f6edcdf571eea5d0cd990626ed))
+* Added `Pry::Config::LazyValue` & `Pry::Config::MemoizedValue`, which allow
+  storing callable procs in the config
+  ([#2024](https://github.com/pry/pry/pull/2024))
+* Added the `rc_file` config option that tells Pry the path to `pryrc`
+  ([#2027](https://github.com/pry/pry/pull/2027))
+* Added the `--code` flag to the `wtf` command, which shows code for each
+  backtrace frame ([#2037](https://github.com/pry/pry/pull/2037))
+* Added the ability to paste method call chains with leading dots
+  ([#2060](https://github.com/pry/pry/pull/2060))
+#### API changes
+* `Pry::Prompt` is a class now and it can be instantiated to create new prompts
+  on the fly that are not registered with `Pry::Prompt#add`. Learn more about
+  its API in the docs ([#1877](https://github.com/pry/pry/pull/1877))
+#### Deprecations
+* Deprecated `Pry.config.exception_whitelist` in favor of
+  `Pry.config.unrescued_exceptions`
+  ([#1874](https://github.com/pry/pry/pull/1874))
+* Deprecated `Pry.config.prompt = Pry::Prompt[:simple][:value]` in favor of
+  `Pry.config.prompt = Pry::Prompt[:simple]` when setting Pry prompt via
+  `pryrc`. `Pry::Prompt[:simple]` would return an instance of `Pry::Prompt`
+  instead of `Hash` ([#1877](https://github.com/pry/pry/pull/1877))
+* Deprecated setting prompt via an array of two procs:
+  ([#1877](https://github.com/pry/pry/pull/1877))
+  ```ruby
+  # Deprecated, emits a warning.
+  Pry.config.prompt = [proc {}, proc {}]
+  ```
+  This will be removed in the next release.
+* Deprecated the `show-doc` command. The `show-source -d` is the new recommended
+  way of reading docs ([#1934](https://github.com/pry/pry/pull/1934))
+* Deprecated `Pry::Command#_pry_`. Use `Pry::Command#pry_instance` instead
+  ([#1989](https://github.com/pry/pry/pull/1989))
+#### Breaking changes
+* Deleted deprecated `Pry::Platform`
+  ([#1863](https://github.com/pry/pry/pull/1863))
+* Deleted deprecated `Pry#{input/output}_array`
+  ([#1884](https://github.com/pry/pry/pull/1864))
+* Deleted deprecated `Pry::Prompt::MAP`
+  ([#1866](https://github.com/pry/pry/pull/1866))
+* Deleted deprecated methods of `Pry::Helpers::BaseHelpers` such as `mac_osx?`,
+  `linux?`, `windows?`, `windows_ansi?`, `jruby?`, `jruby_19?`, `mri?`,
+  `mri_19?`, `mri_2?` ([#1867](https://github.com/pry/pry/pull/1867))
+* Deleted deprecated `Pry::Command#text`
+  ([#1865](https://github.com/pry/pry/pull/1865))
+* Deleted deprecated `Pry::Method#all_from_common`
+  ([#1868](https://github.com/pry/pry/pull/1868))
+* Deleted `install-command` ([#1979](https://github.com/pry/pry/pull/1979))
+* Deleted `Pry::Helpers::BaseHelpers#command_dependencies_met?`
+  ([#1979](https://github.com/pry/pry/pull/1979))
+* Deleted commands: `gem-cd`, `gem-install`, `gem-list`, `gem-open`,
+  `gem-readme`, `gem-search`, `gem-stats`
+  ([#1981](https://github.com/pry/pry/pull/1981))
+* Deleted deprecated commands: `edit-method` and `show-command`
+  ([#2001](https://github.com/pry/pry/pull/2001))
+* Deleted `Pry::Command#disabled_commands`
+  ([#2001](https://github.com/pry/pry/pull/2001))
+* Deleted `Pry::BlockCommand#opts` (use `#context` instead)
+  ([#2003](https://github.com/pry/pry/pull/2003))
+* Deleted `Pry.lazy` (use `Pry::Config::LazyValue` instead)
+  ([#2024](https://github.com/pry/pry/pull/2024))
+#### Bug fixes
+* Fixed bug where using `Pry.config.prompt_name` can return a
+  `Pry::Config::Lazy` instead of expected instance of `String`
+  ([#1890](https://github.com/pry/pry/commit/c8f23b3464d596c08922dc923c64bb57488e6227))
+* Fixed `LoadError` being raised when using auto completions and Bundler
+  ([#1896](https://github.com/pry/pry/commit/85850f47e074fe01f93e5cb7d561e7c2de7aede9))
+* Fixed bug where `Pry.input_ring` doesn't append duplicate elements
+  ([#1898](https://github.com/pry/pry/pull/1898))
+* Fixed Ruby 2.6 warning about `Binding#source_location`
+  ([#1904](https://github.com/pry/pry/pull/1904))
+* Fixed wrong `winsize` when custom `output` is passed to Pry
+  ([#2045](https://github.com/pry/pry/pull/2045))
+* Fixed `XDG_CONFIG_HOME` & `XDG_DATA_HOME` precedence. When these env variables
+  are set, Pry no longer uses traditional files like `~/.pryrc` &
+  `~/.pry_history`. Instead, the env variable paths are loaded first
+  ([#2056](https://github.com/pry/pry/pull/2056))
+* Fixed the `$SAFE will become a normal global variable in Ruby 3.0` warning on
+  Ruby 2.7 ([#2107](https://github.com/pry/pry/pull/2107))
+* Fixed bug when `whereami -c` cannot show beginning of the class, which is on
+  the same line as another expression
+  ([#2098](https://github.com/pry/pry/pull/2098))
+* Fixed bug when `Object#owner` is defined, which results into somewhat broken
+  method introspection ([#2113](https://github.com/pry/pry/pull/2113))
+* Fixed bug when indentation leaves parts of input after pressing enter when
+  Readline is enabled with mode indicators for vi mode. This was supposed to be
+  fixed in v0.12.2 but it regressed
+  ([#2114](https://github.com/pry/pry/pull/2114))
 ### [v0.12.2][v0.12.2] (November 12, 2018)
@@ -951,3 +1059,4 @@ complete CHANGELOG:
 [v0.12.0]: https://github.com/pry/pry/releases/tag/v0.12.0
 [v0.12.1]: https://github.com/pry/pry/releases/tag/v0.12.1
 [v0.12.2]: https://github.com/pry/pry/releases/tag/v0.12.2
+[v0.13.0]: https://github.com/pry/pry/releases/tag/v0.13.0

data/LICENSE CHANGED

@@ -3,7 +3,7 @@ License
 (The MIT License)
-Copyright (c) 2018 The Pry Team
+Copyright (c) 2018 John Mair (banisterfiend)
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md CHANGED

@@ -1,20 +1,62 @@
+Pry
+===
 [![Circle Build Status](https://circleci.com/gh/pry/pry.svg?style=shield)](https://circleci.com/gh/pry/pry)
 [![Code Climate](https://codeclimate.com/github/pry/pry.svg)](https://codeclimate.com/github/pry/pry)
-[![Gem Version](https://badge.fury.io/rb/pry.svg)](http://badge.fury.io/rb/pry)
-[![Documentation Status](http://inch-ci.org/github/pry/pry.svg?branch=master)](http://inch-ci.org/github/pry/pry)
+[![Gem Version](https://badge.fury.io/rb/pry.svg)](https://badge.fury.io/rb/pry)
+[![Documentation Status](https://inch-ci.org/github/pry/pry.svg?branch=master)](https://inch-ci.org/github/pry/pry)
 [![Downloads](https://img.shields.io/gem/dt/pry.svg?style=flat)](https://rubygems.org/gems/pry)
-<br><br>
-![logo for Pry](https://www.dropbox.com/s/zp8o63kquby2rln/pry_logo_350.png?raw=1)
-**Other Resources**
+![Pry logo](https://www.dropbox.com/s/zp8o63kquby2rln/pry_logo_350.png?raw=1)
+© John Mair ([banisterfiend](https://twitter.com/banisterfiend)) 2018<br> (Creator)
+© Kyrylo Silin ([kyrylosilin](https://twitter.com/kyrylosilin)) 2018<br> (Maintainer)
+**Alumni:**
+* Conrad Irwin
+* Ryan Fitzgerald
+* Robert Gleeson
+**Links:**
+* https://pryrepl.org/
+* [YARD API documentation](https://www.rubydoc.info/gems/pry)
+* [Wiki](https://github.com/pry/pry/wiki)
+Table of Contents
+=================
+* [Introduction](#introduction)
+* [Key features](#key-features)
+* [Installation](#installation)
+* [Overview](#overview)
+   * [Commands](#commands)
+   * [Navigating around state](#navigating-around-state)
+   * [Runtime invocation](#runtime-invocation)
+   * [Command Shell Integration](#command-shell-integration)
+   * [Code Browsing](#code-browsing)
+   * [Documentation Browsing](#documentation-browsing)
+   * [Gist integration](#gist-integration)
+   * [Edit methods](#edit-methods)
+   * [Live Help System](#live-help-system)
+   * [Use Pry as your Rails Console](#use-pry-as-your-rails-console)
+   * [Syntax Highlighting](#syntax-highlighting)
+* [Supported Rubies](#supported-rubies)
+* [Contact](#contact)
+* [License](#license)
+* [Contributors](#contributors)
-[Skip to the website (recommended)](http://pryrepl.org/) <br />
-[Skip to the wiki](https://github.com/pry/pry/wiki)
+Introduction
+------------
+Pry is a runtime developer console and IRB alternative with powerful
+introspection capabilities. Pry aims to be more than an IRB replacement. It is
+an attempt to bring REPL driven programming to the Ruby language.
-Pry is a powerful alternative to the standard IRB shell for Ruby. It is
-written from scratch to provide a number of advanced features,
-including:
+Key features
+------------
 * Source code browsing (including core C source with the pry-doc gem)
 * Documentation browsing
@@ -26,103 +68,117 @@ including:
 * Navigation around state (`cd`, `ls` and friends)
 * Runtime invocation (use Pry as a developer console or debugger)
 * Exotic object support (BasicObject instances, IClasses, ...)
-* A Powerful and flexible command system
+* A powerful and flexible command system
 * Ability to view and replay history
-* Many convenience commands inspired by IPython, Smalltalk and other advanced REPLs
-* A wide-range number of [plugins](https://github.com/pry/pry/wiki/Available-plugins) that provide remote sessions, full debugging functionality, and more.
+* Many convenience commands inspired by IPython, Smalltalk and other advanced
+  REPLs
+* A wide-range number of
+  [plugins](https://github.com/pry/pry/wiki/Available-plugins) that provide
+  remote sessions, full debugging functionality, and more.
+Installation
+------------
+### Bundler
+```ruby
+gem 'pry', '~> 0.12.2'
+```
+### Manual
+```sh
+gem install pry
+```
-Pry also aims to be more than an IRB replacement; it is an
-attempt to bring REPL driven programming to the Ruby language. It is
-currently not as powerful as tools like [SLIME](https://en.wikipedia.org/wiki/SLIME) for lisp, but that is the
-general direction Pry is heading.
+Overview
+--------
-Pry is also fairly flexible and allows significant user
-[customization](https://github.com/pry/pry/wiki/Customization-and-configuration)
-is trivial to set it to read from any object that has a `readline` method and write to any object that has a
-`puts` method - many other aspects of Pry are also configurable making
-it a good choice for implementing custom shells.
+Pry is fairly flexible and allows significant user
+[customization](https://github.com/pry/pry/wiki/Customization-and-configuration).
+It is trivial to read from any object that has a `readline` method and
+write to any object that has a `puts` method. Many other aspects of Pry are
+also configurable, making it a good choice for implementing custom shells.
-Pry comes with an executable so it can be invoked at the command line.  Just
+Pry comes with an executable so it can be invoked at the command line. Just
 enter `pry` to start. A `pryrc` file in `$XDG_CONFIG_HOME/pry/` or the user's
 home directory will be loaded if it exists. Type `pry --help` at the command
 line for more information.
-Try `gem install pry-doc` for additional documentation on Ruby Core
-methods. The additional docs are accessed through the `show-doc` and
-`show-method` commands.
-* Install the [gem](https://rubygems.org/gems/pry): `gem install pry`
-* Browse the comprehensive [documentation at the official Pry wiki](https://github.com/pry/pry/wiki)
-* Read the [YARD API documentation](http://www.rubydoc.info/github/pry/pry/)
-* See the [source code](https://github.com/pry/pry)
 ### Commands
-Nearly every piece of functionality in a Pry session is implemented as
-a command. Commands are not methods and must start at the beginning of a line, with no
-whitespace in between. Commands support a flexible syntax and allow
-'options' in the same way as shell commands, for example the following
-Pry command will show a list of all private instance methods (in
-scope) that begin with 'pa'
+Nearly every piece of functionality in a Pry session is implemented as a
+command. Commands are not methods and must start at the beginning of a line,
+with no whitespace in between. Commands support a flexible syntax and allow
+'options' in the same way as shell commands, for example the following Pry
+command will show a list of all private instance methods (in scope) that begin
+with 'pa'
-    pry(YARD::Parser::SourceParser):5> ls -Mp --grep ^pa
-    YARD::Parser::SourceParser#methods: parse  parser_class  parser_type  parser_type=  parser_type_for_filename
+```ruby
+pry(YARD::Parser::SourceParser):5> ls -Mp --grep ^pa
+YARD::Parser::SourceParser#methods: parse  parser_class  parser_type  parser_type=  parser_type_for_filename
+```
 ### Navigating around state
-Pry allows us to pop in and out of different scopes (objects) using
-the `cd` command. This enables us to explore the run-time view of a
-program or library. To view which variables and methods are available
-within a particular scope we use the versatile [ls command.](https://gist.github.com/c0fc686ef923c8b87715)
-Here we will begin Pry at top-level, then Pry on a class and then on
-an instance variable inside that class:
-    pry(main)> class Hello
-    pry(main)*   @x = 20
-    pry(main)* end
-    => 20
-    pry(main)> cd Hello
-    pry(Hello):1> ls -i
-    instance variables: @x
-    pry(Hello):1> cd @x
-    pry(20):2> self + 10
-    => 30
-    pry(20):2> cd ..
-    pry(Hello):1> cd ..
-    pry(main)> cd ..
-The number after the `:` in the pry prompt indicates the nesting
-level. To display more information about nesting, use the `nesting`
-command. E.g
-    pry("friend"):3> nesting
-    Nesting status:
-    0. main (Pry top level)
-    1. Hello
-    2. 100
-    3. "friend"
-    => nil
-We can then jump back to any of the previous nesting levels by using
-the `jump-to` command:
-    pry("friend"):3> jump-to 1
-    => 100
-    pry(Hello):1>
+Pry allows us to pop in and out of different scopes (objects) using the `cd`
+command. This enables us to explore the run-time view of a program or
+library. To view which variables and methods are available within a particular
+scope we use the versatile [ls
+command.](https://gist.github.com/c0fc686ef923c8b87715)
+Here we will begin Pry at top-level, then Pry on a class and then on an instance
+variable inside that class:
+```ruby
+pry(main)> class Hello
+pry(main)*   @x = 20
+pry(main)* end
+=> 20
+pry(main)> cd Hello
+pry(Hello):1> ls -i
+instance variables: @x
+pry(Hello):1> cd @x
+pry(20):2> self + 10
+=> 30
+pry(20):2> cd ..
+pry(Hello):1> cd ..
+pry(main)> cd ..
+```
+The number after the `:` in the pry prompt indicates the nesting level. To
+display more information about nesting, use the `nesting` command. E.g
+```ruby
+pry("friend"):3> nesting
+Nesting status:
+0. main (Pry top level)
+1. Hello
+2. 100
+3. "friend"
+=> nil
+```
+We can then jump back to any of the previous nesting levels by using the
+`jump-to` command:
+```ruby
+pry("friend"):3> jump-to 1
+=> 100
+pry(Hello):1>
+```
 ### Runtime invocation
-Pry can be invoked in the middle of a running program. It opens a Pry
-session at the point it's called and makes all program state at that
-point available. It can be invoked on any object using the
-`my_object.pry` syntax or on the current binding (or any binding)
-using `binding.pry`. The Pry session will then begin within the scope
-of the object (or binding). When the session ends the program continues with any
-modifications you made to it.
+Pry can be invoked in the middle of a running program. It opens a Pry session at
+the point it's called and makes all program state at that point available. It
+can be invoked on any object using the `my_object.pry` syntax or on the current
+binding (or any binding) using `binding.pry`. The Pry session will then begin
+within the scope of the object (or binding). When the session ends the program
+continues with any modifications you made to it.
-This functionality can be used for such things as: debugging,
-implementing developer consoles and applying hot patches.
+This functionality can be used for such things as: debugging, implementing
+developer consoles and applying hot patches.
 code:
@@ -145,246 +201,252 @@ puts "program resumes here."
 Pry session:
-    pry(main)> a.hello
-    hello world!
-    => nil
-    pry(main)> def a.goodbye
-    pry(main)*   puts "goodbye cruel world!"
-    pry(main)* end
-    => nil
-    pry(main)> a.goodbye
-    goodbye cruel world!
-    => nil
-    pry(main)> exit
-    program resumes here.
+```ruby
+pry(main)> a.hello
+hello world!
+=> nil
+pry(main)> def a.goodbye
+pry(main)*   puts "goodbye cruel world!"
+pry(main)* end
+=> nil
+pry(main)> a.goodbye
+goodbye cruel world!
+=> nil
+pry(main)> exit
+program resumes here.
+```
 ### Command Shell Integration
-A line of input that begins with a '.' will be forwarded to the
-command shell. This enables us to navigate the file system, spawn
-editors, and run git and rake directly from within Pry.
+A line of input that begins with a '.' will be forwarded to the command
+shell. This enables us to navigate the file system, spawn editors, and run git
+and rake directly from within Pry.
-Further, we can use the `shell-mode` command to incorporate the
-present working directory into the Pry prompt and bring in (limited at this stage, sorry) file name completion.
-We can also interpolate Ruby code directly into the shell by
+Further, we can use the `shell-mode` command to incorporate the present working
+directory into the Pry prompt and bring in (limited at this stage, sorry) file
+name completion.  We can also interpolate Ruby code directly into the shell by
 using the normal `#{}` string interpolation syntax.
 In the code below we're going to switch to `shell-mode` and edit the `pryrc`
 file. We'll then cat its contents and reload the file.
-    pry(main)> shell-mode
-    pry main:/home/john/ruby/projects/pry $ .cd ~
-    pry main:/home/john $ .emacsclient .pryrc
-    pry main:/home/john $ .cat .pryrc
-    def hello_world
-      puts "hello world!"
-    end
-    pry main:/home/john $ load ".pryrc"
-    => true
-    pry main:/home/john $ hello_world
-    hello world!
-We can also interpolate Ruby code into the shell. In the
-example below we use the shell command `cat` on a random file from the
-current directory and count the number of lines in that file with
-`wc`:
-    pry main:/home/john $ .cat #{Dir['*.*'].sample} | wc -l
-    44
+```ruby
+pry(main)> shell-mode
+pry main:/home/john/ruby/projects/pry $ .cd ~
+pry main:/home/john $ .emacsclient .pryrc
+pry main:/home/john $ .cat .pryrc
+def hello_world
+  puts "hello world!"
+end
+pry main:/home/john $ load ".pryrc"
+=> true
+pry main:/home/john $ hello_world
+hello world!
+```
-### Code Browsing
+We can also interpolate Ruby code into the shell. In the example below we use
+the shell command `cat` on a random file from the current directory and count
+the number of lines in that file with `wc`:
-You can browse method source code with the `show-method` command. Nearly all Ruby methods (and some C methods, with the pry-doc
-gem) can have their source viewed. Code that is longer than a page is
-sent through a pager (such as less), and all code is properly syntax
-highlighted (even C code).
+```ruby
+pry main:/home/john $ .cat #{Dir['*.*'].sample} | wc -l
+44
+```
-The `show-method` command accepts two syntaxes, the typical ri
-`Class#method` syntax and also simply the name of a method that's in
-scope. You can optionally pass the `-l` option to show-method to
-include line numbers in the output.
+### Code Browsing
-In the following example we will enter the `Pry` class, list the
-instance methods beginning with 're' and display the source code for the `rep` method:
+You can browse method source code with the `show-source` command. Nearly all
+Ruby methods (and some C methods, with the pry-doc gem) can have their source
+viewed. Code that is longer than a page is sent through a pager (such as less),
+and all code is properly syntax highlighted (even C code).
-    pry(main)> cd Pry
-    pry(Pry):1> ls -M --grep re
-    Pry#methods: re  readline  refresh  rep  repl  repl_epilogue  repl_prologue  retrieve_line
-    pry(Pry):1> show-method rep -l
+The `show-source` command accepts two syntaxes, the typical ri `Class#method`
+syntax and also simply the name of a method that's in scope. You can optionally
+pass the `-l` option to `show-source` to include line numbers in the output.
-    From: /home/john/ruby/projects/pry/lib/pry/pry_instance.rb @ line 143:
-    Number of lines: 6
+In the following example we will enter the `Pry` class, list the instance
+methods beginning with 're' and display the source code for the `rep` method:
-    143: def rep(target=TOPLEVEL_BINDING)
-    144:   target = Pry.binding_for(target)
-    145:   result = re(target)
-    146:
-    147:   show_result(result) if should_print?
-    148: end
+```ruby
+pry(main)> cd Pry
+pry(Pry):1> ls -M --grep re
+Pry#methods: re  readline  refresh  rep  repl  repl_epilogue  repl_prologue  retrieve_line
+pry(Pry):1> show-source rep -l
+From: /home/john/ruby/projects/pry/lib/pry/pry_instance.rb:143
+Number of lines: 6
+143: def rep(target=TOPLEVEL_BINDING)
+144:   target = Pry.binding_for(target)
+145:   result = re(target)
+146:
+147:   show_result(result) if should_print?
+148: end
+```
 Note that we can also view C methods (from Ruby Core) using the
 `pry-doc` plugin; we also show off the alternate syntax for
-`show-method`:
+`show-source`:
-    pry(main)> show-method Array#select
-    From: array.c in Ruby Core (C Method):
-    Number of lines: 15
-    static VALUE
-    rb_ary_select(VALUE ary)
-    {
-        VALUE result;
-        long i;
-        RETURN_ENUMERATOR(ary, 0, 0);
-        result = rb_ary_new2(RARRAY_LEN(ary));
-        for (i = 0; i < RARRAY_LEN(ary); i++) {
-            if (RTEST(rb_yield(RARRAY_PTR(ary)[i]))) {
-                rb_ary_push(result, rb_ary_elt(ary, i));
-            }
+```ruby
+pry(main)> show-source Array#select
+From: array.c in Ruby Core (C Method):
+Number of lines: 15
+static VALUE
+rb_ary_select(VALUE ary)
+{
+    VALUE result;
+    long i;
+    RETURN_ENUMERATOR(ary, 0, 0);
+    result = rb_ary_new2(RARRAY_LEN(ary));
+    for (i = 0; i < RARRAY_LEN(ary); i++) {
+        if (RTEST(rb_yield(RARRAY_PTR(ary)[i]))) {
+            rb_ary_push(result, rb_ary_elt(ary, i));
         }
-        return result;
     }
+    return result;
+}
+```
 ### Documentation Browsing
-One use-case for Pry is to explore a program at run-time by `cd`-ing
-in and out of objects and viewing and invoking methods. In the course
-of exploring it may be useful to read the documentation for a
-specific method that you come across. Like `show-method` the `show-doc` command supports
-two syntaxes - the normal `ri` syntax as well as accepting the name of
-any method that is currently in scope.
-The Pry documentation system does not rely on pre-generated `rdoc` or
-`ri`, instead it grabs the comments directly above the method on
-demand. This results in speedier documentation retrieval and allows
-the Pry system to retrieve documentation for methods that would not be
-picked up by `rdoc`. Pry also has a basic understanding of both the
-rdoc and yard formats and will attempt to syntax highlight the
-documentation appropriately.
-Nonetheless, the `ri` functionality is very good and
-has an advantage over Pry's system in that it allows documentation
-lookup for classes as well as methods. Pry therefore has good
-integration with  `ri` through the `ri` command. The syntax
-for the command is exactly as it would be in command-line -
+One use-case for Pry is to explore a program at run-time by `cd`-ing in and out
+of objects and viewing and invoking methods. In the course of exploring it may
+be useful to read the documentation for a specific method that you come
+across. Like `show-source` the `show-doc` command supports two syntaxes - the
+normal `ri` syntax as well as accepting the name of any method that is currently
+in scope.
+The Pry documentation system does not rely on pre-generated `rdoc` or `ri`,
+instead it grabs the comments directly above the method on demand. This results
+in speedier documentation retrieval and allows the Pry system to retrieve
+documentation for methods that would not be picked up by `rdoc`. Pry also has a
+basic understanding of both the rdoc and yard formats and will attempt to syntax
+highlight the documentation appropriately.
+Nonetheless, the `ri` functionality is very good and has an advantage over Pry's
+system in that it allows documentation lookup for classes as well as
+methods. Pry therefore has good integration with `ri` through the `ri`
+command. The syntax for the command is exactly as it would be in command-line -
 so it is not necessary to quote strings.
-In our example we will enter the `Gem` class and view the
-documentation for the `try_activate` method:
+In our example we will enter the `Gem` class and view the documentation for the
+`try_activate` method:
-    pry(main)> cd Gem
-    pry(Gem):1> show-doc try_activate
+```ruby
+pry(main)> cd Gem
+pry(Gem):1> show-doc try_activate
-    From: /Users/john/.rvm/rubies/ruby-1.9.2-p180/lib/ruby/site_ruby/1.9.1/rubygems.rb @ line 201:
-    Number of lines: 3
+From: /Users/john/.rvm/rubies/ruby-1.9.2-p180/lib/ruby/site_ruby/1.9.1/rubygems.rb:201
+Number of lines: 3
-    Try to activate a gem containing path. Returns true if
-    activation succeeded or wasn't needed because it was already
-    activated. Returns false if it can't find the path in a gem.
-    pry(Gem):1>
+Try to activate a gem containing path. Returns true if
+activation succeeded or wasn't needed because it was already
+activated. Returns false if it can't find the path in a gem.
+pry(Gem):1>
+```
 We can also use `ri` in the normal way:
-    pry(main) ri Array#each
-    ----------------------------------------------------------- Array#each
-         array.each {|item| block }   ->   array
-    ------------------------------------------------------------------------
-         Calls _block_ once for each element in _self_, passing that element
-         as a parameter.
-            a = [ "a", "b", "c" ]
-            a.each {|x| print x, " -- " }
-         produces:
-            a -- b -- c --
-### Gist integration
+```ruby
+pry(main) ri Array#each
+----------------------------------------------------------- Array#each
+     array.each {|item| block }   ->   array
+------------------------------------------------------------------------
+     Calls _block_ once for each element in _self_, passing that element
+     as a parameter.
-If the `gist` gem is installed then method source or documentation can be gisted to GitHub with the
-`gist` command.  The `gist` command is capable of gisting [almost any REPL content](https://gist.github.com/cae143e4533416529726), including methods, documentation,
-input expressions, command source, and so on. In the example below we will gist the C source
-code for the `Symbol#to_proc` method to GitHub:
+        a = [ "a", "b", "c" ]
+        a.each {|x| print x, " -- " }
-    pry(main)> gist -m Symbol#to_proc
-    Gist created at https://gist.github.com/5332c38afc46d902ce46 and added to clipboard.
-    pry(main)>
+     produces:
-You can see the actual gist generated here: [https://gist.github.com/5332c38afc46d902ce46](https://gist.github.com/5332c38afc46d902ce46)
+        a -- b -- c --
+```
 ### Edit methods
-You can use `edit Class#method` or `edit my_method`
-(if the method is in scope) to open a method for editing directly in
-your favorite editor. Pry has knowledge of a few different editors and
-will attempt to open the file at the line the method is defined.
+You can use `edit Class#method` or `edit my_method` (if the method is in scope)
+to open a method for editing directly in your favorite editor. Pry has knowledge
+of a few different editors and will attempt to open the file at the line the
+method is defined.
 You can set the editor to use by assigning to the `Pry.editor`
-accessor. `Pry.editor` will default to `$EDITOR` or failing that will
-use `nano` as the backup default. The file that is edited will be
-automatically reloaded after exiting the editor - reloading can be
-suppressed by passing the `--no-reload` option to `edit`
+accessor. `Pry.editor` will default to `$EDITOR` or failing that will use `nano`
+as the backup default. The file that is edited will be automatically reloaded
+after exiting the editor - reloading can be suppressed by passing the
+`--no-reload` option to `edit`
-In the example below we will set our default editor to "emacsclient"
-and open the `Pry#repl` method for editing:
+In the example below we will set our default editor to "emacsclient" and open
+the `Pry#repl` method for editing:
-    pry(main)> Pry.editor = "emacsclient"
-    pry(main)> edit Pry#repl
+```ruby
+pry(main)> Pry.editor = "emacsclient"
+pry(main)> edit Pry#repl
+```
 ### Live Help System
-Many other commands are available in Pry; to see the full list type
-`help` at the prompt. A short description of each command is provided
-with basic instructions for use; some commands have a more extensive
-help that can be accessed via typing `command_name --help`. A command
-will typically say in its description if the `--help` option is
-available.
+Many other commands are available in Pry; to see the full list type `help` at
+the prompt. A short description of each command is provided with basic
+instructions for use; some commands have a more extensive help that can be
+accessed via typing `command_name --help`. A command will typically say in its
+description if the `--help` option is available.
 ### Use Pry as your Rails Console
-The recommended way to use Pry as your Rails console is to add
-[the `pry-rails` gem](https://github.com/rweng/pry-rails) to
-your Gemfile. This replaces the default console with Pry, in
-addition to loading the Rails console helpers and adding some
-useful Rails-specific commands.
+The recommended way to use Pry as your Rails console is to add [the `pry-rails`
+gem](https://github.com/rweng/pry-rails) to your Gemfile. This replaces the
+default console with Pry, in addition to loading the Rails console helpers and
+adding some useful Rails-specific commands.
-If you don't want to change your Gemfile, you can still run a Pry
-console in your app's environment using Pry's `-r` flag:
+If you don't want to change your Gemfile, you can still run a Pry console in
+your app's environment using Pry's `-r` flag:
-    pry -r ./config/environment
+```sh
+pry -r ./config/environment
+```
-Also check out the [wiki](https://github.com/pry/pry/wiki/Setting-up-Rails-or-Heroku-to-use-Pry)
+Also check out the
+[wiki](https://github.com/pry/pry/wiki/Setting-up-Rails-or-Heroku-to-use-Pry)
 for more information about integrating Pry with Rails.
-### Limitations:
+### Syntax Highlighting
-* Tab completion is currently a bit broken/limited this will have a
-  major overhaul in a future version.
+Syntax highlighting is on by default in Pry. If you want to change the colors,
+check out the [pry-theme](https://github.com/kyrylo/pry-theme) gem.
-### Syntax Highlighting
+You can toggle the syntax highlighting on and off in a session by using the
+`toggle-color` command. Alternatively, you can turn it off permanently by
+putting the line `Pry.color = false` in your `pryrc` file.
+Supported Rubies
+----------------
+* CRuby >= 1.9.3
+* JRuby >= 1.7
-Syntax highlighting is on by default in Pry. If you want to change
-the colors, check out the [pry-theme](https://github.com/kyrylo/pry-theme)
-gem.
+Contact
+-------
-You can toggle the syntax highlighting on and off in a session by
-using the `toggle-color` command. Alternatively, you can turn it off
-permanently by putting the line `Pry.color = false` in your `pryrc`
-file.
+In case you have a problem, question or a bug report, feel free to:
-### Future Directions
+* ask a question on IRC (#pry on Freenode)
+* [file an issue](https://github.com/pry/pry/issues)
+* [tweet at us](https://twitter.com/pryruby)
-Many new features are planned such as:
+License
+-------
-* Increase modularity (rely more on plugin system)
-* Much improved documentation system, better support for YARD
-* Better support for code and method reloading and saving code
-* Extended and more sophisticated command system, allowing piping
-between commands and running commands in background
+The project uses the MIT License. See LICENSE.md for details.
-### Contact
+Contributors
+------------
-Problems or questions? File an issue at [GitHub](https://github.com/pry/pry/issues).
+Pry is primarily the work of [John Mair (banisterfiend)](https://github.com/banister), for full list
+of contributors see the
+[contributors graph](https://github.com/pry/pry/graphs/contributors).