spirit 0.2 → 0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4844986a578645c04c236ef9ebe931cbfaf7aab9
+  data.tar.gz: 280b2cfbb472f5670eb364e9954c3e42bd87ca5a
+SHA512:
+  metadata.gz: 616c1c9e6fbf583efbded87e74baf193637cac7c582e80044165531d2a1beab46bf90530bbdf0e9013a1351a8f0c5e208dcc6c598208c82962a4b267804a57b7
+  data.tar.gz: 867670f2f3533580428c654c466b4d4d16d5e822710e13f98b253b63a865ae7f57c41fa24875af7f5ded5771bc856c16cf14454b76bcd7ae0d5f30398877bc4d

data/lib/spirit.rb

@@ -1,4 +1,4 @@
-# ~*~ encoding: utf-8 ~*~
+require 'spirit/version'
 require 'spirit/logger'
 require 'spirit/constants'
 require 'spirit/errors'
@@ -6,17 +6,15 @@ require 'spirit/document'
 require 'spirit/manifest'
 
 module Spirit
-  extend self
 
-  attr_reader :logger
+  mattr_accessor :logger
+  @@logger = Logger.new '/dev/null'
 
-  # Initializes the logger. It takes the same arguments as +Logger::new+.
-  # Invoke this at the beginning if you wish {Spirit} to log to another
-  # location than +STDOUT+.
-  def initialize_logger(output=STDOUT, *args)
-    @logger = Logger.new output, *args
+  # Invoke with args for {Logger} to enable logging.
+  def self.reset_logger(io=STDOUT, *args)
+    self.logger = Logger.new(io, *args)
+    logger.formatter = Logger::Formatter.new
+    logger.info "Spirit v#{VERSION}"
   end
 
-  initialize_logger
-
 end

data/lib/spirit/constants.rb

@@ -1,10 +1,9 @@
-# ~*~ encoding: utf-8 ~*~
 require 'tmpdir'
 
 module Spirit
 
   # Path to templates
-  VIEWS = File.join File.dirname(__FILE__), *%w(.. .. views)
+  VIEWS = File.join(File.dirname(__FILE__), *%w(.. .. views)).freeze
 
   # Markdown extensions for Redcarpet
   MARKDOWN_EXTENSIONS = {
@@ -13,15 +12,26 @@ module Spirit
     fenced_code_blocks: true,
     autolink:           true,
     strikethrough:      true,
-  }
+  }.freeze
 
-  SOLUTION_DIR = Dir.tmpdir
-  SOLUTION_EXT = '.sol'
+  # Renderer configuration options
+  RENDERER_CONFIG = {
+    hard_wrap:          true,
+    no_styles:          true,
+  }.freeze
+
+  HAML_CONFIG = {
+    escape_html:        true,
+    format:             :html5,
+  }.freeze
+
+  SOLUTION_DIR = Dir.tmpdir.freeze
+  SOLUTION_EXT = '.sol'.freeze
 
   # Name of index page.
-  INDEX     = 'index.md'
+  INDEX     = 'index.md'.freeze
 
   # Name of manifest file.
-  MANIFEST  = 'manifest.yml'
+  MANIFEST  = 'manifest.yml'.freeze
 
 end

data/lib/spirit/document.rb

@@ -1,4 +1,4 @@
-# ~*~ encoding: utf-8 ~*~
+require 'active_support/core_ext/module/delegation'
 require 'spirit/constants'
 require 'spirit/errors'
 require 'spirit/render'
@@ -6,10 +6,10 @@ require 'spirit/render'
 module Spirit
 
   # Document written in Genie Markup Language.
-  # @todo TODO clean?
   class Document
 
-    attr_accessor :data, :engine
+    attr_reader :data, :engine, :rndr
+    delegate :solutions, to: :rndr
 
     # Creates a new document from the given source. It should contain valid
     # markdown + embedded YAML.
