Initial commit

threesquared · threesquared · commit 40a72d0ca5c1 · 2018-02-05T09:40:42.000Z
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+.idea
+vendor
+composer.lock
+_ide_helper.php
+*.sublime-*
diff --git a/README.md b/README.md
@@ -1,2 +1,51 @@
-# laravel-javascript-lang
-Laravel package that exposes translations and routes to JavaScript
+# Laravel JavaScript Lang
+
+[![Packagist](https://img.shields.io/packagist/v/Pod-Point/laravel-javascript-lang.svg)](https://packagist.org/packages/pod-point/laravel-javascript-lang)
+
+A Laravel package that exposes translations to JavaScript.
+
+## Installation
+
+Require the package in composer:
+
+```javascript
+"require": {
+    "pod-point/laravel-javascript-lang": "^1.0"
+},
+```
+
+Add the service provider to your `config/app.php` providers array:
+
+```php
+'providers' => [
+    PodPoint\JsLang\Providers\ServiceProvider::class
+]
+```
+
+Then finally, publish the config files:
+
+```php
+php artisan vendor:publish --provider=PodPoint\JsLang\Providers\ServiceProvider
+```
+
+## Usage
+
+Now the varable `$jslang` is available in your view. We recommend attaching it to a data tag on your body element:
+
+```html
+<body data-jslang='{{ $jslang }}'>
+```
+
+There is a provided JavaScript module with a helper method you can use to retrieve the translations:
+
+```js
+import jsLang from '../lib/jslang';
+
+const string = jsLang.get('orders.form.error');
+```
+
+Or you can get the data yourself:
+
+```js
+JSON.parse(document.body.getAttribute('data-jslang'))
+```
diff --git a/assets/jsLang.js b/assets/jsLang.js
@@ -0,0 +1,17 @@
+export default {
+
+    /**
+     * Fetches a translation by key if it exists.
+     *
+     * @param form
+     */
+    get: key => {
+        const messages = JSON.parse(document.body.getAttribute('data-jslang'));
+
+        if (typeof messages[key] === 'undefined') {
+            return key;
+        }
+
+        return messages[key];
+    },
+};
diff --git a/composer.json b/composer.json
@@ -0,0 +1,23 @@
+{
+  "name": "pod-point/laravel-javascript-lang",
+  "description": "Laravel package that exposes translations and routes to JavaScript",
+  "keywords": ["laravel", "javascript", "language", "translations", "routes"],
+  "type": "library",
+  "require": {
+    "php": ">=5.5.9",
+    "illuminate/support": "5.1.*|5.2.*|5.3.*|5.4.*|5.5.*"
+  },
+  "license": "MIT",
+  "autoload": {
+    "psr-4": {
+      "PodPoint\\JsLang\\": "src/"
+    }
+  },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "PodPoint\\JsLang\\Providers\\ServiceProvider"
+      ]
+    }
+  }
+}
diff --git a/config/javascript.php b/config/javascript.php
@@ -0,0 +1,19 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Javascript Language Strings
+    |--------------------------------------------------------------------------
+    |
+    | An array of language strings that should be available to JS via the
+    | jslang module.
+    |
+    */
+
+    'lang' => [
+        'validation',
+    ],
+
+];
diff --git a/src/Providers/ServiceProvider.php b/src/Providers/ServiceProvider.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace PodPoint\JsLang\Providers;
+
+use Illuminate\Support\ServiceProvider as LaravelServiceProvider;
+use Illuminate\Contracts\View\Factory;
+use PodPoint\JsLang\ViewComposers\ViewComposer;
+
+class ServiceProvider extends LaravelServiceProvider
+{
+    /**
+     * Bootstrap the application events.
+     *
+     * @param Factory $view
+     * @return void
+     */
+    public function boot(Factory $view)
+    {
+        $this->publishes([
+            __DIR__ . '/../config/javascript.php' => config_path('javascript.php'),
+        ]);
+
+        $view->composer('*', ViewComposer::class);
+    }
+}
diff --git a/src/ViewComposers/ViewComposer.php b/src/ViewComposers/ViewComposer.php
@@ -0,0 +1,55 @@
+<?php
+
+namespace PodPoint\JsLang\ViewComposers;
+
+use Illuminate\Contracts\View\View;
+
+class ViewComposer
+{
+    /**
+     * Binds the data to the view.
+     *
+     * @param View $view
+     */
+    public function compose(View $view)
+    {
+        $keys = config('javascript.lang');
+        $data = [];
+
+        foreach ($keys as $value) {
+            $trans = trans($value);
+
+            if (is_array($trans)) {
+                $data = array_merge($data, $this->transArray($trans, $value));
+            } else {
+                $data[$value] = trans($value);
+            }
+        }
+
+        $view->with([
+            'jslang' => json_encode($data)
+        ]);
+    }
+
+    /**
+     * Translates an array of options with a prefix
+     *
+     * @param  array  $array
+     * @param  string $prefix
+     * @return array
+     */
+    private function transArray(array $array, $prefix)
+    {
+        $data = [];
+
+        foreach ($array as $key => $value) {
+            if (is_array($value)) {
+                $data = array_merge($data, $this->transArray($value, $prefix . '.' . $key));
+            } else {
+                $data[$prefix . '.' . $key] = trans($value);
+            }
+        }
+
+        return $data;
+    }
+}
