simple_faq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8583a32c2dc20e46fe8fb78d56160a45e3fc55a7
+  data.tar.gz: 3825cd3d87edeb51318b412994a469812e700a2c
+SHA512:
+  metadata.gz: edce073f178e945935797e58c09444ab9252cf0a6cb6f8aae3eb3bf4f91be3d6f317acc8c41b7eceaa1c29f3cfdd7b2b98ed78c39e46e631b3f93e5dc703b1a2
+  data.tar.gz: 8b393d84f1a188de6bd163547fa71f493b0e76ba26ea68d0e65e9a8dfe62525958d481340473cc3d84d32dd2cfe6b710067726f273ade1cb6ad7f6156de10815

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Andrei Andreev
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,122 @@
+# SimpleFAQ
+
+FAQ documents often contain multiple sections with groups of questions and answers, which may get hard to maintain in HTML format.
+
+SimpleFAQ makes it easy to create interactive FAQ documents using Markdown and a few special tags.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_faq'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_faq
+
+
+### CSS and JS Assets
+
+If you are using this as a Rails gem, require the gem assets:
+
+~~~
+// app/assets/javascripts/application.js:
+//= require simple_faq
+
+// app/assets/stylesheets/application.css:
+*= require simple_faq
+~~~
+
+If you are not using rails, copy the assets files manually.
+
+## Usage
+
+~~~ruby
+html_for_display = SimpleFAQ::Formatter.new(markdown_with_faq_tags).html
+~~~
+
+### FAQ Tags:
+
+Question and answer tag pairs work together:
+
+    {q}Question title{/q}   <= will display the title as a link
+    {a}Answer content{/a}   <= clicking the title (above) of this question
+                               will expand/collapse its answer
+
+and may be displayed in sections:
+
+    {section-list}     <= will display a list of section titles,
+                          each linking to the corresponding section
+                          down the page
+
+    {section-title}Section 1{/section-title}
+    {q}Question title{/q}
+    {a}Answer content, in Markdown{/a}
+
+    {section-title}Section 2{/section-title}
+    {q}Question title{/q}
+    {a}Answer content{/a}
+
+### Example:
+
+In a Rails view:
+
+    <%
+
+    faq_content = %Q{
+    #Intro Headline
+
+    {section-list}
+
+    {section-title}Section 1{/section-title}
+
+    {q}How do I create a new paragraph in HTML?{/q}
+    {a}
+    Use the `p` tag:
+
+    ~~~
+    <p>Paragraph</p>
+    ~~~
+    {/a}
+
+    {q}Can you help me feel better?{/q}
+    {a}Take a short walk, that almost always helps. If you are thirsty or hungry, have some water or food. If you're tired, rest for a bit.
+
+    ### Or, watch some kittens.
+
+    {vimeo:11663853}
+    {/a}
+
+    {section-title}Section 2{/section-title}
+
+    {q}Section 2 Q1{/q}
+    {a}Section 2 A1{/a}
+
+    {q}I would like some more kittens, this time with close-ups!{/q}
+    {a}
+    Here you go:
+
+    {vimeo:23607676}
+    {/a}
+    }
+
+    formatted_faq_content = SimpleFAQ::Formatter.new(faq_content).html
+    %>
+
+    <%= formatted_faq_content.html_safe %>
+
+ In a real application, you may want to have the faq content in a database and prepare the formatted_faq_content in the model.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/faq_format/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/app/assets/javascripts/simple_faq.js

@@ -0,0 +1,11 @@
+$(document).ready(function(){
+
+  // toggle answer
+  $('[data-qa]').click(function(el){
+    var questionID = $(this).data('qa');
+    // uncomment to hide all other answers when showing the selected one
+    // $('.faq--answer').not('.answer-' + questionID).addClass('hidden');
+    $('.answer-' + questionID).toggle();
+  })
+
+})

data/app/assets/stylesheets/simple_faq.scss

