brice - Extra cool IRb goodness for the masses ↑

VERSION ↑

This documentation refers to brice version 0.4.2

DESCRIPTION ↑

Enhances your IRb experience by adding new functionality and by providing a framework that you can utilize to add your own extensions. It comes with a set of pre-selected features (see the files in lib/brice/rc), but is highly configurable in that regard.

Add this to your ~/.irbrc and receive the default goodness:

require 'brice/init'  # equivalent to: require 'brice'; Brice.init

Or get some more control over the configuration:

require 'brice'

Brice.init { |config|
  ...
}

See Brice::Config for what you can configure, and how.

It will even load your own extensions that you place in your ~/.brice directory. See Brice::DSL for helpers provided.

Please note that further changes to the configuration for brice can't be guaranteed to have any effect after Brice.init has been called.

DEFAULT FEATURES ↑

added_methods

Loads AddedMethods if one (or both) of the following environment variables has been set:

WATCH_FOR_ADDED_METHODS

Regular expression or true

WATCH_FOR_ADDED_METHODS_IN

Space- or comma-delimited list of class names

libs

Loads libraries, either a set of default ones or those you configure with config.libs = %w[...].

history

Configures IRb history support. See Brice::History for more information.

colours

Configures IRb colour support. See Brice::Colours for more information.

shortcuts

Includes convenient shortcut methods. See Brice::Shortcuts and Brice::Shortcuts::ObjectShortcuts for more information.

init

Does some basic initialization for IRb.

prompt

Configures the IRb prompt, providing :BRICE_SIMPLE and :BRICE_VERBOSE prompt modes.

rails

Provides some Rails settings, such as adding the :BRICE_RAILS prompt mode, setting the Rails logger to STDOUT, and defining convenience accessors for your models.

devel

Provides some useful settings when developing Ruby libraries.

Documentation

blackwinter.github.com/brice

Source code

github.com/blackwinter/brice

RubyGem

rubygems.org/gems/brice

Travis CI

travis-ci.org/blackwinter/brice

AUTHORS ↑

LICENSE AND COPYRIGHT ↑

Copyright (C) 2008-2020 Jens Wille

brice is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

brice is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with brice. If not, see <www.gnu.org/licenses/>.