faqml 0.1.0 → 0.1.1

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.markdown

@@ -0,0 +1,51 @@
+# FML
+
+The FAQ Markup Language. It's pretty simple. The gem is called `faqml`, so first install it.
+
+```ruby
+require 'rubygems'
+require 'faqml'
+data = File.readlines('mypage.fml').join()
+puts FML.new(data).to_html
+```
+
+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.
+
+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.
+```
+
+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>
+</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>
+</section>
+```

data/faqml.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'faqml'
+  s.version     = '0.1.1'
+  s.date        = '2012-08-10'
+  s.summary     = "FAQ Markup Language"
+  s.description = "A Simple FAQ Markup Language, based on Markdown"
+  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.files       = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+end

data/lib/faqml.rb

@@ -0,0 +1,63 @@
+# 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faqml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -32,7 +32,11 @@ email: eric@basho.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- Gemfile
+- README.markdown
+- faqml.gemspec
+- lib/faqml.rb
 homepage: http://rubygems.org/gems/faqml
 licenses: []
 post_install_message: