shortcode 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p392

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shortcode.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jamie Dyer
+
+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,50 @@
+# Shortcode
+
+A ruby gem for parsing Wordpress style shortcodes. The gem uses a PEG (Parsing Expression Grammar) parser rather than using regular expressions so its easier to understand, test and extend.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shortcode'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shortcode
+
+## Usage
+
+Example usage
+
+    parser = Shortcode::Parser.new
+    transformer = Shortcode::Transformer.new
+    transformer.apply(parser.parse("[quote]Hello World[/quote]"))
+
+Configuration
+
+    Shortcode.setup do |config|
+
+      # the template parser to use
+      config.template_parser = :haml # :erb or :haml supported, :haml is default
+
+       # location of the template files
+      config.template_path = "support/templates/haml"
+
+      # a list of block tags to support e.g. [quote]Hello World[/quote]
+      config.block_tags = [:quote, :collapsible_list, :item, :timeline_person]
+
+      # a list of self closing tags to support e.g. [gallery]
+      config.self_closing_tags = [:timeline_event, :timeline_info]
+    end
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/shortcode.rb

@@ -0,0 +1,34 @@
+require 'parslet'
+require 'haml'
+require 'erb'
+require 'facets/module/mattr'
+
+module Shortcode
+
+  # Sets the template parser to use, supports :erb and :haml, default is :haml
+  mattr_accessor :template_parser
+  @@template_parser = :haml
+
+  # Sets the template parser to use, supports :erb and :haml, default is :haml
+  mattr_accessor :template_path
+  @@template_path = "app/views/shortcode_templates"
+
+  # Set the supported block_tags
+  mattr_accessor :block_tags
+  @@block_tags = [:quote, :collapsible_list, :item, :timeline_person]
+
+  # Set the supported self_closing_tags
+  mattr_accessor :self_closing_tags
+  @@self_closing_tags = [:timeline_event, :timeline_info]
+
+  def self.setup
+    yield self
+  end
+
+end
+
+require 'shortcode/version'
+require 'shortcode/parser'
+require 'shortcode/transformer'
+require 'shortcode/tag'
+require 'shortcode/exceptions'

data/lib/shortcode/exceptions.rb

@@ -0,0 +1,9 @@
+module Shortcode
+
+  # Raised when the template file can not be found
+  class TemplateNotFound < StandardError; end
+
+  # Raised when the template renderer specified is not supported
+  class TemplateParserNotSupported < StandardError; end
+
+end

data/lib/shortcode/parser.rb

@@ -0,0 +1,39 @@
+class Shortcode::Parser < Parslet::Parser
+
+  rule(:block_tag)        { match_any_of Shortcode.block_tags }
+  rule(:self_closing_tag) { match_any_of Shortcode.self_closing_tags }
+
+  rule(:quotes) { str('"') }
+
+  rule(:space)        { str(' ').repeat(1) }
+  rule(:space?)       { space.maybe }
+  rule(:newline)      { (str("\r\n") | str("\n")) >> space? }
+  rule(:whitespace)   { (space | newline).repeat(1) }
+  rule(:whitespace?)  { whitespace.maybe }
+
+  rule(:key)    { match('[a-zA-Z0-9\-_]').repeat(1) }
+  rule(:value)  { quotes >> (quotes.absent? >> any).repeat.as(:value) >> quotes }
+
+  rule(:option)   { key.as(:key) >> str('=') >> value }
+  rule(:options)  { (str(' ') >> option).repeat(1) }
+  rule(:options?) { options.repeat(0, 1) }
+
+  rule(:open)       { str('[') >> block_tag.as(:open) >> options?.as(:options) >> str(']') >> whitespace? }
+  rule(:close)      { str('[/') >> block_tag.as(:close) >> str(']') >> whitespace?  }
+  rule(:open_close) { str('[') >> self_closing_tag.as(:open_close) >> options?.as(:options) >> str(']') >> whitespace? }
+
+  rule(:text)   { ((close | block | open_close).absent? >> any).repeat(1).as(:text) }
+  rule(:block)  { (open >> (block | text | open_close).repeat.as(:inner) >> close) }
+
+  rule(:body) { (block | text | open_close).repeat.as(:body) }
+  root(:body)
+
+  private
+
+    def match_any_of(tags)
+      tags.map{ |tag| str(tag) }.inject do |tag_chain, tag|
+        tag_chain.send :|, tag
+      end
+    end
+
+end

