Merge pull request #152 from jonsugar/main

Patch release v1.0.1 - Use correct time zone and minor refactors for readability

.gitignore

@@ -1,3 +1,4 @@
 /vendor
 .phpunit.result.cache
 /storage/framework/
+.php_cs.cache

.phpcs.xml.dist

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<ruleset>
+ <file>app</file>
+ <file>config</file>
+ <file>tests</file>
+
+ <rule ref="Tighten"/>
+</ruleset>

app/Actions/CompileAssets.php

@@ -10,24 +10,24 @@ class CompileAssets
  use AbortsCommands;
 
  protected $shell;
- protected $silentDevScript;
+ protected $npm;
  protected $consoleWriter;
 
- public function __construct(Shell $shell, SilentDevScript $silentDevScript, ConsoleWriter $consoleWriter)
+ public function __construct(Shell $shell, SilenceNpm $silenceNpm, ConsoleWriter $consoleWriter)
  {
  $this->shell = $shell;
- $this->silentDevScript = $silentDevScript;
+ $this->npm = $silenceNpm;
  $this->consoleWriter = $consoleWriter;
  }
 
  public function __invoke()
  {
  $this->consoleWriter->logStep('Compiling project assets');
 
- $this->silentDevScript->add();
+ $this->npm->silence();
  $process = $this->shell->execInProject("npm run dev{$this->extraOptions()}");
  $this->abortIf(! $process->isSuccessful(), 'Compilation of project assets did not complete successfully', $process);
- $this->silentDevScript->remove();
+ $this->npm->unsilence();
 
  $this->consoleWriter->success('Project assets compiled successfully.');
  }

app/Actions/ConfigureFrontendFramework.php

@@ -33,7 +33,7 @@ public function __invoke()
  $this->ensureJetstreamInstalled();
 
  $process = $this->shell->execInProject(sprintf(
- "php artisan jetstream:install %s%s%s",
+ 'php artisan jetstream:install %s%s%s',
  $configuredFrontend,
  config('lambo.store.teams') ? ' --teams' : '',
  config('lambo.store.with_output') ? '' : ' --quiet'
@@ -60,7 +60,7 @@ public function ensureJetstreamInstalled()
 
  $process = $this->shell->execInProject('composer require laravel/jetstream' . (config('lambo.store.with_output') ? '' : ' --quiet'));
 
- $this->abortIf(! $process->isSuccessful(), "Installation of laravel/jetstream did not complete successfully.", $process);
+ $this->abortIf(! $process->isSuccessful(), 'Installation of laravel/jetstream did not complete successfully.', $process);
 
  $this->consoleWriter->success('laravel/jetstream installed.');
  }

app/Actions/DisplayHelpScreen.php

@@ -17,19 +17,19 @@ class DisplayHelpScreen
  public function __invoke()
  {
  app('console-writer')->newLine();
- app('console-writer')->text("<comment>Usage:</comment>");
+ app('console-writer')->text('<comment>Usage:</comment>');
  app('console-writer')->text(" lambo new myApplication [arguments]\n");
- app('console-writer')->text("<comment>Commands (lambo COMMANDNAME):</comment>");
+ app('console-writer')->text('<comment>Commands (lambo COMMANDNAME):</comment>');
 
  foreach ($this->commands as $command => $description) {
  $spaces = $this->makeSpaces(strlen($command));
  app('console-writer')->text(" <info>{$command}</info>{$spaces}{$description}");
  }
 
  app('console-writer')->newLine();
- app('console-writer')->text("<comment>Options (lambo new myApplication OPTIONS):</comment>");
+ app('console-writer')->text('<comment>Options (lambo new myApplication OPTIONS):</comment>');
 
- foreach ((new Options)->all() as $option) {
+ foreach ((new Options())->all() as $option) {
  app('console-writer')->text($this->createCliStringForOption($option));
  }
  }
@@ -54,6 +54,6 @@ public function createCliStringForOption($option)
 
  public function makeSpaces($count)
  {
- return str_repeat(" ", $this->indent - $count);
+ return str_repeat(' ', $this->indent - $count);
  }
 }

app/Actions/DisplayLamboWelcome.php

@@ -4,12 +4,12 @@
 
 class DisplayLamboWelcome
 {
- protected $lamboLogo = "
+ protected $lamboLogo = '
  __ __ :version:
  / / ____ _____ ___ / /_ ____
  / / / __ `/ __ `__ \/ __ \/ __ \
  / /___/ /_/ / / / / / / /_/ / /_/ /
- /_____/\__,_/_/ /_/ /_/_.___/\____/";
+ /_____/\__,_/_/ /_/ /_/_.___/\____/';
 
  protected $welcomeText = "
 <info>Lambo:</info> Super-powered <comment>'laravel new'</comment> for Laravel and Valet.";
@@ -23,12 +23,12 @@ public function __invoke()
  {
  foreach (explode("\n", $this->lamboLogo) as $line) {
  // Extra space on the end fixes an issue with console when it ends with backslash
- app('console-writer')->text("<info>$line </info>");
+ app('console-writer')->text("<info>{$line} </info>");
  }
 
  foreach (explode("\n", $this->welcomeText) as $line) {
  // Extra space on the end fixes an issue with console when it ends with backslash
- app('console-writer')->text($line . " ");
+ app('console-writer')->text("{$line} ");
  }
  }
 }

app/Actions/SavedConfig.php → app/Actions/EditConfigFile.php

@@ -5,7 +5,7 @@
 use App\Shell;
 use Illuminate\Support\Facades\File;
 
-class SavedConfig
+class EditConfigFile
 {
  use AbortsCommands;
 
@@ -16,10 +16,10 @@ public function __construct(Shell $shell)
  $this->shell = $shell;
  }
 
- public function createOrEditConfigFile(string $fileName)
+ public function __invoke(string $fileName)
  {
  $configDir = config('home_dir') . '/.lambo';
- $configFilePath = $configDir . "/" . $fileName;
+ $configFilePath = $configDir . '/' . $fileName;
 
  if (! File::isDirectory($configDir)) {
  app('console-writer')->note("Configuration directory '{$configDir}' does not exist, creating it now...");

app/Actions/OpenInBrowser.php

@@ -35,7 +35,7 @@ public function __invoke()
  return;
  }
 
- $this->shell->execInProject("valet open");
+ $this->shell->execInProject('valet open');
  }
 
  public function browser()

app/Actions/OpenInEditor.php

@@ -26,8 +26,8 @@ public function __invoke()
 
  $this->consoleWriter->logStep('Opening In Editor');
 
- $process = $this->shell->withTTY()->execInProject(sprintf("%s .", config('lambo.store.editor')));
- $this->abortIf(! $process->isSuccessful(), sprintf("Failed to open editor %s", config('lambo.store.editor')), $process);
+ $process = $this->shell->withTTY()->execInProject(sprintf('%s .', config('lambo.store.editor')));
+ $this->abortIf(! $process->isSuccessful(), sprintf('Failed to open editor %s', config('lambo.store.editor')), $process);
 
  $this->consoleWriter->success('Opening your project in ' . config('lambo.store.editor'));
  }

