seiten 0.0.8 → 1.0.0

data/lib/seiten.rb

@@ -1,26 +1,77 @@
 require 'seiten/engine'
-require 'seiten/page_store'
+require 'seiten/railtie'
+require 'seiten/navigation'
 require 'seiten/page'
+require 'seiten/page_collection'
+require 'seiten/page_collection_builder'
+require 'seiten/slug_builder'
 require 'seiten/routes_helper'
+require 'seiten/helpers/current'
+require 'seiten/helpers/backend'
+require 'seiten/helpers/frontend'
+require 'seiten/html/helpers'
+require 'seiten/html/navigation'
+require 'seiten/html/breadcrumb'
+require 'seiten/errors/base_error'
+require 'seiten/errors/page_error'
+require 'seiten/errors/routing_error'
 
 module Seiten
-
   @config = {
-    default_storage_type: :yaml,
-    default_storage_file: File.join('config', 'navigation'),
-    default_storage_directory: File.join('app', 'pages'),
-    root_page_filename: "home"
+    config_dir: File.join('config', 'navigations'),
+    pages_dir:  File.join('app', 'pages'),
+    root_page: 'home',
+    default_layout: 'application',
+    html: {
+      navigation: {
+        base: 'navigation',
+        item: 'navigation__item',
+        nodes: 'navigation__nodes',
+      },
+      breadcrumb: {
+        base: 'breadcrumb',
+        item: 'breadcrumb__item',
+        separator: 'breadcrumb__separator',
+      },
+      modifier: {
+        base: nil, # if nil we use the main class combined with the element class
+        separator: '--', # modifier separator
+        parent: 'parent',
+        active: 'active',
+        current: 'current',
+        expanded: 'expanded'
+      }
+    }
   }
 
-  def self.config
-    @config
-  end
+  @navigations = []
+
+  class << self
+    def config
+      @config
+    end
+
+    def navigations
+      @navigations
+    end
+
+    def navigations=(navigations)
+      @navigations = navigations
+    end
 
-  module Controllers
-    autoload :Helpers, 'seiten/controllers/helpers'
+    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
+      end
+    end
   end
 
   ActiveSupport.on_load(:action_controller) do
-    include Controllers::Helpers
+    include Helpers::Current
   end
 end

data/test/controllers/helper_methods_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class CustomPagesController < ActionController::Base
+  include Seiten::Helpers::Backend
+end
+
+class CurrentHelperMethodsTest < ActionController::TestCase
+  tests CustomPagesController
+
+  test 'includes Seiten::ControllerHelpers::Current' do
+    assert_includes @controller.class.ancestors, Seiten::Helpers::Current
+  end
+
+  test 'includes Seiten::ControllerHelpers::Backend' do
+    assert_includes @controller.class.ancestors, Seiten::Helpers::Backend
+  end
+
+  test 'defines methods like current_navigation' do
+    assert_respond_to @controller, :current_navigation
+  end
+
+  test 'defines methods like current_page' do
+    assert_respond_to @controller, :current_page
+  end
+end

data/test/controllers/pages_controller_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class PagesControllerTest < ActionController::TestCase
+  test "should not set current page on pages controller" do
+    get :secret
+    assert Seiten::Navigation.find_by(name: 'application'), @controller.instance_eval { @current_navigation }
+    assert_nil @controller.instance_eval { @current_page }
+  end
+end

data/test/controllers/posts_controller_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class PostsControllerTest < ActionController::TestCase
+  def navigation
+    @navigation ||= Seiten::Navigation.find_by(name: 'application', locale: 'en')
+  end
+
+  test "should set current page on posts controller" do
+    get :index
+    assert_equal navigation.pages.find_by(slug: "blog"), @controller.instance_eval { @current_page }
+  end
+end

data/test/controllers/seiten/pages_controller_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class Seiten::ApplicationPagesControllerTest < ActionController::TestCase
+  setup do
+    @controller = Seiten::PagesController.new
+  end
+
+  def navigation
+    @navigation ||= Seiten::Navigation.find_by(name: 'application', locale: 'en')
+  end
+
+  test 'should set current page when params[:slug] is empty' do
+    get :show, params: { slug: '' }
+    assert_equal(navigation, @controller.instance_eval { @current_navigation })
+    assert_equal(navigation.pages.find_by(slug: ''), @controller.instance_eval { @current_page })
+  end
+
+  test 'should set products page as current page' do
+    get :show, params: { slug: 'products' }
+    assert_equal(navigation, @controller.instance_eval { @current_navigation })
+    assert_equal(navigation.pages.find_by(slug: 'products'), @controller.instance_eval { @current_page })
+  end
+end
+
+class Seiten::HelpPagesControllerTest < ActionController::TestCase
+  setup do
+    @controller = Seiten::PagesController.new
+  end
+
+  def navigation
+    @navigation ||= Seiten::Navigation.find_by(name: 'help', locale: 'en')
+  end
+
+  test 'should set products page as current page' do
+    get :show, params: { slug: 'logging-in', navigation_id: 'help' }
+    assert_equal(navigation, @controller.instance_eval { @current_navigation })
+    assert_equal(navigation.pages.find_by(slug: 'logging-in'), @controller.instance_eval { @current_page })
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,13 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
+
+  before_action :set_seo_values
+
+  private
+
+  def set_seo_values
+    if current_page
+      @title = current_page.data[:title] || current_page.title
+    end
+  end
 end

