aladdin 0.0.1 → 0.0.3

data/lib/aladdin/render/table.rb

@@ -0,0 +1,109 @@
+# ~*~ encoding: utf-8 ~*~
+module Aladdin
+
+  module Render
+
+    # Renders table problems marked up in JSON as HTML.
+    #
+    # The grid should be given as a 2-dimensional array that represents the
+    # table to be filled in. +"?"+ is a special token used in the grid to
+    # indicate cells that require student input.
+    #
+    # The answer should also be given as a 2-dimensional array. However, a
+    # dummy token may be used in cells that do not require student input to
+    # cut redundancy. In the example below, the +"-"+ token is used.
+    #
+    # @example
+    #     {
+    #       "format": "table",
+    #       "question": "fill me in",
+    #       "grid": [[0, "?", 2], [3, "?", 5]],
+    #       "answer": [["-", 1, "-"],  ["-", 4, "-"]
+    #     }
+    class Table < Problem
+
+      # Name of template file for rendering table problems.
+      TEMPLATE = 'table.haml'
+
+      # Optional headings key.
+      HEADINGS = 'headings'
+
+      # Required grid key.
+      GRID = 'grid'
+
+      # Special token indicating that the cell should be filled in.
+      FILL_ME_IN = '?'
+
+      accessor HEADINGS, GRID
+
+      # Ensures that the +headings+ key exists.
+      def initialize(json)
+        json[HEADINGS] ||= nil
+        super
+      end
+
+      # Checks if the given json contains a valid table.
+      # @return [Boolean] true iff the json contains a valid table.
+      def valid?
+        super and
+          valid_grid? and
+          valid_answer?
+      end
+
+      # Gets the expected answer, in www-form-urlencoded format.
+      # @return [Hash] answers, as expected from student's form submission
+      def answer
+        return @answer unless @answer.nil?
+        @answer = encode_answer
+      end
+
+      # @return [Boolean] true iff the given cell is an input cell
+      def self.input?(cell)
+        cell == FILL_ME_IN
+      end
+
+      private
+
+      # Iterates through each cell in the provided grid to look for answers
+      # cells that require input and takes the answer from the answers array.
+      # For example, if the answer for a cell at [0][1] is 6, the returned
+      # hash will contain
+      #
+      #     {'0' => {'1' => 6}}
+      #
+      # @return [Hash] answers
+      def encode_answer
+        encoded, ans = {}, @json[ANSWER]
+        grid.each_with_index do |row, i|
+          row.each_with_index do |cell, j|
+            next unless Table.input? cell
+            encoded[i.to_s] ||= {}
+            encoded[i.to_s][j.to_s] = serialize ans[i][j]
+          end
+        end
+        encoded
+      end
+
+      # @return [Boolean] true iff the json contains a valid grid.
+      def valid_grid?
+        @json.has_key? GRID and is_2d_array? grid
+      end
+
+      # @return [Boolean] true iff +answer+ is a valid 2D array and has the
+      # same number of rows as +grid+.
+      def valid_answer?
+        ans = @json[ANSWER]
+        is_2d_array? ans and ans.size == grid.size
+      end
+
+      # @return [Boolean] true iff +t+ is a 2-dimensional array.
+      def is_2d_array?(t)
+        t.is_a? Array and t.all? { |row| row.is_a? Array }
+      end
+
+    end
+
+  end
+
+end
+

data/lib/aladdin/render/template.rb

@@ -0,0 +1,32 @@
+# ~*~ encoding: utf-8 ~*~
+module Aladdin
+
+  module Render
+
+    # Child classes should provide a +TEMPLATE+ string constant that contains
+    # the path to the 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.
+      def render(locals={})
+        view.render Object.new, locals
+      end
+
+      private
+
+      # Retrieves the +view+ singleton. If it is nil, initializes it from
+      # +self.class.TEMPLATE+.
+      # @return [Haml::Engine] haml engine
+      def view
+        return @view unless @view.nil?
+        file = File.join Aladdin::VIEWS[:haml], self.class::TEMPLATE
+        @view = Haml::Engine.new(File.read file)
+      end
+
+    end
+
+  end
+
+end

data/lib/aladdin/submission.rb

