slimmer 9.6.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d37cd678afb1296a6d4cbf84aee3bcd99a74df28
-  data.tar.gz: d2708c4354d2dbf6c4521ee51826636c40a18b3e
+  metadata.gz: b7b991ffcdf6cdee0c893b13695537a444d9272a
+  data.tar.gz: 06bfc18db4b43fd71a9348ea4d2bf0b24113311a
 SHA512:
-  metadata.gz: a3795f3e350eac43b774b3d08acc781b30017f8dd268ce937dc5bcb170023ee48ac1e4fee5081f43a5cc0310eef9f8d24584868e7e1458235d8e9a21ef9cc4ae
-  data.tar.gz: a2b70d4c759b3f0993d3274b5aed1dbc9ff7abbed4ef61f86bbf9b02e260bdfb483f1c1b3c2823d096a91b6f810c40594c8feea7bec208f51954065cfac92ebc
+  metadata.gz: 9edba40f3ccaf964d893580121058a6b5aeba3d7d0112b068006c15251d941ac4960efeebeaec8347550b02364935daa82c602c1102951c47ac8e5cb7b5558dd
+  data.tar.gz: 46e4d0f6bab847439aca310d7e00d4b080e3b0ee2d6d44afc321b0d973550af13c7f4eedaaa3139b487810b3d10c50b812a4fee003868598d8185c7cadd68231

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 10.0.0
+
+* Removes the need_id meta tag, which is no longer used.
+* Removes the functionality for breadcrumbs, related links and artefact-powered
+  metatags.
+* Drop support for old Rails & Ruby versions. This gem now supports Rails 4.2 and 5.X
+  on Ruby 2.1 and 2.2.
+* Renames `Slimmer::SharedTemplates` to `Slimmer::GovukComponents`
+
 # 9.6.0
 
 * Adds an 'inside header inserter' processor which allows an application to
@@ -19,7 +28,7 @@
 
 * Adds an RSpec helper that makes it easy for host applications to
   configure Slimmer correctly under test.
-  
+
   Fixes `stub_shared_component_locales` helper to correctly stub HTTP
   requests to fetch locale information when rendering its templates.
 

data/README.md

@@ -44,7 +44,7 @@ To get asset tag helpers to point to your external asset server, add
 ```rb
 config.action_controller.asset_host = "http://my.alternative.host"
 ```
-    
+
 to `application.rb`.
 
 ## Specifying a template
@@ -101,25 +101,25 @@ YourApp::Application.configure do
 end
 ```
 
-## Shared components
+## GOV.UK Components
 
-To use shared template components you need to include the shared template resolver
+To use [shared template components](https://govuk-component-guide.herokuapp.com/) you need to include the GOV.UK component module:
 
 ```rb
 class ApplicationController < ActionController::Base
-  include Slimmer::SharedTemplates
+  include Slimmer::GovukComponents
 end
 ```
 
-This will make calls out to static when you try and render a partial prefixed with `govuk-component`:
+This will make calls out to static when you try and render a partial prefixed with `govuk_component`:
 
 ```erb
-<%= render partial: 'govuk-component/example_component' %>
+<%= render partial: 'govuk_component/example_component' %>
 ```
 
 You will need a copy of static running for the templates to be loaded from.
 
-### Testing shared components
+### Testing components
 
 In test mode (when `Rails.env.test?` returns `true`), shared components are not
 fetched from Static. Instead they are rendered as a dummy tag which contains a
@@ -130,8 +130,8 @@ component to assert that it was used. You can make it available in your tests
 with:
 
 ```rb
