govuk_publishing_components 21.56.1 → 21.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ae35a18ee87f9f8bdbc0b7f05b1874d04f3bcfbebed8eb0fd21dfb178bf1118
-  data.tar.gz: e83b74f0187e3db2687dea59f3dc1f482b3400a7fe24f95d1ba5cb9b1377a94e
+  metadata.gz: 1d31d1f48a5d3491e568c0412fdbbcfaf2e1a98a71aaf84ff703556e83a19b6b
+  data.tar.gz: 45ecc8d0b068dd621f3a5a4fb2b4add39f542cfe14ba22f5a2e9828ae9638438
 SHA512:
-  metadata.gz: 485ae5bca952be5d4bd237148436f7c165cf91aadafdc433cf1dec9a899cbcff4f78c9e9ede0509ffc79511902fcdeeff699ed73e918f2cbcbf08182e8d8da42
-  data.tar.gz: fde1485cf2b9b1849993aa71fee949f39c3f4d08c996c1d9a61de520f3c44d0c25d3fd047d176032fd0c4e7c4862a0b4fe00b926b43e5898424c3e459355ada3
+  metadata.gz: 89fd3c928d07a3cda0079255ea980e7731bda3eb1b9033eeba53131f85f05c12a9073334b17a04b86c050ddd5329fcef28be3ced3373137b6c4385cefb1070aa
+  data.tar.gz: 82d9e99c1d65f4441404f8a76c18ccc11a3357250ac579bdd6844e8f0b57c63d41dfca449cb848b3f86e37576c7e5dcd6eb3e373860c5d1814882ac52a6d3052

data/Rakefile

@@ -29,4 +29,9 @@ namespace :assets do
   end
 end
 
-task default: [:spec, "app:jasmine:ci"]
+desc "Run RuboCop linting"
+task lint: :environment do
+  sh "bundle exec rubocop --format clang"
+end
+
+task default: [:lint, :spec, "app:jasmine:ci"]

data/app/assets/javascripts/govuk_publishing_components/components/details.js

@@ -20,9 +20,11 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
         var detailsClick = detailsComponent.querySelector('[data-details-track-click]')
         var that = this
 
-        $(detailsClick).click(function (e) {
-          that.trackDefault(detailsComponent)
-        })
+        if (detailsClick) {
+          detailsClick.addEventListener('click', function (event) {
+            that.trackDefault(detailsComponent)
+          })
+        }
       }
     }
 
@@ -37,7 +39,7 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
           trackOptions = {}
         }
 
