Added diagrams, icons and improvements (phpactor#309)

Author: dantleech

doc/README.md

@@ -30,13 +30,15 @@ Packages
 
 Phpactor is made up of a few different packages:
 
+![Components](images/components.png)
+
 - [phpactor/class-mover](https://github.com/phpactor/class-mover): Find and update class references.
 - [phpactor/class-to-file](https://github.com/phpactor/class-to-file): Convert files to class names and vice-versa.
 - [phpactor/code-builder](https://github.com/phpactor/code-builder): Library for creating and idempotently updating source code.
 - [phpactor/code-transform](https://github.com/phpactor/code-transform): Transform code.
 - [phpactor/path-finder](https://github.com/phpactor/path-finder): Simple for file relationships when they share common path segments.
 - [phpactor/source-code-filesystem](https://github.com/phpactor/source-code-filesystem): Find and manage source code trees.
-- [phpactor/test-utils](https://github.com/phpactor/test-utils): Simple for file relationships when they share common path segments.
+- [phpactor/test-utils](https://github.com/phpactor/test-utils): Shared test utilities for Phpactor
 - [phpactor/worse-reflection](https://github.com/phpactor/worse-reflection): Static source reflection library.
 
 Depends On
@@ -47,15 +49,16 @@ Phpactor stands on the shoulders of some other packages:
 - [Couscous](http://couscous.io/): This documentation is generated with Couscous.
 - [Jetbrains PhpStorm Stubs](https://github.com/JetBrains/phpstorm-stubs): Built in PHP classes are supported through this stub collection from PhpStorm.
 - [PHPBench](https://github.com/phpbench/phpbench): For tracking performance.
+- [PHPUnit](https://github.com/sebastianbergmann/phpunit): The de facto
+  standard PHP test framework
 - [Symfony](https://symfony.com): The command line application is built with the Symfony console component.
 - [Tolerant PHP Parser](https://github.com/Microsoft/tolerant-php-parser): Large parts of Phpactor are integrated with the TPP.
 
 Influenced By
 -------------
 
-  implementing the LSP, some terminology has been borrowed from it.
 - [BetterReflection](https://github.com/Roave/BetterReflection): Phpactors reflection API was heavily influenced by this library.
-- [Language Server Protocol](https://github.com/Microsoft/language-server-protocol): While not
+- [Language Server Protocol](https://github.com/Microsoft/language-server-protocol): While not implementing the LSP, some terminology has been borrowed from it.
 - [Nikic PHP Parser](https://github.com/nikic/PHP-Parser): The original Phpactor used this before switching to TPP.
 
 Similar Projects

doc/build.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+for dotfile in `ls doc/dot`; do
+    name=${dotfile%.dot}
+    dot doc/dot/$dotfile -Tpng > doc/images/$name.png
+done

doc/dot/class-referenes.dot

@@ -0,0 +1,13 @@
+
+digraph {
+    Class [label="Acme\\AbstractServiceFactoryFactoryImpl"]
+    File1 [label="lib/Acme/Engine:32"]
+    File2 [label="lib/Acme/Entity/Car:100"]
+    File3 [label="lib/Acme/Circulator:200"]
+    File4 [label="lib/Acme/ContainerContainer:100,120,130"]
+
+    File1 -> Class
+    File2 -> Class
+    File3 -> Class
+    File4 -> Class
+}

doc/dot/components.dot

@@ -0,0 +1,26 @@
+digraph {
+    CodeBuilder [label="Code Builder"]
+    Transform [label="Code Transform"]
+    Reflection [label="Worse Reflection"]
+    Filesystem [label="SC Filesystem"]
+    ClassMover [label="Class Mover"]
+    Phpactor [label="Phpactor"]
+    ClassToFile [label="Class to File"]
+    TestUtils [label="Test Utils"]
+    PathFinder [label="Path Finder"]
+
+    Transform -> Phpactor
+    Reflection -> Phpactor
+    Filesystem -> Phpactor
+    ClassMover -> Phpactor
+    Reflection -> Transform
+    CodeBuilder -> Transform
+    ClassToFile -> Phpactor
+    PathFinder -> Phpactor
+
+    Reflection -> TestUtils
+    Phpactor -> TestUtils
+    Transform -> TestUtils
+    CodeBuilder -> TestUtils
+    ClassMover -> TestUtils
+}

doc/images/class-referenes.png

@@ -16,7 +16,7 @@ Navigate / list all references to a given class.
 
 - **Command**: `$ phpactor references:class path/to/Class.php`
 - **VIM Context Menu**: _Class context menu > Find references_.
-- **VIM Command**: `call phpactor#FindReferences()`
+- **VIM Command**:`:call phpactor#FindReferences()`
 
 ### Description
 
@@ -27,14 +27,16 @@ The VIM plugin will load the class references into a quick fix list which you ca
 
 The CLI command will list the references and show a highlighted line where the references were found.
 
+![Class references](images/class-referenes.png)
+
 Class Member References
 -------------------------
 
 Navigate / list all references to a given class member (method, property or constant).
 
 - **Command**: `$ phpactor references:member path/to/Class.php memberName`
 - **VIM Context Menu**: _Member context menu > Find references_.
-- **VIM Command**: `call phpactor#FindReferences()`
+- **VIM Command**:`:call phpactor#FindReferences()`
 
 ### Description
 
@@ -52,7 +54,7 @@ Jump to the definition of a class or class member.
 
 - **Command**: _RPC Only_
 - **VIM Context Menu**: _Member/class context menu > Goto definition_.
-- **VIM Command**: `call phpactor#GotoDefinition()`
+- **VIM Command**:`:call phpactor#GotoDefinition()`
 
 ### Description
 
@@ -67,7 +69,7 @@ Jump to a related file (e.g. unit test, integration test, benchmark), and option
 
 - **Command**: _RPC Only_
 - **VIM Context Menu**: _Class context menu > Navigate_.
-- **VIM Command**: `call phpactor#Navigate()`
+- **VIM Command**:`:call phpactor#Navigate()`
 
 ### Description
 

doc/images/components.png

@@ -35,7 +35,7 @@ Automatically add any missing properties to a class.
 
 - **Command**: `$ phpactor class:transform path/to/Class.php --transform=add_missing_assignments`
 - **VIM Context Menu**: _Class context menu > Implement Contracts_.
-- **VIM Command**: `call phpactor#Transform()`
+- **VIM Command**:`:call phpactor#Transform()`
 
 ### Motivation
 
@@ -81,7 +81,7 @@ Copy an existing class to another location updating its name and namespace.
 
 - **Command**: `$ phpactor class:copy path/to/ClassA.php path/to/ClassB.php` (class FQN also accepted).
 - **VIM context menu**: _Class context menu > Copy Class_
-- **VIM function**: `call phpactor#CopyFile()`
+- **VIM function**:`:call phpactor#CopyFile()`
 
 ### Motivation
 
@@ -134,7 +134,7 @@ Move a class (or folder containing classes) from one location to another.
 
 - **Command**: `$ phpactor class:move path/to/ClassA.php path/to/ClassB.php` (class FQN also accepted).
 - **VIM context menu**: _Class context menu > Move Class_
-- **VIM function**: `call phpactor#MoveFile()`
+- **VIM function**:`:call phpactor#MoveFile()`
 
 ### Motivation
 
@@ -190,7 +190,7 @@ Generate a new class with a name and namespace at a given location or from a cla
 
 - **Command**: `$ phpactor class:new path/To/ClassName.php` (class FQN also accepted).
 - **VIM context menu**: _Class context menu > New Class_
-- **VIM function**: `call phpactor#ClassNew()`
+- **VIM function**:`:call phpactor#ClassNew()`
 
 ### Motivation
 
@@ -240,7 +240,7 @@ Complete the assignments and add properties for an incomplete constructor.
 
 - **Command**: `$ phpactor class:transform path/to/class.php --transform=complete_constructor`
 - **VIM plugin**: _Class context menu > Complete Constructor_.
-- **VIM function**: `call phpactor#Transform()`
+- **VIM function**:`:call phpactor#Transform()`
 
 ### Motivation
 
@@ -297,7 +297,7 @@ Extract a constant from a scalar value.
 
 - **Command**: _RPC only_
 - **VIM plugin**: _Symbol context menu > Extract Constant_.
-- **VIM function**: `call phpactor#ContextMenu()`
+- **VIM function**:`:call phpactor#ContextMenu()`
 
 ### Motivation
 
@@ -366,7 +366,7 @@ Extract an interface from a class. If a wildcard is given (CLI only) generate an
 
 - **Command**: `$ phpactor class:inflect path/to/Class.php path/to/Interface.php` (wild card accepted).
 - **VIM plugin**: _Class context menu > Inflect > Extract interface_.
-- **VIM function**: `call phpactor#ClassInflect()`
+- **VIM function**:`:call phpactor#ClassInflect()`
 
 ### Motivation
 
@@ -407,7 +407,7 @@ Generate an accessor for a class property.
 
 - **Command**: _RPC only_
 - **VIM plugin**: _Property context menu > Generate accessor_.
-- **VIM function**: `call phpactor#ContextMenu()`
+- **VIM function**:`:call phpactor#ContextMenu()`
 
 ### Motivation
 
@@ -461,7 +461,7 @@ Generate or update a method based on the method call under the cursor.
 
 - **Command**: _RPC only_
 - **VIM plugin**: _Method context menu > Generate method_.
-- **VIM function**: `call phpactor#ContextMenu()`
+- **VIM function**:`:call phpactor#ContextMenu()`
 
 ### Motivation
 
@@ -533,7 +533,7 @@ Add any non-implemented methods from interfaces or abstract classes.
 
 - **Command**: `$ phpactor class:transform /path/to/class.php --transform=implement_contracts`
 - **VIM plugin**: _Class context menu > Transform > Implement contracts_.
-- **VIM function**: `call phpactor#Transform()`
+- **VIM function**:`:call phpactor#Transform()`
 
 ### Motivation
 
@@ -574,7 +574,7 @@ Import a class into the current namespace based on the class name under the curs
 
 - **Command**: _VIM function only_
 - **VIM plugin**: _VIM function only_
-- **VIM function**: `call phpactor#AddUse()`
+- **VIM function**:`:call phpactor#AddUse()`
 
 ### Motivation
 
@@ -652,7 +652,7 @@ Overide a method from a parent class.
 
 - **Command**: _RPC only_
 - **VIM plugin**: _Class context menu > Override method_.
-- **VIM function**: `call phpactor#ContextMenu()`
+- **VIM function**:`:call phpactor#ContextMenu()`
 
 ### Motivation
 
@@ -698,7 +698,7 @@ Rename a variable in the local or class scope.
 
 - **Command**: _RPC only_
 - **VIM plugin**: _Variable context menu > Rename_.
-- **VIM function**: `call phpactor#ContextMenu()`
+- **VIM function**:`:call phpactor#ContextMenu()`
 
 ### Motivation
 
@@ -757,7 +757,7 @@ Rename a class.
 
 - **Command**: `$ phpactor references:class path/to/Class.php --replace="NewName"` (class FQN accepted)
 - **VIM plugin**: _Class context menu > Replace references_.
-- **VIM function**: `call phpactor#ContextMenu()`
+- **VIM function**:`:call phpactor#ContextMenu()`
 
 ### Motivation
 
@@ -814,7 +814,7 @@ Rename a class member.
 
 - **Command**: `$ phpactor references:member path/to/Class.php memberName --type="method" --replace="newMemberName"` (FQN accepted)
 - **VIM plugin**: _Member context menu > Replace references_.
-- **VIM function**: `call phpactor#ContextMenu()`
+- **VIM function**:`:call phpactor#ContextMenu()`
 
 ### Motivation
 

doc/navigation.md

@@ -0,0 +1,10 @@
+---
+currentMenu: support
+---
+Support
+=======
+
+Need help? Create a Github issue or ping the Phactor twitter account:
+
+- [Github Issues](https://github.com/phpactor/phpactor/issues)
+- Twitter [@phpactor](https://twitter.com/phpactor)

doc/refactorings.md

@@ -13,6 +13,13 @@ section {
 h1, h2, h3, h4 {
     color: #df691a;
 }
+
+h2 {
+    border-bottom-style: solid;
+    border-bottom-width: 1px;
+    border-bottom-color: #aaa;
+}
+
 h3 {
     font-size: 23px;
 }