govspeak 6.1.1 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b48fa791c90052e6ee6f2c235d3baba095c5de501f32b7e2748f05396a799899
-  data.tar.gz: c5e325373b8c6d20e2d59db3b38b5345ccce22a83edba93a9ec41ba03156e1cb
+  metadata.gz: 8f4b2e89725aba68cf9965f46da83bc82a1db1db0c7a12196d0d39feffbdeeb9
+  data.tar.gz: 7270344803d8cc4185a4b1068744e957fef700f00c38be5a1c07df01d550682c
 SHA512:
-  metadata.gz: 3ddd06fa6841ce2efcbfbf660ae09eeff3114b6f4e5de067ed7b09457f6be14e29caa5803b281e24dad159e7c2a49594ef9e98a7d68f54e01930a4a31932ce32
-  data.tar.gz: e4811322275d4f221e198bf8112040340e922d3713ab82bac32395ad386243259e4f4fca1973cb050af9df12e4c1b10b8c17a62febb7f06c2ddbbbacc857d16d
+  metadata.gz: e8f3c856283a4e752c4d16b9b346c07532b1932e6874054695243dd63bd8650fa77dcd4c962de99c6ae49fb54c21e71b7291663a8795a863cd63f022a8afb790
+  data.tar.gz: dfee1a3832ab8c2fdaeeba352f5a070c35453eb10b9514a8c1869b415e21a3c753446bec38785a46a921ff6a527cc970c6e82c66fbeea03687d62900bd7d43e9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 6.2.0
+
+* Remove experimental status on `AttachementLink:attachment-id` and `Attachement:attachment-id`
+* Deprecate `embed:attachments:inline:content-id`
+
 ## 6.1.1
 
 * Fix wrapping `AttachmentLink:attachment-id` in a paragraph when used inline

data/README.md

@@ -352,7 +352,83 @@ Embedded content allows authors to reference a supporting item of a document by
 referencing an id. The details of this content is passed to the publishing
 application to govspeak at the time of rendering.
 
-### Inline Attachment
+### Attachments
+
+Attachments can be be rendered as blocks
+
+    [Attachment:file.txt]
+
+with options provided
+
+    {
+      attachments: [
+        {
+          id: "file.txt",
+          title: "My attached file",
+          url: "http://example.com/file.txt",
+          filename: "file.txt",
+          content_type: "text/plain",
+          file_size: 1024,
+        }
+      ]
+    }
+
+will output an attachment block
+
+```html
+<section class="gem-c-attachment">
+  <div class="gem-c-attachment__thumbnail">
+    <a class="govuk-link" target="_self" tabindex="-1" aria-hidden="true" href="http://example.com/file.txt">
+        <svg class="gem-c-attachment__thumbnail-image" version="1.1" viewbox="0 0 84 120" width="84" height="120" aria-hidden="true">
+  <path d="M74.85 5v106H5" fill="none" stroke-miterlimit="10" stroke-width="2"></path>
+  <path d="M79.85 10v106H10" fill="none" stroke-miterlimit="10" stroke-width="2"></path>
+</svg>
+
+</a>
+</div>
+  <div class="gem-c-attachment__details">
+    <h2 class="gem-c-attachment__title">
+      <a class="govuk-link" target="_self" href="http://example.com/file.txt">My attached file</a>
+</h2>
+      <p class="gem-c-attachment__metadata"><span class="gem-c-attachment__attribute">Plain Text</span>, <span class="gem-c-attachment__attribute">1 KB</span></p>
+
+
+</div></section>
+```
+
+### Attachment Links
+
+Attachments can be be rendered inline as links
+
+    Some information about [AttachmentLink:file.pdf]
+
+with options provided
+
+    {
+      attachments: [
+        {
+          id: "file.pdf",
+          title: "My PDF",
+          url: "http://example.com/file.pdf",
+          filename: "file.pdf",
+          content_type: "application/pdf",
+          file_size: 32768,
+          number_of_pages: 2,
+        }
+      ]
+    }
+
+will output an attachment link within a paragraph of text
+
+```html
+<p>Some information about <span class="gem-c-attachment-link">
+  <a class="govuk-link" href="http://example.com/file.pdf">My PDF</a>
+
+  (<span class="gem-c-attachment-link__attribute"><abbr title="Portable Document Format" class="gem-c-attachment-link__abbr">PDF</abbr></span>, <span class="gem-c-attachment-link__attribute">32 KB</span>, <span class="gem-c-attachment-link__attribute">2 pages</span>)
+</span></p>
+```
+
+### Inline Attachments (DEPRECATED: use `AttachmentLink:attachment-id` instead)
 
 Attachments can be linked to inline
 

data/lib/govspeak.rb

@@ -217,6 +217,7 @@ module Govspeak
       render_image(ImagePresenter.new(image))
     end
 
+    # DEPRECATED: use 'AttachmentLink:attachment-id' instead
     extension('embed attachment inline', /\[embed:attachments:inline:\s*(.*?)\s*\]/) do |content_id|
       attachment = attachments.detect { |a| a[:content_id] == content_id }
       next "" unless attachment
@@ -348,19 +349,12 @@ module Govspeak
       render_image(ImagePresenter.new(image))
     end
 
-    # This is an alternative syntax for embedding attachments using a readable id (expected
-    # to be a unique variation of a filename). This syntax is being used by
-    # Content Publisher and should be considered experimental as it is likely
-    # to be iterated in the short term.
     extension('Attachment', /#{NEW_PARAGRAPH_LOOKBEHIND}\[Attachment:\s*(.*?)\s*\]/) do |attachment_id|
       next "" if attachments.none? { |a| a[:id] == attachment_id }
 
       %{<govspeak-embed-attachment id="#{attachment_id}"></govspeak-embed-attachment>}
     end
 
-    # This is an alternative syntax for embedding attachments as links. This
-    # syntax is being used by Content Publisher and should be considered
-    # experimental
     extension('AttachmentLink', /\[AttachmentLink:\s*(.*?)\s*\]/) do |attachment_id|
       next "" if attachments.none? { |a| a[:id] == attachment_id }
 

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "6.1.1".freeze
+  VERSION = "6.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview