faqml 0.1.2 → 0.2.0

data/README.markdown

@@ -1,51 +1,46 @@
 # FML
 
-The FAQ Markup Language. It's pretty simple. The gem is called `faqml`, so first install it.
+The FAQ Markup Language. It's pretty simple. The gem is called `faqml`, so first install it. Then just access it through Tilt.
 
 ```ruby
 require 'rubygems'
 require 'faqml'
-data = File.readlines('mypage.fml').join()
-puts FML.new(data).to_html
+require 'tilt'
+puts Tilt.new('mypage.fml').render
 ```
 
-Your markup in `mypage.fml` should be valid markdown. The only difference is, that QnA blocks are started by three dashes (`---`), and questions and answers are seperated by three equals (`===`). The first line of the question block will be the QnA's title. That's all.
+Your markup in `mypage.fml` should be valid markdown. The only difference is, that QnA blocks are started by the keyword "question:", or "Q:", and answers being with "answer:" or "A:". If there is any text on the line after the question or answer keywords, it will be that section's summary (neither are required). All remaining indented text consitute the body of the question of answer.
 
 This FML
 
 ```fml
----
-What kind of Bear is Best?
-I hear there are basically two school of thought.
-===
-False. *Blackbear*.
-
----
-Do Bears eat Beats?
-===
-Of course.
+question: What kind of Bear is Best?
+  I hear there are basically two school of thought.
+answer:
+  False. *Blackbear*.
+
+Q: Do Bears eat Beats?
+A: Of course.
 ```
 
 Produces this HTML
 
 ```html
 <section class="qna">
-  <h1><a href="#">What kind of Bear is Best?</a></h1>
-  <div class="qna">
-    <div class="question">
-      <p>I hear there are basically two school of thought.</p>
-    </div>
-    <div class="answer">
-      <p>False. <em>Blackbear</em>.</p>
-    </div>
-  </div>
+  <details class="question" open>
+    <summary>What kind of Bear is Best?</summary>
+    <div>I hear there are basically two school of thought</div>
+    <details class="answer" open>
+      <div>False. *Blackbear*</div>
+    </details>
+  </details>
 </section>
 <section class="qna">
-  <h1><a href="#">Do Bears eat Beats?</a></h1>
-  <div class="qna">
-    <div class="answer">
-      <p>Of course.</p>
-    </div>
-  </div>
+  <details class="question" open>
+    <summary>Do Bears eat Beats?</summary>
+    <details class="answer" open>
+      <summary>Of course.</summary>
+    </details>
+  </details>
 </section>
 ```

data/lib/faqml.rb

@@ -4,5 +4,10 @@
 require 'temple'
 require 'fml/version'
 require 'fml/parser'
+require 'fml/wrap_filter'
+require 'fml/details_filter'
 require 'fml/engine'
 require 'fml/template'
+
+# module FAQML;end; require 'pp'; require 'temple'; %w{parser details_filter wrap_filter engine template}.each {|x| require "./lib/fml/#{x}"}
+# puts Tilt.new('test/test0.fml').render

data/lib/fml/details_filter.rb

@@ -0,0 +1,34 @@
+class FAQML::DetailsFilter < Temple::Filter
+  def initialize(options = {})
+    @options = options
+  end
+
+  def call(exp)
+    compile(exp)
+  end
+
+  def on_fml_qna(question, answer=nil)
+    answer_sexp = !answer.nil? && answer.length >= 4 ? build_fml_details('answer', answer[2], answer[3]) : nil
+    question_sexp = build_fml_details('question', question[2], question[3])
+    question_sexp.last << answer_sexp unless answer_sexp.nil?
+    [:html, :tag, 'section', [:html, :attrs, [:html, :attr, 'class', [:static, 'qna']]],
+      question_sexp
+    ]
+  end
+
+  private
+
+  def build_fml_details(class_name, summary, details)
+    sexp = [:html, :tag, 'details',
+      [:html, :attrs,
+        [:html, :attr, 'class', [:static, class_name]]],
+      [:multi]]
+    if !summary.last.first.nil? && summary.last.first != ''
+      sexp.last << [:html, :tag, 'summary', [:multi], [:static, summary.last.first]]
+    end
+    if details.length > 0
+      sexp.last << [:html, :tag, 'div', [:multi], [:multi, *details.last]]
+    end
+    sexp
+  end
+end

