Feature/theme management

[mallorydxw]

This will fix #41. In progress.

Install:

• Add a new module called dependencies or deps
• whippet deps install reads from whippet.lock and installs the themes in the appropriate places
• WhippetLock class should have a ::FromFile() static method and allow instantiating with a string of JSON
• Produce the same useful output that whippet plugins install does
• Do not install if there's a hash mismatch

Update:

• whippet deps update reads from whippet.json, updates whippet.lock appropriately, and installs the themes
• whippet deps update should modify the gitignore file too

Plugins:

• Add plugins to whippet.lock
• Add plugins to whippet.json
• Make whippet deps migrate command

Loose ends:

• Move WhippetLock to Files/WhippetLock
• Use WhippetLock class for generating new whippet.lock file
• Rename Dependencies(.*).php to Dependencies/$1.php (?)
• Make sure each ->unwrap() call has a ->isErr() check
  • Dependencies/Installer->install
  • Dependencies/Updater->update (2)
  • Dependencies/Migration->migrate (2)
• s/FileLocator/DirectoryLocator/
• Pretty-print whippet.lock (see JSON_PRETTY_PRINT)
• Pretty-print whippet.json when migrating
• dependencies install/update should ignore plugins file entirely
• dependencies update prints error
• dependencies install doesn't produce any output, mysteriously
• $git->clone_repo() fails
• $git->checkout() fails
• Run whippet dependencies migrate/update in all the projects, and see if anything breaks
• Test missing file scenarios
• Test broken JSON scenarios
• Check gitignore behaviour
• Test git command failure
• Test invalid JSON scenarios
• PHP Warning: file(/workbench/src/github.com/dxw/.gitignore): failed to open stream: No such file or directory in /workbench/src/github.com/dxw/whippet/src/Git/Gitignore.php on line 27
• Add Files/WhippetJson for parsing/generating whippet.json file
• Test: a whippet.json file gets updated to remove a plugin, the plugin should be removed from .gitignore, but non-managed plugins should not
• migrate should refuse to overwrite an existing whippet.json file
• updater: return "whippet.json: file not found" instead of just "file not found"
• Break up some of these very large functions into smaller ones
• Make deps an alias for dependencies
• Test for running update on {"plugins":[{"name":"foo"}]} - it'll produce a warning
• Add deprecation notices to whippet plugins commands
• Update WhippetHelpers->whippet_init to find the whippet directory when there's no plugins file
• Update deploy (Modules\Release): if whippet.json exists then use Dependencies\Install, otherwise fallback to using Modules\Plugin
• Make sure the other commands still work without plugins and plugins.lock files
• Better tests: replace getFactory() with $this->addFactoryCallStatic(), $this->addFactoryInstantiate()
• Replace DirectoryLocator with ProjectDirectory, which has a class method that returns a Result which contains a ProjectDirectory. It should just have one instance method: ->__toString()
• Update README

Make tickets (after this has been merged, or shortly before):

• Update individual dependencies, i.e.: whippet deps update themes/twentysixteen. See Allow updating individual dependencies #64
• Change error messages: "whippet.lock not found" -> "whippet.lock not found. Have you run whippet dependencies update?". See Add some more user-friendly error messages #65
• Base.php: Ensure parsing the empty string (or non-arrays) as JSON causes an error. See whippet dependencies causes errors in some weird circumstances #63
• Notice: Undefined index: hash in /Users/chris/github-repos/whippet/src/Files/WhippetLock.php on line 18. See whippet dependencies causes errors in some weird circumstances #63
• Add --no-install to whippet dependencies update (if there's a need - there may not be). Not made into separate issue
• Remove Module/Plugins. See Future: Remove whippet plugins command #66
  • Alias whippet plugins install => whippet dependencies install
  • Alias whippet plugins upgrade => whippet dependencies update
• whippet migrate (generator) needs to be updated to generate a whippet.json file instead of a plugins file. See Update whippet migrate to generate a whippet.json file #67
• Rewrite Gitignore as \Dxw\Whippet\Files\Gitignore (\Dxw\Whippet\Files\Base should be more generic, and \Dxw\Whippet\Files\Json should handle JSON files). See Rewrite Gitignore #68
• stop hardcoding filenames everywhere. See Remove some hardcoded filenames #69
  • Files/Base::fromDir($dir) -> fromFile($dir . '/' . static::$fileName)
  • Files/Base->saveToDir($dir) -> saveToPath($dir . '/' . static::$fileName)
• Repeating ['themes', 'plugins'] everywhere is not DRY. See Repeating ['themes', 'plugins'] everywhere is not DRY #70

[mallorydxw]

@harry-m Would you like to make sure it works?

Should be pretty self-explanatory, if you run whippet plugins install/upgrade it will tell you how to migrate and which commands you should be using instead.

(Oh yes... I just remembered I need to update the README. I'll add that to the list.)

[mallorydxw]

The new README: https://github.com/dxw/whippet/tree/feature/theme-management

[harry-m]

@Stretch96 Please can you review/test this?

[harry-m]

NB see Tom's list of post-merge tasks in his main update above.

[Stretch96]

I've gone through the whippet deps update and whippet deps install commands so far, just need to go through the whippet migrate command. Found a few uncaught errors, but it did work when I used it correctly 👍

• phpunit fails with:

Fatal error: Class 'org\bovigo\vfs\vfsStream' not found in /Users/chris/github-repos/whippet/tests/Helpers.php on line 116

Adding require 'vendor/autoload.php'; into project_directory_test.php passes the tests (Though it may be better to just include the one file needed for that class)

• With empty whippet.lock file, whippet deps install produces error:

Catchable fatal error: Argument 1 passed to Dxw\Whippet\Files\Base::__construct() must be of the type array, null given, called in /Users/chris/github-repos/whippet/src/Files/Base.php on line 14 and defined in /Users/chris/github-repos/whippet/src/Files/Base.php on line 26

Changing the check in Base.php to:

if (json_last_error() !== JSON_ERROR_NONE || !is_array($data))

Catches this error (I think it's because json_decode('') doesn't cause an error, it just returns NULL instead of an empty array)

• With {} in whippet.lock file (Or not including the hash in the array) whippet deps install produces notice:

Notice: Undefined index: hash in /Users/chris/github-repos/whippet/src/Files/WhippetLock.php on line 18

changing line 18 in WhippetLock.php to:

return $this->data['hash'] ?? NULL;

catches this

[mallorydxw]

phpunit fails with:

Did you run phpunit or vendor/bin/phpunit? If you run vendor/bin/phpunit then it already has the composer dependencies loaded.

(It's also useful for the Travis tests because we need to test 5.5 but the latest version of PHPUnit only supports 5.6 and 7.0).

return $this->data['hash'] ?? NULL;

That's PHP 7 syntax. We can't use that quite yet.

Things to fix:

• Base.php: Ensure parsing the empty string (or non-arrays) as JSON causes an error
• Notice: Undefined index: hash in /Users/chris/github-repos/whippet/src/Files/WhippetLock.php on line 18