inf-ruby

KO | EN

gitlite — search

#typescript #llm #golang #android #deep-learning #linux #docker #java #windows #kubernetes #awesome-list #pytorch #ios #open-source

(★ 223)

No description available.

File Explorer

Download Latest Version (.zip)

- FUNDING.yml
inf-ruby.el
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

`inf-ruby` provides a REPL buffer connected to a Ruby subprocess.

## Installation

### Via package.el

`package.el` is the built-in package manager in Emacs 24+. On Emacs 23
you will need to get [package.el](http://bit.ly/pkg-el23) yourself if you wish to use it.

`inf-ruby` is available on both major `package.el` community
maintained repos:
[Marmalade](http://marmalade-repo.org/packages/inf-ruby) and
[MELPA](https://melpa.org/#/inf-ruby).

If you're not already using one of them, follow their installation instructions:
[Marmalade](http://marmalade-repo.org/),
[MELPA](https://melpa.org/#/getting-started).

And then you can install `inf-ruby` with the following command:

<kbd>M-x package-install [RET] inf-ruby [RET]</kbd>

or by adding this bit of Emacs Lisp code to your Emacs initialization file (`.emacs` or `init.el`):

```lisp
(unless (package-installed-p 'inf-ruby)
  (package-install 'inf-ruby))
```

If the installation doesn't work try refreshing the package list:

<kbd>M-x package-refresh-contents [RET]</kbd>

### Via el-get

[el-get](https://github.com/dimitri/el-get) is another popular package manager for Emacs.
If you're an el-get user just do <kbd>M-x el-get-install</kbd>.

### Manual

If you're installing manually, you'll need to:

* drop the `inf-ruby.el` file somewhere on your load path (perhaps `~/.emacs.d/vendor`)
* Add the following lines to your `.emacs` (or `init.el`) file:

```lisp
(autoload 'inf-ruby-minor-mode "inf-ruby" "Run an inferior Ruby process" t)
(add-hook 'ruby-mode-hook 'inf-ruby-minor-mode)
```

Or, for [enh-ruby-mode](https://github.com/zenspider/enhanced-ruby-mode):

```lisp
(add-hook 'enh-ruby-mode-hook 'inf-ruby-minor-mode)
```

Installation via `package.el` interface does the above for you
automatically.

Additionally, consider adding

```lisp
(add-hook 'compilation-filter-hook 'inf-ruby-auto-enter)
```

```lisp
(add-hook 'compilation-filter-hook 'inf-ruby-auto-enter-and-focus)
```

to your init file to automatically switch from common Ruby compilation
modes to interact with a debugger. The latter snippet will also select
the compilation window and move point to the breakpoint prompt.

### Custom Prompts

If you wish to add other interpreter prompt patterns, see the description in
the [wiki](https://github.com/nonsequitur/inf-ruby/wiki/Adding-new-prompt-patterns).

### Emacs Prelude

`inf-ruby` comes bundled in
[Emacs Prelude](https://github.com/bbatsov/prelude). If you're a
Prelude user you can start using it right away.

## Usage

### IRB
A simple IRB process can be fired up with <kbd>M-x inf-ruby</kbd>.

### Project
To launch a REPL with project-specific console instead, type <kbd>M-x inf-ruby-console-auto</kbd>.
It recognizes several project types, including Rails, gems and anything with `racksh` in their Gemfile.

### With Docker

To run the project specific console in a Docker (or Podman or other) container, or in another shell
or host, set `inf-mode-wrapper-command` which will be passed to `format` to produce the command for launching
the console, so it must include `%s`. For instance, one can add the following to a `.dir-locals.el`
file at the root of a project:

```lisp
((ruby-mode . ((inf-ruby-wrapper-command . "docker exec -i container_name %s"))))
```

### Hooks
When entered, this mode runs `comint-mode-hook` and
`inf-ruby-mode-hook` (in that order).

### Commands

* `ruby-switch-to-inf` switches the current buffer to the ruby process buffer.
* `ruby-send-definition` sends the current definition to the ruby process.
* `ruby-send-region` sends the current region to the ruby process.
* `ruby-send-definition-and-go` and `ruby-send-region-and-go` switch to the ruby process buffer after sending their text.

### Keybindings

* <kbd>RET</kbd> after the end of the process' output sends the text from the
end of process to point.
* <kbd>RET</kbd> before the end of the process' output copies the sexp ending at point
to the end of the process' output, and sends it.
* <kbd>DEL</kbd> converts tabs to spaces as it moves back.
* <kbd>TAB</kbd> completes the input at point. IRB, Pry and Bond completion is supported.
* <kbd>C-M-q</kbd> does <kbd>TAB</kbd> on each line starting within following expression.
* Paragraphs are separated only by blank lines.  `#` start comments.
* If you accidentally suspend your process, use
`comint-continue-subjob` to continue it.

### Keymap

To see the list of the keybindings defined by `inf-ruby-minor-mode`,
type <kbd>M-x describe-function [RET] inf-ruby-minor-mode [RET]</kbd>.

## Bugs

* To use Pry in `inf-ruby` with Ruby 3.3, you should install
`readline-ext` (and add it to `Gemfile`, if it is used)
([dgutov/robe#147](https://github.com/dgutov/robe/issues/147#issuecomment-1894806030)).

* If there is a [triangle instead of prompt](https://github.com/nonsequitur/inf-ruby/issues/159), or you see a [reline related error](https://github.com/ruby/irb/issues/43#issuecomment-589593889), or your REPL simply [doesn't react to input](https://github.com/nonsequitur/inf-ruby/issues/51), try putting the following in your `~/.irbrc`:

```rb
IRB.conf[:USE_MULTILINE] = false if ENV['INSIDE_EMACS']
IRB.conf[:USE_READLINE] = false if ENV['INSIDE_EMACS']
```

For most projects that `inf-ruby-console-auto` can recognize, we try
to apply this flag automatically (using command line arguments rather
than `.irbrc`), but some cases remain where the users will have to do
it manually.

* IRB doesn't show the prompt after you send some input until you
  press RET again? And `C-x C-e` freezes in Ruby buffers?

IRB 1.2.x broke the `--noreadline` support
([#137](https://github.com/nonsequitur/inf-ruby/issues/137),
[IRB#127](https://github.com/ruby/irb/issues/127)). Upgrade to IRB
1.3.0 or newer for better experience.

* Pry raises ZeroDivisionError in `lib/pry/pager.rb`?

Put `Pry.config.pager = false if ENV["INSIDE_EMACS"]` into your `~/.pryrc`.

* Pry prints `[0G` right after start?

Put `Pry.config.correct_indent = false if ENV["INSIDE_EMACS"]` into your `~/.pryrc`.

Please report problems at <http://github.com/nonsequitur/inf-ruby/issues>.

inf-ruby

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

inf-ruby

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README