seiten 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09cdd9e8323ed21cafe0eb5f92544ee05a8e78bc86b421a0fb2bfc6c865ecd8b'
-  data.tar.gz: f9860ca8c46a06a36136a992e078be502c81fba45373c5feae6682a5fb431e8e
+  metadata.gz: 6289826464b8f2c34c78a4d469fe26e0e772c79f67adf29f38dc3465c9d35ed6
+  data.tar.gz: fb131648fd8558fadf4e3b17f27aa1c24e4b4d4b59a13fcf0d173632c561c2a3
 SHA512:
-  metadata.gz: 4ab559c9fb74b3373ddb9b31485dd4d78b56bcab9dbd1c1e863bafcf0a60c1a4cfb502728ea763db6e7b81ca9b1ff9d3c17d529fcf5b7b8c0bf226cca5316e6d
-  data.tar.gz: 4525be586db9bba6d0c8b1589d7297680b411523874c4fae5ed73dbb3ebff0445a65c7a27c22c65612c29c2dd525a30de5c845482c2cafef044824c8e7acc426
+  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/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.2.0"
+  VERSION = "1.3.0"
 end

data/lib/seiten.rb

@@ -80,6 +80,11 @@ module Seiten
       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!

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

@@ -1,6 +1,7 @@
 de:
   navigations:
     guide:
+      title: Anleitung
       start:
         title: Start
       account:

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

@@ -1,6 +1,7 @@
 en:
   navigations:
     guide:
+      title: Guide
       start:
         title: Start
       account:

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