typeout 1.4.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Connor McKay
+
+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.rdoc

@@ -0,0 +1,133 @@
+= Typeout
+
+Typeout is a plain text formatting language designed around two goals:
+
+* Syntax simple enough for computer illiterate users
+* Easily typed into an HTML textbox, meaning no tabs or extra spaces.
+
+It is also a set of libraries in different programming languages for converting
+Typeout formatted text into HTML. The primary implementation is in Ruby, which
+has been more or less directly translated into Javascript.
+
+Typeout is inspired by:
+
+* Markdown http://daringfireball.net/projects/markdown
+* Textile http://textism.com/tools/textile
+* Creole http://www.wikicreole.org
+
+*Author*::    Connor McKay (mailto:connor@verticalforest.com)
+*Version*::   1.4.1 (2010-7-8)
+*Copyright*:: Copyright (c) 2007-2010 Connor McKay. All rights reserved.
+*License*::   MIT License (http://opensource.org/licenses/mit-license.php)
+*Website*::   http://github.com/greneholt/typeout
+
+== Requires
+
+Ruby version:
+
+* Sanitize >= 1.2.1
+
+Javascript version:
+
+* MooTools Core >= 1.2.4
+
+== Installation
+
+Gem:
+
+  gem install typeout
+
+Rails plugin:
+
+  ./script/plugin install git://github.com/greneholt/typeout.git
+
+== Usage
+
+Ruby:
+
+  Typeout.convert(text)
+
+Javascript:
+
+  var text = new TypeOut(text);
+  text.toHTML();
+
+== Syntax
+
+  ---
+  Code block
+  ---
+
+  = Level 1 Header
+  == Level 2 Header, etc.
+
+  * Unordered
+  * List
+
+  # Ordered
+  # List
+
+  * Multilevel
+  * Unordered
+  ** List
+  ** With
+  *** Multiple
+  * Asterisks
+
+  * Mixed
+  * Unordered
+  *# And
+  *# Ordered
+  *# Nested
+  * List
+
+  ~~~
+  Four score and seven years ago, blockquotes use at least three tildes at
+  beginning and end.
+  ~~~
+
+  Average paragraph containing *bold text*, _italic text_, and a
+  [link to google](http://google.com) and some `inline code`.
+
+  Another paragraph with a [link](http://google.com):button with a class of "button".
+
+  Images
+
+  !(http://example.com/an_image.png)
+
+  !(http://example.com/logo.png)[An image with optional alt text]
+
+
+  Name: Jane Alice
+  Age: 25
+  Favorite food: Pizza
+
+  Text at the beginning of a line followed by a colon will be automatically bolded.
+
+Newlines in the middle of a paragraph are preserved in Typeout, meaning
+that a paragraph cannot be split across multiple lines.
+
+Plain html can be preserved intact by surrounding it in [html], [/html]
+pairs. It will be sanitized using the Sanitize library in the Ruby version.
+
+== License
+
+Copyright (c) 2010 Connor McKay
+
+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/lib/typeout.js

@@ -0,0 +1,276 @@
+var Typeout = new Class({
+    initialize: function(content) {
+        var self = this;
+        
+        self.content = content;
+    },
+    
+    toHTML: function() {
+        var self = this;
+        
+        var text = self.content;
+    
+        text = self.cleanWhitespace(text);
+        text = '\n\n' + text + '\n\n'; // a few guaranteed newlines
+    
+        self.archive = [];
+        
+        text = self.archiveHtml(text);
+    
+        text = self.htmlEscape(text);
+        
+        text = self.archiveCode(text);
+        
+        text = self.makeBlockquotes(text);
+        text = self.makeHeadings(text);
+        text = self.makeLists(text);
+        text = self.makeParagraphs(text);
+        text = self.makeInlines(text);
+        
+        text = self.removeExcessNewlines(text);
+    
+        text = self.retrieveArchive(text);
+    
+        return text;
+    },
+    
+    htmlEscape: function(text) {
+        return text.
+            replace(/&/g, '&').
+            replace(/</g, '&lt;').
+            replace(/>/g, '&gt;').
+            replace(/"/g, '&quot;')
+    },
+
+    regexpEscape: function(text) {
+        return text.replace(/([\{\}\(\)\[\]\*\+\?\$\^\.\#\\])/g, '\\$1')
+    },
+    
+    cleanWhitespace: function(text) {
+        return text.
+            replace(/\r\n/g, '\n').
+            replace(/\r/g, '\n').
+            replace(/^ +$/gm, '');
+    },
+    
+    removeExcessNewlines: function(text) {
+        return text.replace(/\n{3,}/g, '\n\n');
+    },
+    
+    archiveHtml: function(text) {
+        var self = this;
+        
+        return text.replace(/\[html\]([\s\S]*?)\[\/html\]/gmi, function(wholeMatch, m1) {
+            return self.addToArchive(m1);
+        });
+    },
+    
+    archiveCode: function(text) {
+        var self = this;
+        
+        text = text.replace(/^-{3,}\n([\s\S]+?)\n-{3,}$/gm, function(wholeMatch, m1) {
+            return self.addToArchive('<pre><code>' + m1 +'</code></pre>');
+        });
+        
+        return text.replace(/`(?!\s)((?:\s*\S)+?)`/g, function(wholeMatch, m1) {
+            return self.addToArchive('<code>' + m1 + '</code>');
+        });
+    },
+    
+    addToArchive: function(text) {
+        var self = this;
+        
+        var index = self.archive.push(text) - 1;
+        return '!a!r!c!h!i!v!e!' + index + '!a!r!c!h!i!v!e!'; // nobody's going to type that!
+    },
+    
+    retrieveArchive: function(text) {
+        var self = this;
+        
+        self.archive.each(function(content, index) {
+            text = text.replace(new RegExp('!a!r!c!h!i!v!e!' + index + '!a!r!c!h!i!v!e!'), content); // the block is so gsub won't substitute \&
+        });
+        return text;
+    },
+    
+    makeBlockquotes: function(text) {
+        return text.replace(/^~{3,}\n([\s\S]+?)\n~{3,}$/gm, '\n\n<blockquote>\n\n$1\n\n</blockquote>\n\n');
+    },
+    
+    makeHeadings: function(text) {
+        return text.replace(/^(={1,6})(.+?)=*?$/gm, function(wholeMatch, m1, m2) {
+            var depth = m1.length;
+            return '\n\n<h' + depth + '>' + m2.trim() + '</h' + depth + '>\n\n';
+        });
+    },
+    
+    makeLists: function(text, baseLevel) {
+        var self = this;
+        
+        if (baseLevel == undefined) {
+            baseLevel = '';
+        }
+        
+        return text.replace(new RegExp('^(' + self.regexpEscape(baseLevel) + '[\\*\\#])[\\*\\#]* [^\n]+?\n(?:\\1[\\*\\#]* (?:[^\n])+?\n)*', 'gm'), function(content, level) {
+            content = self.makeLists(content, level);
+            content = content.replace(new RegExp('^' + self.regexpEscape(level) + ' (.+)$', 'gm'), '<li>$1</li>');
+            content = content.replace(/<\/li>\n<([uo])l>/gm, '<$1l>');
+            
+            if (level.slice(-1) == '*') { // its an unordered list
+                content = '<ul>\n' + content + '</ul>';
+            } else {
+                content = '<ol>\n' + content + '</ol>';
+            }
+            
+            if (baseLevel) {
+                content += '</li>\n';
+            } else {
+                content += '\n';
+            }
+            return content;
+        }); 
+    },
+    
+    makeParagraphs: function(text) {
+        var self = this;
+        
+        return text.replace(/^(?!<|!a!r!c!h!i!v!e!)([^\n]+\n)+\n/gm, function(content) {
+            return '\n\n<p>\n' + self.makeBreaks(content.trim()) + '</p>\n\n';
+        });
+    },
+    
+    makeBreaks: function(text) {
+        return text.replace(/([^\n])\n(?!\n)/gm, '$1<br />\n');
+    },
+    
+    makeInlines: function(text) {
+        var self = this;
+        
+        text = text.
+            replace(/^((?: ?[\w\(\)']){3,}:) (?!\s*$)/gm, '<b>$1</b> '). // spaces are not allowed directly in front of the colon, there must be a space after it, and the rest of the line can't be blank
+            replace(/!\((.+?)\)(?:\:([a-zA-Z0-9\_]+))?/g, function(wholeMatch, m1, m2) {
+                if (m2) {
+                    return '<img src="' + self.addToArchive(m1.trim()) + '" class="' + m2 + '" />';
+                } else {
+                    return '<img src="' + self.addToArchive(m1.trim()) + '" />';
+                }
+            }).
+            replace(/\[(.+?)\]\((.+?)\)(?:\:([a-zA-Z0-9\_]+))?/g, function(wholeMatch, m1, m2, m3) {
+                if (m3) {
+                    return '<a href="' + self.addToArchive(m2.trim()) + '" class="' + m3 + '">' + self.addToArchive(m1) + '</a>';
+                } else {
+                    return '<a href="' + self.addToArchive(m2.trim()) + '">' + self.addToArchive(m1) + '</a>';
+                }
+            }).
+            replace(/([a-z0-9\.\-\_\+]+)@((?:[a-z0-9\-]{2,}\.)*)([a-z0-9\-]+\.)(com|org|net|biz|edu|info|gov|co\.uk|co\.us)/gi, function(wholeMatch, address, subdomain, domain, tld) {
+                return '<a href="mailto:' + self.addToArchive(address + '@' + subdomain + domain + tld) + '">' + self.addToArchive(address + '@' + subdomain + domain + tld) + '</a>';
+            }).
+            replace(/(https?:\/\/)?((?:[a-z0-9\-]{2,}\.)*)([a-z0-9\-]+\.)(com|org|net|biz|edu|info|gov|co\.uk|co\.us)((?:\/[a-z0-9\-\._=\?&;\%#]+)*\/?)/gi, function(wholeMatch, protocol, subdomain, domain, tld, file) {
+                if (!protocol) {
+                    protocol = 'http://';
+                }
+                return '<a href="' + self.addToArchive(protocol + subdomain + domain + tld + file) + '">' + self.addToArchive(protocol + subdomain + domain + tld + file) + '</a>';
+            });
+
+        var inlines = [
+            ['*', 'strong'],
+            ['_', 'em'],
+            ['`', 'code'],
+            ['^', 'sup'],
+            ['~', 'sub']
+        ];
+    
+        inlines.each(function(pair) {
+            var char = self.regexpEscape(pair[0]);
+            var tag = pair[1];
+            text = text.replace(new RegExp(char + '(?!\\s)((?:\\s*\\S)+?)' + char, 'g'), '<' + tag + '>$1</' + tag + '>');
+        });
+    
+        return text;
+    }
+});
+
+var TypeOutPreview = new Class({
+    Implements: Options,
+    
+    options: {
+        frequency: 500
+    },
+    
+    initialize: function(textArea, previewDiv, options) {
+        var self = this;
+        
+        self.textArea = $(textArea);
+        self.previewDiv = $(previewDiv);
+        
+        self.setOptions(options);
+        
+        self.typeOut = new TypeOut;
+        self.dirty = true;
+        self.ready = false;
+        
+        self.textArea.addEvent('keyup', self.setDirty.bind(self));
+        self.setReady();
+    },
+    
+    setDirty: function() {
+        var self = this;
+        
+        self.dirty = true;
+        if (self.ready) {
+            self.setUnReady();
+            self.preview();
+        }
+    },
+    
+    setUnReady: function() {
+        var self = this;
+        
+        self.ready = false;
+        self.setReady.delay(self.options.frequency, self);
+    },
+    
+    setReady: function() {
+        var self = this;
+        
+        self.ready = true;
+        if (self.dirty) {
+            self.setUnReady();
+            self.preview();
+        }
+    },
+    
+    render: function(text) {
+        var self = this;
+        
+        self.typeOut.content = text;
+        return self.typeOut.toHTML();
+    },
+    
+    preview: function() {
+        var self = this;
+        
+        self.previewDiv.set('html', self.render(self.textArea.value));
+        self.dirty = false;
+    }
+});
+
+TypeOutTemplatePreview = new Class({
+    Extends: TypeOutPreview,
+    
+    initialize: function(textArea, previewDiv, template, options) {
+        var self = this;
+        
+        self.template = template;
+        self.parent(textArea, previewDiv, options);
+    },
+    
+    render: function(content) {
+        var self = this;
+        
+        self.template.tags.each(function(tag) {
+            content = content.replace(RegExp(self.regexpEscape(tag.name), 'gi'), tag.example);
+        });
+        return self.parent(content);
+    }
+});

data/lib/typeout.rb

@@ -0,0 +1,170 @@
+require 'sanitize'
+
+class Typeout < String
+  VERSION = '1.4.1'
+  
+  include ERB::Util
+  
+  def self.convert(text)
+    self.new(text.to_s).to_html
+  end
+  
+  def to_html
+    text = self.dup
+    
+    text = clean_whitespace text
+    text = "\n\n#{text}\n\n" # a few guaranteed newlines
+    
+    @archive = []
+    
+    text = archive_html text
+    
+    text = html_escape text
+    
+    text = archive_code text
+    text = archive_blockquotes text
+    
+    text = make_headings text
+    text = make_lists text
+    text = make_paragraphs text
+    text = make_inlines text
+    
+    text = remove_excess_newlines text
+    
+    text = retrieve_archive text
+    
+    text
+  end
+  
+  def sanitize_html(text)
+    Sanitize.clean(text, Sanitize::Config::RELAXED)
+  end
+  
+  def clean_whitespace(text)
+    text.gsub(/\r\n/, "\n").
+      gsub(/\r/, "\n").
+      gsub(/^ +$/, '')
+  end
+  
+  def remove_excess_newlines(text)
+    text.gsub(/\n{3,}/, "\n\n")
+  end
+  
+  def archive_html(text)
+    text.gsub(/\[html\](.*?)\[\/html\]/mi) { archive(sanitize_html($1)) }
+  end
+  
+  def archive_code(text)
+    text = text.gsub(/^-{3,}\n(.+?)\n-{3,}$/m) { archive("<pre><code>#{$1}</code></pre>") }
+    text.gsub(/`(?!\s)((?:\s*\S)+?)`/) { archive("<code>#{$1}</code>") }
+  end
+  
+  def archive_blockquotes(text)
+    text.gsub(/^~{3,}\n(.+?)\n~{3,}$/m) do
+      content = remove_excess_newlines(make_paragraphs(make_lists("\n\n#{$1}\n\n"))) # blockquotes support paragraphs and lists
+      archive("<blockquote>#{content}</blockquote>")
+    end
+  end
+  
+  def archive(text)
+    @archive << text
+    "!a!r!c!h!i!v!e!#{@archive.length-1}!a!r!c!h!i!v!e!" # nobody's going to type that!
+  end
+  
+  def retrieve_archive(text)
+    @archive.each_with_index do |content, index|
+      text = text.sub("!a!r!c!h!i!v!e!#{index}!a!r!c!h!i!v!e!") { content } # the block is so gsub won't substitute \&
+    end
+    text
+  end
+  
+  def make_headings(text)
+    text.gsub(/^(={1,6})(.+?)=*?$/) do
+      depth = $1.length
+      "\n\n<h#{depth}>#{$2.strip}</h#{depth}>\n\n"
+    end
+  end
+  
+  def make_lists(text, base_level = nil)
+    text.gsub(/^(#{Regexp.escape(base_level.to_s)}[\*\#])[\*\#]* [^\n]+?\n(?:\1[\*\#]* (?:[^\n])+?\n)*/m) do |content|
+      level = $1
+      
+      content = make_lists(content, level)
+      content = content.gsub(/^#{Regexp.escape(level)} (.+)$/, '<li>\1</li>')
+      content = content.gsub(/<\/li>\n<([uo])l>/m, '<\1l>')
+      
+      if level.last == "*" # its an unordered list
+        content = "<ul>\n#{content}</ul>"
+      else
+        content = "<ol>\n#{content}</ol>"
+      end
+      
+      if base_level
+        content += "</li>\n"
+      else
+        content += "\n"
+      end
+      content
+    end
+  end
+  
+  def make_paragraphs(text)
+    text.gsub(/^(?!<|!a!r!c!h!i!v!e!)([^\n]+\n)+\n/m) { |content| "\n\n<p>\n#{make_breaks(content.strip)}</p>\n\n" }
+  end
+  
+  def make_breaks(text)
+    text.gsub(/([^\n])\n(?!\n)/m, "\\1<br />\n")
+  end
+  
+  def make_inlines(text)
+    text = text.
+      gsub(/^((?: ?[\w\(\)']){3,}:) (?!\s*$)/, '<b>\1</b> '). # spaces are not allowed directly in front of the colon, there must be a space after it, and the rest of the line can't be blank
+      gsub(/!\((.+?)\)(?:\:([a-zA-Z0-9\_]+))?/) do
+        if $2
+          "<img src=\"#{archive($1)}\" class=\"#{$2}\" />"
+        else
+          "<img src=\"#{archive($1)}\" />"
+        end
+      end.
+      gsub(/\[(.+?)\]\((.+?)\)(?:\:([a-zA-Z0-9\_]+))?/) do
+        if $3
+          "<a href=\"#{archive($2)}\" class=\"#{$3}\">#{archive($1)}</a>"
+        else
+          "<a href=\"#{archive($2)}\">#{archive($1)}</a>"
+        end
+      end.
+      gsub(/([a-z0-9\.\-\_\+]+)@((?:[a-z0-9\-]{2,}\.)*)([a-z0-9\-]+\.)(com|org|net|biz|edu|info|gov|co\.uk|co\.us)/i) do
+        "<a href=\"mailto:#{archive($1 + '@' + $2 + $3 + $4)}\">#{archive($1 + '@' + $2 + $3 + $4)}</a>"
+      end.
+      gsub(/(https?:\/\/)?((?:[a-z0-9\-]{2,}\.)*)([a-z0-9\-]+\.)(com|org|net|biz|edu|info|gov|co\.uk|co\.us)((?:\/[a-z0-9\-\._=\?&;\%#]+)*\/?)/i) do
+        if $1.nil?
+          protocol = 'http://'
+        else
+          protocol = $1
+        end
+        "<a href=\"#{archive(protocol + $2 + $3 + $4 + $5)}\">#{archive(protocol + $2 + $3 + $4 + $5)}</a>"
+      end
+    
+    inlines = [
+      ['*', 'strong'],
+      ['_', 'em'],
+      ['`', 'code'],
+      ['^', 'sup'],
+      ['~', 'sub']
+    ]
+    
+    inlines.each do |char, tag|
+      char = Regexp.escape(char)
+      re = /#{char}         # the opening character
+           (?!\s)           # no spaces directly after the char
+           (                # main capture group
+           (?:\s*\S)+?      # because of no lookbehinds, every space must be followed by a non-space
+           )                # with lookbehinds, the whole regex is: \*(?! )(.+?)(?<! )\*
+           #{char}/x        # closing character, no spaces directly before it
+      #re = /#{char}(.+?)#{char}/
+      text.gsub!(re, "<#{tag}>\\1</#{tag}>")
+    end
+    
+    text
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: typeout
+version: !ruby/object:Gem::Version 
+  hash: 5
+  prerelease: false
+  segments: 
+  - 1
+  - 4
+  - 1
+  version: 1.4.1
+platform: ruby
+authors: 
+- Connor McKay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-08 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sanitize
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+- connor@verticalforest.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- LICENSE
+- lib/typeout.js
+- lib/typeout.rb
+has_rdoc: true
+homepage: http://github.com/greneholt/typeout
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 17
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
+requirements: []
+
+rubyforge_project: typeout
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Dead simple plain text to HTML converter
+test_files: []
+