@@ -17,7 +17,7 @@ module Spirit
     # @param [Hash] opts         options for {::Redcarpet}
     def initialize(source, opts={})
       opts = MARKDOWN_EXTENSIONS.merge opts
-      rndr = Render::HTML.new(name: opts[:name])
+      @rndr   = Render::HTML.new
       @engine = ::Redcarpet::Markdown.new(rndr, opts)
       @data   = case
                 when source.respond_to?(:to_str) then source.to_str
@@ -25,11 +25,6 @@ module Spirit
                 else nil end
     end
 
-    # @return [Boolean] true iff if was a clean parse with no errors.
-    def clean?
-      # TODO
-    end
-
     # Rendered output is returned as a string if +anIO+ is not provided. The
     # output is sanitized with {Spirit::Render::Sanitize}, and should be
     # considered safe for embedding into a HTML page without further escaping or

data/lib/spirit/errors.rb

@@ -1,4 +1,3 @@
-# ~*~ encoding: utf-8 ~*~
 module Spirit
 
   # The base exception for all {Spirit} errors. Raised if the parser is unable

data/lib/spirit/logger.rb

@@ -1,4 +1,3 @@
-# ~*~ encoding: utf-8 ~*~
 require 'active_support/core_ext/logger'
 
 module Spirit
@@ -6,13 +5,13 @@ module Spirit
   # @see https://github.com/chriseppstein/compass/blob/stable/lib/compass/logger.rb
   class Logger < ::Logger
 
-    COLORS = { clear: 0, red: 31, green: 32, blue: 35, yellow: 33, grey: 37 }
+    COLORS = { clear: 0, red: 31, green: 32, blue: 35, yellow: 33, grey: 37 }.freeze
 
     ACTION_COLORS = {
-      :error     => :red,
-      :warning   => :yellow,
-      :problem   => :blue,
-    }
+      error:   :red,
+      warning: :yellow,
+      problem: :blue,
+    }.freeze
 
     # Record that an action has occurred.
     def record(action, *args)

data/lib/spirit/manifest.rb

@@ -1,4 +1,3 @@
-# ~*~ encoding: utf-8 ~*~
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/string'
 require 'yaml'
@@ -14,11 +13,11 @@ module Spirit
       verify: { 'bin' => 'string', 'arg_prefix' => 'string' },
       title: 'string',
       description: 'string',
-      categories: %w(string),
-      static_paths: %w(string)
-    }
+      categories: %w[string array],
+      static_paths: %w[string array]
+    }.freeze
 
-    # Creates a new configuration hash from the given source.
+    # Creates a new manifest from the given source.
     def initialize(hash)
       super nil
       hash ||= {}

data/lib/spirit/render.rb

@@ -1,5 +1,3 @@
-# ~*~ encoding: utf-8 ~*~
-require 'albino'
 require 'haml'
 require 'redcarpet'
 

data/lib/spirit/render/errors.rb

@@ -1,11 +1,7 @@
 # ~*~ encoding: utf-8 ~*~
 module Spirit
-
   module Render
-
     # The base exception for {Spirit::Render} errors.
     class RenderError < DocumentError; end
-
   end
-
 end

data/lib/spirit/render/html.rb

@@ -1,10 +1,11 @@
-# ~*~ encoding: utf-8 ~*~
+require 'active_support/core_ext/module/delegation'
+
 require 'spirit/render/errors'
-require 'spirit/render/sanitize'
 require 'spirit/render/templates'
+require 'spirit/render/processable'
+require 'spirit/render/processors'
 
 module Spirit
-
   module Render
 
     # HTML Renderer for Genie Markup Language, which is just GitHub Flavored
@@ -13,124 +14,23 @@ module Spirit
     # @see Spirit::Tilt::Template
     # @see http://github.github.com/github-flavored-markdown/
     class HTML < ::Redcarpet::Render::HTML
+      include Processable
 
