Merge pull request #2 from precariouspanther/rename-automock-helper

Renamed automock helper for automocking test to better reflect what t…

Author: precariouspanther

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+#### What?
+
+A description about what this pull request implements and its purpose. Try to be detailed and describe any technical
+details to simplify the job of the reviewer.
+
+#### Tickets / Documentation
+
+Add links to any relevant issues and documentation.
+
+- [Link 1](http://example.com)
+- ...
+

CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing to Mock Injector
+
+Thanks for showing interest in contributing!
+
+The following is a set of guidelines for contributing to the project. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+By contributing to this codebase, you agree that your contributions will be licensed under its MIT license.
+
+### Pull Requests
+
+* Fill in [the required template](https://github.com/bigcommerce-labs/mock-injector/pull/new/master)
+* End files with a newline.
+
+## Styleguides
+
+### Git Commit Messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference pull requests and external links liberally
+
+### PHP Styleguide
+
+All PHP must adhere to PSR-1, 2 and 4 as specified by the [PHP-FIG](http://www.php-fig.org/psr/).

LICENSE.md

@@ -0,0 +1,16 @@
+(The MIT License)
+Copyright (C) 2015-2017 BigCommerce Inc. 
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense,and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,4 +1,4 @@
-# bigcommerce/test-injector 
+# bigcommerce/mock-injector 
 
 Auto-mocking test Dependency Injector component
 
@@ -39,4 +39,22 @@ $result = $testInjector->invoke($instanceOfThing, "createUser", [
 ````
 
 
-For integration with your PHPUnit tests, see: [AutoMockingTest.php](src/AutoMockingTest.php) 
+For integration with your PHPUnit tests, see: [AutoMockingTest.php](src/AutoMockingTest.php) 
+
+
+(The MIT License)
+Copyright (C) 2015-2017 BigCommerce Inc.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense,and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

phpunit.xml

@@ -6,7 +6,7 @@
          bootstrap="vendor/autoload.php"
 >
     <testsuites>
-        <testsuite name="Injector Test Suite">
+        <testsuite name="MockInjector Test Suite">
             <directory>./tests</directory>
         </testsuite>
     </testsuites>

src/AutoMockingTest.php

@@ -29,8 +29,22 @@ protected function setUp()
      * @param string $className The FQCN of the class we are creating
      * @param array $parameters Any parameters to pass to the constructor. Can be keyed by type, name or position.
      * @return object
+     * @deprecated
+     * @see createWithMocks()
      */
-    protected function autoMock($className, $parameters = []){
+    protected function autoMock($className, $parameters = [])
+    {
+        return $this->injector->create($className, $parameters);
+    }
+
+    /**
+     * Create an instance of $className and automatically mock all its constructor dependencies.
+     * @param string $className The FQCN of the class we are creating
+     * @param array $parameters Any parameters to pass to the constructor. Can be keyed by type, name or position.
+     * @return object
+     */
+    protected function createWithMocks($className, $parameters = [])
+    {
         return $this->injector->create($className, $parameters);
     }