-require 'slimmer/test_helpers/shared_templates'
-include Slimmer::TestHelpers::SharedTemplates
+require 'slimmer/test_helpers/govuk_components'
+include Slimmer::TestHelpers::GovukComponents
 ```
 
 And then assert that the component has been used:

data/lib/slimmer.rb

@@ -16,9 +16,8 @@ module Slimmer
   autoload :Template, 'slimmer/template'
   autoload :App, 'slimmer/app'
   autoload :Headers, 'slimmer/headers'
-  autoload :Artefact, 'slimmer/artefact'
 
-  autoload :SharedTemplates, 'slimmer/shared_templates'
+  autoload :GovukComponents, 'slimmer/govuk_components'
   autoload :ComponentResolver, 'slimmer/component_resolver'
   autoload :I18nBackend, 'slimmer/i18n_backend'
 
@@ -31,13 +30,11 @@ module Slimmer
     autoload :HeaderContextInserter, 'slimmer/processors/header_context_inserter'
     autoload :InsideHeaderInserter, 'slimmer/processors/inside_header_inserter'
     autoload :NavigationMover, 'slimmer/processors/navigation_mover'
-    autoload :RelatedItemsInserter, 'slimmer/processors/related_items_inserter'
     autoload :ReportAProblemInserter, 'slimmer/processors/report_a_problem_inserter'
     autoload :SearchIndexSetter, 'slimmer/processors/search_index_setter'
     autoload :SearchPathSetter, 'slimmer/processors/search_path_setter'
     autoload :SearchParameterInserter, 'slimmer/processors/search_parameter_inserter'
     autoload :SearchRemover, 'slimmer/processors/search_remover'
-    autoload :SectionInserter, 'slimmer/processors/section_inserter'
     autoload :TagMover, 'slimmer/processors/tag_mover'
     autoload :TitleInserter, 'slimmer/processors/title_inserter'
   end

data/lib/slimmer/cucumber.rb

@@ -1,9 +1,9 @@
 require 'cucumber'
 
 require 'slimmer/test'
-require 'slimmer/test_helpers/shared_templates'
+require 'slimmer/test_helpers/govuk_components'
 
-World(Slimmer::TestHelpers::SharedTemplates)
+World(Slimmer::TestHelpers::GovukComponents)
 
 Before do
   stub_shared_component_locales

data/lib/slimmer/{shared_templates.rb → govuk_components.rb}

@@ -1,10 +1,10 @@
 module Slimmer
-  module SharedTemplates
+  module GovukComponents
     def self.included into
-      into.before_action :add_shared_templates
+      into.before_action :add_govuk_components
     end
 
-    def add_shared_templates
+    def add_govuk_components
       append_view_path Slimmer::ComponentResolver.new
 
       return if slimmer_backend_included?

data/lib/slimmer/headers.rb

@@ -20,7 +20,6 @@ module Slimmer
     }
 
     APPLICATION_NAME_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:application_name]}"
-    ARTEFACT_HEADER = "#{HEADER_PREFIX}-Artefact"
     FORMAT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:format]}"
     ORGANISATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:organisations]}"
     REPORT_A_PROBLEM_FORM = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:report_a_problem]}"
@@ -40,46 +39,5 @@ module Slimmer
         headers["#{HEADER_PREFIX}-#{header_suffix}"] = value.to_s if value
       end
     end
-
-    def set_slimmer_artefact(artefact_input)
-      if artefact_input.is_a?(Hash) or artefact_input.is_a?(OpenStruct)
-        artefact = artefact_input.dup
-      elsif artefact_input.respond_to?(:to_hash)
-        artefact = artefact_input.to_hash
-      end
-      yield artefact if block_given?
-      headers[ARTEFACT_HEADER] = artefact.to_json
-    end
-
-    def set_slimmer_artefact_overriding_section(artefact_input, details = {})
-      set_slimmer_artefact(artefact_input) do |artefact|
-        if tag = slimmer_section_tag_for_details(details)
-          artefact["tags"] = [tag] + (artefact["tags"] || [])
-        end
-      end
-    end
-
-    def set_slimmer_dummy_artefact(details = {})
-      set_slimmer_artefact({}) do |artefact|
-        artefact["title"] = details[:title] if details[:title]
-        if tag = slimmer_section_tag_for_details(details)
-          artefact["tags"] = [tag]
-        end
-      end
-    end
-
-    def slimmer_section_tag_for_details(details)
-      if details[:section_name] and details[:section_link]
-        tag = {
-          "title" => details[:section_name],
-          "details" => {"type" => "section"},
-          "content_with_tag" => {"web_url" => details[:section_link]},
-        }
-        if details[:parent]
-          tag["parent"] = slimmer_section_tag_for_details(details[:parent])
-        end
-        tag
-      end
-    end
   end
 end

data/lib/slimmer/processors/metadata_inserter.rb

@@ -1,19 +1,13 @@
 module Slimmer::Processors
   class MetadataInserter
-    def initialize(response, artefact, app_name)
+    def initialize(response, app_name)
       @headers = response.headers
-      @artefact = artefact
       @app_name = app_name
     end
 
     def filter(src, dest)
       head = dest.at_css('head')
 
-      if @artefact
-        add_meta_tag('section', @artefact.primary_root_section["title"].downcase, head) if @artefact.primary_root_section
-        add_meta_tag('need-ids', @artefact.need_ids.join(',').downcase, head) if @artefact.need_ids
-      end
-
       add_meta_tag('analytics:organisations', @headers[Slimmer::Headers::ORGANISATIONS_HEADER], head)
       add_meta_tag('analytics:world-locations', @headers[Slimmer::Headers::WORLD_LOCATIONS_HEADER], head)
       add_meta_tag('format', @headers[Slimmer::Headers::FORMAT_HEADER], head)

data/lib/slimmer/rspec.rb

@@ -2,10 +2,10 @@ require 'rspec/core'
 
 require 'slimmer'
 require 'slimmer/test'
-require 'slimmer/test_helpers/shared_templates'
+require 'slimmer/test_helpers/govuk_components'
 
 RSpec.configure do |config|
-  config.include Slimmer::TestHelpers::SharedTemplates
+  config.include Slimmer::TestHelpers::GovukComponents
 
   config.before { stub_shared_component_locales }
 end

data/lib/slimmer/skin.rb

@@ -104,7 +104,6 @@ module Slimmer
     end
 
     def success(source_request, response, body)
-      artefact = artefact_from_header(response)
       wrapper_id = options[:wrapper_id] || 'wrapper'
       processors = [
         Processors::TitleInserter.new(),
@@ -115,11 +114,9 @@ module Slimmer
         Processors::BodyClassCopier.new,
         Processors::InsideHeaderInserter.new,
         Processors::HeaderContextInserter.new(),
-        Processors::SectionInserter.new(artefact),
-        Processors::MetadataInserter.new(response, artefact, options[:app_name]),
+        Processors::MetadataInserter.new(response, options[:app_name]),
         Processors::SearchParameterInserter.new(response),
         Processors::SearchPathSetter.new(response),
-        Processors::RelatedItemsInserter.new(self, artefact),
         Processors::ReportAProblemInserter.new(self,
                                                source_request.url,
                                                response.headers,
@@ -137,16 +134,5 @@ module Slimmer
       ]
       process(processors, body, template(template_name), rack_env)
     end
-
-    def artefact_from_header(response)
-      if response.headers.include?(Headers::ARTEFACT_HEADER)
-        Artefact.new JSON.parse(response.headers[Headers::ARTEFACT_HEADER])
-      else
-        nil
-      end
-    rescue JSON::ParserError => e
-      logger.error "Slimmer: Failed while parsing artefact header: #{[ e.message, e.backtrace ].flatten.join("\n")}"
-      nil
-    end
   end
 end

data/lib/slimmer/test_helpers/{shared_templates.rb → govuk_components.rb}

@@ -2,7 +2,7 @@ require 'webmock'
 
 module Slimmer
   module TestHelpers
-    module SharedTemplates
+    module GovukComponents
       def stub_shared_component_locales
         stub_request(:get, /https?:\/\/\S+.gov.uk\/templates\/locales\/.+/).
           to_return(status: 400, headers: {})

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '9.6.0'
+  VERSION = '10.0.0'
 end

data/test/headers_test.rb

@@ -49,142 +49,9 @@ class HeadersTest < MiniTest::Test
     assert_equal "rhubarb", headers["X-Slimmer-Skip"]
   end
 
-  def test_should_skip_missing_headers
-    set_slimmer_headers section: "rhubarb"
-    refute_includes headers.keys, "X-Slimmer-Need-ID"
-  end
-
   def test_should_raise_an_exception_if_a_header_has_a_typo
     assert_raises Slimmer::Headers::InvalidHeader do
       set_slimmer_headers seccion: "wrong"
     end
   end
 end
-
-describe Slimmer::Headers do
-  include Slimmer::Headers
-  attr_accessor :headers
-
-  before do
-    self.headers = {}
-  end
-
-  describe "setting the artefact header" do
-    it "should convert a hash to JSON and insert into the header" do
-      artefact = {"foo" => "bar"}
-      self.set_slimmer_artefact(artefact)
-      assert_equal artefact.to_json, headers[Slimmer::Headers::ARTEFACT_HEADER]
-    end
-
-    it "should convert an OpenStruct to JSON" do
-      artefact = OpenStruct.new("foo" => "bar")
-      self.set_slimmer_artefact(artefact)
-      assert_equal({"foo" => "bar"}.to_json, headers[Slimmer::Headers::ARTEFACT_HEADER])
-    end
-
-    it "should handle an object that responds to :to_hash" do
-      hash = {"foo" => "bar", "slug" => "vat-rates"}
-      artefact = stub("Response", :to_hash => hash)
-      self.set_slimmer_artefact(artefact)
-      assert_equal hash.to_json, headers[Slimmer::Headers::ARTEFACT_HEADER]
-    end
-
-    it "should not have side-effects on the passed in hash" do
-      artefact = {"foo" => "bar", "slug" => "vat-rates", "actions" => "some_actions"}
-      artefact_copy = artefact.dup
-      self.set_slimmer_artefact(artefact)
-      assert_equal artefact_copy, artefact
-    end
-  end
-
-  describe "setting the artefact and adding a dummy section" do
-    it "should setup a section tag for the given name and link" do
-      artefact_input = {"foo" => "bar", "slug" => "vat-rates", "actions" => "some_actions"}
-      self.set_slimmer_artefact_overriding_section(artefact_input, :section_name => "Foo", :section_link => "/something/foo")
-
-      artefact = JSON.parse(headers[Slimmer::Headers::ARTEFACT_HEADER])
-
-      assert_equal "Foo", artefact["tags"][0]["title"]
-      assert_equal "section", artefact["tags"][0]["details"]["type"]
-      assert_equal "/something/foo", artefact["tags"][0]["content_with_tag"]["web_url"]
-    end
-
-    it "should not overwrite existing tags" do
-      artefact_input = {"foo" => "bar", "slug" => "vat-rates", "actions" => "some_actions", "tags" => ["foo", "bar"]}
-      self.set_slimmer_artefact_overriding_section(artefact_input, :section_name => "Foo", :section_link => "/something/foo")
-
-      artefact = JSON.parse(headers[Slimmer::Headers::ARTEFACT_HEADER])
-
-      assert_equal ["foo", "bar"], artefact["tags"][1..-1]
-    end
-
-    it "should not have side-effects on the passed in hash" do
-      artefact_input = {"foo" => "bar", "slug" => "vat-rates", "actions" => "some_actions"}
-      artefact_copy = artefact_input.dup
-      self.set_slimmer_artefact_overriding_section(artefact_input, :section_name => "Foo", :section_link => "/foo")
-      assert_equal artefact_copy, artefact_input
-    end
-
-    it "should work correctly with a gds_api response object" do
-      input_artefact = {"foo" => "bar", "slug" => "vat-rates", "actions" => "some_actions"}
-      api_response = GdsApi::Response.new(stub("HTTP Response", :code => 200, :body => input_artefact.to_json))
-      self.set_slimmer_artefact_overriding_section(api_response, :section_name => "Foo", :section_link => "/something/foo")
-
-      artefact = JSON.parse(headers[Slimmer::Headers::ARTEFACT_HEADER])
-
-      assert_equal "Foo", artefact["tags"][0]["title"]
-      assert_equal "section", artefact["tags"][0]["details"]["type"]
-      assert_equal "/something/foo", artefact["tags"][0]["content_with_tag"]["web_url"]
-    end
-  end
-
-  describe "setting a dummy artefact in the artefact header" do
-    it "should setup an artefact title" do
-      self.set_slimmer_dummy_artefact(:title => "Foo")
-
-      artefact = JSON.parse(headers[Slimmer::Headers::ARTEFACT_HEADER])
-
-      assert_equal "Foo", artefact["title"]
-    end
-
-    it "should setup a section tag for the given name and link" do
-      self.set_slimmer_dummy_artefact(:section_name => "Foo", :section_link => "/something/foo")
-
-      artefact = JSON.parse(headers[Slimmer::Headers::ARTEFACT_HEADER])
-
-      assert_equal "Foo", artefact["tags"][0]["title"]
-      assert_equal "section", artefact["tags"][0]["details"]["type"]
-      assert_equal "/something/foo", artefact["tags"][0]["content_with_tag"]["web_url"]
-    end
-
-    it "can set up a section tag with multiple levels of parents" do
-      self.set_slimmer_dummy_artefact(
-        :section_name => "Foo",
-        :section_link => "/something/baz/bar/foo",
-        :parent => {
-          :section_name => "Bar",
-          :section_link => "/something/baz/bar",
-          :parent => {
-            :section_name => "Baz",
-            :section_link => "/something/baz"
-          }
-        }
-      )
-
-      artefact = JSON.parse(headers[Slimmer::Headers::ARTEFACT_HEADER])
-
-      assert_equal "Foo", artefact["tags"][0]["title"]
-      assert_equal "section", artefact["tags"][0]["details"]["type"]
-      assert_equal "/something/baz/bar/foo", artefact["tags"][0]["content_with_tag"]["web_url"]
-
-      assert_equal "Bar", artefact["tags"][0]["parent"]["title"]
-      assert_equal "section", artefact["tags"][0]["parent"]["details"]["type"]
-      assert_equal "/something/baz/bar", artefact["tags"][0]["parent"]["content_with_tag"]["web_url"]
-
-      assert_equal "Baz", artefact["tags"][0]["parent"]["parent"]["title"]
-      assert_equal "section", artefact["tags"][0]["parent"]["parent"]["details"]["type"]
-      assert_equal "/something/baz", artefact["tags"][0]["parent"]["parent"]["content_with_tag"]["web_url"]
-
-    end
-  end
-end

data/test/processors/metadata_inserter_test.rb

@@ -31,14 +31,9 @@ module MetadataInserterTest
     def setup
       super
 
-      artefact = artefact_for_slug_in_a_subsection("something", "rhubarb/in-puddings")
-      artefact["details"].merge!(
-        "need_ids" => [100001,100002],
-      )
       headers = {
         Slimmer::Headers::FORMAT_HEADER => "custard",
         Slimmer::Headers::RESULT_COUNT_HEADER => "3",
-        Slimmer::Headers::ARTEFACT_HEADER => artefact.to_json,
         Slimmer::Headers::ORGANISATIONS_HEADER => "<P1><D422>",
         Slimmer::Headers::WORLD_LOCATIONS_HEADER => "<WL3>"
       }
@@ -46,18 +41,10 @@ module MetadataInserterTest
       given_response 200, GENERIC_DOCUMENT, headers
     end
 
-    def test_should_include_section_meta_tag
-      assert_meta_tag "section", "rhubarb"
-    end
-
     def test_should_include_format_meta_tag
       assert_meta_tag "format", "custard"
     end
 
-    def test_should_include_need_ids_meta_tag
-      assert_meta_tag "need-ids", "100001,100002"
-    end
-
     def test_should_include_organisations_meta_tag
       assert_meta_tag "analytics:organisations", "<P1><D422>"
     end
@@ -71,28 +58,6 @@ module MetadataInserterTest
     end
   end
 
-  class WithInvalidAttributes < SlimmerIntegrationTest
-    include MetaTagAssertions
-
-    def setup
-      super
-    end
-
-    def test_should_skip_passing_need_ids_if_they_are_nil
-      artefact = artefact_for_slug_in_a_subsection("something", "rhubarb/in-puddings")
-      headers = {
-        Slimmer::Headers::ARTEFACT_HEADER => artefact.to_json,
-        Slimmer::Headers::FORMAT_HEADER => "custard"
-      }
-      given_response 200, GENERIC_DOCUMENT, headers
-
-      refute_meta_tag "need-ids"
-      # the presence of these attributes tests that the nil check worked
-      assert_meta_tag "section", "rhubarb"
-      assert_meta_tag "format", "custard"
-    end
-  end
-
   class WithoutHeadersTest < SlimmerIntegrationTest
     include MetaTagAssertions
 
@@ -106,10 +71,6 @@ module MetadataInserterTest
       refute_meta_tag "format"
     end
 
-    def test_should_omit_need_ID
-      refute_meta_tag "need-ids"
-    end
-
     def test_should_omit_organisations
       refute_meta_tag "analytics:organisations"
     end
@@ -122,28 +83,4 @@ module MetadataInserterTest
       refute_meta_tag "search-result-count"
     end
   end
-
-  class WithNilHeaderTest < SlimmerIntegrationTest
-    include MetaTagAssertions
-
-    def setup
-      super
-
-      artefact = artefact_for_slug_in_a_subsection("something", "rhubarb/in-puddings")
-      artefact["details"].merge!(
-        "need_ids" => [100001, 100002],
-      )
-      headers = {
-        Slimmer::Headers::RESULT_COUNT_HEADER => "3",
-        Slimmer::Headers::ARTEFACT_HEADER => artefact.to_json,
-        Slimmer::Headers::ORGANISATIONS_HEADER => "<P1><D422>"
-      }
-
-      given_response 200, GENERIC_DOCUMENT, headers
-    end
-
-    def test_should_include_organisation_meta_tag_without_crashing
-      assert_meta_tag "analytics:organisations", "<P1><D422>"
-    end
-  end
 end