amber 0.2.6 → 0.3.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d45088b2c65fd274e44926886b8a70f0a645f73
+  data.tar.gz: 305ef95bcb2143c71331cfe7e702b97ee9f987f1
+SHA512:
+  metadata.gz: 5b4fc64f2b1f57cafa02c21d2392448e64de89648a9ebe54ae06b26b43febcbf5a5b663804c3b7ff3932c5553077ae82be017490ed922ba8571e5c0aaa6ba706
+  data.tar.gz: a6ab0937bad9f67492940655bfbcf1e04e9b79c48e5a9ec5761686b25a39d1c2165d0b54d19f76cf470e6e14e8b55edc30b61a446f4ca22ea8a38f49fd423f44

data/LICENSE

@@ -1,4 +1,17 @@
-GNU AFFERO GENERAL PUBLIC LICENSE
+Licenses
+========================================
+
+Amber code is copyright (c) 2015 LEAP Encrption Access Project and licensed
+under the GNU AGPL, a copy of which is provided below.
+
+Additionally, Amber redistributes the localization files from Rails (in
+`amber/locales/rails-i18n/`). These files are copyright (c) 2008-2012 Sven
+Fuchs and contributors (see https://github.com/svenfuchs/rails-
+i18n/contributors), and distributed under an MIT license.
+
+GNU Affero General Public License
+========================================
+
                        Version 3, 19 November 2007
 
  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>

data/README.md

@@ -1,26 +1,39 @@
 Amber
 ===================================
 
-Amber is a super simple and flexible static website generator, with good support for localization and navigation.
+Amber is a super simple and flexible static website generator, with good
+support for localization and navigation.
 
 This is still experimental code.
 
-Amber has much in common with other static page generators, but has several features that make it unique:
+Amber has much in common with other static page generators, but has several
+features that make it unique:
 
 * I18n: Primary focus is on very good multi-lingual and localization support.
+  By using a bunch of Apache tricks, Amber is able to create static websites
+  which work   more like dynamic sites when it comes to selecting the
+  appropriate locale.
 * Inheritance: Properties are inherited in the page hierarchy.
-* TOC: Support for table of contents (including inserting TOC into other pages).
-* Flexible: Ability to set custom page path aliases, render partials, rich navigation, and so on.
+* TOC: Support for table of contents (including inserting TOC into other pages,
+  and TOC generation from pages generated by a combination of partials and
+  different markup languages).
+* Flexible: Ability to set custom page path aliases, render partials, rich
+  navigation, and so on.
+
+Amber allows ERB (ruby code) in all page markup types, making it unsuitable for
+any website where you do not trust the source of the page text.
 
 Installation
 ---------------------------------
 
 Installing from gem:
 
+    sudo apt-get install rubygems ruby-dev build-essential
     sudo gem install amber
 
-Installing from source:
+Alternately, you can run directly from source:
 
+    sudo apt-get install rubygems ruby-dev build-essential
     sudo gem install bundler
     git clone https://github.com/leapcode/amber
     cd amber
@@ -30,7 +43,8 @@ Installing from source:
 Directory structure
 ---------------------------------
 
-A simple website has this structure:
+A simple website has three main folders, `amber`, `pages`, and `public`. For
+example:
 
     mysite/
       amber/
@@ -42,15 +56,20 @@ A simple website has this structure:
           default.haml
       pages/
         page1.en.md
-        page2.en.md
+        page1.de.md
       public/
-        page1.en.html
-        page1.en.html
+        page1/
+          en.html
+          de.html
+
+The `public` folder is automatically generated from the `pages` folder.
+Configuration lives in `amber`.
 
-menu.txt
+Menu
 ---------------------------------
 
-A page does not show up in the navigation unless it appears in menu.txt.
+A page does not show up in the navigation unless it appears in
+`amber/menu.txt`.
 
 The order in menu.txt determines the order in the navigation. For example:
 
@@ -66,7 +85,8 @@ Page hierarchy is represented by two spaces:
         ddd
     eee
 
-The items in the menu.txt file must match the names of the pages (the filename with the suffix and locale stripped away).
+The items in the menu.txt file must match the names of the pages (the filename
+with the suffix and locale stripped away).
 
 Supported syntaxes
 ---------------------------------
@@ -76,13 +96,44 @@ Depending the the file extension, the file with be parsed like so:
     .haml       -- HAML
     .md         -- Markdown
     .markdown   -- Markdown
-    .txt        -- Textile
+    .text       -- Textile
     .textile    -- Textile
-    .rst        -- ReStructuredText
+    .html       -- HTML
+
+You can use the native linking method for each markup, or you can use the
+Amber link method:
+
+    [[label -> page-name]]
+    or
+    [[label => page-name]]
+    or
+    [[label -> absolute-url]]
+    or
+    [[page-name]]
+
+In these examples, `page-name` can be the name of the page, optionally
+qualified by some context. For example, if you had two pages called
+`security`, you could link to `[[chat/security]]` or `[[email/security]]`.
+
+This double bracket link notation will automatically find the right
+path for the page with the specified name. Also, Amber will warn you if the page
+name is missing and it will ensure that the link is created with the correct
+language prefix. In haml, you can get the same effect using
+`link 'label' => 'page-name'`
 
-Markdown is rendered using RDiscount, Textile is rendered using RedCloth, and RST is rendered using docutils. Markdown is recommended, because it supports table of contents, although the markup is limited.
+If writing in a right to left script, the links look like:
 
-There are a couple options to preview your source files without needing to run the web server:
+    [[page-name <= label]]
+
+But only if your text editor correctly displays right to left script.
+
+The arrows `->` and `=>` are used interchangeably.
+
+Previewing pages
+-------------------------------------
+
+To preview your site, run `amber server`. Alternately, there are a couple
+options to preview your source files without needing to run the web server:
 
 * Markdown preview for Chrome: https://chrome.google.com/webstore/detail/markdown-preview/jmchmkecamhbiokiopfpnfgbidieafmd
 * Markdown preview for Sublime: https://github.com/revolunet/sublimetext-markdown-preview
@@ -91,9 +142,7 @@ There are a couple options to preview your source files without needing to run t
 Setting page properties
 ---------------------------------
 
-HAML files are rendered as templates, but the other lightweight markup files are treated as static files.
-
-The one exception is that every file can have a "properties header". It looks like this:
+Every file can have a "properties header". It looks like this:
 
     @title = "A fine page"
     @toc = false
@@ -102,6 +151,13 @@ The one exception is that every file can have a "properties header". It looks li
 
 The properties start with '@' and are stripped out of the source file before it is rendered. Property header lines are evaluated as ruby. All properties are optional and they are inherited, including `@title`.
 
+For haml files, the syntax is slightly different:
+
+    - @title = "A fine page"
+    - @toc = false
+
+    %p continue on here with body text.
+
 Available properties:
 
 * `@title` -- The title for the page, appearing as in an H1 on the top of the page and as the HTML title. Also used for navigation title if `@nav_title` is not set. The inline H1 title does not appear unless `@title` is explicitly set for this page (i.e. the inherited value of `@title` does not trigger the automatic H1).
@@ -112,3 +168,16 @@ Available properties:
 * `@this.alias` -- Alternate paths for the page to be rendered on. May be an array. The first path will be used when linking.
 
 To make a property none-inheritable, specify it like so: `@this.layout = 'home'`. For some properties, like `alias`, it does not make sense for the property to be inheritable.
+
+Troubleshooting
+-----------------------------------
+
+If you get an error at some point like this:
+
+    WARNING: Nokogiri was built against LibXML version 2.8.0, but has dynamically loaded 2.9.1
+
+It just means that libxml has been upgraded since the gem nokogiri was installed. To fix, run this:
+
+    sudo gem pristine nokogiri
+
+

data/bin/amber

@@ -1,7 +1,11 @@
 #!/usr/bin/env ruby
 
 if ARGV.include?('--debug')
-  require 'debugger'
+  if RUBY_VERSION =~ /^2/
+    require 'byebug'
+  else
+    require 'debugger'
+  end
 end
 
 begin
@@ -25,8 +29,10 @@ def process_command_line_arguments
       when 'rebuild'     then @command = ARGV.shift
       when 'clean'       then @command = 'clear'; ARGV.shift
       when 'clear'       then @command = ARGV.shift
-      when 'server'      then @command = ARGV.shift
-      when '--port'      then ARGV.shift; @port = ARGV.shift
+      when 'server'      then @command = ARGV.shift; @command_arg = ARGV.shift
+      when 'apache'      then @command = ARGV.shift; @command_arg = ARGV.shift
+      when 'version'     then version
+      when '--version'   then version
       when '--debug'     then ARGV.shift
       when '--help'      then usage
       when 'help'        then usage
