content_block_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 342e7145710ce25e142f4b22f5b16ec7d974a205bd0f7ee2926c992b6687ebc0
+  data.tar.gz: 5a0df078972acd5e743b9b50bcd98d4297b0ac0f1a4f0b5d4f51962981012498
+SHA512:
+  metadata.gz: 62f995e4d2520741e4a4cbe83a2e9083bbcbfd592a6acdc4352f7e27fdd964949bd90c1615965d70fa22dc93b62c5f0e9fccaa8a1de5ea5b444d37b08aaf4b92
+  data.tar.gz: 664d55f226662f74055c421409244ded66fd2b207c4915b7bbbd49593a2c7fc6c1e90043befed4302f51f7d4d3bfbe52d12d493c7bd560a8dbb369bb31541357

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: daily

data/.github/pull_request_template.md

@@ -0,0 +1 @@
+This repo is owned by the content modelling team. Please let us know in #govuk-publishing-content-modelling-dev when you raise any PRs.

data/.github/workflows/autorelease.yml

@@ -0,0 +1,10 @@
+on:
+  workflow_dispatch: {}
+  schedule:
+    - cron: '15 9 * * 1-5' # 9:15am UTC, Mon-Fri.
+
+jobs:
+  autorelease:
+    uses: alphagov/govuk-infrastructure/.github/workflows/autorelease-rubygem.yml@main
+    secrets:
+      GH_TOKEN: ${{ secrets.GOVUK_CI_GITHUB_API_TOKEN }}

data/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  codeql-sast:
+    name: CodeQL SAST scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/codeql-analysis.yml@main
+    permissions:
+      security-events: write
+
+  dependency-review:
+    name: Dependency Review scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/dependency-review.yml@main
+
+  # This matrix job runs the test suite against multiple Ruby versions
+  test_matrix:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [3.2, 3.3]
+    runs-on: ubuntu-latest
+    env:
+      GOVUK_CONTENT_SCHEMAS_PATH: vendor/publishing-api/content_schemas
+    steps:
+      - uses: actions/checkout@v4
+      - name: Checkout Publishing API for content schemas
+        uses: actions/checkout@v4
+        with:
+          repository: alphagov/publishing-api
+          ref: main
+          path: vendor/publishing-api
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+
+  publish:
+    needs: test_matrix
+    if: ${{ github.ref == 'refs/heads/main' }}
+    permissions:
+      contents: write
+    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yml@main
+    secrets:
+      GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+/.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  rubocop-govuk:
+    - config/default.yml

data/.ruby-version