data/lib/fml/engine.rb

@@ -12,7 +12,8 @@ class FAQML::Engine < Temple::Engine
 
   # TODO: replace inline generation with a markdown filter
   # use FAQML::MarkdownFilter
-  # use FAQML::WrapFilter
+  use FAQML::WrapFilter
+  use FAQML::DetailsFilter
 
   html :AttributeMerger, :attr_delimiter
   html :AttributeSorter, :sort_attrs

data/lib/fml/markdown_filter.rb

@@ -0,0 +1,5 @@
+# require 'redcarpet'
+
+# renderer = Redcarpet::Render::HTML.new
+# extensions = {fenced_code_blocks: true}
+# @markdown = Redcarpet::Markdown.new(renderer, extensions)

data/lib/fml/parser.rb

@@ -1,5 +1,3 @@
-require 'redcarpet'
-
 # Transforms FML into a Temple expression
 # @api private
 class FAQML::Parser
@@ -32,11 +30,6 @@ class FAQML::Parser
 
   def initialize(options = {})
     super
-
-    renderer = Redcarpet::Render::HTML.new
-    extensions = {fenced_code_blocks: true}
-    @markdown = Redcarpet::Markdown.new(renderer, extensions)
-
     @tab = ' ' * @options[:tabsize]
   end
 
@@ -65,32 +58,18 @@ class FAQML::Parser
 
   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]]
+      @stacks << [:fml, :answer, [:fml, :summary, [asummary]], [:fml, :details, []] ]
 
     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]]
+      @stacks << [:fml, :question, [:fml, :summary, [qsummary]], [:fml, :details, []]]
 
     else
       indent = get_indent(@line)
@@ -99,16 +78,18 @@ class FAQML::Parser
         @strip_exp = %r"^\s{#{@base_indent}}"
       end
 
-      if indent >= 1
+      if @base_indent > 0 && indent >= @base_indent && !@current.nil?
         # 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
+        @stacks.last.last.last << [:static, @line.sub("\t", @tab).sub(@strip_exp, '')]
+        @stacks.last.last.last << [:newline]
+      elsif @line.strip != ''
         # done with the indented block
         @base_indent = 0
-      end
+        @current = nil
 
-      @current = :q if @line.strip != ''
+        @stacks << [:static, @line]
+        @stacks << [:newline]
+      end
     end
   end
 
@@ -142,7 +123,6 @@ class FAQML::Parser
     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])
+    raise SyntaxError.new(message, options[:file], args[:orig_line], args[:lineno], args[:column])
   end
 end

data/lib/fml/version.rb

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

data/lib/fml/wrap_filter.rb

@@ -0,0 +1,43 @@
+# organizes the FAQs into a wrapped-block layout
+class FAQML::WrapFilter < Temple::Filter
+
+  class SexpError < StandardError
+  end
+
+  def initialize(options = {})
+    @options = options
+  end
+
+  def call(exp)
+    compile(exp)
+  end
+
+  def on_multi(*exps)
+    result = [:multi]
+
+    current_block = nil
+
+    exps.each do |exp|
+      exp = compile(exp)
+
+      if exp.length > 2 && exp[0] == :fml
+        case exp[1]
+        when :question
+          current_block = [:fml, :qna, exp]
+          result << current_block
+        when :answer
+          raise SexpError, "Cannot create an answer without a question" if current_block.nil?
+          result.last << exp
+          current_block = nil
+        else
+          result << exp
+        end
+        next
+      end
+
+      result << exp
+    end
+
+    result
+  end
+end

data/test/test0.fml

@@ -0,0 +1,4 @@
+question: What kind of bear is best?
+  Well?
+answer: False
+  Blackbear

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faqml
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-17 00:00:00.000000000 Z
+date: 2012-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -70,10 +70,14 @@ files:
 - README.markdown
 - faqml.gemspec
 - lib/faqml.rb
+- lib/fml/details_filter.rb
 - lib/fml/engine.rb
+- lib/fml/markdown_filter.rb
 - lib/fml/parser.rb
 - lib/fml/template.rb
 - lib/fml/version.rb
+- lib/fml/wrap_filter.rb
+- test/test0.fml
 - test/test1.fml
 homepage: http://rubygems.org/gems/faqml
 licenses: []