amber 0.2.6 → 0.3.8

data/lib/amber/site_configuration.rb

@@ -12,9 +12,11 @@ module Amber
 
     attr_accessor :title
     attr_accessor :pagination_size
-    attr_accessor :mount_points
     attr_accessor :locales
     attr_accessor :default_locale
+    attr_accessor :path_prefix
+    alias :path :path_prefix
+    attr_accessor :short_paths
 
     attr_accessor :menu
 
@@ -29,8 +31,13 @@ module Amber
     attr_accessor :locales_dir
     attr_accessor :timestamp
 
+    # an array of SiteConfigurations that are attached as sub-sites
+    # to this one.
+    attr_accessor :children
+
     extend Forwardable
-    def_delegators :@site, :pages, :find_page, :find_pages, :find_page_by_path, :find_page_by_name, :continue_on_error
+    def_delegators :@site, :pages, :find_page, :find_pages, :find_page_by_path,
+      :find_page_by_name, :continue_on_error, :root
 
     ##
     ## CLASS METHODS
@@ -48,6 +55,7 @@ module Amber
     # accepts a file_path to a configuration file.
     #
     def initialize(site, root_dir, options={})
+      @children = []
       @site = site
       @root_dir = File.expand_path(find_in_directory_tree('amber', 'config.rb', root_dir))
       if @root_dir == '/'
@@ -61,9 +69,6 @@ module Amber
       @menu_file   = config_path('menu.txt')
       @locales_dir = config_path('locales')
       @layouts_dir = config_path('layouts')
-      @path = '/'
-      @mount_points = []
-      @mount_points << self
       @title = "untitled"
       @pagination_size = 20
 
@@ -71,15 +76,21 @@ module Amber
       @menu.load(@menu_file) if @menu_file
 
       self.eval
+      @path_prefix = options[:path_prefix] if options[:path_prefix]
       self.cleanup
 
       reset_timestamp
       Render::Layout.load(@layouts_dir)
     end
 
-    #def include_site(directory_source, options={})
-    #  @mount_points << SiteMountPoint.new(self, directory_source, options)
-    #end
+    #
+    # map('/path' => '../othersite')
+    #
+    def map(path_to_directory_source, options={})
+      path, root_dir = path_to_directory_source.to_a.first
+      config = self.load(@site, root_dir, {:path_prefix => path})
+      @site.add_config(config)
+    end
 
     def cleanup
       @locale ||= I18n.default_locale
@@ -92,11 +103,15 @@ module Amber
           nil
         end
       }.compact
+      if @path_prefix
+        @path_prefix.gsub!(%r{^/|/$}, '')
+        @path_prefix = nil if @path_prefix == ''
+      end
     end
 
-    def pages_changed?
-      @mount_points.detect {|mp| mp.changed?}
-    end
+    #def pages_changed?
+    #  self.changed? || @children.detect {|child| child.changed?}
+    #end
 
     def eval
       self.instance_eval(File.read(@config_file), @config_file)

data/lib/amber/static_page.rb

@@ -13,9 +13,8 @@ module Amber
       :name,                # the name of the page
       :file_path,           #
       :parent,              # parent page (nil for root page)
-      :mount_point,         # associated SiteConfiguration
-      :site,                # associated Site
-      :locales,             # currently unused
+      :config,              # associated SiteConfiguration (site might have several)
+      :site,                # associated Site (only one)
       :valid                # `false` if there is some problem with this page.
 
     attr_reader :props      # set of page properties (PropertySet)
@@ -28,7 +27,7 @@ module Amber
 
     FORBIDDEN_PAGE_CHARS_RE = /[A-Z\.\?\|\[\]\{\}\$\^\*~!@#%&='"<>]/
 
-    def initialize(parent, name, file_path=nil)
+    def initialize(parent, name, file_path=nil, path_prefix="/")
       @valid     = true
       @children  = PageArray.new  # array of StaticPages
       @nav_title = {} # key is locale
@@ -39,11 +38,11 @@ module Amber
       # set @parent & @path
       if parent
         @parent = parent
-        @mount_point = @parent.mount_point
+        @config = @parent.config
         @parent.add_child(self)
         @path = [@parent.path, @name].flatten.compact
       else
-        @path = []
+        @path = (path_prefix||"").split('/')
       end
 
       if @name =~ FORBIDDEN_PAGE_CHARS_RE
@@ -113,32 +112,47 @@ module Amber
       @props.prop(*args)
     end
 
+    #
+    # Returns array of locale symbols for all locales with properties set
+    # Note: there might be a content for a locale that does not show up in this array,
+    # if the content file does not set any properties.
+    #
+    def locales
+      @props.locales
+    end
+
     #
     # returns an array of normalized aliases based on the :alias property
     # defined for a page.
     #
     # aliases are defined with a leading slash for absolute paths, or without a slash
     # for relative paths. this method converts this to a format that amber uses
-    # (all absolute, with no leading slash).
-    #
-    # currently, we do not maintain per-locale paths or aliases.
+    # (all absolute, with no leading slash, as an array instead of a string).
     #
-    def aliases
+    def aliases(locale=I18n.default_locale)
       @aliases ||= begin
-        if @props.alias.nil?
-          []
-        else
-          @props.alias.collect {|alias_path|
-            if alias_path =~ /^\//
-              alias_path.sub(/^\//, '')
-            elsif @parent
-              (@parent.path + [alias_path]).join('/')
+        aliases_hash = Hash.new([])
+        @props.locales.each do |locale|
+          aliases = @props.prop_without_inheritance(locale, :alias)
+          aliases_hash[locale] = begin
+            if aliases.nil?
+              []
             else
-              alias_path
+              [aliases].flatten.collect {|alias_path|
+                if alias_path =~ /^\//
+                  alias_path.sub(/^\//, '').split('/')
+                elsif @parent
+                  @parent.path + [alias_path]
+                else
+                  alias_path.split('/')
+                end
+              }
             end
-          }
+          end
         end
+        aliases_hash
       end
+      @aliases[locale]
     end
 
     protected

data/lib/amber/static_page/filesystem.rb

@@ -95,15 +95,9 @@ module Amber
     # e.g. /home/user/mysite/public/about-us/contact/index.en.html
     #
     def destination_file(dest_dir, locale)
-      if @simple_page
-        File.join(dest_dir, "#{File.join(@path)}.#{locale}.html")
-      else
-        File.join(dest_dir, *@path, "index.#{locale}.html")
-      end
+      File.join(dest_dir, *@path, "index.#{locale}.html")
     end
 
-    private
-
     # e.g. en, de, pt
     LOCALES_RE  = /(?<locale>#{Amber::POSSIBLE_LANGUAGE_CODES.join('|')})/
     LOCALES_GLOB = "{#{Amber::POSSIBLE_LANGUAGE_CODES.join(',')}}"
@@ -118,6 +112,8 @@ module Amber
 
     SIMPLE_FILE_MATCH_RE = lambda {|name| /^(#{Regexp.escape(name)})(\.#{LOCALES_RE})?\.#{PAGE_SUFFIXES_RE}$/ }
 
+    private
+
     #
     # returns true if the name of a file could be a 'simple' static page
     # that is not a directory.

data/lib/amber/static_page/page_properties.rb

@@ -111,6 +111,13 @@ module Amber
         end
       end
 
+      #
+      # returns an array of locale symbols that are active for this page.
+      #
+      def locales
+        @locales.keys
+      end
+
       #
       # tries to get the value of an inherited variable
       #

data/lib/amber/static_page/render.rb

@@ -34,8 +34,26 @@ module Amber
     def render_to_file(dest_dir, options={})
       render_content_files(dest_dir, options)
       render_assets(dest_dir)
-      if aliases.any?
-        link_page_aliases(dest_dir)
+      @props.locales.each do |locale|
+        if aliases(locale).any?
+          link_page_aliases(dest_dir, aliases(locale), locale)
+        end
+      end
+    end
+
+    #
+    # creates symlinks for aliases to this page.
+    # called by Page#render_to_file and Site#render_short_path_aliases
+    #
+    def link_page_aliases(dest_dir, alias_paths, locale=I18n.default_locale)
+      alias_paths.each do |alias_path|
+        alias_file_path = File.join(dest_dir, alias_path)
+        #if locale != I18n.default_locale
+        #  alias_file_path += ".#{locale}"
+        #end
+        alias_file_path = Pathname.new(alias_file_path)
+        page_file_path  = Pathname.new(File.join(dest_dir, *@path))
+        symlink(page_file_path, alias_file_path)
       end
     end
 
@@ -69,40 +87,38 @@ module Amber
       end
     end
 
-    # called only by render_to_file
-    # for now, we only support aliases on pages that are directories, for simplicity sake.
-    def link_page_aliases(dest_dir)
-      if @simple_page
-        Amber.logger.warn { "The page `#{@file_path}` sets a path alias, but currently aliases are only supported for directory-based pages. Skipping." }
+    #
+    # create a symlink. arguments must be of type Pathname.
+    #
+    def symlink(from_path, to_path)
+      to_path = realpath(to_path)
+      target = from_path.relative_path_from(to_path).to_s.sub(/^\.\.\//, '')
+      if !to_path.dirname.directory?
+        Amber.logger.warn { "On page `#{@file_path}`, the parent directories for alias name `#{to_path}` don't exist. Skipping alias." }
+        return
+      end
+      if to_path.exist? && to_path.symlink?
+        File.unlink(to_path)
+      end
+      if !to_path.exist?
+        Amber.logger.debug { "Symlink #{to_path} => #{target}" }
+        FileUtils.ln_s(target, to_path)
+      end
+    end
+
+    def realpath(pathname)
+      dir = pathname.dirname
+      if dir.directory? || dir.symlink?
+        dir.realpath + pathname.basename
       else
-        aliases.each do |alias_path|
-          alias_path = Pathname.new(File.join(dest_dir, alias_path))
-          if !File.directory?(File.dirname(alias_path))
-            Amber.logger.warn { "On page `#{@file_path}`, the parent directories for alias name `#{alias_path}` don't exist. Skipping alias." }
-          else
-            page_path = Pathname.new(File.join(dest_dir, *@path))
-            target = page_path.relative_path_from(alias_path).to_s.sub(/^\.\.\//, '')
-            if File.exists?(alias_path)
-              if File.symlink?(alias_path)
-                File.unlink(alias_path)
-                Amber.logger.debug { "Alias #{alias_path} => #{target}" }
-                FileUtils.ln_s(target, alias_path)
-              else
-                Amber.logger.warn { "The page `#{@file_path}` sets a path alias, but there is already a file in the way (`#{alias_path}`)" }
-              end
-            else
-              Amber.logger.debug { "Alias #{alias_path} => #{target}" }
-              FileUtils.ln_s(target, alias_path)
-            end
-          end
-        end
+        pathname
       end
     end
 
     # called only by render_to_file
     def render_content_files(dest_dir, options)
-      view = Render::View.new(self, self.mount_point)
-      @mount_point.locales.each do |file_locale|
+      view = Render::View.new(self, @config)
+      @config.locales.each do |file_locale|
         content_file = content_file(file_locale)
         next unless content_file
         dest = destination_file(dest_dir, file_locale)
@@ -112,7 +128,7 @@ module Amber
         if options[:force] || !File.exist?(dest) || File.mtime(content_file) > File.mtime(dest)
           File.open(dest, 'w') do |f|
             layout = @props.layout || 'default'
-            f.write view.render({file: content_file, layout: layout}, {locale: file_locale})
+            f.write view.render({page: self, layout: layout}, {locale: file_locale})
           end
         end
       end

data/lib/amber/templates/apache_config.erb

@@ -0,0 +1,12 @@
+  AccessFileName .htaccess
+  DocumentRoot "/<%= @directory %>"
+  <Directory "/<%= @directory %>">
+    AllowOverride FileInfo Indexes Options=All,MultiViews
+    <IfModule !mod_authz_core.c>
+      Order deny,allow
+      Allow from all
+    </IfModule>
+    <IfModule mod_authz_core.c>
+      Require all granted
+    </IfModule>
+  </Directory>

data/lib/amber/templates/apache_config_with_prefix.erb

@@ -0,0 +1,14 @@
+  AccessFileName .htaccess
+  AliasMatch ^/[a-z]{2}/<%=@site.path_prefix%>(/.+|/|)$ "/<%=@directory%>/$1"
+  Alias /<%=@site.path_prefix%> "/<%=@directory%>/"
+
+  <Directory "/<%=@directory%>/">
+    AllowOverride FileInfo Indexes Options=All,MultiViews
+    <IfModule !mod_authz_core.c>
+      Order deny,allow
+      Allow from all
+    </IfModule>
+    <IfModule mod_authz_core.c>
+      Require all granted
+    </IfModule>
+  </Directory>

data/lib/amber/templates/htaccess.erb

@@ -0,0 +1,176 @@
+##
+## AUTO NEGOTIATED LOCALE
+##
+
+LanguagePriority en
+ForceLanguagePriority Prefer Fallback
+DirectoryIndex index
+DirectorySlash Off
+Options +MultiViews
+
+##
+## REWRITES
+##
+
+Options +FollowSymLinks
+RewriteEngine On
+
+<% if @site.path_prefix %>
+<% @path_prefix = Regexp.escape(@site.path_prefix) %>
+RewriteBase /<%= @path_prefix %>/
+
+##
+## remove trailing slashes (except for paths where we added the slash)
+##
+
+# /path_prefix/foo/bar/ => /path_prefix/foo/bar
+# /en/path_prefix/foo/bar => /en/path_prefix/foo/bar
+# rewrite sees this as:
+# /path_prefix/foo/bar.en.html/ => /path_prefix/foo/bar
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_URI} ^/([a-z]{2}/)?(<%= @path_prefix %>/)?.+\.html/$
+RewriteRule ^(.+)\.[a-z]{2}\.html/$ /%1%2$1 [R=307,L]
+
+# en/path_prefix/blah/ => /en/path_prefix/blah
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_URI} ^/([a-z]{2})/
+RewriteCond %{REQUEST_URI} !\.html$
+RewriteRule ^(.+)/$ /%1/<%= @path_prefix %>/$1 [R=307,L]
+
+# en/path_prefix/ => en/path_prefix
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_URI} ^/([a-z]{2})/<%= @site.path_prefix %>/$
+RewriteRule ^$ /%1/<%= @path_prefix %> [R=307,L]
+
+# path_prefix/ => path_prefix
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_URI} /$
+RewriteRule ^$ /<%= @path_prefix %> [R=307,L]
+
+# path_prefix/blah/ => path_prefix/blah
+RewriteCond %{QUERY_STRING} !end
+RewriteRule ^(.+)/$ $1 [R=307,L]
+
+##
+## rewrite all paths with a local prefix to use
+## the appropriate index.{local}.html file
+##
+
+## /en/prefix_path => /index.en.html
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_URI} ^/([a-z]{2})/<%= @path_prefix %>$
+RewriteRule ^(.*) index.%1.html?end [L]
+
+# /en/path_prefix/blah => /path_prefix/blah/index.en.html
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_URI} !/$
+RewriteCond %{REQUEST_URI} ^/([a-z]{2})/
+RewriteCond %{REQUEST_FILENAME}/index.%1.html -f
+RewriteRule ^(.*) $1/index.%1.html?end [L]
+
+# /de/path_prefix/foo/bar => /path_prefix/foo/bar.de.html
+# rewrite sees this as:
+# /de/path_prefix/foo/bar.en.html => /path_prefix/foo/bar.de.html
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_URI} !/$
+RewriteCond %{REQUEST_FILENAME} en\.html$
+RewriteCond %{REQUEST_FILENAME} -f
+RewriteCond %{REQUEST_URI} ^/([a-z]{2})/
+RewriteRule ^(.*)?\.en\.html $1.%1.html?end [L]
+
+##
+## internally simulate a trailing slashes for directories in order
+## to trigger DirectoryIndex and autonegotiated locale.
+##
+
+# /path_prefix/foo/bar => /path_prefix/foo/bar/
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_FILENAME} -d
+RewriteRule ^(.*[^/])$ $1/?end [PT]
+
+# /path_prefix => /path_prefix/
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_FILENAME} -d
+RewriteRule ^$ /<%= @path_prefix %>/?end [PT]
+
+##
+## redirect assets that are locale prefixed
+## (in order to allow relative paths)
+##
+
+# e.g. /de/foo/assets/style.css => /foo/assets/style.css
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_FILENAME} -f
+RewriteCond %{REQUEST_URI} ^/([a-z]{2})/<%= @path_prefix %>/
+RewriteRule (.*) /$1 [R=307,L]
+
+<% else %>
+RewriteBase /
+
+##
+## remove trailing slashes (except for paths where we added the slash)
+##
+
+# /en/ => /en
+RewriteCond %{QUERY_STRING} !end
+RewriteRule ^([a-z]{2})/$ /$1 [R=307,L]
+
+# /en/aaa/ => /en/aaa
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_URI} ^/([a-z]{2})/
+RewriteCond %{REQUEST_URI} !\.html$
+RewriteRule ^(.+)/$ /$1 [R=307,L]
+
+# /foo/bar.en.html/ => /foo/bar
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{REQUEST_URI} \.html/$
+RewriteRule ^(.+)\.[a-z]{2}\.html/$ $1 [R=307,L]
+
+# /foo/bar/ => /foo/blah
+RewriteCond %{QUERY_STRING} !end
+RewriteRule ^(.+)/$ $1 [R=307,L]
+
+##
+## rewrite all paths with a local prefix to use
+## the appropriate index.{local}.html file or
+## filename.{local}.html file.
+##
+
+# /en => /index.en.html
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{DOCUMENT_ROOT}/index.$1.html -f
+RewriteCond %{REQUEST_URI} ^/([a-z]{2})$
+RewriteRule ^(.*) /index.%1.html?end [L]
+
+# /en/aaa => /aaa/index.en.html
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{DOCUMENT_ROOT}/$2/index.$1.html -f
+RewriteRule ^([a-z]{2})/(.*) /$2/index.$1.html?end [L]
+
+# /de/foo/bar => /foo/bar.de.html
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{DOCUMENT_ROOT}/$2.$1.html -f
+RewriteRule ^([a-z]{2})/(.*) /$2.$1.html?end [L]
+
+##
+## internally simulate a trailing slashes for directories in order
+## to trigger DirectoryIndex and autonegotiated locale.
+##
+
+# /foo/bar => /foo/bar/
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{DOCUMENT_ROOT}/$1 -d
+RewriteRule ^(.*[^/])$ /$1/?end [PT]
+
+##
+## redirect assets that are locale prefixed
+## (in order to allow relative paths)
+##
+
+# e.g. /de/foo/assets/style.css => /foo/assets/style.css
+RewriteCond %{QUERY_STRING} !end
+RewriteCond %{DOCUMENT_ROOT}/$2 -f
+RewriteRule ^([a-z]{2})/(.*) /$2 [R=307,L]
+
+<% end %>
+