spirit 0.2 → 0.5

data/lib/spirit/render/templates/multi.rb

@@ -6,15 +6,14 @@ module Spirit
     # Renders multiple choice questions marked up in YAML as HTML.
     # @example
     #
-    #     {
-    #       "format": "multi",
-    #       "question": "How tall is Mount Everest?",
-    #       "answer": "A",
-    #       "options": {
-    #         "A": "452 inches",
-    #         "B": "8.85 kilometers"
-    #       }
-    #     }
+    #     """
+    #     format: multi
+    #     question: How tall is Mount Everest?
+    #     answer: A
+    #     options:
+    #       A: 452 inches
+    #       B: 8.85 kilometers
+    #     """
     class Multi < Problem
 
       # Required key in YAML markup. Associated value should be a dictionary of
@@ -22,7 +21,7 @@ module Spirit
       OPTIONS = 'options'
 
       # Name of template file for rendering multiple choice questions.
-      TEMPLATE = 'multi.haml'
+      self.template = 'multi.haml'
 
       # Checks if the given yaml contains a valid MCQ.
       # @return [Boolean] true iff the yaml contains a valid MCQ.

data/lib/spirit/render/templates/navigation.rb

@@ -1,4 +1,3 @@
-# ~*~ encoding: utf-8 ~*~
 module Spirit
 
   module Render
@@ -6,8 +5,10 @@ module Spirit
     # Keeps track of document sections and renders a navigation bar.
     class Navigation < Template
 
+      delegate :size, :count, to: :@sections
+
       # HAML template for navigation bar
-      TEMPLATE = 'nav.haml'
+      self.template = 'nav.haml'
 
       # Creates a new navigation bar.
       def initialize
@@ -24,9 +25,7 @@ module Spirit
 
       # Renders the navigation bar in HTML.
       def render(locals={})
-        # FIXME disabled for now
-        ''
-        # super locals.merge(sections: @sections)
+        super locals.merge(sections: @sections)
       end
 
     end

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

@@ -1,5 +1,6 @@
-# ~*~ encoding: utf-8 ~*~
+require 'active_support/core_ext/class/attribute'
 require 'spirit/constants'
+
 module Spirit
 
   module Render
@@ -18,14 +19,15 @@ module Spirit
       # Required key in YAML markup. Value contains answers.
       ANSWER = 'answer'
 
-      # Optional key in YAML markup. Value contains problem ID.
+      # Generated ID.
       ID = 'id'
 
       # Required keys.
       KEYS = [FORMAT, QUESTION, ANSWER]
 
       # Stateless markdown renderer.
-      MARKDOWN = ::Redcarpet::Markdown.new(::Redcarpet::Render::HTML, MARKDOWN_EXTENSIONS)
+      class_attribute :markdown
+      self.markdown = ::Redcarpet::Markdown.new(::Redcarpet::Render::HTML, MARKDOWN_EXTENSIONS)
 
       class << self
 
@@ -35,8 +37,9 @@ module Spirit
         # @param  [String]  text          embedded yaml
         # @return [Problem] problem
         def parse(text)
-          yaml = YAML.load text
-          get_instance(yaml)
+          digest = OpenSSL::Digest::SHA256.digest text
+          yaml   = YAML.load text
+          get_instance(yaml, digest)
         rescue ::Psych::SyntaxError => e
           raise RenderError, e.message
         end
@@ -49,49 +52,42 @@ module Spirit
         end
 
         # @return [Problem] problem
-        def get_instance(yaml)
-          raise RenderError, "Missing 'format' key in given YAML" unless instantiable? yaml
-          klass = Spirit::Render.const_get(yaml[FORMAT].capitalize)
+        def get_instance(hash, digest)
+          raise RenderError, "Missing 'format' key in given YAML" unless instantiable? hash
+          klass = Spirit::Render.const_get(hash[FORMAT].capitalize)
           raise NameError unless klass < Problem
-          klass.new(yaml)
+          klass.new(hash, digest)
         rescue NameError
-          raise RenderError, 'Unrecognized format: %p' % yaml[FORMAT]
+          raise RenderError, 'Unrecognized format: %p' % hash[FORMAT]
         end
 
         private
 
-        def instantiable?(yaml)
-          yaml.is_a?(Hash) and yaml.has_key?(FORMAT)
+        def instantiable?(hash)
+          hash.is_a?(Hash) and hash.has_key?(FORMAT)
         end
 
       end
 
-      accessor ID, *KEYS
+      accessor *KEYS
+      attr_accessor :nesting, :id
+      attr_reader   :digest
 
       # Creates a new problem from the given YAML.
       # @param [Hash] yaml          parsed yaml object
-      def initialize(yaml)
-        @yaml = yaml
-        @yaml[ID] ||= SecureRandom.uuid
+      # @param [String] digest      SHA-256 hash of yaml text
+      # @param [Fixnum] id          integer ID of question
+      def initialize(yaml, digest)
+        @yaml, @digest, @nesting, @id = yaml, digest, [], 0
         raise RenderError.new('Invalid problem.') unless @yaml[QUESTION].is_a? String