-      @sanitize = Sanitize.new
-      class << self; attr_reader :sanitize end
-
-      # Paragraphs that start and end with '---' are treated as embedded YAML
-      # and are parsed for questions/answers.
-      PROBLEM_REGEX = /^"""$(.*?)^"""$/m
+      delegate :solutions, to: :problems
+      attr_accessor :navigation, :problems, :nesting
 
-      # Paragraphs that only contain images are rendered with {Spirit::Render::Image}.
-      IMAGE_REGEX = /\A\s*<img[^<>]+>\s*\z/m
-
-      # Renderer configuration options.
-      CONFIGURATION = {
-        hard_wrap:          true,
-        no_styles:          true,
-      }
+      use Processors::SanitizeProcessor
+      use Processors::MathProcessor
+      use Processors::LayoutProcessor
+      use Processors::ProblemsProcessor
+      use Processors::PygmentsProcessor
+      use Processors::BlockImageProcessor
+      use Processors::HeadersProcessor
 
       # Creates a new HTML renderer.
-      # @param [Hash] options        described in the RedCarpet documentation.
-      def initialize(options={})
-        super CONFIGURATION.merge options
-        @nav, @headers = Navigation.new, Headers.new
-        @prob, @img = 0, 0 # indices for Problem #, Figure #
-        @name = options.delete(:name) || 'untitled'
-      end
-
-      # Pygmentizes code blocks.
-      # @param [String] code        code block contents
-      # @param [String] marker      name of language, for syntax highlighting
-      # @return [String] highlighted code
-      def block_code(code, marker)
-        #language, type, id = (marker || 'text').split ':'
-        #highlighted = Albino.colorize code, language
-        language, _, _ = (marker || 'text').split ':'
-        Albino.colorize code, language
-        # TODO
-        #case type
-        #when 'demo', 'test'
-        #  executable id: id, raw: code, colored: highlighted
-        #else highlighted end
-      end
-
-      # Detects block images and renders them as such.
-      # @return [String] rendered html
-      def paragraph(text)
-        case text
-        when IMAGE_REGEX then block_image(text)
-        else p(text) end
-      rescue RenderError => e # fall back to paragraph
-        Spirit.logger.warn e.message
-        p(text)
-      end
-
-      # Increases all header levels by one and keeps a navigation bar.
-      # @return [String] rendered html
-      def header(text, level)
-        html, name = h(text, level += 1)
-        @nav.append(text, name) if level == 2
-        html
-      end
-
-      # Runs a first pass through the document to look for problem blocks.
-      # @param [String] document    markdown document
-      def preprocess(document)
-        document.gsub(PROBLEM_REGEX) { |yaml| problem $1 }
-      end
-
-      # Sanitizes the final document.
-      # @param [String]  document    html document
-      # @return [String] sanitized document
-      def postprocess(document)
-        HTML.sanitize.clean(@nav.render + document.force_encoding('utf-8'))
-      end
-
-      private
-
-      # Prepares an executable code block.
-      # @option opts [String] id        author-supplied ID
-      # @option opts [String] raw       code to execute
-      # @option opts [String] colored   syntax highlighted code
-      # @return [String]
-      #def executable(opts)
-      #  opts[:colored] + @exe.render(Object.new, id: opts[:id], raw: opts[:raw])
-      #end
-
-      # Prepares a problem form. Returns +yaml+ if the given text does not
-      # contain valid yaml markup for a problem.
-      # @param [String] yaml            YAML markup
-      # @return [String] rendered HTML
-      def problem(yaml)
-        problem = Problem.parse(yaml)
-        Spirit.logger.record :problem, "ID: #{problem.id}"
-        problem.save!(@name) and problem.render(index: @prob += 1)
-      rescue RenderError
-        yaml
-      end
-
-      # Prepares a block image. Raises {RenderError} if the given text does not
-      # contain a valid image block.
-      # @param  [String] text         markdown text
-      # @return [String] rendered HTML
-      def block_image(text)
-        Image.parse(text).render(index: @img += 1)
-      end
-
-      # Wraps the given text with header tags.
-      # @return [String] rendered HTML
-      # @return [String] anchor name
-      def h(text, level)
-        header = @headers.add(text, level)
-        return header.render, header.name
-      end
-
-      # Wraps the given text with paragraph tags.
-      # @param [String] text            paragraph text
-      # @return [String] rendered html
-      def p(text)
-        '<p>' + text + '</p>'
+      # @param  [Hash] opts        described in the RedCarpet documentation
+      def initialize(opts={})
+        super RENDERER_CONFIG.merge opts
       end
 
     end

data/lib/spirit/render/processable.rb

@@ -0,0 +1,78 @@
+require 'active_support/core_ext/class/attribute'
+require 'active_support/concern'
+
+module Spirit
+  module Render
+
+    # Provides methods to attach processors.
+    module Processable
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :processors,
+          instance_reader: false, instance_writer: false
+        self.processors = {}          # array of processor classes
+        attr_accessor :processors     # array of processor instances
+      end
+
+      module ClassMethods
+
+        # @example using a processor
+        #     include Processable
+        #     use Processor::MathProcessor
+        def use(processor)
+          processor.events.each do |event|
+            processors[event] ||= []
+            processors[event] << processor
+            define event unless method_defined? event
+          end
+        end
+
+        def define(event)
+          define_method(event) { |*args| invoke_callbacks event, *args }
+        end
+
+      end
+
+      def preprocess(document)
+        instantiate_processors document
+        invoke_callbacks :preprocess, document
+      end
+
+      def postprocess(document)
+        invoke_callbacks_in_reverse :postprocess, document
+      end
+
+      # Instantiate processors. {#processors} becomes a hash from classes to
+      # instances.
+      def instantiate_processors(document)
+        processors = self.class.processors.values.flatten.uniq
+        instances  = processors.map { |c| [ c, c.new(self, document) ] }
+        self.processors = Hash[instances]
+      end
+      private :instantiate_processors
+
+      def invoke_callbacks(event, *args)
+        processors = processors_for event
+        processors.each { |p| args = p.invoke_callbacks_for event, *args }
+        args
+      end
+      private :invoke_callbacks
+
+      def invoke_callbacks_in_reverse(event, *args)
+        processors = processors_for(event).reverse
+        processors.each { |p| args = p.invoke_callbacks_for event, *args }
+        args
+      end
+      private :invoke_callbacks_in_reverse
+
+      def processors_for(event)
+        classes = self.class.processors[event] || []
+        classes.map { |c| processors[c] }.compact
+      end
+      private :processors_for
+
+    end
+
+  end
+end

data/lib/spirit/render/processors.rb

@@ -0,0 +1,15 @@
+require 'spirit/render/processors/base'
+require 'spirit/render/processors/math_processor'
+require 'spirit/render/processors/sanitize_processor'
+require 'spirit/render/processors/layout_processor'
+require 'spirit/render/processors/problems_processor'
+require 'spirit/render/processors/pygments_processor'
+require 'spirit/render/processors/block_image_processor'
+require 'spirit/render/processors/headers_processor'
+
+module Spirit
+  module Render
+    module Processors
+    end
+  end
+end

data/lib/spirit/render/processors/base.rb

@@ -0,0 +1,40 @@
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/module/delegation'
+require 'spirit/constants'
+
+module Spirit
+  module Render
+    module Processors
+
+      class Base
+
+        class_attribute :hooks
+
+        def self.inherited(subclass)
+          subclass.hooks  = {}
+        end
+
+        def self.process(event, callback)
+          hooks[event] ||= []
+          hooks[event] << callback
+        end
+
+        def self.events
+          hooks.keys
+        end
+
+        def initialize(*args)
+        end
+
+        def invoke_callbacks_for(event, *args)
+          hooks[event].each do |h|
+            args = public_send(h, *args)
+          end
+          args
+        end
+
+      end
+
+    end
+  end
+end