-        trackOptions['label'] = componentStatus
+        trackOptions.label = componentStatus
 
         if (trackAction && trackCategory) {
           window.GOVUK.analytics.trackEvent(trackCategory, trackAction, trackOptions)

data/app/assets/javascripts/govuk_publishing_components/components/print-link.js

@@ -0,0 +1,14 @@
+window.GOVUK = window.GOVUK || {}
+window.GOVUK.Modules = window.GOVUK.Modules || {};
+
+(function (Modules) {
+  'use strict'
+
+  Modules.PrintLink = function () {
+    this.start = function (element) {
+      element[0].addEventListener('click', function () {
+        window.print()
+      })
+    }
+  }
+})(window.GOVUK.Modules)

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

@@ -53,6 +53,7 @@
 @import "components/panel";
 @import "components/phase-banner";
 @import "components/previous-and-next-navigation";
+@import "components/print-link";
 @import "components/radio";
 @import "components/related-navigation";
 @import "components/search";

data/app/assets/stylesheets/govuk_publishing_components/components/_action-link.scss

@@ -118,6 +118,16 @@
 }
 
 .gem-c-action-link--dark-icon {
+  &:before {
+    // sass-lint:disable no-duplicate-properties
+    background: image-url("govuk_publishing_components/action-link-arrow--dark.png");
+    background: image-url("govuk_publishing_components/action-link-arrow--dark.svg"), linear-gradient(transparent, transparent);
+    // sass-lint:enable no-duplicate-properties
+  }
+}
+
+.gem-c-action-link--dark-icon,
+.gem-c-action-link--small-icon {
   max-width: none;
 
   @include govuk-media-query($until: tablet) {
@@ -125,12 +135,8 @@
   }
 
   &:before {
-    width: 30px;
     height: 30px;
-    // sass-lint:disable no-duplicate-properties
-    background: image-url("govuk_publishing_components/action-link-arrow--dark.png");
-    background: image-url("govuk_publishing_components/action-link-arrow--dark.svg"), linear-gradient(transparent, transparent);
-    // sass-lint:enable no-duplicate-properties
+    width: 35px;
     background-repeat: no-repeat;
     background-size: 25px auto;
     background-position: 0 2px;

data/app/assets/stylesheets/govuk_publishing_components/components/_cookie-banner.scss

@@ -12,6 +12,10 @@ $govuk-cookie-banner-background: govuk-colour("light-grey", "grey-4");
   background-color: $govuk-cookie-banner-background;
 }
 
+.gem-c-cookie-banner--services {
+  display: none;
+}
+
 .gem-c-cookie-banner__message {
   display: inline-block;
   padding-bottom: govuk-spacing(2);

data/app/assets/stylesheets/govuk_publishing_components/components/_input.scss

@@ -10,6 +10,7 @@
 // TODO: remove these styles once static is made less aggressive
 .gem-c-input.govuk-input {
   margin: 0;
+  min-width: 0;
   padding: govuk-spacing(1);
 
   &.gem-c-input--search-icon {
@@ -40,16 +41,19 @@
   box-sizing: border-box;
   cursor: default; // emphasise non-editable status of prefixes and suffixes
   display: inline-block;
-  white-space: nowrap;
-  width: auto;
-  text-align: center;
+  flex: 0 0 auto;
   height: 40px;
-  padding: govuk-spacing(1);
+  margin-top: 0;
   min-width: 40px;
+  padding: govuk-spacing(1);
+  text-align: center;
+  white-space: nowrap;
+  width: auto;
+
   @if $govuk-typography-use-rem {
+    height: govuk-px-to-rem(40px);
     min-width: govuk-px-to-rem(40px);
   }
-  margin-top: 0;
 }
 
 .gem-c-input__prefix {

data/app/assets/stylesheets/govuk_publishing_components/components/_list.scss

@@ -0,0 +1 @@
+@import "govuk/components/list/list";

data/app/assets/stylesheets/govuk_publishing_components/components/_print-link.scss

@@ -0,0 +1,52 @@
+.gem-c-print-link {
+  display: none;
+  margin-bottom: 2em;
+  margin-top: 2em;
+}
+
+.gem-c-print-link.gem-c-print-link--show-without-js {
+  display: block;
+}
+
+.js-enabled {
+  .gem-c-print-link {
+    display: block;
+  }
+}
+
+.gem-c-print-link__link {
+  background: image-url("govuk_publishing_components/icon-print.png") no-repeat 10px 50%;
+
+  margin-left: -10px;
+  padding: .5em .5em .5em 38px;
+
+  @include govuk-device-pixel-ratio($ratio: 2) {
+    background-image: image-url("govuk_publishing_components/icon-print-2x.png");
+    background-size: 16px 18px;
+  }
+
+  &:focus {
+    @include govuk-focused-text;
+  }
+}
+
+.gem-c-print-link__button {
+  @extend %govuk-body-s;
+  background: image-url("govuk_publishing_components/icon-print.png") no-repeat 10px 50%;
+  border: 0;
+  color: $govuk-link-colour;
+  cursor: pointer;
+  margin: 0;
+  margin-left: -10px;
+  padding: .5em .5em .5em 38px;
+  text-decoration: underline;
+
+  @include govuk-device-pixel-ratio($ratio: 2) {
+    background-image: image-url("govuk_publishing_components/icon-print-2x.png");
+    background-size: 16px 18px;
+  }
+
+  &:focus {
+    @include govuk-focused-text;
+  }
+}

data/app/assets/stylesheets/govuk_publishing_components/components/_search.scss

@@ -9,6 +9,7 @@ $large-input-size: 50px;
 .gem-c-search__label {
   @include govuk-font($size: 19, $line-height: $input-size);
   display: block;
+  background: govuk-colour("white");
 
   h1 {
     @include govuk-font($size: 19, $line-height: $input-size);
@@ -17,8 +18,10 @@ $large-input-size: 50px;
 
   .js-enabled & {
     position: absolute;
-    left: govuk-spacing(3);
-    top: 1px;
+    left: 2px;
+    top: 2px;
+    bottom: 2px;
+    padding-left: govuk-spacing(3);
     z-index: 1;
     color: $govuk-secondary-text-colour;
   }
@@ -201,6 +204,8 @@ $large-input-size: 50px;
 .gem-c-search--separate-label {
   .gem-c-search__label {
     position: relative;
+    top: auto;
     left: auto;
+    padding-left: 0;
   }
 }

data/app/assets/stylesheets/govuk_publishing_components/components/print/_govspeak.scss

@@ -7,8 +7,12 @@
   .help-notice,
   .call-to-action {
     margin: govuk-spacing(3) 0;
-    padding: 0 govuk-spacing(3);
+  }
+
+  .call-to-action {
+    background: none;
     border: 1pt solid $govuk-border-colour;
+    padding: govuk-spacing(3);
   }
 
   .help-notice p {

data/app/controllers/govuk_publishing_components/audit_controller.rb

@@ -0,0 +1,52 @@
+module GovukPublishingComponents
+  class AuditController < GovukPublishingComponents::ApplicationController
+    def show
+      path = Dir.pwd
+
+      components = AuditComponents.new(path)
+      applications = analyse_applications(File.expand_path("..", path))
+      compared_data = AuditComparer.new(components.data, applications)
+
+      @applications = compared_data.data
+      @components = compared_data.gem_data
+    end
+
+  private
+
+    def analyse_applications(path)
+      results = []
+      applications = %w[
+        calculators
+        collections
+        collections-publisher
+        content-data-admin
+        content-publisher
+        email-alert-frontend
+        feedback
+        finder-frontend
+        frontend
+        government-frontend
+        govspeak-preview
+        info-frontend
+        licence-finder
+        manuals-frontend
+        release
+        search-admin
+        service-manual-frontend
+        signon
+        smart-answers
+        static
+        travel-advice-publisher
+        whitehall
+      ].sort
+
+      applications.each do |application|
+        application_path = [path, application].join("/")
+        app = AuditApplications.new(application_path, application)
+        results << app.data
+      end
+
+      results
+    end
+  end
+end

data/app/controllers/govuk_publishing_components/component_guide_controller.rb

@@ -85,6 +85,7 @@ module GovukPublishingComponents
 
       files = Dir["#{@application_path}/app/views/**/*.html.erb"]
       files.concat Dir["#{@application_path}/app/**/*.rb"]
+      files.concat Dir["#{@application_path}/lib/**/*.rb"]
 
       files.each do |file|
         data = File.read(file)

data/app/models/govuk_publishing_components/audit_applications.rb

@@ -0,0 +1,99 @@
+module GovukPublishingComponents
+  class AuditApplications
+    attr_reader :data
+
+    def initialize(path, name)
+      templates = Dir["#{path}/app/views/**/*.html.erb"]
+      stylesheets = Dir["#{path}/app/assets/stylesheets/**/*.scss"]
+      javascripts = Dir["#{path}/app/assets/javascripts/**/*.js"]
+
+      find_templates = /(?<=govuk_publishing_components\/components\/)[\/a-zA-Z_-]+(?=['"])/
+
+      @find_all_stylesheets = /@import ["']{1}govuk_publishing_components\/all_components/
+      find_stylesheets = /(?<=@import ["']{1}govuk_publishing_components\/components\/)(?!print)+[a-zA-Z_-]+(?=['"])/
+
+      @find_all_print_stylesheets = /@import ["']{1}govuk_publishing_components\/all_components_print/
+      find_print_stylesheets = /(?<=@import ["']{1}govuk_publishing_components\/components\/print\/)[a-zA-Z_-]+(?=['"])/
+
+      @find_all_javascripts = /\/\/[ ]*= require govuk_publishing_components\/all_components/
+      find_javascripts = /(?<=require govuk_publishing_components\/components\/)[a-zA-Z_-]+/
+
+      components_in_templates = find_components(templates, find_templates, "templates") || []
+      components_in_stylesheets = find_components(stylesheets, find_stylesheets, "stylesheets") || []
+      components_in_print_stylesheets = find_components(stylesheets, find_print_stylesheets, "print_stylesheets") || []
+      components_in_javascripts = find_components(javascripts, find_javascripts, "javascripts") || []
+
+      find_ruby = /(?<=render\(["']{1}govuk_publishing_components\/components\/)[a-zA-Z_-]+/
+      ruby_paths = %w[/app/helpers/ /app/presenters/ /lib/]
+
+      components_in_ruby = []
+      ruby_paths.each do |ruby_path|
+        components_in_ruby << find_components(Dir["#{path}#{ruby_path}**/*.rb"], find_ruby, "ruby") || []
+      end
+
+      components_in_ruby = components_in_ruby.flatten.uniq
+
+      @data = {
+        name: name,
+        application_found: application_exists(path),
+        components_found: [
+          {
+            location: "templates",
+            components: components_in_templates,
+          },
+          {
+            location: "stylesheets",
+            components: components_in_stylesheets,
+          },
+          {
+            location: "print_stylesheets",
+            components: components_in_print_stylesheets,
+          },
+          {
+            location: "javascripts",
+            components: components_in_javascripts,
+          },
+          {
+            location: "ruby",
+            components: components_in_ruby,
+          },
+        ],
+      }
+    end
+
+  private
+
+    def find_components(files, find, type)
+      components_found = []
+
+      files.each do |file|
+        src = File.read(file)
+        components_found << find_match(find, src, type)
+      end
+
+      components_found.flatten.uniq.sort
+    end
+
+    def find_match(find, src, type)
+      return %w[all] if src.match(@find_all_stylesheets) && type == "stylesheets"
+      return %w[all] if src.match(@find_all_print_stylesheets) && type == "print_stylesheets"
+      return %w[all] if src.match(@find_all_javascripts) && type == "javascripts"
+
+      matches = src.scan(find)
+      all_matches = []
+      matches.each do |match|
+        all_matches << clean_file_name(match.tr('[])\'"', ""))
+      end
+
+      all_matches
+    end
+
+    def clean_file_name(name)
+      name.tr("_-", " ").strip
+    end
+
+    def application_exists(directory)
+      File.directory?(directory)
+    end
+  end
+end

data/app/models/govuk_publishing_components/audit_comparer.rb

@@ -0,0 +1,172 @@
+module GovukPublishingComponents
+  class AuditComparer
+    attr_reader :data, :gem_data
+
+    def initialize(gem_data, results)
+      @gem_data = gem_data
+      @data = sort_results(results)
+      @gem_data[:components_by_application] = get_components_by_application
+    end
+
+  private
+
+    def prettify_key(key)
+      key.to_s.gsub("_", " ").capitalize
+    end
+
+    def sort_results(results)
+      data = []
+
+      results.each do |result|
+        templates = result[:components_found].find { |c| c[:location] == "templates" }
+        stylesheets = result[:components_found].find { |c| c[:location] == "stylesheets" }
+        print_stylesheets = result[:components_found].find { |c| c[:location] == "print_stylesheets" }
+        javascripts = result[:components_found].find { |c| c[:location] == "javascripts" }
+        ruby = result[:components_found].find { |c| c[:location] == "ruby" }
+
+        @all_stylesheets = true if stylesheets[:components].include?("all")
+        @all_print_stylesheets = true if print_stylesheets[:components].include?("all")
+        @all_javascripts = true if javascripts[:components].include?("all")
+
+        templates[:components] = include_any_components_within_components(templates[:components])
+
+        warnings = []
+        warnings << warn_about_missing_components(result[:components_found])
+        warnings << warn_about_missing_assets(result[:components_found])
+        warnings = warnings.flatten
+
+        data << {
+          name: result[:name],
+          application_found: result[:application_found],
+          summary: [
+            {
+              name: "Components in templates",
+              value: templates[:components].flatten.uniq.sort.join(", "),
+            },
+            {
+              name: "Components in stylesheets",
+              value: stylesheets[:components].join(", "),
+            },
+            {
+              name: "Components in print stylesheets",
+              value: print_stylesheets[:components].join(", "),
+            },
+            {
+              name: "Components in javascripts",
+              value: javascripts[:components].join(", "),
+            },
+            {
+              name: "Components in ruby",
+              value: ruby[:components].join(", "),
+            },
+          ],
+          warnings: warnings,
+          warning_count: warnings.length,
+        }
+      end
+
+      data
+    end
+
+    def include_any_components_within_components(components)
+      @gem_data[:components_containing_components].each do |component|
+        components << component[:sub_components] if components.include?(component[:component])
+      end
+
+      components.flatten.uniq.sort
+    end
+
+    def create_warning(component, message)
+      {
+        component: component,
+        message: message,
+      }
+    end
+
+    def find_missing_items(first_group, second_group)
+      warnings = []
+
+      first_group.each do |first|
+        first_location = first[:location]
+
+        second_group.each do |second|
+          second_location = second[:location]
+          second_location = "code" if %w[templates ruby].include?(second_location)
+          in_current = find_missing(second[:components].clone, first[:components].clone)
+
+          next if second[:components].include?("all")
+
+          in_current.each do |component|
+            if @gem_data.include?("component_#{second_location}".to_sym)
+              warnings << create_warning(component, "Included in #{first_location} but not #{second_location}") if @gem_data["component_#{second_location}".to_sym].include?(component)
+            end
+          end
+        end
+      end
+
+      warnings
+    end
+
+    def warn_about_missing_assets(components)
+      warnings = []
+
+      code = components.select { |c| c[:location] == "templates" || c[:location] == "ruby" }
+      code = [
+        {
+          location: "code",
+          components: code.map { |c| c[:components] }.flatten.uniq.sort,
+        },
+      ]
+      assets = components.select { |c| c[:location] == "stylesheets" || c[:location] == "print_stylesheets" || c[:location] == "javascripts" }
+
+      warnings << find_missing_items(code, assets)
+      warnings << find_missing_items(assets, code)
+      warnings.flatten
+    end
+
+    def warn_about_missing_components(results)
+      warnings = []
+
+      results.each do |result|
+        location = result[:location]
+        result[:components].each do |component|
+          warnings << create_warning(component, "Included in #{location} but component does not exist") if component_does_not_exist(component)
+        end
+      end
+
+      warnings
+    end
+
+    def component_does_not_exist(component)
+      !@gem_data[:component_code].include?(component) unless component == "all"
+    end
+
+    def find_missing(needle, haystack)
+      (haystack - needle).flatten.sort
+    end
+
+    def get_components_by_application
+      results = []
+
+      @gem_data[:component_listing].each do |component|
+        found_in_applications = []
+
+        @data.each do |application|
+          name = application[:name]
+
+          application[:summary].each do |item|
+            found_in_applications << name if item[:value].include?(component[:name])
+          end
+        end
+
+        results << {
+          component: component[:name],
+          count: found_in_applications.uniq.length,
+          list: found_in_applications.uniq.join(", "),
+        }
+      end
+
+      results
+    end
+  end
+end