govspeak 5.8.0 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac38fd3a1d6da3054f961380d76d362ad637aab0dd9593667a7657777ff10339
-  data.tar.gz: 6e8e0430a8a6ee72e67374b90e70a695ff8f1c710d10ce61849b5af10e9a4db9
+  metadata.gz: aefa5ca742f032b154510d7a90ca70e4cb26adb803811ed4aac9377d07ea21ff
+  data.tar.gz: 6fdb391bb18c3b90c07f5d52a75758edc82711848da11578aab725eae6b556d7
 SHA512:
-  metadata.gz: b3727ecd02a709c0db38b5881de8cb34846d627fbae0c0543da05462b250dfd1fb21bd3f5b07351be73dcc5bd8e447e7215e9a3693c59bce001559a978e7d6b5
-  data.tar.gz: 7a190b06732cb113838ddff93eec9c34e5c3785568f8025781b8d8da9d6100a9da6bef64a190669217867dc6a55ed143757316b7a9538434dca19abda4dfb55f
+  metadata.gz: 2af64448e8f05a2e7aff9da5f81e252ff4ad5d466b8c9e7eba24114f937993f99ba0e8e59b1481c6fb1dba6dd6b438ec28e5735380b3d4879355a8eba20d4809
+  data.tar.gz: f4a4dbb952b94c994c8697d52b8a905bf457a98883ef8d23a8f661528f719632f28acb0c1cbcc1e7a26195340dafce0e2e7bac950f8e89eb0e4f675fea7af291

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.9.0
+
+* Add image credits to embedded images
+
 ## 5.8.0
 
 * Add new `Image:image-id` extension and deprecate `embed:attachments:image:content-id`

data/README.md

@@ -473,6 +473,7 @@ with options provided
         {
           alt_text: "Some alt text",
           caption: "An optional caption",
+          credit: "An optional credit",
           url: "http://example.com/lovely-landscape.jpg",
           id: "filename.png",
         }
@@ -485,7 +486,10 @@ will output a image section
 <figure class="image embedded">
   <div class="img">
     <img src="http://example.com/lovely-landscape.jpg" alt="Some alt text">
-    <figcaption>An optional caption</figcaption>
+    <figcaption>
+      <p>An optional caption</p>
+      <p>Image credit: An optional credit</p>
+    </figcaption>
   </div>
 </figure>
 ```

data/lib/govspeak.rb

@@ -269,7 +269,7 @@ module Govspeak
       lines = []
       lines << %{<figure#{id_attr} class="image embedded">}
       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 << image.figcaption_html if image.figcaption?
       lines << '</figure>'
       lines.join
     end

data/lib/govspeak/presenters/attachment_image_presenter.rb

@@ -18,8 +18,20 @@ module Govspeak
       nil
     end
 
+    def credit
+      nil
+    end
+
     def id
       attachment.id
     end
+
+    def figcaption?
+      false
+    end
+
+    def figcaption_html
+      nil
+    end
   end
 end

data/lib/govspeak/presenters/image_presenter.rb

@@ -18,8 +18,25 @@ module Govspeak
       (image.respond_to?(:caption) ? image.caption : image[:caption]).to_s.strip.presence
     end
 
+    def credit
+      (image.respond_to?(:credit) ? image.credit : image[:credit]).to_s.strip.presence
+    end
+
     def id
       nil
     end
+
+    def figcaption?
+      caption.present? || credit.present?
+    end
+
+    def figcaption_html
+      lines = []
+      lines << '<figcaption>'
+      lines << %{<p>#{caption}</p>} if caption.present?
+      lines << %{<p>#{I18n.t('govspeak.image.figure.credit', credit: credit)}</p>} if credit.present?
+      lines << '</figcaption>'
+      lines.join
+    end
   end
 end

data/lib/govspeak/version.rb

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

data/locales/en.yml

@@ -24,3 +24,6 @@ en:
     contact:
       email: Email
       contact_form: Contact form
+    image:
+      figure:
+        credit: "Image credit: %{credit}"

data/test/govspeak_images_bang_test.rb

@@ -7,12 +7,13 @@ class GovspeakImagesBangTest < Minitest::Test
   include GovspeakTestHelper
 
   class Image
-    attr_reader :alt_text, :url, :caption
+    attr_reader :alt_text, :url, :caption, :credit
 
     def initialize(attrs = {})
       @alt_text = attrs[:alt_text] || "my alt"
       @url = attrs[:url] || "http://example.com/image.jpg"
       @caption = attrs[:caption]
+      @credit = attrs[:credit]
     end
   end
 
@@ -51,7 +52,7 @@ class GovspeakImagesBangTest < Minitest::Test
       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>} +
+        %{<figcaption><p>My Caption &amp; so on</p></figcaption>} +
         %{</figure>}
       )
     end
@@ -66,4 +67,39 @@ class GovspeakImagesBangTest < Minitest::Test
       )
     end
   end
+
+  test "¡¡n syntax adds image credit if given" do
+    given_govspeak "!!1", images: [Image.new(credit: 'My Credit & 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><p>Image credit: My Credit &amp; so on</p></figcaption>} +
+        %{</figure>}
+      )
+    end
+  end
+
+  test "!!n syntax ignores a blank credit" do
+    given_govspeak "!!1", images: [Image.new(credit: '  ')] 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 adds image caption and credit if given" do
+    given_govspeak "!!1", images: [Image.new(caption: 'My Caption & so on', credit: 'My Credit & 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>} +
+          %{<p>My Caption &amp; so on</p>\n} +
+          %{<p>Image credit: My Credit &amp; so on</p>} +
+        %{</figcaption>} +
+        %{</figure>}
+      )
+    end
+  end
 end

data/test/govspeak_images_test.rb

@@ -43,7 +43,7 @@ class GovspeakImagesTest < Minitest::Test
       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>} +
+        %{<figcaption><p>My Caption &amp; so on</p></figcaption>} +
         %{</figure>}
       )
     end
@@ -58,4 +58,39 @@ class GovspeakImagesTest < Minitest::Test
       )
     end
   end
+
+  test "Image:image-id syntax adds image credit if given" do
+    given_govspeak "[Image:image-id]", images: [build_image(credit: 'My Credit & 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><p>Image credit: My Credit &amp; so on</p></figcaption>} +
+        %{</figure>}
+      )
+    end
+  end
+
+  test "Image:image-id syntax ignores a blank credit" do
+    given_govspeak "[Image:image-id]", images: [build_image(credit: '  ')] 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 adds image caption and credit if given" do
+    given_govspeak "[Image:image-id]", images: [build_image(caption: 'My Caption & so on', credit: 'My Credit & 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>} +
+          %{<p>My Caption &amp; so on</p>\n} +
+          %{<p>Image credit: My Credit &amp; so on</p>} +
+        %{</figcaption>} +
+        %{</figure>}
+      )
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 5.8.0
+  version: 5.9.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-13 00:00:00.000000000 Z
+date: 2018-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -365,21 +365,21 @@ signing_key:
 specification_version: 4
 summary: Markup language for single domain
 test_files:
-- test/test_helper.rb
-- test/govspeak_button_test.rb
-- test/govspeak_test.rb
-- test/html_validator_test.rb
-- test/govspeak_contacts_test.rb
-- test/govspeak_test_helper.rb
 - test/blockquote_extra_quote_remover_test.rb
+- test/govspeak_test_helper.rb
+- test/govspeak_structured_headers_test.rb
 - test/govspeak_attachments_image_test.rb
+- test/govspeak_attachments_test.rb
+- test/test_helper.rb
+- test/govspeak_attachments_inline_test.rb
 - test/html_sanitizer_test.rb
-- 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_button_test.rb
 - test/govspeak_images_bang_test.rb
+- test/govspeak_images_test.rb
+- test/html_validator_test.rb
+- test/govspeak_extract_contact_content_ids_test.rb
+- test/govspeak_test.rb
 - test/govspeak_link_extractor_test.rb
-- test/govspeak_attachments_test.rb
-- test/govspeak_attachments_inline_test.rb
+- test/govspeak_link_test.rb
+- test/govspeak_contacts_test.rb
+- test/presenters/h_card_presenter_test.rb