Repository: govuk_content_block_tools

A Ruby Gem that renders GOV.UK Publishing Content Blocks in a consistent way

• GitHub: govuk_content_block_tools
• Ownership: #govuk-publishing-content-modelling-dev
• Category: Gems

README

A suite of tools for working with GOV.UK Content Blocks

Installation

Install the gem

gem install content_block_tools

or add it to your Gemfile

gem "content_block_tools"

Usage

Finding embed code

To find embed code in a block of text, use ContentBlockReference.find_all_in_document:

content = "Hello - here is a embed code {{embed:content_block_email_address:be24ee44-b636-4a3e-b979-0da27b4a8e62}}"
ContentBlockReference.find_all_in_document(content)
# =>
#[#<data ContentBlockTools::ContentBlockReference
#  document_type="content_block_email_address",
#  content_id="be24ee44-b636-4a3e-b979-0da27b4a8e62",
#  embed_code="{{embed:content_block_email_address:be24ee44-b636-4a3e-b979-0da27b4a8e62}}">]

Rendering a content block

To render a content block, you can initialize the content block like so:

content_block = ContentBlockTools::ContentBlock.new(
  document_type: "something",
  content_id: "some uuid",
  title: "Title",
  details: { some: "hash"},
)

Then call render:

content_block.render
#=> {HTML representation of content block}

For more information, see the Documentation

License

The gem is available as open source under the terms of the MIT License.