govuk_publishing_components 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b207862254886d7f7566147383b4e909b81d06d7
-  data.tar.gz: 0da7dab36dedf0afd7963641485212187c81b5b0
+  metadata.gz: a8d9bbd3501a6dc341847fe5f7e1e55862a12a26
+  data.tar.gz: c17cb2fca96844fd7d3038656550fba5cd378e9a
 SHA512:
-  metadata.gz: e3a8ace879c8f22e51142f55eac134aa7d0f4dd93f5b1fcdb5acdf159339c55405fe2a204ec87c468314f3ece7d035ce005ea579566d12a21885f83a53fdbd07
-  data.tar.gz: 5964cab14635b8df4d6e58adb23ab1d542c6c05e4333991231d06de1e919ee17742efa9a303fd60491def7dd5d5c017327638d2962bb17cb19cedea9d3804fea
+  metadata.gz: f608ae560744b49d350b8d72b3ee0062a2ea899ddb76cb0219cf941d8e92336d4681695bb145d810e83670bb64afc5382eb010aa49ceba5a7e72036a68a70eb6
+  data.tar.gz: a2f28ab4fd0aae15e63479a7e2b5afe2c7ee819726bbddd954555b294a973f08f6413f352923e7b66c341f6d5b137effdf741703ed1e2e43a875d9526623fc9d

data/README.md

@@ -81,6 +81,29 @@ rails generate govuk_publishing_components:component [component_name]
 
 This will create a template, scss file and yml documentation file for a new component. It will not create a test file as this cannot be reliably done automatically across applications, but a test file will be necessary.
 
+## Integration with Heroku
+To make the best use of the component guide we use Heroku to serve the current `master` build and whenever a [pull request is added](https://devcenter.heroku.com/articles/github-integration-review-apps)
+
+When an app is deployed to Heroku it will be in `production` mode, so only gems that are in the main group will be installed and made available.
+To ensure that we only load the guide on Heroku and not when deployed to _production_ we need to have the gem included in the main bundle group in the Gemfile.
+For this use case we need `require: false` so that it's not loaded in _production_ but then we can manually `require` the gem in our `application.rb` based on the more complex environmental logic that we've specified.
+
+First move the gem outside of the `development`, `test` groups and set require to false. ([example](https://github.com/alphagov/government-frontend/blob/5110d3d33f7a6b63f218b889a5afec90e6df810f/Gemfile#L11)):
+
+```ruby
+# Gemfile
+gem 'govuk_publishing_components', require: false
+```
+
+Now we can manually require the gem ([example](https://github.com/alphagov/government-frontend/blob/5110d3d33f7a6b63f218b889a5afec90e6df810f/config/application.rb#L14)):
+
+```ruby
+# config/application.rb
+if !Rails.env.production? || ENV['HEROKU_APP_NAME'].present?
+  require 'govuk_publishing_components'
+end
+```
+
 ## Licence
 
 [MIT Licence](LICENCE.md)

data/app/assets/javascripts/govuk_publishing_components/vendor/matches-polyfill.min.js

@@ -0,0 +1 @@
+if(window.Element&&!window.Element.prototype.matches){var proto=window.Element.prototype;proto.matches=proto.matchesSelector||proto.mozMatchesSelector||proto.msMatchesSelector||proto.oMatchesSelector||proto.webkitMatchesSelector};

data/app/controllers/govuk_publishing_components/application_controller.rb

@@ -5,11 +5,16 @@ module GovukPublishingComponents
     include Slimmer::Headers
     protect_from_forgery with: :exception
     before_action :set_custom_slimmer_headers
+    before_action :set_x_frame_options_header
 
   private
 
     def set_custom_slimmer_headers
       set_slimmer_headers(report_a_problem: 'false', remove_search: true)
     end
+
+    def set_x_frame_options_header
+      response.headers["X-Frame-Options"] = "ALLOWALL"
+    end
   end
 end

data/app/models/govuk_publishing_components/component_doc_resolver.rb

@@ -21,10 +21,21 @@ module GovukPublishingComponents
                        component[:name],
                        component[:description],
                        component[:body],
-                       component[:accessibility_criteria],
+                       combined_accessibility_criteria(component),
                        examples)
     end
 
+    def combined_accessibility_criteria(component)
+      shared_accessibility_criteria = []
+
+      if component[:shared_accessibility_criteria].present?
+        component[:shared_accessibility_criteria].each do |criteria|
+          shared_accessibility_criteria << SharedAccessibilityCriteria.send(criteria) if SharedAccessibilityCriteria.respond_to? criteria
+        end
+      end
+      "#{component[:accessibility_criteria]}\n#{shared_accessibility_criteria.join("\n")}"
+    end
+
     def fetch_component_docs
       doc_files = Rails.root.join(documentation_directory, "*.yml")
       Dir[doc_files].sort.map { |file| parse_documentation(file) }

data/app/models/govuk_publishing_components/shared_accessibility_criteria.rb

@@ -0,0 +1,19 @@
+module GovukPublishingComponents
+  module SharedAccessibilityCriteria
+    def self.link
+      "
+Links in the component must:
+
+- accept focus
+- be focusable with a keyboard
+- be usable with a keyboard
+- indicate when it has focus
+- change in appearance when touched (in the touch-down state)
+- change in appearance when hovered
+- be usable with touch
+- be usable with [voice commands](https://www.w3.org/WAI/perspectives/voice.html)
+- have visible text
+      "
+    end
+  end
+end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '1.5.0'.freeze
+  VERSION = '1.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2017-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -179,6 +179,7 @@ files:
 - app/assets/javascripts/govuk_publishing_components/accessibility-test.js
 - app/assets/javascripts/govuk_publishing_components/application.js
 - app/assets/javascripts/govuk_publishing_components/vendor/axe.min.js
+- app/assets/javascripts/govuk_publishing_components/vendor/matches-polyfill.min.js
 - app/assets/stylesheets/govuk_publishing_components/application.scss
 - app/controllers/govuk_publishing_components/application_controller.rb
 - app/controllers/govuk_publishing_components/component_guide_controller.rb
@@ -186,6 +187,7 @@ files:
 - app/models/govuk_publishing_components/component_doc.rb
 - app/models/govuk_publishing_components/component_doc_resolver.rb
 - app/models/govuk_publishing_components/component_example.rb
+- app/models/govuk_publishing_components/shared_accessibility_criteria.rb
 - app/views/govuk_publishing_components/component_guide/component_doc/_call.html.erb
 - app/views/govuk_publishing_components/component_guide/component_doc/_component.html.erb
 - app/views/govuk_publishing_components/component_guide/component_doc/_preview.html.erb