app/Actions/RunAfterScript.php

@@ -28,7 +28,7 @@ public function __invoke()
 
  $this->consoleWriter->logStep('Running after script');
 
- $process = $this->shell->execInProject("sh " . $afterScriptPath);
+ $process = $this->shell->execInProject('sh ' . $afterScriptPath);
  $this->abortIf(! $process->isSuccessful(), 'After file did not complete successfully', $process);
 
  $this->consoleWriter->success('After script has completed.');

app/Actions/RunLaravelInstaller.php

@@ -20,28 +20,29 @@ public function __construct(Shell $shell, ConsoleWriter $consoleWriter)
 
  public function __invoke()
  {
- $this->consoleWriter->logStep("Running the Laravel installer");
+ $this->consoleWriter->logStep('Running the Laravel installer');
 
  $process = $this->shell->execInRoot('laravel new ' . config('lambo.store.project_name') . $this->extraOptions());
- $this->abortIf(! $process->isSuccessful(), "The laravel installer did not complete successfully.", $process);
+ $this->abortIf(! $process->isSuccessful(), 'The laravel installer did not complete successfully.', $process);
 
  $this->consoleWriter->success($this->getFeedback());
  }
 
  public function extraOptions()
  {
- return sprintf('%s%s',
+ return sprintf(
+ '%s%s',
  config('lambo.store.dev') ? ' --dev' : '',
  config('lambo.store.with_output') ? '' : ' --quiet'
  );
  }
 
  public function getFeedback(): string
  {
- return sprintf("A new application '%s' has been created from the %s branch.",
+ return sprintf(
+ "A new application '%s' has been created from the %s branch.",
  config('lambo.store.project_name'),
  config('lambo.store.dev') ? 'develop' : 'release'
  );
  }
-
 }

app/Actions/SilentDevScript.php → app/Actions/SilenceNpm.php

@@ -5,7 +5,7 @@
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\File;
 
-class SilentDevScript
+class SilenceNpm
 {
  private $packageJsonPath;
  private $backupPackageJsonPath;
@@ -16,13 +16,13 @@ public function __construct()
  $this->backupPackageJsonPath = config('lambo.store.project_path') . '/package-original.json';
  }
 
- public function add()
+ public function silence()
  {
  File::copy($this->packageJsonPath, $this->backupPackageJsonPath);
  File::replace($this->packageJsonPath, $this->getSilentPackageJson($this->packageJsonPath));
  }
 
- public function remove()
+ public function unsilence()
  {
  File::move($this->backupPackageJsonPath, $this->packageJsonPath);
  }
@@ -33,6 +33,6 @@ private function getSilentPackageJson(string $originalPackageJson)
  $silentDevelopmentCommand = str_replace('--progress', '--no-progress', Arr::get($packageJson, 'scripts.development'));
  Arr::set($packageJson, 'scripts.development', $silentDevelopmentCommand);
 
- return json_encode($packageJson,  JSON_UNESCAPED_SLASHES);
+ return json_encode($packageJson, JSON_UNESCAPED_SLASHES);
  }
 }

