Skip to content

Commit

Permalink
added phpcs
Browse files Browse the repository at this point in the history
  • Loading branch information
eerison committed Dec 19, 2020
1 parent ef26df9 commit c38108d
Show file tree
Hide file tree
Showing 12 changed files with 64 additions and 38 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ jobs:
- name: Install npm dependencies
run: composer install

- name: Run lint
run: php -v
- name: Run code sniffer
run: make phpcs

- name: Run tests
run: make test
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@ vendor/
.phpunit.result.cache
coverage.xml
###< phpunit ###

###> phpcs ###
.phpcs-cache
###< phpcs ###
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@ init:
composer install

test:
vendor/bin/phpunit --coverage-clover coverage.xml --testdox
vendor/bin/phpunit --coverage-clover coverage.xml --testdox

phpcs:
vendor/bin/phpcs
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
"doctrine/annotations": "^1.11"
},
"require-dev": {
"phpunit/phpunit": "^8"
"phpunit/phpunit": "^8",
"squizlabs/php_codesniffer": "^3.5"
},
"autoload": {
"psr-4": {
Expand Down
16 changes: 16 additions & 0 deletions phpcs.xml.dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>

<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">

<arg name="basepath" value="."/>
<arg name="cache" value=".phpcs-cache"/>
<arg name="colors"/>
<arg name="extensions" value="php"/>

<rule ref="PSR12"/>
<rule ref="Squiz.NamingConventions.ValidVariableName.NotCamelCaps"/>

<file>src/</file>

</ruleset>
2 changes: 1 addition & 1 deletion src/Enum/Status.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
class Status
{
public const ASSEMBLY_COMPLETED = 'ASSEMBLY_COMPLETED';
}
}
3 changes: 1 addition & 2 deletions src/Exception/AnyStepAddedException.php
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<?php


namespace Transloadit\Exception;

use Exception;

class AnyStepAddedException extends Exception implements TransloaditExceptionInterface
{

}
}
4 changes: 1 addition & 3 deletions src/Exception/TransloaditExceptionInterface.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
<?php


namespace Transloadit\Exception;


interface TransloaditExceptionInterface
{

}
}
12 changes: 9 additions & 3 deletions src/Factory/SerializerFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,14 @@ final class SerializerFactory
public static function create(): Serializer
{
$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
$metadataAwareNameConverter = new MetadataAwareNameConverter($classMetadataFactory, new CamelCaseToSnakeCaseNameConverter());
$metadataAwareNameConverter = new MetadataAwareNameConverter(
$classMetadataFactory,
new CamelCaseToSnakeCaseNameConverter()
);

return new Serializer([new ObjectNormalizer($classMetadataFactory, $metadataAwareNameConverter)], [new JsonEncoder()]);
return new Serializer(
[new ObjectNormalizer($classMetadataFactory, $metadataAwareNameConverter)],
[new JsonEncoder()]
);
}
}
}
22 changes: 11 additions & 11 deletions src/Model/Assembly.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,30 +21,30 @@ public function __construct(Parameter $parameter = null)
private $id;

/**
* @Groups({"read", "write"})
* @Groups({"read", "write"})
* @SerializedName("params")
* @var Parameter
* @var Parameter
*/
private $parameter;

/**
* @Groups("read")
* @SerializedName("assembly_url")
* @var string
* @var string
*/
private $url;

/**
* @Groups("read")
* @SerializedName("assembly_ssl_url")
* @var string
* @var string
*/
private $sslUrl;

/**
* @Groups("read")
* @SerializedName("ok")
* @var string
* @var string
*/
private $status;

Expand All @@ -57,7 +57,7 @@ public function getId(): string
}

/**
* @param string $id
* @param string $id
* @return Assembly
*/
public function setId(string $id): Assembly
Expand All @@ -75,7 +75,7 @@ public function getParameter(): Parameter
}

/**
* @param Parameter $parameter
* @param Parameter $parameter
* @return Assembly
*/
public function setParameter(Parameter $parameter): Assembly
Expand All @@ -94,7 +94,7 @@ public function getUrl(): string
}

/**
* @param string $url
* @param string $url
* @return Assembly
*/
public function setUrl(string $url): Assembly
Expand All @@ -112,7 +112,7 @@ public function getSslUrl(): string
}

/**
* @param string $sslUrl
* @param string $sslUrl
* @return Assembly
*/
public function setSslUrl(string $sslUrl): Assembly
Expand All @@ -130,12 +130,12 @@ public function getStatus(): string
}

/**
* @param string $status
* @param string $status
* @return Assembly
*/
public function setStatus(string $status): Assembly
{
$this->status = $status;
return $this;
}
}
}
23 changes: 11 additions & 12 deletions src/Model/Parameter.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,25 @@ class Parameter

/**
* @Groups({"read", "write"})
* @var string|null
* @var string|null
*/
private $templateId;

/**
* @Groups({"read", "write"})
* @var string|null
* @var string|null
*/
private $notifyUrl;

/**
* @Groups({"read", "write"})
* @var array|null
* @var array|null
*/
private $fields;

/**
* @Groups({"read", "write"})
* @var bool|null
* @var bool|null
*/
private $allowStepsOverride;

Expand All @@ -45,9 +45,8 @@ public function getSteps(): array
}

/**
* @Groups({"read", "write"})
* @Groups({"read", "write"})
* @SerializedName("steps")
*
*/
public function getStepsData()
{
Expand All @@ -61,7 +60,7 @@ public function getStepsData()
}

/**
* @param Step $step
* @param Step $step
* @return Parameter
*/
public function addStep(Step $step): Parameter
Expand All @@ -82,7 +81,7 @@ public function getTemplateId(): ?string
}

/**
* @param string|null $templateId
* @param string|null $templateId
* @return Parameter
*/
public function setTemplateId(?string $templateId): Parameter
Expand All @@ -100,7 +99,7 @@ public function getNotifyUrl(): ?string
}

/**
* @param string|null $notifyUrl
* @param string|null $notifyUrl
* @return Parameter
*/
public function setNotifyUrl(?string $notifyUrl): Parameter
Expand All @@ -118,7 +117,7 @@ public function getFields(): ?array
}

/**
* @param array|null $fields
* @param array|null $fields
* @return Parameter
*/
public function setFields(?array $fields): Parameter
Expand All @@ -136,12 +135,12 @@ public function getAllowStepsOverride(): ?bool
}

/**
* @param bool|null $allowStepsOverride
* @param bool|null $allowStepsOverride
* @return Parameter
*/
public function setAllowStepsOverride(?bool $allowStepsOverride): Parameter
{
$this->allowStepsOverride = $allowStepsOverride;
return $this;
}
}
}
4 changes: 2 additions & 2 deletions src/Model/Step.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public function getName(): string
}

/**
* @param string $name
* @param string $name
* @return Step
*/
public function setName(string $name): Step
Expand All @@ -47,7 +47,7 @@ public function getValue()
}

/**
* @param array|string $value
* @param array|string $value
* @return Step
*/
public function setValue($value)
Expand Down

0 comments on commit c38108d

Please sign in to comment.