Merge pull request #29 from mdevlamynck/env-var

Add support for global variable replacement through env vars

Author: mdevlamynck

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.2.0
+
+New features:
+  * Add support for global variable replacement through env vars
+
 ## 1.1.4
 
 Bug fixes:

doc/Usage.md

@@ -153,3 +153,19 @@ It also supports variants to handle plural rules. The special variable `%count%`
 
 Finally if there is a `keyname` in the translation path, an extra function is created accepting a keyname variable to choose the translation. This is for convenience and should be used with care, if the keyname does not match any translation the function returns an empty string.
 
+## Replace variable during compile time
+
+Variables can be resolved at compile time using the `envVariables` option :
+
+```
+envVariables: {
+    '{site_name}': 'SITE_NAME', // example of variable in routing
+    '%site_name%': 'SITE_NAME', // example of variable in translation
+}
+```
+
+Values are read from `./.env.local` or `./env` :
+
+```
+SITE_NAME=value
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "elm-symfony-bridge",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "author": "Matthias Devlamynck <[email protected]>",
   "license": "MIT",
   "homepage": "https://github.com/mdevlamynck/elm-symfony-bridge#readme",
@@ -42,6 +42,6 @@
     "elm-hot": "^1.1.4",
     "elm-test": "^0.19.1-revision2",
     "elm-verify-examples": "^5.0.0",
-    "node-elm-compiler": "^5.0.4"
+    "node-elm-compiler": "^5.0.6"
   }
 }

parcel/README.md

@@ -70,13 +70,14 @@ This plugin follows parcel's zero-config philosophy and will automatically confi
 * `watchExtensions`: Which file extensions to watch (defaults to `php`, `yaml`, `yml`, `xml`)
 * `watchConfig`: Which files to watch for configuration changes (defaults to `elm.json`, `elm-package.json`, `package.json`, `composer.json`)
 * `dev`: Use symfony's env=dev or env=prod (defaults to parcel's own dev value)
-* `generatedCodeFolder`: Where to put generated code. Automatically added to your elm's `source-directories` config (defaults to `elm-stuff/generated-code/elm-symfony-bridge`)
-* `tmpFolder`: Where to put temporary (defaults to `elm-stuff/generated-code/elm-symfony-bridge`)
+* `elmRoot`: Where to put generated code. Automatically added to your elm's `source-directories` config (defaults to `elm-stuff/generated-code/elm-symfony-bridge`)
+* `outputFolder`: Where to put temporary (defaults to `elm-stuff/generated-code/elm-symfony-bridge`)
 * `elmVersion`: Elm version the generated code should be compatible with (defaults to 0.19 if a `elm.json` file is present, 0.18 if a `elm-package.json` file is present)
 * `enableRouting`: Enable generating routes (defaults to true)
 * `urlPrefix`: When dev is true, which prefix to use when generating urls (defaults to `/index.php` or `/app_dev.php` depending on which is found)
 * `enableTranslations`: Enable generating translations (defaults to true if the willdurand/js-translation-bundle package is installed)
 * `lang`: Lang to use when exporting translations (defaults to the default lang configured in symfony)
+* `envVariables`: Variables to replace during compile time
 
 If these rules don't work for you, you can override any of these parameters in your `package.json` under the `elm-symfony-bridge` key like so:
 

parcel/index.js

@@ -12,8 +12,8 @@ function run(bundler) {
         options: {
             watch: bundler.options.watch,
             dev: !bundler.options.production,
-            generatedCodeFolder: 'elm-stuff/generated-code/elm-symfony-bridge',
-            tmpFolder: 'elm-stuff/generated-code/elm-symfony-bridge',
+            elmRoot: './elm-stuff/generated-code/elm-symfony-bridge',
+            outputFolder: './elm-stuff/generated-code/elm-symfony-bridge',
             elmVersion: '0.19',
             enableRouting: true,
             urlPrefix: '/index.php',
@@ -43,6 +43,8 @@ function run(bundler) {
 function loadConfig(global) {
     global.options = utils.overrideDefaultsIfProvided(config.guessImplicit(global), global.options);
     global.options = utils.overrideDefaultsIfProvided(config.readExplicit(), global.options);
+
+    config.loadEnvVariables(global);
 }
 
 function generate(global) {
@@ -53,9 +55,9 @@ function generate(global) {
 
 function prepareFolderForGeneratedCode(global) {
     const file = global.options.elmVersion === '0.19' ? 'elm.json' : 'elm-package.json';
-    fs.editJsonFile(file, (elmConfig) => {
-        return utils.mapKey(elmConfig, 'source-directories', (sources) => {
-            return utils.arrayPushIfNotPresent(sources, global.options.generatedCodeFolder);
+    fs.editJsonFile(file, elmConfig => {
+        return utils.mapKey(elmConfig, 'source-directories', sources => {
+            return utils.arrayPushIfNotPresent(sources, global.options.elmRoot);
         });
     });
 }

parcel/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parcel-plugin-elm-symfony-bridge",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "author": "Matthias Devlamynck <[email protected]>",
   "license": "MIT",
   "homepage": "https://github.com/mdevlamynck/elm-symfony-bridge/tree/master/parcel#readme",
@@ -33,6 +33,7 @@
   },
   "dependencies": {
     "chokidar": "^3.4.0",
+    "dotenv": "^16.0.0",
     "glob": "^7.1.6"
   },
   "devDependencies": {

parcel/yarn.lock

@@ -2148,6 +2148,11 @@ dotenv-expand@^5.1.0:
   resolved "https://registry.yarnpkg.com/dotenv-expand/-/dotenv-expand-5.1.0.tgz#3fbaf020bfd794884072ea26b1e9791d45a629f0"
   integrity sha512-YXQl1DSa4/PQyRfgrv6aoNjhasp/p4qs9FjJ4q4cQk+8m4r6k4ZSiEyytKG8f8W9gi8WsQtIObNmKd+tMzNTmA==
 
+dotenv@^16.0.0:
+  version "16.0.0"
+  resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-16.0.0.tgz#c619001253be89ebb638d027b609c75c26e47411"
+  integrity sha512-qD9WU0MPM4SWLPJy/r2Be+2WgQj8plChsyrCNQzW/0WjvcJQiKQJ9mH3ZgB3fxbUUxgc/11ZJ0Fi5KiimWGz2Q==
+
 dotenv@^5.0.0:
   version "5.0.1"
   resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-5.0.1.tgz#a5317459bd3d79ab88cff6e44057a6a3fbb1fcef"

src/Main.elm

@@ -6,9 +6,11 @@ port module Main exposing (main, Msg(..), update, decodeJsValue)
 
 -}
 
-import Dict
+import Dict exposing (Dict)
+import Dict.Extra as Dict
 import Elm exposing (Version(..))
 import Json.Decode as Decode exposing (Decoder)
+import Json.Decode.Pipeline as Decode
 import Json.Encode as Encode exposing (Value)
 import Platform exposing (Program, worker)
 import Platform.Cmd exposing (Cmd)
@@ -50,6 +52,7 @@ type Msg
     = NoOp
     | TranspileRouting Routing.Command
     | TranspileTranslation Translation.Command
+    | CommandError String
 
 
 {-| Run received commands.
@@ -75,54 +78,75 @@ update message =
                 |> formatResult translation.name
                 |> encodeTranslationResult
 
+        CommandError error ->
+            Encode.object
+                [ ( "succeeded", Encode.bool False )
+                , ( "error", Encode.string error )
+                ]
+
 
 {-| Decode json commands.
 -}
 decodeJsValue : Value -> Msg
 decodeJsValue =
-    Decode.decodeValue ((Decode.dict << Decode.dict) Decode.string)
-        >> Result.toMaybe
-        >> Maybe.andThen (Dict.toList >> List.head)
-        >> Maybe.andThen
-            (\( command, commandArgs ) ->
-                let
-                    urlPrefix =
-                        Dict.get "urlPrefix" commandArgs
-
-                    fileName =
-                        Dict.get "name" commandArgs
-
-                    content =
-                        Dict.get "content" commandArgs
-
-                    version =
-                        Dict.get "version" commandArgs
-                            |> Maybe.andThen
-                                (\versionString ->
-                                    case versionString of
-                                        "0.18" ->
-                                            Just Elm_0_18
-
-                                        "0.19" ->
-                                            Just Elm_0_19
-
-                                        _ ->
-                                            Nothing
-                                )
-                in
-                case command of
-                    "routing" ->
-                        Maybe.map3 Routing.Command urlPrefix content version
-                            |> Maybe.map TranspileRouting
-
-                    "translation" ->
-                        Maybe.map3 Translation.Command fileName content version
-                            |> Maybe.map TranspileTranslation
+    Decode.decodeValue commandDecoder
+        >> Result.mapError (CommandError << Decode.errorToString)
+        >> Result.merge
+
+
+commandDecoder : Decoder Msg
+commandDecoder =
+    Decode.oneOf
+        [ routingDecoder
+        , translationDecoder
+        ]
+
+
+routingDecoder : Decoder Msg
+routingDecoder =
+    Decode.succeed TranspileRouting
+        |> Decode.required "routing"
+            (Decode.succeed Routing.Command
+                |> Decode.required "urlPrefix" Decode.string
+                |> Decode.required "content" Decode.string
+                |> Decode.required "version" versionDecoder
+                |> Decode.required "envVariables" envVariableDecoder
+            )
+
+
+translationDecoder : Decoder Msg
+translationDecoder =
+    Decode.succeed TranspileTranslation
+        |> Decode.required "translation"
+            (Decode.succeed Translation.Command
+                |> Decode.required "name" Decode.string
+                |> Decode.required "content" Decode.string
+                |> Decode.required "version" versionDecoder
+                |> Decode.required "envVariables" envVariableDecoder
+            )
+
+
+versionDecoder : Decoder Version
+versionDecoder =
+    Decode.string
+        |> Decode.andThen
+            (\versionString ->
+                case versionString of
+                    "0.18" ->
+                        Decode.succeed Elm_0_18
+
+                    "0.19" ->
+                        Decode.succeed Elm_0_19
 
                     _ ->
-                        Nothing
+                        Decode.fail <| "Unsupported version: " ++ versionString
             )
-        >> Maybe.withDefault NoOp
+
+
+envVariableDecoder : Decoder (Dict String String)
+envVariableDecoder =
+    Decode.dict (Decode.maybe Decode.string)
+        |> Decode.map (Dict.filterMap (\k maybeV -> maybeV))
 
 
 {-| Encode transpiled routing results.

src/Routing/Transpiler.elm

@@ -22,6 +22,7 @@ type alias Command =
     { urlPrefix : String
     , content : String
     , version : Version
+    , envVariables : Dict String String
     }
 
 
@@ -31,6 +32,7 @@ transpileToElm : Command -> Result String String
 transpileToElm command =
     command.content
         |> readJsonContent
+        |> Result.map (replaceEnvVariables command.envVariables)
         |> Result.andThen parseRouting
         |> Result.map (convertToElm command.version command.urlPrefix)
 
@@ -67,6 +69,15 @@ decodeRouting =
             )
 
 
+replaceEnvVariables : Dict String String -> Dict String JsonRouting -> Dict String JsonRouting
+replaceEnvVariables envVariables =
+    let
+        replace routing =
+            Dict.foldl String.replace routing envVariables
+    in
+    Dict.map (\k r -> { r | path = replace r.path })
+
+
 {-| Turns the raw extracted data into our internal representation.
 -}
 parseRouting : Dict String JsonRouting -> Result String (Dict String Routing)

src/Translation/Transpiler.elm

@@ -24,6 +24,7 @@ type alias Command =
     { name : String
     , content : String
     , version : Version
+    , envVariables : Dict String String
     }
 
 
@@ -41,6 +42,7 @@ transpileToElm : Command -> Result String File
 transpileToElm command =
     command.content
         |> readJsonContent
+        |> Result.map (replaceEnvVariables command.envVariables)
         |> Result.andThen parseTranslationDomain
         |> Result.map (convertToElm command.version)
 
@@ -108,6 +110,15 @@ readJsonContent =
             )
 
 
+replaceEnvVariables : Dict String String -> JsonTranslationDomain -> JsonTranslationDomain
+replaceEnvVariables envVariables json =
+    let
+        replace translation =
+            Dict.foldl String.replace translation envVariables
+    in
+    { json | translations = Dict.map (\k v -> replace v) json.translations }
+
+
 {-| Parses the translations into use usable type.
 -}
 parseTranslationDomain : JsonTranslationDomain -> Result String TranslationDomain