govuk_publishing_components 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3dc010098e20d7c3f41d718c0f35fcfca619bd3
-  data.tar.gz: d29bd6f7f3822e2d327e73f614db8ace63128235
+  metadata.gz: 964f3e0359c0d4bc49f3bd8e40c6735569a492c2
+  data.tar.gz: f4ff341d71b97c332a0b642ee27e43f1367bc8e8
 SHA512:
-  metadata.gz: 31d55fa0966460daa1476332d765c43e19e83c3acff69b558474165f63158674da3080349dc8d2a7e512f6e0113b4a57236415d27cafeacfa3b6bcc8d39491ea
-  data.tar.gz: f87f4b14640ba594300a97e65e616236e2f2048d6abbd86537c7b02bf7e89bc919c468b7852e679b279aab074e16e698a4e87c4c6fdb613afd2086d02295c5a6
+  metadata.gz: 69201660752e0a7a58a565563ff83b1f8632d99df40cae14fefa81a0cd67d17022007e0377f04b9f7879f1cee03dc40b38fa480046afa2fb4d09e7458da55d89
+  data.tar.gz: 3d961bc24e02413fbc21087588cc21adfcfcf51efe550194c4e86bfa1b21bf4cdbc894a7299b27c1689c870bfe6636901f03d5156d03ffc5d9c31d9a7c952272

data/app/assets/stylesheets/govuk_publishing_components/component_guide.scss

@@ -99,6 +99,11 @@ $border-color: #ccc;
 }
 
 .component-guide-preview {
+  &.direction-rtl {
+    direction: rtl;
+    text-align: start;
+  }
+
   padding: ($gutter * 1.5) $gutter $gutter;
   border: 1px solid $border-colour;
   position: relative;
@@ -122,11 +127,11 @@ $border-color: #ccc;
   }
 }
 
