Commit ⋅ mpociot/laravel-apidoc-generator

Showing 4 of 4 files from the diff.

94.59% 100.00% -1.96% 15 -8

src/Tools/Traits/ParamHelpers.php changed.

100.00% ø ø 24 5

src/Tools/Generator.php changed.

96.00% ø ø 8 0

src/Tools/RouteDocBlocker.php changed.

Newly tracked file

100.00% 100.00% ø 3 ø

src/Tools/Traits/DocBlockParamHelpers.php changed.

@@ -6,7 +6,7 @@


trait ParamHelpers
{
    protected  function generateDummyValue(string $type)
    protected function generateDummyValue(string $type)
    {
        $faker = Factory::create();
        if ($this->config->get('faker_seed')) {

@@ -49,7 +49,7 @@

     *
     * @return mixed
     */
    protected  function castToType(string $value, string $type)
    protected function castToType(string $value, string $type)
    {
        $casts = [
            'integer' => 'intval',

@@ -175,7 +175,7 @@


    /**
     * For each array notation parameter (eg user.*, item.*.name, object.*.*, user[])
     * generate concrete sample (user.0, item.0.name, object.0.0, user.0) with example as value
     * generate concrete sample (user.0, item.0.name, object.0.0, user.0) with example as value.
     *
     * @param string $paramName
     * @param mixed $paramExample

@@ -13,8 +13,9 @@

    /**
     * @param Route $route
     *
     * @return array<string, DocBlock> Method and class docblocks
     * @throws \ReflectionException
     *
     * @return array<string, DocBlock> Method and class docblocks
     */
    public static function getDocBlocksFromRoute(Route $route): array
    {

@@ -2,9 +2,6 @@


namespace Mpociot\ApiDoc\Tools\Traits;

use Faker\Factory;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Mpociot\Reflection\DocBlock\Tag;

trait DocBlockParamHelpers

@@ -19,7 +16,7 @@

     *
     * @return bool Whether no example should be generated
     */
    protected  function shouldExcludeExample(Tag $tag)
    protected function shouldExcludeExample(Tag $tag)
    {
        return strpos($tag->getContent(), ' No-example') !== false;
    }

@@ -33,7 +30,7 @@

     *
     * @return array The description and included example.
     */
    protected  function parseParamDescription(string $description, string $type)
    protected function parseParamDescription(string $description, string $type)
    {
        $example = null;
        if (preg_match('/(.*)\s+Example:\s*(.*)\s*/', $description, $content)) {

Files		•	•	•	Complexity	Coverage
src	766	696	0	70	315	90.86%
Project Totals (19 files)	766	696	0	70	315	90.86%

TRAVIS_PHP_VERSION=7.1.3
TRAVIS_OS_NAME=linux

View CI Build Download

TRAVIS_PHP_VERSION=7.2.0
TRAVIS_OS_NAME=linux

View CI Build Download

TRAVIS_PHP_VERSION=7.2.0
TRAVIS_OS_NAME=linux

View CI Build Download

TRAVIS_PHP_VERSION=7.1.3
TRAVIS_OS_NAME=linux

View CI Build Download

TRAVIS_PHP_VERSION=7.2.0
TRAVIS_OS_NAME=linux

View CI Build Download

TRAVIS_PHP_VERSION=7.0.0
TRAVIS_OS_NAME=linux

View CI Build Download

TRAVIS_PHP_VERSION=7.2.0
TRAVIS_OS_NAME=linux

View CI Build Download

TRAVIS_PHP_VERSION=7.0.0
TRAVIS_OS_NAME=linux

View CI Build Download

TRAVIS_PHP_VERSION=7.0.0
TRAVIS_OS_NAME=linux

View CI Build Download

TRAVIS_PHP_VERSION=7.1.3
TRAVIS_OS_NAME=linux

View CI Build Download

No yaml found.

Create your codecov.yml to customize your Codecov experience

Read the docs

Interact now

The inner-most circle is the entire project, moving away from the center are folders then, finally, a single file. The size and color of each slice is representing the number of statements and the coverage, respectively.

SVG

The top section represents the entire project. Proceeding with folders and finally individual files. The size and color of each slice is representing the number of statements and the coverage, respectively.

SVG

Each block represents a single file in the project. The size and color of each block is represented by the number of statements and the coverage, respectively.

SVG

Learn more about the coverage sunburst graph

49	49		*
50	50		* @return mixed
51	51		*/
52		-	protected function castToType(string $value, string $type)
	52	+	protected function castToType(string $value, string $type)
53	53		{
54	54		$casts = [
55	55		'integer' => 'intval',

175	175
176	176		/**
177	177		* For each array notation parameter (eg user., item..name, object.., user[])
178		-	* generate concrete sample (user.0, item.0.name, object.0.0, user.0) with example as value
	178	+	* generate concrete sample (user.0, item.0.name, object.0.0, user.0) with example as value.
179	179		*
180	180		* @param string $paramName
181	181		* @param mixed $paramExample

Navigation	Overlay
`t` Navigate files	`h` Toggle hits
`y` Change url to tip of branch	`m` Toggle misses
`b / v` Jump to prev/next hit line	`p` Toggle partial
`z / x` Jump to prev/next missed or partial line	`1..9` Toggle flags
`shift + o` Open current page in GitHub	`a` Toggle all on
`/ or ?` Show keyboard shortcuts dialog	`c` Toggle context lines or commits

6	6
7	7		trait ParamHelpers
8	8		{
9		-	protected function generateDummyValue(string $type)
	9	+	protected function generateDummyValue(string $type)
10	10		{
11	11		$faker = Factory::create();
12	12		if ($this->config->get('faker_seed')) {

13	13		/**
14	14		* @param Route $route
15	15		*
16		-	* @return array<string, DocBlock> Method and class docblocks
17	16		* @throws \ReflectionException
	17	+	*
	18	+	* @return array<string, DocBlock> Method and class docblocks
18	19		*/
19	20		public static function getDocBlocksFromRoute(Route $route): array
20	21		{

2	2
3	3		namespace Mpociot\ApiDoc\Tools\Traits;
4	4
5		-	use Faker\Factory;
6		-	use Illuminate\Support\Arr;
7		-	use Illuminate\Support\Str;
8	5		use Mpociot\Reflection\DocBlock\Tag;
9	6
10	7		trait DocBlockParamHelpers

19	16		*
20	17		* @return bool Whether no example should be generated
21	18		*/
22		-	protected function shouldExcludeExample(Tag $tag)
	19	+	protected function shouldExcludeExample(Tag $tag)
23	20		{
24	21		return strpos($tag->getContent(), ' No-example') !== false;
25	22		}

33	30		*
34	31		* @return array The description and included example.
35	32		*/
36		-	protected function parseParamDescription(string $description, string $type)
	33	+	protected function parseParamDescription(string $description, string $type)
37	34		{
38	35		$example = null;
39	36		if (preg_match('/(.)\s+Example:\s(.)\s/', $description, $content)) {

Updating our web app

No yaml found.