seiten 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ca1b6ad9f5f4c830d23928eccc0ca333069d8f88412022725c495e9315b6ea4
-  data.tar.gz: 7ad22ccd05fa7571b4c6e858cfdf03eb9e9ecfdd8da2440e0ce4d1413e32c7cc
+  metadata.gz: '09cdd9e8323ed21cafe0eb5f92544ee05a8e78bc86b421a0fb2bfc6c865ecd8b'
+  data.tar.gz: f9860ca8c46a06a36136a992e078be502c81fba45373c5feae6682a5fb431e8e
 SHA512:
-  metadata.gz: cc3ea9c6fed75f3887f5d6827aeca2ca06359d12c389dcecc2dcdea78dba87840a328c399e02a27430a46bde3ba96b320e1717712fac0169e8a46ee45adf9138
-  data.tar.gz: da5ae1af8ed70e7fa3b955cb2868324345c5f2aec0245de4b484135d0dcb6886002ffbb486f2281bba185e20619e31bd5375b5b5d2ccf3dde18bd821b0af8f96
+  metadata.gz: 4ab559c9fb74b3373ddb9b31485dd4d78b56bcab9dbd1c1e863bafcf0a60c1a4cfb502728ea763db6e7b81ca9b1ff9d3c17d529fcf5b7b8c0bf226cca5316e6d
+  data.tar.gz: 4525be586db9bba6d0c8b1589d7297680b411523874c4fae5ed73dbb3ebff0445a65c7a27c22c65612c29c2dd525a30de5c845482c2cafef044824c8e7acc426

data/lib/seiten/page.rb

@@ -2,7 +2,7 @@
 
 module Seiten
   class Page
-    attr_accessor :navigation_id, :id, :parent_id, :title, :slug, :refer, :data, :html_options
+    attr_accessor :navigation_id, :id, :parent_id, :title, :slug, :refer, :key, :data, :html_options
     attr_writer :layout
 
     # initialize Page object with attributes
@@ -13,6 +13,7 @@ module Seiten
       @title          = options[:title]
       @slug           = options[:slug]
       @refer          = options[:refer]
+      @key            = options[:key]&.to_s
       @layout         = options[:layout]
       @data           = options[:data].each_with_object({}){|(k,v), h| h[k.to_sym] = v} if options[:data]
       @data         ||= {}
@@ -71,6 +72,37 @@ module Seiten
       end
     end
 
+    # The page's place in its navigation tree: the index among its siblings, from the root down
+    # (e.g. [2, 0] for the first child of the third top-level page).
+    def position
+      @position ||= (parent ? parent.position : []) + [navigation.pages.where(parent_id: parent_id).index(self)]
+    end
+
+    # The same page in the navigation of the same name in another locale: the page at the same
+    # position, or, for a page with a `key`, the page with the same key. Nil when there is none.
+    def translation(locale)
+      locale = locale.to_s
+      return self if locale == navigation.locale
+
+      other = Seiten::Navigation.find_by(name: navigation.name, locale: locale)
+      return unless other
+
+      if key
+        other.pages.find_by(key: key)
+      else
+        page = other.pages.all.find { |candidate| candidate.position == position }
+        page unless page&.key
+      end
+    end
+
+    # This page in every locale that has it, by locale (including its own).
+    def translations
+      Seiten::Navigation.where(name: navigation.name).each_with_object({}) do |other, translations|
+        page = translation(other.locale)
+        translations[other.locale] = page if page
+      end
+    end
+
     # get children of page
     def children
       navigation.pages.where(parent_id: id)

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/routes_helper.rb

@@ -15,7 +15,7 @@ class ActionDispatch::Routing::Mapper
       # NOTE: See https://github.com/rails/rails/issues/31228
       resource_options[:constraints] ||= ->(req) { req.path.exclude? 'rails/active_storage' }
 
-      get '(*slug)', resource_options
+      get '(*slug)', **resource_options
     end
   end
 end

data/lib/seiten/version.rb

@@ -1,3 +1,3 @@
 module Seiten
-  VERSION = "1.0.2"
+  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/initializers/new_framework_defaults.rb

@@ -12,9 +12,5 @@ Rails.application.config.action_controller.per_form_csrf_tokens = false
 # Enable origin-checking CSRF mitigation. Previous versions had false.
 Rails.application.config.action_controller.forgery_protection_origin_check = false
 
-# Make Ruby 2.4 preserve the timezone of the receiver when calling `to_time`.
-# Previous versions had false.
-ActiveSupport.to_time_preserves_timezone = false
-
 # Require `belongs_to` associations by default. Previous versions had false.
 # Rails.application.config.active_record.belongs_to_required_by_default = false

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