A plugin for the Pry REPL that enables audit logging
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
.gitignore
.rubocop.yml
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
pry-auditlog.gemspec

README.md

PryAuditlog

Build Status Gem Version

PryAuditlog is a plugin for the Pry REPL that enables logging of any combination of Pry input and output to a configured audit log file.

It modifies the read method of the REPL class to read input statements to Pry, and it inserts itself into the output mechanism to scrape a copy of all emitted data. It also redirects $stdout and $stderr during the Pry session in order to capture all output emitted from any puts or similar statements.

All output data is forwarded to the original configured Pry.config.output mechanism after logging, and this plugin should (hopefully) respect any configured outputter.

The log file location is configurable, and the choice of logging input statements, output statements or both (the default) is configurable.

Installation

$ gem install pry-auditlog

Usage

Set appropriate config values and then require the plugin in your .pryrc or any other location where you configure Pry.

# The auditlog must be explicitly enabled
Pry.config.auditlog_enabled = true           # default: false

# Path to audit log destination and optional file mode
Pry.config.auditlog_file = '/path/to/file'   # default: '/dev/null'
Pry.config.auditlog_file_mode = 0644         # default: 0600

# We log both input and output by default
Pry.config.auditlog_log_input = false        # default: true
Pry.config.auditlog_log_output = false       # default: true

# Set all config values *before* requiring the plugin
require 'pry-auditlog'

Copyright

Copyright (c) 2014-2015 Matt Greensmith and Cozy Services Ltd. See LICENSE.txt for further details.