virgo 0.1.3 → 0.1.4

data/vendor/gems/shortcode/Rakefile

@@ -0,0 +1,3 @@
+require "rubygems"
+require "bundler/setup"
+require "bundler/gem_tasks"

data/vendor/gems/shortcode/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "2.0.1"
+gem "rails", "~> 3.2.21"
+
+gemspec :path => "../"

data/vendor/gems/shortcode/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "2.0.1"
+gem "rails", "~> 4.0.13"
+
+gemspec :path => "../"

data/vendor/gems/shortcode/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "2.0.1"
+gem "rails", "~> 4.1.10"
+
+gemspec :path => "../"

data/vendor/gems/shortcode/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "2.0.1"
+gem "rails", "4.2.1"
+
+gemspec :path => "../"

data/vendor/gems/shortcode/lib/shortcode.rb

@@ -0,0 +1,53 @@
+$:.unshift File.expand_path('..', __FILE__)
+
+require 'parslet'
+require 'erb'
+
+begin
+  require 'haml'
+rescue LoadError; end
+
+begin
+  require 'slim'
+rescue LoadError; end
+
+module Shortcode
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.process(string, additional_attributes=nil)
+    Shortcode::Processor.new.process string, additional_attributes
+  end
+
+  def self.setup
+    yield configuration
+  end
+
+  def self.register_presenter(*presenters)
+    presenters.each do |presenter|
+      Shortcode::Presenter.register presenter
+    end
+  end
+
+  private
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+end
+
+require 'shortcode/version'
+require 'shortcode/configuration'
+require 'shortcode/parser'
+require 'shortcode/presenter'
+require 'shortcode/processor'
+require 'shortcode/template_binding'
+require 'shortcode/transformer'
+require 'shortcode/tag'
+require 'shortcode/exceptions'
+require 'shortcode/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
+
+Shortcode.setup {}

data/vendor/gems/shortcode/lib/shortcode/configuration.rb

@@ -0,0 +1,36 @@
+class Shortcode::Configuration
+  # Sets the template parser to use, supports :erb, :haml, and :slim, default is :haml
+  attr_accessor :template_parser
+
+  # Sets the path to search for template files
+  attr_accessor :template_paths
+
+  # Allows templates to be set from strings rather than read from the filesystem
+  attr_accessor :templates
+
+  # Assigns helper modules to be included in templates
+  attr_accessor :helpers
+
+  # Set the supported block_tags
+  attr_accessor :block_tags
+
+  # Set the supported self_closing_tags
+  attr_accessor :self_closing_tags
+
+  # Set the quotation sign used for attribute values. Defaults to double quote (")
+  attr_accessor :attribute_quote_type
+
+  # Allows quotes around attributes to be omitted. Defaults to false (quotes must be present around the value).
+  attr_accessor :use_attribute_quotes
+
+  def initialize
+    @template_parser      = :erb
+    @template_paths       = ["app/views/shortcode_templates"]
+    @templates            = nil
+    @helpers              = []
+    @block_tags           = []
+    @self_closing_tags    = []
+    @attribute_quote_type = '"'
+    @use_attribute_quotes = true
+  end
+end

data/vendor/gems/shortcode/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/vendor/gems/shortcode/lib/shortcode/parser.rb

@@ -0,0 +1,43 @@
+class Shortcode::Parser < Parslet::Parser
+
+  rule(:block_tag)        { match_any_of Shortcode.configuration.block_tags }
+  rule(:self_closing_tag) { match_any_of Shortcode.configuration.self_closing_tags }
+
+  rule(:quotes) { str(Shortcode.configuration.attribute_quote_type) }
+
+  rule(:space)        { str(' ').repeat(1) }
+  rule(:space?)       { space.maybe }
+  rule(:newline)      { (str("\r\n") | str("\n")) >> space? }
+  rule(:newline?)     { newline.maybe }
+  rule(:whitespace)   { (space | newline).repeat(1) }
+
+  rule(:key) { match('[a-zA-Z0-9\-_]').repeat(1) }
+
+  rule(:value_with_quotes) { quotes >> (quotes.absent? >> any).repeat.as(:value) >> quotes }
+  rule(:value_without_quotes) { quotes.absent? >> ( (str(']') | whitespace).absent? >> any ).repeat.as(:value) }
+  rule(:value) { Shortcode.configuration.use_attribute_quotes ? value_with_quotes : (value_without_quotes | value_with_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(']') >> newline? }
+  rule(:close)      { str('[/') >> block_tag.as(:close) >> str(']') >> newline? }
+  rule(:open_close) { str('[') >> self_closing_tag.as(:open_close) >> options?.as(:options) >> str(']') >> newline? }
+
+  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)
+      return str('') if tags.length < 1
+      tags.map{ |tag| str(tag) }.inject do |tag_chain, tag|
+        tag_chain.send :|, tag
+      end
+    end
+
+end

data/vendor/gems/shortcode/lib/shortcode/presenter.rb

@@ -0,0 +1,49 @@
+class Shortcode::Presenter
+
+  class << self
+    attr_writer :presenters
+
+    def presenters
+      @presenters ||= {}
+    end
+
+    def register(presenter)
+      validate presenter
+      [*presenter.for].each { |k| presenters[k.to_sym] = presenter }
+    end
+
+    def validate(presenter)
+      raise ArgumentError, "The presenter must define the class method #for" unless presenter.respond_to?(:for)
+      raise ArgumentError, "The presenter must define an initialize method" unless presenter.private_instance_methods(false).include?(:initialize)
+      %w(content attributes).each do |method|
+        raise ArgumentError, "The presenter must define the method ##{method}" unless presenter.method_defined?(method.to_sym)
+      end
+    end
+  end
+
+  def initialize(name, attributes, content, additional_attributes)
+    @attributes = attributes
+    @content = content
+    @additional_attributes = additional_attributes
+    initialize_custom_presenter(name)
+  end
+
+  def content
+    @content
+  end
+
+  def attributes
+    @attributes
+  end
+
+  private
+
+    def initialize_custom_presenter(name)
+      if Shortcode::Presenter.presenters.has_key? name.to_sym
+        presenter   = Shortcode::Presenter.presenters[name.to_sym].new(@attributes, @content, @additional_attributes)
+        @attributes = presenter.attributes
+        @content    = presenter.content
+      end
+    end
+
+end

data/vendor/gems/shortcode/lib/shortcode/processor.rb

@@ -0,0 +1,17 @@
+class Shortcode::Processor
+
+  def process(string, additional_attributes=nil)
+    transformer.apply parser.parse(string), additional_attributes: additional_attributes
+  end
+
+  private
+
+    def parser
+      @parser ||= Shortcode::Parser.new
+    end
+
+    def transformer
+      @transformer ||= Shortcode::Transformer.new
+    end
+
+end

data/vendor/gems/shortcode/lib/shortcode/railtie.rb

@@ -0,0 +1,3 @@
+class Shortcode::TemplateBinding
+  include ActionView::Helpers
+end

data/vendor/gems/shortcode/lib/shortcode/tag.rb

@@ -0,0 +1,54 @@
+class Shortcode::Tag
+
+  def initialize(name, attributes=[], content='', additional_attributes=nil)
+    @name = name.downcase
+    @binding = Shortcode::TemplateBinding.new(@name, attributes, content, additional_attributes)
+  end
+
+  def markup
+    return markup_from_config unless Shortcode.configuration.templates.nil?
+    template_files.each do |path|
+      return File.read(path) if File.file? path
+    end
+    raise Shortcode::TemplateNotFound, "Searched in:", template_files
+  end
+
+  def render
+    render_template
+  end
+
+  private
+
+    def render_template
+      case Shortcode.configuration.template_parser
+      when :erb
+        ERB.new(markup).result(@binding.get_binding)
+      when :haml
+        Haml::Engine.new(markup, ugly: true).render(@binding)
+      when :slim
+        Slim::Template.new { markup }.render(@binding)
+      else
+        raise Shortcode::TemplateParserNotSupported, Shortcode.configuration.template_parser
+      end
+    end
+
+    def markup_from_config
+      if Shortcode.configuration.templates.has_key? @name.to_sym
+        Shortcode.configuration.templates[@name.to_sym]
+      else
+        raise Shortcode::TemplateNotFound, "Shortcode.configuration.templates does not contain the key #{@name.to_sym}"
+      end
+    end
+
+    def template_files
+      expanded_template_paths.map do |filename|
+        Shortcode.configuration.template_paths.reverse.map do |path|
+          File.join path, filename
+        end
+      end.flatten
+    end
+
+    def expanded_template_paths
+      [ "#{@name}.html.#{Shortcode.configuration.template_parser.to_s}", "#{@name}.#{Shortcode.configuration.template_parser.to_s}" ]
+    end
+end

data/vendor/gems/shortcode/lib/shortcode/template_binding.rb

@@ -0,0 +1,33 @@
+class Shortcode::TemplateBinding
+
+  def initialize(name, attributes=[], content='', additional_attributes=nil)
+    include_helper_modules
+    presenter   = Shortcode::Presenter.new name, set_attributes(attributes), content, additional_attributes
+    @name       = name
+    @attributes = presenter.attributes
+    @content    = presenter.content
+  end
+
+  # Expose private binding() method for use with erb templates
+  def get_binding
+    binding
+  end
+
+  private
+
+    def set_attributes(attributes)
+      hash = {}
+      attributes.each { |o| hash[o[:key].to_sym] = o[:value] }
+      hash
+    end
+
+    def include_helper_modules
+      return unless Shortcode.configuration.helpers.any?
+      class << self
+        Shortcode.configuration.helpers.each do |helper|
+          include helper
+        end
+      end
+    end
+
+end

data/vendor/gems/shortcode/lib/shortcode/transformer.rb

@@ -0,0 +1,17 @@
+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, inner.join, additional_attributes).render }
+  rule(
+    open_close: simple(:name),
+    options:    subtree(:options)
+  ) { Shortcode::Tag.new(name.to_s, options, '', additional_attributes).render }
+
+  rule(body: sequence(:strings)) { strings.join }
+
+end

data/vendor/gems/shortcode/lib/shortcode/version.rb

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

data/vendor/gems/shortcode/shortcode.gemspec

@@ -0,0 +1,30 @@
+# 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 in ruby projects"
+  spec.homepage      = "https://github.com/kernow/shortcode"
+  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.7.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "coveralls", "~> 0"
+  spec.add_development_dependency "slim", "~> 3.0"
+  spec.add_development_dependency "haml", "~> 4.0"
+  spec.add_development_dependency "rails"
+end

data/vendor/gems/shortcode/spec/parser_spec.rb

@@ -0,0 +1,267 @@
+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(:without_quotes)    { load_fixture :without_quotes }
+  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|
+      expect(parser).to parse(string)
+    end
+  end
+
+  context "attribute_quote_type configuration" do
+
+    before do
+      Shortcode.setup do |config|
+        config.attribute_quote_type = "'"
+      end
+    end
+
+    it "parses quotes using custom quotations" do
+      quotes.each do |string|
+        # Change double quotes to single quotes in the fixture
+        expect(parser).to parse(string.gsub '"', "'")
+      end
+    end
+
+  end
+
+  context "use_attribute_quotes configuration" do
+
+    before do
+      Shortcode.setup do |config|
+        config.use_attribute_quotes = false
+      end
+    end
+
+    it "parses shortcodes with optional quotes" do
+      expect(parser).to parse(without_quotes)
+    end
+
+  end
+
+  it "parses list shortcodes" do
+    collapsible_lists.each do |string|
+      expect(parser).to parse(string)
+    end
+  end
+
+  it "parses timeline shortcodes" do
+    timelines.each do |string|
+      expect(parser).to parse(string)
+    end
+  end
+
+  it "parses complex nested shortcodes" do
+    expect(parser).to 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
+        expect(parsed_object[:body]).to eq([{ 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
+        expect(parsed_object[:body]).to eq([{
+          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
+        expect(parsed_object[:body]).to eq([
+          { 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
+        expect(parsed_object[:body]).to eq([{
+          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
+        expect(parsed_object[:body]).to eq([{
+          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
+        expect(parsed_object[:body]).to eq([{
+          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
+        expect(parsed_object[:body]).to eq([{
+          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
+        expect(parsed_object[:body]).to eq([{
+          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: "\n<p>Some more text</p>\n" }
+        ])
+      end
+    end
+  end
+end