acts_as_markup 0.3.0 → 0.4.0

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.4.0 / 2008-08-08
+
+* Add support for RDoc.
+
 == 0.3.0 / 2008-08-08
 
 * Add support for wikitext.

data/Manifest.txt

@@ -7,6 +7,7 @@ acts_as_markup.gemspec
 lib/acts/as_markup.rb
 lib/acts_as_markup.rb
 lib/acts_as_markup/exts/rdiscount.rb
+lib/acts_as_markup/exts/rdoc.rb
 lib/acts_as_markup/exts/string.rb
 lib/acts_as_markup/exts/wikitext.rb
 tasks/bones.rake
@@ -20,6 +21,7 @@ tasks/setup.rb
 tasks/test.rake
 test/acts_as_markdown_test.rb
 test/acts_as_markup_test.rb
+test/acts_as_rdoc_test.rb
 test/acts_as_textile_test.rb
 test/acts_as_wikitext_test.rb
 test/test_helper.rb

data/README.rdoc

@@ -10,13 +10,14 @@ RDoc: http://viget.rubyforge.org/acts_as_markup
 == DESCRIPTION:
 
 Allows you to specify columns of an ActiveRecord model that contain Markdown, 
-Textile, and Wiki text. You may then use +to_s+ to get the original markup 
+Textile, Wiki text and RDoc. You may then use +to_s+ to get the original markup 
 text or +to_html+ to get the formated HTML.
 
 Additionally you can have a model that contains a column that has a column with 
 markup text, and another that defines what language to process it as. If the field 
-is listed as "markdown" "textile", or "wikitext" (case insensitive) it will treat it as such, 
-any other value for markup language will have the value pass through as a normal string.
+is listed as "markdown" "textile", "wikitext" or "rdoc" (case insensitive) it will 
+treat it as such, any other value for markup language will have the value pass 
+through as a normal string.
 
 This AR extension can use 3 different types of Markdown processing backends: 
 BlueCloth, RDiscount, or Ruby PEG. You specify which one you want to use by setting
@@ -61,6 +62,17 @@ By default RDiscount will be used.
     @post.body.to_html  #=> "<h2>Wikitext Headline</h2>"
     
 
+==== Using +acts_as_rdoc+:
+
+    class Post < ActiveRecrod
+      acts_as_rdoc :body
+    end
+
+    @post = Post.find(:first)
+    @post.body.to_s     #=> "== RDoc Headline"
+    @post.body.to_html  #=> "<h2>RDoc Headline</h2>"
+    
+
 ==== Using +acts_as_markup+:
 
     class Post < ActiveRecrod
@@ -72,7 +84,7 @@ By default RDiscount will be used.
     @post.body.to_html  #=> "<h2> Markdown Headline</h2>"
     
     
-==== Using +acts_as_markup+ with +:variable+ language:
+==== Using +acts_as_markup+ with <tt>:variable</tt> language:
 
     class Post < ActiveRecrod
       acts_as_markup :language => :variable, :columns => [:body], :language_column => 'markup_language'

data/acts_as_markup.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name = %q{acts_as_markup}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Landau"]
-  s.date = %q{2008-08-08}
+  s.date = %q{2008-08-11}
   s.description = %q{Represent ActiveRecord Markdown, Textile, or Wiki text columns as Markdown, Textile or Wikitext objects using various external libraries to convert to HTML.}
   s.email = %q{brian.landau@viget.com}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "acts_as_markup.gemspec", "lib/acts/as_markup.rb", "lib/acts_as_markup.rb", "lib/acts_as_markup/exts/rdiscount.rb", "lib/acts_as_markup/exts/string.rb", "lib/acts_as_markup/exts/wikitext.rb", "tasks/bones.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/manifest.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/setup.rb", "tasks/test.rake", "test/acts_as_markdown_test.rb", "test/acts_as_markup_test.rb", "test/acts_as_textile_test.rb", "test/acts_as_wikitext_test.rb", "test/test_helper.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "acts_as_markup.gemspec", "lib/acts/as_markup.rb", "lib/acts_as_markup.rb", "lib/acts_as_markup/exts/rdiscount.rb", "lib/acts_as_markup/exts/rdoc.rb", "lib/acts_as_markup/exts/string.rb", "lib/acts_as_markup/exts/wikitext.rb", "tasks/bones.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/manifest.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/setup.rb", "tasks/test.rake", "test/acts_as_markdown_test.rb", "test/acts_as_markup_test.rb", "test/acts_as_rdoc_test.rb", "test/acts_as_textile_test.rb", "test/acts_as_wikitext_test.rb", "test/test_helper.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://viget.rubyforge.com/acts_as_markup}
   s.rdoc_options = ["--main", "README.rdoc"]
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{viget}
   s.rubygems_version = %q{1.2.0}
   s.summary = %q{Represent ActiveRecord Markdown, Textile, or Wiki text columns as Markdown, Textile or Wikitext objects using various external libraries to convert to HTML}
