acts_as_markup 1.3.4 → 1.4.0

data/lib/acts_as_markup/active_record_extension.rb

@@ -0,0 +1,217 @@
+module ActsAsMarkup
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      
+      # This allows you to specify columns you want to define as containing 
+      # Markdown, Textile, Wikitext or RDoc content.
+      # Then you can simply call <tt>.to_html</tt> method on the attribute.
+      # 
+      # You can also specify the language as <tt>:variable</tt>. The language used
+      # to process the column will be based on another column. By default a column
+      # named "<tt>markup_language</tt>" is used, but this can be changed by providing 
+      # a <tt>:language_column</tt> option. When a value is accessed it will create 
+      # the correct object (Markdown, Textile, Wikitext or RDoc) based on the value 
+      # of the language column. If any value besides markdown, textile, mediawiki, or 
+      # RDoc is supplied for the markup language the text will pass through as a string.
+      #
+      # You can specify additional options to pass to the markup library by using
+      # <tt>:markdown_options</tt>, <tt>:textile_options</tt> or <tt>:mediawiki_options</tt>.
+      # RDoc does not support any useful options. The options should be given as an array
+      # of arguments. You can specify options for more than one language when using
+      # <tt>:variable</tt>. See each library's documentation for more details on what
+      # options are available.
+      # 
+      # 
+      # ==== Examples
+      # 
+      # ===== Using Markdown language
+      # 
+      #     class Post < ActiveRecord
+      #       acts_as_markup :language => :markdown, :columns => [:body]
+      #     end
+      #     
+      #     @post = Post.find(:first)
+      #     @post.body.to_s            # => "## Markdown Headline"
+      #     @post.body.to_html         # => "<h2> Markdown Headline</h2>"
+      #     
+      # 
+      # ===== Using variable language
+      # 
+      #     class Post < ActiveRecord
+      #       acts_as_markup :language => :variable, :columns => [:body], :language_column => 'language_name'
+      #     end
+      #     
+      #     @post = Post.find(:first)
+      #     @post.language_name        # => "markdown"
+      #     @post.body.to_s            # => "## Markdown Headline"
+      #     @post.body.to_html         # => "<h2> Markdown Headline</h2>"
+      #     
+      # 
+      # ===== Using options
+      # 
+      #     class Post < ActiveRecord
+      #       acts_as_markup :language => :markdown, :columns => [:body], :markdown_options => [ :filter_html ]
+      #     end
+      #     
+      #     class Post < ActiveRecord
+      #       acts_as_markup :language => :textile, :columns => [:body], :textile_options => [ [ :filter_html ] ]
+      #     end
+      #     
+      #     class Post < ActiveRecord
+      #       acts_as_markup :language => :mediawiki, :columns => [:body], :mediawiki_options => [ { :space_to_underscore => true } ]
+      #     end
+      #     
+      # 
+      def acts_as_markup(options)
+        options.reverse_merge!(:language_column => :markup_language)
+        markup_class = load_markup_class(options)
+        
+        unless options[:language].to_sym == :variable
+          define_markup_columns_reader_methods(markup_class, options)
+        else
+          define_variable_markup_columns_reader_methods(markup_class, options)
+        end
+      end
+      
+      # This is a convenience method for 
+      # `<tt>acts_as_markup :language => :markdown, :columns => [:body]</tt>`
+      # Additional options can be given at the end, if necessary.
+      # 
+      def acts_as_markdown(*columns)
+        options = columns.extract_options!
+        acts_as_markup options.merge(:language => :markdown, :columns => columns)
+      end
+      
+      # This is a convenience method for 
+      # `<tt>acts_as_markup :language => :textile, :columns => [:body]</tt>`
+      # Additional options can be given at the end, if necessary.
+      #
+      def acts_as_textile(*columns)
+        options = columns.extract_options!
+        acts_as_markup options.merge(:language => :textile, :columns => columns)
+      end
+      
+      # This is a convenience method for 
+      # `<tt>acts_as_markup :language => :mediawiki, :columns => [:body]</tt>`
+      # Additional options can be given at the end, if necessary.
+      #
+      def acts_as_mediawiki(*columns)
+        options = columns.extract_options!
+        acts_as_markup options.merge(:language => :mediawiki, :columns => columns)
+      end
+      
+      # This is a convenience method for 
+      # `<tt>acts_as_markup :language => :rdoc, :columns => [:body]</tt>`
+      # Additional options can be given at the end, if necessary.
+      #
+      def acts_as_rdoc(*columns)
+        options = columns.extract_options!
+        acts_as_markup options.merge(:language => :rdoc, :columns => columns)
+      end
+      
+      
+      private
+        def get_markdown_class
+          if ActsAsMarkup::MARKDOWN_LIBS.keys.include? ActsAsMarkup.markdown_library
+            markdown_library_names = ActsAsMarkup::MARKDOWN_LIBS[ActsAsMarkup.markdown_library]
+            require markdown_library_names[:lib_name]
+            require_extensions(markdown_library_names[:lib_name])
+            return markdown_library_names[:class_name].constantize
+          else
+            raise ActsAsMarkup::UnsportedMarkdownLibrary, "#{ActsAsMarkup.markdown_library} is not currently supported."
+          end
+        end
+        
+        def get_mediawiki_class
+          if ActsAsMarkup::MEDIAWIKI_LIBS.keys.include? ActsAsMarkup.mediawiki_library
+            mediawiki_library_names = ActsAsMarkup::MEDIAWIKI_LIBS[ActsAsMarkup.mediawiki_library]
+            require mediawiki_library_names[:lib_name]
+            require_extensions(mediawiki_library_names[:lib_name])
+            return mediawiki_library_names[:class_name].constantize
+          else
+            raise ActsAsMarkup::UnsportedMediawikiLibrary, "#{ActsAsMarkup.mediawiki_library} is not currently supported."
+          end
+        end
+        
+        def require_extensions(library)# :nodoc:
+          if ActsAsMarkup::LIBRARY_EXTENSIONS.include? library.to_s
+            require "acts_as_markup/exts/#{library}"
+          end
+        end
+        
+        def require_library_and_get_class(language)
+          case language
+          when :markdown
+            return get_markdown_class
+          when :textile
+            require 'redcloth'
+            return RedCloth
+          when :mediawiki
+            return get_mediawiki_class
+          when :rdoc
+            require 'rdoc'
+            require_extensions 'rdoc'
+            return RDocText
+          else
+            return String
+          end
+        end
+        
+        def load_markup_class(options)
+          case options[:language].to_sym
+          when :markdown, :textile, :mediawiki, :rdoc
+            require_library_and_get_class(options[:language].to_sym)
+          when :variable
+            markup_classes = {}
+            [:textile, :mediawiki, :rdoc, :markdown].each do |language|
+              markup_classes[language] = require_library_and_get_class(language)
+            end
+            markup_classes
+          else
+            raise ActsAsMarkup::UnsupportedMarkupLanguage, "#{options[:langauge]} is not a currently supported markup language."
+          end
+        end
+        
+        def define_markup_columns_reader_methods(markup_class, options)
+          markup_options = options["#{options[:language]}_options".to_sym] || []
+          
+          options[:columns].each do |col|
+            define_method col do
+              if instance_variable_defined?("@#{col}") && !send("#{col}_changed?")
+                  instance_variable_get("@#{col}")
+              else
+                instance_variable_set("@#{col}", markup_class.new(self[col].to_s, *markup_options))
+              end
+            end
+          end
+        end
+        
+        def define_variable_markup_columns_reader_methods(markup_classes, options)
+          options[:columns].each do |col|
+            define_method col do
+              if instance_variable_defined?("@#{col}")
+                unless send("#{col}_changed?") || send("#{options[:language_column]}_changed?")
+                  return instance_variable_get("@#{col}")
+                end
+              end
+              instance_variable_set("@#{col}", case send(options[:language_column])
+              when /markdown/i
+                markup_classes[:markdown].new self[col].to_s, *(options[:markdown_options] || [])
+              when /textile/i
+                markup_classes[:textile].new self[col].to_s, *(options[:textile_options] || [])
+              when /mediawiki/i
+                markup_classes[:mediawiki].new self[col].to_s, *(options[:mediawiki_options] || [])
+              when /rdoc/i
+                markup_classes[:rdoc].new self[col].to_s
+              else
+                self[col]
+              end)
+            end
+          end
+        end
+      
+    end
+  end
+end

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

@@ -1,7 +1,6 @@
-require 'rdoc/markup/simple_markup'
-require 'rdoc/markup/simple_markup/to_html'
+require 'rdoc'
 
-class RDocWithHyperlinkToHtml < SM::ToHtml
+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
@@ -72,7 +71,7 @@ class RDocText < String
   def initialize(str)
     super(str)
     @text = str.to_s
-    @markup = SM::SimpleMarkup.new
+    @markup = RDoc::Markup.new
     
     # external hyperlinks
     @markup.add_special(/((link:|https?:|mailto:|ftp:|www\.)\S+\w)/, :HYPERLINK)

data/lib/acts_as_markup/exts/redcarpet.rb

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

data/lib/acts_as_markup/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
+  end
+  
+  def blank?
+    @text.blank?
+  end
+end

data/lib/acts_as_markup/railtie.rb

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

data/lib/acts_as_markup/version.rb

@@ -0,0 +1,3 @@
+module ActsAsMarkup
+  VERSION = '1.4.0'
+end

data/tasks/rdoc.rb

@@ -1,13 +1,7 @@
-begin
-  gem 'brianjlandau-sdoc-helpers'
-  require 'sdoc_helpers'
-  require 'rake/sdoctask'
-  
-  Rake::SDocTask.new do |rdoc|
-    version = ActsAsMarkup::VERSION
-    rdoc.title = "ActsAsMarkup #{version} Documentation"
-    rdoc.rdoc_files.include('lib/**/*.rb')
-  end
-rescue LoadError
-  puts "sdoc RDoc tasks not loaded. Please intall sdoc."
-end
+require 'rake/sdoctask'
+
+Rake::SDocTask.new do |rdoc|
+  version = ActsAsMarkup::VERSION
+  rdoc.title = "ActsAsMarkup #{version} Documentation"
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/test/acts_as_markdown_test.rb

@@ -223,12 +223,13 @@ class ActsAsMarkdownTest < ActsAsMarkupTestCase
     context 'using BlueCloth with options' do
       setup do
         class ::Post
-          acts_as_markdown :body, :markdown_options => [ :filter_html ]
+          acts_as_markdown :body, :markdown_options => [{:escape_html => true}]
         end
         @post = Post.new(:title => 'Blah')
       end
       
-      should "return escaped html because of :filter_html" do
+      # 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
@@ -291,6 +292,68 @@ class ActsAsMarkdownTest < ActsAsMarkupTestCase
       end
     end
     
+    context 'using Redcarpet' do
+      setup do
+        ActsAsMarkup.markdown_library = :redcarpet
+        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 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

data/test/acts_as_markup_test.rb

@@ -7,7 +7,7 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
   
   context 'acts_as_markup' do
     setup do
-      ActsAsMarkup.markdown_library = ActsAsMarkup::DEFAULT_MARKDOWN_LIB
+      ActsAsMarkup.markdown_library = :rdiscount
       
       @textile_text = "h2. Textile Test Text"
       class ::TextilePost < ActiveRecord::Base
@@ -76,7 +76,8 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
   
   context 'acts_as_markup with variable language' do
     setup do
-      ActsAsMarkup.markdown_library = ActsAsMarkup::DEFAULT_MARKDOWN_LIB
+      ActsAsMarkup.markdown_library = :rdiscount
+      ActsAsMarkup.mediawiki_library = :wikicloth
       class ::VariablePost < ActiveRecord::Base
         acts_as_markup :language => :variable, :columns => [:body]
       end
@@ -176,14 +177,14 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
       end
     end
     
-    context 'with a Wikitext post' do
+    context 'with a Mediawiki post' do
       setup do
         @wikitext = "== Wikitext Test Text =="
-        @wikitext_post = VariablePost.create!(:title => 'Blah', :body => @wikitext, :markup_language => 'Wikitext')
+        @wikitext_post = VariablePost.create!(:title => 'Blah', :body => @wikitext, :markup_language => 'Mediawiki')
       end
 
       should "have a WikitextString object returned for the column value" do
-        assert_kind_of WikitextString, @wikitext_post.body
+        assert_kind_of WikiClothText, @wikitext_post.body
       end
 
       should "return original wikitext text for a `to_s` method call on the column value" do
@@ -191,26 +192,26 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
       end
 
       should "return formated html for a `to_html` method call on the column value" do
-        assert_match(/<h2>Wikitext Test Text<\/h2>/, @wikitext_post.body.to_html)
+        assert_match(/<h2>.*Wikitext Test Text.*<\/h2>/, @wikitext_post.body.to_html)
       end
 
       context "changing value of wikitext field should return new wikitext object" do
         setup do
           @old_body = @wikitext_post.body
-          @wikitext_post.body = "`@count = 20`"
+          @wikitext_post.body = "'''This is very important'''"
         end
 
         should "still have an WikitextString object but not the same object" do
