Allow a default connection to be passed to the constructor and update documentation

Author: jspringe

README.md

@@ -33,7 +33,7 @@ The `ModelCollection` extends https://github.com/tightenco/collect / [Laravel Co
 You can also instantiate `Scripting`:
 
     $scripting = new PhpWinTools\WmiScripting\Scripting;
-    $scripting->addConnection('remote', PhpWinTools\WmiScripting\Connection::defaultNamespace('server', 'user', 'password'));
+    $scripting->addConnection('remote', PhpWinTools\WmiScripting\Connection::simple('server', 'user', 'password'));
     $scripting->query('remote')->loggedOnUser()->get();
 
 Whether you use `$scripting->query($connection = null)->modelName()` or `::query($connection = null)` you are dropped into a basic query

docs/.vuepress/config.js

@@ -25,7 +25,7 @@ module.exports = {
                     collapsable: false,
                     children: [
                         ['documentation/', 'How It Works'],
-                        ['documentation/getting-started/', 'Getting Started']
+                        ['documentation/getting-started', 'Getting Started']
                     ]
                 }
             ]

docs/.vuepress/theme/styles/code.styl

@@ -11,7 +11,6 @@
         color #EC5975
       &.inserted
         color $accentColor
-
 {$contentClass}
   pre, pre[class*="language-"]
     line-height 1.4
@@ -21,7 +20,7 @@
     border-radius 6px
     overflow auto
     code
