seiten 1.1.0 → 1.3.0

data/test/integration/localized_routes_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+class Seiten::LocalizedRoutesTest < ActionDispatch::IntegrationTest
+  def route_set(&)
+    ActionDispatch::Routing::RouteSet.new.tap do |routes|
+      routes.default_url_options[:host] = 'example.com'
+      routes.draw(&)
+    end
+  end
+
+  def draw(&)
+    route_set(&).routes.map { |route| [route.name, route.path.spec.to_s, route.defaults.except(:action, :slug)] }
+  end
+
+  test 'routes a navigation of one file under each locale and its slug, to its pages controller' do
+    get '/de/anleitung/dein-account/account-verwalten'
+    assert_equal 'guide.de account.manage', response.body
+
+    get '/en/guide'
+    assert_equal 'guide.en start', response.body
+  end
+
+  test 'names the routes after the navigation and the locale' do
+    assert_equal '/de/anleitung/rechnungen', guide_page_de_path(slug: 'rechnungen')
+  end
+
+  test 'to, as and path replace the defaults' do
+    assert_equal [['docs_de', '/de/doku(/*slug)', { controller: 'docs', navigation_id: 'guide', locale: 'de' }],
+                  ['docs_en', '/en/doku(/*slug)', { controller: 'docs', navigation_id: 'guide', locale: 'en' }]],
+                 draw { seiten :guide, to: 'docs#show', as: :docs, path: 'doku' }.sort
+  end
+
+  test 'localized: false draws one catch-all route' do
+    assert_equal [['seiten_guide_page', '/(*slug)(.:format)', { controller: 'seiten/pages', navigation_id: 'guide' }]],
+                 draw { seiten :guide, localized: false }
+  end
+
+  test 'navigations of one file per locale get one catch-all route unless localized' do
+    assert_equal 1, draw { seiten :application }.size
+    assert_equal ['/de(/*slug)', '/en(/*slug)'], draw { seiten :application, localized: true }.map(&:second).sort
+  end
+
+  test 'links a page by its key in the current or the given locale' do
+    I18n.with_locale(:de) { assert_equal '/de/anleitung/dein-account/account-verwalten', guide_page_path('account.manage') }
+    assert_equal '/en/guide/your-account/account-security', guide_page_path('account.security', locale: :en)
+    assert_equal 'http://example.com/de/anleitung/rechnungen?page=2#top', guide_page_url('billing', locale: 'de', host: 'example.com', page: 2, anchor: 'top')
+  end
+
+  test 'links the navigation root without a key' do
+    assert_equal '/en/guide', guide_page_path
+    assert_equal '/de/anleitung', guide_page_path(locale: :de)
+  end
+
+  test 'page helpers are named after the navigation and the key' do
+    assert_equal '/en/guide/your-account/manage-your-account', guide_account_manage_path
+    assert_equal 'http://example.com/de/anleitung/rechnungen#top', guide_billing_url(locale: :de, host: 'example.com', anchor: 'top')
+    assert_equal '/en/guide', guide_start_path
+  end
+
+  test 'prefix: false names the page helpers after the key only' do
+    helpers = route_set { seiten :guide, prefix: false }.url_helpers
+
+    assert_equal '/en/guide/your-account/manage-your-account', helpers.account_manage_path
+    assert_respond_to helpers, :guide_page_path
+  end
+
+  test 'raises for an unknown page or locale' do
+    assert_raises(ArgumentError) { guide_page_path('account.missing') }
+    assert_raises(ArgumentError) { guide_page_path('billing', locale: :fr) }
+  end
+end

data/test/lib/seiten/html/helpers_test.rb

@@ -2,12 +2,13 @@ require 'test_helper'
 
 class Seiten::HTML::HelpersTest < ActiveSupport::TestCase
 
+  # Its own navigation: pages added to a shared one would show up in other tests.
   def navigation
-    @navigation ||= Seiten::Navigation.find_by(id: 'application.en')
+    @navigation ||= Seiten::Navigation.new(name: :helpers_test, locale: :en).tap { |navigation| Seiten.navigations << navigation }
   end
 
-  def current_page
-    @current_page ||= navigation.pages.find(1)
+  teardown do
+    Seiten.navigations -= [@navigation] if @navigation
   end
 
   def helpers