@@ -0,0 +1,92 @@
+# ~*~ encoding: utf-8 ~*~
+require 'securerandom'
+
+module Aladdin
+
+  # Student submission.
+  #
+  # == DANGER DANGER DANGER ==
+  # The scratchspace code assumes that there is only one submission at a time,
+  # 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
+
+    SCRATCHSPACE = '.__ss'
+
+    # Creates a new student submission.
+    # @param [String] id      exercise ID
+    # @param [Type]   type    quiz or code
+    # @param [Hash]   params  form values
+    # @param [String] input   student input
+    def initialize(id, type, params, input)
+      @id, @type, @params, @input = id, type, params, input
+    end
+
+    # Verifies the student's submission.
+    def verify
+      case @type
+      when Type::CODE then verify_code
+      when Type::QUIZ then verify_quiz
+      end
+    end
+
+    private
+
+    # Verifies quiz answers by comparing the submitted answer against the
+    # answer in the solution file.
+    # @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
+      File.open(solution, 'rb') { |f| same? @params['answer'], Marshal.restore(f) }.to_json
+    rescue => e
+      logger.warn e.message
+      false.to_json
+    end
+
+    # Executes the verification script and returns the JSON-encoded results.
+    # @example
+    #     ./verify --id=0 --input=path/to/student/input
+    def verify_code
+      scratchspace do
+        # FIXME: catch errors
+        filename = SecureRandom.uuid
+        IO.write(filename, @input)
+        bin = File.join '..', Aladdin.config['verify']['bin']
+        `#{bin} --id=#{@id} --input=#{filename}`
+        IO.read 'genie-results.json'
+      end
+    end
+
+    def scratchspace
+      enter_scratchspace
+      results = yield
+      exit_scratchspace
+      return results
+    end
+
+    def enter_scratchspace
+      # TODO: handle errors
+      Dir.mkdir SCRATCHSPACE
+      Dir.chdir SCRATCHSPACE
+    end
+
+    def exit_scratchspace
+      # TODO: handle errors
+      Dir.chdir '..'
+      FileUtils.rm_rf SCRATCHSPACE
+    end
+
+    # Submission Type, for use as enum.
+    module Type
+      # Quiz Type
+      QUIZ = 'quiz'
+      # Code Type
+      CODE = 'code'
+    end
+
+  end
+
+end

data/lib/aladdin/version.rb

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

data/skeleton/index.md

@@ -0,0 +1,3 @@
+# Lesson 0
+
+This is your first lesson! Hack away.

data/views/haml/exe.haml

@@ -0,0 +1,5 @@
+-# coding: UTF-8
+%form{id: id}
+  %input.ex-raw{type: 'hidden', value: raw}
+  %input.ex-id{type: 'hidden', value: id}
+  %a.button.run{href: "#"} Run

data/views/haml/img.haml

@@ -0,0 +1,6 @@
+-# coding: UTF-8
+.block-image
+  = img
+  %p
+    %strong Figure #{index}:
+    = caption

data/views/haml/layout.haml

@@ -1,3 +1,4 @@
+-# coding: UTF-8
 !!! 5
 
 -# paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/
@@ -10,23 +11,52 @@
   %meta{charset: 'utf-8'}
   %meta{name: 'viewport', content: 'width=device-width'}
 
-  %title Welcome to Foundation
+  %title= title
   %link{rel: 'stylesheet', href:'stylesheets/app.css'}
-  %link{rel: 'stylesheet', href:'stylesheets/pygment.css'}
-  %link{rel: 'stylesheet', href:'stylesheets/github.css'}
   %script{src: 'javascripts/foundation/modernizr.foundation.js'}
 
 %body
 
   .row
-    .twelve.columns
-      %h1 Genie Tutorial
-      %hr/
 
-  .row
-    .twelve.columns
-      =yield
+    %section{role: 'complementary'}
+      .row
+        .six.columns
+          %h1= title
+          %h4
+            <!-- TODO: user gravatar -->
+            %img{src: 'images/no_gravatar.gif', width: 20, height: 20, alt: 'John Doe'}
+            <!-- TOOD: user name -->
+            %small John Doe
+          %h4.subheader= description
+          %div.panel.meta
+            %h6.subheader Dec 18, 2012 12:00PM
+            %ul.inline-list
+              -categories.each do |category|
+                %li
+                  %a{href: '#'}=category
+        .six.columns
+          %h1
+            %a.th.hero{href: '#'}
+              <!-- TODO: graphic from user's repo -->
+              %img{src: 'images/graphic.png'}
+
+    %hr/
+    %section{role: 'lesson'}
+      .row
+        .twelve.columns
+          !=yield # output is sanitized by the sanitize gem
+
+    %hr/
 
+    .row#footer
+      .ten.columns
+        .radius.progress.success.ten
+          %span.meter.eight 80%
+      .two.columns
+        %span <!-- TODO: score goes here -->
+
+  -# foundation
   %script{src: 'javascripts/foundation/jquery.js'}
   %script{src: 'javascripts/foundation/jquery.cookie.js'}
   %script{src: 'javascripts/foundation/jquery.event.move.js'}
@@ -36,16 +66,18 @@
   %script{src: 'javascripts/foundation/jquery.foundation.buttons.js'}
   %script{src: 'javascripts/foundation/jquery.foundation.clearing.js'}
   %script{src: 'javascripts/foundation/jquery.foundation.forms.js'}
-  %script{src: 'javascripts/foundation/jquery.foundation.joyride.js'}
   %script{src: 'javascripts/foundation/jquery.foundation.magellan.js'}
   %script{src: 'javascripts/foundation/jquery.foundation.mediaQueryToggle.js'}
   %script{src: 'javascripts/foundation/jquery.foundation.navigation.js'}
