aladdin 0.0.1 → 0.0.3

data/README.md

@@ -3,7 +3,7 @@
 [![Dependency Status](https://gemnasium.com/jimjh/aladdin.png)](https://gemnasium.com/jimjh/aladdin)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jimjh/aladdin)
 
-Generates tutorials using the set of markdown documents provided by the author.
+Generates lessons using the markdown document and tests provided by the author.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,18 +21,24 @@ Or install it yourself as:
     $> gem install aladdin
 
 ## Usage
-Create a new directory for your notes _e.g._ `my_tutorial`. Change into that
-directory, and create your notes using GitHub-Flavored Markdown. It might look
-like:
+Create a new directory for your notes _e.g._ `lesson_0`. Change into that
+directory, then execute:
 
-    my_tutorial/
-      01-introduction.md
-      02-the-beginning.md
-      03-the-end.md
+```sh
+$> aladdin new
+```
 
-Finally, execute aladdin to launch the Sinatra server:
+Update `index.md` and provide your unit tests in the lesson directory. Finally, execute aladdin to launch the Sinatra server:
 
-    $> aladdin
+```sh
+$> aladdin server
+```
+
+Note that the following directory names are reserved:
+
+- javascripts
+- stylesheets
+- verify
 
 ## Contributing
 

data/assets/javascripts/app.js

@@ -0,0 +1,76 @@
+/* ========================================================================
+ * app.js
+ * http://github.com/jimjh/aladdin
+ * ========================================================================
+ * Copyright (c) 2012 Carnegie Mellon University
+ * License: https://raw.github.com/jimjh/aladdin/master/LICENSE
+ * ========================================================================
+ */
+/*jshint strict:true unused:true*/
+/*global $*/
+
+;(function () {
+  'use strict';
+
+  // TODO: refactor
+
+  // Shows results of last submission at the given button and form.
+  var showResult = function(button, form) {
+    return function(result) {
+      switch(result) {
+      case true:
+        button.addClass('success');
+        form.removeClass('error');
+        break;
+      case false:
+        button.removeClass('success');
+        form.addClass('error');
+        break;
+      default:
+        $.each(result, function(i, row) {
+          $.each(row, function(j, cell) {
+            var input = form.find("input[name='answer["+i+"]["+j+"]']");
+            if (cell) input.addClass('success'); else input.addClass('error');
+          });
+        });
+      }
+    };
+  };
+
+  // Adds click listeners to the submit buttons.
+  var observeSubmitButton = function() {
+
+    $('a.button.submit').click(function(e) {
+      var button = $(e.target);
+      var form = button.parents('form');
+      var id = form.find('input.q-id').val();
+      $.post('/verify/quiz/' + id, form.serialize(), showResult(button, form));
+      return false;
+    });
+
+  };
+
+  // Adds click listeners to the run buttons.
+  // var run = function() {
+  //   $('a.button.run').click(function(e){
+  //     var form = $(e.target).parents('form');
+  //     var raw = form.find('.ex-raw').val();
+  //     var id = form.find('.ex-id').val();
+  //     $.post('/verify/code/' + id, raw,
+  //       function(data) { console.log(data); }
+  //     );
+  //     return false;
+  //   });
+  // };
+
+  var genie = {
+
+    launch: function() {
+      observeSubmitButton();
+    }
+
+  };
+
+  $(genie.launch());
+
+})();

data/bin/aladdin

@@ -1,20 +1,5 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+$:.unshift File.join File.dirname(__FILE__), *%w(.. lib)
 
-require 'aladdin'
-require 'optparse'
-
-opt_parser = OptionParser.new do |opts|
-
-  opts.banner = 'Usage: aladdin /path/to/tutorial/directory'
-
-  opts.on_tail('--version', 'Display current gem version.') do
-    puts 'aladdin v' + Aladdin::VERSION
-    exit 0
-  end
-
-end
-opt_parser.parse!
-
-Aladdin.launch from: ARGV[0]
+require 'aladdin/cli'

data/lib/aladdin.rb

@@ -4,27 +4,66 @@ require 'zurb-foundation'
 require 'albino'
 require 'haml'
 require 'redcarpet'
+require 'htmlentities'
 require 'sanitize'
+require 'yaml'
+require 'json'
 
-require 'aladdin/render/sanitize'
+require 'aladdin/mixin/logger'
+require 'aladdin/mixin/weak_comparator'
+require 'aladdin/submission'
 require 'aladdin/render/markdown'
 
-# Aladdin is for tutorial apps.
+# Aladdin is a gem that tutorial authors can use to preview and test their
+# tutorials locally.
 module Aladdin
 
-  # 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 self.launch(opts = {})
-    Aladdin::App.set :views, Aladdin::VIEWS.merge(markdown: opts[:from] || '.')
-    Aladdin::App.run!
-  end
+  # 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
+
+    # 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
+      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 ) )
+    end
 
-  # Converts a hash to struct.
-  def self.to_struct(hash)
-    Struct.new( *(k = hash.keys) ).new( *hash.values_at( *k ) )
   end
-  private_class_method :to_struct
 
   # Paths to different types of views.
   VIEWS = {
@@ -38,6 +77,12 @@ module Aladdin
     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

@@ -7,15 +7,19 @@ module Aladdin
   # Adapted from https://github.com/jerodsanto/sinatra-foundation-skeleton/
   class App < Sinatra::Base
 
+    # Default page
+    INDEX = :index
+
     # Default markdown options.
     MARKDOWN_OPTIONS = {
       renderer:           Aladdin::Render::HTML,
+      layout_engine:      :haml,
       no_intra_emphasis:  true,
       tables:             true,
       fenced_code_blocks: true,
       autolink:           true,
       strikethrough:      true,
-      layout_engine:      :haml
+      tables:             true,
     }
 
     class << self
@@ -40,7 +44,7 @@ module Aladdin
         set :public_folder, Aladdin::PATHS.assets
       end
 
-      # Configures ZURB's compass to compile laddin's scss assets.
+      # Configures ZURB's compass to compile aladdin's scss assets.
       # @return [void]
       def configure_compass
         Compass.configuration do |config|
@@ -50,12 +54,12 @@ module Aladdin
         set :scss, Compass.sass_engine_options
       end
 
-      # Registers redcarpet2 and laddin's markdown renderer to be as close to
-      # the github-flavored markdown as possible.
+      # Registers redcarpet2 and configures aladdin's markdown renderer.
       # @return [void]
       def configure_markdown
-        Tilt.register Tilt::RedcarpetTemplate::Redcarpet2, 'markdown', 'mkd', 'md'
+        Tilt.register Tilt::RedcarpetTemplate::Redcarpet2, *%w(markdown mkd md)
         set :markdown, MARKDOWN_OPTIONS
+        set :haml, escape_html: true
       end
 
     end
@@ -64,10 +68,13 @@ module Aladdin
     # @param block        block to call within wrapper
     def render_or_pass(&block)
       begin return block.call
-      rescue pass
+      rescue Exception => e
+        logger.error e.message
+        pass
       end
     end
 
+    enable :logging
     configure_views
     configure_markdown
 
@@ -80,8 +87,21 @@ module Aladdin
       render_or_pass { scss path.to_sym }
     end
 
+    get '/img/*' do |path|
+      send_file File.join('img', path)
+    end
+
     get '/*' do |path|
-      render_or_pass { markdown path.to_sym }
+      path = path.empty? ? INDEX : path.to_sym
+      render_or_pass do
+        markdown(path, locals: Aladdin.config)
+      end
+    end
+
+    post '/verify/:type/:id' do
+      input = request.body.read
+      content_type :json
+      Submission.new(params[:id], params[:type], params, input).verify
     end
 
   end

data/lib/aladdin/cli.rb

@@ -0,0 +1,29 @@
+# ~*~ 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/commands/new.rb

@@ -0,0 +1,16 @@
+# ~*~ encoding: utf-8 ~*~
+require 'aladdin'
+require 'optparse'
+
+# Array of skeleton files to be copied over.
+SKELETON_FILES = %w(.genie.yml index.md images)
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: aladdin new [options] [LESSON_PATH]"
+end
+opt_parser.parse!
+
+root = ARGV[0] || Dir.pwd
+
+Dir.chdir File.join File.dirname(__FILE__), *%w(.. .. .. skeleton)
+FileUtils.cp_r SKELETON_FILES, root, verbose: true

data/lib/aladdin/commands/server.rb

@@ -0,0 +1,10 @@
+# ~*~ encoding: utf-8 ~*~
+require 'aladdin'
+require 'optparse'
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: aladdin server [options] [LESSON_PATH]"
+end
+opt_parser.parse!
+
+Aladdin.launch from: ARGV[0]

data/lib/aladdin/mixin/logger.rb

@@ -0,0 +1,26 @@
+# ~*~ 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

data/lib/aladdin/mixin/weak_comparator.rb

@@ -0,0 +1,60 @@
+# ~*~ encoding: utf-8 ~*~
+module Aladdin
+
+  module Mixin
+
+    # Provides a richer comparison with weak-typing.
+    # @see #same?
+    module WeakComparator
+
+      # Compares +submitted+ against +saved+ and returns a simple diff. Assumes
+      # that:
+      # - +saved+ is a ruby-marshalled value that carries rich type information
+      # - +submitted+ is a user-submitted value that is either a string or an
+      #   hash
+      #
+      # === Booleans
+      # If +saved+ is +true+, then it will accept any +submitted+ value that
+      # begins with 'T' or 't'. Similarly, if +saved+ is +false+, then it will
+      # accept any +submitted+ value that begins with 'F' or 'f'.
+      #
+      # === 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.
+      #
+      # @param [String, Hash] submitted
+      # @param [String, Numeric, Boolean, Hash] saved
+      # @return [Boolean, Hash] diff
+      def same?(submitted, saved)
+        case saved
+        when Hash
+          Hash === submitted and same_hash? submitted, saved
+        when String then saved == submitted
+        when Numeric then saved == JSON.parse(%|[#{submitted}]|).first
+        when TrueClass, FalseClass then saved.to_s[0] == submitted.downcase[0]
+        else false end
+      rescue
+        false
+      end
+
+      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.
+      #
+      # @param [Hash] submitted
+      # @param [Hash] saved
+      # @return [Boolean, Hash] diff
+      # @see #same?
+      def same_hash?(submitted, saved)
+        saved.count == submitted.count and
+          Hash[saved.map { |key, value| [key, same?(submitted[key], value)] }]
+      end
+
+    end
+
+  end
+
+end