govspeak 5.7.1 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d11428240a9a0cdbed2f63a5d278893bab54ccdee09814a1689fce6f47df9a75
-  data.tar.gz: 18aaf4b2f5f72ff4ec22540badcac28db7b29df2867e9b5c59785472cee14cc0
+  metadata.gz: ac38fd3a1d6da3054f961380d76d362ad637aab0dd9593667a7657777ff10339
+  data.tar.gz: 6e8e0430a8a6ee72e67374b90e70a695ff8f1c710d10ce61849b5af10e9a4db9
 SHA512:
-  metadata.gz: 06dade4f0571fc2bdef539d7e273b45afd3a7994d4b60d8686975e064aeb7c11912cd47e71d8dd2a7649296a6006ade569c772fba1f1ac06d8f3855b51512604
-  data.tar.gz: 8953ea5d545b19510bc567de1851110c8f404b250e3c4a5d0a39e41485befd9e8afb034d0de19371789cd54b0778aa48ea6ca7fdf671742ec46e673d050964eb
+  metadata.gz: b3727ecd02a709c0db38b5881de8cb34846d627fbae0c0543da05462b250dfd1fb21bd3f5b07351be73dcc5bd8e447e7215e9a3693c59bce001559a978e7d6b5
+  data.tar.gz: 7a190b06732cb113838ddff93eec9c34e5c3785568f8025781b8d8da9d6100a9da6bef64a190669217867dc6a55ed143757316b7a9538434dca19abda4dfb55f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.8.0
+
+* Add new `Image:image-id` extension and deprecate `embed:attachments:image:content-id`
+
 ## 5.7.1
 
 * Include locale, config and asset files in the gem distribution

data/README.md

@@ -432,7 +432,7 @@ will output an attachment within a block of text
 <p>Details referenced in <span class="attachment-inline"><a href="http://example.com/my-thorough-study.pdf">My Thorough Study</a></span></p>
 ```
 
-### Image Attachments
+### Image Attachments (DEPRECATED: use `Image:image-id` instead)
 
 Attachments can be used to embed an image within the document
 
@@ -460,6 +460,36 @@ will output a image section
 </figure>
 ```
 
+### Images
+
+Images can be embedded as a figure with optional caption.
+
+    [Image:filename.png]
+
+with options provided
+
+    {
+      images: [
+        {
+          alt_text: "Some alt text",
+          caption: "An optional caption",
+          url: "http://example.com/lovely-landscape.jpg",
+          id: "filename.png",
+        }
+      ]
+    }
+
+will output a image section
+
+```html
+<figure class="image embedded">
+  <div class="img">
+    <img src="http://example.com/lovely-landscape.jpg" alt="Some alt text">
+    <figcaption>An optional caption</figcaption>
+  </div>
+</figure>
+```
+
 ### Link
 
 Links to different documents can be embedded so they change when the documents

data/lib/govspeak.rb

@@ -16,6 +16,8 @@ require 'govspeak/link_extractor'
 require 'govspeak/presenters/attachment_presenter'
 require 'govspeak/presenters/contact_presenter'
 require 'govspeak/presenters/h_card_presenter'
+require 'govspeak/presenters/image_presenter'
+require 'govspeak/presenters/attachment_image_presenter'
 
 
 module Govspeak
@@ -217,12 +219,9 @@ module Govspeak
 
     extension('attached-image', /^!!([0-9]+)/) do |image_number|
       image = images[image_number.to_i - 1]
-      if image
-        caption = image.caption rescue nil
-        render_image(image.url, image.alt_text, caption)
-      else
-        ""
-      end
+      next "" unless image
+
+      render_image(ImagePresenter.new(image))
     end
 
     extension('attachment', /\[embed:attachments:(?!inline:|image:)\s*(.*?)\s*\]/) do |content_id, body|
