Add public API

Author: theodorejb

README.md

@@ -1,14 +1,25 @@
-# handlebars.php
+# PHP Handlebars Parser
 
-Parse and render [Handlebars](https://handlebarsjs.com) templates with PHP.
+Parse [Handlebars](https://handlebarsjs.com) templates to a spec-compliant AST with PHP.
 
 ## Installation
 
-`composer require devtheorem/handlebars.php`
+`composer require devtheorem/php-handlebars-parser`
 
 ## Usage
 
-Todo
+```php
+use DevTheorem\HandlebarsParser\ParserFactory;
+
+$parser = (new ParserFactory())->create();
+
+$template = "Hello {{name}}!";
+
+$result = $parser->parse($template);
+```
+
+If the template contains invalid syntax, an exception will be thrown.
+Otherwise, `$result` will contain a `DevTheorem\HandlebarsParser\Ast\Program` instance.
 
 ## Author
 

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "devtheorem/handlebars-parser",
+    "name": "devtheorem/php-handlebars-parser",
     "description": "Parse Handlebars templates to a spec-compliant AST with PHP.",
     "keywords": [
         "Handlebars",

composer.lock

@@ -5,27 +5,27 @@ $meta #
 #semval(%n) $stackPos-(%l-%n)
 #semval(%n,%t) $stackPos-(%l-%n)
 
-namespace DevTheorem\Handlebars;
-
-use DevTheorem\Handlebars\Ast\ArrayLiteral;
-use DevTheorem\Handlebars\Ast\BooleanLiteral;
-use DevTheorem\Handlebars\Ast\CloseBlock;
-use DevTheorem\Handlebars\Ast\CommentStatement;
-use DevTheorem\Handlebars\Ast\ContentStatement;
-use DevTheorem\Handlebars\Ast\Hash;
-use DevTheorem\Handlebars\Ast\HashLiteral;
-use DevTheorem\Handlebars\Ast\HashPair;
-use DevTheorem\Handlebars\Ast\InverseChain;
-use DevTheorem\Handlebars\Ast\NullLiteral;
-use DevTheorem\Handlebars\Ast\NumberLiteral;
-use DevTheorem\Handlebars\Ast\OpenBlock;
-use DevTheorem\Handlebars\Ast\OpenHelper;
-use DevTheorem\Handlebars\Ast\OpenPartialBlock;
-use DevTheorem\Handlebars\Ast\PartialStatement;
-use DevTheorem\Handlebars\Ast\PathSegment;
-use DevTheorem\Handlebars\Ast\StringLiteral;
-use DevTheorem\Handlebars\Ast\SubExpression;
-use DevTheorem\Handlebars\Ast\UndefinedLiteral;
+namespace DevTheorem\HandlebarsParser;
+
+use DevTheorem\HandlebarsParser\Ast\ArrayLiteral;
+use DevTheorem\HandlebarsParser\Ast\BooleanLiteral;
+use DevTheorem\HandlebarsParser\Ast\CloseBlock;
+use DevTheorem\HandlebarsParser\Ast\CommentStatement;
+use DevTheorem\HandlebarsParser\Ast\ContentStatement;
+use DevTheorem\HandlebarsParser\Ast\Hash;
+use DevTheorem\HandlebarsParser\Ast\HashLiteral;
+use DevTheorem\HandlebarsParser\Ast\HashPair;
+use DevTheorem\HandlebarsParser\Ast\InverseChain;
+use DevTheorem\HandlebarsParser\Ast\NullLiteral;
+use DevTheorem\HandlebarsParser\Ast\NumberLiteral;
+use DevTheorem\HandlebarsParser\Ast\OpenBlock;
+use DevTheorem\HandlebarsParser\Ast\OpenHelper;
+use DevTheorem\HandlebarsParser\Ast\OpenPartialBlock;
+use DevTheorem\HandlebarsParser\Ast\PartialStatement;
+use DevTheorem\HandlebarsParser\Ast\PathSegment;
+use DevTheorem\HandlebarsParser\Ast\StringLiteral;
+use DevTheorem\HandlebarsParser\Ast\SubExpression;
+use DevTheorem\HandlebarsParser\Ast\UndefinedLiteral;
 #include;
 
 /* This is an automatically GENERATED file, which should not be manually edited.

grammar/parser.template

@@ -0,0 +1,11 @@
+<?php
+
+namespace DevTheorem\HandlebarsParser;
+
+class ParserFactory
+{
+    public function create(): Parser
+    {
+        return new Parser(new Lexer());
+    }
+}

src/ParserFactory.php

@@ -3,8 +3,7 @@
 namespace DevTheorem\HandlebarsParser\Test;
 
 use DevTheorem\HandlebarsParser\Ast\Program;
-use DevTheorem\HandlebarsParser\Lexer;
-use DevTheorem\HandlebarsParser\Parser;
+use DevTheorem\HandlebarsParser\ParserFactory;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
@@ -37,7 +36,7 @@ public static function jsonSpecProvider(): array
     #[DataProvider("jsonSpecProvider")]
     public function testSpecs(array $spec): void
     {
-        $parser = new Parser(new Lexer());
+        $parser = (new ParserFactory())->create();
 
         try {
             $result = $parser->parse($spec['template']);