pugin 0.8.5 → 0.8.6.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eadf3c6054f9428bcb8f2e0a8659e9d6d9b99b90
-  data.tar.gz: 67115adf068391fb641faa9e38e25094309a247c
+  metadata.gz: ead24bb9ca07f105257830abe4aa843e933ce7ab
+  data.tar.gz: ea7c4d958e3c64556ce937cfc54febf678faab6d
 SHA512:
-  metadata.gz: 93317babc8acd89546fe4be7541e8c3ec2563854979bf091d9738966084de6ecce2e3fc609a1ce9b0250e96bf8bf4caa97591c0ebf8490ae6c65578f65cdf4f1
-  data.tar.gz: cafb31ac9b106ccd0892138edebcdd8194b5968b58956d27ffbad0dc4a1cdd31a5f11bb31e55d5b6236d9cdfa66cff913d6e528541589930d6b81a356e35aa13
+  metadata.gz: a4041fbd51b33225014277870eb8d8722dffd02b4acf48f2b8b67396d68b0e7d1ee93d87862ec84cd26b275349f831ceb502e28da4d76341c018f5c9af265746
+  data.tar.gz: dd3c79fa8f92a794a23531caa3f27f832a26b51bf170674c1e1391f8c9147f47ac70399997c0848ba8a3a74442ab8e5e69d6210705b691978c20f469f187a0f3

data/README.md

@@ -1,5 +1,5 @@
 # Pugin Components Rails
-[pugin-components-rails][pugin-components-rails] is a component-based pattern design library created by the [Parliamentary Digital Service][pds] that holds all of the reusable partials for elements of the UK Parliament's microservices.
+[pugin-components-ruby][pugin-components-ruby] is a component-based pattern design library created by the [Parliamentary Digital Service][pds] that holds all of the reusable partials for elements of the UK Parliament's microservices.
 
 [![Build Status][shield-travis]][info-travis] [![Test Coverage][shield-coveralls]][info-coveralls] [![License][shield-license]][info-license]
 
