seiten 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f11b589f94032def9f0ef35b5fd457e1acb0f3508cf39f1ac63fb0338ee8217a
-  data.tar.gz: 71e0543f85e054dac2cf348e6e9ecf1eebde83d1659921dca8c4460a734665b6
+  metadata.gz: 6289826464b8f2c34c78a4d469fe26e0e772c79f67adf29f38dc3465c9d35ed6
+  data.tar.gz: fb131648fd8558fadf4e3b17f27aa1c24e4b4d4b59a13fcf0d173632c561c2a3
 SHA512:
-  metadata.gz: 186fe751f440f15e30944acc416a9dfac931bcf1afd0f65c4f58ba5b6e7c8a0ebd3fab9e8ad39260c39aebc26de7769cb5b829c4b05c7f35c30407806a97577a
-  data.tar.gz: 133f9dd5ac075f2805088865e309183c453a2e889b0cc090c970db1e94076e603f4a60a8f249685b97d674741b857a6e78112ce33f356c0e3aaaa64e73b1d8b5
+  metadata.gz: b69aa165a103bd083dba0cb57c6c34078b139d56dba5a0e83679e4d654bd863e1e245d7dc247e429f6f3bf393818faa450f6c59fe9ad2255498e773427eb865c
+  data.tar.gz: '0643406590aa1ae9a182222163f903764807699d460cfa9652f3a56e235685bbb4c50e440701cae5a519f1f0a2afb5c5ba680ea41d74bf9098257737bd39242b'

data/lib/seiten/navigation.rb

@@ -32,6 +32,16 @@ module Seiten
       page_collection
     end
 
+    # The navigation's own title and slug, from I18n like its pages' (<i18n_scope>.<name>.title and
+    # .slug; the slug defaults to the parameterized title). Its localized routes start with the slug.
+    def title
+      I18n.t('title', scope: [Seiten.config[:i18n_scope], name], locale: locale, default: nil)
+    end
+
+    def slug
+      I18n.t('slug', scope: [Seiten.config[:i18n_scope], name], locale: locale, default: nil) || title&.parameterize
+    end
+
     def pages=(pages_array)
       page_collection.pages = pages_array.map { |page| page.navigation_id = id; page }
       # return page_collection

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

@@ -1,15 +1,48 @@
 class ActionDispatch::Routing::Mapper
+  # Routes a navigation's pages. Draw it after your other routes, which it would swallow.
+  #
+  # A navigation built in every locale from one file (config/navigations/help.yml) gets a route per
+  # locale, under the locale and the navigation's slug (its I18n title or slug, see
+  # Navigation#slug), to Help::PagesController#show, named help_page_<locale>:
+  #
+  #   seiten :help   # /en/help(/*slug), /de/hilfe(/*slug)
+  #
+  # Every page gets a link helper named after the navigation and its key, and the navigation one that
+  # takes a key; both link to the page in I18n.locale or the `locale:` option:
+  #
+  #   help_account_manage_path                      # => "/en/help/your-account/manage-your-account"
+  #   help_account_manage_url(locale: :de)          # => "http://…/de/hilfe/dein-account/account-verwalten"
+  #   help_page_path(page.key)                      # the same, for a key in a variable; unknown keys raise
+  #   help_page_path                                # => "/en/help", the navigation's root
+  #
+  # `to:`, `as:` (of the navigation's helper) and `path:` (the same in every locale) replace the
+  # defaults, `prefix: false` names the page helpers without the navigation (account_manage_path), and
+  # `localized: false` draws one catch-all route instead.
+  #
+  # Other navigations get one catch-all route to seiten/pages#show (or `to:`) that sets
+  # params[:navigation_id] (except for the application navigation); `localized: true` routes them per
+  # locale too.
+  #
+  #   seiten                         # /*slug, the application navigation
+  #   scope(:help) { seiten :help }
   def seiten(*resources)
     options = resources.extract_options!
-    options[:to] ||= 'seiten/pages#show'
+    localized, path, prefix = options.extract!(:localized, :path, :prefix).values_at(:localized, :path, :prefix)
 
     resources.each do |resource|
-      resource_options = options.dup
+      name = resource.to_s
+
+      if localized.nil? ? Seiten.i18n_navigation?(name) : localized
+        seiten_localized_routes(name, options.dup, path: path, prefix: prefix.nil? ? name : prefix)
+        next
+      end
 
+      resource_options = options.dup
+      resource_options[:to] ||= 'seiten/pages#show'
       resource_options[:as] ||= resource == :application ? :seiten_page : "seiten_#{resource}_page"
 
-      resource_options[:defaults] ||= {}
-      resource_options[:defaults][:navigation_id] = resource.to_s unless resource == :application
+      resource_options[:defaults] = resource_options[:defaults].to_h.dup
+      resource_options[:defaults][:navigation_id] = name unless resource == :application
       resource_options[:defaults][:slug] = ''
 
       # NOTE: See https://github.com/rails/rails/issues/31228
@@ -18,4 +51,46 @@ class ActionDispatch::Routing::Mapper
       get '(*slug)', **resource_options
     end
   end
+
+  private
+
+  def seiten_localized_routes(name, options, path:, prefix:)
+    navigations = Seiten::Navigation.where(name: name)
+    raise ArgumentError, "No #{name} navigation in #{Seiten.config[:config_dir]}" if navigations.empty?
+
+    route = (options.delete(:as) || "#{name}_page").to_s
+    options = { to: "#{name}/pages#show", format: false, **options }
+    defaults = { **options.delete(:defaults).to_h, navigation_id: name, slug: '' }
+
+    navigations.each do |navigation|
+      locale_path = [navigation.locale, path || navigation.slug].compact_blank.join('/')
+      get "#{locale_path}(/*slug)", **options, as: "#{route}_#{navigation.locale}", defaults: defaults.merge(locale: navigation.locale)
+    end
+
+    keys = navigations.first.pages.all.filter_map(&:key)
+    helpers = keys.map { |key| [prefix.presence, *key.split('.')].compact.join('_') }
+    duplicate = [route, *helpers].tally.find { |_, count| count > 1 }&.first
+    raise ArgumentError, "The #{name} navigation would define #{duplicate}_path twice" if duplicate
+
+    seiten_link_helper(route, name, route)
+    keys.zip(helpers).each { |key, helper| seiten_link_helper(helper, name, route, key) }
+  end
+
+  # <helper>_path and <helper>_url: the page with `page_key` (else the key given first, else the
+  # navigation's root) in the navigation of I18n.locale or the `locale:` option.
+  def seiten_link_helper(helper, navigation_name, route, page_key = nil)
+    @set.add_url_helper(helper, {}) do |*args|
+      options = args.extract_options!
+      key = page_key || args.first
+      locale = (options[:locale] || I18n.locale).to_s
+
+      navigation = Seiten::Navigation.find_by(name: navigation_name, locale: locale)
+      raise ArgumentError, "No #{navigation_name} navigation in #{locale}" unless navigation
+
+      page = navigation.pages.find_by(key: key.to_s) if key
+      raise ArgumentError, "No page #{key} in the #{navigation_name} navigation" if key && !page
+
+      { use_route: "#{route}_#{locale}", slug: page&.slug.to_s, **options.except(:locale) }
+    end
+  end
 end

data/lib/seiten/version.rb

@@ -1,3 +1,3 @@
 module Seiten
-  VERSION = "1.1.0"
+  VERSION = "1.3.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,72 @@ 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
+
+    # Whether the navigation is built in every locale from one file (config/navigations/<name>.yml).
+    def i18n_navigation?(name)
+      @i18n_files.key?(name.to_s)
+    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/app/controllers/guide/pages_controller.rb

@@ -0,0 +1,5 @@
+class Guide::PagesController < ApplicationController
+  def show
+    render plain: "#{current_navigation.id} #{current_page&.key}"
+  end
+end

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

@@ -0,0 +1,14 @@
+de:
+  navigations:
+    guide:
+      title: Anleitung
+      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,15 @@
+en:
+  navigations:
+    guide:
+      title: 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

data/test/dummy/config/routes.rb

@@ -3,6 +3,8 @@ Dummy::Application.routes.draw do
 
   get "/blog",   to: "posts#index"
 
+  seiten :guide
+
   scope :help do
     seiten :help
   end