amber 0.2.6

data/README.md

@@ -0,0 +1,114 @@
+Amber
+===================================
+
+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:
+
+* I18n: Primary focus is on very good multi-lingual and localization support.
+* 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.
+
+Installation
+---------------------------------
+
+Installing from gem:
+
+    sudo gem install amber
+
+Installing from source:
+
+    sudo gem install bundler
+    git clone https://github.com/leapcode/amber
+    cd amber
+    bundle install
+    sudo ln -s `pwd`/bin/amber /usr/local/bin
+
+Directory structure
+---------------------------------
+
+A simple website has this structure:
+
+    mysite/
+      amber/
+        config.rb
+        locales/
+          en.yml
+        menu.txt
+        layouts/
+          default.haml
+      pages/
+        page1.en.md
+        page2.en.md
+      public/
+        page1.en.html
+        page1.en.html
+
+menu.txt
+---------------------------------
+
+A page does not show up in the navigation unless it appears in menu.txt.
+
+The order in menu.txt determines the order in the navigation. For example:
+
+    aaa
+    ccc
+    bbb
+
+Page hierarchy is represented by two spaces:
+
+    aaa
+      bbb
+      ccc
+        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).
+
+Supported syntaxes
+---------------------------------
+
+Depending the the file extension, the file with be parsed like so:
+
+    .haml       -- HAML
+    .md         -- Markdown
+    .markdown   -- Markdown
+    .txt        -- Textile
+    .textile    -- Textile
+    .rst        -- ReStructuredText
+
+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.
+
+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
+* Markdown preview for Firefox: https://addons.mozilla.org/de/firefox/addon/markdown-viewer/  (see https://addons.mozilla.org/en-US/firefox/addon/markdown-viewer/reviews/423328/ for rendering .md file extensions)
+
+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:
+
+    @title = "A fine page"
+    @toc = false
+
+    continue on here with body text.
+
+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`.
+
+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).
+* `@nav_title` -- The title for the navigation to this page, as well as the HTML title if @title is not set.
+* `@toc` -- If set to `false`, don't include a table of contents when rendering the file. This only applies to .rst and .md files.
+* `@layout` -- Manually set the layout template to use for rendering this page.
+* `@author` -- The author credit for the page.
+* `@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.

data/bin/amber

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+if ARGV.include?('--debug')
+  require 'debugger'
+end
+
+begin
+  require 'amber'
+rescue LoadError
+  base_dir = File.expand_path('..', File.dirname(File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__))
+  ["#{base_dir}/lib"].each do |path|
+    $LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+  end
+  require 'amber'
+end
+
+def process_command_line_arguments
+  @command = nil
+  @command_arg = nil
+  @verbose = false
+  loop do
+    case ARGV[0]
+      when 'init'        then @command = ARGV.shift; @command_arg = ARGV.shift
+      when 'build'       then @command = ARGV.shift
+      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 '--debug'     then ARGV.shift
+      when '--help'      then usage
+      when 'help'        then usage
+      when '-h'          then usage
+      when '-v'          then @verbose = true; ARGV.shift
+      when /^-/          then usage("Unknown option: #{ARGV[0].inspect}")
+      else break
+    end
+  end
+  usage("No command given") unless @command
+end
+
+def usage(msg=nil)
+  $stderr.puts(msg) if msg
+  $stderr.puts
+  $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")
+  $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)")
+  exit(2)
+end
+
+def main
+  process_command_line_arguments
+  if @verbose
+    Amber.logger.level = Logger::DEBUG
+  end
+  Amber::CLI.new(Dir.pwd).send(@command, {:port => @port, :verbose => @verbose, :arg => @command_arg})
+end
+
+main

data/lib/amber.rb

@@ -0,0 +1,76 @@
+# 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'  #
+
+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
+    end
+  end
+
+end
+
+require 'amber/cli'
+require 'amber/server'
+require 'amber/logger'
+
+require 'amber/menu'
+require 'amber/site'
+require 'amber/site_configuration'
+
+require 'amber/static_page'
+require 'amber/static_page/filesystem'
+require 'amber/static_page/render'
+require 'amber/static_page/property_set'
+require 'amber/static_page/page_properties'
+require 'amber/page_array'
+
+require 'amber/render/layout'
+require 'amber/render/view'
+require 'amber/render/template'
+require 'amber/render/asset'
+require 'amber/render/autolink'
+require 'amber/render/bracketlink'
+require 'amber/render/table_of_contents'

data/lib/amber/cli.rb