@@ -14,6 +14,9 @@
 - [Installation](#installation)
 - [Usage](#usage)
   - [Example](#example)
+  - [Adding the Parliamentary layout](#adding-the-parliamentary-layout)
+    - [Including rel-alternate links](#including-rel-alternate-links)
+      - [Example](#example-1)
 - [Getting Started with Development](#getting-started-with-development)
   - [Running the tests](#running-the-tests)
 - [Contributing](#contributing)
@@ -23,7 +26,7 @@
 
 
 ## Requirements
-[pugin-components-rails][pugin-components-rails] requires the following:
+[pugin-components-ruby][pugin-components-ruby] requires the following:
 * [Ruby][ruby] - [click here][ruby-version] for the exact version
 * [Bundler][bundler]
 * [Rails][rails]
@@ -57,12 +60,34 @@ Add the following line into the application controller within your host applicat
 layout 'pugin/layouts/pugin'
 ```
 
+#### Including rel-alternate links
+When rendering using the Parliamentary layout, if you'd like to document rel-alternates like so:
+
+```html
+<link rel="alternate" type="application/rdf+json" href="https://api.example.com/some/url" />
+<link rel="alternate" type="application/rdf+xml" href="https://api.example.com/some/other/url" />
+```
+
+You can do so automatically by setting `Pugin.alternates`.
+
+##### Example
+Within your controller:
+
+```ruby
+alternates = [
+  { type: 'application/rdf+json', href: 'https://api.example.com/some/url' },
+  { type: 'application/rdf+xml', href: 'https://api.example.com/some/other/url' }
+]
+
+Pugin.alternates = alternates
+```
+
 
 ## Getting Started with Development
 To clone the repository and set up the dependencies, run the following:
 ```bash
-git clone https://github.com/ukparliament/pugin-components-rails.git
-cd pugin-components-rails
+git clone https://github.com/ukparliament/pugin-components-ruby.git
+cd pugin-components-ruby
 bundle install
 ```
 
@@ -85,12 +110,12 @@ If you wish to submit a bug fix or feature, you can create a pull request and it
 
 
 ## License
-[pugin-components-rails][pugin-components-rails] is licensed under the [Open Parliament Licence][info-license].
+[pugin-components-ruby][pugin-components-ruby] is licensed under the [Open Parliament Licence][info-license].
 
 [ruby]:                   https://www.ruby-lang.org/en/
 [bundler]:                http://bundler.io
 [rspec]:                  http://rspec.info
-[pugin-components-rails]: https://github.com/ukparliament/parliament.uk-pugin-components-rails
+[pugin-components-ruby]: 	https://github.com/ukparliament/parliament.uk-pugin-components-ruby
 [pds]:                    https://www.parliament.uk/mps-lords-and-offices/offices/bicameral/parliamentary-digital-service/
 [ruby-version]:           https://github.com/ukparliament/pugin/blob/master/.ruby-version
 [rails]:                  http://rubyonrails.org

data/app/views/pugin/layouts/{pugin.haml → _layout.html.haml}

@@ -8,6 +8,12 @@
     %link{rel: 'shortcut icon', type: 'image/x-icon', href: "#{Pugin::STATIC_ASSET_LOCATION_URL}/favicon.ico"}
     - if ENV['GTM_KEY']
       = render partial: 'pugin/javascript/google_tag_manager'
+    - unless Pugin.alternates.empty?
+      / /==========================\
+      / [ See below for data views ]
+      / \==========================/
+    - Pugin.alternates.each do |alternate|
+      %link{rel: 'alternate', type: alternate[:type], href: alternate[:href]}
   %body.no-js
     - if ENV['GTM_KEY']
       = render partial: 'pugin/javascript/google_tag_manager_noscript'

data/app/views/pugin/layouts/pugin.html.erb

@@ -0,0 +1,51 @@
+<!--
+
+                                  ...........
+                                   ,,,,,,,,,
+                      .,,       ..   ,,,,,    .       ,,.
+         .,,,,        .,,,...   ,,,,..,,,...,,,   ...,,,,        ,,,,.
+         ,,,,       ...,,,,,,,. ,,,,,,,,,,,,,,, .,,,,,,,,,.       ,,,,
+         ,,,, .,  ,,,,,,,,,   , ,,,,,.,,,.,,,,,     ,,,,,,,,,  ,. ,,,,
+          ,,,,,,,  ,   ,,,,     ,,   .,,,.   ,,     ,,,,   ,  ,,,,,,,
+           .,,,,,,     .,,,,        .,,,,,.        ,,,,.     ,,,,,,.
+            .,,. ,.     ,,,,.     .,,,,,,,,,.     .,,,,     ,  .,,.
+             ,,,..     .,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,     ..,,,
+              .,,,,,,,,,,,,,,,,,,,           ,,,,,,,,,,,,,,,,,,,,
+         ...   .,,,,,,,,                               ,,,,,,,,.   ...
+      .,,,,,,,. ,,                                           ,, .,,,,,,,.
+      ,,,   ,,,.................................................,,.   ,,,.
+      ,,. . .,,,,.,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,.,,,,. ...,,,
+       ,,,,,,,.  .,,,      ,,,,.     ,,,,,     .,,,,      .,,.  .,,,,,,,
+         ,,.     .,,,      ,,,,.     ,,,,,     .,,,,      .,,.     ,,,
+        .,,..    .,,,      ,,,,.     ,,,,,     .,,,,      .,,.     .,,
+      .,,,,,,,.  .,,,......,,,,......,,,,,......,,,,.......,,.  .,,,,,,,.
+      ,,.   .,,. .,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,.  ,,, .  ,,,
+      ,,.....,,  .,,,......,,,,......,,,,,.....,,,,,.......,,.  ,,,.,,.,,
+       ,,,,,,,   .,,,      ,,,,.     ,,,,,     .,,,,      .,,.   ,,,,,,,
+         ,,.     .,,,      ,,,,.     ,,,,,     .,,,,      .,,.     ,,,
+        .,,..    .,,,      ,,,,.     ,,,,,     .,,,,      .,,.    ..,,.
+      .,,,,,,,.  .,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,.  .,,,,,,,.
+      ,,,    ,,. .,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,.  ,,.    ,,,
+      ,,..,..,,  .,,,      ,,,,.     ,,,,,     .,,,,      .,,.  .,..,,,,,
+       ,,,,,,,   .,,,      ,,,,.     ,,,,,     .,,,,      .,,.   .,,,,,,
+         ,,.     .,,,      ,,,,.     ,,,,,     .,,,,      .,,.     ,,,
+       .,,,,,.   .,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,.   .,,,,,.
+      .,,.,.,,.  .,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,.  .,,.,,.,.
+      ,,     ,,, .,,,      ,,,,.     ,,,,,     .,,,,      .,,.  ,,,    ,,,
+      .,,.,.,,.  .,,,      ,,,,.     ,,,,,     .,,,,      .,,.  .,,.,,.,,
+       ,,,,,,,   .,,,      ,,,,.     ,,,,,     .,,,,      .,,.   ,,,,,,,
+         ,,.     .,,,..  ..,,,,..   .,,,,,.   ..,,,,..  ...,,.     ,,,
+       .,,,,,.   .,,,,,   .,,,,,    ,,,,,,,    ,,,,,.   ,,,,,.   .,,,,,.
+      .,.,,,.,,  .,,.      ,,,,      ,,,,,      ,,,,      ,,,.  .,,,,,.,,
+      ,,     ,,, .,.       ,,,,       ,,,       ,,,,       .,.  ,,.    ,,,
+      ,,,..,,,,  ..         ..        ,,,        ..         ..  ,,,,.,,,,
+        ,,,,,,   .                     ,          ,          .    ,,,,,,
+
+    Developers!
+    Have a look at the "alternate" <link> rels for our new data views...
+
+    Did you know we're building a new data service for Parliament?
+    https://pds.blog.parliament.uk/2017/06/23/a-new-data-service-for-parliament/
+
+-->
+<%= render 'pugin/layouts/layout' %>

data/lib/pugin.rb

@@ -1,11 +1,17 @@
 require 'pugin/version'
 
 module Pugin
-  ASSET_VERSION = '1.4.11'.freeze
+  ASSET_VERSION = '1.5.0'.freeze
   ASSET_LOCATION_URL = ENV.fetch('ASSET_LOCATION_URL', 'https://s3-eu-west-1.amazonaws.com/web1devci.pugin-website')
   STATIC_ASSET_LOCATION_URL = ENV.fetch('STATIC_ASSET_LOCATION_URL', 'https://s3-eu-west-1.amazonaws.com/web1devci.static-assets')
 
   class << self
+		attr_writer :alternates
+
+		def alternates
+			@alternates || []
+		end
+
   	# Inspired by bootsrap-sass
   	def load!
   		if rails?

data/lib/pugin/version.rb

@@ -1,3 +1,3 @@
 module Pugin
-  VERSION = '0.8.5'.freeze
+  VERSION = '0.8.6.pre'.freeze
 end

data/spec/pugin_spec.rb

@@ -12,4 +12,26 @@ describe Pugin do
   it 'has an asset version' do
   	expect(Pugin::ASSET_VERSION).not_to be_nil
   end
+
+  describe '#alternates' do
+    context 'with no value set' do
+      it 'returns an empty array' do
+        expect(Pugin.alternates).to eq([])
+      end
+    end
+
+    context 'with a value set' do
+      before :each do
+        Pugin.alternates = [{ type: 'text/foo', href: 'https://api.example.com/' }]
+      end
+
+      after :each do
+        Pugin.alternates = nil
+      end
+
+      it 'returns the value' do
+        expect(Pugin.alternates).to eq([{ type: 'text/foo', href: 'https://api.example.com/' }])
+      end
+    end
+  end
 end

data/spec/views/pugin/layouts/_layout.html.haml_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'haml'
+
+describe 'pugin/layouts/_layout.html.haml', type: :view do
+  before :each do
+    HousesHelper = Class.new
+    allow(HousesHelper).to receive(:commons_id).and_return('123')
+    allow(HousesHelper).to receive(:lords_id).and_return('456')
+    allow(view).to receive(:mps_path).and_return("/mps")
+    allow(view).to receive(:house_members_current_a_z_letter_path).and_return("houses/#{HousesHelper.lords_id}/members/current/a-z/a")
+    allow(view).to receive(:constituencies_current_a_z_letter_path).and_return("constituencies/current/a-z/a")
+    allow(view).to receive(:house_parties_current_path).and_return("houses/#{HousesHelper.commons_id}/parties/current/")
+  end
+
+  it 'renders HAML without errors' do
+    render
+    expect(rendered).to have_title(I18n.t('.pugin.layouts.pugin.website_brand'))
+  end
+
+  context 'with Pugin.alternates set' do
+    let(:alternates) do
+      [
+        { type: 'text/foo', href: 'https://api.example.com/' },
+        { type: 'application/bar', href: 'https://api.example.com/' },
+      ]
+    end
+
+    before :each do
+      allow(Pugin).to receive(:alternates).and_return(alternates)
+      render
+    end
+
+    it 'renders rel-alternate links' do
+      expect(rendered).to include('<link href=\'https://api.example.com/\' rel=\'alternate\' type=\'text/foo\'>')
+      expect(rendered).to include('<link href=\'https://api.example.com/\' rel=\'alternate\' type=\'application/bar\'>')
+    end
+  end
+
+  context 'without Pugin.alternates set' do
+    before :each do
+      allow(Pugin).to receive(:alternates).and_return([])
+      render
+    end
+
+    it 'renders rel-alternate links' do
+      expect(rendered).not_to include('<link href=\'https://api.example.com/\' rel=\'alternate\' type=\'text/foo\'>')
+      expect(rendered).not_to include('<link href=\'https://api.example.com/\' rel=\'alternate\' type=\'application/bar\'>')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pugin
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6.pre
 platform: ruby
 authors:
 - Matt Rayner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -203,8 +203,9 @@ files:
 - app/views/pugin/elements/_skip-content.haml
 - app/views/pugin/javascript/_google_tag_manager.haml
 - app/views/pugin/javascript/_google_tag_manager_noscript.haml
+- app/views/pugin/layouts/_layout.html.haml
 - app/views/pugin/layouts/pugin-sinatra.haml
-- app/views/pugin/layouts/pugin.haml
+- app/views/pugin/layouts/pugin.html.erb
 - app/views/pugin/parties/list/_list.html.haml
 - app/views/pugin/parties/list/current/current_party.html.haml
 - app/views/pugin/parties/list/former/former_party.html.haml
@@ -295,7 +296,7 @@ files:
 - spec/views/pugin/components/_status.html.haml_spec.rb
 - spec/views/pugin/constituencies/list/_list.html.haml_spec.rb
 - spec/views/pugin/elements/_list.html.haml_spec.rb
-- spec/views/pugin/layouts/pugin.html.haml_spec.rb
+- spec/views/pugin/layouts/_layout.html.haml_spec.rb
 - spec/views/pugin/people/list/_list.html.haml
 - spec/views/pugin/people/list/lord/_lord.html.haml
 - spec/views/pugin/people/list/member/_member.html.haml
@@ -314,9 +315,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8
@@ -384,7 +385,7 @@ test_files:
 - spec/lib/pugin/feature/simple_feature_spec.rb
 - spec/lib/pugin/feature/bandiera_spec.rb
 - spec/pugin/engine_spec.rb
-- spec/views/pugin/layouts/pugin.html.haml_spec.rb
+- spec/views/pugin/layouts/_layout.html.haml_spec.rb
 - spec/views/pugin/cards/_person-list.html.haml_spec.rb
 - spec/views/pugin/constituencies/list/_list.html.haml_spec.rb
 - spec/views/pugin/components/_status.html.haml_spec.rb

data/spec/views/pugin/layouts/pugin.html.haml_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-require 'haml'
-
-describe 'pugin/layouts/pugin.html.haml', type: :view do
-  context 'with a fully implemented person' do
-    let(:person) { double('Grom::Node') }
-
-    before :each do
-      allow(person).to receive(:name).and_return('Jane Smith')
-      allow(person).to receive(:position).and_return('Minister for Tests')
-      allow(person).to receive(:id).and_return('123')
-      HousesHelper = Class.new
-      allow(HousesHelper).to receive(:commons_id).and_return('123')
-      allow(HousesHelper).to receive(:lords_id).and_return('456')
-      allow(view).to receive(:mps_path).and_return("/mps")
-      allow(view).to receive(:house_members_current_a_z_letter_path).and_return("houses/#{HousesHelper.lords_id}/members/current/a-z/a")
-      allow(view).to receive(:constituencies_current_a_z_letter_path).and_return("constituencies/current/a-z/a")
-      allow(view).to receive(:house_parties_current_path).and_return("houses/#{HousesHelper.commons_id}/parties/current/")
-    end
-
-    it 'renders HAML without errors' do
-      render
-      expect(rendered).to have_title(I18n.t('.pugin.layouts.pugin.website_brand'))
-    end
-  end
-end