vigetlabs-acts_as_markup 0.4.0 → 1.0.0

data/CHANGELOG

@@ -1,4 +1,8 @@
-== 0.4.0 / 2008-08-08
+== 1.0.0 / 2008-08-11
+
+* Add support for Maruku Markdown Library.
+
+== 0.4.0 / 2008-08-11
 
 * Add support for RDoc.
 
@@ -15,4 +19,4 @@
 * Initial Release
   * Support for Markdown and Textile markup languages.
   * `acts_as_markdown` and `acts_as_textile` convenience methods
-  * Support for BlueCloth, RDiscount and Ruyb PEG markdown processors.
+  * Support for BlueCloth, RDiscount and Ruby PEG markdown processors.

data/Manifest.txt

@@ -6,6 +6,7 @@ Rakefile
 acts_as_markup.gemspec
 lib/acts/as_markup.rb
 lib/acts_as_markup.rb
+lib/acts_as_markup/exts/maruku.rb
 lib/acts_as_markup/exts/rdiscount.rb
 lib/acts_as_markup/exts/rdoc.rb
 lib/acts_as_markup/exts/string.rb

data/README.rdoc

@@ -1,4 +1,4 @@
-= acts_as_markup
+= Acts as Markup
 
 by Brian Landau of Viget Labs <brian.landau@viget.com>
 
@@ -20,7 +20,7 @@ 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
+BlueCloth, RDiscount, Ruby PEG or Maruku. You specify which one you want to use by setting
 a config value in your environment.rb file:
 
     ActsAsMarkup.markdown_library = :bluecloth
@@ -108,6 +108,7 @@ The three options currently supported are:
 * BlueCloth
 * RDiscount[http://github.com/rtomayko/rdiscount]
 * {Ruby PEG}[http://github.com/rtomayko/rpeg-markdown/tree/master]
+* Maruku[http://maruku.rubyforge.org/]
 
 == INSTALL:
 

data/Rakefile

@@ -13,7 +13,7 @@ PROJ.name = 'acts_as_markup'
 PROJ.authors = 'Brian Landau'
 PROJ.email = 'brian.landau@viget.com'
 PROJ.url = 'http://viget.rubyforge.com/acts_as_markup'
-PROJ.description = "Represent ActiveRecord Markdown, Textile, or Wiki text columns as Markdown, Textile or Wikitext objects using various external libraries to convert to HTML."
+PROJ.description = "Represent ActiveRecord Markdown, Textile, Wiki text, RDoc columns as Markdown, Textile Wikitext, RDoc objects using various external libraries to convert to HTML."
 PROJ.rubyforge.name = 'viget'
 PROJ.version = ActsAsMarkup::VERSION
 PROJ.rdoc.include = %w(^lib/ LICENSE CHANGELOG README\.rdoc)

data/acts_as_markup.gemspec

@@ -1,21 +1,21 @@
 Gem::Specification.new do |s|
   s.name = %q{acts_as_markup}
-  s.version = "0.4.0"
+  s.version = "1.0.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-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.description = %q{Represent ActiveRecord Markdown, Textile, Wiki text, RDoc columns as Markdown, Textile Wikitext, RDoc 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/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.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/maruku.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"]
   s.require_paths = ["lib"]
   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.summary = %q{Represent ActiveRecord Markdown, Textile, Wiki text, RDoc columns as Markdown, Textile Wikitext, RDoc 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_rdoc_test.rb", "test/acts_as_textile_test.rb", "test/acts_as_wikitext_test.rb"]
 
   if s.respond_to? :specification_version then

data/lib/acts/as_markup.rb

@@ -9,7 +9,6 @@ module ActiveRecord # :nodoc:
       
       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.
@@ -116,7 +115,6 @@ module ActiveRecord # :nodoc:
           end
         end
         
-        ##
         # This is a convenience method for 
         # `<tt>acts_as_markup :language => :markdown, :columns => [:body]</tt>`
         # 
@@ -124,7 +122,6 @@ module ActiveRecord # :nodoc:
           acts_as_markup :language => :markdown, :columns => columns
         end
         
-        ##
         # This is a convenience method for 
         # `<tt>acts_as_markup :language => :textile, :columns => [:body]</tt>`
         #
@@ -132,7 +129,6 @@ module ActiveRecord # :nodoc:
           acts_as_markup :language => :textile, :columns => columns
         end
         
-        ##
         # This is a convenience method for 
         # `<tt>acts_as_markup :language => :wikitext, :columns => [:body]</tt>`
         #
@@ -140,7 +136,6 @@ 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>`
         #
@@ -160,8 +155,9 @@ module ActiveRecord # :nodoc:
               raise ActsAsMarkup::UnsportedMarkdownLibrary, "#{ActsAsMarkup.markdown_library} is not currently supported."
             end
           end
+          
           def require_extensions(library)# :nodoc:
-            if %w(rdiscount wikitext rdoc).include? library.to_s
+            if %w(rdiscount maruku wikitext rdoc).include? library.to_s
               require "acts_as_markup/exts/#{library.to_s}"
             end
           end

data/lib/acts_as_markup/exts/maruku.rb

@@ -0,0 +1,68 @@
+require 'maruku'
+
+class Maruku
+  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
+	
+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)
+    		e = []
+    		array.each do |c|
+    			method = c.kind_of?(MDElement) ? 
+    			   "to_html_#{c.node_type}" : "to_xml"
+
+    			if not c.respond_to?(method)
+    				#raise "Object does not answer to #{method}: #{c.class} #{c.inspect}"
+    				next
+    			end
+
+    			h =  c.send(method)
+
+    			if h.nil?
+    				raise "Nil html created by method  #{method}:\n#{h.inspect}\n"+
+    				" for object #{c.inspect[0,300]}"
+    			end
+
+    			if h.kind_of?Array
+    				e = e + h #h.each do |hh| e << hh end
+    			else
+    				e << h
+    			end
+    		end
+    		e
+    	end
+
+    end
+  end
+end

data/lib/acts_as_markup/exts/rdiscount.rb

@@ -1,6 +1,7 @@
 require 'rdiscount'
 
 class RDiscount
+  # Used to get the original Markdown text.
   def to_s
     self.text
   end

data/lib/acts_as_markup/exts/rdoc.rb

@@ -3,9 +3,9 @@ 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
@@ -31,21 +31,21 @@ class RDocWithHyperlinkToHtml < SM::ToHtml
     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]
-  #
+  #    <label>[url]
+  # 
   def handle_special_TIDYLINK(special)
     text = special.text
     unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/ 
@@ -58,7 +58,6 @@ class RDocWithHyperlinkToHtml < SM::ToHtml
 
 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

data/lib/acts_as_markup/exts/wikitext.rb

@@ -1,6 +1,5 @@
 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.

data/lib/acts_as_markup.rb

@@ -2,7 +2,7 @@ require 'active_support'
 
 module ActsAsMarkup
   # :stopdoc:
-  VERSION = '0.4.0'
+  VERSION = '1.0.0'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:
@@ -22,7 +22,9 @@ module ActsAsMarkup
                     :bluecloth => {:class_name => "BlueCloth",
                                    :lib_name   => "bluecloth"},
                     :rpeg      => {:class_name => "PEGMarkdown",
-                                   :lib_name   => "peg_markdown"} }
+                                   :lib_name   => "peg_markdown"},
+                    :maruku    => {:class_name => "Maruku",
+                                   :lib_name   => "maruku"} }
   
   @@markdown_library = DEFAULT_MAKRDOWN_LIB
   mattr_accessor :markdown_library

data/test/acts_as_markdown_test.rb

@@ -24,7 +24,7 @@ class ActsAsMarkdownTest < ActsAsMarkupTestCase
       end
 
       should "return formated html for a `to_html` method call on the column value" do
-        assert_match(/<h2>\s*Markdown Test Text\s*<\/h2>/, @post.body.to_html)
+        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
@@ -75,7 +75,7 @@ class ActsAsMarkdownTest < ActsAsMarkupTestCase
       end
 
       should "return formated html for a `to_html` method call on the column value" do
-        assert_match(/<h2>\s*Markdown Test Text\s*<\/h2>/, @post.body.to_html)
+        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
@@ -126,7 +126,7 @@ class ActsAsMarkdownTest < ActsAsMarkupTestCase
       end
 
       should "return formated html for a `to_html` method call on the column value" do
-        assert_match(/<h2>\s*Markdown Test Text\s*<\/h2>/, @post.body.to_html)
+        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
@@ -158,7 +158,58 @@ class ActsAsMarkdownTest < ActsAsMarkupTestCase
         Post.delete_all
       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 "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 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

data/test/acts_as_markup_test.rb

@@ -33,7 +33,7 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
     end
   
     should "return formated html for a `to_html` method call on the column value" do
-      assert_match(/<h2>\s*Markdown Test Text\s*<\/h2>/, @markdown_post.body.to_html)
+      assert_match(/<h2(\s\w+\=['"]\w*['"])*\s*>\s*Markdown Test Text\s*<\/h2>/, @markdown_post.body.to_html)
       assert_match(/<h2>Textile Test Text<\/h2>/, @textile_post.body.to_html)
     end
   
@@ -97,7 +97,7 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
       end
 
       should "return formated html for a `to_html` method call on the column value" do
-        assert_match(/<h2>\s*Markdown Test Text\s*<\/h2>/, @markdown_post.body.to_html)
+        assert_match(/<h2(\s\w+\=['"]\w*['"])*\s*>\s*Markdown Test Text\s*<\/h2>/, @markdown_post.body.to_html)
       end
 
       context "changing value of markup field should return new markup object" do
@@ -486,6 +486,33 @@ class ActsAsMarkupTest < ActsAsMarkupTestCase
         Post.delete_all
       end
     end
+    
+    context 'with Maruku Markdown' do
+      setup do
+        ActsAsMarkup.markdown_library = :maruku
+        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 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 Maruku, @post.body
+      end
+      
+      teardown do
+        @post = nil
+        Post.delete_all
+      end
+    end
   end
   
   context 'acts_as_markup with bad language name' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vigetlabs-acts_as_markup
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Brian Landau
@@ -57,7 +57,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.1.1
     version: 
-description: Represent ActiveRecord Markdown, Textile, or Wiki text columns as Markdown, Textile or Wikitext objects using various external libraries to convert to HTML.
+description: Represent ActiveRecord Markdown, Textile, Wiki text, RDoc columns as Markdown, Textile Wikitext, RDoc objects using various external libraries to convert to HTML.
 email: brian.landau@viget.com
 executables: []
 
@@ -76,6 +76,7 @@ files:
 - acts_as_markup.gemspec
 - lib/acts/as_markup.rb
 - lib/acts_as_markup.rb
+- lib/acts_as_markup/exts/maruku.rb
 - lib/acts_as_markup/exts/rdiscount.rb
 - lib/acts_as_markup/exts/rdoc.rb
 - lib/acts_as_markup/exts/string.rb
@@ -121,7 +122,7 @@ rubyforge_project: viget
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Represent ActiveRecord Markdown, Textile, or Wiki text columns as Markdown, Textile or Wikitext objects using various external libraries to convert to HTML
+summary: Represent ActiveRecord Markdown, Textile, Wiki text, RDoc columns as Markdown, Textile Wikitext, RDoc objects using various external libraries to convert to HTML
 test_files: 
 - test/acts_as_markdown_test.rb
 - test/acts_as_markup_test.rb