-          assert_kind_of WikitextString, @wikitext_post.body
+          assert_kind_of WikiClothText, @wikitext_post.body
           assert_not_same @wikitext_post.body, @old_body 
         end
 
         should "return correct text for `to_s`" do
-          assert_equal "`@count = 20`", @wikitext_post.body.to_s
+          assert_equal "'''This is very important'''", @wikitext_post.body.to_s
         end
 
         should "return correct HTML for the `to_html` method" do
-          assert_match(/<p><code>\@count\s\=\s20<\/code><\/p>/, @wikitext_post.body.to_html)
+          assert_match(/<p><b>This is very important<\/b><\/p>/, @wikitext_post.body.to_html)
         end
 
         teardown do
@@ -239,7 +240,7 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
       end
 
       should "return formated html for a `to_html` method call on the column value" do
-        assert_match(/<h2>\s*RDoc Test Text\s*<\/h2>/, @rdoc_post.body.to_html)
+        assert_match(/<h2[^>]*>\s*RDoc Test Text\s*<\/h2>/, @rdoc_post.body.to_html)
       end
 
       context "changing value of RDoc field should return new RDoc object" do
@@ -325,7 +326,8 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
   
   context 'acts_as_markup with variable language setting the language column' do
     setup do
-      ActsAsMarkup.markdown_library = ActsAsMarkup::DEFAULT_MARKDOWN_LIB
+      ActsAsMarkup.markdown_library = :rdiscount
+      ActsAsMarkup.mediawiki_library = :wikicloth
       class ::VariableLanguagePost < ActiveRecord::Base
         acts_as_markup :language => :variable, :columns => [:body], :language_column => :language_name
       end
@@ -380,10 +382,42 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
       end
     end
     
-    context 'with wikitext' do
+    context 'with WikiCloth mediawiki' do
       setup do
+        ActsAsMarkup.mediawiki_library = :wikicloth
         class ::Post < ActiveRecord::Base
-          acts_as_wikitext :body
+          acts_as_mediawiki :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @text)
+      end
+      
+      should 'return a blank string for `to_s` method' do
+        assert_equal @post.body.to_s, ''
+      end
+      
+      should 'return true for .blank?' do
+        assert @post.body.blank?
+      end
+      
+      should 'return a blank string for `to_html` method' do
+        assert_match(/[\n\s]*/, @post.body.to_html)
+      end
+      
+      should "have a WikitextString object returned for the column value" do
+        assert_kind_of WikiClothText, @post.body
+      end
+      
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+    
+    context 'with Wikitext mediawiki' do
+      setup do
+        ActsAsMarkup.mediawiki_library = :wikitext
+        class ::Post < ActiveRecord::Base
+          acts_as_mediawiki :body
         end
         @post = Post.create!(:title => 'Blah', :body => @text)
       end
@@ -481,7 +515,7 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
       end
       
       should 'return a blank string for `to_s` method' do
-        assert_equal @post.body.to_s, ''
+        assert_equal '', @post.body.to_s
       end
       
       should 'return true for .blank?' do
@@ -563,6 +597,37 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
         Post.delete_all
       end
     end
+    
+    context 'with Redcarpet Markdown' do
+      setup do
+        ActsAsMarkup.markdown_library = :redcarpet
+        class ::Post < ActiveRecord::Base
+          acts_as_markdown :body
+        end
+        @post = Post.create!(:title => 'Blah', :body => @text)
+      end
+      
+      should 'return a blank string for `to_s` method' do
+        assert_equal @post.body.to_s, ''
+      end
+      
+      should 'return true for .blank?' do
+        assert @post.body.blank?
+      end
+      
+      should 'return a blank string for `to_html` method' do
+        assert_match(/[\n\s]*/, @post.body.to_html)
+      end
+      
+      should "have a Maruku object returned for the column value" do
+        assert_kind_of Redcarpet, @post.body
+      end
+      
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
   end
   
   context 'acts_as_markup with bad language name' do
@@ -586,6 +651,17 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
     end
   end
   
+  context 'acts_as_markup with bad mediawiki library' do
+    should 'raise exception when a non-supported library is set as the mediawiki library attribute on ActsAsMarkup' do
+      assert_raise ActsAsMarkup::UnsportedMediawikiLibrary do
+        ActsAsMarkup.mediawiki_library = :fake
+        class ::Post < ActiveRecord::Base
+          acts_as_markup :language => :mediawiki, :columns => [:body]
+        end
+      end
+    end
+  end
+  
   def teardown
     teardown_db
   end