locomotivecms_steam 1.4.1 → 1.5.0.beta1

data/lib/locomotive/steam/middlewares/locale_redirection.rb

@@ -8,11 +8,13 @@ module Locomotive::Steam
     #
     class LocaleRedirection < ThreadSafe
 
-      include Helpers
+      include Concerns::Helpers
 
       def _call
-        if url = redirect_url
-          redirect_to url
+        if redirect_to_root_path_with_lang
+          redirect_to(path_with_locale, 302)
+        elsif url = redirect_url
+          redirect_to(url, redirect_type)
         end
       end
 
@@ -21,13 +23,20 @@ module Locomotive::Steam
       def redirect_url
         if apply_redirection?
           if site.prefix_default_locale
-            path_with_default_locale if locale_not_mentioned_in_path?
+            path_with_locale if locale_not_mentioned_in_path?
           else
             env['steam.path'] if default_locale? && locale_mentioned_in_path?
           end
         end
       end
 
+      # only applied if redirect_url is not nil
+      def redirect_type
+        # We don't want a permanent redirection for the index page in case
+        # the user wants to change the current locale from the index page.
+        self.path == '/' && self.locales.size > 1 ? 302 : 301
+      end
+
       def apply_redirection?
         site.locales.size > 1 && request.get? && env['PATH_INFO'] != '/sitemap.xml'
       end
@@ -44,12 +53,15 @@ module Locomotive::Steam
         !locale_mentioned_in_path?
       end
 
-      def path_with_default_locale
+      def path_with_locale
         modify_path do |segments|
-          segments.insert(1, site.default_locale)
+          segments.insert(1, locale)
         end
       end
 
+      def redirect_to_root_path_with_lang
+        locale_not_mentioned_in_path? && path.gsub(/^\//, '') == '' && !default_locale?
+      end
     end
   end
 

data/lib/locomotive/steam/middlewares/logging.rb

@@ -5,7 +5,7 @@ module Locomotive::Steam
     #
     class Logging
 
-      include Helpers
+      include Concerns::Helpers
 
       attr_accessor_initialize :app
 

data/lib/locomotive/steam/middlewares/page.rb

@@ -6,7 +6,7 @@ module Locomotive::Steam
     #
     class Page < ThreadSafe
 
-      include Helpers
+      include Concerns::Helpers
 
       def _call
         return env['steam.page'] if env['steam.page']
@@ -26,12 +26,12 @@ module Locomotive::Steam
       protected
 
       def fetch_page
-        page = page_finder.match(path).tap do |pages|
-          if pages.size > 1
-            self.log "Found multiple pages: #{pages.map(&:title).join(', ')}"
-          end
-        end.first
+        page = site.routes.present? ? fetch_page_from_routes : nil
+
+        # if we don't find it from the site routes, try with the paths
+        page ||= fetch_page_from_paths
 
+        # make sure the page can be displayed, otherwise, display a nice 404 error page
         if page && (page.published? || page.not_found? || live_editing?)
           page
         else
@@ -39,6 +39,35 @@ module Locomotive::Steam
         end
       end
 
+      def fetch_page_from_routes
+        site.routes.each do |definition|
+          route, handle = definition['route'], definition['page_handle']
+
+          _route = route.gsub(/:([a-z][a-z0-9_]+)/, '(?<\1>[^\/]+)').gsub(/^\//, '')
+          regexp = Regexp.new(/^#{_route}$/i)
+
+          if (matches = path.match(regexp))
+            log "Route found! #{route} (#{handle})"
+
+            # we want the named route parameters in the request params object
+            # because they will be needed in the liquid template.
+            self.merge_with_params(matches.named_captures)
+
+            return page_finder.by_handle(handle, false)
+          end
+        end
+
+        nil # out of luck, find another way to get the page
+      end
+
+      def fetch_page_from_paths
+        page_finder.match(path).tap do |pages|
+          if pages.size > 1
+            self.log "Found multiple pages: #{pages.map(&:title).join(', ')}"
+          end
+        end.first
+      end
+
       def page_finder
         services.page_finder
       end

data/lib/locomotive/steam/middlewares/path.rb

@@ -16,7 +16,7 @@ module Locomotive::Steam
       protected
 
       def set_path!(env)
-        path = (env['steam.path'] || request.path_info).dup
+        path = env['steam.path'].dup
 
         path.gsub!(/\.[a-zA-Z][a-zA-Z0-9]{2,}$/, '')
         path.gsub!(/^\//, '')

data/lib/locomotive/steam/middlewares/private_access.rb

@@ -8,7 +8,7 @@ module Locomotive::Steam
     #
     class PrivateAccess < ThreadSafe
 
-      include Helpers
+      include Concerns::Helpers
 
       def _call
         return if env['steam.private_access_disabled']

data/lib/locomotive/steam/middlewares/redirection.rb

@@ -8,7 +8,7 @@ module Locomotive::Steam
     #
     class Redirection < ThreadSafe
 
-      include Helpers
+      include Concerns::Helpers
 
       def _call
         begin

data/lib/locomotive/steam/middlewares/renderer.rb

@@ -3,7 +3,8 @@ module Locomotive::Steam
 
     class Renderer < ThreadSafe
 
-      include Helpers
+      include Concerns::Helpers
+      include Concerns::LiquidContext
 
       def _call
         if page
@@ -45,87 +46,6 @@ module Locomotive::Steam
         end
       end
 
-      def liquid_context
-        ::Liquid::Context.new(liquid_assigns, {}, liquid_registers, true)
-      end
-
-      def liquid_registers
-        {
-          request:        request,
-          locale:         locale,
-          site:           site,
-          page:           page,
-          services:       services,
-          repositories:   services.repositories,
-          logger:         Locomotive::Common::Logger,
-          live_editing:   !!env['steam.live_editing'],
-          session:        request.session
-        }
-      end
-
-      def liquid_assigns
-        _default_liquid_assigns.merge(
-          _locale_liquid_assigns.merge(
-            _request_liquid_assigns.merge(
-              _http_actions_liquid_assigns.merge(
-                _steam_liquid_assigns))))
-      end
-
-      def _default_liquid_assigns
-        {
-          'current_page'      => params[:page],
-          'params'            => params.stringify_keys,
-          'now'               => Time.zone.now,
-          'today'             => Date.today,
-          'mode'              => Locomotive::Steam.configuration.mode,
-          'wagon'             => Locomotive::Steam.configuration.mode == :test,
-          'live_editing'      => live_editing?
-        }
-      end
-
-      def _steam_liquid_assigns
-        {
-          'site'          => site.to_liquid,
-          'page'          => page.to_liquid,
-          'models'        => Locomotive::Steam::Liquid::Drops::ContentTypes.new,
-          'contents'      => Locomotive::Steam::Liquid::Drops::ContentTypes.new,
-          'session'       => Locomotive::Steam::Liquid::Drops::SessionProxy.new,
-        }.merge(env['steam.liquid_assigns'])
-      end
-
-      def _locale_liquid_assigns
-        {
-          'locale'         => locale.to_s,
-          'default_locale' => site.default_locale.to_s,
-          'locales'        => site.locales.map(&:to_s)
-        }
-      end
-
-      def _request_liquid_assigns
-        {
-          'base_url'    => request.base_url,
-          'fullpath'    => request.fullpath,
-          'http_method' => request.request_method,
-          'ip_address'  => request.ip,
-          'mounted_on'  => mounted_on,
-          'path'        => request.path,
-          'referer'     => request.referer,
-          'url'         => request.url,
-          'user_agent'  => request.user_agent,
-          'host'        => request.host_with_port
-        }
-      end
-
-      def _http_actions_liquid_assigns
-        {
-          'head?'    => request.head?,
-          'get?'    => request.get?,
-          'post?'   => request.post?,
-          'put?'    => request.put?,
-          'delete?' => request.delete?
-        }
-      end
-
     end
 
   end

data/lib/locomotive/steam/middlewares/robots.rb

@@ -3,7 +3,7 @@ module Locomotive::Steam
 
     class Robots
 
-      include Helpers
+      include Concerns::Helpers
 
       attr_accessor_initialize :app
 

data/lib/locomotive/steam/middlewares/section.rb

@@ -0,0 +1,56 @@
+module Locomotive::Steam
+  module Middlewares
+    class Section < ThreadSafe
+
+      include Concerns::Helpers
+      include Concerns::LiquidContext
+
+      def _call
+        if section_type = get_section_type
+          html = render(section_type)
+          render_response(html, 200)
+        end
+      end
+
+      private
+
+      def get_section_type
+        request.get_header('HTTP_LOCOMOTIVE_SECTION_TYPE')
+      end
+
+      def section_finder
+        services.section_finder
+      end
+
+      def render(section_type)
+        document = Liquid::Template.parse(liquid_source(section_type))
+        document.render(liquid_context)
+      end
+
+      def liquid_source(section_type)
+        "{% section '#{section_type}' %}"
+      end
+
+      def liquid_registers
+        super.merge(_section_content: section_content)
+      end
+
+      def section_content
+        # looks like request.body is not always in the right state,
+        # the following statement makes sure of it.
+        request.body.rewind
+
+        if (data = request.body.read).present?
+          JSON.parse(data)['section_content']
+        else
+          {}
+        end
+      end
+
+      def live_editing?
+        true
+      end
+
+    end
+  end
+end

data/lib/locomotive/steam/middlewares/site.rb

@@ -6,7 +6,7 @@ module Locomotive::Steam
     #
     class Site < ThreadSafe
 
-      include Helpers
+      include Concerns::Helpers
 
       def _call
         site = find_site

data/lib/locomotive/steam/middlewares/sitemap.rb

@@ -3,7 +3,7 @@ module Locomotive::Steam
 
     class Sitemap < ThreadSafe
 
-      include Helpers
+      include Concerns::Helpers
 
       def _call
         if env['PATH_INFO'] == '/sitemap.xml' && (page.nil? || page.not_found?)
@@ -14,78 +14,100 @@ module Locomotive::Steam
       private
 
       def build_xml
-        <<-EOF
+        <<-XML
 <?xml version="1.0" encoding="UTF-8"?>
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
-  <url>
-    <loc>#{base_url}</loc>
-    <priority>1.0</priority>
-  </url>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
 #{build_pages_to_xml}
 </urlset>
-        EOF
+        XML
       end
 
       def build_pages_to_xml
+        # we request the data based on the default locale
+        page_repository.locale = site.default_locale
+
         page_repository.published.map do |page|
           next if skip_page?(page)
 
-          build_page_xml(page)
+          _page = Locomotive::Steam::Decorators::I18nDecorator.new(page)
+
+          if page.templatized?
+            build_templatized_page_to_xml(_page)
+          else
+            build_page_to_xml(_page)
+          end
         end.flatten.join.strip
       end
 
-      def build_page_xml(page)
-        _page = Locomotive::Steam::Decorators::I18nDecorator.new(page)
+      def build_page_to_xml(page)
+        entry = { date: page.updated_at.to_date, links: [] }
 
-        site.locales.map do |locale|
-          _page.__locale__ = locale
+        site.locales.each_with_index do |locale, index|
+          page.__locale__ = locale
 
-          next if _page.title.blank? # should be translated
+          # if blank, means that the page is not translated, so skip it
+          next if page.title.blank?
 
-          if _page.templatized?
-            build_templatized_page_xml(_page, locale)
+          if index == 0 # default locale
+            entry[:loc] = url_for(page, locale)
           else
-            page_to_xml(_page, locale)
+            entry[:links] << { locale: locale, href: url_for(page, locale) }
           end
         end
+
+        entry_to_xml(entry)
       end
 
-      def build_templatized_page_xml(page, locale)
+      def build_templatized_page_to_xml(page)
         content_type = repositories.content_type.find(page.content_type_id)
 
-        return nil unless build_templatized_page_xml?(page, content_type, locale)
+        repositories.content_entry.with(content_type).all({ _visible: true }).map do |content_entry|
+          _content_entry  = Locomotive::Steam::Decorators::I18nDecorator.new(content_entry, locale)
+          entry           = { date: content_entry.updated_at.to_date, links: [] }
 
-        repositories.content_entry.with(content_type).all.map do |entry|
-          next unless entry.visible? # only visible content entry
+          site.locales.each_with_index do |locale, index|
+            page.__locale__           = locale
+            _content_entry.__locale__ = locale
 
-          _entry = Locomotive::Steam::Decorators::I18nDecorator.new(entry, locale)
+            # if blank, means that the page or the content entry is not translated, so skip it
+            next if _content_entry._label.blank? || page.title.blank?
 
-          next if _entry._label.blank? # should be translated
+            page.content_entry = _content_entry
 
-          page.content_entry = _entry
+            if index == 0 # default locale
+              entry[:loc] = url_for(page, locale)
+            else
+              entry[:links] << { locale: locale, href: url_for(page, locale) }
+            end
+          end
 
-          page_to_xml(page, locale)
-        end
+          entry_to_xml(entry)
+        end.flatten.join.strip
       end
 
-      def page_to_xml(page, locale)
-        last_modification = (page.content_entry || page).updated_at.to_date
-
-        <<-EOF
+      def entry_to_xml(entry)
+        <<-XML
   <url>
-    <loc>#{base_url}#{url_for(page, locale)}</loc>
-    <lastmod>#{last_modification.to_s('%Y-%m-%d')}</lastmod>
-    <priority>0.9</priority>
+    <loc>#{base_url}#{entry[:loc]}</loc>
+    <lastmod>#{entry[:date].to_s('%Y-%m-%d')}</lastmod>
+    #{entry_links_to_xml(entry[:links])}
   </url>
-        EOF
+        XML
+      end
+
+      def entry_links_to_xml(links)
+        links.map do |link|
+          <<-XML
+     <xhtml:link rel="alternate" hreflang="#{link[:locale]}" href="#{base_url}#{link[:href]}" />
+          XML
+        end.flatten.join.strip
       end
 
       def skip_page?(page)
-        page.index? ||
         page.not_found? ||
         page.layout? ||
         page.redirect? ||
-        (!page.templatized? && !page.listed?)
+        (!page.templatized? && !page.index? && !page.listed?)
       end
 
       def repositories
@@ -100,15 +122,6 @@ module Locomotive::Steam
         services.url_builder.url_for(page, locale)
       end
 
-      def build_templatized_page_xml?(page, content_type, locale)
-        return true if content_type.localized? || default_locale == locale
-
-        # does the templatized page have the same source
-        # (liquid template) as in the default locale?
-        # If so, no need to add a xml entry for this page
-        !page.source.blank?
-      end
-
       def base_url
         "#{request.scheme}://#{request.host_with_port}"
       end