Made classes final and added docs (#23)

* Made classes final

* style ci

* Added branch alias

Author: Nyholm

Changelog.md

@@ -2,11 +2,12 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release. 
 
-## UNRELEASED
+## 1.0.0
 
 ## Added
 
 - Extractor for classes implementing `TranslationSourceLocationContainer`
+- Made classes final 
 
 ## 0.1.1
 

composer.json

@@ -32,6 +32,11 @@
     "scripts": {
         "test": "vendor/bin/phpunit",
         "test-ci": "vendor/bin/phpunit --coverage-text --coverage-clover=build/coverage.xml"
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0-dev"
+        }
     }
 }
 

src/Extractor.php

@@ -16,7 +16,13 @@
 use Translation\Extractor\FileExtractor\FileExtractor;
 use Translation\Extractor\Model\SourceCollection;
 
-class Extractor
+/**
+ * Main class for all extractors. This is the service that will be loaded with file
+ * extractors.
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
+final class Extractor
 {
     /**
      * @var FileExtractor[]

src/FileExtractor/BladeFileExtractor.php

@@ -18,7 +18,7 @@
 /**
  * @author Tobias Nyholm <[email protected]>
  */
-class BladeFileExtractor implements FileExtractor
+final class BladeFileExtractor implements FileExtractor
 {
     public function getSourceLocations(SplFileInfo $file, SourceCollection $collection)
     {

src/FileExtractor/PHPFileExtractor.php

@@ -22,7 +22,7 @@
 /**
  * @author Tobias Nyholm <[email protected]>
  */
-class PHPFileExtractor implements FileExtractor
+final class PHPFileExtractor implements FileExtractor
 {
     /**
      * @var Visitor[]|NodeVisitor[]

src/FileExtractor/TwigFileExtractor.php

@@ -18,7 +18,7 @@
 /**
  * @author Tobias Nyholm <[email protected]>
  */
-class TwigFileExtractor implements FileExtractor
+final class TwigFileExtractor implements FileExtractor
 {
     /**
      * @var Visitor[]|\Twig_NodeVisitorInterface[]

src/Visitor/BaseVisitor.php

@@ -14,6 +14,11 @@
 use Symfony\Component\Finder\SplFileInfo;
 use Translation\Extractor\Model\SourceCollection;
 
+/**
+ * Base class for any visitor.
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
 abstract class BaseVisitor implements Visitor
 {
     /**

src/Visitor/Php/BasePHPVisitor.php

@@ -14,6 +14,11 @@
 use PhpParser\Node;
 use Translation\Extractor\Visitor\BaseVisitor;
 
+/**
+ * Base class for PHP visitors.
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
 abstract class BasePHPVisitor extends BaseVisitor
 {
     /**

src/Visitor/Php/SourceLocationContainerVisitor.php

@@ -21,7 +21,7 @@
  *
  * @author Tobias Nyholm <[email protected]>
  */
-class SourceLocationContainerVisitor extends BasePHPVisitor implements NodeVisitor
+final class SourceLocationContainerVisitor extends BasePHPVisitor implements NodeVisitor
 {
     /**
      * @var string

src/Visitor/Php/Symfony/ContainerAwareTrans.php

@@ -16,7 +16,10 @@
 use Translation\Extractor\Model\SourceLocation;
 use Translation\Extractor\Visitor\Php\BasePHPVisitor;
 
-class ContainerAwareTrans extends BasePHPVisitor implements NodeVisitor
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+final class ContainerAwareTrans extends BasePHPVisitor implements NodeVisitor
 {
     public function beforeTraverse(array $nodes)
     {