seiten 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f11b589f94032def9f0ef35b5fd457e1acb0f3508cf39f1ac63fb0338ee8217a
-  data.tar.gz: 71e0543f85e054dac2cf348e6e9ecf1eebde83d1659921dca8c4460a734665b6
+  metadata.gz: '09cdd9e8323ed21cafe0eb5f92544ee05a8e78bc86b421a0fb2bfc6c865ecd8b'
+  data.tar.gz: f9860ca8c46a06a36136a992e078be502c81fba45373c5feae6682a5fb431e8e
 SHA512:
-  metadata.gz: 186fe751f440f15e30944acc416a9dfac931bcf1afd0f65c4f58ba5b6e7c8a0ebd3fab9e8ad39260c39aebc26de7769cb5b829c4b05c7f35c30407806a97577a
-  data.tar.gz: 133f9dd5ac075f2805088865e309183c453a2e889b0cc090c970db1e94076e603f4a60a8f249685b97d674741b857a6e78112ce33f356c0e3aaaa64e73b1d8b5
+  metadata.gz: 4ab559c9fb74b3373ddb9b31485dd4d78b56bcab9dbd1c1e863bafcf0a60c1a4cfb502728ea763db6e7b81ca9b1ff9d3c17d529fcf5b7b8c0bf226cca5316e6d
+  data.tar.gz: 4525be586db9bba6d0c8b1589d7297680b411523874c4fae5ed73dbb3ebff0445a65c7a27c22c65612c29c2dd525a30de5c845482c2cafef044824c8e7acc426

data/lib/seiten/railtie.rb

@@ -3,5 +3,8 @@ module Seiten
     config.action_dispatch.rescue_responses.merge!(
       'Seiten::Errors::RoutingError' => :not_found
     )
+
+    # Navigations built from I18n follow reloaded translations in development.
+    config.to_prepare { Seiten.reset_i18n_navigations! }
   end
 end

data/lib/seiten/version.rb

@@ -1,3 +1,3 @@
 module Seiten
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/seiten.rb

@@ -21,6 +21,7 @@ module Seiten
     config_dir: File.join('config', 'navigations'),
     pages_dir:  File.join('app', 'pages'),
     root_page: 'home',
+    i18n_scope: 'navigations',
     default_layout: 'application',
     html: {
       navigation: {
@@ -45,6 +46,9 @@ module Seiten
   }
 
   @navigations = []
+  @i18n_files = {}
+  @i18n_navigations = nil
+  @i18n_lock = Mutex.new
 
   class << self
     def config
@@ -52,6 +56,7 @@ module Seiten
     end
 
     def navigations
+      build_i18n_navigations unless @i18n_navigations
       @navigations
     end
 
@@ -59,14 +64,67 @@ module Seiten
       @navigations = navigations
     end
 
+    # config/navigations/<name>.<locale>.yml holds one locale's navigation; <name>.yml holds the pages
+    # of every locale, with titles and slugs from I18n (built on first use, see #i18n_pages).
     def initialize_navigations
       Dir[File.join(Rails.root, Seiten.config[:config_dir], "*.yml")].each do |file|
-        id     = File.basename(file, '.yml')
-        name   = id.gsub(/\..*/, '')
-        locale = id.gsub(/.*\./, '')
-        navigation = Seiten::Navigation.new(name: name, locale: locale, dir: File.join(Rails.root, Seiten.config[:pages_dir], name, locale))
-        navigation.page_collection.build(pages: YAML.load_file(navigation.config))
-        Seiten.navigations << navigation
+        id = File.basename(file, '.yml')
+        if id.include?('.')
+          name, locale = id.split('.', 2)
+          navigation = Seiten::Navigation.new(name: name, locale: locale, dir: File.join(Rails.root, Seiten.config[:pages_dir], name, locale))
+          navigation.page_collection.build(pages: YAML.load_file(navigation.config))
+          @navigations << navigation
+        else
+          @i18n_files[id] = file
+        end
+      end
+    end
+
+    # Drops the navigations built from I18n, so they're built again with the current translations
+    # (on every code or translation reload in development).
+    def reset_i18n_navigations!
+      @i18n_lock.synchronize do
+        @navigations -= @i18n_navigations if @i18n_navigations
+        @i18n_navigations = nil
+      end
+    end
+
+    private
+
+    def build_i18n_navigations
+      @i18n_lock.synchronize do
+        return if @i18n_navigations
+
+        @i18n_navigations = @i18n_files.flat_map do |name, file|
+          structure = YAML.load_file(file)
+          I18n.available_locales.map do |locale|
+            navigation = Seiten::Navigation.new(name: name, locale: locale, config: file, dir: File.join(Rails.root, Seiten.config[:pages_dir], name, locale.to_s))
+            navigation.page_collection.build(pages: i18n_pages(structure, locale, [Seiten.config[:i18n_scope], name]))
+            navigation
+          end
+        end
+        @navigations.concat(@i18n_navigations)
+      end
+    end
+
+    # The pages of a locale: every page names its `key`; its title and slug are the translations
+    # <i18n_scope>.<navigation>.<parent keys…>.<key>.title and .slug (the slug defaults to the
+    # parameterized title). The page's key becomes its full key, e.g. "account.manage", which is the
+    # same page in every locale.
+    def i18n_pages(nodes, locale, scope)
+      nodes.map do |node|
+        node = node.dup
+        key = node['key'] or raise Errors::PageError, "Every page of #{scope[1]}.yml needs a key"
+        page_scope = [*scope, key.to_s]
+        title = I18n.t('title', scope: page_scope, locale: locale, default: nil)
+        slug = I18n.t('slug', scope: page_scope, locale: locale, default: nil)
+        raise Errors::PageError, "#{page_scope.join('.')} needs a title or a slug in #{locale}" unless title || slug || node.key?('url')
+
+        node['title'] = title
+        node['url'] = slug if slug && !node.key?('url')
+        node['key'] = page_scope.drop(2).join('.')
+        node['nodes'] = i18n_pages(node['nodes'], locale, page_scope) if node['nodes']
+        node
       end
     end
   end

data/test/dummy/config/locales/guide.de.yml

@@ -0,0 +1,13 @@
+de:
+  navigations:
+    guide:
+      start:
+        title: Start
+      account:
+        title: Dein Account
+        manage:
+          title: Account verwalten
+        security:
+          title: Sicherheit
+      billing:
+        title: Rechnungen

data/test/dummy/config/locales/guide.en.yml

@@ -0,0 +1,14 @@
+en:
+  navigations:
+    guide:
+      start:
+        title: Start
+      account:
+        title: Your account
+        manage:
+          title: Manage your account
+        security:
+          title: Security
+          slug: account-security
+      billing:
+        title: Billing

data/test/dummy/config/navigations/guide.yml

@@ -0,0 +1,7 @@
+- key: start
+  url: '/'
+- key: account
+  nodes:
+    - key: manage
+    - key: security
+- key: billing