data/lib/shortcode/tag.rb

@@ -0,0 +1,48 @@
+class Shortcode::Tag
+
+  def initialize(name, opts=[])
+    @name = name.downcase
+    set_options opts
+  end
+
+  def set_options(opts)
+    hash = {}
+    opts.each { |o| hash[o[:key].to_sym] = o[:value] }
+    @options = hash
+  end
+
+  def markup
+    template_files.each do |path|
+      return File.read(path) if File.file? path
+    end
+    raise Shortcode::TemplateNotFound, "Searched in:", template_files
+  end
+
+  def wrap(text='')
+    @text = text
+    render_template
+  end
+
+  private
+
+    def render_template
+      case Shortcode.template_parser
+      when :haml
+        Haml::Engine.new(markup, ugly: true).render(binding)
+      when :erb
+        ERB.new(markup).result(binding)
+      else
+        raise Shortcode::TemplateParserNotSupported, Shortcode.template_parser
+      end
+    end
+
+    def template_files
+      template_paths.map do |filename|
+        File.join Shortcode.template_path, filename
+      end
+    end
+
+    def template_paths
+      [ "#{@name}.html.#{Shortcode.template_parser.to_s}", "#{@name}.#{Shortcode.template_parser.to_s}" ]
+    end
+end

data/lib/shortcode/transformer.rb

@@ -0,0 +1,16 @@
+class Shortcode::Transformer < Parslet::Transform
+
+  rule(text: simple(:text)) { String(text) }
+  rule(
+    open:     simple(:name),
+    options:  subtree(:options),
+    inner:    sequence(:inner),
+    close:    simple(:name)
+  ) { Shortcode::Tag.new(name.to_s, options).wrap(inner.join) }
+  rule(
+    open_close: simple(:name),
+    options:    subtree(:options)
+  ) { Shortcode::Tag.new(name.to_s, options).wrap }
+
+  rule(body: sequence(:strings)) { strings.join }
+end

data/lib/shortcode/version.rb

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

data/shortcode.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shortcode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shortcode"
+  spec.version       = Shortcode::VERSION
+  spec.authors       = ["Jamie Dyer"]
+  spec.email         = ["jamie@kernowsoul.com"]
+  spec.description   = "Gem for parsing wordpress style shortcodes"
+  spec.summary       = "Gem for parsing wordpress style shortcodes"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "parslet", "1.5.0"
+  spec.add_dependency "haml", "4.0.0"
+  spec.add_dependency "facets", "2.9.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/parser_spec.rb

