Merge pull request #26 from trogon/develop

Release 0.3.0

.gitignore

@@ -1,2 +1,3 @@
+data/
 vendor/
 coverage.xml

.vscode/launch.json

@@ -0,0 +1,22 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Listen for XDebug",
+            "type": "php",
+            "request": "launch",
+            "port": 9000
+        },
+        {
+            "name": "Launch currently open script",
+            "type": "php",
+            "request": "launch",
+            "program": "${file}",
+            "cwd": "${fileDirname}",
+            "port": 9000
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,49 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Install project",
+            "type": "shell",
+            "command": "composer install",
+            "problemMatcher": []
+        },
+        {
+            "label": "Run Unit Tests",
+            "type": "shell",
+            "command": "vendor/bin/phpunit",
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": true
+            },
+            "problemMatcher": [],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        },
+        {
+            "label": "Install Docs",
+            "type": "shell",
+            "command": "bundler install",
+            "options": {
+                "cwd": "${workspaceRoot}/docs"
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "Run Docs DEV",
+            "type": "shell",
+            "command": "bundle exec jekyll serve --config _config_dev.yml",
+            "options": {
+                "cwd": "${workspaceRoot}/docs"
+            },
+            "problemMatcher": []
+        }
+    ]
+}

README.md

@@ -33,7 +33,7 @@ Documentation available on [https://trogon.github.io/otus-pdf/](https://trogon.g
 Contributing
 ============
 
-Please read before submitting issues and pull requests the [CONTRIBUTING.md](https://github.com/trogon/otus-pdf/blob/develop/README.md) file.
+Please read before submitting issues and pull requests the [CONTRIBUTING.md](https://github.com/trogon/otus-pdf/blob/develop/CONTRIBUTING.md) file.
 
 Notice
 ============

composer.json

@@ -31,7 +31,11 @@
     ],
     "require": {
         "php": "^7.3 || ^7.2 || ^7.1 || ^7.0 || ^5.6 || ^5.5 || ^5.4",
-        "phenx/php-font-lib": "^0.5.1"
+        "phenx/php-font-lib": "^0.5.1",
+        "trogon/adobe-fonts-core14": "^1.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^7.0 || ^6.0 || ^5.0 || ^4.0"
     },
     "autoload": {
         "psr-4": {
@@ -40,10 +44,15 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "trogon\\otuspdf\\test\\": "src/test/"
+            "trogon\\otuspdf\\test\\": "tests/"
         }
     },
-    "require-dev": {
-        "phpunit/phpunit": "^7.0 || ^6.0 || ^5.0 || ^4.0"
+    "scripts": {
+        "post-package-install": [
+            "trogon\\otuspdf\\io\\FontInstaller::postPackageInstall"
+        ],
+        "install-fonts": [
+            "trogon\\otuspdf\\io\\FontInstaller::buildFontMetrics"
+        ]
     }
 }

docs/_data/api/Document.json

@@ -3,12 +3,20 @@
     "name": "Document",
     "description": "Describes single document",
     "introduced": "0.1.0",
+    "version": "0.3.0",
     "properties": [
         {
             "name": "info",
             "type": "DocumentInfo",
             "access": "Read Only",
             "description": "Stores document meta informations"
+        },
+        {
+            "name": "pages",
+            "type": "PageCollection",
+            "access": "Read Only",
+            "description": "Stores pages list",
+            "introduced": "0.2.0"
         }
     ],
     "methods": []

docs/_data/api/Page.json

@@ -0,0 +1,28 @@
+{
+    "$schema": "http://schema.trogon.eu/json/apidocs.json",
+    "name": "Page",
+    "description": "Describes single page",
+    "introduced": "0.2.0",
+    "version": "0.3.0",
+    "properties": [
+        {
+            "name": "info",
+            "type": "PageInfo",
+            "access": "Read Only",
+            "description": "Stores page meta informations"
+        },
+        {
+            "name": "items",
+            "type": "Text[]",
+            "access": "Read Only",
+            "description": "Stores page content"
+        }
+    ],
+    "methods": [
+        {
+            "name": "addText",
+            "type": "Text",
+            "description": "Append new text entry"
+        }
+    ]
+}

docs/_data/api/PageCollection.json

@@ -0,0 +1,15 @@
+{
+    "$schema": "http://schema.trogon.eu/json/apidocs.json",
+    "name": "PageCollection",
+    "description": "Describes collection of pages",
+    "introduced": "0.2.0",
+    "version": "0.3.0",
+    "properties": [],
+    "methods": [
+        {
+            "name": "add",
+            "type": "Page",
+            "description": "Append new page"
+        }
+    ]
+}

docs/_data/api/Text.json

@@ -0,0 +1,22 @@
+{
+    "$schema": "http://schema.trogon.eu/json/apidocs.json",
+    "name": "Text",
+    "description": "Describes single text block (immutable type)",
+    "introduced": "0.2.0",
+    "version": "0.3.0",
+    "properties": [
+        {
+            "name": "info",
+            "type": "TextInfo",
+            "access": "Read Only",
+            "description": "Stores text meta informations"
+        },
+        {
+            "name": "text",
+            "type": "string",
+            "access": "Read Only",
+            "description": "Stores text value"
+        }
+    ],
+    "methods": []
+}

docs/_data/api/io/DocumentWriter.json

@@ -1,19 +1,20 @@
 {
     "$schema": "http://schema.trogon.eu/json/apidocs.json",
     "name": "DocumentWriter",
-    "description": "Transform document object into PDF document",
+    "description": "Transform document object into given format using installed providers",
     "introduced": "0.1.0",
+    "version": "0.3.0",
     "properties": [],
     "methods": [
         {
             "name": "save",
             "type": "void",
-            "description": "Transform document into PDF document and saves as file in given location"
+            "description": "Transform document into given format and saves as file in given location"
         },
         {
             "name": "toString",
             "type": "string",
-            "description": "Transform document into PDF document and returns as binary string"
+            "description": "Transform document into given format and returns as binary string"
         }
     ]
 }

docs/_data/api/io/PdfDocumentWriter.json

@@ -0,0 +1,19 @@
+{
+    "$schema": "http://schema.trogon.eu/json/apidocs.json",
+    "name": "PdfDocumentWriter",
+    "description": "Document writer provider. Transforms document object into PDF document",
+    "introduced": "0.3.0",
+    "properties": [],
+    "methods": [
+        {
+            "name": "save",
+            "type": "void",
+            "description": "Transform document into PDF document and saves as file in given location"
+        },
+        {
+            "name": "toString",
+            "type": "string",
+            "description": "Transform document into PDF document and returns as binary string"
+        }
+    ]
+}