Adding in submodules and corresponding scripts. (#354)

* Adding in submodules and corresponding scripts.

* Adding CI style fixer

* Removing spaces

.circleci/config.yml

@@ -25,6 +25,12 @@ commands:
     description: "Build the project."
     steps:
     - pull-merge
+    - run:
+        name: Add in submodules
+        command: git submodule update --init
+    - run:
+        name: Run style fixer
+        command: bin/ci-style-fixer
     - run:
         name: Initialize docker .env
         command: bin/init/init_docker_env.sh

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "submodules"]
+	path = submodules
+	url = [email protected]:Medology/submodules.git

.php_cs.dist

@@ -0,0 +1 @@
+./submodules/config/.php_cs.dist

bin/ci-style-fixer

@@ -0,0 +1 @@
+../submodules/bin/ci-style-fixer

bin/get_colors

@@ -0,0 +1 @@
+../submodules/bin/get_colors

bin/get_images

@@ -0,0 +1 @@
+../submodules/bin/get_images

bin/get_local_user

@@ -0,0 +1 @@
+../submodules/bin/get_local_user

bin/get_tty

@@ -0,0 +1 @@
+../submodules/bin/get_tty

bin/gherkin-cs-fixer

@@ -0,0 +1 @@
+../submodules/bin/gherkin-cs-fixer

bin/init_git_hooks

@@ -0,0 +1 @@
+../submodules/bin/init_git_hooks

bin/init_project

@@ -9,3 +9,11 @@ echo "Installing Composer..."
 
 echo "Installing Composer dependencies with out dev..."
 composer install --no-interaction --no-suggest
+
+if  [[ ! "$CI" == 'true' ]]; then
+    echo "Initializing git hooks..."
+    "$ROOT"/bin/init_git_hooks
+
+    echo "Initializing submodules..."
+    git submodule update --init
+fi

bin/php-cs-fixer

@@ -0,0 +1 @@
+../submodules/bin/php-cs-fixer

bin/prettier-eslint

@@ -0,0 +1 @@
+../submodules/bin/prettier-eslint

bin/style-fixer

@@ -0,0 +1 @@
+../submodules/bin/style-fixer

hooks/pre-commit

@@ -0,0 +1 @@
+../submodules/bin/pre-commit

src/Medology/Behat/CsvContext.php

