aladdin 0.0.4 → 0.0.5

data/assets/fonts/general_foundicons.svg

@@ -0,0 +1,15 @@
+<?xml version="1.0" standalone="no"?> <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" > <svg xmlns="http://www.w3.org/2000/svg" width="100%" height="100%">
+<defs >
+<font id="generalfoundicons" horiz-adv-x="955" ><font-face
+    font-family="General Foundicons"
+    units-per-em="1000"
+    panose-1="0 0 0 0 0 0 0 0 0 0"
+    ascent="1000"
+    descent="0"
+    alphabetic="0" />
+<missing-glyph horiz-adv-x="250" />
+<glyph unicode=" " glyph-name="space" horiz-adv-x="250" />
+<glyph unicode="~" glyph-name="asciitilde" horiz-adv-x="1000" />
+</font>
+</defs>
+</svg>

data/bin/aladdin

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
+# ~*~ encoding: utf-8 ~*~
 
 $:.unshift File.join File.dirname(__FILE__), *%w(.. lib)
-
-require 'aladdin/cli'
+require 'aladdin/commands'
+Aladdin::Commands.parse!

data/lib/aladdin.rb

@@ -1,88 +1,33 @@
 # ~*~ encoding: utf-8 ~*~
-require 'sinatra'
-require 'zurb-foundation'
-require 'albino'
-require 'haml'
-require 'redcarpet'
-require 'htmlentities'
-require 'sanitize'
-require 'yaml'
 require 'json'
+require 'active_support/core_ext/hash'
 
-require 'aladdin/mixin/logger'
-require 'aladdin/mixin/weak_comparator'
-require 'aladdin/submission'
-require 'aladdin/render/markdown'
+require 'aladdin/constants'
+require 'aladdin/config'
+require 'aladdin/support'
+require 'aladdin/render'
 
-# Aladdin is a gem that tutorial authors can use to preview and test their
-# tutorials locally.
+# Aladdin is a gem that lesson authors can use to preview and test their
+# lessons locally.
 module Aladdin
-
-  # Name of configuration file.
-  CONFIG_FILE = '.genie.yml'
-
-  # Default configuration options.
-  DEFAULT_CONFIG = {
-    'verify' => {
-      'bin' => 'make',
-      'arg_prefix' => ''
-     },
-    'title' => 'Lesson X',
-    'description' => 'This is a placeholder description. You should provide your own',
-    'categories' => []
-  }
-
   class << self
 
-    attr_reader :config, :root
+    include Support::Logger
+    attr_accessor :config
 
     # Launches the tutorial app using 'thin' as the default webserver.
     # @option opts [String] from        path to author's markdown documents;
     #                                   defaults to the current working directory
     def launch(opts = {})
-      @root = opts[:from] || '.'
-      configure
+      root = opts[:from] || Dir.pwd
+      @config = Config.new root
+      require 'aladdin/app'
       Aladdin::App.set :views, Aladdin::VIEWS.merge(markdown: root)
       Aladdin::App.run!
-    end
-
-    private
-
-    # Reads configuration options from +.genie.yml+ and merges it into
-    # {DEFAULT_CONFIG}.
-    def configure
-      config_file = File.expand_path CONFIG_FILE, root
-      config = File.exists?(config_file) ? YAML.load_file(config_file) : {}
-      @config = DEFAULT_CONFIG.merge(config) { |k, l, r|
-        (l.is_a?(Hash) and r.is_a?(Hash)) ? l.merge(r) : r
-      }
-    end
-
-    # Converts a hash to struct.
-    def to_struct(hash)
-      Struct.new( *(k = hash.keys) ).new( *hash.values_at( *k ) )
+    rescue => e
+      logger.error e.message
     end
 
   end
-
-  # Paths to different types of views.
-  VIEWS = {
-    haml:     File.expand_path('../../views/haml', __FILE__),
-    scss:     File.expand_path('../../views/scss', __FILE__),
-    default:  File.expand_path('../../views', __FILE__)
-  }
-
-  # Paths to other parts of the library.
-  PATHS = to_struct(
-    assets: File.expand_path('../../assets', __FILE__),
-  ).freeze
-
-  # File extension for solution files.
-  DATA_EXT = '.sol'
-
-  # @todo TODO allow configuration?
-  DATA_DIR = Dir.tmpdir
-
 end
 
-require 'aladdin/app'

data/lib/aladdin/app.rb

@@ -1,4 +1,8 @@
 # ~*~ encoding: utf-8 ~*~
+require 'sinatra'
+require 'zurb-foundation'
+require 'aladdin/submission'
+
 module Aladdin
 
   # Sinatra app that serves the tutorial. Should be able to use this in a
