govuk_publishing_components 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d096d826f4036a0b4d935adcb65e7046e30c036
-  data.tar.gz: 73166cb75dbfdda9d960f790c6f4f0833ffdc800
+  metadata.gz: 977c19c9c3c98f7113ee56e38465aa8563cb3869
+  data.tar.gz: c355c901404936ef826f59dcaa2f4077427e4487
 SHA512:
-  metadata.gz: 0f40af4038b72fb80da00abb67fc9fb944495df6006a5b4609e650819717a291f30c8cb17908d17298fbdc0740c891e1d36a9fc9f13438520553040472e412ca
-  data.tar.gz: 35d8bb1bc8d0812eb6bfe580c0edf05c015bf40eb980d64d015d0f99fbe5a161bb073922b72261f5c202f7236dc51bca8711419d4fdda2bc5e262dc8e0659843
+  metadata.gz: 31845d620a5314bb240ebf110653c8acbdb0e8ab4e97f00d8254fd52af8f55d7dc579cb4dec3f51c80ddfef7db1c2e79aca839733f3aaad4c8cfccfd382d7ee6
+  data.tar.gz: ea7d156f8ed7899d5a11bbbd745382a8721996ec5ed3c9fb08419e808f8e4a6b953956e44526fba55117ab9a66d3d3b358258538ca2bd2a6bbaf7b3a46f39e93

data/app/models/govuk_publishing_components/component_doc_resolver.rb

@@ -14,7 +14,7 @@ module GovukPublishingComponents
     def build(component)
       examples = component[:examples].map { |id, example|
         example = example || {}
-        ComponentExample.new(id.to_s, example["data"], example["context"])
+        ComponentExample.new(id.to_s, example["data"], example["context"], example["description"])
       }
 
       ComponentDoc.new(component[:id],

data/app/models/govuk_publishing_components/component_example.rb

@@ -2,12 +2,14 @@ module GovukPublishingComponents
   class ComponentExample
     attr_reader :id,
                 :data,
-                :context
+                :context,
+                :description
 
-    def initialize(id, data, context)
+    def initialize(id, data, context, description)
       @id = id
       @data = data || {}
       @context = context || {}
+      @description = description || false
     end
 
     def name
@@ -48,5 +50,15 @@ module GovukPublishingComponents
     def right_to_left?
       !!context['right_to_left']
     end
+
+    def html_description
+      govspeak_to_html(description) if description.present?
+    end
+
+  private
+
+    def govspeak_to_html(govspeak)
+      Govspeak::Document.new(govspeak).to_html
+    end
   end
 end

data/app/views/govuk_publishing_components/component_guide/example.html.erb

@@ -3,6 +3,7 @@
 
 <div class="component-show">
   <div class="component-doc">
+    <%= render "govuk_component/govspeak", content: @component_example.html_description %>
     <h2 class="component-doc-h2">How to call this example</h2>
     <%= render partial: "govuk_publishing_components/component_guide/component_doc/call", locals: { component_doc: @component_doc, example: @component_example } %>
 

data/app/views/govuk_publishing_components/component_guide/show.html.erb

@@ -44,6 +44,7 @@
             <a href="<%= component_example_path(@component_doc.id, example.id) %>"><%= example.name %></a>
             <small>(<a href="<%= component_preview_path(@component_doc.id, example.id) %>">preview</a>)</small>
           </h3>
+          <%= render "govuk_component/govspeak", content: example.html_description %>
           <%= render "govuk_publishing_components/component_guide/component_doc/call", component_doc: @component_doc, example: example %>
           <%= render "govuk_publishing_components/component_guide/component_doc/preview", component_doc: @component_doc, example: example %>
         </div>

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-01 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails