Merge branch 'master' of github.com:mediact/dependency-guard

* 'master' of github.com:mediact/dependency-guard:
  Expand guidelines
  Deleted feature request template
  Simplify bug report template
  Add known limitations
  Add badges for downloads and license
  Fix fread call when file size is zero
  Add CONTRIBUTING.md
  Update bug_report.md
  Add issue templates
  Create CODE_OF_CONDUCT.md

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+# Description
+
+[Description of the issue]
+
+# Steps to Reproduce
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+**Expected behavior:** [What you expect to happen]
+
+**Actual behavior:** [What actually happens]
+
+**Reproduces how often:** [What percentage of the time does it reproduce?]
+
+# Versions
+
+You can get this information from copy and pasting the output of:
+
+* As dependency: `composer show mediact/dependency-guard | grep version`
+* As root package: `composer show --self | grep version`
+

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing to DependencyGuard
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+The following is a set of guidelines for contributing to DependencyGuard.
+These are mostly guidelines, not rules.
+Use your best judgment, and feel free to propose changes to this document in a
+pull request.
+
+# Code of Conduct
+
+This project and everyone participating in it is governed by the
+[Code of Conduct](CODE_OF_CONDUCT.md).
+
+By participating, you are expected to uphold this code.
+Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
+
+# How Can I Contribute?
+
+## Reporting Bugs
+
+This section guides you through submitting a bug report.
+Following these guidelines helps maintainers and the community understand your
+report :pencil:, reproduce the behavior :computer: :computer:, and find related
+reports :mag_right:.
+
+> **Note:** If you find a **Closed** issue that seems like it is the same thing
+that you're experiencing, open a new issue and include a link to the original
+issue in the body of your new one.
+
+Please use the following as guidelines to write a bug report:
+
+### Please describe the found bug
+A clear and concise description of what the problem is.
+
+> I'm always frustrated when [...]
+
+### Describe the solution you'd like
+A clear and concise description of what you want to happen.
+
+> I would like the following changes to be made, in order to achieve [...]
+
+### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+> I have considered using **X** with **Y**, yet [...]
+
+### Additional context
+
+Add any other context or screenshots about the feature request here.
+
+![Dependency Guard: JSON format](docs/composer-dependency-guard-json.png)
+
+## Pull Requests
+
+* Do not include issue numbers in the pull request title.
+* Include screenshots and animated GIFs in your pull request whenever possible.
+* Follow the style guides in this document.
+* Add two of the following reviewers:
+  * Ashoka de Wit
+  * Jan-Marten de Boer
+* Ensure Scrutinizer CI runs successfully.
+  [![Build Status](https://scrutinizer-ci.com/g/mediact/dependency-guard/badges/build.png?b=master)](https://scrutinizer-ci.com/g/mediact/dependency-guard/build-status/master)
+* Ensure code coverage stays the same or increases.
+  [![Code Coverage](https://scrutinizer-ci.com/g/mediact/dependency-guard/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/mediact/dependency-guard/?branch=master)
+* Ensure code quality stays the same or improves.
+  [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mediact/dependency-guard/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mediact/dependency-guard/?branch=master)
+
+
+## Styleguides
+
+### PHP
+
+The package
+[`mediact/testing-suite`](https://packagist.org/packages/mediact/testing-suite)
+is installed, ensuring code style and standards, as well as quality.
+
+To locally test using the testing suite, use the following:
+
+```
+vendor/bin/grumphp run
+```
+
+This will run GrumPHP using the tests set by the testing suite.
+
+### 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 issues and pull requests liberally after the first line

README.md

@@ -1,10 +1,12 @@
-
+[![Packagist](https://img.shields.io/packagist/dt/mediact/dependency-guard.png)](https://packagist.org/packages/mediact/dependency-guard/stats)
 [![Packagist](https://img.shields.io/packagist/v/mediact/dependency-guard.png)](https://packagist.org/packages/mediact/dependency-guard)
 [![PHP from Packagist](https://img.shields.io/packagist/php-v/mediact/dependency-guard.png)](https://packagist.org/packages/mediact/dependency-guard)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mediact/dependency-guard/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mediact/dependency-guard/?branch=master)
 [![Code Coverage](https://scrutinizer-ci.com/g/mediact/dependency-guard/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/mediact/dependency-guard/?branch=master)
 [![Build Status](https://scrutinizer-ci.com/g/mediact/dependency-guard/badges/build.png?b=master)](https://scrutinizer-ci.com/g/mediact/dependency-guard/build-status/master)
 [![Code Intelligence Status](https://scrutinizer-ci.com/g/mediact/dependency-guard/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence)
+[![license](https://img.shields.io/github/license/mediact/dependency-guard.png)](LICENSE.md)
+
 
 # Introduction
 
@@ -152,3 +154,59 @@ The configuration above will ignore violations for the following packages:
 - `acme/tnt`
 - `symfony/console`
 - `league/flysystem`
+
+# Known limitations
+
+Some scenarios cannot be covered by Dependency Guard, in its current form.
+Known limitations are listed below:
+
+## 🦊 Pokémon exception handling combined with integration tests
+
+[Pókemon exception handling](http://wiki.c2.com/?PokemonExceptionHandling) is also known as:
+
+- :stars: [Yoda Exception Handling](http://wiki.c2.com/?YodaExceptionHandling)
+- :trollface: [Error Hiding](https://en.wikipedia.org/wiki/Error_hiding)
+- :poop: [Diaper pattern](http://mike.pirnat.com/2009/05/09/the-diaper-pattern-stinks/)
+
+This methodology catches any and all exceptions and either forwards them or ignores them:
+
+```php
+<?php
+try {
+    doSomething();
+} catch (Throwable $exception) {
+    // Do nothing.
+}
+```
+
+When this is used to handle exceptions in an application, the following issue is caused by
+running integration tests on that code.
+
+When the test sets an expectation / assertion, the assertion may fail. When the assertion
+fails, it throws a corresponding exception, which is meant to be caught by the test framework.
+
+Instead it is caught by the exception handling as described above. To counteract this, the
+following ends up in production code:
+
+```php
+<?php
+try {
+    doSomething();
+} catch (\PHPUnit\Framework\AssertionFailedError $assertionException) {
+    // Re-throw the exception, as it is part of the testing framework.
+    throw $assertionException;
+} catch (Throwable $exception) {
+    // Do nothing.
+}
+```
+
+The code above causes DependencyGuard, to detect that
+`\PHPUnit\Framework\AssertionFailedError` is a symbol that can only be available when
+a development installation is used. It may be expected that, since this symbol is only
+used within a `catch`, it is not "really" a dependency, as it will only be autoloaded
+when that specific `catch` is reached. DependencyGuard does no such specific inspection
+of the symbol at hand. The exception is thus marked as dependency violation.
+
+There are currently no plans to solve this. That being said, pull requests and open
+discussions on this matter are welcomed.
+

src/Php/SymbolExtractor.php

@@ -49,10 +49,11 @@ public function extract(
 
         foreach ($files as $file) {
             try {
+                $size     = $file->getSize();
                 $handle   = $file->openFile('rb');
-                $contents = $handle->fread($file->getSize());
+                $contents = $size  > 0 ? $handle->fread($size) : '';
 
-                if (!$contents) { // phpstan thinks this can only return string.
+                if (empty($contents)) {
                     continue;
                 }
 

tests/Php/SymbolExtractorTest.php

@@ -45,7 +45,7 @@ public function testConstructor(): void
 
     /**
      * @dataProvider emptyProvider
-     * @dataProvider unparsableFilesProvider
+     * @dataProvider nonParsingFilesProvider
      * @dataProvider filledFilesProvider
      *
      * @param Parser                $parser
@@ -115,14 +115,20 @@ public function emptyProvider(): array
             ->with(self::anything());
 
         return [
-            [$parser, $this->createFileIterator()]
+            [$parser, $this->createFileIterator()],
+            [
+                $parser,
+                $this->createFileIterator(
+                    $this->createFile('')
+                )
+            ]
         ];
     }
 
     /**
      * @param string $content
      *
-     * @return SplFileInfo|\PHPUnit_Framework_MockObject_MockObject
+     * @return SplFileInfo
      */
     private function createFile(string $content): SplFileInfo
     {
@@ -141,7 +147,7 @@ private function createFile(string $content): SplFileInfo
             ->method("getSize")
             ->willReturn(\strlen($content));
 
-        $handle = $this->getMockBuilder(\SplFileObject::class)
+        $handle = $this->getMockBuilder(SplFileObject::class)
             ->enableOriginalConstructor()
             ->setConstructorArgs([tempnam(sys_get_temp_dir(), "")])
             ->getMock();
@@ -160,7 +166,7 @@ private function createFile(string $content): SplFileInfo
     /**
      * @return Parser[][]|FileIteratorInterface[][]
      */
-    public function unparsableFilesProvider(): array
+    public function nonParsingFilesProvider(): array
     {
         $parser = $this->createMock(Parser::class);