initial commit

Author: Raphaël Droz

.gitattributes

@@ -0,0 +1,7 @@
+/tests/         export-ignore
+/phpunit.xml    export-ignore
+.*              export-ignore
+phpcs.xml       export-ignore
+
+# Set the line ending configuration
+* text=lf

.gitignore

@@ -0,0 +1,11 @@
+vendor
+composer.lock
+*.cache
+
+# Eclipse-specific files
+/.settings/
+/.buildpath
+/.project
+
+# PhpStorm-specific files
+/.idea/

.travis.yml

@@ -0,0 +1,12 @@
+language: php
+sudo: false
+
+php:
+  - 7.2
+  - 7.3
+
+before_install:
+  - composer install
+
+script: 
+  - composer test

CHANGELOG.md

@@ -0,0 +1,77 @@
+# Twig Scanner
+
+[![Latest Version on Packagist][ico-version]][link-packagist]
+[![Software License][ico-license]](LICENSE)
+[![Build Status][ico-travis]][link-travis]
+[![Quality Score][ico-scrutinizer]][link-scrutinizer]
+[![Total Downloads][ico-downloads]][link-downloads]
+
+Created by Raphaël Droz <raphael.droz@gmail.com> (GPL-3 License)
+
+Twig code scanner to use with [gettext/gettext](https://github.com/php-gettext/Gettext)
+
+## Warning
+
+In order to be usable, upstream ParsedFunction class at php-gettext/Gettext must be slightly modified to ease inheritance.
+
+## Installation
+
+```
+composer require gettext/twig-scanner
+```
+
+## About dependencies
+
+We do not require a **specific** version of Twig.
+
+ToDo: Support symfony/twig-bridge `trans` filter.
+
+## Usage example
+
+```php
+use Gettext\Scanner\TwigScanner;
+use Gettext\Generator\PoGenerator;
+use Gettext\Translations;
+
+//Create a new scanner, adding a translation for each domain we want to get:
+$twigScanner = new TwigScanner(
+    Translations::create('domain1'),
+    Translations::create('domain2'),
+    Translations::create('domain3')
+);
+
+//Set a default domain, so any translations with no domain specified, will be added to that domain
+$twigScanner->setDefaultDomain('domain1');
+
+//Extract all comments starting with 'notes:'
+$twigScanner->extractCommentsStartingWith('notes:');
+
+//Scan files
+foreach (glob('*.twig') as $file) {
+    $twigScanner->scanFile($file);
+}
+
+//Save the translations in .po files
+$generator = new PoGenerator();
+
+foreach ($twigScanner->getTranslations() as $domain => $translations) {
+    $generator->generateFile($translations, "locales/{$domain}.po");
+}
+```
+
+---
+
+Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes.
+
+The GPL-3 License (GPL-3). Please see [LICENSE](LICENSE) for more information.
+
+[ico-version]: https://img.shields.io/packagist/v/drzraf/twig-scanner.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-GPLv3-brightgreen.svg?style=flat-square
+[ico-travis]: https://img.shields.io/travis/drzraf/Twig-Scanner/master.svg?style=flat-square
+[ico-scrutinizer]: https://img.shields.io/scrutinizer/g/drzraf/Twig-Scanner.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/packagist/dt/drzraf/twig-scanner.svg?style=flat-square
+
+[link-packagist]: https://packagist.org/packages/drzraf/twig-scanner
+[link-travis]: https://travis-ci.org/drzraf/Twig-Scanner
+[link-scrutinizer]: https://scrutinizer-ci.com/g/drzraf/Twig-Scanner
+[link-downloads]: https://packagist.org/packages/drzraf/twig-scanner

LICENSE

@@ -0,0 +1,43 @@
+{
+    "name": "drzraf/twig-scanner",
+    "type": "library",
+    "description": "Twig scanner for gettext",
+    "keywords": ["twig", "gettext", "i18n", "translation", "scanner"],
+    "homepage": "https://github.com/drzraf/twig-scanner",
+    "license": "GPL-3.0-or-later",
+    "authors": [
+        {
+            "name": "Raphaël Droz",
+            "email": "raphael.droz@gmail.com",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^7.2",
+        "gettext/gettext": "^5.2.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8.0",
+        "squizlabs/php_codesniffer": "^3.0",
+        "oscarotero/php-cs-fixer-config": "^1.0",
+        "friendsofphp/php-cs-fixer": "^2.15",
+	"timber/timber": "^1.8"
+    },
+    "autoload": {
+        "psr-4": {
+            "Gettext\\Scanner\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Gettext\\Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": [
+            "phpunit",
+            "phpcs"
+        ],
+        "cs-fix": "php-cs-fixer fix"
+    }
+}

README.md

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<ruleset name="Gettext coding standard">
+    <description>Gettext coding standard</description>
+
+    <!-- display progress -->
+    <arg value="p"/>
+    <arg name="colors"/>
+
+    <!-- coding standard -->
+    <rule ref="PSR2"/>
+
+    <!-- Paths to check -->
+    <file>src</file>
+</ruleset>

composer.json

@@ -0,0 +1,12 @@
+<phpunit bootstrap="./vendor/autoload.php">
+	<testsuites>
+		<testsuite name="All tests">
+			<directory>./tests/</directory>
+		</testsuite>
+	</testsuites>
+	<filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

phpcs.xml

@@ -0,0 +1,84 @@
+<?php
+
+/**
+ * Copyright (C) 2018-2020 raphael.droz@gmail.com
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ */
+
+declare(strict_types = 1);
+
+namespace Gettext\Scanner;
+
+/**
+ * ToDo: Don't make Gettext\Scanner\ParsedFunction final
+ */
+class ParsedFunction2 extends ParsedFunction
+{
+    const ALLOWED_PROTOTYPES = [
+        'gettext',
+        'dgettext',
+        'pgettext',
+        'dpgettext',
+        'ngettext',
+        'dngettext',
+        'npgettext',
+        'dnpgettext',
+        'ngettext',
+        'dngettext',
+        'npgettext',
+        'dnpgettext',
+    ];
+
+    private $prototype = null;
+
+    /**
+     * In order for TwigScanner to inherit CodeScanner.php, the mappings must be self-contained within
+     * the CodeScanner::$functions property.
+     *
+     * Storing the official gettext function allows TwigFunctionScanner...
+     * 1. To keep track of the original function name (not hijacking of the $name property)
+     * 2. To avoid hardcoding wp-specific function.
+     * 3. To store the prototype in order to obtain their handlers.
+     */
+    public function setPrototype(?string $prototype)
+    {
+        if ($prototype && !in_array($prototype, self::ALLOWED_PROTOTYPES, true)) {
+            throw new Exception('Not a valid gettext function');
+        }
+        $this->prototype = $prototype;
+        return $this;
+    }
+
+    public function getPrototype() : ?string
+    {
+        return $this->prototype;
+    }
+
+    public function hasDomain() : bool
+    {
+        return $this->prototype && substr($this->prototype, 0, 1) === 'd';
+    }
+
+    /**
+     * Transform prototype (eg: 'gettext') to its domain-counterpart (eg 'dgettext').
+     */
+    public function setDomain()
+    {
+        if ($this->prototype) {
+            $this->prototype = 'd' . ltrim($this->prototype, 'd');
+        }
+        return $this;
+    }
+
+    /**
+     * The opposite of setDomain()
+     */
+    public function unsetDomain()
+    {
+        $this->prototype = ltrim($this->prototype, 'd');
+        return $this;
+    }
+}