flavoured_markdown 0.5.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Lawrence Pit
+
+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.markdown

@@ -0,0 +1,78 @@
+Flavoured Markdown
+==================
+
+*Websafe Markdown with some extra flavour.*
+
+Markdown is a way to use an easy-to-read, easy-to-write plain text format that is turned into valid XHTML or HTML. See the <a href='http://daringfireball.net/projects/markdown/syntax'>Markdown Syntax</a> at Daring Fireball.
+
+It's important to realize that Markdown by default accepts any HTML code as its source. If you use Markdown as a way for your users to enter text easily via a web interface, providing easy markup capabilities, they could potentially enter harmful code (javascripts, styles, etc.). Flavoured Markdown escapes all HTML code by default.
+
+The extra flavors provided by Flavoured Markdown:
+
+* Do not allow javascript, styles and HTML codes
+* Except for A tags that have no on* attributes
+* And except for BR tags
+* HTML entities are alllowed (e.g.: &copy;, &amp;, etc.)
+* URLs and emails are automatically hyperlinked. Long hyperlinks are automatically limited to 55 characters.
+* Three consecutive dots are replaced by an ellipsis character
+* Fancy pants mode
+* Prevents paragraphs and list items from having an <a href='http://en.wikipedia.org/wiki/Widows_and_orphans'>orphan</a>.
+
+
+Usage
+-----
+
+    flavoured_markdown("# Hello World #\n----\n* Item A\n* Item B")
+
+
+Requirements
+------------
+
+This gem/plugin depends on the rdiscount and actionpack gems. To install, run:
+
+    $ sudo gem install rdiscount
+    $ sudo gem install actionpack
+
+
+Installation
+------------
+
+#### As a Gem
+
+Use this if you prefer to use versioned releases of Flavoured Markdown.
+Specify the gem dependency in your config/environment.rb file:
+
+    Rails::Initializer.run do |config|
+      config.gem "flavoured_markdown", :source => "http://gemcutter.org"
+    end
+
+Then:
+
+    $ rake gems:install
+    $ rake gems:unpack
+
+#### As a Rails Plugin
+
+Use this if you prefer to use the edge version of Flavoured Markdown within a Rails application:
+
+    $ script/plugin install git://github.com/lawrencepit/flavoured_markdown.git
+
+
+Options
+-------
+
+No options. Hack it.
+
+
+Credits
+-------
+
+Written by [Lawrence Pit](http://lawrencepit.com).
+
+Thanks to GitHub for their amazing services!
+GitHub has it's own <a href='http://github.github.com/github-flavored-markdown/'>GitHub Flavored Markdown</a>.
+You can have yours too.
+
+
+----
+Copyright (c) 2009 Lawrence Pit, released under the MIT license

data/init.rb

@@ -0,0 +1,2 @@
+require 'flavoured_markdown'
+ActionView::Base.send(:include, ActionView::Helpers::Markdown)

data/lib/flavoured_markdown.rb

@@ -0,0 +1,91 @@
+require 'rdiscount'
+require 'digest/md5'
+require 'action_view'
+
+module ActionView
+  module Helpers
+    module Markdown
+      include TagHelper
+      include TextHelper
+      include CaptureHelper
+      include UrlHelper
+
+      def flavoured_markdown(str)
+        str = RDiscount.new(str, :smart, :filter_styles, :filter_html).to_html
+
+        # Extract pre blocks
+        str = extract_markup(str, :pre)
+
+        # Undo markdown's html encoding of breaks
+        str.gsub!(%r{&lt;br\s*\/?>}m, "<br/>")
+
+        # Undo markdowns' html encoding of hyperlinks, except for those that
+        # contain an on* attribute which may contain javascript code.
+        str.gsub!(%r{&lt;a\s(.*?)&lt;/a>}m) do
+          match = $1
+          match =~ %r{\son\w}m ? "&lt;a #{match}&lt;/a>" : "<a #{match}</a>"
+        end
+
+        # Extract hyperlink html code
+        str = extract_markup(str, :a)
+
+        # Auto hyperlink urls and email addresses
+        str = auto_link(str, :all) do |txt|
+          txt.size < 55 ? txt : truncate(txt, :length => 50, :omission => "...")
+        end
+
+        # Extract the new hyperlinks
+        str = extract_markup(str, :a)
+
+        # preserve whitespace for haml
+        #str = str.chomp("\n").gsub(/\n/, '&#x000A;').gsub(/\r/, '')
+
+        # Prevent an orphan for P and LI tags
+        str.gsub!(%r{<(p|li)\b[^>]*>(.*?)</\1>}m) do |match|
+          last_space_index = match.rindex(' ')
+          if last_space_index
+            match = match.slice(0, last_space_index) + "&#160;" + match.slice(last_space_index + 1, match.length - last_space_index - 1)
+          end
+          match
+        end
+
+        # Add css class "last" to last P tag if it's the last element
+        str.sub!(%r{<p>(.*?)</p>\Z}, "<p class=\"last\">\\1</p>")
+
+        # Turn 3 consecutive dot characters into an ellipsis character
+        str = hellip(str)
+
+        # Put back in the previously extracted markup
+        str = add_extracted_markup(str)
+        
+        str
+      end
+      alias_method :flavored_markdown, :flavoured_markdown
+
+      private
+        # Parts from Github Flavored Markdown
+        # http://github.github.com/github-flavored-markdown/
+        def extract_markup(str, mode = :a)
+          regexp = mode == :pre ? %r{<pre>.*?</pre>}m : %r{<a\s(.*?)>(.*?)</a>}m
+          @extractions ||= {}
+          str.gsub(regexp) do |match|
+            match = "<a #{$1}>#{hellip($2)}</a>" if mode == :a
+            md5 = Digest::MD5.hexdigest(match)
+            @extractions[md5] = match
+            "{extraction-#{md5}}"
+          end
+        end
+
+        # Insert back the extracted markup
+        def add_extracted_markup(str)
+          str.gsub(/\{extraction-([0-9a-f]{32})\}/) do
+            @extractions[$1]
+          end
+        end
+        
+        def hellip(str)
+          str.gsub(%r{\b\.\.\.}m, "&hellip;")
+        end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+Kernel.load File.join(File.dirname(__FILE__), '..', 'init.rb')

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: flavoured_markdown
+version: !ruby/object:Gem::Version 
+  version: 0.5.3
+platform: ruby
+authors: 
+- Lawrence Pit
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-10 00:00:00 +11:00
+default_executable: 
+dependencies: []
+
+description: 
+email: lawrence.pit@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- MIT-LICENSE
+- init.rb
+- rails/init.rb
+- lib/flavoured_markdown.rb
+has_rdoc: true
+homepage: http://github.com/lawrencepit/flavoured_markdown
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Websafe markdown with some extra flavour.
+test_files: []
+