@@ -45,21 +51,28 @@ def usage(msg=nil)
   $stderr.puts("Usage: #{File.basename($0)} [OPTIONS] COMMAND")
   $stderr.puts
   $stderr.puts("COMMAND may be one or more of:
-  init DIRECTORY   -- create a new amber site in DIRECTORY
-  build            -- render static html pages
-  rebuild          -- runs `clear` then `build`
-  server           -- runs mini-web server at localhost:8000
-  clear            -- erase static html pages
-  clean            -- alias for clear
-  help             -- this message")
+  init DIRECTORY         -- Create a new amber site in DIRECTORY.
+  build                  -- Render static html pages.
+  rebuild                -- Runs `clear` then `build`.
+  server [[HOST][:PORT]] -- Runs mini web server bound to HOST:PORT (defaults to #{Amber::DEFAULT_HOST}:#{Amber::DEFAULT_PORT}).
+  clear                  -- Erase static HTML pages.
+  clean                  -- Alias for `clear`.
+  apache DIRECTORY       -- Prints out appropriate apache2 config for the given DIRECTORY.
+  help                   -- This message.
+  version                -- Print version and exit.")
   $stderr.puts
   $stderr.puts("OPTIONS may be one or more of:
-  -v               -- run in verbose mode
-  --debug          -- enable debugger
-  --port PORT      -- sets the port for the `server` command (default 8000)")
+  -v                     -- Run in verbose mode.
+  --version              -- Print version and exit.
+  --debug                -- Enable debugger.")
   exit(2)
 end
 
+def version
+  puts Amber::VERSION
+  exit
+end
+
 def main
   process_command_line_arguments
   if @verbose

data/lib/amber.rb

@@ -1,60 +1,45 @@
 # encoding: utf-8
 
+# enforce UTF8 as the default, even if LANG environment
+# variable says otherwise.
+Encoding.default_internal = Encoding::UTF_8
+Encoding.default_external = Encoding::UTF_8
+
 require 'logger'
-require 'i18n'
-require 'i18n/backend/fallbacks'
-I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
 
-require 'sass'  # sass seems to freak out if require'd after haml.
-require 'haml'  #
+# ensure that we load sass from a gem, not the sass included in some
+# versions of haml.
+gem 'sass'
+require 'sass'
+require 'haml'
 
 module Amber
 
   class MissingTemplate < StandardError
   end
 
-  #
-  # Languages that might possibly be supported.
-  #
-  # https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers
-  #
-  POSSIBLE_LANGUAGES = {
-    :zh => ['中文',       'zh', 1, false],
-    :es => ['Español',   'es', 2, false],
-    :en => ['English',   'en', 3, false],
-    :hi => ['Hindi',     'hi', 4, false],
-    :ar => ['العربية',   'ar', 5, true],
-    :pt => ['Português', 'pt', 6, false],
-    :ru => ['Pyccĸий',   'ru', 7, false],
-    :de => ['Deutsch',   'de', 8, false],
-    :fr => ['Français',  'fr', 10, false],
-    :it => ['Italiano',  'it', 11, false],
-    :el => ['Ελληνικά',  'el', 20, false],
-    :ca => ['Català',    'ca', 101, false]
-  }
-
-  # Although everywhere else we use symbols for locales, this array should be strings:
-  POSSIBLE_LANGUAGE_CODES = POSSIBLE_LANGUAGES.keys.map(&:to_s)
-
   # Possible page suffixes. Only files with these suffixes are treated as pages
-  PAGE_SUFFIXES = %w(haml md markdown text textile rst html)
-
-  def self.logger
-    @logger ||= begin
-      logger = Logger.new(STDOUT)
-      logger.level = Logger::INFO
-      logger.formatter = proc do |severity, datetime, progname, msg|
-        "#{severity}: #{msg}\n"
-      end
-      logger
+  PAGE_SUFFIXES = %w(haml md markdown text textile rst html html.haml)
+
+  DEFAULT_HOST = '127.0.0.1'
+  DEFAULT_PORT = '8000'
+
+  def self.env
+    if defined?(TESTING) && TESTING==true
+      :test
+    elsif defined?(Amber::Server)
+      :developmet
+    else
+      :production
     end
   end
 
 end
 
+require 'amber/version'
 require 'amber/cli'
-require 'amber/server'
 require 'amber/logger'
+require 'amber/i18n'
 
 require 'amber/menu'
 require 'amber/site'
@@ -74,3 +59,4 @@ require 'amber/render/asset'
 require 'amber/render/autolink'
 require 'amber/render/bracketlink'
 require 'amber/render/table_of_contents'
+require 'amber/render/apache'

data/lib/amber/cli.rb

@@ -40,6 +40,7 @@ module Amber
       site = Site.new(@root)
       site.continue_on_error = false
       site.load_pages
+      FileUtils.mkdir_p(site.dest_dir) unless File.exists?(site.dest_dir)
       gitkeep = File.exists?(File.join(site.dest_dir, '.gitkeep'))
       temp_render = File.join(File.dirname(site.dest_dir), 'public-tmp')
       temp_old_pages = File.join(File.dirname(site.dest_dir), 'remove-me')
@@ -62,8 +63,31 @@ module Amber
     end
 
     def server(options)
+      require 'amber/server'
+      host = nil
+      port = nil
+      if options[:arg]
+        host, port = options[:arg].split(':')
+      end
+      if host.nil? || host.empty?
+        host = DEFAULT_HOST
+      end
+      if port.nil? || port.empty?
+        port = DEFAULT_PORT
+      end
       site = Site.new(@root)
-      Amber::Server.start(:port => (options[:port] || 8000), :site => site)
+      Amber::Server.start(:port => port, :host => host, :site => site)
+    end
+
+    def apache(options)
+      site = Site.new(@root)
+      directory = options[:arg]
+      unless directory
+        puts "Missing DIRECTORY argument"
+        exit 1
+      end
+      directory = directory.gsub(%r{^/|/$}, '')
+      Amber::Render::Apache.echo_config(site, directory)
     end
 
     private

data/lib/amber/i18n.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'i18n'
+require 'i18n/backend/fallbacks'
+
+I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
+I18n.enforce_available_locales = false
+
+I18n.load_path += Dir[File.join(File.expand_path('../../../locales', __FILE__), '/**/*.{yml,yaml}')]
+
+module Amber
+
+  #
+  # Languages that might possibly be supported.
+  #
+  # https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers
+  #
+  POSSIBLE_LANGUAGES = {
+    :zh => ['中文',       'zh', 1, false],   # Chinese
+    :es => ['Español',   'es', 2, false],
+    :en => ['English',   'en', 3, false],
+    :hi => ['Hindi',     'hi', 4, false],
+    :ar => ['العربية',   'ar', 5, true],    # Arabic
+    :pt => ['Português', 'pt', 6, false],
+    :ru => ['Pyccĸий',   'ru', 7, false],   # Russian
+    :ja => ['日本語',     'ja', 8, false],   # Japanese
+    :pa => ['ਪੰਜਾਬੀ',  'pa', 9, false],   # Punjabi
+    :de => ['Deutsch',   'de', 10, false],
+    :vi => ['Tiếng Việt','vi', 11, false],  # Vietnamese
+    :fr => ['Français',  'fr', 12, false],
+    :ur => ['اُردُو',    'ur', 13, false],  # Urdu
+    :fa => ['فارسی',     'fa', 14, false],  # Farsi / Persian
+    :tr => ['Türkçe',    'tr', 15, false],  # Turkish
+    :it => ['Italiano',  'it', 16, false],
+    :el => ['Ελληνικά',  'el', 17, false],  # Greek
+    :pl => ['Polski',    'pl', 18, false],  # Polish
+    :ca => ['Català',    'ca', 19, false]
+  }
+
+  # Although everywhere else we use symbols for locales, this array should be strings:
+  POSSIBLE_LANGUAGE_CODES = POSSIBLE_LANGUAGES.keys.map(&:to_s)
+
+end

data/lib/amber/render/apache.rb

@@ -0,0 +1,44 @@
+module Amber
+  module Render
+    class Apache
+
+      def self.write_htaccess(site, src_dir, dst_dir)
+        src_htaccess_file = File.join(src_dir, '.htaccess')
+        dst_htaccess_file = File.join(dst_dir, '.htaccess')
+        template = Tilt::ERBTemplate.new(template_path("htaccess.erb"))
+
+        tail_content = nil
+        if File.exists?(src_htaccess_file)
+          tail_content = File.read(src_htaccess_file)
+        end
+        File.open(dst_htaccess_file, 'w', :encoding => 'UTF-8') do |f|
+          f.write template.render(context_object(:site => site))
+          if tail_content
+            f.write "\n\n"
+            f.write tail_content
+          end
+        end
+      end
+
+      def self.echo_config(site, directory)
+        template = Tilt::ERBTemplate.new(
+          site.path_prefix ? template_path('apache_config_with_prefix.erb') : template_path('apache_config.erb')
+        )
+        puts template.render(context_object(:site => site, :directory => directory))
+      end
+
+      def self.context_object(variables)
+        object = Object.new
+        variables.each do |name, value|
+          object.instance_variable_set("@#{name}", value)
+        end
+        object
+      end
+
+      def self.template_path(filename)
+        File.expand_path("../templates/#{filename}", File.dirname(__FILE__))
+      end
+
+    end
+  end
+end