app/Actions/UpgradeSavedConfiguration.php

@@ -11,14 +11,16 @@ class UpgradeSavedConfiguration
  // IMPORTANT NOTE: Every time we make *any* changes to configuration, we need
  // to increment this configurationVersion so that users get upgraded config
  private $configurationVersion = 1;
-
+ private $configDir;
+ private $configFilePath;
+ private $lastVersionUpdateFilePath;
+ private $commented = [];
  private $removedConfigurationKeys = [
  'NODE',
  'MIX',
  'AUTH',
  'FRONTEND',
  ];
-
  private $newConfiguration = [
  'MIGRATE_DATABASE' => [
  'commented' => false,
@@ -35,7 +37,7 @@ class UpgradeSavedConfiguration
  'default' => '127.0.0.1',
  'description' => [
  'The database host. Defaults to 127.0.0.1.',
- ]
+ ],
  ],
  'DB_PORT' => [
  'commented' => true,
@@ -53,20 +55,14 @@ class UpgradeSavedConfiguration
  ],
  ];
 
- private $configDir;
- private $configFilePath;
- private $lastVersionUpdateFilePath;
-
- private $commented = [];
-
  public function __construct()
  {
  $this->configDir = config('home_dir') . '/.lambo';
  $this->configFilePath = "{$this->configDir}/config";
  $this->lastVersionUpdateFilePath = "{$this->configDir}/.last_version_update";
  }
 
- public function __invoke()
+ public function __invoke(): bool
  {
  if (! $this->shouldUpgrade()) {
  return false;
@@ -83,7 +79,7 @@ public function __invoke()
  return true;
  }
 
- private function shouldUpgrade()
+ private function shouldUpgrade(): bool
  {
  if (! File::isFile($this->configFilePath)) {
  return false;
@@ -100,10 +96,10 @@ private function shouldUpgrade()
  return false;
  }
 
- public function upgrade(string $savedConfiguration, array $unusedConfigurationKeys, array $newConfiguration = []): string
+ public function upgrade(string $savedConfiguration, array $removedConfigurationKeys, array $newConfiguration = []): string
  {
  return implode(PHP_EOL, [
- $this->commentUnusedConfiguration($savedConfiguration, $unusedConfigurationKeys),
+ $this->commentRemovedConfiguration($savedConfiguration, $removedConfigurationKeys),
  "\n# ------------------------------------------------------------------------------",
  '# ' . Carbon::now()->format('j-M-Y g:i a') . ' (auto-generated by Lambo):',
  '# ------------------------------------------------------------------------------',
@@ -112,7 +108,7 @@ public function upgrade(string $savedConfiguration, array $unusedConfigurationKe
  ]);
  }
 
- private function commentUnusedConfiguration(string $savedConfiguration, array $oldConfigurationKeys): string
+ private function commentRemovedConfiguration(string $savedConfiguration, array $oldConfigurationKeys): string
  {
  return collect(explode("\n", $savedConfiguration))->transform(function ($item) use ($oldConfigurationKeys) {
  $matched = collect($oldConfigurationKeys)->reduce(function ($carry, $oldKey) use ($item) {
@@ -126,17 +122,17 @@ private function commentUnusedConfiguration(string $savedConfiguration, array $o
  })->implode("\n");
  }
 
- private function summarizeComments()
+ private function summarizeComments(): string
  {
  if (count($this->commented) < 1) {
  return '';
  }
 
  return implode(PHP_EOL, [
- '# Lambo has commented out the following configuration items; they are no',
- '# longer used, and you may safely remove them:',
+ '# Lambo has commented out the following configuration items as they',
+ '# are no-longer used. You may safely remove them:',
  collect($this->commented)->reduce(function ($carry, $item) {
- return "$carry# {$item}\n";
+ return "{$carry}# {$item}\n";
  }, '')
  ]);
  }
@@ -149,7 +145,7 @@ private function addNewConfiguration(array $newConfiguration): string
 
  return collect(array_keys($newConfiguration))->reduce(function ($carry, $key) use ($newConfiguration) {
  $description = collect($newConfiguration[$key]['description'])->reduce(function ($carry, $item) {
- return "$carry# {$item}\n";
+ return "{$carry}# {$item}\n";
  }, '');
 
  $configurationItem = sprintf(

app/Actions/ValetLink.php

@@ -10,6 +10,7 @@ class ValetLink
  use AbortsCommands;
 
  protected $shell;
+
  private $consoleWriter;
 
  public function __construct(Shell $shell, ConsoleWriter $consoleWriter)

app/Actions/ValetSecure.php

@@ -26,7 +26,7 @@ public function __invoke()
 
  $this->consoleWriter->logStep('Running valet secure');
 
- $process = $this->shell->execInProject("valet secure");
+ $process = $this->shell->execInProject('valet secure');
  $this->abortIf(! $process->isSuccessful(), 'valet secure did not complete successfully', $process);
 
  $this->consoleWriter->success('valet secure successful');