data/test/dummy/app/controllers/pages_controller.rb

@@ -1,5 +1,5 @@
 class PagesController < ApplicationController
-
   def secret
+    @title = current_page
   end
 end

data/test/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,10 @@
+class PostsController < ApplicationController
+  def index
+  end
+
+  private
+
+  def set_current_page
+    current_navigation.pages.find_by(slug: 'blog')
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,3 @@
 module ApplicationHelper
+  include Seiten::Helpers::Frontend
 end

data/test/dummy/app/pages/application/en/about/our-team.html.erb

@@ -0,0 +1,2 @@
+<h1>Subnavigation</h1>
+<%= seiten_navigation(parent_id: current_page.id) %>

data/test/dummy/app/pages/application/en/about/partners.html.erb

@@ -0,0 +1 @@
+<%= seiten_navigation(parent_id: current_page.id) %>

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Dummy</title>
+  <title><%= @title %></title>
   <%= stylesheet_link_tag    "application", :media => "all" %>
   <%# <%= javascript_include_tag "application" %1> %>
   <%= csrf_meta_tags %>

data/test/dummy/app/views/layouts/home.html.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Dummy</title>
+  <title><%= @title %></title>
   <%= stylesheet_link_tag    "application", :media => "all" %>
   <%# <%= javascript_include_tag "application" %1> %>
   <%= csrf_meta_tags %>

data/test/dummy/app/views/pages/secret.html.erb

@@ -1 +1 @@
-This is a secret page
+<p>pages#secret</p>

data/test/dummy/app/views/posts/index.html.erb

@@ -0,0 +1 @@
+<p>posts#index</p>

data/test/dummy/config/application.rb

@@ -1,6 +1,7 @@
 require File.expand_path('../boot', __FILE__)
 
-require 'rails/all'
+require "action_controller/railtie"
+require "action_view/railtie"
 
 Bundler.require(*Rails.groups)
 require "seiten"
@@ -14,46 +15,8 @@ module Dummy
     # Custom directories with classes and modules you want to be autoloadable.
     # config.autoload_paths += %W(#{config.root}/extras)
 
-    # Only load the plugins named here, in the order given (default is alphabetical).
-    # :all can be used as a placeholder for all plugins not explicitly named.
-    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
-
-    # Activate observers that should always be running.
-    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
-
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
-
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password]
-
-    # Enable escaping HTML in JSON.
-    config.active_support.escape_html_entities_in_json = true
-
-    # Use SQL instead of Active Record's schema dumper when creating the database.
-    # This is necessary if your schema can't be completely dumped by the schema dumper,
-    # like if you have constraints or database-specific column types
-    # config.active_record.schema_format = :sql
-
-    # Enforce whitelist mode for mass assignment.
-    # This will create an empty whitelist of attributes available for mass-assignment for all models
-    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
-    # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
-
-    # Enable the asset pipeline
-    config.assets.enabled = true
-
-    # Version of your assets, change this if you want to expire all your assets
-    config.assets.version = '1.0'
+    config.i18n.default_locale = :en
+    config.i18n.available_locales = [:en, :de]
   end
 end
 

data/test/dummy/config/boot.rb

@@ -1,10 +1,3 @@
-require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 
-if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-end
-
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+require 'bundler/setup' # Set up gems listed in the Gemfile.

data/test/dummy/config/cable.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1

data/test/dummy/config/environments/development.rb

@@ -1,37 +1,42 @@
 Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+  # Settings specified here will take precedence over those in config/application.rb.
 
   # In the development environment your application's code is reloaded on
   # every request. This slows down response time but is perfect for development
   # since you don't have to restart the web server when you make code changes.
   config.cache_classes = false
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
+  # Do not eager load code on boot.
+  config.eager_load = false
 
-  # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = false
+  # Show full error reports.
+  config.consider_all_requests_local = true
 
-  # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
 
-  # Print deprecation notices to the Rails logger
-  config.active_support.deprecation = :log
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => 'public, max-age=172800'
+    }
+  else
+    config.action_controller.perform_caching = false
 
-  # Only use best-standards-support built into browsers
-  config.action_dispatch.best_standards_support = :builtin
+    config.cache_store = :null_store
+  end
 
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
 
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  # config.assets.debug = true
 
-  # Do not compress assets
-  config.assets.compress = false
+  # Suppress logger output for asset requests.
+  # config.assets.quiet = true
 
-  # Expands the lines which load the assets
-  config.assets.debug = true
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
 end

data/test/dummy/config/environments/production.rb

@@ -4,6 +4,9 @@ Dummy::Application.configure do
   # Code is not reloaded between requests
   config.cache_classes = true
 
