acts_as_markup_on 1.0.0

data/lib/acts_as_markup_on/exts/bluecloth.rb

@@ -0,0 +1,16 @@
+class BlueClothText < BlueCloth
+  include Stringlike
+
+  def initialize(string, options = BlueCloth::DEFAULT_OPTIONS)
+    @string = string
+    super
+  end
+  
+  def to_s
+    @string
+  end
+  
+  def blank?
+    @string.blank?
+  end
+end

data/lib/acts_as_markup_on/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_on+
+      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_on/exts/object.rb

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

data/lib/acts_as_markup_on/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_on/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_on/exts/rdoc.rb

@@ -0,0 +1,100 @@
+require 'rdoc'
+
+class RDocWithHyperlinkToHtml < RDoc::Markup::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 = RDoc::Markup.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(RDoc::Options.new)
+    
+    @html = @markup.convert(@text, @html_formatter)
+  end
+  
+  def to_html
+    @html
+  end
+end
+

data/lib/acts_as_markup_on/exts/redcarpet.rb

@@ -0,0 +1,9 @@
+class RedcarpetText < Redcarpet::Markdown
+  include Stringlike
+  
+  alias_method :to_s, :text
+  
+  def blank?
+    text.blank?
+  end
+end

data/lib/acts_as_markup_on/exts/wikicloth.rb

@@ -0,0 +1,18 @@
+require 'wikicloth'
+
+class WikiClothText < WikiCloth::Parser
+  include Stringlike
+  
+  def initialize(string)
+    @text = string
+    super({:data => string.to_s})
+  end
+  
+  def to_s
+    @text.to_s
+  end
+  
+  def blank?
+    @text.blank?
+  end
+end

data/lib/acts_as_markup_on/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_on/railtie.rb

@@ -0,0 +1,26 @@
+module ActsAsMarkupOn
+  class Railtie < Rails::Railtie
+    config.acts_as_markup_on = ActiveSupport::OrderedOptions.new
+    
+    initializer 'acts_as_markup_on.set_config', :after => 'active_record.initialize_database' do |app|
+      ActiveSupport.on_load(:acts_as_markup_on) do
+        self.markdown_library = app.config.acts_as_markup_on.markdown_library
+        self.mediawiki_library = app.config.acts_as_markup_on.mediawiki_library
+      end
+    end
+    
+    initializer 'acts_as_markup_on.extend_active_record', :after => 'acts_as_markup_on.set_config' do |app|
+      ActiveSupport.on_load(:active_record) do
+        require 'acts_as_markup_on/exts/object'
+        require 'acts_as_markup_on/stringlike'
+        require 'acts_as_markup_on/active_record_extension'
+        self.send :include, ActsAsMarkupOn::ActiveRecordExtension
+      end
+    end
+    
+    config.before_configuration do
+      config.acts_as_markup_on['markdown_library'] ||= :rdiscount
+      config.acts_as_markup_on['mediawiki_library'] ||= :wikicloth
+    end
+  end
+end

data/lib/acts_as_markup_on/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_on/version.rb

@@ -0,0 +1,3 @@
+module ActsAsMarkupOn
+  VERSION = '1.0.o'
+end

data/test/acts_as_markdown_test.rb

@@ -0,0 +1,361 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ActsAsMarkdownTest < ActsAsMarkupOnTestCase
+  context 'acts_as_markdown_on' do
+    setup do
+      @markdown_text = '## Markdown Test Text'
+    end
+
+    context 'using RDiscount' do
+      setup do
+        ActsAsMarkupOn.markdown_library = :rdiscount
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown_on :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_on :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
+        ActsAsMarkupOn.markdown_library = :rpeg
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown_on :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_on :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
+        ActsAsMarkupOn.markdown_library = :bluecloth
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown_on :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_on :body, :markdown_options => [{:escape_html => true}]
+        end
+        @post = Post.new(:title => 'Blah')
+      end
+      
+      # TODO: This test is broken because BleuCloth's behavior is broken.
+      should "return escaped html because of :escape_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
+        ActsAsMarkupOn.markdown_library = :maruku
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown_on :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
+    
+    context 'using Redcarpet' do
+      setup do
+        ActsAsMarkupOn.markdown_library = :redcarpet
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown_on :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @markdown_text)
+      end
+      
+      should_act_like_a_string
+
+      should "have a Redcarpet object returned for the column value" do
+        assert_kind_of Redcarpet, @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 Redcarpet object but not the same object" do
+          assert_kind_of Redcarpet, @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