@@ -0,0 +1,128 @@
+// FAQFormatter Styles
+
+.faq--section-title {
+  text-transform: uppercase;
+  font-size: 1em;
+  border: 1px solid #3c6;
+  display: inline-block;
+  padding: 0.3em 0.7em;
+  border-radius: 3px;
+  background-color: #f6fff6;
+  color: #062;
+  font-weight: bold;
+}
+
+
+.faq--question {
+  font-size: 1.1em;
+  color: #c60;
+  cursor: pointer;
+  // margin: .4em 0;
+  margin: 0 0 0 1.8em;
+  padding: 4px 0;
+
+  & span.with-video {
+    &:before {
+      content: "video";
+      text-transform: uppercase;
+      font-size: 10px;
+      background-color: #fff;
+      color: #c60;
+      padding: 2px 4px;
+      font-weight: normal;
+      margin-left: 1em;
+      border: 1px solid #c60;
+      border-radius: 3px;
+    }
+
+  }
+
+  &:hover {
+    color: #b50;
+    background-color: lighten(#b50,60%)
+  }
+
+  &:before {
+    content: "Q: ";
+    font-size: 1.1em;
+    margin-left: -25px;
+    margin-top: -3px;
+  }
+}
+
+.faq--answer {
+  padding: 0 0 0 .3em;
+  margin: 0 0 0 1.8em;
+
+  &.hidden { display:none; }
+
+  & > p {
+    margin: 0 0 .7em 0;
+    font-size: 1.1em;
+    line-height: 1.35;
+  }
+
+
+  &:before {
+    content: "A:";
+
+    font-size: 1.15em;
+    margin-left: -25px;
+    font-weight: bold;
+    position: absolute;
+  }
+
+}
+
+.faq--section--title-link {
+  font-size: 1.3em;
+  font-weight: normal;
+  line-height: 1.4;
+  > a:hover {
+    color: #333;
+    background-color: #fff;
+  }
+  & > a {
+    color: #666;
+    text-decoration: none;
+  }
+}
+
+.faq--section--title-link:last-child {
+    margin-bottom: 2em;
+  }
+
+.faq--section--title-anchor {
+  color: #666;
+  font-size: 1.7em;
+  font-weight: normal;
+  margin-top: 1em;
+  margin-bottom: 0.3em;
+}
+
+
+.faq {
+
+  font-family: arial, helvetica, sans-serif;
+  font-size: 1rem;
+  color: #433;
+
+
+  code, pre {
+    background-color: #eee;
+    padding: 0px 4px;
+    outline: 1px solid #ddd;
+    font-size: .95em;
+
+    & > code {
+      outline: none;
+    }
+  }
+
+  ol, li {
+    & > p {
+          margin: 0;
+        }
+
+      }
+}

data/lib/simple_faq.rb

@@ -0,0 +1,119 @@
+require "simple_faq/version"
+require 'simple_faq/engine' if defined?(Rails)
+require "redcarpet"
+
+module SimpleFAQ
+
+      class Formatter
+
+        REGEXES = {
+          section_title: /(\{section-title\}([\s|\S|\n|\r]*?)\{\/section-title\})/i,
+          intro: /\A([\s|\S]*?){/i,
+          qa: /(\{q\}([\s\S]*?)\{\/q\}[\r\n|\n|\s]*?\{a\}([\s\S]*?)\{\/a\})/i,
+          vimeo: /(\{\s*?vimeo\s*?:\s*?([0-9]*?)\s*?\})/i,
+          has_video: /({[\s]*?vimeo\s*?:\s*?\d{5,10}\s*?})/i
+        }
+
+        MARKDOWN = Redcarpet::Markdown.new(Redcarpet::Render::HTML,
+                    no_intra_emphasis: true, tables: true,
+                    fenced_code_blocks: true, autolink: true,
+                    strikethrough: true, highlight: true, quote: true)
+
+        FORMATTING = {
+          q: "<h3 class=\"faq--question\" data-qa=\"{i}\">{q}</h3>",
+          q_with_video: "<h3 class=\"faq--question\" data-qa=\"{i}\">{q}<span class=\"with-video\"></span></h3>",
+          a: "<div class=\"faq--answer answer-{i} hidden\">{a}</div>",
+          vimeo: '<iframe src="//player.vimeo.com/video/{stream_id}?title=0&amp;byline=0&amp;portrait=0&amp;badge=0" width="500" height="281" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>',
+          section_list: '<ul class="faq--section--list">{section-list}</ul>',
+          title_anchor: "<h2 class=\"faq--section--title-anchor\"><a name=\"section-{i}\"></a>{title}</h2>",
+          title_link: "<li class=\"faq--section--title-link\"><a href=\"#section-{i}\">{title}</a></li>",
+          body_wrap: %Q{<div class="faq">{body}</div>}
+        }
+
+        def initialize(body)
+          @body = body.strip.gsub("\r", "")
+          @section_list = ""
+          format_section_titles
+          format_qa_pairs
+          format_intro
+          format_section_list
+          @body.gsub!(/(\n){1,}/, "\n")
+        end
+
+        def html
+          FORMATTING[:body_wrap].sub("{body}", @body)
+        end
+
+      private
+
+        def format_section_list
+          @body.gsub!('{section-list}', FORMATTING[:section_list].sub("{section-list}", @section_list))
+        end
+
+        def format_section_titles
+          title_matches = @body.scan(REGEXES[:section_title])
+          title_matches.each_with_index do |title_match, i|
+            title_sub_string = title_match[0]
+            title = title_match[1]
+
+            title_anchor = FORMATTING[:title_anchor].gsub('{i}', i.to_s).gsub('{title}', title)
+            title_link = FORMATTING[:title_link].gsub('{i}', i.to_s).gsub('{title}', title)
+
+            @body.sub!(title_sub_string, title_anchor)
+            @section_list << title_link
+          end
+        end
+
+        def format_qa_pairs
+          qas = @body.scan(REGEXES[:qa])
+          qas.each_with_index do |qa_pair, qa_index|
+            qa_sub_string = qa_pair[0]
+            q = qa_pair[1]
+            a = qa_pair[2]
+            q_formatting = if a.match(REGEXES[:has_video])
+              :q_with_video
+            else
+              :q
+            end
+
+            qa_id = "q#{qa_index}"
+
+            a_with_markdown = MARKDOWN.render(a.strip)
+            a_with_vimeo = process_vimeo_tags(a_with_markdown)
+
+            q_formatted = FORMATTING[q_formatting].gsub('{q}', q.strip).gsub('{i}', qa_id)
+            a_formatted = FORMATTING[:a].gsub('{a}', a_with_vimeo).gsub('{i}', qa_id)
+
+            qa_html = q_formatted + "\n" + a_formatted
+
+            @body.sub!(qa_sub_string, qa_html)
+          end
+
+        end
+
+        def process_vimeo_tags s
+          r = s.dup
+          streams = s.scan(REGEXES[:vimeo])
+
+          streams.each do |stream|
+            stream_tag = stream[0]
+            stream_id = stream[1]
+            stream_html = FORMATTING[:vimeo].sub('{stream_id}', stream_id)
+            r.sub!(stream_tag, stream_html)
+          end
+          r
+        end
+
+        def format_intro
+          intro_tag_match = @body.scan(REGEXES[:intro]).flatten
+          return unless intro_tag_match.size > 0
+
+          intro_sub_string = intro_tag_match[0]
+          intro_body = intro_sub_string.strip
+
+          @body.sub!(intro_sub_string, MARKDOWN.render(intro_body))
+        end
+
+      end
+
+end

data/lib/simple_faq/engine.rb

@@ -0,0 +1,6 @@
+module SimpleFAQ
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/simple_faq/version.rb

@@ -0,0 +1,3 @@
+module SimpleFAQ
+    VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: simple_faq
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrei Andreev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- aaandre@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- app/assets/javascripts/simple_faq.js
+- app/assets/stylesheets/simple_faq.scss
+- lib/simple_faq.rb
+- lib/simple_faq/engine.rb
+- lib/simple_faq/version.rb
+homepage: https://github.com/andreimoment/simple_faq
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Easily create FAQ documents using Markdown and a few specilaized tags.
+test_files: []