aladdin 0.0.8 → 0.1.0.pre

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Jiunn Haur Lim, Carnegie Mellon University
+Copyright (c) 2012-2013 Jiunn Haur Lim, Carnegie Mellon University
 
 MIT License
 

data/README.md

@@ -1,27 +1,17 @@
-# Aladdin
-[![Build Status](https://secure.travis-ci.org/jimjh/aladdin.png?branch=master)](https://travis-ci.org/jimjh/aladdin)
-[![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)
+# Aladdin a.k.a. genie-previewer
+[![Build Status](https://secure.travis-ci.org/jimjh/genie-previewer.png?branch=master)](https://travis-ci.org/jimjh/genie-previewer)
+[![Dependency Status](https://gemnasium.com/jimjh/genie-previewer.png)](https://gemnasium.com/jimjh/genie-previewer)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jimjh/genie-previewer)
 
-Generates lessons using the markdown document and tests provided by the author.
+Previews lessons using the markdown document and tests provided by the author.
 
 ## Installation
-Add this line to your application's Gemfile:
-
-    gem 'aladdin'
-
-And then execute:
-
-    $> easy_install Pygments
-    $> bundle install
-
-Or install it yourself as:
 
     $> easy_install Pygments
     $> gem install aladdin
 
 ## Usage
-Create a new directory for your notes _e.g._ `lesson_0`. Change into that
+Create a new directory for your lesson _e.g._ `lesson_0`. Change into that
 directory, then execute:
 
 ```sh
@@ -34,6 +24,8 @@ Update `index.md` and provide your unit tests in the lesson directory. Finally,
 $> aladdin server
 ```
 
+Your lesson may be previewed at `http://localhost:3456`.
+
 A short guide can be obtained using
 
 ```sh
@@ -47,18 +39,3 @@ Note that the following filenames are reserved:
 - `__font`
 - `__img`
 - verify
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## Troublesome Parts
-
-1. Launch an Ubuntu instance
-1. Install ruby through rvm
-1. Install build-essentials
-1. Install libxslt-dev libxml2-dev

data/lib/aladdin.rb

@@ -1,35 +1,34 @@
 # ~*~ encoding: utf-8 ~*~
-require 'json'
-require 'active_support/core_ext/hash'
-require 'active_support/core_ext/string'
-
 require 'aladdin/constants'
 require 'aladdin/config'
 require 'aladdin/support'
-require 'aladdin/render'
 
-# Aladdin is a gem that lesson authors can use to preview and test their
-# lessons locally.
 module Aladdin
-  class << self
+  extend self
 
-    include Support::Logger
-    attr_accessor :config
+  # @!attribute [r] config
+  #   @return [Hash] configuration hash
+  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] || Dir.pwd
-      @config = Config.new root
-      require 'aladdin/app'
-      Aladdin::App.set :root, root
-      Aladdin::App.set :views, Aladdin::VIEWS.merge(markdown: root)
-      Aladdin::App.run!
-    rescue => e
-      logger.error e.message
-    end
+  # Prepares to launch the previewer app by configuring sinatra.
+  # @option opts [String] from (Dir.pwd)   path to author's markdown documents
+  # @return [void]
+  def prepare(opts = {})
+    root = opts[:from] || Dir.pwd
+    @config = Config.new root
+    require 'aladdin/app'
+    Aladdin::App.set :root, root
+    Aladdin::App.set :views, Aladdin::VIEWS.merge(markdown: root)
+  end
 
+  # Launches the previewer app.
+  # @return [void]
+  def launch(opts = {})
+    prepare opts
+    Aladdin::App.run!
+  rescue => e
+    puts e.message
   end
+
 end
 

data/lib/aladdin/app.rb

@@ -1,24 +1,17 @@
 # ~*~ encoding: utf-8 ~*~
 require 'sinatra'
+require 'spirit'
+require 'spirit/tilt/template'
 require 'aladdin/submission'
 
 module Aladdin
 
-  # Sinatra app that serves the tutorial. Should be able to use this in a
+  # Sinatra app that serves the lesson preview. Should be able to use this in a
   # config.ru file or as middleware. Authors should launch the app using the
   # +bin/aladdin+ executable.
   class App < Sinatra::Base
     extend Support::OneOfPattern
 
-    # Default page
-    INDEX = :index
-
-    # Default markdown options.
-    MARKDOWN_OPTIONS = {
-      renderer:           Aladdin::Render::HTML,
-      layout_engine:      :haml,
-    }.merge MARKDOWN_EXTENSIONS
-
     class << self
       private
 
@@ -38,7 +31,6 @@ module Aladdin
       # Configures path to static assets in the public folder.
       # @return [void]
       def configure_assets
-        puts Aladdin::PATHS.public
         set :public_folder, Aladdin::PATHS.public
         set :static_paths, Proc.new { Aladdin.config[:static_paths] }
       end
@@ -46,17 +38,16 @@ module Aladdin
       # 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, format: :html5
+        Tilt.register Spirit::Tilt::Template, *%w(markdown mkd md)
+        set :markdown, layout: :layout, layout_engine: :haml
+        set :haml,     escape_html: true, format: :html5
       end
 
     end
 
     # Calls the given +block+ and invokes +pass+ on error.
-    # @param block        block to call within wrapper
     def render_or_pass(&block)
-      begin return block.call
+      begin yield
       rescue Exception => e
         logger.error e.message
         pass
@@ -74,16 +65,14 @@ module Aladdin
 
     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)
-      end
+      path = path.empty? ? :index : path.to_sym
+      render_or_pass { markdown(path, locals: Aladdin.config) }
     end
 
     post '/verify/:type/:id' do
       input = request.body.read
       content_type :json
-      Submission.new(params[:id], params[:type], params, input).verify
+      Submission.new(params[:id], params[:type], params, input, logger).verify
     end
 
   end

data/lib/aladdin/commands/new.rb

@@ -1,7 +1,7 @@
 # ~*~ encoding: utf-8 ~*~
 require 'aladdin'
 require 'optparse'
-require 'aladdin/constants'
+require 'spirit/constants'
 
 module Aladdin
 
@@ -12,7 +12,7 @@ module Aladdin
     module New
 
       # Array of skeleton files to be copied over.
-      FILES     = %w(index.md images) << Aladdin::Config::FILE
+      FILES     = ['images', Spirit::MANIFEST, Spirit::INDEX]
 
       # Array of dot files to be copied over and renamed.
       DOT_FILES = %w(gitignore)

data/lib/aladdin/config.rb

@@ -1,21 +1,18 @@
-# ~*~ encoding: utf-8 ~*~
+  # ~*~ encoding: utf-8 ~*~
 require 'active_support/core_ext/hash'
-require 'json'
-require 'aladdin/constants'
+require 'active_support/core_ext/string'
+require 'spirit'
 
 module Aladdin
 
   # Raised when there is a configuration error.
   class ConfigError < StandardError; end
 
-  # Configuration options for Aladdin. Gets all of its values from {FILE}.
-  # Values in this file should not be trusted because they are given by the
-  # user.
+  # Configuration options for Aladdin. Gets all of its values from
+  # {::Spirit::MANIFEST}. Values in this file should not be trusted
+  # because they are given by the user.
   class Config < Hash
 
-    # Name of configuration file.
-    FILE = 'manifest.json'
-
     # Default configuration options.
     DEFAULTS = {
       verify: {
@@ -33,14 +30,12 @@ module Aladdin
     # {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
-      ensure_readable
       super nil
-      newsets = ::JSON.parse File.read @path
-      merge! DEFAULTS.deep_merge newsets.symbolize_keys
-      ensure_valid
-    rescue ::JSON::JSONError => e
-      raise ConfigError.new e.message
+      @path = File.join root, Spirit::MANIFEST
+      ensure_readable
+      merge! DEFAULTS.deep_merge Spirit::Manifest.load_file @path
+    rescue Spirit::Error => e
+      not_parseable e
     end
 
     private
@@ -52,34 +47,25 @@ module Aladdin
       not_readable unless File.readable? @path
     end
 
-    # Raises {ConfigError} unless the all of the values in the supplied
-    # configuration have the same type as those in {DEFAULTS}.
-    def ensure_valid(defaults=DEFAULTS, supplied=self)
-      supplied.each do |key, value|
-        bad_type(key, defaults[key], value) unless value.is_a? defaults[key].class
-        ensure_valid(defaults[key], value) if Hash === value
-      end
-    end
-
     def missing
-      raise ConfigError.new <<-eos.squish
+      raise ConfigError, <<-eos.squish
         We expected a manifest file at #{@path}, but couldn't find it. Please
-        ensure that you have a file named #{Aladdin::Config::File} at the root
+        ensure that you have a file named #{Spirit::MANIFEST} at the root
         of your lesson directory.
       eos
     end
 
     def not_readable
-      raise ConfigError.new <<-eos.squish
+      raise ConfigError, <<-eos.squish
         We found a manifest file at #{@path}, but couldn't open it for reading.
         Please ensure that you have the permissions to read the file.
       eos
     end
 
-    def bad_type(key, expected, actual)
-      raise ConfigError.new <<-eos.squish
-        The #{key} option in the manifest file should be a #{expected.class.name}
-        instead of a #{actual.class.name}.
+    def not_parseable(e)
+      raise ConfigError, <<-eos.strip_heredoc
+      We found a manifest file at #{@path}, but couldn't parse it. The following error message was returned from the parser:
+          #{e.message}
       eos
     end
 

data/lib/aladdin/constants.rb

@@ -15,25 +15,7 @@ module Aladdin
   # 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)
   }
 
-  require 'tmpdir'
-  # @todo TODO allow configuration?
-  DATA_DIR = Dir.tmpdir
-
-  # File extension for solution files.
-  SOLUTION_EXT = '.sol'
-
-  # Markdown extensions for Redcarpet
-  MARKDOWN_EXTENSIONS = {
-    no_intra_emphasis:  true,
-    tables:             true,
-    fenced_code_blocks: true,
-    autolink:           true,
-    strikethrough:      true,
-    tables:             true,
-  }
-
 end

data/lib/aladdin/submission.rb

@@ -10,7 +10,6 @@ module Aladdin
   # it's unsuitable for production use. It does not impose any security
   # restrictions at all.
   class Submission
-    include Support::Logger
     include Support::WeakComparator
 
     SCRATCHSPACE = '.__ss'
@@ -20,8 +19,8 @@ module Aladdin
     # @param [Type]   type    problem 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
+    def initialize(id, type, params, input, logger)
+      @id, @type, @params, @input, @logger = id, type, params, input, logger
     end
 
     # Verifies the student's submission.
@@ -34,12 +33,14 @@ module Aladdin
 
     private
 
+    attr_reader :logger
+
     # 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_problem
       id = @id.gsub File::SEPARATOR, '' # protect against directory attacks
-      solution = File.expand_path id + Aladdin::SOLUTION_EXT, Aladdin::DATA_DIR
+      solution = File.expand_path id + Spirit::SOLUTION_EXT, Spirit::SOLUTION_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

@@ -1,6 +1,5 @@
 # ~*~ encoding: utf-8 ~*~
 require 'aladdin/support/core_ext'
-require 'aladdin/support/logger'
 require 'aladdin/support/weak_comparator'
 require 'aladdin/support/multiroute'
 

data/lib/aladdin/support/weak_comparator.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 # ~*~ encoding: utf-8 ~*~
 module Aladdin
 

data/lib/aladdin/version.rb

@@ -1,4 +1,3 @@
 module Aladdin
-  # Version number.
-  VERSION = "0.0.8"
+  VERSION = '0.1.0.pre'
 end

data/skeleton/manifest.yml

@@ -0,0 +1,9 @@
+---
+title: A Genie Lesson
+description: Hello World! Welcome to your first lesson.
+categories:
+  - ruby
+  - programming
+  - software
+static_paths:
+  - images

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: aladdin
 version: !ruby/object:Gem::Version
-  version: 0.0.8
-  prerelease: 
+  version: 0.1.0.pre
+  prerelease: 6
 platform: ruby
 authors:
 - Jiunn Haur Lim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 00:00:00.000000000 Z
+date: 2013-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -28,77 +28,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: haml
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: albino
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: htmlentities
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 4.3.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 4.3.1
-- !ruby/object:Gem::Dependency
-  name: sanitize
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: 3.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,15 +42,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: 3.2.9
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: spirit
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.9
+        version: 0.1.0.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.9
+        version: 0.1.0.pre
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -203,7 +139,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.2
-description: A simple tutorial generator for markdown documents.
+description: Parses the lesson files and launches a preview site.
 email:
 - codex.is.poetry@gmail.com
 executables:
@@ -220,50 +156,21 @@ files:
 - lib/aladdin/commands.rb
 - lib/aladdin/config.rb
 - lib/aladdin/constants.rb
-- lib/aladdin/render/error.rb
-- lib/aladdin/render/html.rb
-- lib/aladdin/render/sanitize.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/multiroute.rb
 - lib/aladdin/support/weak_comparator.rb
 - lib/aladdin/support.rb
 - lib/aladdin/version.rb
 - lib/aladdin.rb
-- views/haml/exe.haml
-- views/haml/header.haml
-- views/haml/img.haml
 - views/haml/layout.haml
-- views/haml/multi.haml
-- views/haml/nav.haml
-- views/haml/short.haml
-- views/haml/table.haml
-- views/scss/_forms.scss
-- views/scss/_github.scss
-- views/scss/_mathjax.scss
-- 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
+- skeleton/manifest.yml
+homepage: https://github.com/jimjh/genie-previewer
 licenses:
 - MIT
 post_install_message: ! "\e[0;34;49m» Use `easy_install Pygments` to install the python
@@ -280,18 +187,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -57149837415841268
+      version: 1.3.1
 requirements:
 - pygments, python's syntax highlighter
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A simple tutorial generator for markdown documents.
+summary: A previewer for lessons written in the Genie Markup Language
 test_files: []
 has_rdoc: