Add composer package (#82)

* Initial commit.

Spec.php, composer.json, types.php, LICENSE added
README.md: Added composer package instructions
.gitignore: Added standard ignore statements for most composer packages
Build.php: Added writePHPObject() function to create the types.php file
package-lock.json: Did NOT bump version

* Requested changes to README.md

Author: anchovie91471

.gitignore

@@ -1,3 +1,6 @@
 node_modules
 /lib
-/coverage
+/coverage
+/vendor/
+composer.phar
+/.idea

Build.php

@@ -69,6 +69,7 @@ public function __construct()
             $this->writeReadme($table);
         }
         $this->writeTypeScript();
+        $this->writePHPObject();
     }
 
     /**
@@ -182,6 +183,33 @@ private function writeTypeScript(): void
         $json = file_get_contents('./data/types.json');
         file_put_contents('./src/types.ts', 'export const types = ' . $json . ';');
     }
+
+    private function writePHPObject(): void
+    {
+        // Fetch the JSON file
+        $jsonData = file_get_contents('./data/types.json');
+        if ($jsonData === false) {
+            die("Error fetching JSON file.");
+        }
+
+        // Decode JSON data
+        $dataObject = json_decode($jsonData);
+        if ($dataObject === null) {
+            die("Error decoding JSON data.");
+        }
+
+        // Prepare the PHP content
+        $phpContent = "<?php\n\n" . 'return ' . var_export($dataObject, true) . ";\n";
+
+        // Write to types.php in the src directory
+        $fileWritten = file_put_contents(__DIR__ . '/src/types.php', $phpContent);
+
+        if ($fileWritten === false) {
+            die("Error writing to types.php.");
+        }
+
+        echo "types.php successfully written.\n";
+    }
 }
 
 new Build();

LICENSE

@@ -0,0 +1,26 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michael Dowling <mtdowling@gmail.com>
+Copyright (c) 2015 Márk Sági-Kazár <mark.sagikazar@gmail.com>
+Copyright (c) 2015 Graham Campbell <hello@gjcampbell.co.uk>
+Copyright (c) 2016 Tobias Schultze <webmaster@tubo-world.de>
+Copyright (c) 2016 George Mponos <gmponos@gmail.com>
+Copyright (c) 2018 Tobias Nyholm <tobias.nyholm@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -276,3 +276,93 @@ Some possible next steps for this format include:
 - contact information for following up on issues with feed or meeting info
 - language split out into its own fields
 - indication of which language was used for geocoding
+
+## Use the Spec in your code
+
+### PHP
+***
+### Code4Recovery Spec Composer Package
+
+This package contains a class that makes the most up-to-date meeting types available to your application. Updates are released anytime new meeting types are added.
+
+### Installation
+```shell
+composer require code4recovery/spec
+```
+
+### Get all available languages
+Returns an array of all available languages for types can be translated into. The array is keyed by language code and has the expanded language name as the value.
+```php
+$spec::getLanguages();
+```
+Example returned value
+```php
+[
+    'en' => 'English',
+    'es' => 'Español',
+    'fr' => 'Français',
+    'ja' => '日本語',
+    'sv' => 'Svenska',
+];
+```
+
+### Get all types
+Returns an object containing all current meeeting types in every language.
+```php
+$spec::getAllTypes();
+```
+Example returned value (truncated)
+```php
+{
+  "11": {
+    "en": "11th Step Meditation",
+    "es": "Meditación del Paso 11",
+    "fr": "Méditation sur la 11e Étape",
+    "ja": "ステップ11 黙想",
+    "sv": "11th Stegs Meditation"
+  },
+   "12x12": {
+    "en": "12 Steps & 12 Traditions",
+    "es": "12 Pasos y 12 Tradiciones",
+    "fr": "12 Étapes et 12 Traditions",
+    "ja": "12のステップと12の伝統",
+    "sv": "12 Steg & 12 Traditioner"
+  },
+  ...
+};
+```
+
+### Get types by language
+Returns an array of types translated into a specified language. Pass the desired language key as a string ('en', 'es', 'fr', etc.)
+
+```php
+$spec::getTypesByLanguage('en');
+```
+Example returned value
+```php
+[
+    11 => "11th Step Meditation"
+    "12x12" => "12 Steps & 12 Traditions"
+    "A" => "Secular"
+    "ABSI" => "As Bill Sees It"
+    ...
+];
+```
+
+### Typescript/Javascript
+***
+
+### Installation
+```shell
+npm i @code4recovery/spec
+```
+
+### Usage
+```shell
+import { getTypesForLanguage } from '@code4recovery/spec';
+
+const types = getTypesForLanguage('en');
+```
+
+## License
+Code4Recovery Spec is made available under the MIT License (MIT). Please see [License File](LICENSE) for more information.

composer.json

@@ -0,0 +1,19 @@
+{
+    "name": "code4recovery/spec",
+    "description": "The goal of the Meeting Guide API is help sync information about AA meetings. It was developed for the Meeting Guide app, but it is non-proprietary and other systems are encouraged to make use of it.",
+    "require": {
+        "php": ">=7.4",
+        "ext-json": "*"
+    },
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Code4Recovery\\": "src"
+        }
+    },
+    "authors": [
+        {
+            "name": "Code for Recovery"
+        }
+    ]
+}

src/Spec.php

@@ -0,0 +1,58 @@
+<?php
+
+class Spec
+{
+    private static array $languages = [
+        'en' => 'English',
+        'es' => 'Español',
+        'fr' => 'Français',
+        'ja' => '日本語',
+        'sv' => 'Svenska',
+    ];
+
+    /**
+     * Get all languages.
+     *
+     * Retrieves and returns all languages with language code and expanded language translation that is stored
+     * in the type repository.
+     *
+     * @return string[]
+     */
+    public static function getLanguages(): array
+    {
+        return self::$languages;
+    }
+
+    /**
+     * Get all types.
+     *
+     * Retrieves and returns all types stored in the type repository.
+     *
+     * @return object The array of all types.
+     */
+    public static function getAllTypes (): object
+    {
+        $types = include 'types.php';
+        return $types;
+    }
+
+    /**
+     * Returns an array of types translated into the specified language.
+     *
+     * @param string $language The language code to retrieve the translations
+     *     for.
+     *
+     * @return array An array of type translations in the specified language.
+     */
+    public static function getTypesByLanguage(string $language): array
+    {
+        $typesByLanguage = [];
+        $types = self::getAllTypes();
+        foreach ($types as $typeKey => $typeTranslations) {
+            if (isset($typeTranslations->$language)) {
+                $typesByLanguage[$typeKey] = $typeTranslations->$language;
+            }
+        }
+        return $typesByLanguage;
+    }
+}

src/languages.ts

@@ -1 +1 @@
-export const languages = ["en", "es", "fr", "ja", "sv"] as const;
+export const languages = ["en","es","fr","ja","sv"] as const;