-.fixtures {
-  .component-fixture {
+.examples {
+  .component-example {
     margin: 0 0 $gutter * 1.5;
 
-    .fixture-title {
+    .example-title {
       @include bold-24;
       margin: $gutter-half 0;
 

data/app/controllers/govuk_publishing_components/component_guide_controller.rb

@@ -11,27 +11,27 @@ module GovukPublishingComponents
       @guide_breadcrumbs = [index_breadcrumb, component_breadcrumb(@component_doc)]
     end
 
-    def fixture
+    def example
       @component_doc = component_documentation_resolver.get(params[:component])
-      @component_fixture = @component_doc.fixtures.find { |f| f.id == params[:fixture] }
+      @component_example = @component_doc.examples.find { |f| f.id == params[:example] }
       @guide_breadcrumbs = [
                              index_breadcrumb,
-                             component_breadcrumb(@component_doc, @component_fixture),
+                             component_breadcrumb(@component_doc, @component_example),
                              {
-                               title: @component_fixture.name
+                               title: @component_example.name
                              }
                            ]
     end
 
     def preview
-      @component_fixtures = []
+      @component_examples = []
       @component_doc = component_documentation_resolver.get(params[:component])
       @preview = true
 
-      if params[:fixture].present?
-        @component_fixtures.push(@component_doc.fixtures.find { |f| f.id == params[:fixture] })
+      if params[:example].present?
+        @component_examples.push(@component_doc.examples.find { |f| f.id == params[:example] })
       else
-        @component_fixtures = @component_doc.fixtures
+        @component_examples = @component_doc.examples
       end
     end
 
@@ -48,10 +48,10 @@ module GovukPublishingComponents
       }
     end
 
-    def component_breadcrumb(component_doc, component_fixture = nil)
+    def component_breadcrumb(component_doc, component_example = nil)
       Hash.new.tap do |h|
         h[:title] = component_doc.name
-        h[:url] = component_doc_path(component_doc.id) if component_fixture
+        h[:url] = component_doc_path(component_doc.id) if component_example
       end
     end
   end

data/app/models/govuk_publishing_components/component_doc.rb

@@ -5,23 +5,23 @@ module GovukPublishingComponents
                 :description,
                 :body,
                 :accessibility_criteria,
-                :fixtures
+                :examples
 
-    def initialize(id, name, description, body, accessibility_criteria, fixtures)
+    def initialize(id, name, description, body, accessibility_criteria, examples)
       @id = id
       @name = name
       @description = description
       @body = body
       @accessibility_criteria = accessibility_criteria
-      @fixtures = fixtures
+      @examples = examples
     end
 
-    def fixture
-      fixtures.first
+    def example
+      examples.first
     end
 
-    def other_fixtures
-      fixtures.slice(1..-1)
+    def other_examples
+      examples.slice(1..-1)
     end
 
     def html_body

data/app/models/govuk_publishing_components/component_doc_resolver.rb

@@ -12,8 +12,9 @@ module GovukPublishingComponents
   private
 
     def build(component)
-      fixtures = component[:fixtures].map { |id, data|
-        ComponentFixture.new(id.to_s, data)
+      examples = component[:examples].map { |id, example|
+        example = example || {}
+        ComponentExample.new(id.to_s, example["data"], example["context"])
       }
 
       ComponentDoc.new(component[:id],
@@ -21,7 +22,7 @@ module GovukPublishingComponents
                        component[:description],
                        component[:body],
                        component[:accessibility_criteria],
-                       fixtures)
+                       examples)
     end
 
     def fetch_component_docs

data/app/models/govuk_publishing_components/{component_fixture.rb → component_example.rb}

@@ -1,11 +1,13 @@
 module GovukPublishingComponents
-  class ComponentFixture
+  class ComponentExample
     attr_reader :id,
-                :data
+                :data,
+                :context
 
-    def initialize(id, data)
+    def initialize(id, data, context)
       @id = id
-      @data = data
+      @data = data || {}
+      @context = context || {}
     end
 
     def name
@@ -42,5 +44,9 @@ module GovukPublishingComponents
         obj
       end
     end
+
+    def right_to_left?
+      !!context['right_to_left']
+    end
   end
 end

data/app/views/govuk_publishing_components/component_guide/component_doc/_call.html.erb

@@ -1,3 +1,3 @@
 <div class="component-call code-block" contenteditable>
-  <pre class="language-ruby"><code>&lt;%= render '<%= @component_doc.partial_path %>'<% if fixture.data? %>, <%= fixture.pretty_data %><% end %> %&gt;</code></pre>
+  <pre class="language-ruby"><code>&lt;%= render '<%= @component_doc.partial_path %>'<% if example.data? %>, <%= example.pretty_data %><% end %> %&gt;</code></pre>
 </div>

data/app/views/govuk_publishing_components/component_guide/component_doc/_preview.html.erb

@@ -1,3 +1,3 @@
-<div data-module="test-a11y" class="component-guide-preview">
-  <%= render @component_doc.partial_path, fixture.html_safe_data %>
+<div data-module="test-a11y" class="component-guide-preview <% if example.right_to_left? %>direction-rtl<% end %>">
+  <%= render component_doc.partial_path, example.html_safe_data %>
 </div>

data/app/views/govuk_publishing_components/component_guide/{fixture.html.erb → example.html.erb}

@@ -1,12 +1,12 @@
-<% content_for :title, "#{@component_fixture.name} example - #{@component_doc.name} component" %>
-<%= render 'govuk_component/title', title: @component_fixture.name, context: "#{@component_doc.name} example" %>
+<% content_for :title, "#{@component_example.name} example - #{@component_doc.name} component" %>
+<%= render 'govuk_component/title', title: @component_example.name, context: "#{@component_doc.name} example" %>
 
 <div class="component-show">
   <div class="component-doc">
     <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, fixture: @component_fixture } %>
+    <%= render partial: "govuk_publishing_components/component_guide/component_doc/call", locals: { component_doc: @component_doc, example: @component_example } %>
 
     <h2 class="component-doc-h2">How it looks</h2>
-    <%= render partial: "govuk_publishing_components/component_guide/component_doc/preview", locals: { component_doc: @component_doc, fixture: @component_fixture } %>
+    <%= render partial: "govuk_publishing_components/component_guide/component_doc/preview", locals: { component_doc: @component_doc, example: @component_example } %>
   </div>
 </div>

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

@@ -1,10 +1,8 @@
-<% @component_fixtures.each do |fixture| %>
+<% @component_examples.each do |example| %>
   <div class="component-guide-preview-page">
-    <% if @component_fixtures.length > 1 %>
-      <h2 class="preview-title"><a href="<%= component_fixture_path(@component_doc.id, fixture.id) %>"><%= fixture.name %></a></h2>
+    <% if @component_examples.length > 1 %>
+      <h2 class="preview-title"><a href="<%= component_example_path(@component_doc.id, example.id) %>"><%= example.name %></a></h2>
     <% end %>
-    <div data-module="test-a11y">
-      <%= render @component_doc.partial_path, fixture.html_safe_data %>
-    </div>
+    <%= render "govuk_publishing_components/component_guide/component_doc/preview", component_doc: @component_doc, example: example %>
   </div>
 <% end %>

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

@@ -17,12 +17,12 @@
 
   <div class="component-doc">
     <h2 class="component-doc-h2">How to call this component</h2>
-    <%= render "govuk_publishing_components/component_guide/component_doc/call", component_doc: @component_doc, fixture: @component_doc.fixture %>
+    <%= render "govuk_publishing_components/component_guide/component_doc/call", component_doc: @component_doc, example: @component_doc.example %>
 
     <h2 class="component-doc-h2">How it looks</h2>
   </div>
 
-  <%= render "govuk_publishing_components/component_guide/component_doc/preview", component_doc: @component_doc, fixture: @component_doc.fixture %>
+  <%= render "govuk_publishing_components/component_guide/component_doc/preview", component_doc: @component_doc, example: @component_doc.example %>
 
   <% if @component_doc.accessibility_criteria.present? %>
     <div class="grid-row component-accessibility-criteria">
@@ -33,19 +33,19 @@
     </div>
   <% end %>
 
-  <% if @component_doc.other_fixtures.any? %>
-    <div class="fixtures">
+  <% if @component_doc.other_examples.any? %>
+    <div class="examples">
       <h2 class="component-doc-h2">Other examples
         <small>(<a href="<%= component_preview_all_path(@component_doc.id) %>">preview all</a>)</small>
       </h2>
-      <% @component_doc.other_fixtures.each do |fixture| %>
-        <div class="component-fixture">
-          <h3 class="fixture-title">
-            <a href="<%= component_fixture_path(@component_doc.id, fixture.id) %>"><%= fixture.name %></a>
-            <small>(<a href="<%= component_preview_path(@component_doc.id, fixture.id) %>">preview</a>)</small>
+      <% @component_doc.other_examples.each do |example| %>
+        <div class="component-example">
+          <h3 class="example-title">
+            <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_publishing_components/component_guide/component_doc/call", component_doc: @component_doc, fixture: fixture %>
-          <%= render "govuk_publishing_components/component_guide/component_doc/preview", component_doc: @component_doc, fixture: fixture %>
+          <%= 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>
       <% end %>
     </div>

data/app/views/layouts/govuk_publishing_components/application.html.erb

@@ -3,8 +3,8 @@
 <head>
   <title>
     <% if @preview %>
-      <%= @component_doc.name %><% if @component_fixtures.length == 1 %>:
-        <%= @component_fixtures.first.name %>
+      <%= @component_doc.name %><% if @component_examples.length == 1 %>:
+        <%= @component_examples.first.name %>
       <% end %>
       preview -
     <% end %>

data/config/routes.rb

@@ -1,7 +1,7 @@
 GovukPublishingComponents::Engine.routes.draw do
   root :to => 'component_guide#index', as: :component_guide
   get ':component/preview' => 'component_guide#preview', as: :component_preview_all
-  get ':component/:fixture/preview' => 'component_guide#preview', as: :component_preview
+  get ':component/:example/preview' => 'component_guide#preview', as: :component_preview
   get ':component' => 'component_guide#show', as: :component_doc
-  get ':component/:fixture' => 'component_guide#fixture', as: :component_fixture
+  get ':component/:example' => 'component_guide#example', as: :component_example
 end

data/lib/generators/govuk_publishing_components/templates/component.yml.erb

@@ -8,5 +8,5 @@ accessibility_criteria: |
   The link must:
 
   * be keyboard focusable
-fixtures:
+examples:
   default: {}

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '0.9.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-25 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -186,10 +186,10 @@ files:
 - app/helpers/govuk_publishing_components/application_helper.rb
 - app/models/govuk_publishing_components/component_doc.rb
 - app/models/govuk_publishing_components/component_doc_resolver.rb
-- app/models/govuk_publishing_components/component_fixture.rb
+- app/models/govuk_publishing_components/component_example.rb
 - app/views/govuk_publishing_components/component_guide/component_doc/_call.html.erb
 - app/views/govuk_publishing_components/component_guide/component_doc/_preview.html.erb
-- app/views/govuk_publishing_components/component_guide/fixture.html.erb
+- app/views/govuk_publishing_components/component_guide/example.html.erb
 - app/views/govuk_publishing_components/component_guide/index.html.erb
 - app/views/govuk_publishing_components/component_guide/preview.html.erb
 - app/views/govuk_publishing_components/component_guide/show.html.erb