nubs/sensible

A library for finding sensible user programs, like editor, pager, and browser.

v0.5.0 2016-05-23 19:26 UTC

Requires

• php: ~5.6 || ~7.0
• nubs/which: ~1.0

Requires (Dev)

• phpunit/phpunit: ~5.0
• satooshi/php-coveralls: ~1.0
• squizlabs/php_codesniffer: ~2.3

Suggests

• brianium/habitat: For better access to environment variables (e.g., for mocking).
• nubs/which: For locating commands in PATH rather than using absolute paths.
• symfony/process: For executing the commands rather than just locating them.

MIT

• Spencer Rinehart

• browser
• user
• pager
• editor
• environment
• sensible

README

A PHP library for finding sensible user programs, like editor, pager, and browser.

Requirements

This library requires PHP 5.6, or newer.

Installation

This package uses composer so you can just add nubs/sensible as a dependency to your composer.json file or execute the following command:

composer require nubs/sensible

Supported Program Types

This library supports opening a text editor (like vim), a pager (like more), and a browser (like firefox).

Program Factories

The recommended way to initialize one of the supported program loaders is to use the included factories.

Browser Factory

The browser factory uses a command locator (via which) to determine which browsers are available. The default list of browsers is

• sensible-browser
• firefox
• chromium-browser
• chrome
• elinks

A simple example for creating a browser object:

$commandLocatorFactory = new Nubs\Which\LocatorFactory\PlatformLocatorFactory();
$browserFactory = new Nubs\Sensible\CommandFactory\BrowserFactory(
    $commandLocatorFactory->create()
);
$browser = $browserFactory->create();

If you want to override the default list of browsers:

$commandLocatorFactory = new Nubs\Which\LocatorFactory\PlatformLocatorFactory();
$browserFactory = new Nubs\Sensible\CommandFactory\BrowserFactory(
    $commandLocatorFactory->create(),
    ['my-favorite-browser', 'some-fallback-browser']
);
$browser = $browserFactory->create();

Editor Factory

The editor factory uses your EDITOR environment variable if set, otherwise it uses a command locator (via which) to determine which editors are available. The default list of editors is

• sensible-editor
• nano
• vim
• ed

A simple example for creating a editor object:

$commandLocatorFactory = new Nubs\Which\LocatorFactory\PlatformLocatorFactory();
$editorFactory = new Nubs\Sensible\CommandFactory\EditorFactory(
    $commandLocatorFactory->create()
);
$editor = $editorFactory->create();

If you want to override the default list of editors:

$commandLocatorFactory = new Nubs\Which\LocatorFactory\PlatformLocatorFactory();
$editorFactory = new Nubs\Sensible\CommandFactory\EditorFactory(
    $commandLocatorFactory->create(),
    ['my-favorite-editor', 'some-fallback-editor']
);
$editor = $editorFactory->create();

Pager Factory

The pager factory uses your PAGER environment variable if set, otherwise it uses a command locator (via which) to determine which pagers are available. The default list of pagers is

• sensible-pager
• less
• more

A simple example for creating a pager object:

$commandLocatorFactory = new Nubs\Which\LocatorFactory\PlatformLocatorFactory();
$pagerFactory = new Nubs\Sensible\CommandFactory\PagerFactory(
    $commandLocatorFactory->create()
);
$pager = $pagerFactory->create();

If you want to override the default list of pagers:

$commandLocatorFactory = new Nubs\Which\LocatorFactory\PlatformLocatorFactory();
$pagerFactory = new Nubs\Sensible\CommandFactory\PagerFactory(
    $commandLocatorFactory->create(),
    ['my-favorite-pager', 'some-fallback-pager']
);
$pager = $pagerFactory->create();

Using the programs

Once you've created the program type with its strategy for locating the sensible command for the user, you can use it to work with files/data/etc.

Browser

A browser can be executed to load a supported URI. For example:

$browser->viewURI(
    new Symfony\Component\Process\ProcessBuilder(), 
    'http://www.google.com'
);

Editor

The editor can be used to edit files. For example:

$process = $editor->editFile(
    new Symfony\Component\Process\ProcessBuilder(), 
    '/path/to/a/file'
);
if ($process->isSuccessful()) {
    // continue
}

There is also a convenient shorthand for editing a string in an editor by means of a temporary file. For example:

$updatedMessage = $editor->editData(
    new Symfony\Component\Process\ProcessBuilder(), 
    'a message'
);

This will return the input unaltered if the process does not exit successfully.

Pager

The pager passes the file or string to the configured pager for convenient viewing. For example, for a file source:

$process = $pager->viewFile(
    new Symfony\Component\Process\ProcessBuilder(), 
    '/path/to/a/file'
);

Or for a string source:

$process = $pager->viewData(
    new Symfony\Component\Process\ProcessBuilder(), 
    'a message'
);

CLI Interface

There is also a CLI interface for Linux systems that imitates Ubuntu's sensible-* commands. It is available as nubs/sensible-cli.

License

sensible is licensed under the MIT license. See LICENSE for the full license text.