@@ -0,0 +1,235 @@
+require 'spec_helper'
+require 'parslet/rig/rspec'
+require 'pp'
+
+describe Shortcode::Parser do
+
+  let(:parser) { Shortcode::Parser.new }
+
+  let(:simple_quote)      { load_fixture :simple_quote }
+  let(:full_quote)        { load_fixture :full_quote }
+  let(:quote_with_extras) { load_fixture :quote_with_extras }
+  let(:simple_list)       { load_fixture :simple_list }
+  let(:timeline_event)    { load_fixture :timeline_event }
+  let(:timeline_info)     { load_fixture :timeline_info }
+  let(:timeline_person)   { load_fixture :timeline_person }
+  let(:complex_snippet)   { load_fixture :complex_snippet }
+
+  let(:quotes)            { [simple_quote, full_quote, quote_with_extras] }
+  let(:collapsible_lists) { [simple_list] }
+  let(:timelines)         { [timeline_event, timeline_info, timeline_person] }
+
+  it "parses quote shortcodes" do
+    quotes.each do |string|
+      parser.should parse(string)
+    end
+  end
+
+  it "parses list shortcodes" do
+    collapsible_lists.each do |string|
+      parser.should parse(string)
+    end
+  end
+
+  it "parses timeline shortcodes" do
+    timelines.each do |string|
+      parser.should parse(string)
+    end
+  end
+
+  it "parses complex nested shortcodes" do
+    parser.should parse(complex_snippet)
+  end
+
+  describe "parsed strings" do
+
+    context "simple_quote" do
+
+      let(:parsed_object) { parser.parse(simple_quote) }
+
+      it "created the expected object" do
+        parsed_object[:body].should == [{ open: "quote", options: [], inner: [{ text: "hello" }], close: "quote" }]
+      end
+
+    end
+
+    context "full_quote" do
+
+      let(:parsed_object) { parser.parse(full_quote) }
+
+      it "created the expected object" do
+        parsed_object[:body].should == [{
+          open: "quote",
+          options: [
+            { key: "author", value: "Jamie Dyer" },
+            { key: "title", value: "King of England" }
+          ],
+          inner: [{ text: "A quote" }],
+          close: "quote"
+        }]
+      end
+
+    end
+
+    context "quote_with_extras" do
+
+      let(:parsed_object) { parser.parse(quote_with_extras) }
+
+      it "created the expected object" do
+        parsed_object[:body].should == [
+          { text: "Blah blah " },
+          {
+            open: "quote",
+            options: [
+              { key: "author", value: "Jamie Dyer" }
+            ],
+            inner: [{ text: "A quote" }],
+            close: "quote"
+          },
+          { text: "<br> blah blah\n" }
+        ]
+      end
+
+    end
+
+    context "simple_list" do
+
+      let(:parsed_object) { parser.parse(simple_list) }
+
+      it "created the expected object" do
+        parsed_object[:body].should == [{
+          open: "collapsible_list",
+          options: [],
+          inner: [{
+            open: "item",
+            options: [{ key: "title", value: "Example title 1" }],
+            inner: [{ text: "Example content 1" }],
+            close: "item"
+          },
+          {
+            open: "item",
+            options: [{ key: "title", value: "Example title 2" }],
+            inner: [{ text: "Example content 2" }],
+            close: "item"
+          },
+          {
+            open: "item",
+            options: [{ key: "title", value: "Example title 3" }],
+            inner: [{ text: "Example content 3" }],
+            close: "item"
+          }],
+          close: "collapsible_list"
+        }]
+      end
+
+    end
+
+    context "timeline_event" do
+
+      let(:parsed_object) { parser.parse(timeline_event) }
+
+      it "created the expected object" do
+        parsed_object[:body].should == [{
+          open_close: "timeline_event",
+          options: [
+            { key: "date", value: "March 2013" },
+            { key: "title", value: "a title" },
+            { key: "link", value: "http://blah.com" }
+          ]
+        }]
+      end
+
+    end
+
+    context "timeline_info" do
+
+      let(:parsed_object) { parser.parse(timeline_info) }
+
+      it "created the expected object" do
+        parsed_object[:body].should == [{
+          open_close: "timeline_info",
+          options: [
+            { key: "date", value: "Feb 2013" },
+            { key: "title", value: "Something amazing" }
+          ]
+        }]
+      end
+
+    end
+
+    context "timeline_person" do
+
+      let(:parsed_object) { parser.parse(timeline_person) }
+
+      it "created the expected object" do
+        parsed_object[:body].should == [{
+          open: "timeline_person",
+          options: [
+            { key: "date", value: "Jan 2012" },
+            { key: "title", value: "A real title" },
+            { key: "image", value: "/images/person.jpg" },
+            { key: "name", value: "Sam Smith" },
+            { key: "position", value: "Presedent" },
+            { key: "link", value: "http://blah.com" }
+          ],
+          inner: [{ text: "A bit of body copy\nwith a newline\n" }],
+          close: "timeline_person"
+        }]
+      end
+
+    end
+
+    context "complex_snippet" do
+
+      let(:parsed_object) { parser.parse(complex_snippet) }
+
+      it "created the expected object" do
+        parsed_object[:body].should == [{
+          text: "<h3>A page title</h3>\n<p>Some text</p>\n"},
+          {
+            open: "collapsible_list",
+            options: [],
+            inner:     [{
+              open: "item",
+              options: [{ key: "title", value: "Example title 1" }],
+              inner: [{
+                open: "quote",
+                options: [
+                  { key: "author", value: "Jamie Dyer" },
+                  { key: "title", value: "King of England" }
+                ],
+                inner: [{ text: "A quote" }],
+                close: "quote"
+              },
+              { text: "I'm inbetween 2 quotes!\n    " },
+              {
+                open: "quote",
+                options: [
+                  { key: "author", value: "Forrest Gump" },
+                  { key: "title", value: "Idiot" }
+                ],
+                inner: [{text: "Life is like..."}],
+                close: "quote"
+              }],
+            close: "item"
+            },
+            {
+              open: "item",
+              options: [{ key: "title", value: "Example title 2" }],
+              inner: [{ text: "Example content 2" }],
+              close: "item"
+            },
+            {
+              open: "item",
+              options: [{ key: "title", value: "Example title 3" }],
+              inner: [{ text: "Example content 3" }],
+              close: "item"
+            }],
+            close: "collapsible_list"
+          },
+          { text: "<p>Some more text</p>\n" }
+        ]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'rspec'
+require 'shortcode'
+require 'support/fixtures'
+
+RSpec.configure do |config|
+  config.order = "random"
+
+  config.before(:each) do
+    Shortcode.setup do |config|
+      config.template_parser = :haml
+      config.template_path = File.join File.dirname(__FILE__), "support/templates/haml"
+    end
+  end
+end

data/spec/support/fixtures.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+
+  def load_fixture(name, type='txt')
+    File.read File.join(File.dirname(__FILE__), 'fixtures', "#{name}.#{type}")
+  end
+
+end

data/spec/support/fixtures/complex_snippet.txt

@@ -0,0 +1,13 @@
+<h3>A page title</h3>
+<p>Some text</p>
+[collapsible_list]
+  [item title="Example title 1"]
+    [quote author="Jamie Dyer" title="King of England"]A quote[/quote]
+    I'm inbetween 2 quotes!
+    [quote author="Forrest Gump" title="Idiot"]Life is like...[/quote]
+  [/item]
+  [item title="Example title 2"]Example content 2[/item]
+  [item title="Example title 3"]Example content 3[/item]
+[/collapsible_list]
+
+<p>Some more text</p>

data/spec/support/fixtures/complex_snippet_output.html

@@ -0,0 +1,33 @@
+<h3>A page title</h3>
+<p>Some text</p>
+<div class='collapsible'>
+<section>
+<h5>Example title 1</h5>
+<div><blockquote>
+<p class='quotation'>A quote</p>
+<p class='citation'>
+<span class='author'>Jamie Dyer</span>
+<span class='position'>King of England</span>
+</p>
+</blockquote>
+I'm inbetween 2 quotes!
+    <blockquote>
+<p class='quotation'>Life is like...</p>
+<p class='citation'>
+<span class='author'>Forrest Gump</span>
+<span class='position'>Idiot</span>
+</p>
+</blockquote>
+</div>
+</section>
+<section>
+<h5>Example title 2</h5>
+<div>Example content 2</div>
+</section>
+<section>
+<h5>Example title 3</h5>
+<div>Example content 3</div>
+</section>
+
+</div>
+<p>Some more text</p>

data/spec/support/fixtures/full_quote.txt

@@ -0,0 +1 @@
+[quote author="Jamie Dyer" title="King of England"]A quote[/quote]

data/spec/support/fixtures/full_quote_output.html

@@ -0,0 +1,7 @@
+<blockquote>
+<p class='quotation'>A quote</p>
+<p class='citation'>
+<span class='author'>Jamie Dyer</span>
+<span class='position'>King of England</span>
+</p>
+</blockquote>

data/spec/support/fixtures/quote_with_extras.txt

@@ -0,0 +1 @@
+Blah blah [quote author="Jamie Dyer"]A quote[/quote] <br> blah blah

data/spec/support/fixtures/quote_with_extras_output.html

@@ -0,0 +1,7 @@
+Blah blah <blockquote>
+<p class='quotation'>A quote</p>
+<p class='citation'>
+<span class='author'>Jamie Dyer</span>
+</p>
+</blockquote>
+<br> blah blah

data/spec/support/fixtures/simple_list.txt

@@ -0,0 +1,5 @@
+[collapsible_list]
+[item title="Example title 1"]Example content 1[/item]
+[item title="Example title 2"]Example content 2[/item]
+[item title="Example title 3"]Example content 3[/item]
+[/collapsible_list]

data/spec/support/fixtures/simple_list_output.html

@@ -0,0 +1,15 @@
+<div class='collapsible'>
+<section>
+<h5>Example title 1</h5>
+<div>Example content 1</div>
+</section>
+<section>
+<h5>Example title 2</h5>
+<div>Example content 2</div>
+</section>
+<section>
+<h5>Example title 3</h5>
+<div>Example content 3</div>
+</section>
+
+</div>

data/spec/support/fixtures/simple_quote.txt

@@ -0,0 +1 @@
+[quote]hello[/quote]

data/spec/support/fixtures/simple_quote_output.html

@@ -0,0 +1,3 @@
+<blockquote>
+<p class='quotation'>hello</p>
+</blockquote>

data/spec/support/fixtures/timeline_event.txt

@@ -0,0 +1 @@
+[timeline_event date="March 2013" title="a title" link="http://blah.com"]

data/spec/support/fixtures/timeline_event_output.html

@@ -0,0 +1,15 @@
+<div class='timeline'>
+<table>
+<tbody>
+<tr>
+<th scope='row'>
+March 2013
+</th>
+<td class='event'>
+<span class='description'>a title</span>
+<a class='read_more' href='http://blah.com'>Read More</a>
+</td>
+</tr>
+</tbody>
+</table>
+</div>

data/spec/support/fixtures/timeline_info.txt

@@ -0,0 +1 @@
+[timeline_info date="Feb 2013" title="Something amazing"]

data/spec/support/fixtures/timeline_info_output.html

@@ -0,0 +1,14 @@
+<div class='timeline'>
+<table>
+<tbody>
+<tr>
+<th scope='row'>
+Feb 2013
+</th>
+<td class='information'>
+<p>Something amazing</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>

data/spec/support/fixtures/timeline_person.txt

@@ -0,0 +1,4 @@
+[timeline_person date="Jan 2012" title="A real title" image="/images/person.jpg" name="Sam Smith" position="Presedent" link="http://blah.com"]
+A bit of body copy
+with a newline
+[/timeline_person]

data/spec/support/fixtures/timeline_person_output.html

@@ -0,0 +1,23 @@
+<div class='timeline'>
+<table>
+<tbody>
+<tr>
+<th scope='row'>
+Jan 2012
+</th>
+<td class='team_news'>
+<img src='/images/person.jpg'>
+<h4>A real title</h4>
+<span class='name'>Sam Smith</span>
+<span class='position'>Presedent</span>
+<a class='read_more' href='http://blah.com'>View Profile</a>
+<div class='description'>
+<p>A bit of body copy
+with a newline
+</p>
+</div>
+</td>
+</tr>
+</tbody>
+</table>
+</div>

data/spec/support/templates/erb/quote.html.erb

@@ -0,0 +1,12 @@
+<blockquote>
+<p class='quotation'><%= @text %></p>
+<% if @options[:author] || @options[:title] %>
+<p class='citation'>
+<% if @options[:author] %>
+<span class='author'><%= @options[:author] %></span>
+<% end %>
+<% if @options[:title] <% end %><span class='position'><%= @options[:title] %></span>
+<% end %>
+</p>
+<% end %>
+</blockquote>

data/spec/support/templates/haml/collapsible_list.html.haml

@@ -0,0 +1,2 @@
+.collapsible
+  = @text

data/spec/support/templates/haml/item.html.haml

@@ -0,0 +1,3 @@
+%section
+  %h5= @options[:title]
+  %div= @text

data/spec/support/templates/haml/quote.html.haml

@@ -0,0 +1,8 @@
+%blockquote
+  %p.quotation= @text
+  -if @options[:author] || @options[:title]
+    %p.citation
+      -if @options[:author]
+        %span.author= @options[:author]
+      -if @options[:title]
+        %span.position= @options[:title]

data/spec/support/templates/haml/timeline_event.html.haml

@@ -0,0 +1,10 @@
+.timeline
+  %table
+    %tbody
+      %tr
+        %th{scope: :row}
+          = @options[:date]
+        %td.event
+          %span.description= @options[:title]
+          -if @options[:link]
+            %a.read_more{href: @options[:link]} Read More

data/spec/support/templates/haml/timeline_info.html.haml

@@ -0,0 +1,8 @@
+.timeline
+  %table
+    %tbody
+      %tr
+        %th{scope: :row}
+          = @options[:date]
+        %td.information
+          %p= @options[:title]

data/spec/support/templates/haml/timeline_person.html.haml

@@ -0,0 +1,15 @@
+.timeline
+  %table
+    %tbody
+      %tr
+        %th{scope: :row}
+          = @options[:date]
+        %td.team_news
+          %img{src: @options[:image]}
+          %h4= @options[:title]
+          %span.name= @options[:name]
+          %span.position= @options[:position]
+          -if @options[:link]
+            %a.read_more{href: @options[:link]} View Profile
+          .description
+            %p= @text

data/spec/tag_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Shortcode::Tag do
+
+  context "when the template file is missing" do
+
+    let(:tag) { Shortcode::Tag.new('doesnt_exist') }
+
+    it "raises a TemplateNotFound error when the file doesn't exists" do
+      expect { tag.wrap }.to raise_error(Shortcode::TemplateNotFound)
+    end
+
+  end
+
+  context "when an unsupported template parser is specified" do
+
+    let(:tag) { Shortcode::Tag.new('quote') }
+
+    before(:each) do
+      Shortcode.setup do |config|
+        config.template_parser = :something_crazy
+      end
+    end
+
+    it "raises a TemplateNotFound error when the file doesn't exists" do
+      expect { tag.wrap }.to raise_error(Shortcode::TemplateParserNotSupported)
+    end
+
+  end
+
+end