@@ -247,13 +246,12 @@ module Govspeak
       %{<span#{span_id} class="attachment-inline">#{link}#{attributes}</span>}
     end
 
+    # DEPRECATED: use 'Image:image-id' instead
     extension('attachment image', /\[embed:attachments:image:\s*(.*?)\s*\]/) do |content_id|
       attachment = attachments.detect { |a| a[:content_id] == content_id }
       next "" unless attachment
 
-      attachment = AttachmentPresenter.new(attachment)
-      title = (attachment.title || "").tr("\n", " ")
-      render_image(attachment.url, title, nil, attachment.id)
+      render_image(AttachmentImagePresenter.new(attachment))
     end
 
     # As of version 1.12.0 of Kramdown the block elements (div & figcaption)
@@ -266,12 +264,12 @@ module Govspeak
     # out div and figcaption
     #
     # This issue is not considered a bug by kramdown: https://github.com/gettalong/kramdown/issues/191
-    def render_image(url, alt_text, caption = nil, id = nil)
-      id_attr = id ? %{ id="attachment_#{id}"} : ""
+    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(url)}" alt="#{encode(alt_text)}"></div>}
-      lines << %{<figcaption>#{caption.strip}</figcaption>} if caption && !caption.strip.empty?
+      lines << %{<div class="img"><img src="#{encode(image.url)}" alt="#{encode(image.alt_text)}"></div>}
+      lines << %{<figcaption>#{encode(image.caption)}</figcaption>} if image.caption
       lines << '</figure>'
       lines.join
     end
@@ -359,6 +357,13 @@ module Govspeak
       @renderer.result(binding)
     end
 
+    extension('Image', /\[Image:\s*(.*?)\s*\]/) do |image_id|
+      image = images.detect { |c| c.is_a?(Hash) && c[:id] == image_id }
+      next "" unless image
+
+      render_image(ImagePresenter.new(image))
+    end
+
   private
 
     def kramdown_doc

data/lib/govspeak/presenters/attachment_image_presenter.rb

@@ -0,0 +1,25 @@
+module Govspeak
+  class AttachmentImagePresenter
+    attr_reader :attachment
+
+    def initialize(attachment)
+      @attachment = AttachmentPresenter.new(attachment)
+    end
+
+    def url
+      attachment.url
+    end
+
+    def alt_text
+      (attachment.title || "").tr("\n", " ")
+    end
+
+    def caption
+      nil
+    end
+
+    def id
+      attachment.id
+    end
+  end
+end

data/lib/govspeak/presenters/image_presenter.rb

@@ -0,0 +1,25 @@
+module Govspeak
+  class ImagePresenter
+    attr_reader :image
+
+    def initialize(image)
+      @image = image
+    end
+
+    def url
+      image.respond_to?(:url) ? image.url : image[:url]
+    end
+
+    def alt_text
+      image.respond_to?(:alt_text) ? image.alt_text : image[:alt_text]
+    end
+
+    def caption
+      (image.respond_to?(:caption) ? image.caption : image[:caption]).to_s.strip.presence
+    end
+
+    def id
+      nil
+    end
+  end
+end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "5.7.1".freeze
+  VERSION = "5.8.0".freeze
 end

data/test/govspeak_images_bang_test.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+
+require 'test_helper'
+require 'govspeak_test_helper'
+
+class GovspeakImagesBangTest < Minitest::Test
+  include GovspeakTestHelper
+
+  class Image
+    attr_reader :alt_text, :url, :caption
+
+    def initialize(attrs = {})
+      @alt_text = attrs[:alt_text] || "my alt"
+      @url = attrs[:url] || "http://example.com/image.jpg"
+      @caption = attrs[:caption]
+    end
+  end
+
+  test "!!n syntax renders an image in options[:images]" do
+    given_govspeak "!!1", images: [Image.new] do
+      assert_html_output(
+        %{<figure class="image embedded">} +
+        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>} +
+        %{</figure>}
+      )
+    end
+  end
+
+  test "!!n syntax escapes alt text" do
+    given_govspeak "!!1", images: [Image.new(alt_text: %{my alt '&"<>})] do
+      assert_html_output(
+        %{<figure class="image embedded">} +
+        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt '&amp;&quot;&lt;&gt;"></div>} +
+        %{</figure>}
+      )
+    end
+  end
+
+  test "!!n syntax renders nothing if not found" do
+    doc = Govspeak::Document.new("!!1")
+    assert_equal %{\n}, doc.to_html
+  end
+
+  test "Image:image-id syntax renders nothing" do
+    doc = Govspeak::Document.new("[Image:another-id]", images: [Image.new])
+    assert_equal %{\n}, doc.to_html
+  end
+
+  test "!!n syntax adds image caption if given" do
+    given_govspeak "!!1", images: [Image.new(caption: 'My Caption & so on')] do
+      assert_html_output(
+        %{<figure class="image embedded">} +
+        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n} +
+        %{<figcaption>My Caption &amp; so on</figcaption>} +
+        %{</figure>}
+      )
+    end
+  end
+
+  test "!!n syntax ignores a blank caption" do
+    given_govspeak "!!1", images: [Image.new(caption: '  ')] do
+      assert_html_output(
+        %{<figure class="image embedded">} +
+        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>} +
+        %{</figure>}
+      )
+    end
+  end
+end

data/test/govspeak_images_test.rb

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+
+require 'test_helper'
+require 'govspeak_test_helper'
+
+class GovspeakImagesTest < Minitest::Test
+  include GovspeakTestHelper
+
+  def build_image(attrs = {})
+    attrs[:alt_text] ||= "my alt"
+    attrs[:url] ||= "http://example.com/image.jpg"
+    attrs[:id] ||= "image-id"
+    attrs
+  end
+
+  test "Image:image-id syntax renders an image in options[:images]" do
+    given_govspeak "[Image:image-id]", images: [build_image] do
+      assert_html_output(
+        %{<figure class="image embedded">} +
+        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>} +
+        %{</figure>}
+      )
+    end
+  end
+
+  test "Image:image-id syntax escapes alt text" do
+    given_govspeak "[Image:image-id]", images: [build_image(alt_text: %{my alt '&"<>})] do
+      assert_html_output(
+        %{<figure class="image embedded">} +
+        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt '&amp;&quot;&lt;&gt;"></div>} +
+        %{</figure>}
+      )
+    end
+  end
+
+  test "Image:image-id syntax renders nothing if not found" do
+    doc = Govspeak::Document.new("[Image:another-id]")
+    assert_equal %{\n}, doc.to_html
+  end
+
+  test "Image:image-id syntax adds image caption if given" do
+    given_govspeak "[Image:image-id]", images: [build_image(caption: 'My Caption & so on')] do
+      assert_html_output(
+        %{<figure class="image embedded">} +
+        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n} +
+        %{<figcaption>My Caption &amp; so on</figcaption>} +
+        %{</figure>}
+      )
+    end
+  end
+
+  test "Image:image-id syntax ignores a blank caption" do
+    given_govspeak "[Image:image-id]", images: [build_image(caption: '  ')] do
+      assert_html_output(
+        %{<figure class="image embedded">} +
+        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>} +
+        %{</figure>}
+      )
+    end
+  end
+end

data/test/govspeak_test.rb

@@ -440,7 +440,7 @@ Teston
 
     $CTA
     Click here to start the tool
-    $CTA", [], document_domains: %w(www.not-external.com) do
+    $CTA", document_domains: %w(www.not-external.com) do
     assert_html_output %{
       <p><a href="http://www.not-external.com">internal link</a></p>
 
@@ -632,58 +632,6 @@ Teston
       }
   end
 
-  test "can reference attached images using !!n" do
-    images = [OpenStruct.new(alt_text: 'my alt', url: "http://example.com/image.jpg")]
-    given_govspeak "!!1", images do
-      assert_html_output(
-        %{<figure class="image embedded">} +
-        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>} +
-        %{</figure>}
-      )
-    end
-  end
-
-  test "alt text of referenced images is escaped" do
-    images = [OpenStruct.new(alt_text: %{my alt '&"<>}, url: "http://example.com/image.jpg")]
-    given_govspeak "!!1", images do
-      assert_html_output(
-        %{<figure class="image embedded">} +
-        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt '&amp;&quot;&lt;&gt;"></div>} +
-        %{</figure>}
-      )
-    end
-  end
-
-  test "silently ignores an image attachment if the referenced image is missing" do
-    doc = Govspeak::Document.new("!!1")
-    doc.images = []
-
-    assert_equal %{\n}, doc.to_html
-  end
-
-  test "adds image caption if given" do
-    images = [OpenStruct.new(alt_text: "my alt", url: "http://example.com/image.jpg", caption: 'My Caption & so on')]
-    given_govspeak "!!1", images do
-      assert_html_output(
-        %{<figure class="image embedded">} +
-        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n} +
-        %{<figcaption>My Caption &amp; so on</figcaption>} +
-        %{</figure>}
-      )
-    end
-  end
-
-  test "ignores a blank caption" do
-    images = [OpenStruct.new(alt_text: "my alt", url: "http://example.com/image.jpg", caption: '  ')]
-    given_govspeak "!!1", images do
-      assert_html_output(
-        %{<figure class="image embedded">} +
-        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>} +
-        %{</figure>}
-      )
-    end
-  end
-
   test "can sanitize a document" do
     document = Govspeak::Document.new("<script>doBadThings();</script>")
     assert_equal "doBadThings();", document.to_sanitized_html.strip

data/test/govspeak_test_helper.rb

@@ -4,15 +4,14 @@ module GovspeakTestHelper
   end
 
   class GovspeakAsserter
-    def initialize(testcase, govspeak, images = [], options = {})
+    def initialize(testcase, govspeak, options = {})
       @testcase = testcase
       @govspeak = remove_indentation(govspeak)
-      @images = images
       @options = options
     end
 
     def document
-      Govspeak::Document.new(@govspeak, @options.merge(images: @images))
+      Govspeak::Document.new(@govspeak, @options)
     end
 
     def assert_text_output(raw_expected)
@@ -55,8 +54,8 @@ module GovspeakTestHelper
     end
   end
 
-  def given_govspeak(govspeak, images = [], options = {}, &block)
-    asserter = GovspeakAsserter.new(self, govspeak, images, options)
+  def given_govspeak(govspeak, options = {}, &block)
+    asserter = GovspeakAsserter.new(self, govspeak, options)
     asserter.instance_eval(&block)
   end
 
@@ -69,9 +68,9 @@ module GovspeakTestHelper
   end
 
   module ClassMethods
-    def test_given_govspeak(govspeak, images = [], options = {}, &block)
+    def test_given_govspeak(govspeak, options = {}, &block)
       test "Given #{govspeak}" do
-        given_govspeak(govspeak, images, options, &block)
+        given_govspeak(govspeak, options, &block)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 5.7.1
+  version: 5.8.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2018-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -269,9 +269,11 @@ files:
 - lib/govspeak/kramdown_overrides.rb
 - lib/govspeak/link_extractor.rb
 - lib/govspeak/post_processor.rb
+- lib/govspeak/presenters/attachment_image_presenter.rb
 - lib/govspeak/presenters/attachment_presenter.rb
 - lib/govspeak/presenters/contact_presenter.rb
 - lib/govspeak/presenters/h_card_presenter.rb
+- lib/govspeak/presenters/image_presenter.rb
 - lib/govspeak/structured_header_extractor.rb
 - lib/govspeak/version.rb
 - lib/kramdown/parser/kramdown_with_automatic_external_links.rb
@@ -328,6 +330,8 @@ files:
 - test/govspeak_button_test.rb
 - test/govspeak_contacts_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
+- test/govspeak_images_bang_test.rb
+- test/govspeak_images_test.rb
 - test/govspeak_link_extractor_test.rb
 - test/govspeak_link_test.rb
 - test/govspeak_structured_headers_test.rb
@@ -373,7 +377,9 @@ test_files:
 - test/govspeak_link_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
 - test/govspeak_structured_headers_test.rb
+- test/govspeak_images_test.rb
 - test/presenters/h_card_presenter_test.rb
+- test/govspeak_images_bang_test.rb
 - test/govspeak_link_extractor_test.rb
 - test/govspeak_attachments_test.rb
 - test/govspeak_attachments_inline_test.rb