test

doc/en-US.md

@@ -24,6 +24,11 @@ Request content:
 let hello_world = bundle_asset.content("hello-world")?;
 ```
 
+## File formats
+
+- `ResourceAsset` have to be `FTL`.
+- `BundlesAsset` files may be `YAML` or `RON`
+
 ## Definitions
 [`BundleAsset`][bundle-asset] - is an abstraction for presentation
 [`FluentBundle`][fluent-bundle]. A *bundles* file has the extension `.ftl.ron`

examples/complex/assets/locales/monolingual/.ftl.yml

@@ -0,0 +1,3 @@
+en-US: [en-US/main.ftl]
+ru-BY: [ru/ru-BY/main.ftl]
+ru-RU: [ru/ru-RU/main.ftl]

examples/complex/assets/locales/multilingual/.ftl.ron

@@ -0,0 +1,5 @@
+{
+    "*de-DE": ["de-DE.ftl"],
+    "en-US": ["en-US.ftl"],
+    "ru-RU": ["ru-RU.ftl"],
+}

examples/complex/assets/locales/multilingual/de-DE.ftl

@@ -0,0 +1 @@
+hello-world = hallo welt

examples/complex/assets/locales/multilingual/ru-RU.ftl

@@ -0,0 +1 @@
+hello-world = привет мир

examples/complex/main.rs

@@ -0,0 +1,98 @@
+use bevy::{asset::LoadState, prelude::*};
+use bevy_fluent::{
+    assets::bundles::{Locale, Settings},
+    prelude::*,
+};
+use fluent_content::Content;
+use unic_langid::langid;
+
+// Locale fallback chain.
+pub fn main() {
+    App::new()
+        .add_plugins((
+            DefaultPlugins.set(AssetPlugin {
+                file_path: "examples/complex/assets".to_string(),
+                ..default()
+            }),
+            FluentPlugin,
+        ))
+        .add_systems(Update, (monolingual, multilingual))
+        .run();
+}
+
+// Loads locales fallback chain bundle (monolingual) by settings.
+// - Note: the `BundlesAsset` file uses the yaml format.
+fn monolingual(
+    asset_server: Res<AssetServer>,
+    assets: Res<Assets<BundlesAsset>>,
+    mut handle: Local<Option<Handle<BundlesAsset>>>,
+) {
+    let handle = &*handle.get_or_insert_with(|| {
+        asset_server.load_with_settings(
+            "locales/monolingual/.ftl.yml",
+            |settings: &mut Settings| {
+                settings.locales.push(Locale {
+                    requested: vec![langid!("ru")],
+                    default: Some(langid!("en-US")),
+                    ..default()
+                });
+            },
+        )
+    });
+    if let Some(LoadState::Loaded) = asset_server.get_load_state(handle) {
+        let bundles = assets.get(handle).unwrap();
+        assert_eq!(bundles.len(), 1);
+        assert_eq!(bundles["ru"].locales, ["ru-RU", "ru-BY", "en-US"]);
+        // From ru-RU bundle, the first in fallback chain.
+        assert_eq!(bundles.content("hello").unwrap(), "привет");
+        // From ru-BY bundle, the second in fallback chain.
+        assert_eq!(bundles.content("world").unwrap(), "свету");
+        // From en-US bundle, the last in fallback chain, default locale.
+        assert_eq!(bundles.content("bevy").unwrap(), "bevy");
+    }
+}
+
+// Loads locales fallback chain bundles (multilingual) by settings.
+// - Note: the `BundlesAsset` file contains default locale selector ("de-DE").
+//   But the locale "ru" overrides it to "en-US" via settings.
+fn multilingual(
+    asset_server: Res<AssetServer>,
+    assets: Res<Assets<BundlesAsset>>,
+    mut handle: Local<Option<Handle<BundlesAsset>>>,
+) {
+    let handle = &*handle.get_or_insert_with(|| {
+        asset_server.load_with_settings(
+            "locales/multilingual/.ftl.ron",
+            |settings: &mut Settings| {
+                settings.locales = vec![
+                    Locale {
+                        requested: vec![langid!("de")],
+                        ..default()
+                    },
+                    Locale {
+                        requested: vec![langid!("en")],
+                        ..default()
+                    },
+                    Locale {
+                        requested: vec![langid!("ru")],
+                        default: Some(langid!("en-US")),
+                        ..default()
+                    },
+                ];
+            },
+        )
+    });
+    if let Some(LoadState::Loaded) = asset_server.get_load_state(handle) {
+        let bundles = assets.get(handle).unwrap();
+        assert_eq!(bundles.len(), 3);
+        assert_eq!(bundles["de"].locales, ["de-DE"]);
+        assert_eq!(bundles["en"].locales, ["en-US", "de-DE"]);
+        assert_eq!(bundles["ru"].locales, ["ru-RU", "en-US"]);
+        // From de-DE bundle.
+        assert_eq!(bundles["de"].content("hello-world").unwrap(), "hallo welt");
+        // From en-US bundle.
+        assert_eq!(bundles["en"].content("hello-world").unwrap(), "hello world");
+        // From ru-RU bundle.
+        assert_eq!(bundles["ru"].content("hello-world").unwrap(), "привет мир");
+    }
+}

examples/trivial/assets/locales/en-US.ftl

@@ -0,0 +1 @@
+hello-world = hello world

examples/trivial/assets/locales/ru-RU.ftl

@@ -0,0 +1 @@
+hello-world = привет мир

examples/trivial/assets/locales/with_default.ftl.ron

@@ -0,0 +1,4 @@
+{
+    "*en-US": ["en-US.ftl"],
+    "ru-RU": ["ru-RU.ftl"],
+}

examples/multilingual/assets/locales/.ftl.ron → examples/trivial/assets/locales/without_default.ftl.ron

@@ -1,5 +1,4 @@
 {
-    "de-DE": ["de-DE.ftl"],
     "en-US": ["en-US.ftl"],
     "ru-RU": ["ru-RU.ftl"],
 }

examples/trivial/main.rs

@@ -0,0 +1,76 @@
+use bevy::{asset::LoadState, prelude::*};
+use bevy_fluent::prelude::*;
+use fluent_content::Content;
+
+// Single locale.
+pub fn main() {
+    App::new()
+        .add_plugins((
+            DefaultPlugins.set(AssetPlugin {
+                file_path: "examples/trivial/assets".to_string(),
+                ..default()
+            }),
+            FluentPlugin,
+        ))
+        .add_systems(Update, (empty, selector, label))
+        .run();
+}
+
+// Loads a bundle without everything.
+// - Note: no default locale selector is set, no label is set, no settings are
+//   set. In this case `BundlesAsset` will be empty.
+fn empty(
+    asset_server: Res<AssetServer>,
+    assets: Res<Assets<BundlesAsset>>,
+    mut handle: Local<Option<Handle<BundlesAsset>>>,
+) {
+    let handle =
+        &*handle.get_or_insert_with(|| asset_server.load("locales/without_default.ftl.ron"));
+    if let Some(LoadState::Loaded) = asset_server.get_load_state(handle) {
+        let bundles = assets.get(handle).unwrap();
+        assert_eq!(bundles.len(), 0);
+    }
+}
+
+// Loads a bundle using a default locale selector.
+// - Note: the default locale selector is set ("en-US").
+fn selector(
+    asset_server: Res<AssetServer>,
+    assets: Res<Assets<BundlesAsset>>,
+    mut handle: Local<Option<Handle<BundlesAsset>>>,
+) {
+    let handle = &*handle.get_or_insert_with(|| asset_server.load("locales/with_default.ftl.ron"));
+    if let Some(LoadState::Loaded) = asset_server.get_load_state(handle) {
+        let bundles = assets.get(handle).unwrap();
+        assert_eq!(bundles.len(), 1);
+        assert_eq!(bundles[0].locales, ["en-US"]);
+        assert_eq!(bundles.content("hello-world").unwrap(), "hello world");
+    }
+}
+
+// Loads a bundle using a label.
+// - Note: whether a default locale selector is set or not, the bandle will be
+//   loaded by label.
+fn label(
+    asset_server: Res<AssetServer>,
+    assets: Res<Assets<BundlesAsset>>,
+    mut ru: Local<Option<Handle<BundlesAsset>>>,
+    mut en: Local<Option<Handle<BundlesAsset>>>,
+) {
+    let handle =
+        &*en.get_or_insert_with(|| asset_server.load("locales/without_default.ftl.ron#en-US"));
+    if let Some(LoadState::Loaded) = asset_server.get_load_state(handle) {
+        let bundles = assets.get(handle).unwrap();
+        assert_eq!(bundles.len(), 1);
+        assert_eq!(bundles[0].locales, ["en-US"]);
+        assert_eq!(bundles.content("hello-world").unwrap(), "hello world");
+    }
+    let handle =
+        &*ru.get_or_insert_with(|| asset_server.load("locales/with_default.ftl.ron#ru-RU"));
+    if let Some(LoadState::Loaded) = asset_server.get_load_state(handle) {
+        let bundles = assets.get(handle).unwrap();
+        assert_eq!(bundles.len(), 1);
+        assert_eq!(bundles[0].locales, ["ru-RU"]);
+        assert_eq!(bundles.content("hello-world").unwrap(), "привет мир");
+    }
+}

examples/ui/assets/locales/.ftl.ron

@@ -3,5 +3,5 @@
     "en-US": ["en-US/menu/ui.ftl"],
     "ru-BY": ["ru/ru-BY/menu/ui.ftl"],
     "ru-RU": ["ru/ru-RU/menu/ui.ftl"],
-    "und": ["und/menu/locales.ftl"],
+    "*und": ["und/menu/locales.ftl"],
 }