module ActsAsMarkup::ActiveRecordExtension::ClassMethods
Public Instance Methods
This is a convenience method for ‘acts_as_markup :language => :markdown, :columns => [:body]
` Additional options can be given at the end, if necessary.
# File lib/acts_as_markup/active_record_extension.rb, line 83 def acts_as_markdown(*columns) options = columns.extract_options! acts_as_markup options.merge(:language => :markdown, :columns => columns) end
This allows you to specify columns you want to define as containing Markdown, Textile, or RDoc content. Then you can simply call .to_html
method on the attribute.
You can also specify the language as :variable
. The language used to process the column will be based on another column. By default a column named “markup_language
” is used, but this can be changed by providing a :language_column
option. When a value is accessed it will create the correct object (Markdown, Textile, or RDoc) based on the value of the language column. If any value besides markdown, textile, 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 :markdown_options
, :textile_options
. 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 :variable
. 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
# File lib/acts_as_markup/active_record_extension.rb, line 67 def acts_as_markup(options) options.reverse_merge!(:language_column => :markup_language) include InstanceMethods unless options[:language].to_sym == :variable define_markup_columns_reader_methods(options) else define_variable_markup_columns_reader_methods(options) end end
This is a convenience method for ‘acts_as_markup :language => :rdoc, :columns => [:body]
` Additional options can be given at the end, if necessary.
# File lib/acts_as_markup/active_record_extension.rb, line 101 def acts_as_rdoc(*columns) options = columns.extract_options! acts_as_markup options.merge(:language => :rdoc, :columns => columns) end
This is a convenience method for ‘acts_as_markup :language => :textile, :columns => [:body]
` Additional options can be given at the end, if necessary.
# File lib/acts_as_markup/active_record_extension.rb, line 92 def acts_as_textile(*columns) options = columns.extract_options! acts_as_markup options.merge(:language => :textile, :columns => columns) end
Private Instance Methods
# File lib/acts_as_markup/active_record_extension.rb, line 108 def define_markup_columns_reader_methods(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(options[:language]).new(self[col].to_s, *markup_options)) end end end end
# File lib/acts_as_markup/active_record_extension.rb, line 122 def define_variable_markup_columns_reader_methods(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_class(:markdown).new string_for_markup_column(col), *(options[:markdown_options] || []) when /textile/i markup_class(:textile).new string_for_markup_column(col), *(options[:textile_options] || []) when /rdoc/i markup_class(:rdoc).new string_for_markup_column(col) else String(self[col]) end) end end end