-  %script{src: 'javascripts/foundation/jquery.foundation.orbit.js'}
-  %script{src: 'javascripts/foundation/jquery.foundation.reveal.js'}
   %script{src: 'javascripts/foundation/jquery.foundation.tabs.js'}
   %script{src: 'javascripts/foundation/jquery.foundation.tooltips.js'}
   %script{src: 'javascripts/foundation/jquery.foundation.topbar.js'}
   %script{src: 'javascripts/foundation/jquery.placeholder.js'}
+  %script{src: 'javascripts/foundation/app.js'}
+
+  -# mathjax
+  %script{src: 'https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'}
+  %script{src: 'javascripts/app.js'}
 
 :plain
   </html>

data/views/haml/multi.haml

@@ -0,0 +1,18 @@
+-# coding: UTF-8
+%form.question{id: "question_#{id}"}
+  %fieldset
+
+    %legend Problem #{index}
+    %input.q-id{type: 'hidden', value: id}
+
+    %p= question
+
+    .row.collapse
+      .ten.mobile-three.columns
+        -options.each do |value, label|
+          %label{for: 'answer'}
+            %input{name: 'answer', type: 'radio', value: value}
+              = label
+      .two.mobile-one.columns
+        %a.button.submit.small.expand.postfix.radius{href: '#'} Submit
+

data/views/haml/nav.haml

@@ -0,0 +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

data/views/haml/short.haml

@@ -0,0 +1,14 @@
+-# coding: UTF-8
+%form.question{id: "question_#{id}"}
+  %fieldset
+
+    %legend Problem #{index}
+    %input.q-id{type: 'hidden', value: id}
+
+    %p= question
+
+    .row.collapse
+      .ten.mobile-three.columns
+        %input{name: 'answer', type: 'text'}
+      .two.mobile-one.columns
+        %a.button.small.submit.expand.postfix.radius{href: '#'} Submit

data/views/haml/table.haml

@@ -0,0 +1,30 @@
+-# coding: UTF-8
+%form.question{id: "question_#{id}"}
+  %fieldset
+
+    %legend Problem #{index}
+    %input.q-id{type: 'hidden', value: id}
+
+    %p= question
+
+    .row
+      .twelve.columns
+        %table
+          %thead
+            -if headings
+              %tr
+                -headings.each do |heading|
+                  %th= heading
+
+          %tbody
+            -grid.each_with_index do |row, i|
+              %tr
+                -row.each_with_index do |cell, j|
+                  %td
+                    - if Aladdin::Render::Table.input? cell
+                      %input{name: "answer[#{i}][#{j}]", type: 'text'}
+                    - else
+                      = cell
+    .row
+      .two.columns.mobile-one
+        %a.button.small.submit.radius{href: '#'} Submit

data/views/scss/app.scss

@@ -1,47 +1,53 @@
-// You custom settings file to override Foundation defaults
 @import "settings";
-
-// Comment out this import if you are customizing you imports below
 @import "foundation";
 
-// ----------------------------------------
-// Import specific parts of Foundation by commenting the import "foundation"
-// and uncommenting what you want below. You must uncomment the following if customizing
-
-// @import "compass/css3";
-// @import "foundation/settings";
-// @import "foundation/functions/all";
-
-// Control which mixins you have access too
-
-// @import "foundation/mixins/clearfix";
-// @import "foundation/mixins/css-triangle";
-// @import "foundation/mixins/font-size";
-
-// Must include next two for semantic grid to work
-
-// @import "foundation/mixins/respond-to";
-// @import "foundation/mixins/semantic-grid";
-
-// @import "modular-scale";
-// @import "foundation/common/globals";
-
-// Must include the grid for any responsiveness
-
-// @import "foundation/components/grid";
-
-// Control which common styles get compiled
-
-// @import "foundation/common/typography";
-// @import "foundation/common/forms";
-
-// Control which components you get if customizing
-
-// @import "foundation/components/modules/buttons";
-// @import "foundation/components/modules/tabs";
-// @import "foundation/components/modules/ui";
-// @import "foundation/components/modules/topbar";
-// @import "foundation/components/modules/navbar";
-// @import "foundation/components/modules/orbit";
-// @import "foundation/components/modules/reveal";
-// @import "foundation/components/modules/offcanvas";
+/* settings */
+$borderWidth: 2px;
+
+.highlight {
+  @import "pygment";
+  @import "github";
+}
+
+@import "mathjax";
+
+body {
+  padding: 0 $columnGutter/2;
+}
+
+/* Meta panel */
+div.meta.panel {
+  border-top: $borderWidth solid $darkEdge;
+}
+
+/* Lesson graphic */
+a.hero img {
+  width: 100%;
+}
+
+/* Floating navigation bar */
+#sections {
+  background: darken($white, 5%);
+  padding-top: 10px;
+  width: $rowWidth + 18;
+  border-bottom: $borderWidth solid $darkEdge;
+  z-index: 3;
+}
+
+/* Progress bar */
+#footer .meter {
+  color: $white;
+  font-weight: 800;
+  text-align: right;
+  padding: 2px 2px 0 0;
+}
+
+/* Styling within lesson */
+
+section[role='lesson'] .block-image {
+  text-align: center;
+}
+
+section[role='lesson'] ul {
+  margin-left: 17px;
+}