-  s.test_files = ["test/acts_as_markdown_test.rb", "test/acts_as_markup_test.rb", "test/acts_as_textile_test.rb", "test/acts_as_wikitext_test.rb"]
+  s.test_files = ["test/acts_as_markdown_test.rb", "test/acts_as_markup_test.rb", "test/acts_as_rdoc_test.rb", "test/acts_as_textile_test.rb", "test/acts_as_wikitext_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -25,20 +25,20 @@ Gem::Specification.new do |s|
     if current_version >= 3 then
       s.add_runtime_dependency(%q<activesupport>, [">= 2.1.0"])
       s.add_runtime_dependency(%q<activerecord>, [">= 2.1.0"])
-      s.add_runtime_dependency(%q<rdiscount>, [">= 1.2.7"])
+      s.add_runtime_dependency(%q<rdiscount>, [">= 1.2.7.1"])
       s.add_runtime_dependency(%q<RedCloth>, [">= 4.0.1"])
       s.add_runtime_dependency(%q<wikitext>, [">= 1.1.1"])
     else
       s.add_dependency(%q<activesupport>, [">= 2.1.0"])
       s.add_dependency(%q<activerecord>, [">= 2.1.0"])
-      s.add_dependency(%q<rdiscount>, [">= 1.2.7"])
+      s.add_dependency(%q<rdiscount>, [">= 1.2.7.1"])
       s.add_dependency(%q<RedCloth>, [">= 4.0.1"])
       s.add_dependency(%q<wikitext>, [">= 1.1.1"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 2.1.0"])
     s.add_dependency(%q<activerecord>, [">= 2.1.0"])
-    s.add_dependency(%q<rdiscount>, [">= 1.2.7"])
+    s.add_dependency(%q<rdiscount>, [">= 1.2.7.1"])
     s.add_dependency(%q<RedCloth>, [">= 4.0.1"])
     s.add_dependency(%q<wikitext>, [">= 1.1.1"])
   end

data/lib/acts/as_markup.rb

@@ -11,15 +11,15 @@ module ActiveRecord # :nodoc:
         
         ##
         # This allows you to specify columns you want to define as containing 
-        # Markdown, Textile or Wikitext content.
+        # 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> you will then
         # need to add an additional option of <tt>:language_column</tt>. When 
         # a value is accessed it will create the correct object (Markdown, Textile, 
-        # or Wikitext) based on the value of the language column. If any value 
-        # besides markdown, textile, or wikitext is supplied for the markup language 
-        # the text will pass through as a string.
+        # Wikitext or RDoc) based on the value of the language column. If any value 
+        # besides markdown, textile, wikitext, or RDoc is supplied for the markup 
+        # language the text will pass through as a string.
         # 
         # 
         # ==== Examples
@@ -58,13 +58,22 @@ module ActiveRecord # :nodoc:
             require 'wikitext'
             require_extensions 'wikitext'
             klass = 'WikitextString'
+          when :rdoc
+            require 'rdoc/markup/simple_markup'
+            require 'rdoc/markup/simple_markup/to_html'
+            require_extensions 'rdoc'
+            klass = 'RDocText'
           when :variable
             markdown_klass = get_markdown_class
             require 'redcloth'
             require 'wikitext'
+            require 'rdoc/markup/simple_markup'
+            require 'rdoc/markup/simple_markup/to_html'
             require_extensions 'wikitext'
+            require_extensions 'rdoc'
             textile_klass = 'RedCloth'
             wiki_klass = 'WikitextString'
+            rdoc_klass = 'RDocText'
           else
             raise ActsAsMarkup::UnsportedMarkupLanguage, "#{options[:langauge]} is not a currently supported markup language."
           end
@@ -74,7 +83,7 @@ module ActiveRecord # :nodoc:
               class_eval <<-EOV
                 def #{col.to_s}
                   if @#{col.to_s}
-                    if !self.#{col.to_s}_changed?
+                    unless self.#{col.to_s}_changed?
                       return @#{col.to_s}
                     end
                   end
@@ -96,6 +105,8 @@ module ActiveRecord # :nodoc:
                     @#{col.to_s} = #{textile_klass}.new(self['#{col.to_s}'].to_s)
                   when /wikitext/i
                     @#{col.to_s} = #{wiki_klass}.new(self['#{col.to_s}'].to_s)
+                  when /rdoc/i
+                    @#{col.to_s} = #{rdoc_klass}.new(self['#{col.to_s}'].to_s)
                   else
                     @#{col.to_s} = self['#{col.to_s}']
                   end
@@ -129,6 +140,14 @@ module ActiveRecord # :nodoc:
           acts_as_markup :language => :wikitext, :columns => columns
         end
         
+        ##
+        # This is a convenience method for 
+        # `<tt>acts_as_markup :language => :rdoc, :columns => [:body]</tt>`
+        #
+        def acts_as_rdoc(*columns)
+          acts_as_markup :language => :rdoc, :columns => columns
+        end
+        
         
         private
           def get_markdown_class
@@ -142,7 +161,7 @@ module ActiveRecord # :nodoc:
             end
           end
           def require_extensions(library)# :nodoc:
-            if %w(rdiscount maruku wikitext).include? library.to_s
+            if %w(rdiscount wikitext rdoc).include? library.to_s
               require "acts_as_markup/exts/#{library.to_s}"
             end
           end

data/lib/acts_as_markup/exts/rdoc.rb

@@ -0,0 +1,102 @@
+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.rb

@@ -2,7 +2,7 @@ require 'active_support'
 
 module ActsAsMarkup
   # :stopdoc:
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/test/acts_as_markup_test.rb

@@ -224,6 +224,54 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
       end
     end
     
+    context 'with a RDoc post' do
+      setup do
+        @rdoctext = "== RDoc Test Text"
+        @rdoc_post = VariablePost.create!(:title => 'Blah', :body => @rdoctext, :markup_language => 'RDoc')
+      end
+
+      should "have a RDocText object returned for the column value" do
+        assert_kind_of RDocText, @rdoc_post.body
+      end
+
+      should "return original RDoc text for a `to_s` method call on the column value" do
+        assert_equal @rdoctext, @rdoc_post.body.to_s
+      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)
+      end
+
+      context "changing value of RDoc field should return new RDoc object" do
+        setup do
+          @old_body = @rdoc_post.body
+          @rdoc_post.body = "http://www.example.com/"
+        end
+
+        should "still have an RDocText object but not the same object" do
+          assert_kind_of RDocText, @rdoc_post.body
+          assert_not_same @rdoc_post.body, @old_body 
+        end
+
+        should "return correct text for `to_s`" do
+          assert_equal "http://www.example.com/", @rdoc_post.body.to_s
+        end
+
+        should "return correct HTML for the `to_html` method" do
+          assert_match(/<a href="http:\/\/www.example.com">www.example.com<\/a>/, @rdoc_post.body.to_html)
+        end
+
+        teardown do
+          @old_body = nil
+        end
+      end
+
+      teardown do
+        @rdoctext, @rdoc_post = nil
+        Post.delete_all
+      end
+    end
+    
     context "with a plain text post" do
       setup do
         @plain_text = "Hahaha!!!"
@@ -322,7 +370,7 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
         assert_match(/[\n\s]*/, @post.body.to_html)
       end
       
-      should "have a RedCloth object returned for the column value" do
+      should "have a WikitextString object returned for the column value" do
         assert_kind_of WikitextString, @post.body
       end
       
@@ -332,6 +380,32 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
       end
     end
     
+    context 'with RDoc' do
+      setup do
+        class ::Post < ActiveRecord::Base
+          acts_as_rdoc :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 a blank string for `to_html` method' do
+        assert_match(/[\n\s]*/, @post.body.to_html)
+      end
+      
+      should "have a RDocText object returned for the column value" do
+        assert_kind_of RDocText, @post.body
+      end
+      
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
+    
     context 'with RDiscount Markdown' do
       setup do
         ActsAsMarkup.markdown_library = :rdiscount
@@ -424,6 +498,17 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
     end
   end
   
+  context 'acts_as_markup with bad markdown library' do
+    should 'raise exception when a non-supported library is set as the markdown library attribute on ActsAsMarkup' do
+      assert_raise ActsAsMarkup::UnsportedMarkdownLibrary do
+        ActsAsMarkup.markdown_library = :fake
+        class ::Post < ActiveRecord::Base
+          acts_as_markup :language => :markdown, :columns => [:body]
+        end
+      end
+    end
+  end
+  
   def teardown
     teardown_db
   end

data/test/acts_as_rdoc_test.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ActsAsRDocTest < ActsAsMarkupTestCase
+  context 'acts_as_rdoc' do
+    setup do
+      @rdoctext = "== RDoc Test Text"
+      class ::Post < ActiveRecord::Base
+        acts_as_rdoc :body
+      end
+      @post = Post.create!(:title => 'Blah', :body => @rdoctext)
+    end
+    
+    should "have a RDocText object returned for the column value" do
+      assert_kind_of RDocText, @post.body
+    end
+  
+    should "return original RDoc text for a `to_s` method call on the column value" do
+      assert_equal @rdoctext, @post.body.to_s
+    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>/, @post.body.to_html)
+    end
+  
+    context "changing value of RDoc field should return new RDoc object" do
+      setup do
+        @old_body = @post.body
+        @post.body = "http://www.example.com/"
+      end
+    
+      should "still have an RDocText object but not the same object" do
+        assert_kind_of RDocText, @post.body
+        assert_not_same @post.body, @old_body 
+      end
+    
+      should "return correct text for `to_s`" do
+        assert_equal "http://www.example.com/", @post.body.to_s
+      end
+    
+      should "return correct HTML for the `to_html` method" do
+        assert_match(/<a href="http:\/\/www.example.com">www.example.com<\/a>/, @post.body.to_html)
+      end
+    
+      teardown do
+        @old_body = nil
+      end
+    end
+    
+    teardown do
+      @rdoctext, @post = nil
+      Post.delete_all
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_markup
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Brian Landau
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-08 00:00:00 -04:00
+date: 2008-08-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.7
+        version: 1.2.7.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: RedCloth
@@ -82,6 +82,7 @@ files:
 - lib/acts/as_markup.rb
 - lib/acts_as_markup.rb
 - lib/acts_as_markup/exts/rdiscount.rb
+- lib/acts_as_markup/exts/rdoc.rb
 - lib/acts_as_markup/exts/string.rb
 - lib/acts_as_markup/exts/wikitext.rb
 - tasks/bones.rake
@@ -95,6 +96,7 @@ files:
 - tasks/test.rake
 - test/acts_as_markdown_test.rb
 - test/acts_as_markup_test.rb
+- test/acts_as_rdoc_test.rb
 - test/acts_as_textile_test.rb
 - test/acts_as_wikitext_test.rb
 - test/test_helper.rb
@@ -128,5 +130,6 @@ summary: Represent ActiveRecord Markdown, Textile, or Wiki text columns as Markd
 test_files: 
 - test/acts_as_markdown_test.rb
 - test/acts_as_markup_test.rb
+- test/acts_as_rdoc_test.rb
 - test/acts_as_textile_test.rb
 - test/acts_as_wikitext_test.rb