@@ -94,7 +98,7 @@ module Aladdin
     get '/*' do |path|
       path = path.empty? ? INDEX : path.to_sym
       render_or_pass do
-        markdown(path, locals: Aladdin.config)
+        markdown(path, locals: Aladdin.config.to_hash)
       end
     end
 

data/lib/aladdin/commands.rb

@@ -0,0 +1,48 @@
+# ~*~ encoding: utf-8 ~*~
+Signal.trap('INT') { puts; exit(1) }
+
+module Aladdin
+
+  # Parses the command line arguments and invokes the relevant command.
+  # @example Adding a command
+  #   Commands.register do
+  #     def new
+  #       # do stuff
+  #     end
+  #   end
+  module Commands
+
+    # Path to USAGE file.
+    USAGE = File.join File.dirname(__FILE__), *%w(commands/USAGE)
+
+    # Registers a new command.
+    def register(&block)
+      extend Module.new(&block)
+    end
+
+    # Parses the command line arguments.
+    def parse!(argv=ARGV, opts={})
+      command = argv.shift
+      case command
+      when '--version', '-v'
+        puts "Aladdin #{Aladdin::VERSION}"
+        exit 0
+      when '--help', '-h'
+        puts File.read USAGE
+        exit 0
+      else
+        require_relative 'commands/new'
+        require_relative 'commands/server'
+        send command, argv, opts
+      end
+    rescue => e
+      puts e.message
+      puts File.read USAGE
+      exit 1
+    end
+
+    extend self
+
+  end
+
+end

data/lib/aladdin/commands/new.rb

@@ -1,16 +1,66 @@
 # ~*~ encoding: utf-8 ~*~
 require 'aladdin'
 require 'optparse'
+require 'aladdin/constants'
 
-# Array of skeleton files to be copied over.
-SKELETON_FILES = %w(.genie.yml index.md images)
+module Aladdin
 
-opt_parser = OptionParser.new do |opts|
-  opts.banner = "Usage: aladdin new [options] [LESSON_PATH]"
-end
-opt_parser.parse!
+  module Commands
+
+    # @example
+    #   $> aladdin new path/to/lesson/root
+    module New
+
+      # Array of skeleton files to be copied over.
+      FILES     = %w(index.md images) << Aladdin::Config::FILE
+
+      # Array of dot files to be copied over and renamed.
+      DOT_FILES = %w(gitignore)
+
+      # Flags for {FileUtils.cp_r}
+      COPY_FLAGS = {verbose: true}
+
+      # Copies skeleton files to given destination.
+      # @param [String] dest          destination path
+      # @param [Hash]   flags         options for {FileUtils.cp_r}
+      # @return [Void]
+      def copy_files(dest, flags={})
+        flags = COPY_FLAGS.merge flags
+        paths = FILES.map { |file| path_to file }
+        FileUtils.cp_r paths, dest, flags
+        DOT_FILES.each do |file|
+          FileUtils.cp_r path_to(file), File.join(dest, '.' + file), flags
+        end
+      end
 
-root = ARGV[0] || Dir.pwd
+      # Prefixes +filename+ with the skeleton directory.
+      # @param [String] filename      name of file to resolve
+      # @return [String] path
+      def path_to(file)
+        File.expand_path file, Aladdin::PATHS.skeleton
+      end
 
-Dir.chdir File.join File.dirname(__FILE__), *%w(.. .. .. skeleton)
-FileUtils.cp_r SKELETON_FILES, root, verbose: true
+      # Parses the command line arguments.
+      # @param [Array] argv           command line arguments
+      # @return [Void]
+      def parse!(argv)
+        opt_parser = OptionParser.new do |opts|
+          opts.banner = "Usage: aladdin new [options] [LESSON_PATH]"
+        end
+        opt_parser.parse! argv
+      end
+
+      extend self
+
+      Commands.register do
+        def new(argv=ARGV, opts={})
+          New.parse! argv
+          New.copy_files(argv[0] || Dir.pwd, opts)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/aladdin/commands/server.rb

@@ -2,9 +2,37 @@
 require 'aladdin'
 require 'optparse'
 
-opt_parser = OptionParser.new do |opts|
-  opts.banner = "Usage: aladdin server [options] [LESSON_PATH]"
-end
-opt_parser.parse!
+module Aladdin
+
+  module Commands
+
+    # @example
+    #   $> aladdin server path/to/lesson/root
+    module Server
+
+      # Parses the command line arguments.
+      # @param [Array] argv           command line arguments
+      # @return [Void]
+      def parse!(argv)
+        opt_parser = OptionParser.new do |opts|
+          opts.banner = "Usage: aladdin server [options] [LESSON_PATH]"
+        end
+        opt_parser.parse! argv
+      end
+
+      extend self
 
