Kern046 / changelog-parser

src/Manager/ChangelogManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
     
     /**
      * @param string $storagePath
-     * @return \ChangelogParser\Driver\Driver
+     * @return ChangelogManager
      */
     public function setStoragePath($storagePath) {
         $this->storagePath = $storagePath;

Spacing +4 added lines, -4 removed lines

@@ -38,7 +38,7 @@ 
      */
     public function getLastVersion($filepath, $format = 'json') {
         $cacheFile = "last-version-$format";
-        if(($cache = $this->cacheManager->getCache($filepath, $cacheFile)) !== false) {
+        if (($cache = $this->cacheManager->getCache($filepath, $cacheFile)) !== false) {
             return $cache;
         }
         $this->initializeDriver($format);
@@ -55,7 +55,7 @@ 
      */
     public function getAllVersions($filepath, $format = 'json') {
         $cacheFile = "all-versions-$format";
-        if(($cache = $this->cacheManager->getCache($filepath, $cacheFile)) !== false) {
+        if (($cache = $this->cacheManager->getCache($filepath, $cacheFile)) !== false) {
             return $cache;
         }
         $this->initializeDriver($format);
@@ -72,12 +72,12 @@ 
     public function initializeDriver($format) {
         $driverClass = 'ChangelogParser\\Driver\\' . ucfirst($format) . 'Driver';
         
-        if(!class_exists($driverClass)) {
+        if (!class_exists($driverClass)) {
             throw new \InvalidArgumentException('The requested format is not supported');
         }
         
         $this->driver = new $driverClass();
-        if($this->storagePath !== null) {
+        if ($this->storagePath !== null) {
             $this->driver->setStoragePath($this->storagePath);
         }
     }

src/Parser/Parser.php

Spacing +9 added lines, -9 removed lines

@@ -15,7 +15,7 @@ 
      * @return array
      */
     public function parse($filepath) {
-        foreach($this->parseFile($filepath) as $line) {
+        foreach ($this->parseFile($filepath) as $line) {
             $this->parseLine($line);
         }
         return $this->releases;
@@ -26,11 +26,11 @@ 
      * @throws \RuntimeException
      */
     private function parseFile($filepath) {
-        if(($file = fopen($filepath, 'r')) === false) {
+        if (($file = fopen($filepath, 'r')) === false) {
             throw new \RuntimeException("The file $filepath does not exist");
         }
         
-        while($line = fgets($file)) {
+        while ($line = fgets($file)) {
             yield $line;
         }
         fclose($file);
@@ -40,7 +40,7 @@ 
      * @param string $line
      */
     private function parseLine($line) {
-        switch($line{0}) {
+        switch ($line{0}) {
             case '#':
                 $this->parseTitle($line);
                 break;
@@ -54,15 +54,15 @@ 
      * @param string $line
      */
     private function parseTitle($line) {
-        for($i = 0; $i < 3; ++$i) {
-            if($line{$i} !== '#') {
+        for ($i = 0; $i < 3; ++$i) {
+            if ($line{$i} !== '#') {
                 break;
             }
         }
-        switch($i) {
+        switch ($i) {
             case 2:
                 $parts = explode('-', $line);
-                if(count($parts) === 1) {
+                if (count($parts) === 1) {
                     $this->currentRelease = $this->formatReleaseVersion($line);
                     break;
                 }
@@ -89,6 +89,6 @@ 
      * @param string $line
      */
     private function parseItem($line) {
-        $this->releases[$this->currentRelease]['items'][$this->currentReleasePart][] = trim(substr($line,1));
+        $this->releases[$this->currentRelease]['items'][$this->currentReleasePart][] = trim(substr($line, 1));
     }
 }
\ No newline at end of file

src/Driver/JsonDriver.php

Spacing +2 added lines, -2 removed lines

@@ -21,8 +21,8 @@
     public final function getLastVersion() {
         $data = json_decode($this->getAllVersions(), true);
         
-        foreach($data as $version => $changelog) {
-            if($version === 'unreleased') {
+        foreach ($data as $version => $changelog) {
+            if ($version === 'unreleased') {
                 continue;
             }
             return json_encode([$version => $changelog]);

src/Driver/Driver.php

Spacing +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
      * @param mixed $data
      */
     protected function storeResults($data) {
-        if(is_file($this->storagePath)) {
+        if (is_file($this->storagePath)) {
             unlink($this->storagePath);
         }
         file_put_contents($this->storagePath, $data);

Doc Comments +3 added lines, -3 removed lines

@@ -38,12 +38,12 @@ 
     abstract protected function formatData($data);
     
     /**
-     * @return mixed
+     * @return string
      */
     abstract protected function getLastVersion();
     
     /**
-     * @return mixed
+     * @return string
      */
     abstract protected function getAllVersions();
     
@@ -56,7 +56,7 @@ 
     }
     
     /**
-     * @param mixed $data
+     * @param string $data
      */
     protected function storeResults($data) {
         if(is_file($this->storagePath)) {

example/index.php

Spacing +1 added lines, -1 removed lines

@@ -6,6 +6,6 @@
 
 $manager = new ChangelogManager();
 // Set the cache validity time to one day
-$manager->getCacheManager()->setCacheTime(60*60*24);
+$manager->getCacheManager()->setCacheTime(60 * 60 * 24);
 echo $manager->getLastVersion(__DIR__ . '/EXAMPLE_CHANGELOG.md') . "\n";
 echo $manager->getAllVersions(__DIR__ . '/EXAMPLE_CHANGELOG.md') . "\n";
\ No newline at end of file

src/Manager/CacheManager.php

Spacing +2 added lines, -2 removed lines

@@ -38,7 +38,7 @@ 
      */
     public function getCache($changelogFile, $cacheFile) {
         $path = $this->generateCachePath($changelogFile, $cacheFile);
-        if(!is_file($path) || ($generationTime = filemtime($path)) === false || $generationTime < (time() - $this->cacheTime)) {
+        if (!is_file($path) || ($generationTime = filemtime($path)) === false || $generationTime < (time() - $this->cacheTime)) {
             clearstatcache(true, $path);
             return false;
         }
@@ -55,6 +55,6 @@ 
     public function generateCachePath($changelogFile, $cacheFile) {
         $changelogSignature = str_replace([':', ' ', '/', '\\'], '-', strtolower(basename(dirname($changelogFile)) . '-' . basename($changelogFile, 'md')));
         
-        return realpath(__DIR__ . "/../../data/cache"). '/' . $changelogSignature . "-$cacheFile.cache";
+        return realpath(__DIR__ . "/../../data/cache") . '/' . $changelogSignature . "-$cacheFile.cache";
     }
 }
\ No newline at end of file