@@ -0,0 +1,98 @@
+require 'fileutils'
+
+module Amber
+  class CLI
+
+    def initialize(root, *args)
+      @options = {}
+      @options = args.pop if args.last.is_a?(::Hash)
+      @root    = File.expand_path(root)
+    end
+
+    def init(options)
+      new_dir = options[:arg]
+      mkdir(new_dir, nil)
+      mkdir('amber', new_dir)
+      touch('amber/config.rb', new_dir)
+      touch('amber/menu.txt', new_dir)
+      mkdir('amber/layouts', new_dir)
+      mkdir('amber/locales', new_dir)
+      mkdir('public', new_dir)
+      mkdir('pages', new_dir)
+    end
+
+    def build(options)
+      site = Site.new(@root)
+      site.load_pages
+      site.render
+    end
+
+    def clear(options)
+      site = Site.new(@root)
+      site.clear
+    end
+
+    def clean(options)
+      clear(options)
+    end
+
+    def rebuild(options)
+      site = Site.new(@root)
+      site.continue_on_error = false
+      site.load_pages
+      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')
+      site.with_destination(temp_render) do
+        site.render
+      end
+      FileUtils.mv(site.dest_dir, temp_old_pages)
+      FileUtils.mv(temp_render, site.dest_dir)
+      site.with_destination(temp_old_pages) do
+        site.clear
+        FileUtils.rm_r(temp_old_pages)
+      end
+      if gitkeep
+        FileUtils.touch(File.join(site.dest_dir, '.gitkeep'))
+      end
+    ensure
+      # cleanup if something goes wrong.
+      FileUtils.rm_r(temp_render) if temp_render && File.exists?(temp_render)
+      FileUtils.rm_r(temp_old_pages) if temp_old_pages && File.exists?(temp_old_pages)
+    end
+
+    def server(options)
+      site = Site.new(@root)
+      Amber::Server.start(:port => (options[:port] || 8000), :site => site)
+    end
+
+    private
+
+    def mkdir(dir, context)
+      if context
+        path = File.join(context, dir)
+        print_path = File.join(File.basename(context), dir)
+      else
+        path = dir
+        print_path = dir
+      end
+      unless Dir.exists?(path)
+        if File.exists?(path)
+          puts "Could not make directory `#{print_path}`. File already exists."
+          exit(1)
+        end
+        FileUtils.mkdir_p(path)
+        puts "* Creating `#{print_path}`"
+      end
+    end
+
+    def touch(file, context)
+      path = File.join(context, file)
+      unless File.exists?(path)
+        FileUtils.touch(path)
+        puts "* Creating `#{File.basename(context)}/#{file}`"
+      end
+    end
+
+  end
+end

data/lib/amber/logger.rb

@@ -0,0 +1,21 @@
+require 'logger'
+
+module Amber
+
+  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
+    end
+  end
+
+  def self.log_exception(e)
+    Amber.logger.error(e)
+    Amber.logger.error(e.backtrace.join("\n       "))
+  end
+
+end

data/lib/amber/menu.rb

@@ -0,0 +1,141 @@
+#
+# A navigation menu class
+#
+
+module Amber
+  class Menu
+    attr_accessor :parent
+    attr_accessor :children
+    attr_accessor :name
+
+    #
+    # load the menu.txt file and build the in-memory menu array
+    #
+    def load(menu_file_path)
+      File.open(menu_file_path) do |file|
+        parse_menu(file)
+      end
+    end
+
+    def initialize(name, parent=nil)
+      self.name = name
+      self.parent = parent
+      self.children = []
+    end
+
+    ##
+    ## public methods
+    ##
+
+    #
+    # returns the menu under the item that matches item_name.
+    #
+    def submenu(item_name=nil)
+      if item_name
+        self.children.detect {|child| child.name == item_name}
+      else
+        self.children
+      end
+    end
+
+    #
+    # returns path from root to this leaf as an array
+    #
+    def path
+      @path ||= begin
+        if parent == nil
+          []
+        else
+          parent.path + [name]
+        end
+      end
+    end
+
+    def path_str
+      @path_str ||= path.join('/')
+    end
+
+    def each(&block)
+      children.each(&block)
+    end
+
+    def size
+      children.size
+    end
+
+    #
+    # returns true if menu's path starts with +path_prefix+
+    #
+    def path_starts_with?(path_prefix)
+      array_starts_with?(path, path_prefix)
+    end
+
+    def path_prefix_of?(full_path)
+      array_starts_with?(full_path, path)
+    end
+
+    #
+    # returns true if this menu item is the terminus menu item for path.
+    # (meaning that there are no children that match more path segments)
+    #
+    def leaf_for_path?(path)
+      return false unless path_prefix_of?(path)
+      next_path_segment = (path - self.path).first
+      return false if next_path_segment.nil?
+      return !children.detect {|i| i.name == next_path_segment}
+    end
+
+    def inspect(indent=0)
+      lines = []
+      lines << '  '*indent + '- ' + self.name
+      self.children.each do |child|
+        lines << child.inspect(indent+1)
+      end
+      lines.join("\n")
+    end
+
+    #
+    # private & protected methods
+    #
+
+    protected
+
+    def add_child(name)
+      self.children << Menu.new(name, self)
+    end
+
+    private
+
+    def array_starts_with?(big_array, small_array)
+      small_array.length.times do |i|
+        if small_array[i] != big_array[i]
+          return false
+        end
+      end
+      return true
+    end
+
+
+    def parse_menu(file)
+      while true
+        item = file.readline
+        if item.strip.chars.any? && item !~ /^\s*#/
+          depth = item.scan("  ").size
+          last_menu_at_depth(depth).add_child(item.strip)
+        end
+      end
+    rescue EOFError
+      # done loading
+    end
+
+    #
+    # returns the last list of children at the specified depth
+    #
+    def last_menu_at_depth(depth)
+      menu = self
+      depth.times { menu = menu.children.last }
+      menu
+    end
+
+  end
+end