@@ -0,0 +1 @@
+3.2.4

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+- We use the [GOV.UK versioning guidelines](https://docs.publishing.service.gov.uk/manual/publishing-a-ruby-gem.html#versioning).
+- Mark breaking changes with `BREAKING:`. Be sure to include instructions on how applications should be upgraded.
+- Include a link to your pull request.
+- Don't include changes that are purely internal. The CHANGELOG should be a
+  useful summary for people upgrading their application, not a replication
+  of the commit log.
+
+## 0.1.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+ruby File.read(".ruby-version").strip unless ENV["CI"]
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (C) 2024 Crown Copyright (Government Digital Service)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Content Block Tools
+
+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`:
+
+```ruby
+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:
+
+```ruby
+content_block = ContentBlockTools::ContentBlock.new(
+  document_type: "something",
+  content_id: "some uuid",
+  title: "Title",
+  details: { some: "hash"},
+)
+```
+
+Then call `render`:
+
+```ruby
+content_block.render
+#=> {HTML representation of content block}
+```
+
+For more information, see the [Documentation](https://www.rubydoc.info/github/alphagov/content_block_tools)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'content_block_tools'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/content_block_tools.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "content_block_tools/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "content_block_tools"
+  spec.version       = ContentBlockTools::VERSION
+  spec.authors       = ["GOV.UK Dev"]
+  spec.email         = ["govuk-dev@digital.cabinet-office.gov.uk"]
+
+  spec.summary       = "A suite of tools for working with GOV.UK Content Blocks"
+  spec.homepage      = "https://github.com/alphagov/content_block_tools"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 3.2"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency "rake", "13.2.1"
+  spec.add_development_dependency "rspec", "3.13.0"
+  spec.add_development_dependency "rubocop-govuk", "5.0.2"
+
+  spec.add_dependency "actionview", "7.2.2"
+end

data/lib/content_block_tools/content_block.rb

@@ -0,0 +1,52 @@
+module ContentBlockTools
+  ContentBlock = Data.define(:content_id, :title, :document_type, :details)
+
+  # Defines a Content Block
+  #
+  # @api public
+  #
+  # @!attribute [r] content_id
+  #   The content UUID for a block
+  #   @example
+  #     content_block.id #=> "2b92cade-549c-4449-9796-e7a3957f3a86"
+  #   @return [String]
+  #
+  # @!attribute [r] title
+  #   A title for the content block
+  #   @example
+  #     content_block.title #=> "Some title"
+  #   @return [String]
+  #   @api public
+  #
+  # @!attribute [r] document_type
+  #   The document type of the content block - this will be used to work out which Presenter
+  #   will be used to render the content block. All supported document_types are documented in
+  #   {ContentBlockTools::ContentBlockReference::SUPPORTED_DOCUMENT_TYPES}
+  #   @example
+  #     content_block.document_type #=> "content_block_email_address"
+  #   @return [String] the document type
+  #   @api public
+  #
+  # @!attribute [r] details
+  #  A hash that contains the details of the content block
+  #  @example
+  #   content_block.details #=> { email_address: "foo@example.com" }
+  #  @return [Hash] the details
+  #  @api public
+  class ContentBlock < Data
+    # A lookup of presenters for particular content block types
+    CONTENT_PRESENTERS = {
+      "content_block_email_address" => ContentBlockTools::Presenters::EmailAddressPresenter,
+    }.freeze
+
+    # Calls the appropriate presenter class to return a HTML representation of a content
+    # block. Defaults to {Presenters::BasePresenter}
+    #
+    # @return [string] A HTML representation of the content block
+    def render
+      CONTENT_PRESENTERS
+        .fetch(document_type, Presenters::BasePresenter)
+        .new(self).render
+    end
+  end
+end

data/lib/content_block_tools/content_block_reference.rb

@@ -0,0 +1,47 @@
+module ContentBlockTools
+  ContentBlockReference = Data.define(:document_type, :content_id, :embed_code)
+
+  # Defines a reference pointer for a Content Block
+  #
+  # @api public
+  # @!attribute [r] document_type
+  #   The document type of the content block - this will be used to work out which Presenter
+  #   will be used to render the content block. All supported document_types are documented in
+  #   {ContentBlockTools::ContentBlockReference::SUPPORTED_DOCUMENT_TYPES}
+  #   @example
+  #     content_block_reference.document_type #=> "content_block_email_address"
+  #   @return [String] the document type
+  #   @api public
+  #
+  # @!attribute [r] content_id
+  #   The content UUID for a block
+  #   @example
+  #     content_block_reference.id #=> "2b92cade-549c-4449-9796-e7a3957f3a86"
+  #   @return [String]
+  #
+  # @!attribute [r] embed_code
+  #   The embed_code used for a block
+  #   @example
+  #     content_block_reference.embed_code #=> "{{embed:content_block_email_address:2b92cade-549c-4449-9796-e7a3957f3a86}}"
+  #   @return [String]
+  class ContentBlockReference < Data
+    # An array of the supported document types
+    SUPPORTED_DOCUMENT_TYPES = %w[contact content_block_email_address].freeze
+    # The regex used to find UUIDs
+    UUID_REGEX = /([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})/
+    # The regex used when scanning a document using {ContentBlockTools::ContentBlockReference.find_all_in_document}
+    EMBED_REGEX = /({{embed:(#{SUPPORTED_DOCUMENT_TYPES.join('|')}):#{UUID_REGEX}}})/
+
+    class << self
+      # Finds all content block references within a document, using `ContentBlockReference::EMBED_REGEX`
+      # to scan through the document
+      #
+      # @return [Array<ContentBlockReference>] An array of content block references
+      def find_all_in_document(document)
+        document.scan(ContentBlockReference::EMBED_REGEX).map { |match|
+          ContentBlockReference.new(document_type: match[1], content_id: match[2], embed_code: match[0])
+        }.uniq
+      end
+    end
+  end
+end

data/lib/content_block_tools/presenters/base_presenter.rb

@@ -0,0 +1,49 @@
+module ContentBlockTools
+  module Presenters
+    class BasePresenter
+      include ActionView::Helpers::TagHelper
+
+      # The default HTML tag to wrap the presented response in - can be overridden in a subclass
+      BASE_TAG_TYPE = :span
+
+      # Returns a new presenter object
+      #
+      # @param [{ContentBlockTools::ContentBlock}] content_block  A content block object
+      #
+      # @return [{ContentBlockTools::Presenters::BasePresenter}]
+      def initialize(content_block)
+        @content_block = content_block
+      end
+
+      # Returns a HTML representation of the content block wrapped in a base tag with
+      # a class and data attributes
+      # Calls the {#content} method, which can be overridden in a subclass
+      #
+      # @return [string] A HTML representation of the content block
+      def render
+        content_tag(
+          BASE_TAG_TYPE,
+          content,
+          class: %W[content-embed content-embed__#{content_block.document_type}],
+          data: {
+            content_block: "",
+            document_type: content_block.document_type,
+            content_id: content_block.content_id,
+          },
+        )
+      end
+
+    private
+
+      # The default representation of the content block - this can be overridden in a subclass
+      #
+      # @return [string] A representation of the content block to be wrapped in the base_tag in
+      # {#content}
+      def content
+        content_block.title
+      end
+
+      attr_reader :content_block
+    end
+  end
+end

data/lib/content_block_tools/presenters/email_address_presenter.rb

@@ -0,0 +1,11 @@
+module ContentBlockTools
+  module Presenters
+    class EmailAddressPresenter < BasePresenter
+    private
+
+      def content
+        content_block.details[:email_address]
+      end
+    end
+  end
+end

data/lib/content_block_tools/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ContentBlockTools
+  VERSION = "0.1.0"
+end

data/lib/content_block_tools.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "action_view"
+require "uri"
+
+require "content_block_tools/presenters/base_presenter"
+require "content_block_tools/presenters/email_address_presenter"
+
+require "content_block_tools/content_block"
+require "content_block_tools/content_block_reference"
+
+require "content_block_tools/version"
+
+module ContentBlockTools
+  class Error < StandardError; end
+  module Presenters; end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: content_block_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GOV.UK Dev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-govuk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+description: 
+email:
+- govuk-dev@digital.cabinet-office.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/pull_request_template.md"
+- ".github/workflows/autorelease.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- content_block_tools.gemspec
+- lib/content_block_tools.rb
+- lib/content_block_tools/content_block.rb
+- lib/content_block_tools/content_block_reference.rb
+- lib/content_block_tools/presenters/base_presenter.rb
+- lib/content_block_tools/presenters/email_address_presenter.rb
+- lib/content_block_tools/version.rb
+homepage: https://github.com/alphagov/content_block_tools
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key: 
+specification_version: 4
+summary: A suite of tools for working with GOV.UK Content Blocks
+test_files: []