aladdin 0.0.7 → 0.0.8

data/lib/aladdin/app.rb

@@ -1,6 +1,5 @@
 # ~*~ encoding: utf-8 ~*~
 require 'sinatra'
-require 'zurb-foundation'
 require 'aladdin/submission'
 
 module Aladdin
@@ -8,7 +7,6 @@ module Aladdin
   # Sinatra app that serves the tutorial. Should be able to use this in a
   # config.ru file or as middleware. Authors should launch the app using the
   # +bin/aladdin+ executable.
-  # Adapted from https://github.com/jerodsanto/sinatra-foundation-skeleton/
   class App < Sinatra::Base
     extend Support::OneOfPattern
 
@@ -40,26 +38,17 @@ module Aladdin
       # Configures path to static assets in the public folder.
       # @return [void]
       def configure_assets
-        set :public_folder, Aladdin::PATHS.assets
+        puts Aladdin::PATHS.public
+        set :public_folder, Aladdin::PATHS.public
         set :static_paths, Proc.new { Aladdin.config[:static_paths] }
       end
 
-      # Configures ZURB's compass to compile aladdin's scss assets.
-      # @return [void]
-      def configure_compass
-        Compass.configuration do |config|
-          config.http_path = '/'
-          config.http_images_path = '/__img'
-        end
-        set :scss, Compass.sass_engine_options
-      end
-
       # Registers redcarpet2 and configures aladdin's markdown renderer.
       # @return [void]
       def configure_markdown
         Tilt.register Tilt::RedcarpetTemplate::Redcarpet2, *%w(markdown mkd md)
         set :markdown, MARKDOWN_OPTIONS
-        set :haml, escape_html: true
+        set :haml, escape_html: true, format: :html5
       end
 
     end
@@ -77,21 +66,14 @@ module Aladdin
     enable :logging
     configure_views
     configure_markdown
-
-    configure :development, :test do
-      configure_assets
-      configure_compass
-    end
-
-    get '/__css/*.css' do |path|
-      render_or_pass { scss path.to_sym }
-    end
+    configure_assets
 
     get one_of(settings.static_paths) do |path|
       send_file File.join(settings.root, path)
     end
 
     get '/*' do |path|
+      pass if path.starts_with? '__sinatra__'
       path = path.empty? ? INDEX : path.to_sym
       render_or_pass do
         markdown(path, locals: Aladdin.config)

data/lib/aladdin/constants.rb

@@ -8,7 +8,7 @@ module Aladdin
   # Paths to other parts of the library.
   PATHS = {
     root:     root,
-    assets:   File.expand_path('assets', root),
+    public:   File.expand_path('public', root),
     skeleton: File.expand_path('skeleton', root)
   }.to_struct.freeze
 

data/lib/aladdin/render/html.rb

@@ -26,15 +26,16 @@ module Aladdin
 
       # Paragraphs that start and end with braces are treated as JSON blocks
       # and are parsed for questions/answers.