-Aladdin.launch from: ARGV[0]
+      Commands.register do
+        def server(argv=ARGV, opts={})
+          Server.parse! argv
+          Aladdin.launch opts.merge(from: argv[0])
+        rescue => e
+          puts e.message
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/aladdin/config.rb

@@ -0,0 +1,52 @@
+# ~*~ encoding: utf-8 ~*~
+
+module Aladdin
+
+  # Raised when there is a configuration error.
+  class ConfigError < StandardError; end
+
+  # Configuration options for Aladdin.
+  class Config
+
+    # Name of configuration file.
+    FILE = 'manifest.json'
+
+    # Default configuration options.
+    DEFAULTS = {
+      'verify' => {
+        'bin' => 'make',
+        'arg_prefix' => ''
+       },
+      'title' => 'Lesson X',
+      'description' => 'This is a placeholder description. You should provide your own',
+      'categories' => []
+    }
+
+    # Creates a new configuration from the file at the given path. Merges the
+    # configuration hash parsed from the file with {DEFAULTS}. Raises
+    # {ConfigError} if the file could not be read or parsed.
+    # @param [String] root            path to lesson root
+    def initialize(root)
+      path = File.expand_path FILE, root
+      case
+      when (not File.exist? path)
+        ConfigError.new("We couldn't find a manifest file at #{path}")
+      when (not File.readable? path)
+        ConfigError.new("We found a manifest file at #{path}, but couldn't " +
+          "read it. Please ensure that the permissions are set correctly.")
+      else
+        config = ::JSON.parse(File.read path)
+        @config = DEFAULTS.deep_merge config
+      end
+    rescue ::JSON::JSONError => e
+      raise ConfigError.new e.message
+    end
+
+    # @return [Hash] a hash copy of the configuration options
+    def to_hash
+      @config.clone
+    end
+
+  end
+
+end

data/lib/aladdin/constants.rb

@@ -0,0 +1,29 @@
+# ~*~ encoding: utf-8 ~*~
+require 'aladdin/support/core_ext/hash'
+
+module Aladdin
+
+  root = File.expand_path('../../..', __FILE__)
+
+  # Paths to other parts of the library.
+  PATHS = {
+    root:     root,
+    assets:   File.expand_path('assets', root),
+    skeleton: File.expand_path('skeleton', root)
+  }.to_struct.freeze
+
+  # Paths to different types of views.
+  VIEWS = {
+    haml:     File.expand_path('views/haml', root),
+    scss:     File.expand_path('views/scss', root),
+    default:  File.expand_path('views', root)
+  }
+
+  # @todo TODO allow configuration?
+  require 'tmpdir'
+  DATA_DIR = Dir.tmpdir
+
+  # File extension for solution files.
+  SOLUTION_EXT = '.sol'
+
+end

data/lib/aladdin/render.rb

@@ -0,0 +1,8 @@
+# ~*~ encoding: utf-8 ~*~
+require 'albino'
+require 'haml'
+require 'redcarpet'
+require 'htmlentities'
+require 'sanitize'
+
+require 'aladdin/render/markdown'

data/lib/aladdin/render/error.rb

@@ -4,16 +4,13 @@ module Aladdin
   module Render
 
     # The base exception for {Aladdin::Render} Errors
-    class Error < StandardError
-    end
+    class Error < StandardError; end
 
     # This exception is raised if a parse error occurs.
-    class ParseError < Error
-    end
+    class ParseError < Error; end
 
     # This exception is raised if a render error occurs.
-    class RenderError < Error
-    end
+    class RenderError < Error; end
 
   end
 

data/lib/aladdin/render/markdown.rb

@@ -1,17 +1,11 @@
+# ~*~ encoding: utf-8 ~*~
 require 'aladdin/render/sanitize'
 require 'aladdin/render/error'
-require 'aladdin/render/template'
-require 'aladdin/render/image'
-require 'aladdin/render/problem'
-require 'aladdin/render/multi'
-require 'aladdin/render/short'
-require 'aladdin/render/table'
-require 'aladdin/render/navigation'
+require 'aladdin/render/templates'
 
-# ~*~ encoding: utf-8 ~*~
 module Aladdin
 
-  # aladdin-render module for all of Laddin's rendering needs.
+  # aladdin-render module for all of Aladdin's rendering needs.
   module Render
 
     # HTML Renderer for Markdown.
@@ -23,7 +17,7 @@ module Aladdin
     #
     # @see http://github.github.com/github-flavored-markdown/
     class HTML < ::Redcarpet::Render::HTML
-      include Aladdin::Mixin::Logger
+      include Aladdin::Support::Logger
 
       @sanitize = Aladdin::Sanitize.new
       @entities = HTMLEntities.new
@@ -40,7 +34,7 @@ module Aladdin
       # Renderer configuration options.
       CONFIGURATION = {
         hard_wrap:          true,
-        safe_links_only:    true,
+        no_styles:          true,
       }
 
       # Creates a new HTML renderer.
@@ -48,8 +42,9 @@ module Aladdin
       def initialize(options = {})
         super options.merge(CONFIGURATION)
         exe_template = File.join(Aladdin::VIEWS[:haml], 'exe.haml')
-        @exe, @nav = Haml::Engine.new(File.read exe_template), Navigation.new
-        @prob, @img = 0, 0 # indices for Problem # and Figure #
+        @exe = Haml::Engine.new(File.read exe_template)
+        @nav, @headers = Navigation.new, Headers.new
+        @prob, @img = 0, 0 # indices for Problem #, Figure #
       end
 
       # Pygmentizes code blocks.
@@ -77,15 +72,10 @@ module Aladdin
         p(text)
       end
 
-      # Increases all header levels by one and keeps track of document
-      # sections.
+      # Increases all header levels by one and keeps a navigation bar.
       def header(text, level)
-        level += 1
-        html = h(text, level)
-        if level == 2
-          index = @nav << text
-          html += "<a name='section_#{index}' data-magellan-destination='section_#{index}'/>"
-        end
+        html, name = h(text, level += 1)
+        @nav.append(text, name) if level == 2
         html
       end
 
@@ -120,14 +110,15 @@ module Aladdin
       # Prepares a block image. Raises {RenderError} or {ParseError} if the
       # given text does not contain a valid image block.
       def block_image(text)
-        image = Image.parse(text)
-        image.render(index: @img += 1)
+        Image.parse(text).render(index: @img += 1)
       end
 
       # Wraps the given text with header tags.
-      # @return [String] wrapped text
+      # @return [String] rendered HTML
+      # @return [String] anchor name
       def h(text, level)
-        "<h#{level}>#{text}</h#{level}>"
+        header = @headers.add(text, level)
+        return header.render, header.name
       end
 
       # Wraps the given text with paragraph tags.

data/lib/aladdin/render/templates.rb

@@ -0,0 +1,2 @@
+base_path = 'aladdin/render/templates/'
+%w(template header image problem multi short table navigation).each { |f| require base_path + f }

data/lib/aladdin/render/templates/header.rb

@@ -0,0 +1,52 @@
+# ~*~ encoding: utf-8 ~*~
+require 'active_support/core_ext/string/inflections'
+
+module Aladdin
+
+  module Render
+
+    # Keeps track of headers within the same document. It's responsible for
+    # assigning unique names that can be used in the anchors.
+    class Headers
+
+      def initialize
+        @headers = {}
+      end
+
+      # Adds a new header to the set.
+      # @return [Header] header
+      def add(text, level=1)
+        name = text.parameterize
+        if @headers.include? name
+          name += '-%d' % (@headers[name] += 1)
+        else @headers[name] = 0 end
+        Header.new(text, level, name)
+      end
+
+    end
+
+    # Renders a header (e.g. +h1+, +h2+, ...) with anchors.
+    class Header < Template
+
+      # Name of template file for rendering headers.
+      TEMPLATE = 'header.haml'
+
+      attr_reader :name
+
+      # Creates a new header.
+      # @param [String] text          header text
+      # @param [Fixnum] level         1 to 6
+      # @param [String] name          anchor name
+      def initialize(text, level, name)
+        @text, @level, @name = text, level, name
+      end
+
+      def render(locals={})
+        super locals.merge(text: @text, level: @level, name: @name)
+      end
+
+    end
+
+  end
+
+end

data/lib/aladdin/render/{navigation.rb → templates/navigation.rb}

@@ -11,15 +11,15 @@ module Aladdin
 
       # Creates a new navigation bar.
       def initialize
-        @sections = []
+        @sections = {}
       end
 
       # Adds a new section.
       # @param [String] heading      section heading
-      # @return [Fixnum] section index
-      def <<(heading)
-        @sections << heading
-        @sections.size - 1
+      # @param [String] name         anchor name
+      # @return [void]
+      def append(heading, name)
+        @sections[name] = heading
       end
 
       # Renders the navigation bar in HTML.

data/lib/aladdin/render/{problem.rb → templates/problem.rb}

@@ -78,7 +78,7 @@ module Aladdin
       #   so that the author doesn't have to read the logs.
       def save!
         raise RenderError.new('Invalid problem.') unless valid?
