faqml 0.1.1 → 0.1.2

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    faqml (0.1.2)
+      redcarpet (>= 2.1.1)
+      temple (>= 0.4.0)
+      tilt (~> 1.3.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    redcarpet (2.1.1)
+    temple (0.4.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faqml!

data/faqml.gemspec

@@ -1,15 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.dirname(__FILE__) + '/lib/fml/version'
+require 'date'
+
 Gem::Specification.new do |s|
   s.name        = 'faqml'
-  s.version     = '0.1.1'
-  s.date        = '2012-08-10'
+  s.version     = FAQML::VERSION
+  s.date        = Date.today.to_s
   s.summary     = "FAQ Markup Language"
-  s.description = "A Simple FAQ Markup Language, based on Markdown"
+  s.description = "A Simple FAQ Markup Language"
   s.authors     = ["Eric Redmond"]
   s.email       = 'eric@basho.com'
-  s.files       = ["lib/faqml.rb"]
   s.homepage    = 'http://rubygems.org/gems/faqml'
 
   s.add_dependency('redcarpet', '>= 2.1.1')
+  s.add_dependency('temple', '>= 0.4.0')
+  s.add_dependency('tilt', '~> 1.3.3')
 
   s.files       = `git ls-files`.split("\n")
   s.require_paths = ["lib"]

data/lib/faqml.rb

@@ -1,63 +1,8 @@
+# encoding: utf-8
 # FAQ Markup Language
-# require 'rubygems'
-require 'redcarpet'
 
-class FML
-  def initialize(data)
-    @data = data
-  end
-
-  def to_html(attrs={})
-    linked_question = attrs[:linked_question] || true
-
-    faqs, current = [], :t
-    faqs << {:q => "", :a => "", :t => ""}
-    @data.split(/\n/m).each do |line|
-      # start an answer block
-      if line =~ /^===\s*$/
-        raise "Cannot begin an answer without a question title" if current != :q
-        current = :a
-        next
-      end
-
-      # start a new question block
-      if line =~ /^---/
-        line = line.sub(/^#/, '').strip
-        faqs << {:q => "", :a => "", :t => ""}
-        current = :t
-        next
-      end
-
-      faqs.last[current] += line
-
-      current = :q if current == :t && line.strip != ''
-    end
-
-    renderer = Redcarpet::Render::HTML.new
-    extensions = {fenced_code_blocks: true}
-    redcarpet = Redcarpet::Markdown.new(renderer, extensions)
-
-    buffer = ""
-    for faq in faqs
-      next if faq[:t] == ''
-      buffer += "<section class=\"qna\">\n"
-      if linked_question
-        buffer += "<h1><a href=\"#\">#{faq[:t].to_s.strip}</a></h1>\n"
-      else
-        buffer += "<h1>#{faq[:t].to_s.strip}</h1>\n"
-      end
-      buffer += "<div class=\"qna\">"
-      if faq[:q].to_s != ''
-        buffer += "<div class=\"question\">"
-        buffer += redcarpet.render(faq[:q])
-        buffer += "</div>"
-      end
-      buffer += "<div class=\"answer\">"
-      buffer += redcarpet.render(faq[:a].to_s)
-      buffer += "</div>"
-      buffer += "</div>"
-      buffer += "</section>\n"
-    end
-    return buffer
-  end
-end
+require 'temple'
+require 'fml/version'
+require 'fml/parser'
+require 'fml/engine'
+require 'fml/template'

data/lib/fml/engine.rb

@@ -0,0 +1,31 @@
+class FAQML::Engine < Temple::Engine
+
+  set_default_options :pretty => false,
+                      :sort_attrs => true,
+                      :attr_wrapper => '"',
+                      :attr_delimiter => {'class' => ' '},
+                      :remove_empty_attrs => true,
+                      :generator => Temple::Generators::ArrayBuffer
+                      # :default_tag => 'div'
+
+  use FAQML::Parser, :strict
+
+  # TODO: replace inline generation with a markdown filter
+  # use FAQML::MarkdownFilter
+  # use FAQML::WrapFilter
+
+  html :AttributeMerger, :attr_delimiter
+  html :AttributeSorter, :sort_attrs
+  html :AttributeRemover, :remove_empty_attrs
+  html :Pretty, :format, :attr_wrapper, :pretty, :indent
+
+  filter :Escapable, :use_html_safe, :disable_escape
+  filter :MultiFlattener
+  # filter :StaticMerger
+  # filter :DynamicInliner
+
+  # generator :ArrayBuffer, :buffer
+
+  use(:Optimizer) { (options[:streaming] ? Temple::Filters::StaticMerger : Temple::Filters::DynamicInliner).new }
+  use(:Generator) { options[:generator].new(options) }
+end

data/lib/fml/parser.rb

@@ -0,0 +1,148 @@
+require 'redcarpet'
+
+# Transforms FML into a Temple expression
+# @api private
+class FAQML::Parser
+  include Temple::Mixins::Options
+
+  set_default_options :tabsize => 4,
+                      :encoding => 'utf-8'
+
+  class SyntaxError < StandardError
+    attr_reader :error, :file, :line, :lineno, :column
+
+    def initialize(error, file, line, lineno, column)
+      @error = error
+      @file = file || '(__TEMPLATE__)'
+      @line = line.to_s
+      @lineno = lineno
+      @column = column
+    end
+
+    def to_s
+      line = @line.strip
+      column = @column + line.size - @line.size
+      %{#{error}
+#{file}, Line #{lineno}
+  #{line}
+  #{' ' * column}^
+}
+    end
+  end
+
+  def initialize(options = {})
+    super
+
+    renderer = Redcarpet::Render::HTML.new
+    extensions = {fenced_code_blocks: true}
+    @markdown = Redcarpet::Markdown.new(renderer, extensions)
+
+    @tab = ' ' * @options[:tabsize]
+  end
+
+  # Compile string to Temple expression
+  #
+  # @param [String] str FML code
+  # @return [Array] Temple expression representing the code]]
+  def call(str)
+    # Set string encoding if option is set
+    if options[:encoding] && str.respond_to?(:encoding)
+      old_enc = str.encoding
+      str = str.dup if str.frozen?
+      str.force_encoding(options[:encoding])
+      # Fall back to old encoding if new encoding is invalid
+      str.force_encoding(old_enc) unless str.valid_encoding?
+    end
+
+    result = [:multi]
+    reset(str.split(/\r?\n/), result)
+
+    parse_line while next_line
+
+    reset
+    result
+  end
+
+  private
+
+  # TODO: the markdown rendering should be a filter... that way
+  # you could have different kinds of FML markups
+
+  # TODO: rewrite this to have a sort of wrapping filter... have this just output:
+  # [:question, [:summary, [text]], [:data, [line, line...]]]
+  # [:answer,   [:summary, [text]], [:data, [line, line...]]]
+
+  def parse_line
+    # start an answer block
+    if @line =~ /^a(nswer)?(\s*)\:\s*(.*?)$/i
+      asummary = @line.sub(/^a(nswer)?(\s*)\:(\s*)/i, '')
+      syntax_error!("Cannot begin an answer without a question") if @current != :q
+      @current = :a
+
+      @stacks.last.last << [:html, :tag, 'details', [:html, :attrs, [:html, :attr, 'class', [:static, 'answer']]], [:multi]]
+      @stacks.last.last.last.last << [:html, :tag, 'summary', [:multi], [:static, asummary]]
+      @stacks.last.last.last.last << [:html, :tag, 'div', [:multi], [:multi]]
+
+    elsif @line =~ /^q(uestion)?(\s*)\:\s*(.*?)$/i
+      qsummary = @line.sub(/^q(uestion)?(\s*)\:(\s*)/i, '')
+      @current = :q
+
+      @stacks << [:html, :tag, 'section', [:html, :attrs, [:html, :attr, 'class', [:static, 'qna']]],[:multi]]
+      @stacks.last.last << [:html, :tag, 'details', [:html, :attrs, [:html, :attr, 'class', [:static, 'question']]], [:multi]]
+      @stacks.last.last.last.last << [:html, :tag, 'summary', [:multi], [:static, qsummary]]
+      @stacks.last.last.last.last << [:html, :tag, 'div', [:multi], [:multi]]
+
+    else
+      indent = get_indent(@line)
+      if @base_indent == 0
+        @base_indent = indent
+        @strip_exp = %r"^\s{#{@base_indent}}"
+      end
+
+      if indent >= 1
+        # strip off base_indent from @line
+        @stacks.last.last.last.last.last.last << [:static, @line.sub("\t", @tab).sub(@strip_exp, '')]
+        @stacks.last.last.last.last.last.last << [:newline]
+      else
+        # done with the indented block
+        @base_indent = 0
+      end
+
+      @current = :q if @line.strip != ''
+    end
+  end
+
+  def reset(lines = nil, stacks = nil)
+    @stacks = stacks
+    @base_indent = 0
+    @lineno = 0
+    @lines = lines
+    @line = @orig_line = nil
+    @current = nil
+  end
+
+  def next_line
+    if @lines.empty?
+      @orig_line = @line = nil
+    else
+      @orig_line = @lines.shift
+      @lineno += 1
+      @line = @orig_line.dup
+    end
+  end
+
+  def get_indent(line)
+    # Figure out the indentation. ugly/slow/ ripped from Slim
+    line[/\A[ \t]*/].sub("\t", @tab).size
+  end
+
+  # Helper for raising exceptions
+  def syntax_error!(message, args = {})
+    args[:orig_line] ||= @orig_line
+    args[:line] ||= @line
+    args[:lineno] ||= @lineno
+    args[:column] ||= args[:orig_line] && args[:line] ? args[:orig_line].size - args[:line].size : 0
+    raise SyntaxError.new(message, options[:file],
+                          args[:orig_line], args[:lineno], args[:column])
+  end
+end

data/lib/fml/template.rb

@@ -0,0 +1,18 @@
+module FAQML
+  # Tilt template implementation for FAQML
+  # @api public
+  Template = Temple::Templates::Tilt(FAQML::Engine, :register_as => :fml)
+
+  if Object.const_defined?(:Rails)
+    # Rails template implementation for FAQML
+    # @api public
+    RailsTemplate = Temple::Templates::Rails(FAQML::Engine,
+                                             :register_as => :fml,
+                                             # Use rails-specific generator. This is necessary
+                                             # to support block capturing and streaming.
+                                             :generator => Temple::Generators::RailsOutputBuffer,
+                                             # Rails takes care of the capturing by itself.
+                                             :disable_capture => true,
+                                             :streaming => Object.const_defined?(:Fiber))
+  end
+end

data/lib/fml/version.rb

@@ -0,0 +1,4 @@
+module FAQML
+  # @api public
+  VERSION = '0.1.2'
+end

data/test/test1.fml

@@ -0,0 +1,14 @@
+question: What's the best bear?
+  What kind of bear is best?
+
+answer: Blackbear
+  False. *Blackbear*
+
+q: Do bears eat beats?
+
+a: Bears. Beats. _Battlestar Galactica._
+
+Q:
+  Do bears eat beats?
+A:
+  Bears. Beats. Battlestar Galactica.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faqml
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-10 00:00:00.000000000 Z
+date: 2012-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -27,16 +27,54 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.1.1
-description: A Simple FAQ Markup Language, based on Markdown
+- !ruby/object:Gem::Dependency
+  name: temple
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+description: A Simple FAQ Markup Language
 email: eric@basho.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - README.markdown
 - faqml.gemspec
 - lib/faqml.rb
+- lib/fml/engine.rb
+- lib/fml/parser.rb
+- lib/fml/template.rb
+- lib/fml/version.rb
+- test/test1.fml
 homepage: http://rubygems.org/gems/faqml
 licenses: []
 post_install_message: