acts_as_markup 1.3.4 → 1.4.0

data/.gitignore

@@ -1,4 +0,0 @@
-coverage
-doc
-pkg
-docs

data/lib/acts/as_markup.rb

@@ -1,204 +0,0 @@
-require 'active_record'
-
-module ActiveRecord # :nodoc:
-  module Acts # :nodoc:
-    module AsMarkup
-      def self.included(base) # :nodoc:
-        base.extend(ClassMethods)
-      end
-      
-      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, wikitext, 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>:wikitext_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 => :wikitext, :columns => [:body], :wikitext_options => [ { :space_to_underscore => true } ]
-        #     end
-        #     
-        # 
-        def acts_as_markup(options)
-          case options[:language].to_sym
-          when :markdown, :textile, :wikitext, :rdoc
-            klass = require_library_and_get_class(options[:language].to_sym)
-          when :variable
-            markup_klasses = {}
-            [:textile, :wikitext, :rdoc, :markdown].each do |language|
-              markup_klasses[language] = require_library_and_get_class(language)
-            end
-            options[:language_column] ||= :markup_language
-          else
-            raise ActsAsMarkup::UnsupportedMarkupLanguage, "#{options[:langauge]} is not a currently supported markup language."
-          end
-          
-          unless options[:language].to_sym == :variable
-            markup_options = options["#{options[:language]}_options".to_sym] || []
-            options[:columns].each do |col|
-              define_method col do
-                if instance_variable_defined?("@#{col}")
-                  unless send("#{col}_changed?")
-                    return instance_variable_get("@#{col}")
-                  end
-                end
-                instance_variable_set("@#{col}", klass.new(self[col].to_s, *markup_options))
-              end
-            end
-          else
-            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_klasses[:markdown].new self[col].to_s, *(options[:markdown_options] || [])
-                when /textile/i
-                  markup_klasses[:textile].new self[col].to_s, *(options[:textile_options] || [])
-                when /wikitext/i
-                  markup_klasses[:wikitext].new self[col].to_s, *(options[:wikitext_options] || [])
-                when /rdoc/i
-                  markup_klasses[:rdoc].new self[col].to_s
-                else
-                  self[col]
-                end)
-              end
-            end
-          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 => :wikitext, :columns => [:body]</tt>`
-        # Additional options can be given at the end, if necessary.
-        #
-        def acts_as_wikitext(*columns)
-          options = columns.extract_options!
-          acts_as_markup options.merge(:language => :wikitext, :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 require_extensions(library)# :nodoc:
-            if ActsAsMarkup::LIBRARY_EXTENSIONS.include? library.to_s
-              require "#{ActsAsMarkup::LIBPATH}/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 :wikitext
-              require 'wikitext'
-              require_extensions 'wikitext'
-              return WikitextString
-            when :rdoc
-              require 'rdoc/markup/simple_markup'
-              require 'rdoc/markup/simple_markup/to_html'
-              require_extensions 'rdoc'
-              return RDocText
-            else
-              return String
-            end
-          end
-        
-      end
-    end
-  end
-end
-
-ActiveRecord::Base.send :include, ActiveRecord::Acts::AsMarkup

data/test/acts_as_wikitext_test.rb

@@ -1,77 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper'
-
-class ActsAsWikitextTest < ActsAsMarkupTestCase
-  context 'acts_as_wikitext' do
-    setup do
-      @wikitext = "== Wikitext Test Text =="
-      class ::Post < ActiveRecord::Base
-        acts_as_wikitext :body
-      end
-      @post = Post.create!(:title => 'Blah', :body => @wikitext)
-    end
-    
-    should "have a WikitextString object returned for the column value" do
-      assert_kind_of WikitextString, @post.body
-    end
-  
-    should "return original wikitext text for a `to_s` method call on the column value" do
-      assert_equal @wikitext, @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>Wikitext Test Text<\/h2>/, @post.body.to_html)
-    end
-    
-    should "underscore spaces in URLs" do
-      @post.body = "[[foo bar]]"
-      assert_match(/<a href="\/wiki\/foo_bar">foo bar<\/a>/, @post.body.to_html)
-    end
-    
-    context "changing value of wikitext field should return new wikitext object" do
-      setup do
-        @old_body = @post.body
-        @post.body = "`@count = 20`"
-      end
-    
-      should "still have an WikitextString object but not the same object" do
-        assert_kind_of WikitextString, @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(/<p><code>\@count\s\=\s20<\/code><\/p>/, @post.body.to_html)
-      end
-    
-      teardown do
-        @old_body = nil
-      end
-    end
-    
-    teardown do
-      @wikitext, @post = nil
-      Post.delete_all
-    end
-  end
-  
-  context 'acts_as_wikitext with options' do
-    setup do
-      class ::Post
-        acts_as_wikitext :body, :wikitext_options => [ { :space_to_underscore => false } ]
-      end
-      @post = Post.new(:title => 'Blah')
-    end
-    
-    should "not underscore spaces in URLs because of :space_to_underscore option" do
-      @post.body = "[[foo bar]]"
-      assert_match(/<a href="\/wiki\/foo%20bar">foo bar<\/a>/, @post.body.to_html)
-    end
-  end
-end