-        solution = File.join(Aladdin::DATA_DIR, id + Aladdin::DATA_EXT)
+        solution = File.join(Aladdin::DATA_DIR, id + Aladdin::SOLUTION_EXT)
         File.open(solution, 'wb+') { |file| Marshal.dump answer, file }
       end
 

data/lib/aladdin/render/{template.rb → templates/template.rb}

@@ -3,13 +3,14 @@ module Aladdin
 
   module Render
 
-    # Child classes should provide a +TEMPLATE+ string constant that contains
-    # the path to the HAML file.
+    # Base class for all templates. Child classes should provide a +TEMPLATE+
+    # string constant that contains the path to the relevant HAML file.
     class Template
 
       # Renders the given problem using {#view}.
       # @todo TODO should probably show some error message in the preview,
       # so that the author doesn't have to read the logs.
+      # @params [Hash] locals         local variables to pass to the template
       def render(locals={})
         view.render Object.new, locals
       end
@@ -17,7 +18,8 @@ module Aladdin
       private
 
       # Retrieves the +view+ singleton. If it is nil, initializes it from
-      # +self.class.TEMPLATE+.
+      # +self.class.TEMPLATE+. Note that this is reloaded with every refresh so
+      # I can edit the templates without refreshing.
       # @return [Haml::Engine] haml engine
       def view
         return @view unless @view.nil?

data/lib/aladdin/submission.rb

@@ -10,8 +10,8 @@ module Aladdin
   # it's unsuitable for production use. It does not impose any security
   # restrictions at all.
   class Submission
-    include Aladdin::Mixin::Logger
-    include Aladdin::Mixin::WeakComparator
+    include Support::Logger
+    include Support::WeakComparator
 
     SCRATCHSPACE = '.__ss'
 
@@ -39,7 +39,7 @@ module Aladdin
     # @return [String] (json-encoded) true iff the submitted answer is correct.
     def verify_quiz
       id = @id.gsub File::SEPARATOR, '' # protect against directory attacks
-      solution = File.expand_path id + Aladdin::DATA_EXT, Aladdin::DATA_DIR
+      solution = File.expand_path id + Aladdin::SOLUTION_EXT, Aladdin::DATA_DIR
       File.open(solution, 'rb') { |f| same? @params['answer'], Marshal.restore(f) }.to_json
     rescue => e
       logger.warn e.message

data/lib/aladdin/support.rb

@@ -0,0 +1,10 @@
+# ~*~ encoding: utf-8 ~*~
+require 'aladdin/support/core_ext'
+require 'aladdin/support/logger'
+require 'aladdin/support/weak_comparator'
+
+module Aladdin
+  # aladdin-support is a collection of utility classes and modules for use in
+  # the Aladdin project.
+  module Support; end
+end

data/lib/aladdin/support/core_ext.rb

@@ -0,0 +1,2 @@
+# ~*~ encoding: utf-8 ~*~
+require 'aladdin/support/core_ext/hash'

data/lib/aladdin/support/core_ext/hash.rb

@@ -0,0 +1,10 @@
+# ~*~ encoding: utf-8 ~*~
+class Hash
+
+  # Returns a struct representation of the receiver.
+  # @return [Struct] struct
+  def to_struct
+    Struct.new( *(k = keys) ).new( *values_at( *k ) )
+  end
+
+end

data/lib/aladdin/support/logger.rb

@@ -0,0 +1,29 @@
+# ~*~ encoding: utf-8 ~*~
+require 'active_support/core_ext/logger'
+
+module Aladdin
+
+  module Support
+
+    # Provides a convenient global logger.
+    # @example
+    #   class X
+    #     include Logger
+    #     def x; logger.info "hey"; end
+    #   end
+    # @todo FIXME allow configuration
+    module Logger
+
+      # Global logger.
+      LOGGER = ::Logger.new(STDOUT)
+
+      # Retrieves the global logger.
+      def logger
+        Logger::LOGGER
+      end
+
+    end
+
+  end
+
+end

data/lib/aladdin/{mixin → support}/weak_comparator.rb

@@ -1,9 +1,9 @@
 # ~*~ encoding: utf-8 ~*~
 module Aladdin
 
-  module Mixin
+  module Support
 
-    # Provides a richer comparison with weak-typing.
+    # Provides a rich comparison with weak-typing.
     # @see #same?
     module WeakComparator
 
@@ -21,7 +21,7 @@ module Aladdin
       # === Numerics
       # If +saved+ is a numeric, then it will accept any +submitted+ value that
       # is numerically equivalent to +saved+. For example, if +saved+ is 0,