-      PROBLEM_REGEX = %r<^\s*{.+$>
+      PROBLEM_REGEX = /\A\s*{.+\z/m
 
       # Paragraphs that only contain images are rendered differently.
-      IMAGE_REGEX = %r{^\s*<img[^<>]+>\s*$}
+      IMAGE_REGEX = /\A\s*<img[^<>]+>\s*\z/m
 
       # Renderer configuration options.
       CONFIGURATION = {
         hard_wrap:          true,
         no_styles:          true,
+        name:               'untitled'
       }
 
       # Creates a new HTML renderer.
@@ -42,6 +43,7 @@ module Aladdin
       def initialize(options = {})
         super options.merge(CONFIGURATION)
         exe_template = File.join(Aladdin::VIEWS[:haml], 'exe.haml')
+        @name = options[:name]
         @exe = Haml::Engine.new(File.read exe_template)
         @nav, @headers = Navigation.new, Headers.new
         @prob, @img = 0, 0 # indices for Problem #, Figure #
@@ -104,7 +106,7 @@ module Aladdin
       def problem(json)
         b = '\\' # unescape backslashes
         problem = Problem.parse(HTML.entities.decode(json).gsub(b, b * 4))
-        problem.save! and problem.render(index: @prob += 1)
+        problem.save! @name and problem.render(index: @prob += 1)
       end
 
       # Prepares a block image. Raises {RenderError} or {ParseError} if the

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

@@ -76,7 +76,7 @@ module Aladdin
       # Saves the answer to a file on disk.
       # @todo TODO should probably show some error message in the preview,
       #   so that the author doesn't have to read the logs.
-      def save!
+      def save!(name)
         raise RenderError.new('Invalid problem.') unless valid?
         solution = File.join(Aladdin::DATA_DIR, id + Aladdin::SOLUTION_EXT)
         File.open(solution, 'wb+') { |file| Marshal.dump answer, file }

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

@@ -24,7 +24,7 @@ module Aladdin
       def view
         return @view unless @view.nil?
         file = File.join Aladdin::VIEWS[:haml], self.class::TEMPLATE
-        @view = Haml::Engine.new(File.read file)
+        @view = Haml::Engine.new(File.read file, format: :html5)
       end
 
     end

data/lib/aladdin/submission.rb

@@ -17,7 +17,7 @@ module Aladdin
 
     # Creates a new student submission.
     # @param [String] id      exercise ID
-    # @param [Type]   type    quiz or code
+    # @param [Type]   type    problem or code
     # @param [Hash]   params  form values
     # @param [String] input   student input
     def initialize(id, type, params, input)
@@ -28,16 +28,16 @@ module Aladdin
     def verify
       case @type
       when Type::CODE then verify_code
-      when Type::QUIZ then verify_quiz
+      when Type::PROBLEM then verify_problem
       end
     end
 
     private
 
-    # Verifies quiz answers by comparing the submitted answer against the
+    # Verifies problem 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
+    def verify_problem
       id = @id.gsub File::SEPARATOR, '' # protect against directory attacks
       solution = File.expand_path id + Aladdin::SOLUTION_EXT, Aladdin::DATA_DIR
       File.open(solution, 'rb') { |f| same? @params['answer'], Marshal.restore(f) }.to_json
@@ -81,8 +81,8 @@ module Aladdin
 
     # Submission Type, for use as enum.
     module Type
-      # Quiz Type
-      QUIZ = 'quiz'
+      # Problem Type
+      PROBLEM = 'problem'
       # Code Type
       CODE = 'code'
     end

data/lib/aladdin/version.rb

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

data/views/haml/layout.haml

@@ -12,12 +12,12 @@
   %meta{name: 'viewport', content: 'width=device-width'}
 
   %title= title
-  %link{rel: 'stylesheet', href:'__css/app.css'}
-  %link{rel: 'stylesheet', href:'__css/general_foundicons.css'}
+  %link{rel: 'stylesheet', href:'/assets/application.css'}
+  %link{rel: 'stylesheet', href:'/assets/general_foundicons.css'}
   /[if lt IE 8]
-    %link{rel: 'stylesheet', href:'__css/general_foundicons_ie7.css'}
+    %link{rel: 'stylesheet', href:'/assets/general_foundicons_ie7.css'}
 
-  %script{src: '__js/foundation/modernizr.foundation.js'}
+  %script{src: '/assets/foundation/modernizr.foundation.js'}
 
 %body
 
@@ -29,7 +29,7 @@
           %h1= title
           %h4
             <!-- TODO: user gravatar -->
-            %img{src: '__img/no_gravatar.gif', width: 20, height: 20, alt: 'John Doe'}
+            %img{src: '/assets/no_gravatar.gif', width: 20, height: 20, alt: 'John Doe'}
             <!-- TOOD: user name -->
             %small John Doe
           %h4.subheader= description
@@ -43,7 +43,7 @@
           %h1
             %a.th.hero{href: '#'}
               <!-- TODO: graphic from user's repo -->
-              %img{src: '__img/graphic.png'}
+              %img{src: '/assets/graphic.png'}
 
     %hr/
     %section{role: 'lesson'}
@@ -61,27 +61,27 @@
         %span <!-- TODO: score goes here -->
 
   -# foundation
-  %script{src: '__js/foundation/jquery.js'}
-  %script{src: '__js/foundation/jquery.cookie.js'}
-  %script{src: '__js/foundation/jquery.event.move.js'}
-  %script{src: '__js/foundation/jquery.event.swipe.js'}
-  %script{src: '__js/foundation/jquery.foundation.accordion.js'}
-  %script{src: '__js/foundation/jquery.foundation.alerts.js'}
-  %script{src: '__js/foundation/jquery.foundation.buttons.js'}
-  %script{src: '__js/foundation/jquery.foundation.clearing.js'}
-  %script{src: '__js/foundation/jquery.foundation.forms.js'}
-  %script{src: '__js/foundation/jquery.foundation.magellan.js'}
-  %script{src: '__js/foundation/jquery.foundation.mediaQueryToggle.js'}
-  %script{src: '__js/foundation/jquery.foundation.navigation.js'}
-  %script{src: '__js/foundation/jquery.foundation.tabs.js'}
-  %script{src: '__js/foundation/jquery.foundation.tooltips.js'}
-  %script{src: '__js/foundation/jquery.foundation.topbar.js'}
-  %script{src: '__js/foundation/jquery.placeholder.js'}
-  %script{src: '__js/foundation/app.js'}
+  %script{src: 'assets/foundation/jquery.js'}
+  %script{src: 'assets/foundation/jquery.cookie.js'}
+  %script{src: 'assets/foundation/jquery.event.move.js'}
+  %script{src: 'assets/foundation/jquery.event.swipe.js'}
+  %script{src: 'assets/foundation/jquery.foundation.accordion.js'}
+  %script{src: 'assets/foundation/jquery.foundation.alerts.js'}
+  %script{src: 'assets/foundation/jquery.foundation.buttons.js'}
+  %script{src: 'assets/foundation/jquery.foundation.clearing.js'}
+  %script{src: 'assets/foundation/jquery.foundation.forms.js'}
+  %script{src: 'assets/foundation/jquery.foundation.magellan.js'}
+  %script{src: 'assets/foundation/jquery.foundation.mediaQueryToggle.js'}
+  %script{src: 'assets/foundation/jquery.foundation.navigation.js'}
+  %script{src: 'assets/foundation/jquery.foundation.tabs.js'}
+  %script{src: 'assets/foundation/jquery.foundation.tooltips.js'}
+  %script{src: 'assets/foundation/jquery.foundation.topbar.js'}
+  %script{src: 'assets/foundation/jquery.placeholder.js'}
+  %script{src: 'assets/foundation/app.js'}
 
   -# mathjax
   %script{src: 'https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'}
-  %script{src: '__js/app.js'}
+  %script{src: 'assets/app.min.js'}
 
 :plain
   </html>

data/views/haml/multi.haml

@@ -1,10 +1,8 @@
 -# coding: UTF-8
-%form.question{id: "question_#{id}"}
+%form.problem{action: 'verify/problem/' + id, 'accept-charset' => 'UTF-8', id: "problem_#{id}", method: 'post'}
   %fieldset
 
     %legend Problem #{index}
-    %input.q-id{type: 'hidden', value: id}
-
     %p= question
 
     .row.collapse

data/views/haml/short.haml

@@ -1,10 +1,8 @@
 -# coding: UTF-8
-%form.question{id: "question_#{id}"}
+%form.problem{action: 'verify/problem/' + id, 'accept-charset' => 'UTF-8', id: "problem_#{id}", method: 'post'}
   %fieldset
 
     %legend Problem #{index}
-    %input.q-id{type: 'hidden', value: id}
-
     %p= question
 
     .row.collapse

data/views/haml/table.haml

@@ -1,10 +1,8 @@
 -# coding: UTF-8
-%form.question{id: "question_#{id}"}
+%form.problem{action: 'verify/problem/' + id, 'accept-charset' => 'UTF-8', id: "problem_#{id}", method: 'post'}
   %fieldset
 
     %legend Problem #{index}
-    %input.q-id{type: 'hidden', value: id}
-
     %p= question
 
     .row

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aladdin
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-29 00:00:00.000000000 Z
+date: 2013-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -27,22 +27,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: zurb-foundation
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.3
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -258,36 +242,6 @@ files:
 - lib/aladdin/support.rb
 - lib/aladdin/version.rb
 - lib/aladdin.rb
-- assets/__font/general_foundicons.eot
-- assets/__font/general_foundicons.svg
-- assets/__font/general_foundicons.ttf
-- assets/__font/general_foundicons.woff
-- assets/__img/graphic.png
-- assets/__img/no_gravatar.gif
-- assets/__js/app.js
-- assets/__js/foundation/app.js
-- assets/__js/foundation/jquery.cookie.js
-- assets/__js/foundation/jquery.event.move.js
-- assets/__js/foundation/jquery.event.swipe.js
-- assets/__js/foundation/jquery.foundation.accordion.js
-- assets/__js/foundation/jquery.foundation.alerts.js
-- assets/__js/foundation/jquery.foundation.buttons.js
-- assets/__js/foundation/jquery.foundation.clearing.js
-- assets/__js/foundation/jquery.foundation.forms.js
-- assets/__js/foundation/jquery.foundation.joyride.js
-- assets/__js/foundation/jquery.foundation.magellan.js
-- assets/__js/foundation/jquery.foundation.mediaQueryToggle.js
-- assets/__js/foundation/jquery.foundation.navigation.js
-- assets/__js/foundation/jquery.foundation.orbit.js
-- assets/__js/foundation/jquery.foundation.reveal.js
-- assets/__js/foundation/jquery.foundation.tabs.js
-- assets/__js/foundation/jquery.foundation.tooltips.js
-- assets/__js/foundation/jquery.foundation.topbar.js
-- assets/__js/foundation/jquery.js
-- assets/__js/foundation/jquery.offcanvas.js
-- assets/__js/foundation/jquery.placeholder.js
-- assets/__js/foundation/modernizr.foundation.js
-- assets/favicon.ico
 - views/haml/exe.haml
 - views/haml/header.haml
 - views/haml/img.haml
@@ -331,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3977803358167524809
+      hash: -57149837415841268
 requirements:
 - pygments, python's syntax highlighter
 rubyforge_project: 

data/assets/__font/general_foundicons.svg

@@ -1,15 +0,0 @@
-<?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/assets/__js/app.js

@@ -1,76 +0,0 @@
-/* ========================================================================
- * 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(form) {
-    return function(result) {
-      switch(result) {
-      case true:
-        form.removeClass('error');
-        form.addClass('success');
-        break;
-      case false:
-        form.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+"]']");
-            showResult(input)(cell);
-          });
-        });
-      }
-    };
-  };
-
-  // 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(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());
-
-})();