feat(standards): updated the code to follow the coding standards and added circle.ci tests

Author: Mikolaj Misiurewicz

.circleci/config.yml

@@ -0,0 +1,39 @@
+version: 2.1
+
+commands:
+  composer:
+    description: 'Configure & Install vendor packages'
+    steps:
+      - restore_cache:
+          key: composer
+      - run: composer self-update
+      - run: 'curl -H "Authorization: token $COMPOSER_TOKEN" https://api.github.com/rate_limit'
+      - run: composer config --global github-oauth.github.com $COMPOSER_TOKEN
+      - run: composer install --no-interaction --no-progress
+      - save_cache:
+          key: composer
+          paths:
+            - ~/.composer/
+  checks:
+    description: 'Run checks'
+    steps:
+      - run: make all
+
+jobs:
+  checks:
+    docker:
+      - image: markupglasgow/php:7.1-cli-composer
+    steps:
+      - checkout
+      - composer
+      - checks
+
+workflows:
+  version: 2
+  checks:
+    jobs:
+      - checks:
+          filters:
+            tags:
+              # ensures the CI runs for tags, see https://discuss.circleci.com/t/builds-for-tags-not-triggering/17681/2
+              only: /.*/

Makefile

@@ -0,0 +1,16 @@
+.PHONY: all
+default: all;
+
+analysis:
+	vendor/bin/phpstan.phar analyse -c phpstan.neon ./src --level 7
+
+unit:
+	vendor/bin/phpunit --no-coverage
+
+standards:
+	vendor/bin/phpcs -p --colors --standard=ruleset.xml ./src
+
+mess:
+	vendor/bin/phpmd ./src text phpmd.xml
+
+all: analysis unit standards mess

README.md

@@ -1,7 +1,11 @@
 {
     "name": "markup/needle-bundle",
     "description": "A Symfony bundle for search. Defines a standard search query builder (including filters and faceting), and integrates with different backends (currently Solr and Elastic).",
-    "keywords": ["search", "faceting", "solr"],
+    "keywords": [
+        "search",
+        "faceting",
+        "solr"
+    ],
     "type": "symfony-bundle",
     "license": "MIT",
     "authors": [
@@ -47,7 +51,14 @@
         }
     ],
     "autoload": {
-        "psr-4": { "Markup\\NeedleBundle\\": "" }
+        "psr-4": {
+            "Markup\\NeedleBundle\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Markup\\NeedleBundle\\Tests\\": "Tests"
+        }
     },
     "extra": {
         "branch-alias": {

composer.json

@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<ruleset name="needle"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
+         xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
+    <description>Needle Ruleset</description>
+
+    <rule ref="vendor/markup/coding-standard/phpmd.xml">
+        <exclude name="ElseExpression"/>
+        <exclude name="CouplingBetweenObjects"/>
+        <exclude name="CyclomaticComplexity"/>
+        <exclude name="BooleanGetMethodName"/>
+        <exclude name="ExcessiveMethodLength"/>
+        <exclude name="NPathComplexity"/>
+        <exclude name="LongVariable"/>
+    </rule>
+</ruleset>

phpmd.xml

@@ -1,13 +1,7 @@
 parameters:
     excludes_analyse:
-        - %currentWorkingDirectory%/DependencyInjection/Configuration.php
-        - %currentWorkingDirectory%/Tests/*
-        - %currentWorkingDirectory%/vendor/*
-        - %currentWorkingDirectory%/bin/*
+        - */DependencyInjection/Configuration.php
     ignoreErrors:
         - '#Query::addDocuments\(\) expects array#'
-        - '#Class Symfony\\Component\\DependencyInjection\\ChildDefinition not found#'
-        - '#Class Symfony\\Component\\DependencyInjection\\DefinitionDecorator not found#'
-        - '#Access to undefined constant Symfony\\Component\\DependencyInjection\\ContainerInterface::SCOPE_PROTOTYPE#'
     reportUnmatchedIgnoredErrors: false
     inferPrivatePropertyTypeFromConstructor: true

phpstan.neon

@@ -8,14 +8,4 @@
         </testsuite>
     </testsuites>
 
-    <filter>
-        <whitelist>
-            <directory>./</directory>
-            <exclude>
-                <directory>./Resources</directory>
-                <directory>./Tests</directory>
-                <directory>./vendor</directory>
-            </exclude>
-        </whitelist>
-    </filter>
 </phpunit>

phpunit.xml.dist

@@ -4,18 +4,8 @@
 
     <config name="ignore_warnings_on_exit" value="true"/>
 
-    <arg name="tab-width" value="4"/>
-    <arg name="encoding" value="utf-8"/>
-
     <rule ref="vendor/markup/coding-standard/Markup/ruleset.xml"/>
 
-    <!-- Use Unix newlines -->
-    <rule ref="Generic.Files.LineEndings">
-        <properties>
-            <property name="eolChar" value="\n"/>
-        </properties>
-    </rule>
-
     <!--Override to disable Fie length checks-->
     <rule ref="Generic.Files.LineLength">
         <severity>4</severity>
@@ -24,6 +14,7 @@
     <rule ref="Markup.Doctrine.EntityManager.EntityManagerFound"/>
     <rule ref="Markup.Doctrine.PreventInheritanceOfDoctrine.EntityRepositoryFound"/>
 
-    <exclude-pattern>Tests/*</exclude-pattern>
-    <exclude-pattern>vendor/*</exclude-pattern>
+    <rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue.NullabilitySymbolRequired">
+        <type>warning</type>
+    </rule>
 </ruleset>

ruleset.xml

@@ -22,7 +22,7 @@ public function __construct(PromiseInterface $resultPromise)
     /**
      * Returns the number of results.
      *
-     * @return integer The number of results.
+     * @return int The number of results.
      */
     public function getNbResults()
     {
@@ -32,8 +32,8 @@ public function getNbResults()
     /**
      * Returns an slice of the results.
      *
-     * @param integer $offset The offset.
-     * @param integer $length The length.
+     * @param int $offset The offset.
+     * @param int $length The length.
      *
      * @return array|\Traversable The slice.
      */