-      # then +'0.0'+ and +'0'+ will both be accepted.
+      # then both +'0.0'+ and +'0'+ will be accepted.
       #
       # @param [String, Hash] submitted
       # @param [String, Numeric, Boolean, Hash] saved
@@ -40,9 +40,9 @@ module Aladdin
 
       private
 
-      # Compares two hash and returns a simple diff. It checks that both
-      # +submitted+ and +saved+ have the same number of elements, and then
-      # compares each pair of elements in order.
+      # Compares two hashes and returns a simple diff. It checks that both
+      # +submitted+ and +saved+ have the same number of keys, and then
+      # compares all key-value pairs in order.
       #
       # @param [Hash] submitted
       # @param [Hash] saved
@@ -53,6 +53,8 @@ module Aladdin
           Hash[saved.map { |key, value| [key, same?(submitted[key], value)] }]
       end
 
+      extend self
+
     end
 
   end

data/lib/aladdin/version.rb

@@ -1,4 +1,4 @@
 module Aladdin
   # Version number.
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/skeleton/gitignore

@@ -0,0 +1,3 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+.sass-cache

data/skeleton/manifest.json

@@ -0,0 +1,9 @@
+{
+  "title": "A Genie Lesson",
+  "description": "Hello World! Welcome to your first lesson.",
+  "categories": [
+    "ruby",
+    "programming",
+    "software"
+  ]
+}

data/views/haml/header.haml

@@ -0,0 +1,5 @@
+-# coding: UTF-8
+-haml_tag ('h%d' % level).to_sym do
+  %a.anchor{name: name, href: '#' + name, 'data-magellan-destination' => name}
+    %i.foundicon-paper-clip
+  =text

data/views/haml/layout.haml

@@ -13,6 +13,10 @@
 
   %title= title
   %link{rel: 'stylesheet', href:'stylesheets/app.css'}
+  %link{rel: 'stylesheet', href:'stylesheets/general_foundicons.css'}
+  /[if lt IE 8]
+    %link{rel: 'stylesheet', href:'stylesheets/general_foundicons_ie7.css'}
+
   %script{src: 'javascripts/foundation/modernizr.foundation.js'}
 
 %body

data/views/haml/nav.haml

@@ -1,5 +1,5 @@
 -# coding: UTF-8
 %dl#sections.sub-nav{'data-magellan-expedition' => 'fixed'}
-  -sections.each_with_index do |section, i|
-    %dd{'data-magellan-arrival' => "section_#{i}"}
-      %a{href: "#section_#{i}"}= section
+  -sections.each do |name, heading|
+    %dd{'data-magellan-arrival' => name}
+      %a{href: '#' + name}= heading

data/views/scss/_settings.scss

@@ -239,4 +239,33 @@
 // $base-size: $baseFontSize $importantModNum;
 // Produced the following list of values: 14, 17, 23, 27, 37, 44, 59, 71, 95, 115;
 // http://www.modularscale.com by Tim Brown
-// https://github.com/scottkellum/modular-scale by scottkellum
+// https://github.com/scottkellum/modular-scale by scottkellum
+
+$fontFileName: "/fonts/general_foundicons";
+$fontName: "GeneralFoundicons";
+$classPrefix: "foundicon-";
+
+@mixin i-class($name,$pua) {
+  .#{$classPrefix}#{$name}:before {
+    content: "\f#{$pua}";
+  }
+}
+
+@mixin ie-class($name,$pua) {
+  .#{$classPrefix}#{$name} {
+    *zoom: expression( this.runtimeStyle['zoom'] = "1", this.innerHTML = "&#xf#{$pua};");
+  }
+}
+
+@mixin face {
+  @font-face {
+    font-family: $fontName;
+    src: url('#{$fontFileName}.eot');
+    src: url('#{$fontFileName}.eot?#iefix') format('embedded-opentype'),
+         url('#{$fontFileName}.woff') format('woff'),
+         url('#{$fontFileName}.ttf') format('truetype'),
+         url('#{$fontFileName}.svg##{$fontName}') format('svg');
+    font-weight: normal;
+    font-style: normal;
+  }
+}

data/views/scss/app.scss

@@ -44,11 +44,32 @@ a.hero img {
 }
 
 /* Styling within lesson */
+section[role='lesson'] {
 
-section[role='lesson'] .block-image {
-  text-align: center;
-}
+  .block-image {
+    text-align: center;
+  }
+
+  ul {
+    margin-left: 17px;
+  }
+
+  #{nest(headings(), 'a.anchor')} {
+    position: absolute;
+    padding-left: 60px;
+    margin-left: -60px;
+    display: block;
+  }
+
+  #{nest(headings(), 'a.anchor i')} {
+    display: none;
+    width: 16px;
+    font-size: 16px;
+  }
+
+  #{nest(append-selector(headings(), ':hover'), 'a.anchor i')} {
+    display: inline-block;
+    margin-left: -1.5em;
+  }
 
