Class: WikiContent
- Inherits:
-
String
- Object
- String
- WikiContent
- Defined in:
- app/models/wiki_content.rb
Overview
Wiki content is just a string that can process itself with a chain of actions. The actions can modify wiki content so that certain parts of it are protected from being rendered by later actions.
When wiki content is rendered, it can be interrogated to find out which chunks were rendered. This means things like categories, wiki links, can be determined.
Exactly how wiki content is rendered is determined by a number of settings that are optionally passed in to a constructor. The current options are:
* :engine
=> The structural markup engine to use (Textile, Markdown, RDoc)
* :engine_opts
=> A list of options to pass to the markup engines (safe modes, etc)
* :pre_engine_actions
=> A list of render actions or chunks to be processed before the
markup engine is applied. By default this is:
Category, Include, URIChunk, WikiChunk::Link, WikiChunk::Word
* :post_engine_actions
=> A list of render actions or chunks to apply after the markup
engine. By default these are:
Literal::Pre, Literal::Tags
* :mode
=> How should the content be rendered? For normal display (:display),
publishing (:publish) or export (:export)?
AUTHOR: Mark Reid <mark @ threewordslong . com> CREATED: 15th May 2004 UPDATED: 22nd May 2004
Constant Summary collapse
- PRE_ENGINE_ACTIONS =
[ NoWiki, Category, Include, URIChunk, WikiChunk::Link, WikiChunk::Word ]
- POST_ENGINE_ACTIONS =
[ Literal::Pre, Literal::Tags ]
- DEFAULT_OPTS =
{ :pre_engine_actions => PRE_ENGINE_ACTIONS, :post_engine_actions => POST_ENGINE_ACTIONS, :engine => Engines::Textile, :engine_opts => [], :mode => [:display] }
Instance Attribute Summary collapse
-
#options ⇒ Object
readonly
Returns the value of attribute options.
-
#rendered ⇒ Object
readonly
Returns the value of attribute rendered.
-
#web ⇒ Object
readonly
Returns the value of attribute web.
Instance Method Summary collapse
-
#apply_type!(chunk_type) ⇒ Object
Find all the chunks of the given type in this content Each time the type’s pattern is matched, create a new chunk for it, and replace the occurance of the chunk in this content with its mask.
-
#find_chunks(chunk_type) ⇒ Object
Find all the chunks of the given types.
-
#initialize(revision, options = {}) ⇒ WikiContent
constructor
Create a new wiki content string from the given one.
-
#page_link(name, text) ⇒ Object
Call @web.page_link using current options.
-
#render!(chunk_types) ⇒ Object
Render this content using the specified actions.
Constructor Details
#initialize(revision, options = {}) ⇒ WikiContent
Create a new wiki content string from the given one. The options are explained at the top of this file.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'app/models/wiki_content.rb', line 56 def initialize(revision, = {}) @revision = revision @web = @revision.page.web # Deep copy of DEFAULT_OPTS to ensure that changes to PRE/POST_ENGINE_ACTIONS stay local @options = Marshal.load(Marshal.dump(DEFAULT_OPTS)).update() @options[:engine] = Engines::MAP[@web.markup] || Engines::Textile @options[:engine_opts] = (@web.safe_mode ? [:filter_html, :filter_styles] : []) @options[:pre_engine_actions].delete(WikiChunk::Word) if @web.brackets_only super(@revision.content) begin render!(@options[:pre_engine_actions] + [@options[:engine]] + @options[:post_engine_actions]) rescue => e @rendered = e. end end |
Instance Attribute Details
#options ⇒ Object (readonly)
Returns the value of attribute options.
52 53 54 |
# File 'app/models/wiki_content.rb', line 52 def @options end |
#rendered ⇒ Object (readonly)
Returns the value of attribute rendered.
52 53 54 |
# File 'app/models/wiki_content.rb', line 52 def rendered @rendered end |
#web ⇒ Object (readonly)
Returns the value of attribute web.
52 53 54 |
# File 'app/models/wiki_content.rb', line 52 def web @web end |
Instance Method Details
#apply_type!(chunk_type) ⇒ Object
Find all the chunks of the given type in this content Each time the type’s pattern is matched, create a new chunk for it, and replace the occurance of the chunk in this content with its mask.
99 100 101 102 103 104 |
# File 'app/models/wiki_content.rb', line 99 def apply_type!(chunk_type) self.gsub!( chunk_type.pattern ) do |match| @chunks << chunk_type.new($~) @chunks.last.mask(self) end end |
#find_chunks(chunk_type) ⇒ Object
Find all the chunks of the given types
82 83 84 |
# File 'app/models/wiki_content.rb', line 82 def find_chunks(chunk_type) rendered.select { |chunk| chunk.kind_of?(chunk_type) } end |
#page_link(name, text) ⇒ Object
Call @web.page_link using current options.
77 78 79 |
# File 'app/models/wiki_content.rb', line 77 def page_link(name, text) @web.make_link(name, text, @options) end |
#render!(chunk_types) ⇒ Object
Render this content using the specified actions.
87 88 89 90 91 92 93 |
# File 'app/models/wiki_content.rb', line 87 def render!(chunk_types) @chunks = [] chunk_types.each { |chunk_type| self.apply_type!(chunk_type) } @rendered = @chunks.map { |chunk| chunk.unmask(self) }.compact (@chunks - @rendered).each { |chunk| chunk.revert(self) } end |