-        @yaml[QUESTION] = MARKDOWN.render @yaml[QUESTION]
+        @yaml[QUESTION] = markdown.render @yaml[QUESTION]
       end
 
       # @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={})
         raise RenderError.new('Invalid problem.') unless valid?
-        yaml = @yaml.merge(locals)
-        super yaml
-      end
-
-      # 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!(name)
-        raise RenderError.new('Invalid problem.') unless valid?
-        solution = File.join(Spirit::SOLUTION_DIR, id + Spirit::SOLUTION_EXT)
-        File.open(solution, 'wb+') { |file| Marshal.dump answer, file }
+        super @yaml.merge(locals)
       end
 
       # Retrieves the answer from the given YAML object in a serializable form.

data/lib/spirit/render/templates/short.rb

@@ -13,13 +13,12 @@ module Spirit
     class Short < Problem
 
       # Name of template file for rendering short answer questions.
-      TEMPLATE = 'short.haml'
+      self.template = 'short.haml'
 
       # Checks if the given yaml contains a valid MCQ.
       # @return [Boolean] true iff the yaml contains a valid MCQ.
       def valid?
-        super and
-          not @yaml[ANSWER].nil?
+        super and not @yaml[ANSWER].nil?
       end
 
     end

data/lib/spirit/render/templates/table.rb

@@ -23,7 +23,7 @@ module Spirit
     class Table < Problem
 
       # Name of template file for rendering table problems.
-      TEMPLATE = 'table.haml'
+      self.template = 'table.haml'
 
       # Optional headings key.
       HEADINGS = 'headings'
@@ -37,7 +37,7 @@ module Spirit
       accessor HEADINGS, GRID
 
       # Ensures that the +headings+ key exists.
-      def initialize(yaml)
+      def initialize(yaml, digest)
         yaml[HEADINGS] ||= nil
         super
       end

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

@@ -1,28 +1,32 @@
-# ~*~ encoding: utf-8 ~*~
+require 'active_support/core_ext/class/attribute'
+require 'spirit/constants'
 module Spirit
 
   module Render
 
-    # Base class for all templates. Child classes should provide a +TEMPLATE+
-    # string constant that contains the path to the relevant HAML file.
+    # Base class for all templates. Class classes should override the
+    # +template+ class attribute.
     class Template
 
+      class_attribute :template
+
       # Renders the given problem using {#view}.
       # @param [Hash] locals         local variables to pass to the template
       def render(locals={})
-        view.render Object.new, locals
+        view.render self, locals
       end
 
       private
 
       # Retrieves the +view+ singleton. If it is nil, initializes it from
-      # +self.class.TEMPLATE+. Note that this is reloaded with every refresh so
-      # I can edit the templates without refreshing.
+      # +self.template+. Note that this is reloaded with every refresh so I can
+      # edit the templates without restarting.
+      # @todo TODO optimize by reusing the HAML engine
       # @return [Haml::Engine] haml engine
       def view
         return @view unless @view.nil?
-        file = File.join Spirit::VIEWS, self.class::TEMPLATE
-        @view = Haml::Engine.new(File.read file, escape_html: true, format: :html5)
+        file = File.join VIEWS, self.template
+        @view = Haml::Engine.new File.read(file), HAML_CONFIG
       end
 
     end

data/lib/spirit/version.rb

@@ -1,4 +1,3 @@
-# ~*~ encoding: utf-8 ~*~
 module Spirit
-  VERSION = '0.2'
+  VERSION = '0.5'
 end

data/views/header.haml

@@ -2,4 +2,4 @@
 -haml_tag ('h%d' % level).to_sym do
   %a.anchor{name: name, href: '#' + name, 'data-magellan-destination' => name}
     %i.foundicon-paper-clip
-  = text
+  != text

data/views/img.haml

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

data/views/layout.haml

@@ -0,0 +1,27 @@
+-# coding: UTF-8
+!= navigation.render
+.row
+  .large-6.columns
+    != preserve content
+  .large-6.columns
+    .lesson-problems.panel
+      .row
+        .large-6.large-centered.columns
+          .jqpagination
+            %a.first{href: '#', 'data-action' => 'first'} «
+            %a.previous{href: '#', 'data-action' => 'previous'} ‹
+            %input{type: 'text', readonly: 'readonly', 'data-max-page' => problems.count}
+            %a.next{href: '#', 'data-action' => 'next'} ›
+            %a.last{href: '#', 'data-action' => 'last'} »
+      - problems.each_with_index do |problem, i|
+        %div.problem-wrapper{class: i != 0 ? 'hide' : ''}
+          %form.custom.problem{action: '/answers', 'accept-charset' => 'UTF-8', id: "problem_#{problem.id}", method: 'post'}
+            %input{type: 'hidden', name: 'position', value: problem.id}
+            %fieldset
+              %legend Problem #{problem.id + 1}
+              - if problem.nesting.any?
+                %ul.breadcrumbs
+                  - problem.nesting.each do |header|
+                    %li
+                      %a{href: '#' + header.name}!= header.text
+              != problem.render