-section[role='lesson'] ul {
-  margin-left: 17px;
 }

data/views/scss/general_foundicons.scss

@@ -0,0 +1,71 @@
+@import "settings";
+
+/* font-face */
+@include face;
+
+/* global foundicon styles */
+[class*="#{$classPrefix}"] {
+  display: inline;
+  width: auto;
+  height: auto;
+  line-height: inherit;
+  vertical-align: baseline;
+  background-image: none;
+  background-position: 0 0;
+  background-repeat: repeat;
+}
+[class*="#{$classPrefix}"]:before {
+  font-family: $fontName;
+  font-weight: normal;
+  font-style: normal;
+  text-decoration: inherit;
+}
+
+/* icons */
+@include i-class(settings,"000");
+@include i-class(heart,"001");
+@include i-class(star,"002");
+@include i-class(plus,"003");
+@include i-class(minus,"004");
+@include i-class(checkmark,"005");
+@include i-class(remove,"006");
+@include i-class(mail,"007");
+@include i-class(calendar,"008");
+@include i-class(page,"009");
+@include i-class(tools,"00a");
+@include i-class(globe,"00b");
+@include i-class(home,"00c");
+@include i-class(quote,"00d");
+@include i-class(people,"00e");
+@include i-class(monitor,"00f");
+@include i-class(laptop,"010");
+@include i-class(phone,"011");
+@include i-class(cloud,"012");
+@include i-class(error,"013");
+@include i-class(right-arrow,"014");
+@include i-class(left-arrow,"015");
+@include i-class(up-arrow,"016");
+@include i-class(down-arrow,"017");
+@include i-class(trash,"018");
+@include i-class(add-doc,"019");
+@include i-class(edit,"01a");
+@include i-class(lock,"01b");
+@include i-class(unlock,"01c");
+@include i-class(refresh,"01d");
+@include i-class(paper-clip,"01e");
+@include i-class(video,"01f");
+@include i-class(photo,"020");
+@include i-class(graph,"021");
+@include i-class(idea,"022");
+@include i-class(mic,"023");
+@include i-class(cart,"024");
+@include i-class(address-book,"025");
+@include i-class(compass,"026");
+@include i-class(flag,"027");
+@include i-class(location,"028");
+@include i-class(clock,"029");
+@include i-class(folder,"02a");
+@include i-class(inbox,"02b");
+@include i-class(website,"02c");
+@include i-class(smiley,"02d");
+@include i-class(search,"02e");

data/views/scss/general_foundicons_ie7.scss

@@ -0,0 +1,56 @@
+@import "settings";
+
+/* general icons for IE7 */
+[class*="#{$classPrefix}"] {
+  font-family: $fontName;
+  font-weight: normal;
+  font-style: normal;
+}
+
+@include ie-class(settings,"000");
+@include ie-class(heart,"001");
+@include ie-class(star,"002");
+@include ie-class(plus,"003");
+@include ie-class(minus,"004");
+@include ie-class(checkmark,"005");
+@include ie-class(remove,"006");
+@include ie-class(mail,"007");
+@include ie-class(calendar,"008");
+@include ie-class(page,"009");
+@include ie-class(tools,"00a");
+@include ie-class(globe,"00b");
+@include ie-class(home,"00c");
+@include ie-class(quote,"00d");
+@include ie-class(people,"00e");
+@include ie-class(monitor,"00f");
+@include ie-class(laptop,"010");
+@include ie-class(phone,"011");
+@include ie-class(cloud,"012");
+@include ie-class(error,"013");
+@include ie-class(right-arrow,"014");
+@include ie-class(left-arrow,"015");
+@include ie-class(up-arrow,"016");
+@include ie-class(down-arrow,"017");
+@include ie-class(trash,"018");
+@include ie-class(add-doc,"019");
+@include ie-class(edit,"01a");
+@include ie-class(lock,"01b");
+@include ie-class(unlock,"01c");
+@include ie-class(refresh,"01d");
+@include ie-class(paper-clip,"01e");
+@include ie-class(video,"01f");
+@include ie-class(photo,"020");
+@include ie-class(graph,"021");
+@include ie-class(idea,"022");
+@include ie-class(mic,"023");
+@include ie-class(cart,"024");
+@include ie-class(address-book,"025");
+@include ie-class(compass,"026");
+@include ie-class(flag,"027");
+@include ie-class(location,"028");
+@include ie-class(clock,"029");
+@include ie-class(folder,"02a");
+@include ie-class(inbox,"02b");
+@include ie-class(website,"02c");
+@include ie-class(smiley,"02d");
+@include ie-class(search,"02e");

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aladdin
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-24 00:00:00.000000000 Z
+date: 2012-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -155,6 +155,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.9
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -246,25 +262,37 @@ files:
 - LICENSE
 - README.md
 - lib/aladdin/app.rb
