Skip to content

Create a mixin module from renderer class #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lfdebrux wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create a mixin module from renderer class #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/govuk_markdown.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
require_relative "./govuk_markdown/version"
require_relative "./govuk_markdown/preprocessor"
require_relative "./govuk_markdown/renderer"
require_relative "./govuk_markdown/renderer/mixin"

module GovukMarkdown
def self.render(markdown, govuk_options = {})
Expand Down
97 changes: 4 additions & 93 deletions lib/govuk_markdown/renderer.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,104 +1,15 @@
module GovukMarkdown
class Renderer < ::Redcarpet::Render::HTML
include Redcarpet::Render::SmartyPants
autoload :Mixin, "govuk_markdown/renderer/mixin"

include ::Redcarpet::Render::SmartyPants
include Mixin

def initialize(govuk_options, options = {})
@headings_start_with = govuk_options[:headings_start_with]
@strip_front_matter = govuk_options[:strip_front_matter]

super options
end

def table(header, body)
<<~HTML
<table class='govuk-table'>
<thead class='govuk-table__head'>
#{header}
</thead>
<tbody class='govuk-table__body'>
#{body}
</tbody>
</table>
HTML
end

def table_row(content)
<<~HTML
<tr class='govuk-table__row'>
#{content}
</tr>
HTML
end

def table_cell(content, _alignment, header)
if header
<<~HTML
<th class='govuk-table__header'>
#{content}
</th>
HTML
else
<<~HTML
<td class='govuk-table__cell'>
#{content}
</td>
HTML
end
end

def header(text, header_level)
valid_header_sizes = %w[xl l m s].freeze

start_size = valid_header_sizes.include?(@headings_start_with) ? @headings_start_with : "xl"

start_size_index = valid_header_sizes.find_index(start_size)

header_size = valid_header_sizes[start_size_index + header_level - 1] || "s"

id_attribute = @options[:with_toc_data] ? " id=\"#{text.parameterize}\"" : ""
<<~HTML
<h#{header_level}#{id_attribute} class="govuk-heading-#{header_size}">#{text}</h#{header_level}>
HTML
end

def paragraph(text)
<<~HTML
<p class="govuk-body-m">#{text}</p>
HTML
end

def list(contents, list_type)
case list_type
when :unordered
<<~HTML
<ul class="govuk-list govuk-list--bullet">
#{contents}
</ul>
HTML
when :ordered
<<~HTML
<ol class="govuk-list govuk-list--number">
#{contents}
</ol>
HTML
else
raise "Unexpected type #{list_type.inspect}"
end
end

def hrule
<<~HTML
<hr class="govuk-section-break govuk-section-break--xl govuk-section-break--visible">
HTML
end

def preprocess(document)
Preprocessor
.new(document)
.inject_inset_text
.inject_details
.strip_front_matter(@strip_front_matter)
.output
end
end
end
97 changes: 97 additions & 0 deletions lib/govuk_markdown/renderer/mixin.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
module GovukMarkdown
# Renderer::Mixin overrides methods in Redcarpet::Render::HTML.
# See `GovukMarkdown::Renderer` for an example of how to include it.
module Renderer::Mixin
def table(header, body)
<<~HTML
<table class='govuk-table'>
<thead class='govuk-table__head'>
#{header}
</thead>
<tbody class='govuk-table__body'>
#{body}
</tbody>
</table>
HTML
end

def table_row(content)
<<~HTML
<tr class='govuk-table__row'>
#{content}
</tr>
HTML
end

def table_cell(content, _alignment, header)
if header
<<~HTML
<th class='govuk-table__header'>
#{content}
</th>
HTML
else
<<~HTML
<td class='govuk-table__cell'>
#{content}
</td>
HTML
end
end

def header(text, header_level)
valid_header_sizes = %w[xl l m s].freeze

start_size = valid_header_sizes.include?(@headings_start_with) ? @headings_start_with : "xl"

start_size_index = valid_header_sizes.find_index(start_size)

header_size = valid_header_sizes[start_size_index + header_level - 1] || "s"

id_attribute = @options[:with_toc_data] ? " id=\"#{text.parameterize}\"" : ""
<<~HTML
<h#{header_level}#{id_attribute} class="govuk-heading-#{header_size}">#{text}</h#{header_level}>
HTML
end

def paragraph(text)
<<~HTML
<p class="govuk-body-m">#{text}</p>
HTML
end

def list(contents, list_type)
case list_type
when :unordered
<<~HTML
<ul class="govuk-list govuk-list--bullet">
#{contents}
</ul>
HTML
when :ordered
<<~HTML
<ol class="govuk-list govuk-list--number">
#{contents}
</ol>
HTML
else
raise "Unexpected type #{list_type.inspect}"
end
end

def hrule
<<~HTML
<hr class="govuk-section-break govuk-section-break--xl govuk-section-break--visible">
HTML
end

def preprocess(document)
Preprocessor
.new(document)
.inject_inset_text
.inject_details
.strip_front_matter(@strip_front_matter)
.output
end
end
end