data/views/multi.haml

@@ -1,16 +1,12 @@
 -# coding: UTF-8
-%form.problem{action: 'verify/problem/' + id, 'accept-charset' => 'UTF-8', id: "problem_#{id}", method: 'post'}
-  %fieldset
-
-    %legend Problem #{index}
-    %p= question
-
-    .row.collapse
-      .large-10.small-3.columns
-        -options.each do |value, label|
-          %label{for: 'answer'}
-            %input{name: 'answer', type: 'radio', value: value}
-              = label
-      .large-2.small-1.columns
-        %a.button.submit.small.expand.postfix.radius{href: '#'} Submit
+!= question
+.row.collapse
+  .large-10.columns
+    -options.each do |value, label|
+      %label{for: 'answer'}
+        %input.hide{name: 'answer', type: 'radio', value: value}
+        %span.custom.radio
+        != label
+  .large-2.columns
+    %input.small.button.expand.radius{type: 'submit', value: 'Submit'}
 

data/views/nav.haml

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

data/views/short.haml

@@ -1,12 +1,7 @@
 -# coding: UTF-8
-%form.problem{action: 'verify/problem/' + id, 'accept-charset' => 'UTF-8', id: "problem_#{id}", method: 'post'}
-  %fieldset
-
-    %legend Problem #{index}
-    %p= question
-
-    .row.collapse
-      .large-10.small-3.columns
-        %input{name: 'answer', type: 'text'}
-      .large-2.small-1.columns
-        %a.button.small.submit.expand.postfix.radius{href: '#'} Submit
+!= question
+.row.collapse
+  .large-10.columns
+    %input{name: 'answer', type: 'text'}
+  .large-2.columns
+    %input.button.postfix.radius{type: 'submit', value: 'Submit'}

data/views/table.haml

@@ -1,28 +1,22 @@
 -# coding: UTF-8
-%form.problem{action: 'verify/problem/' + id, 'accept-charset' => 'UTF-8', id: "problem_#{id}", method: 'post'}
-  %fieldset
+.row
+  .large-12.columns
+    %table
+      %thead
+        -if headings
+          %tr
+            -headings.each do |heading|
+              %th= heading
 
-    %legend Problem #{index}
-    %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 Spirit::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
+      %tbody
+        -grid.each_with_index do |row, i|
+          %tr
+            -row.each_with_index do |cell, j|
+              %td
+                - if Spirit::Render::Table.input? cell
+                  %input{name: "answer[#{i}][#{j}]", type: 'text'}
+                - else
+                  != cell
+.row
+  .large-2.small-1.columns
+    %input.small.button.radius{type: 'submit', value: 'Submit'}

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: spirit
 version: !ruby/object:Gem::Version
-  version: '0.2'
-  prerelease: 
+  version: '0.5'
 platform: ruby
 authors:
 - Jiunn Haur Lim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-16 00:00:00.000000000 Z
+date: 2013-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,39 +27,34 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: albino
+  name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,99 +83,87 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: debugger-pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.0
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.0
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '1.1'
 description: Parses Genie Markup Language
 email:
 - codex.is.poetry@gmail.com
@@ -203,7 +180,16 @@ files:
 - lib/spirit/manifest.rb
 - lib/spirit/render/errors.rb
 - lib/spirit/render/html.rb
-- lib/spirit/render/sanitize.rb
+- lib/spirit/render/processable.rb
+- lib/spirit/render/processors/base.rb
+- lib/spirit/render/processors/block_image_processor.rb
+- lib/spirit/render/processors/headers_processor.rb
+- lib/spirit/render/processors/layout_processor.rb
+- lib/spirit/render/processors/math_processor.rb
+- lib/spirit/render/processors/problems_processor.rb
+- lib/spirit/render/processors/pygments_processor.rb
+- lib/spirit/render/processors/sanitize_processor.rb
+- lib/spirit/render/processors.rb
 - lib/spirit/render/templates/header.rb
 - lib/spirit/render/templates/image.rb
 - lib/spirit/render/templates/multi.rb
@@ -217,9 +203,9 @@ files:
 - lib/spirit/tilt/template.rb
 - lib/spirit/version.rb
 - lib/spirit.rb
-- views/exe.haml
 - views/header.haml
 - views/img.haml
+- views/layout.haml
 - views/multi.haml
 - views/nav.haml
 - views/short.haml
@@ -227,33 +213,26 @@ files:
 homepage: https://github.com/jimjh/genie-parser
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 96703733558518260
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 96703733558518260
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Parses Genie Markup Language
 test_files: []
 has_rdoc: