Class: Govspeak::Document
- Inherits:
-
Object
- Object
- Govspeak::Document
- Defined in:
- lib/govspeak.rb
Constant Summary collapse
- Parser =
Kramdown::Parser::Govuk
- PARSER_CLASS_NAME =
Parser.name.split("::").last
- UUID_REGEX =
/^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.freeze
- NEW_PARAGRAPH_LOOKBEHIND =
%q{(?<=\A|\n\n|\r\n\r\n)}.freeze
Class Attribute Summary collapse
-
.extensions ⇒ Object
readonly
Returns the value of attribute extensions.
Instance Attribute Summary collapse
-
#attachments ⇒ Object
readonly
Returns the value of attribute attachments.
-
#contacts ⇒ Object
readonly
Returns the value of attribute contacts.
-
#images ⇒ Object
Returns the value of attribute images.
-
#links ⇒ Object
readonly
Returns the value of attribute links.
-
#locale ⇒ Object
readonly
Returns the value of attribute locale.
Class Method Summary collapse
- .devolved_options ⇒ Object
- .extension(title, regexp = nil, &block) ⇒ Object
- .surrounded_by(open, close = nil) ⇒ Object
- .to_html(source, options = {}) ⇒ Object
- .wrap_with_div(class_name, character, parser = Kramdown::Document) ⇒ Object
Instance Method Summary collapse
- #extract_contact_content_ids ⇒ Object
- #extracted_links(website_root: nil) ⇒ Object
- #headers ⇒ Object
-
#initialize(source, options = {}) ⇒ Document
constructor
A new instance of Document.
- #insert_strong_inside_p(body, parser = Govspeak::Document) ⇒ Object
- #preprocess(source) ⇒ Object
- #remove_forbidden_characters(source) ⇒ Object
-
#render_image(image) ⇒ Object
As of version 1.12.0 of Kramdown the block elements (div & figcaption) inside this html block will have it’s < > converted into HTML Entities when ever this code is used inside block level elements.
- #structured_headers ⇒ Object
- #to_html ⇒ Object
- #to_liquid ⇒ Object
- #to_text ⇒ Object
- #valid?(validation_options = {}) ⇒ Boolean
Constructor Details
#initialize(source, options = {}) ⇒ Document
Returns a new instance of Document.
51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/govspeak.rb', line 51 def initialize(source, = {}) = .dup.deep_symbolize_keys @source = source ? source.dup : "" @images = .delete(:images) || [] @attachments = Array.wrap(.delete(:attachments)) @links = Array.wrap(.delete(:links)) @contacts = Array.wrap(.delete(:contacts)) @locale = .fetch(:locale, "en") @options = { input: PARSER_CLASS_NAME, sanitize: true }.merge() @options[:entity_output] = :symbolic end |
Class Attribute Details
.extensions ⇒ Object (readonly)
Returns the value of attribute extensions.
48 49 50 |
# File 'lib/govspeak.rb', line 48 def extensions @extensions end |
Instance Attribute Details
#attachments ⇒ Object (readonly)
Returns the value of attribute attachments.
41 42 43 |
# File 'lib/govspeak.rb', line 41 def @attachments end |
#contacts ⇒ Object (readonly)
Returns the value of attribute contacts.
41 42 43 |
# File 'lib/govspeak.rb', line 41 def contacts @contacts end |
#images ⇒ Object
Returns the value of attribute images.
40 41 42 |
# File 'lib/govspeak.rb', line 40 def images @images end |
#links ⇒ Object (readonly)
Returns the value of attribute links.
41 42 43 |
# File 'lib/govspeak.rb', line 41 def links @links end |
#locale ⇒ Object (readonly)
Returns the value of attribute locale.
41 42 43 |
# File 'lib/govspeak.rb', line 41 def locale @locale end |
Class Method Details
.devolved_options ⇒ Object
303 304 305 306 307 308 309 310 |
# File 'lib/govspeak.rb', line 303 def self. { "scotland" => "Scotland", "england" => "England", "england-wales" => "England and Wales", "northern-ireland" => "Northern Ireland", "wales" => "Wales", "london" => "London" } end |
.extension(title, regexp = nil, &block) ⇒ Object
124 125 126 127 |
# File 'lib/govspeak.rb', line 124 def self.extension(title, regexp = nil, &block) regexp ||= %r${::#{title}}(.*?){:/#{title}}$m @extensions << [title, regexp, block] end |
.surrounded_by(open, close = nil) ⇒ Object
129 130 131 132 133 134 135 136 137 |
# File 'lib/govspeak.rb', line 129 def self.surrounded_by(open, close = nil) open = Regexp::escape(open) if close close = Regexp::escape(close) %r+(?:\r|\n|^)#{open}(.*?)#{close} *(\r|\n|$)?+m else %r+(?:\r|\n|^)#{open}(.*?)#{open}? *(\r|\n|$)+m end end |
.to_html(source, options = {}) ⇒ Object
43 44 45 |
# File 'lib/govspeak.rb', line 43 def self.to_html(source, = {}) new(source, ).to_html end |
.wrap_with_div(class_name, character, parser = Kramdown::Document) ⇒ Object
139 140 141 142 143 144 |
# File 'lib/govspeak.rb', line 139 def self.wrap_with_div(class_name, character, parser = Kramdown::Document) extension(class_name, surrounded_by(character)) { |body| content = parser ? parser.new("#{body.strip}\n").to_html : body.strip %{\n<div class="#{class_name}">\n#{content}</div>\n} } end |
Instance Method Details
#extract_contact_content_ids ⇒ Object
100 101 102 103 104 105 |
# File 'lib/govspeak.rb', line 100 def extract_contact_content_ids _, regex = self.class.extensions.find { |(title)| title == "Contact" } return [] unless regex @source.scan(regex).map(&:first).uniq.select { |id| id.match(UUID_REGEX) } end |
#extracted_links(website_root: nil) ⇒ Object
96 97 98 |
# File 'lib/govspeak.rb', line 96 def extracted_links(website_root: nil) Govspeak::LinkExtractor.new(self, website_root: website_root).call end |
#headers ⇒ Object
88 89 90 |
# File 'lib/govspeak.rb', line 88 def headers Govspeak::HeaderExtractor.convert(kramdown_doc).first end |
#insert_strong_inside_p(body, parser = Govspeak::Document) ⇒ Object
146 147 148 |
# File 'lib/govspeak.rb', line 146 def insert_strong_inside_p(body, parser = Govspeak::Document) parser.new(body.strip).to_html.sub(/^<p>(.*)<\/p>$/, "<p><strong>\\1</strong></p>") end |
#preprocess(source) ⇒ Object
107 108 109 110 111 112 113 114 115 116 |
# File 'lib/govspeak.rb', line 107 def preprocess(source) source = Govspeak::BlockquoteExtraQuoteRemover.remove(source) source = remove_forbidden_characters(source) self.class.extensions.each do |_, regexp, block| source.gsub!(regexp) { instance_exec(*Regexp.last_match.captures, &block) } end source end |
#remove_forbidden_characters(source) ⇒ Object
118 119 120 121 122 |
# File 'lib/govspeak.rb', line 118 def remove_forbidden_characters(source) # These are characters that are not deemed not suitable for # markup: https://www.w3.org/TR/unicode-xml/#Charlist source.gsub(Sanitize::REGEX_UNSUITABLE_CHARS, "") end |
#render_image(image) ⇒ Object
As of version 1.12.0 of Kramdown the block elements (div & figcaption) inside this html block will have it’s < > converted into HTML Entities when ever this code is used inside block level elements.
To resolve this we have a post-processing task that will convert this back into HTML (I know - it’s ugly). The way we could resolve this without ugliness would be to output only inline elements which rules out div and figcaption
This issue is not considered a bug by kramdown: github.com/gettalong/kramdown/issues/191
263 264 265 266 267 268 269 270 271 |
# File 'lib/govspeak.rb', line 263 def render_image(image) id_attr = image.id ? %{ id="attachment_#{image.id}"} : "" lines = [] lines << %{<figure#{id_attr} class="image embedded">} lines << %{<div class="img"><img src="#{encode(image.url)}" alt="#{encode(image.alt_text)}"></div>} lines << image. if image. lines << "</figure>" lines.join end |
#structured_headers ⇒ Object
92 93 94 |
# File 'lib/govspeak.rb', line 92 def structured_headers Govspeak::StructuredHeaderExtractor.new(self).call end |
#to_html ⇒ Object
64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/govspeak.rb', line 64 def to_html @to_html ||= begin html = if @options[:sanitize] HtmlSanitizer.new(kramdown_doc.to_html).sanitize else kramdown_doc.to_html end Govspeak::PostProcessor.process(html, self) end end |
#to_liquid ⇒ Object
76 77 78 |
# File 'lib/govspeak.rb', line 76 def to_liquid to_html end |
#to_text ⇒ Object
80 81 82 |
# File 'lib/govspeak.rb', line 80 def to_text HTMLEntities.new.decode(to_html.gsub(/(?:<[^>]+>|\s)+/, " ").strip) end |
#valid?(validation_options = {}) ⇒ Boolean
84 85 86 |
# File 'lib/govspeak.rb', line 84 def valid?( = {}) Govspeak::HtmlValidator.new(@source, ).valid? end |