data/test/lib/seiten/i18n_navigation_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class Seiten::I18nNavigationTest < ActiveSupport::TestCase
+  def navigation(locale)
+    Seiten::Navigation.find_by(name: 'guide', locale: locale)
+  end
+
+  def page(locale, key)
+    navigation(locale).pages.find_by(key: key)
+  end
+
+  test 'one structure file gives a navigation in every available locale' do
+    assert_equal ['de', 'en'], Seiten::Navigation.where(name: 'guide').map(&:locale).sort
+  end
+
+  test 'titles and slugs come from I18n, nested like the pages' do
+    assert_equal 'Account verwalten', page('de', 'account.manage').title
+    assert_equal 'dein-account/account-verwalten', page('de', 'account.manage').slug
+    assert_equal 'your-account/account-security', page('en', 'account.security').slug, 'a translated slug replaces the title'
+    assert_equal '', page('en', 'start').slug, 'url in the structure applies to every locale'
+    assert_equal page('en', 'account'), page('en', 'account.manage').parent
+  end
+
+  test 'pages with the same key translate each other' do
+    assert_equal page('en', 'account.manage'), page('de', 'account.manage').translation(:en)
+    assert_equal({ 'de' => page('de', 'billing'), 'en' => page('en', 'billing') }, page('en', 'billing').translations)
+  end
+
+  test 'navigations are built again with reloaded translations' do
+    I18n.backend.store_translations(:en, navigations: { guide: { billing: { title: 'Invoices' } } })
+    Seiten.reset_i18n_navigations!
+
+    assert_equal 'invoices', page('en', 'billing').slug
+  ensure
+    I18n.backend.store_translations(:en, navigations: { guide: { billing: { title: 'Billing' } } })
+    Seiten.reset_i18n_navigations!
+  end
+
+  test 'the navigation has a title and a slug from I18n, like its pages' do
+    assert_equal 'Anleitung', navigation('de').title
+    assert_equal 'anleitung', navigation('de').slug
+
+    I18n.backend.store_translations(:en, navigations: { guide: { slug: 'docs' } })
+    assert_equal 'docs', navigation('en').slug
+  ensure
+    I18n.backend.store_translations(:en, navigations: { guide: { slug: nil } })
+  end
+
+  test 'a page needs a key and a title or slug' do
+    assert_raises(Seiten::Errors::PageError) { Seiten.send(:i18n_pages, [{ 'title' => 'Untitled' }], :en, ['navigations', 'guide']) }
+    assert_raises(Seiten::Errors::PageError) { Seiten.send(:i18n_pages, [{ 'key' => 'missing' }], :en, ['navigations', 'guide']) }
+  end
+
+  test 'navigations of one locale per file keep working' do
+    assert_equal 'Produkte', Seiten::Navigation.find_by(name: 'application', locale: 'de').pages.find_by(slug: 'produkte').title
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seiten
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Daniel Puglisi
@@ -104,6 +104,7 @@ files:
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/guide/pages_controller.rb
 - test/dummy/app/controllers/pages_controller.rb
 - test/dummy/app/controllers/posts_controller.rb
 - test/dummy/app/helpers/application_helper.rb
@@ -149,11 +150,15 @@ files:
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
+- test/dummy/config/locales/guide.de.yml
+- test/dummy/config/locales/guide.en.yml
 - test/dummy/config/navigations/application.de.yml
 - test/dummy/config/navigations/application.en.yml
+- test/dummy/config/navigations/guide.yml
 - test/dummy/config/navigations/help.en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config/secrets.yml
+- test/dummy/log/development.log
 - test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
@@ -164,11 +169,13 @@ files:
 - test/fixtures/breadcrumb.html
 - test/fixtures/navigation.html
 - test/integration/layout_test.rb
+- test/integration/localized_routes_test.rb
 - test/integration/navigation_test.rb
 - test/lib/seiten/helpers/frontend_test.rb
 - test/lib/seiten/html/breadcrumb_test.rb
 - test/lib/seiten/html/helpers_test.rb
 - test/lib/seiten/html/navigation_test.rb
+- test/lib/seiten/i18n_navigation_test.rb
 - test/lib/seiten/navigation_test.rb
 - test/lib/seiten/page_collection_builder_test.rb
 - test/lib/seiten/page_collection_test.rb
@@ -206,6 +213,7 @@ test_files:
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/guide/pages_controller.rb
 - test/dummy/app/controllers/pages_controller.rb
 - test/dummy/app/controllers/posts_controller.rb
 - test/dummy/app/helpers/application_helper.rb
@@ -251,11 +259,15 @@ test_files:
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
+- test/dummy/config/locales/guide.de.yml
+- test/dummy/config/locales/guide.en.yml
 - test/dummy/config/navigations/application.de.yml
 - test/dummy/config/navigations/application.en.yml
+- test/dummy/config/navigations/guide.yml
 - test/dummy/config/navigations/help.en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config/secrets.yml
+- test/dummy/log/development.log
 - test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
@@ -266,11 +278,13 @@ test_files:
 - test/fixtures/breadcrumb.html
 - test/fixtures/navigation.html
 - test/integration/layout_test.rb
+- test/integration/localized_routes_test.rb
 - test/integration/navigation_test.rb
 - test/lib/seiten/helpers/frontend_test.rb
 - test/lib/seiten/html/breadcrumb_test.rb
 - test/lib/seiten/html/helpers_test.rb
 - test/lib/seiten/html/navigation_test.rb
+- test/lib/seiten/i18n_navigation_test.rb
 - test/lib/seiten/navigation_test.rb
 - test/lib/seiten/page_collection_builder_test.rb
 - test/lib/seiten/page_collection_test.rb