@@ -90,10 +90,11 @@ public function assertThingIsCSVWithRows($key, TableNode $table)
     /**
      * Asserts that required CSV headers are present.
      *
-     * @param  string[]  $required the headers that are required to be present.
-     * @param  string[]  $actual   the headers that are actually present.
-     * @param  string    $csvName  The name of the CSV (for the exception message).
-     * @throws Exception if any of the required headers are not present.
+     * @param string[] $required the headers that are required to be present
+     * @param string[] $actual   the headers that are actually present
+     * @param string   $csvName  the name of the CSV (for the exception message)
+     *
+     * @throws Exception if any of the required headers are not present
      */
     private function assertHeadersArePresent(array $required, array $actual, $csvName)
     {
@@ -105,10 +106,11 @@ private function assertHeadersArePresent(array $required, array $actual, $csvNam
     /**
      * Asserts that no additional CSV headers are present.
      *
-     * @param  string[]  $required the headers that are required to be present.
-     * @param  string[]  $actual   the headers that are actually present.
-     * @param  string    $csvName  The name of the CSV (for the exception message).
-     * @throws Exception if any additional headers are present.
+     * @param string[] $required the headers that are required to be present
+     * @param string[] $actual   the headers that are actually present
+     * @param string   $csvName  the name of the CSV (for the exception message)
+     *
+     * @throws Exception if any additional headers are present
      */
     private function assertNoAdditionalHeaders(array $required, array $actual, $csvName)
     {

src/Medology/Behat/Mink/FlexibleContext.php

@@ -60,7 +60,7 @@ public function __construct()
      *
      * Overrides the base method to support injecting stored values and matching URLs that include hostname.
      *
-     * @param string $page the page to assert we are on.
+     * @param string $page the page to assert we are on
      *
      * @throws DriverException          if the driver failed to perform the action
      * @throws ExpectationException     If the current page is not the expected page.
@@ -623,7 +623,7 @@ public function scrollToButton($locator, TraversableElement $context = null)
     {
         $locator = $this->fixStepArgument($locator);
 
-        /** @noinspection PhpUnhandledExceptionInspection */
+        /* @noinspection PhpUnhandledExceptionInspection */
         return Spinner::waitFor(function () use ($locator, $context) {
             $context = $context ? $context : $this->getSession()->getPage();
             $buttons = $context->findAll('named', ['button', $locator]);
@@ -681,7 +681,7 @@ public function assertVisibleLink($locator)
      */
     public function scrollToLink($locator)
     {
-        /** @noinspection PhpUnhandledExceptionInspection */
+        /* @noinspection PhpUnhandledExceptionInspection */
         return Spinner::waitFor(function () use ($locator) {
             $links = $this->getLinks($locator);
 
@@ -765,7 +765,7 @@ public function scrollToOption($locator)
     {
         $locator = $this->fixStepArgument($locator);
 
-        /** @noinspection PhpUnhandledExceptionInspection */
+        /* @noinspection PhpUnhandledExceptionInspection */
         return Spinner::waitFor(function () use ($locator) {
             $options = $this->getSession()->getPage()->findAll('named', ['field', $locator]);
 
@@ -819,7 +819,7 @@ public function assertFieldExists($fieldName, TraversableElement $context = null
      */
     public function scrollToField($fieldName, TraversableElement $context = null)
     {
-        /** @noinspection PhpUnhandledExceptionInspection */
+        /* @noinspection PhpUnhandledExceptionInspection */
         return Spinner::waitFor(function () use ($fieldName, $context) {
             $context = $context ?: $this->getSession()->getPage();
 
@@ -2032,7 +2032,7 @@ public function findRadioButton($label)
     /**
      * Returns all ancestors of the specified node element.
      *
-     * @param NodeElement $node   the node element to fetch ancestors for.
+     * @param NodeElement $node   the node element to fetch ancestors for
      * @param string|null $stopAt html tag to stop at. This node will NOT be included in the returned list.
      *
      * @return NodeElement[]

src/Medology/Behat/Mink/TableContext.php

@@ -537,8 +537,9 @@ private function buildTableFromHtml($table, $keyName = '')
         /**
          * Anonymous function to retrieve cell values from an array of row nodes. Does not support row or colspan!
          *
-         * @param  NodeElement[] $rows The rows to parse
-         * @return array         The cell values for the rows numerically indexed as [row][col]
+         * @param NodeElement[] $rows The rows to parse
+         *
+         * @return array The cell values for the rows numerically indexed as [row][col]
          */
         $parser = function (array $rows) {
             $data = [];

src/Medology/Behat/Mink/WebDownloadContext.php

@@ -109,10 +109,12 @@ public function download($file, $key = 'Download', $headersString = '')
     /**
      * This method checks if the image for an <img> tag actually loaded.
      *
-     * @param  string      $xpath The xpath of the <img> tag to check
-     * @param  string|null $src   The src value.
+     * @param string      $xpath The xpath of the <img> tag to check
+     * @param string|null $src   the src value
+     *
      * @throws Exception
-     * @return bool        True if image loaded, false otherwise
+     *
+     * @return bool True if image loaded, false otherwise
      */
     public function checkImageLoaded($xpath, $src = null)
     {

src/Medology/Behat/TypeCaster.php

@@ -37,7 +37,7 @@ public function castStringToInt($string)
      */
     public function castStringToFloat($string)
     {
-        /** @todo Add PHP_FLOAT_MAX check when we move all our projects to at least php 7.2 */
+        /* @todo Add PHP_FLOAT_MAX check when we move all our projects to at least php 7.2 */
         return floatval($string);
     }
 

tests/Medology/Behat/Mink/FlexibleContext/GetAncestorsTest.php

@@ -8,9 +8,13 @@
 class GetAncestorsTest extends FlexibleContextTest
 {
     private $body;
+
     private $div;
+
     private $list;
+
     private $listItem;
+
     private $button;
 
     public function setUp()
@@ -33,6 +37,17 @@ public function setUp()
         $this->button = $this->mockNode('button', $this->listItem);
     }
 
+    public function tearDown()
+    {
+        $this->body = null;
+        $this->div = null;
+        $this->list = null;
+        $this->listItem = null;
+        $this->button = null;
+
+        parent::tearDown();
+    }
+
     public function testAllAncestorsAreReturned()
     {
         // When I pass the button to allAncestors()
@@ -61,8 +76,9 @@ public function testStopAtIsNotReturned()
     /**
      * Creates a mocked NodeElement with an optional parent.
      *
-     * @param  string                 $tagName the type of node element to mock
-     * @param  NodeElement|null       $parent  the optional parent for the node element
+     * @param string           $tagName the type of node element to mock
+     * @param NodeElement|null $parent  the optional parent for the node element
+     *
      * @return MockObject|NodeElement
      */
     protected function mockNode($tagName, NodeElement $parent = null)
@@ -73,15 +89,4 @@ protected function mockNode($tagName, NodeElement $parent = null)
 
         return $node;
     }
-
-    public function tearDown()
-    {
-        $this->body = null;
-        $this->div = null;
-        $this->list = null;
-        $this->listItem = null;
-        $this->button = null;
-
-        parent::tearDown();
-    }
 }

tests/Medology/Behat/ParallelWorker/FilterTestBase.php

@@ -80,7 +80,8 @@ protected function getGherkinFeature()
     }
 
     /**
-     * @throws PHPUnit_Framework_AssertionFailedError if the parser returns null (it should never do this).
+     * @throws PHPUnit_Framework_AssertionFailedError if the parser returns null (it should never do this)
+     *
      * @return FeatureNode
      */
     protected function getParsedFeature()

tests/Medology/Behat/StoreContextTest.php

@@ -4,6 +4,7 @@
  * @noinspection PhpDocMissingThrowsInspection
  * @noinspection PhpUnhandledExceptionInspection
  */
+
 namespace Tests\Medology\Behat;
 
 use DateTime;
@@ -55,6 +56,7 @@ public function injectLikeSyntaxDataProvider()
 
     /**
      * @dataProvider injectLikeSyntaxDataProvider
+     *
      * @param string $string the value to pass to injectStoredValues
      */
     public function testInjectionLikeSyntaxIsNotInjected($string)
@@ -76,6 +78,7 @@ public function nonExistentItemDataProvider()
 
     /**
      * @dataProvider nonExistentItemDataProvider
+     *
      * @param string $string the value to pass to injectStoredValues
      * @param string $error  the expected Exception error message
      */
@@ -91,12 +94,13 @@ public function onGetFnWrongArgsDataProvider()
     {
         return [
             'no args'       => [function () {}],
-            'too many args' => [function (/** @scrutinizer ignore-unused */ $a, /** @scrutinizer ignore-unused */ $b) {}],
+            'too many args' => [function (/* @scrutinizer ignore-unused */ $a, /* @scrutinizer ignore-unused */ $b) {}],
         ];
     }
 
     /**
      * @dataProvider onGetFnWrongArgsDataProvider
+     *
      * @param $onGetFn
      */
     public function testOnGetFnMustTakeOneArgument($onGetFn)
@@ -115,8 +119,8 @@ public function testOnGetFnMustTakeOneArgument($onGetFn)
     public function onGetFnWrongReturnTypeDataProvider()
     {
         return [
-            'no return'       => [function (/** @scrutinizer ignore-unused */ $a) {}],
-            'return string'   => [function ($a) {
+            'no return'     => [function (/* @scrutinizer ignore-unused */ $a) {}],
+            'return string' => [function ($a) {
                 return gettype($a);
             }],
             'return function' => [function ($a) {
@@ -129,7 +133,6 @@ public function onGetFnWrongReturnTypeDataProvider()
 
     /**
      * @dataProvider onGetFnWrongReturnTypeDataProvider
-     * @param callable $onGetFn
      */
     public function testOnGetFnWrongReturnType(callable $onGetFn)
     {
@@ -268,7 +271,7 @@ function ($a, $b, $c) {
 
         // Lambda with wrong return type throws appropriate error
         $wrongReturnTypes = [
-            function (/** @scrutinizer ignore-unused */ $a, /** @scrutinizer ignore-unused */ $b) {
+            function (/* @scrutinizer ignore-unused */ $a, /* @scrutinizer ignore-unused */ $b) {
             },
             function ($a, $b) {
                 return gettype($a) . gettype($b);

tests/Medology/Behat/TypeCaster/CastStringToIntTest.php

@@ -28,8 +28,8 @@ protected function setUp()
     /**
      * Test numbers are converted properly.
      *
-     * @param $input    string The input to the conversion method.
-     * @param $expected mixed  The out put of the conversion method.
+     * @param $input    string The input to the conversion method
+     * @param $expected mixed  The out put of the conversion method
      *
      * @dataProvider conversionExamples
      */