+  # Do not eager load code on boot.
+  config.eager_load = true
+
   # Full error reports are disabled and caching is turned on
   config.consider_all_requests_local       = false
   config.action_controller.perform_caching = true

data/test/dummy/config/environments/test.rb

@@ -1,5 +1,5 @@
 Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+  # Settings specified here will take precedence over those in config/application.rb.
 
   # The test environment is used exclusively to run your application's
   # test suite. You never need to work with it otherwise. Remember that
@@ -7,31 +7,27 @@ Dummy::Application.configure do
   # and recreated between test runs. Don't rely on the data there!
   config.cache_classes = true
 
-  # Configure static asset server for tests with Cache-Control for performance
-  config.serve_static_assets = true
-  config.static_cache_control = "public, max-age=3600"
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
 
-  # Log error messages when you accidentally call methods on nil
-  config.whiny_nils = true
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    'Cache-Control' => 'public, max-age=3600'
+  }
 
-  # Show full error reports and disable caching
+  # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
 
-  # Raise exceptions instead of rendering exception templates
+  # Raise exceptions instead of rendering exception templates.
   config.action_dispatch.show_exceptions = false
 
-  # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
 
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
-
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
-
-  # Print deprecation notices to the stderr
+  # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
 end

data/test/dummy/config/initializers/application_controller_renderer.rb

@@ -0,0 +1,6 @@
+# Be sure to restart your server when you modify this file.
+
+# ApplicationController.renderer.defaults.merge!(
+#   http_host: 'example.org',
+#   https: false
+# )

data/test/dummy/config/initializers/cookies_serializer.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Specify a serializer for the signed and encrypted cookie jars.
+# Valid options are :json, :marshal, and :hybrid.
+Rails.application.config.action_dispatch.cookies_serializer = :marshal

data/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/test/dummy/config/initializers/inflections.rb

@@ -1,15 +1,16 @@
 # Be sure to restart your server when you modify this file.
 
-# Add new inflection rules using the following format
-# (all these examples are active by default):
-# ActiveSupport::Inflector.inflections do |inflect|
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
 #   inflect.plural /^(ox)$/i, '\1en'
 #   inflect.singular /^(ox)en/i, '\1'
 #   inflect.irregular 'person', 'people'
 #   inflect.uncountable %w( fish sheep )
 # end
-#
+
 # These inflection rules are supported but not enabled by default:
-# ActiveSupport::Inflector.inflections do |inflect|
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
 #   inflect.acronym 'RESTful'
 # end

data/test/dummy/config/initializers/mime_types.rb

@@ -2,4 +2,3 @@
 
 # Add new mime types for use in respond_to blocks:
 # Mime::Type.register "text/richtext", :rtf
-# Mime::Type.register_alias "text/html", :iphone

data/test/dummy/config/initializers/new_framework_defaults.rb

@@ -0,0 +1,20 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains migration options to ease your Rails 5.0 upgrade.
+#
+# Once upgraded flip defaults one by one to migrate to the new default.
+#
+# Read the Rails 5.0 release notes for more info on each option.
+
+# Enable per-form CSRF tokens. Previous versions had false.
+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/initializers/session_store.rb

@@ -1,8 +1,3 @@
 # Be sure to restart your server when you modify this file.
 
-Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
-
-# Use the database for sessions instead of the cookie-based default,
-# which shouldn't be used to store highly confidential information
-# (create the session table with "rails generate session_migration")
-# Dummy::Application.config.session_store :active_record_store
+Rails.application.config.session_store :cookie_store, key: '_dummy_session'

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -1,5 +1,5 @@
 # Be sure to restart your server when you modify this file.
-#
+
 # This file contains settings for ActionController::ParamsWrapper which
 # is enabled by default.
 
@@ -8,7 +8,7 @@ ActiveSupport.on_load(:action_controller) do
   wrap_parameters format: [:json]
 end
 
-# Disable root element in JSON by default.
-ActiveSupport.on_load(:active_record) do
-  self.include_root_in_json = false
-end
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#   self.include_root_in_json = true
+# end

data/test/dummy/config/{navigation/de.yml → navigations/application.de.yml}

@@ -10,10 +10,10 @@
     - title: "Logo Design"
     - title: "Web Development"
     - title: "Heuere uns an"
-      redirect: "/kontakt" # links to Contact page
+      refer: "/kontakt" # refers to /kontakt
 
 - title: "Über uns"
-  redirect: true # redirects /about to /about/our-team
+  refer: true # refers to /uber-uns/unser-team
   nodes:
     - title: "Unser Team"
       layout:
@@ -26,11 +26,11 @@
     - title: "Partner"
       nodes:
         - title: "Daniel Puglisi"
-          url: "http://danielpuglisi.com"
+          refer: "http://danielpuglisi.com"
         - title: "Codegestalt"
-          url: "http://codegestalt.com"
+          refer: "http://codegestalt.com"
         - title: "Kreatify"
-          url: "http://kreatify.com"
+          refer: "http://kreatify.com"
 
 - title: "Kontakt"
 - title: "I18n"