-- lib/aladdin/cli.rb
 - lib/aladdin/commands/new.rb
 - lib/aladdin/commands/server.rb
-- lib/aladdin/mixin/logger.rb
-- lib/aladdin/mixin/weak_comparator.rb
+- lib/aladdin/commands.rb
+- lib/aladdin/config.rb
+- lib/aladdin/constants.rb
 - lib/aladdin/render/error.rb
-- lib/aladdin/render/image.rb
 - lib/aladdin/render/markdown.rb
-- lib/aladdin/render/multi.rb
-- lib/aladdin/render/navigation.rb
-- lib/aladdin/render/problem.rb
 - lib/aladdin/render/sanitize.rb
-- lib/aladdin/render/short.rb
-- lib/aladdin/render/table.rb
-- lib/aladdin/render/template.rb
+- lib/aladdin/render/templates/header.rb
+- lib/aladdin/render/templates/image.rb
+- lib/aladdin/render/templates/multi.rb
+- lib/aladdin/render/templates/navigation.rb
+- lib/aladdin/render/templates/problem.rb
+- lib/aladdin/render/templates/short.rb
+- lib/aladdin/render/templates/table.rb
+- lib/aladdin/render/templates/template.rb
+- lib/aladdin/render/templates.rb
+- lib/aladdin/render.rb
 - lib/aladdin/submission.rb
+- lib/aladdin/support/core_ext/hash.rb
+- lib/aladdin/support/core_ext.rb
+- lib/aladdin/support/logger.rb
+- lib/aladdin/support/weak_comparator.rb
+- lib/aladdin/support.rb
 - lib/aladdin/version.rb
 - lib/aladdin.rb
 - assets/favicon.ico
+- assets/fonts/general_foundicons.eot
+- assets/fonts/general_foundicons.svg
+- assets/fonts/general_foundicons.ttf
+- assets/fonts/general_foundicons.woff
 - assets/images/graphic.png
 - assets/images/no_gravatar.gif
 - assets/javascripts/app.js
@@ -291,6 +319,7 @@ files:
 - assets/javascripts/foundation/jquery.placeholder.js
 - assets/javascripts/foundation/modernizr.foundation.js
 - views/haml/exe.haml
+- views/haml/header.haml
 - views/haml/img.haml
 - views/haml/layout.haml
 - views/haml/multi.haml
@@ -303,9 +332,13 @@ files:
 - views/scss/_pygment.scss
 - views/scss/_settings.scss
 - views/scss/app.scss
+- views/scss/general_foundicons.scss
+- views/scss/general_foundicons_ie7.scss
 - bin/aladdin
+- skeleton/gitignore
 - skeleton/images/graphic.png
 - skeleton/index.md
+- skeleton/manifest.json
 homepage: https://github.com/jimjh/aladdin
 licenses:
 - MIT

data/lib/aladdin/cli.rb

@@ -1,29 +0,0 @@
-# ~*~ encoding: utf-8 ~*~
-
-Signal.trap('INT') { puts; exit(1) }
-
-case ARGV.first
-when '--version', '-v'
-  puts "Aladdin #{Aladdin::VERSION}"
-  exit(0)
-when 'new'
-  ARGV.shift
-  require_relative 'commands/new'
-when 'server'
-  ARGV.shift
-  require_relative 'commands/server'
-else
-  puts <<-eos
-Usage:
-  aladdin COMMAND [options]
-
-Commands:
-  new                 # generates the skeleton for a new lesson
-  server              # launches a preview server
-
-Aladdin Options:
-  -v, [--version]     # show version number and quit
-  -h, [--help]        # show this help message and quit
-eos
-  exit ['-h', '--help'].include?(ARGV.first) ? 0 : 1
-end

data/lib/aladdin/mixin/logger.rb

@@ -1,26 +0,0 @@
-# ~*~ encoding: utf-8 ~*~
-require 'logger'
-
-module Aladdin
-
-  # aladdin-mixin module contains all other mixin modules.
-  module Mixin
-
-    # @example
-    #   require 'logger'
-    #   logger.info "hey"
-    module Logger
-
-      # Global Logger.
-      LOGGER = ::Logger.new STDOUT
-
-      # Retrieves the global logger.
-      def logger
-        Logger::LOGGER
-      end
-
-    end
-
-  end
-
-end