Skip to content

Commit

Permalink
Base completion files from @AD7six/cakephp-completion adjusted to be …
Browse files Browse the repository at this point in the history
…part of the framework
  • Loading branch information
WyriHaximus committed Oct 2, 2013
1 parent 5e9b222 commit cdf2b8c
Show file tree
Hide file tree
Showing 2 changed files with 276 additions and 0 deletions.
50 changes: 50 additions & 0 deletions app/Vendor/cake.bash
@@ -0,0 +1,50 @@
# bash completion for CakePHP console

_cake()
{
local cur prev opts cake
COMPREPLY=()
cake="${COMP_WORDS[0]}"
cur="${COMP_WORDS[COMP_CWORD]}"
prev="${COMP_WORDS[COMP_CWORD-1]}"

if [[ "$cur" == -* ]] ; then
if [[ ${COMP_CWORD} = 1 ]] ; then
opts=$(${cake} Completion options)
elif [[ ${COMP_CWORD} = 2 ]] ; then
opts=$(${cake} Completion options "${COMP_WORDS[1]}")
else
opts=$(${cake} Completion options "${COMP_WORDS[1]}" "${COMP_WORDS[2]}")
fi

COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
return 0
fi

if [[ ${COMP_CWORD} = 1 ]] ; then
opts=$(${cake} Completion commands)
COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
return 0
fi

if [[ ${COMP_CWORD} = 2 ]] ; then
opts=$(${cake} Completion subcommands $prev)
COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
if [[ $COMPREPLY = "" ]] ; then
COMPREPLY=( $(compgen -df -- ${cur}) )
return 0
fi
return 0
fi


opts=$(${cake} Completion fuzzy "${COMP_WORDS[@]:1}")
COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
if [[ $COMPREPLY = "" ]] ; then
COMPREPLY=( $(compgen -df -- ${cur}) )
return 0
fi
return 0;
}

complete -F _cake cake Console/cake
226 changes: 226 additions & 0 deletions lib/Cake/Console/Command/CompletionShell.php
@@ -0,0 +1,226 @@
<?php
App::uses('CommandListShell', 'Console/Command');

/**
* CompletionShell
*/
class CompletionShell extends CommandListShell {

/**
* Echo no header
*
*/
public function startup() {
}

/**
* Not called by the autocomplet shell - this is for curious users
*/
public function main() {
$this->out($this->OptionParser->help());
}

/**
* list commands
*/
public function commands() {
$options = $this->_commands();
return $this->_output($options);
}

/**
* list options for the named command
*/
public function options() {
if (!$this->args) {
$parser = new ConsoleOptionParser();
} else {
$Shell = $this->_getShell($this->args[0]);
if (!$Shell) {
$parser = new ConsoleOptionParser();
} else {
$parser = $Shell->getOptionParser();
}
}

$options = array();
$array = $parser->options();
foreach ($array as $name => $obj) {
$options[] = "--$name";
$short = $obj->short();
if ($short) {
$options[] = "-$short";
}
}
return $this->_output($options);
}

/**
* list subcommands for the named command
*/
public function subCommands() {
if (!$this->args) {
return $this->_output();
}

$options = $this->_subCommands($this->args[0]);
return $this->_output($options);
}

/**
* Guess autocomplete from the whole argument string
*/
public function fuzzy() {
return $this->_output();
}

/**
* getOptionParser for _this_ shell
*/
public function getOptionParser() {
$translationDomain = 'bash_completion';

$parser = AppShell::getOptionParser();

$parser->description(__d($translationDomain, 'Used by bash to autocomplete command name, options and arguments'))
->addSubcommand('commands', array(
'help' => __d($translationDomain, 'Output a list of available commands'),
'parser' => array(
'description' => __d($translationDomain, 'List all availables'),
'arguments' => array(
)
)
))->addSubcommand('subcommands', array(
'help' => __d($translationDomain, 'Output a list of available subcommands'),
'parser' => array(
'description' => __d($translationDomain, 'List subcommands for a command'),
'arguments' => array(
'command' => array(
'help' => __d($translationDomain, 'The command name'),
'required' => true,
)
)
)
))->addSubcommand('options', array(
'help' => __d($translationDomain, 'Output a list of available options'),
'parser' => array(
'description' => __d($translationDomain, 'List options'),
'arguments' => array(
'command' => array(
'help' => __d($translationDomain, 'The command name'),
'required' => false,
)
)
)
))->epilog(
array(
'This command is not intended to be called manually',
)
);
return $parser;
}

/**
* Return a list of all commands
*
* @return array
*/
protected function _commands() {
$shellList = $this->_getShellList();
unset($shellList['Completion']);

$options = array();
foreach ($shellList as $type => $commands) {
$prefix = '';
if (!in_array($type, array('app', 'core', 'APP', 'CORE'))) {
$prefix = $type . '.';
}

foreach ($commands as $shell) {
$options[] = $prefix . $shell;
}
}

return $options;
}

/**
* Return a list of subcommands for a given command
*
* @param string $commandName
* @return array
*/
protected function _subCommands($commandName) {
$Shell = $this->_getShell($commandName);

if (!$Shell) {
return array();
}

$return = array();
$taskMap = TaskCollection::normalizeObjectArray((array)$Shell->tasks);
foreach ($taskMap as $task => $properties) {
$return[] = $task;
}

$return = array_map('Inflector::underscore', $return);

$ShellReflection = new ReflectionClass('AppShell');
$shellMethods = $ShellReflection->getMethods(ReflectionMethod::IS_PUBLIC);
$shellMethodNames = array('main', 'help');
foreach ($shellMethods as $method) {
$shellMethodNames[] = $method->getName();
}

$Reflection = new ReflectionClass($Shell);
$methods = $Reflection->getMethods(ReflectionMethod::IS_PUBLIC);
$methodNames = array();
foreach ($methods as $method) {
$methodNames[] = $method->getName();
}

$return += array_diff($methodNames, $shellMethodNames);
sort($return);

return $return;
}

/**
* _getShell
*
* @param mixed $commandName
*/
protected function _getShell($commandName) {
list($plugin, $name) = pluginSplit($commandName, true);

if (!in_array($commandName, $this->_commands())) {
return false;
}
if ($plugin === 'CORE.' || $plugin === 'APP.') {
$plugin = '';
}

$name = Inflector::camelize($name);
$plugin = Inflector::camelize($plugin);
$class = $name . 'Shell';
APP::uses($class, $plugin . 'Console/Command');

$Shell = new $class();
$Shell->plugin = trim($plugin, '.');
$Shell->initialize();
$Shell->loadTasks();

return $Shell;
}

/**
* Emit results as a string, space delimited
*
* @param array $options
*/
protected function _output($options = array()) {
if ($options) {
$this->out(implode($options, ' '));
}
}
}

0 comments on commit cdf2b8c

Please sign in to comment.