Skip to content

Commit f862f5b

Browse files
aik099aik099
committed
Auto-complete fork names for "sync" and "bc" commands
1 parent 5d2ea6e commit f862f5b

9 files changed

+191
-28
lines changed

‎CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
44

55
## [Unreleased]
66
### Added
7-
...
7+
- The fork names are auto-completed for `sync` (`--project-fork` option) and `bc` (`--source-project-fork` and `--target-project-fork` options) commands.
88

99
### Changed
1010
...

‎src/CodeInsight/Command/AbstractCommand.php

+20-4
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212

1313

1414
use ConsoleHelpers\ConsoleKit\Command\AbstractCommand as BaseCommand;
15+
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
16+
use Symfony\Component\Console\Input\ArgvInput;
17+
use Symfony\Component\Console\Input\InputInterface;
1518

1619
/**
1720
* Base command class.
@@ -29,18 +32,31 @@ protected function prepareDependencies()
2932
$container = $this->getContainer();
3033
}
3134

35+
/**
36+
* Returns input from completion context.
37+
*
38+
* @param CompletionContext $context Completion context.
39+
*
40+
* @return InputInterface
41+
*/
42+
protected function getInputFromCompletionContext(CompletionContext $context)
43+
{
44+
$words = $context->getWords();
45+
array_splice($words, 1, 1); // Remove the command name.
46+
47+
return new ArgvInput($words, $this->getDefinition());
48+
}
49+
3250
/**
3351
* Returns and validates path.
3452
*
35-
* @param string $argument_name Argument name, that contains path.
53+
* @param string $raw_path Raw path.
3654
*
3755
* @return string
3856
* @throws \InvalidArgumentException When path isn't valid.
3957
*/
40-
protected function getPath($argument_name)
58+
protected function getPath($raw_path)
4159
{
42-
$raw_path = $this->io->getArgument($argument_name);
43-
4460
if ( !$raw_path ) {
4561
return '';
4662
}

‎src/CodeInsight/Command/BackwardsCompatibilityCommand.php

+54-18
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
use ConsoleHelpers\CodeInsight\KnowledgeBase\KnowledgeBaseFactory;
2020
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
2121
use Symfony\Component\Console\Exception\RuntimeException;
22+
use Symfony\Component\Console\Input\ArgvInput;
2223
use Symfony\Component\Console\Input\InputArgument;
2324
use Symfony\Component\Console\Input\InputInterface;
2425
use Symfony\Component\Console\Input\InputOption;
@@ -124,6 +125,18 @@ public function completeOptionValues($optionName, CompletionContext $context)
124125
{
125126
$ret = parent::completeOptionValues($optionName, $context);
126127

128+
if ( $optionName === 'source-project-fork' ) {
129+
$input = $this->getInputFromCompletionContext($context);
130+
131+
return $this->_knowledgeBaseFactory->getForks($this->getSourcePath($input, true));
132+
}
133+
134+
if ( $optionName === 'target-project-fork' ) {
135+
$input = $this->getInputFromCompletionContext($context);
136+
137+
return $this->_knowledgeBaseFactory->getForks($this->getTargetPath($input));
138+
}
139+
127140
if ( $optionName === 'format' ) {
128141
return $this->_reporterFactory->getNames();
129142
}
@@ -133,33 +146,18 @@ public function completeOptionValues($optionName, CompletionContext $context)
133146

134147
/**
135148
* {@inheritdoc}
136-
*
137-
* @throws RuntimeException When source project path is missing.
138149
*/
139150
protected function execute(InputInterface $input, OutputInterface $output)
140151
{
141152
// Get reporter upfront so that we can error out early for invalid reporters.
142153
$reporter = $this->_reporterFactory->get($this->io->getOption('format'));
143154

144-
$source_path = $this->getPath('source-project-path');
145-
$target_path = $this->getPath('target-project-path');
146-
147-
$source_fork = $this->io->getOption('source-project-fork');
148-
149-
if ( !$source_path ) {
150-
if ( $source_fork ) {
151-
// Single code base, but comparing with fork.
152-
$source_path = $target_path;
153-
}
154-
else {
155-
// Not using fork, then need to specify project path.
156-
throw new RuntimeException('Not enough arguments (missing: "source-project-path").');
157-
}
158-
}
155+
$source_path = $this->getSourcePath($input, false);
156+
$target_path = $this->getTargetPath($input);
159157

160158
$source_knowledge_base = $this->_knowledgeBaseFactory->getKnowledgeBase(
161159
$source_path,
162-
$source_fork,
160+
$this->io->getOption('source-project-fork'),
163161
$this->io
164162
);
165163
$target_knowledge_base = $this->_knowledgeBaseFactory->getKnowledgeBase(
@@ -181,6 +179,44 @@ protected function execute(InputInterface $input, OutputInterface $output)
181179
$this->io->writeln($reporter->generate($bc_breaks));
182180
}
183181

182+
/**
183+
* Returns source path.
184+
*
185+
* @param InputInterface $input Input.
186+
* @param boolean $autocomplete Autocomplete.
187+
*
188+
* @return string
189+
* @throws RuntimeException When source project path is missing.
190+
*/
191+
protected function getSourcePath(InputInterface $input, $autocomplete)
192+
{
193+
$source_path = $this->getPath($input->getArgument('source-project-path'));
194+
195+
if ( $source_path ) {
196+
return $source_path;
197+
}
198+
199+
// Single code base, but comparing with fork OR autocompleting forks.
200+
if ( $autocomplete || $input->getOption('source-project-fork') ) {
201+
return $this->getTargetPath($input);
202+
}
203+
204+
// Not using fork, then need to specify project path.
205+
throw new RuntimeException('Not enough arguments (missing: "source-project-path").');
206+
}
207+
208+
/**
209+
* Returns target path.
210+
*
211+
* @param InputInterface $input Input.
212+
*
213+
* @return string
214+
*/
215+
protected function getTargetPath(InputInterface $input)
216+
{
217+
return $this->getPath($input->getArgument('target-project-path'));
218+
}
219+
184220
/**
185221
* Finds backward compatibility breaks.
186222
*

‎src/CodeInsight/Command/MissingTestsCommand.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ protected function configure()
4646
*/
4747
protected function execute(InputInterface $input, OutputInterface $output)
4848
{
49-
$src_path = $this->getPath('src-path');
50-
$tests_path = $this->getPath('tests-path');
49+
$src_path = $this->getPath($this->io->getArgument('src-path'));
50+
$tests_path = $this->getPath($this->io->getArgument('tests-path'));
5151

5252
$finder = new Finder();
5353
$finder->files()->name('*.php')->notName('/^(I[A-Z]|Abstract[A-Z])/')->in($src_path);

‎src/CodeInsight/Command/ReportCommand.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ protected function prepareDependencies()
6969
protected function execute(InputInterface $input, OutputInterface $output)
7070
{
7171
$knowledge_base = $this->_knowledgeBaseFactory->getKnowledgeBase(
72-
$this->getPath('project-path'),
72+
$this->getPath($this->io->getArgument('project-path')),
7373
$this->io->getOption('project-fork'),
7474
$this->io
7575
);

‎src/CodeInsight/Command/SyncCommand.php

+25-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313

1414
use ConsoleHelpers\CodeInsight\KnowledgeBase\KnowledgeBaseFactory;
15+
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
1516
use Symfony\Component\Console\Input\InputArgument;
1617
use Symfony\Component\Console\Input\InputInterface;
1718
use Symfony\Component\Console\Input\InputOption;
@@ -63,13 +64,36 @@ protected function prepareDependencies()
6364
$this->_knowledgeBaseFactory = $container['knowledge_base_factory'];
6465
}
6566

67+
/**
68+
* Return possible values for the named option
69+
*
70+
* @param string $optionName Option name.
71+
* @param CompletionContext $context Completion context.
72+
*
73+
* @return array
74+
*/
75+
public function completeOptionValues($optionName, CompletionContext $context)
76+
{
77+
$ret = parent::completeOptionValues($optionName, $context);
78+
79+
if ( $optionName === 'project-fork' ) {
80+
$input = $this->getInputFromCompletionContext($context);
81+
82+
return $this->_knowledgeBaseFactory->getForks(
83+
$this->getPath($input->getArgument('project-path'))
84+
);
85+
}
86+
87+
return $ret;
88+
}
89+
6690
/**
6791
* {@inheritdoc}
6892
*/
6993
protected function execute(InputInterface $input, OutputInterface $output)
7094
{
7195
$knowledge_base = $this->_knowledgeBaseFactory->getKnowledgeBase(
72-
$this->getPath('project-path'),
96+
$this->getPath($this->io->getArgument('project-path')),
7397
$this->io->getOption('project-fork'),
7498
$this->io
7599
);

‎src/CodeInsight/KnowledgeBase/DatabaseManager.php

+35-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public function __construct(MigrationManager $migration_manager, $working_direct
6060
*/
6161
public function getDatabase($project_path, $fork = null)
6262
{
63-
if ( substr($project_path, 0, 1) !== '/' ) {
63+
if ( strpos($project_path, '/') !== 0 ) {
6464
throw new \InvalidArgumentException('The "$project_path" argument must contain absolute path.');
6565
}
6666

@@ -85,6 +85,40 @@ public function getDatabase($project_path, $fork = null)
8585
return new ExtendedPdo('sqlite:' . $fork_db_file);
8686
}
8787

88+
/**
89+
* Returns forks for given project.
90+
*
91+
* @param string $project_path Project path.
92+
*
93+
* @return string[]
94+
* @throws \InvalidArgumentException When relative project path is given.
95+
*/
96+
public function getForks($project_path)
97+
{
98+
if ( strpos($project_path, '/') !== 0 ) {
99+
throw new \InvalidArgumentException('The "$project_path" argument must contain absolute path.');
100+
}
101+
102+
$project_path = $this->_databaseDirectory . $project_path;
103+
104+
if ( !file_exists($project_path) ) {
105+
return array();
106+
}
107+
108+
$ret = array();
109+
$absolute_forks = glob($project_path . '/code_insight-*.sqlite');
110+
111+
foreach ( $absolute_forks as $absolute_fork ) {
112+
$ret[] = preg_replace(
113+
'/^' . preg_quote($project_path . '/code_insight-', '/') . '(.+).sqlite/',
114+
'$1',
115+
$absolute_fork
116+
);
117+
}
118+
119+
return $ret;
120+
}
121+
88122
/**
89123
* Runs outstanding migrations on the database.
90124
*

‎src/CodeInsight/KnowledgeBase/KnowledgeBaseFactory.php

+12
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,16 @@ public function getKnowledgeBase($project_path, $fork = null, ConsoleIO $io = nu
5858
return $knowledge_base;
5959
}
6060

61+
/**
62+
* Returns forks for given project.
63+
*
64+
* @param string $project_path Project path.
65+
*
66+
* @return string[]
67+
*/
68+
public function getForks($project_path)
69+
{
70+
return $this->_databaseManager->getForks($project_path);
71+
}
72+
6173
}

‎tests/CodeInsight/KnowledgeBase/DatabaseManagerTest.php

+41
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,47 @@ public function testCreatingForkedDatabaseFromOriginal()
113113
);
114114
}
115115

116+
public function testRelativeProjectPathForksError()
117+
{
118+
$this->expectException(\InvalidArgumentException::class);
119+
$this->expectExceptionMessage('The "$project_path" argument must contain absolute path.');
120+
121+
$this->getDatabaseManager()->getForks('relative/path');
122+
}
123+
124+
/**
125+
* @depends testCreatingDatabase
126+
*/
127+
public function testNoForksWithProjectDatabase()
128+
{
129+
$database_manager = $this->getDatabaseManager();
130+
$database_manager->getDatabase('/absolute/path');
131+
132+
$this->assertEmpty($database_manager->getForks('/absolute/path'));
133+
}
134+
135+
public function testNoForksWithoutProjectDatabase()
136+
{
137+
$database_manager = $this->getDatabaseManager();
138+
139+
$this->assertEmpty($database_manager->getForks('/absolute/path'));
140+
}
141+
142+
public function testGetForks()
143+
{
144+
$database_manager = $this->getDatabaseManager();
145+
$original_database = $database_manager->getDatabase('/absolute/path');
146+
$original_database->perform('CREATE TABLE "SampleTableOrg" ("Name" TEXT(255,0) NOT NULL, PRIMARY KEY("Name"))');
147+
148+
$db_fork1 = $database_manager->getDatabase('/absolute/path', 'fork1');
149+
$db_fork1->perform('CREATE TABLE "SampleTableFork1" ("Name" TEXT(255,0) NOT NULL, PRIMARY KEY("Name"))');
150+
151+
$db_fork2 = $database_manager->getDatabase('/absolute/path', 'fork2');
152+
$db_fork2->perform('CREATE TABLE "SampleTableFork2" ("Name" TEXT(255,0) NOT NULL, PRIMARY KEY("Name"))');
153+
154+
$this->assertEquals(array('fork1', 'fork2'), $database_manager->getForks('/absolute/path'));
155+
}
156+
116157
/**
117158
* Returns database DSN.
118159
*

0 commit comments

Comments
 (0)