acts_as_markup_extended 1.0.1

data/lib/acts_as_markup/exts/maruku.rb

@@ -0,0 +1,70 @@
+require 'maruku'
+
+class Maruku
+  include Stringlike
+  
+  attr_reader :text
+  
+  def initialize(s=nil, meta={})
+    super(nil)
+    self.attributes.merge! meta
+    if s
+      @text = s
+      parse_doc(s)
+    end
+  end
+  
+  # Used to get the original Markdown text.
+  def to_s
+    @text
+  end
+  
+  # used to be compatable with Rails/ActiveSupport
+  def blank?
+    @text.blank?
+  end
+  
+end
+
+class String
+  alias_method :to_html, :to_s
+  
+  def to_xml
+    REXML::Text.new(self)
+  end
+end
+
+module MaRuKu # :nodoc:
+  module Out # :nodoc:
+    module HTML
+      
+      # We patch this method to play nicely with our own modifications of String.
+      #
+      # It originally used a +to_html+ method on String we've swapped this out for a +to_xml+ 
+      # method because we need +to_html+ to return the original text on plain text fields of
+      # the variable language option on +acts_as_markup+
+      def array_to_html(array)
+        elements = []
+        array.each do |item|
+          method = item.kind_of?(MDElement) ? "to_html_#{item.node_type}" : "to_xml"
+          unless item.respond_to?(method)
+            next
+          end
+
+          html_text =  item.send(method)
+          if html_text.nil?
+            raise "Nil html created by method  #{method}:\n#{html_text.inspect}\n for object #{item.inspect[0,300]}"
+          end
+
+          if html_text.kind_of?Array
+            elements = elements + html_text
+          else
+            elements << html_text
+          end
+        end
+        elements
+      end
+
+    end
+  end
+end

data/lib/acts_as_markup/exts/object.rb

@@ -0,0 +1 @@
+Object.send :alias_method, :to_html, :to_s

data/lib/acts_as_markup/exts/peg_markdown.rb

@@ -0,0 +1,10 @@
+require 'peg_markdown'
+
+class PEGMarkdown
+  include Stringlike
+  
+  # used to be compatable with Rails/ActiveSupport
+  def blank?
+    self.text.blank?
+  end
+end

data/lib/acts_as_markup/exts/rdiscount.rb

@@ -0,0 +1,15 @@
+require 'rdiscount'
+
+class RDiscount
+  include Stringlike
+  
+  # Used to get the original Markdown text.
+  def to_s
+    self.text
+  end
+  
+  # used to be compatable with Rails/ActiveSupport
+  def blank?
+    self.text.blank?
+  end
+end

data/lib/acts_as_markup/exts/rdoc.rb

@@ -0,0 +1,101 @@
+require 'rdoc/markup/simple_markup'
+require 'rdoc/markup/simple_markup/to_html'
+
+class RDocWithHyperlinkToHtml < SM::ToHtml
+
+  # Generate a hyperlink for url, labeled with text. Handle the
+  # special cases for img: and link: described under handle_special_HYPEDLINK
+  # 
+  def gen_url(url, text)
+    if url =~ /([A-Za-z]+):(.*)/
+      type = $1
+      path = $2
+    else
+      type = "http"
+      path = url
+      url  = "http://#{url}"
+    end
+
+    if type == "link"
+      if path[0,1] == '#'  # is this meaningful?
+        url = path
+      else
+        url = HTMLGenerator.gen_url(@from_path, path)
+      end
+    end
+
+    if (type == "http" || type == "link") && url =~ /\.(gif|png|jpg|jpeg|bmp)$/
+      "<img src=\"#{url}\" />"
+    else
+      "<a href=\"#{url}\">#{text.sub(%r{^#{type}:/*}, '')}</a>"
+    end
+  end
+  
+  # And we're invoked with a potential external hyperlink mailto:
+  # just gets inserted. http: links are checked to see if they
+  # reference an image. If so, that image gets inserted using an
+  # <img> tag. Otherwise a conventional <a href> is used.  We also
+  # support a special type of hyperlink, link:, which is a reference
+  # to a local file whose path is relative to the --op directory.
+  # 
+  def handle_special_HYPERLINK(special)
+    url = special.text
+    gen_url(url, url)
+  end
+
+  # Here's a hypedlink where the label is different to the URL
+  #    <label>[url]
+  # 
+  def handle_special_TIDYLINK(special)
+    text = special.text
+    unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/ 
+      return text
+    end
+    label = $1
+    url   = $2
+    gen_url(url, label)
+  end
+
+end
+
+# This allows a us to create a wrapper object similar to those provided by the
+# Markdown and Textile libraries. It stores the original and formated HTML text
+# in instance variables. It also stores the SimpleMarkup parser objects in
+# instance variables.
+#
+class RDocText < String
+  attr_reader :text
+  attr_reader :html
+  attr_reader :markup
+  attr_reader :html_formater
+  
+  def initialize(str)
+    super(str)
+    @text = str.to_s
+    @markup = SM::SimpleMarkup.new
+    
+    # external hyperlinks
+    @markup.add_special(/((link:|https?:|mailto:|ftp:|www\.)\S+\w)/, :HYPERLINK)
+
+    # and links of the form  <text>[<url>]
+    @markup.add_special(/(((\{.*?\})|\b\S+?)\[\S+?\.\S+?\])/, :TIDYLINK)
+    
+    # Convert leading comment markers to spaces, but only
+    # if all non-blank lines have them
+
+    if str =~ /^(?>\s*)[^\#]/
+      content = str
+    else
+      content = str.gsub(/^\s*(#+)/)  { $1.tr('#',' ') }
+    end
+    
+    @html_formatter = RDocWithHyperlinkToHtml.new
+    
+    @html = @markup.convert(@text, @html_formatter)
+  end
+  
+  def to_html
+    @html
+  end
+end
+

data/lib/acts_as_markup/exts/wikitext.rb

@@ -0,0 +1,20 @@
+require 'wikitext'
+
+# This allows a us to create a wrapper object similar to those provided by the
+# Markdown and Textile libraries. It stores the original and formated HTML text
+# in instance variables.
+# 
+class WikitextString < String
+  attr_reader :text
+  attr_reader :html
+  
+  def initialize(str, *options)
+    super(str)
+    @text = str.to_s
+    @html = Wikitext::Parser.new(*options).parse(@text)
+  end
+  
+  def to_html
+    @html
+  end
+end

data/lib/acts_as_markup/stringlike.rb

@@ -0,0 +1,7 @@
+# This mixin allows our markup objects (like RDiscount or RedCloth) to have
+# all the normal string methods that are available.
+module Stringlike
+  def method_missing(method, *params)
+    self.to_s.send(method, *params)
+  end
+end

data/lib/acts_as_markup_extended.rb

@@ -0,0 +1,79 @@
+require 'set'
+require 'active_support'
+require 'active_support/core_ext'
+
+module ActsAsMarkup
+  # :stopdoc:
+  VERSION = '1.3.4'.freeze
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+  
+  # This exception is raised when an unsupported markup language is supplied to acts_as_markup.
+  class UnsupportedMarkupLanguage < ArgumentError
+  end
+  # This exception is raised when an unsupported Markdown library is set to the config value.
+  class UnsportedMarkdownLibrary < ArgumentError
+  end
+  # this extension is raised when an extension method doesn't exist
+  class UnknownExtensionMethod < ArgumentError
+  end
+  DEFAULT_MARKDOWN_LIB = :rdiscount
+  
+  MARKDOWN_LIBS = { :rdiscount => {:class_name => "RDiscount",
+                                   :lib_name   => "rdiscount"}, 
+                    :bluecloth => {:class_name => "BlueCloth",
+                                   :lib_name   => "bluecloth"},
+                    :rpeg      => {:class_name => "PEGMarkdown",
+                                   :lib_name   => "peg_markdown"},
+                    :maruku    => {:class_name => "Maruku",
+                                   :lib_name   => "maruku"} }
+                                   
+  LIBRARY_EXTENSIONS = ::Set.new(Dir[ActsAsMarkup::LIBPATH + 'acts_as_markup/exts/*.rb'].map {|file| File.basename(file, '.rb')}).delete('string')
+  
+  @@markdown_library = DEFAULT_MARKDOWN_LIB
+  mattr_accessor :markdown_library
+  
+  # :stopdoc:
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the library path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
+  end
+
+  # Returns the path for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, *args)
+  end
+
+  # Utility method used to rquire all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+  # :startdoc:
+
+end  # module ActsAsMarkup
+
+require 'acts_as_markup/exts/object'
+require 'acts_as_markup/stringlike'
+require 'markup_extensions'
+ActsAsMarkup.require_all_libs_relative_to __FILE__, 'acts'

data/lib/markup_extensions.rb

@@ -0,0 +1,24 @@
+ActsAsMarkup.require_all_libs_relative_to __FILE__, 'markup_methods'
+ActsAsMarkup.require_all_libs_relative_to "lib/.", 'markup_methods'
+
+module MarkupExtensions
+  class MString < String
+    include MarkupExtensionMethods
+    
+    def run_methods(methods) 
+      (methods == :all ?
+        MarkupExtensionMethods.instance_methods :
+        methods
+      ).inject(self) { |mstring, meth|
+        if mstring.respond_to? meth
+          MString.new(mstring.send(meth))
+        else
+          raise ActsAsMarkup::UnknownExtensionMethod,
+           "Extension method \"#{meth.to_s}\" is not defined " 
+          MString.new(mstring)
+        end
+        }
+    end
+
+  end
+end

data/lib/markup_methods/ahttp.rb

@@ -0,0 +1,27 @@
+module MarkupExtensionMethods
+  
+  # This sample extension replaces URL strings in the form:
+  #   "http://..."
+  # with links:
+  #   "<a href="http://..."
+  #
+  # Strings that are already part of 
+  #   <a href= ...> or <img src= ...> 
+  # or inside 
+  #   <code> or <pre> 
+  # tags will remain unchanged
+  #
+  # (This extension can be used for any markup language.)
+  #
+  def ahttp
+    gsub( /http:\/\/[^\s><"']+/ ) {
+      match = $&; before = $`; after = $'     
+      before !~ /\s+(href|src|)\s*=\s*['"]*$/  && 
+      after  !~ /^[^<]*<\/a>/  && 
+      before !~ /(<code>|<pre>).*$/         ?
+        %Q~<a href="#{match}">#{match}</a>~ :
+        match
+    }
+  end
+
+end

data/lib/markup_methods/checklist.rb

@@ -0,0 +1,30 @@
+module MarkupExtensionMethods
+  
+  # This sample extension allows list elements to act as a checklist.
+  # If the markup list indicator is followed by a disposition character
+  # and a space, this method will make checklist substitutions.
+  #  
+  # For example, when this method sees this in a Markdown list:
+  #  '- x item one' 
+  # or this in a Textile list:
+  #  '* x item one" 
+  # it will substitute: 
+  #  '<li <strong>(x)</strong> item one'.
+  # 
+  # This method recognizes these disposition characters.
+  #  x - item completed
+  #  0 - item dropped
+  #  d - item deferred
+  #  @ - item in progress
+  #
+  # (this extension can be used for any markup language.)
+  #
+  def checklist
+    gsub(/<li>([x0d@]) (\S)/)  {
+      m1 = $1;m2 = $2
+      m1 = ">" if m1 == "d"
+      "<li><strong>(#{m1.upcase}) </strong>#{m2}"
+    }
+  end
+
+end

data/lib/markup_methods/logo.rb

@@ -0,0 +1,27 @@
+module MarkupExtensionMethods
+  
+  # This sample extension inserts a company logo.
+  # If Markdown contains:
+  #   "[logo](home)"
+  # or Textile contains:
+  #   "logo":home
+  # The generated HTML contains the company logo and links to the home page.
+  #
+  # (This extension can be used for any markup language)
+  #
+  def logo
+    gsub( /<a href="home">logo<\/a>/ ) { 
+      match = $&; before = $`
+      if before !~ /(<code>|<pre>).*$/
+        %Q~<a href="http://www.google.com">\n~ +
+        %Q~<img id="logo" alt="Google"~ +
+        %Q~ src="http://www.google.com/images/logos/google_logo.gif"~ + 
+        %Q~ style="border: 0 none;">\n~ +
+        %Q~</a>\n~
+      else
+        match
+      end
+    }
+  end
+
+end

data/test/acts_as_markdown_test.rb

@@ -0,0 +1,298 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ActsAsMarkdownTest < ActsAsMarkupTestCase
+  context 'acts_as_markdown' do
+    setup do
+      @markdown_text = '## Markdown Test Text'
+    end
+
+    context 'using RDiscount' do
+      setup do
+        ActsAsMarkup.markdown_library = :rdiscount
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @markdown_text)
+      end
+      
+      should_act_like_a_string
+
+      should "have a RDiscount object returned for the column value" do
+        assert_kind_of RDiscount, @post.body
+      end
+
+      should "return original markdown text for a `to_s` method call on the column value" do
+        assert_equal @markdown_text, @post.body.to_s
+      end
+      
+      should 'return false for .blank?' do
+        assert !@post.body.blank?
+      end
+
+      should "return formatted html for a `to_html` method call on the column value" do
+        assert_match(/<h2(\s\w+\=['"]\w*['"])*\s*>\s*Markdown Test Text\s*<\/h2>/, @post.body.to_html)
+      end
+    
+      should "not return escaped html" do
+        @post.body = "## Markdown <i>Test</i> Text"
+        assert_match(/<i>Test<\/i>/, @post.body.to_html)
+      end
+
+      context "changing value of markdown field should return new markdown object" do
+        setup do
+          @old_body = @post.body
+          @post.body = "`@count = 20`"
+        end
+
+        should "still have an RDiscount object but not the same object" do
+          assert_kind_of RDiscount, @post.body
+          assert_not_same @post.body, @old_body 
+        end
+
+        should "return correct text for `to_s`" do
+          assert_equal "`@count = 20`", @post.body.to_s
+        end
+
+        should "return correct HTML for the `to_html` method" do
+          assert_match(/<code>\s*\@count\s\=\s20\s*<\/code>/, @post.body.to_html)
+        end
+
+        teardown do
+          @old_body = nil
+        end
+      end
+
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+    
+    context 'using RDiscount with options' do
+      setup do
+        class ::Post
+          acts_as_markdown :body, :markdown_options => [ :filter_html ]
+        end
+        @post = Post.new(:title => 'Blah')
+      end
+      
+      should "return escaped html because of :filter_html" do
+        @post.body = "## Markdown <i>Test</i> Text"
+        assert_match(/&lt;i>Test&lt;\/i>/, @post.body.to_html)
+      end
+    end
+
+    context 'using Ruby PEG Markdown' do
+      setup do
+        ActsAsMarkup.markdown_library = :rpeg
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @markdown_text)
+      end
+      
+      should_act_like_a_string
+    
+      should "have a Ruby PEG Markdown object returned for the column value" do
+        assert_kind_of PEGMarkdown, @post.body
+      end
+    
+      should "return original markdown text for a `to_s` method call on the column value" do
+        assert_equal @markdown_text, @post.body.to_s
+      end
+      
+      should 'return false for .blank?' do
+        assert !@post.body.blank?
+      end
+    
+      should "return formated html for a `to_html` method call on the column value" do
+        assert_match(/<h2(\s\w+\=['"]\w*['"])*\s*>\s*Markdown Test Text\s*<\/h2>/, @post.body.to_html)
+      end
+    
+      should "not return escaped html" do
+        @post.body = "## Markdown <i>Test</i> Text"
+        assert_match(/<i>Test<\/i>/, @post.body.to_html)
+      end
+    
+      context "changing value of markdown field should return new markdown object" do
+        setup do
+          @old_body = @post.body
+          @post.body = "`@count = 20`"
+        end
+    
+        should "still have an PEGMarkdown object but not the same object" do
+          assert_kind_of PEGMarkdown, @post.body
+          assert_not_same @post.body, @old_body 
+        end
+    
+        should "return correct text for `to_s`" do
+          assert_equal "`@count = 20`", @post.body.to_s
+        end
+    
+        should "return correct HTML for the `to_html` method" do
+          assert_match(/<code>\s*\@count\s\=\s20\s*<\/code>/, @post.body.to_html)
+        end
+    
+        teardown do
+          @old_body = nil
+        end
+      end
+    
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+    
+    context 'using Ruby PEG Markdown with options' do
+      setup do
+        class ::Post
+          acts_as_markdown :body, :markdown_options => [ :filter_html ]
+        end
+        @post = Post.new(:title => 'Blah')
+      end
+      
+      should "return no html because of :filter_html" do
+        @post.body = "## Markdown <i>Test</i> Text"
+        assert_match(/Markdown Test Text/, @post.body.to_html)
+      end
+    end
+
+    context 'using BlueCloth' do
+      setup do
+        ActsAsMarkup.markdown_library = :bluecloth
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @markdown_text)
+      end
+      
+      should_act_like_a_string
+
+      should "have a BlueCloth object returned for the column value" do
+        assert_kind_of BlueCloth, @post.body
+      end
+
+      should "return original markdown text for a `to_s` method call on the column value" do
+        assert_equal @markdown_text, @post.body.to_s
+      end
+      
+      should 'return false for .blank?' do
+        assert !@post.body.blank?
+      end
+
+      should "return formated html for a `to_html` method call on the column value" do
+        assert_match(/<h2(\s\w+\=['"]\w*['"])*\s*>\s*Markdown Test Text\s*<\/h2>/, @post.body.to_html)
+      end
+    
+      should "not return escaped html" do
+        @post.body = "## Markdown <i>Test</i> Text"
+        assert_match(/<i>Test<\/i>/, @post.body.to_html)
+      end
+
+      context "changing value of markdown field should return new markdown object" do
+        setup do
+          @old_body = @post.body
+          @post.body = "`@count = 20`"
+        end
+
+        should "still have an BlueCloth object but not the same object" do
+          assert_kind_of BlueCloth, @post.body
+          assert_not_same @post.body, @old_body 
+        end
+
+        should "return correct text for `to_s`" do
+          assert_equal "`@count = 20`", @post.body.to_s
+        end
+
+        should "return correct HTML for the `to_html` method" do
+          assert_match(/<code>\s*\@count\s\=\s20\s*<\/code>/, @post.body.to_html)
+        end
+
+        teardown do
+          @old_body = nil
+        end
+      end
+
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+    
+    context 'using BlueCloth with options' do
+      setup do
+        class ::Post
+          acts_as_markdown :body, :markdown_options => [ :filter_html ]
+        end
+        @post = Post.new(:title => 'Blah')
+      end
+      
+      should "return escaped html because of :filter_html" do
+        @post.body = "## Markdown <i>Test</i> Text"
+        assert_match(/&lt;i&gt;Test&lt;\/i&gt;/, @post.body.to_html)
+      end
+    end
+    
+    context 'using Maruku' do
+      setup do
+        ActsAsMarkup.markdown_library = :maruku
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @markdown_text)
+      end
+      
+      should_act_like_a_string
+
+      should "have a Maruku object returned for the column value" do
+        assert_kind_of Maruku, @post.body
+      end
+
+      should "return original markdown text for a `to_s` method call on the column value" do
+        assert_equal @markdown_text, @post.body.to_s
+      end
+      
+      should 'return false for .blank?' do
+        assert !@post.body.blank?
+      end
+
+      should "return formated html for a `to_html` method call on the column value" do
+        assert_match(/<h2(\s\w+\=['"]\w*['"])*\s*>\s*Markdown Test Text\s*<\/h2>/, @post.body.to_html)
+      end
+
+      context "changing value of markdown field should return new markdown object" do
+        setup do
+          @old_body = @post.body
+          @post.body = "`@count = 20`"
+        end
+
+        should "still have an Maruku object but not the same object" do
+          assert_kind_of Maruku, @post.body
+          assert_not_same @post.body, @old_body 
+        end
+
+        should "return correct text for `to_s`" do
+          assert_equal "`@count = 20`", @post.body.to_s
+        end
+
+        should "return correct HTML for the `to_html` method" do
+          assert_match(/<code>\s*\@count\s\=\s20\s*<\/code>/, @post.body.to_html)
+        end
+
+        teardown do
+          @old_body = nil
+        end
+      end
+
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+    
+    teardown do
+      @markdown_text = nil
+    end
+  end
+end