-      color #fff
+      color lighten(#A9B7C6, 40%)
       padding 0
       background-color transparent
       border-radius 0
@@ -131,7 +130,20 @@ div[class~="language-python"]:before
 div[class~="language-bash"]:before
   content "sh"
 
-div[class~="language-php"]:before
-  content "php"
+div[class~="language-php"]
+  .token.keyword
+    color saturate(#CC7832, 40%)
+  .token.variable
+    color saturate(#9876AA, 40%)
+  .token.comment
+    font-style italic
+    color saturate(#629755, 40%)
+  .token.string
+    color saturate(#6A8759, 40%)
+  .token.class-name
+  .token.operator
+    color lighten(#A9B7C6, 40%)
+  &:before
+    content "php"
 
 @import '~prismjs/themes/prism-tomorrow.css'

docs/.vuepress/theme/styles/config.styl

@@ -1 +1,2 @@
 $contentClass = '.theme-default-content'
+$codeBgColor = #232525

docs/documentation/getting-started.md

@@ -0,0 +1,70 @@
+# Getting Started
+
+:::warning
+#### REQUIREMENTS
+\>= PHP 7.1
+
+Windows and the `com_dotnet` extension enabled (available in every [`Windows PHP`](https://windows.php.net/download/) release).
+:::
+
+## Install
+``` sh
+composer require phpwintools/wmi-scripting
+```
+
+## Basic Configuration
+
+### Static call on Win32Model class
+``` php
+$connection = Connection::simple('computer-one', 'admin', 'password');
+
+// Returns an instance of Query\Builder
+$builder = LoggedOnUser::query($connection);
+
+// Returns a ModelCollection of Models\LoggedOnUsers
+$loggedOnUsers = $builder->get();
+```
+
+A connection defined in this way will not be stored in the `Config` container. This is useful when you need to reference
+many connections in an array to poll many computers across your network.
+
+``` php
+$username = 'admin';
+$password = 'password';
+$computers = ['computer_one', 'computer_two'];
+
+$results = [];
+
+foreach ($computers as $computer) {
+    // $results becomes an array of ModelCollections
+    $results[] = LoggedOnUser::query(Connection::simple($computer, $user $password));
+}
+```
+
+### Instance of Scripting
+``` php
+$scripting = new Scripting(Connection::simple('computer-one', 'admin', 'password);
+
+// Returns and instance of Query\Builder (same as above)
+$builder = $scripting->query()->loggedOnUser();
+```
+
+This will set the given connection as the default connection. All models queried without a given connection will use
+this connection.
+
+### No Configuration
+``` php
+// Returns a ModelCollection of LoggedOnUser models on the machine that PHP is installed on
+$local = LoggedOnUser::query()->get();
+
+$scripting = new Scripting;
+// Same as above
+$local = $scripting->query()->loggedOnUser()->get();
+```
+
+If no configuration is provided then the library's default connection is localhost.
+
+::: danger
+`Scripting` should only be instantiated once. If it is instantiated more than once then the last configuration options
+will be used.
+:::

docs/documentation/getting-started/readme.md

@@ -2,13 +2,18 @@
 
 The basic goal of this library is to make querying information from Windows systems on your network as easy as possible.
 This is accomplished by adopting an active record approach similar to
-[Laravel's Eloquent](https://laravel.com/docs/6.0/eloquent).
+[Laravel's Eloquent](https://laravel.com/docs/5.8/eloquent).
 
 The WMI Scripting library consists of models that represent the
 [WMI Win32 Provider classes](https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-provider)
 and a basic query builder using [WQL](https://docs.microsoft.com/en-us/windows/win32/wmisdk/querying-with-wql)
 as it's target language.
 
+I also take advantage of [Laravel's Collections](https://laravel.com/docs/5.8/collections) via the extraction done by
+[TightenCo](https://github.com/tightenco/collect), so you are not bound directly to the Laravel framework. Anytime you
+query a model you will get back an instance of `ModelCollection` which extends Laravel's `Collection`. This allows for
+fluent access to this data: `$modelCollection->map->getAttribute('name);` returns a collection of only the model names.
+
 ## Todo
 
 I'm still working through the API and some of the core code to make this library as clean and resilient as possible.

docs/documentation/readme.md

@@ -50,8 +50,8 @@ composer require phpwintools/wmi-scripting
 $scripting = new Scripting;
 
 // These connections can be called by name.
-$scripting->addConnection('server1', Connection::defaultNamespace('server1', 'user', 'password'));
-$scripting->addConnection('server2', Connection::defaultNamespace('server2', 'user', 'password'));
+$scripting->addConnection('server1', Connection::simple('server1', 'user', 'password'));
+$scripting->addConnection('server2', Connection::simple('server2', 'user', 'password'));
 
 $scripting->query('server2')->loggedOnUser()->get();
 
@@ -65,5 +65,5 @@ $scripting->query()->loggedOnUser()->get();
 ### Connections with static calls
 
 ```php
-LoggedOnUser::query(Connection::defaultNamespace('server1', 'user', 'password'))->get();
+LoggedOnUser::query(Connection::simple('server1', 'user', 'password'))->get();
 ```

docs/readme.md

@@ -28,6 +28,11 @@ public function __construct($config = null)
             $this->config = $config;
         }
 
+        if ($config instanceof Connection) {
+            $this->config = Config::instance();
+            $this->setDefaultConnection('default', $config);
+        }
+
         if (is_array($config)) {
             $this->config = Config::instance($config);
         }
@@ -80,13 +85,13 @@ public function query($connection = null): WmiQueryFactory
     public function addConnection(string $name, $connection): self
     {
         if ($connection instanceof Connection) {
-            $this->config->addConnection($name, $connection);
+            $this->getConfig()->addConnection($name, $connection);
 
             return $this;
         }
 
         if (is_array($connection)) {
-            $this->config->addConnection($name, new Connection(
+            $this->getConfig()->addConnection($name, new Connection(
                 $connection['server'] ?? Connection::DEFAULT_SERVER,
                 $connection['namespace'] ?? Connection::DEFAULT_NAMESPACE,
                 $connection['user'] ?? null,
@@ -116,8 +121,26 @@ public function setDefaultConnection(string $name, $connection = null): self
             $this->addConnection($name, $connection);
         }
 
-        $this->config->setDefaultConnection($name);
+        $this->getConfig()->setDefaultConnection($name);
 
         return $this;
     }
+
+    /**
+     * @param string|null $name
+     *
+     * @return Connection|null
+     */
+    public function getConnection(string $name = null)
+    {
+        return $this->getConfig()->getConnection($name);
+    }
+
+    /**
+     * @return Connection|null
+     */
+    public function getDefaultConnection()
+    {
+        return $this->getConnection();
+    }
 }

src/WmiScripting/Scripting.php

@@ -38,6 +38,15 @@ public function it_can_instantiate_and_use_the_given_configuration()
         $this->assertSame($config, $scripting->getConfig());
     }
 
+    /** @test */
+    public function it_can_instantiate_with_a_connection_and_set_it_as_the_default_connection()
+    {
+        $connection = Connection::simple('server', 'user', 'password');
+        $scripting = new Scripting($connection);
+
+        $this->assertSame($connection, $scripting->getDefaultConnection());
+    }
+
     /** @test */
     public function it_can_instantiate_and_merge_in_a_configuration_array()
     {