data/spec/transformer_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+require 'parslet/rig/rspec'
+require 'pp'
+
+describe Shortcode do
+
+  let(:parser)      { Shortcode::Parser.new }
+  let(:transformer) { Shortcode::Transformer.new }
+
+  let(:simple_quote)      { load_fixture :simple_quote }
+  let(:full_quote)        { load_fixture :full_quote }
+  let(:quote_with_extras) { load_fixture :quote_with_extras }
+  let(:simple_list)       { load_fixture :simple_list }
+  let(:timeline_event)    { load_fixture :timeline_event }
+  let(:timeline_info)     { load_fixture :timeline_info }
+  let(:timeline_person)   { load_fixture :timeline_person }
+  let(:complex_snippet)   { load_fixture :complex_snippet }
+
+  let(:quotes)            { [simple_quote, full_quote, quote_with_extras] }
+  let(:collapsible_lists) { [simple_list] }
+  let(:timelines)         { [timeline_event, timeline_info, timeline_person] }
+
+  let(:simple_quote_output)      { load_fixture :simple_quote_output, :html }
+  let(:full_quote_output)        { load_fixture :full_quote_output, :html }
+  let(:quote_with_extras_output) { load_fixture :quote_with_extras_output, :html }
+  let(:simple_list_output)       { load_fixture :simple_list_output, :html }
+  let(:timeline_event_output)    { load_fixture :timeline_event_output, :html }
+  let(:timeline_info_output)     { load_fixture :timeline_info_output, :html }
+  let(:timeline_person_output)   { load_fixture :timeline_person_output, :html }
+  let(:complex_snippet_output)   { load_fixture :complex_snippet_output, :html }
+
+  context "simple_quote" do
+
+    it "converts into html" do
+      obj = parser.parse(simple_quote)
+      html = transformer.apply obj
+      html.should == simple_quote_output
+    end
+
+  end
+
+  context "full_quote" do
+
+    it "converts into html" do
+      html = transformer.apply(parser.parse(full_quote))
+      html.should == full_quote_output
+    end
+
+  end
+
+  context "quote_with_extras" do
+
+    it "converts into html" do
+      html = transformer.apply(parser.parse(quote_with_extras))
+      html.should == quote_with_extras_output
+    end
+
+  end
+
+  context "simple_list" do
+
+    it "converts into html" do
+      html = transformer.apply(parser.parse(simple_list))
+      html.should == simple_list_output
+    end
+
+  end
+
+  context "timeline_event" do
+
+    it "converts into html" do
+      html = transformer.apply(parser.parse(timeline_event))
+      html.should == timeline_event_output
+    end
+
+  end
+
+  context "timeline_info" do
+
+    it "converts into html" do
+      html = transformer.apply(parser.parse(timeline_info))
+      html.should == timeline_info_output
+    end
+
+  end
+
+  context "timeline_person" do
+
+    it "converts into html" do
+      html = transformer.apply(parser.parse(timeline_person))
+      html.should == timeline_person_output
+    end
+
+  end
+
+  context "complex_snippet" do
+
+    it "converts into html" do
+      html = transformer.apply(parser.parse(complex_snippet))
+      html.should == complex_snippet_output
+    end
+  end
+
+  context "erb templates" do
+
+    before(:each) do
+      Shortcode.setup do |config|
+        config.template_parser = :erb
+        config.template_path = File.join File.dirname(__FILE__), "support/templates/erb"
+      end
+    end
+
+    it "converts into html" do
+      html = transformer.apply(parser.parse(simple_quote))
+      html.gsub("\n",'').should == simple_quote_output.gsub("\n",'')
+    end
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: shortcode
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jamie Dyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for parsing wordpress style shortcodes
+email:
+- jamie@kernowsoul.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shortcode.rb
+- lib/shortcode/exceptions.rb
+- lib/shortcode/parser.rb
+- lib/shortcode/tag.rb
+- lib/shortcode/transformer.rb
+- lib/shortcode/version.rb
+- shortcode.gemspec
+- spec/parser_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures.rb
+- spec/support/fixtures/complex_snippet.txt
+- spec/support/fixtures/complex_snippet_output.html
+- spec/support/fixtures/full_quote.txt
+- spec/support/fixtures/full_quote_output.html
+- spec/support/fixtures/quote_with_extras.txt
+- spec/support/fixtures/quote_with_extras_output.html
+- spec/support/fixtures/simple_list.txt
+- spec/support/fixtures/simple_list_output.html
+- spec/support/fixtures/simple_quote.txt
+- spec/support/fixtures/simple_quote_output.html
+- spec/support/fixtures/timeline_event.txt
+- spec/support/fixtures/timeline_event_output.html
+- spec/support/fixtures/timeline_info.txt
+- spec/support/fixtures/timeline_info_output.html
+- spec/support/fixtures/timeline_person.txt
+- spec/support/fixtures/timeline_person_output.html
+- spec/support/templates/erb/quote.html.erb
+- spec/support/templates/haml/collapsible_list.html.haml
+- spec/support/templates/haml/item.html.haml
+- spec/support/templates/haml/quote.html.haml
+- spec/support/templates/haml/timeline_event.html.haml
+- spec/support/templates/haml/timeline_info.html.haml
+- spec/support/templates/haml/timeline_person.html.haml
+- spec/tag_spec.rb
+- spec/transformer_spec.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Gem for parsing wordpress style shortcodes
+test_files:
+- spec/parser_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures.rb
+- spec/support/fixtures/complex_snippet.txt
+- spec/support/fixtures/complex_snippet_output.html
+- spec/support/fixtures/full_quote.txt
+- spec/support/fixtures/full_quote_output.html
+- spec/support/fixtures/quote_with_extras.txt
+- spec/support/fixtures/quote_with_extras_output.html
+- spec/support/fixtures/simple_list.txt
+- spec/support/fixtures/simple_list_output.html
+- spec/support/fixtures/simple_quote.txt
+- spec/support/fixtures/simple_quote_output.html
+- spec/support/fixtures/timeline_event.txt
+- spec/support/fixtures/timeline_event_output.html
+- spec/support/fixtures/timeline_info.txt
+- spec/support/fixtures/timeline_info_output.html
+- spec/support/fixtures/timeline_person.txt
+- spec/support/fixtures/timeline_person_output.html
+- spec/support/templates/erb/quote.html.erb
+- spec/support/templates/haml/collapsible_list.html.haml
+- spec/support/templates/haml/item.html.haml
+- spec/support/templates/haml/quote.html.haml
+- spec/support/templates/haml/timeline_event.html.haml
+- spec/support/templates/haml/timeline_info.html.haml
+- spec/support/templates/haml/timeline_person.html.haml
+- spec/tag_spec.rb
+- spec/transformer_spec.rb