govuk_publishing_components 21.25.0 → 21.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04e2dde0c324eadb613ca21bf75464158fc7736d65fcd76ed49fc39d39b9859b
-  data.tar.gz: 014ed07b9ec95bdf59a243129a2121231aa47f5b39469134e175a4d6ff462a0e
+  metadata.gz: 85bfabc41347e3eabf194ea1267d038be37fb4a7d1f2275a114768760400fdbb
+  data.tar.gz: 94857248756288979fa76c7d836de06a412572d3162b56999b554bf5c48f6d6f
 SHA512:
-  metadata.gz: 52031cc0a250839e6738e617d653fca57d86ce733cf8b945e8d4eb09fb6398d3565aba3bd76d278a27fa19d0c8559b3164720a3a16cf1d15227ddf57f6ecaae5
-  data.tar.gz: b42b626497d9c42c2404ba057a1975116b78adaf9ca3f216e6609f63e468cd57e8c24c8a8f6fe63a0c1506ebf1af464d1a606fe2652d3ca1941ff43b68390c3b
+  metadata.gz: '05045873de72f2d7ee83c5e3ff3409f4617914f012a8dddd7156d5babccc0ad6e7eccc765e89303f301e8721eadee9730e0ebfe66189d3965566f03547ae5405'
+  data.tar.gz: 51a1441882dce26a073c3f18e431346f4ad628487213c19c9d6110398125338f5abc387675e05a93411713e1a6aed8f665bd5dc2a450efd290b31fa5fa3aa5c4

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

@@ -7,6 +7,8 @@
 @import "govuk/helpers/all";
 @import "govuk/core/all";
 
+@import "govuk_publishing_components/all_components";
+
 $gem-guide-border-width: 1px;
 
 .component-list {

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

@@ -0,0 +1,16 @@
+// This file should be included in an application prior to specific components
+// It provides supporting gem component helpers and mixins
+// and everything else from govuk-frontend not included in govuk_frontend_support
+@import "govuk/core/all";
+@import "govuk/objects/all";
+@import "govuk/components/all";
+@import "govuk/utilities/all";
+@import "govuk/overrides/all";
+
+@import "govuk_publishing_components/components/helpers/variables";
+@import "govuk_publishing_components/components/helpers/brand-colours";
+@import "govuk_publishing_components/components/mixins/govuk-template-link-focus-override";
+@import "govuk_publishing_components/components/mixins/media-down";
+@import "govuk_publishing_components/components/mixins/margins";
+@import "govuk_publishing_components/components/mixins/clearfix";
+@import "govuk_publishing_components/components/mixins/css3";

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

@@ -0,0 +1,6 @@
+// This file should be included in an application prior to specific components
+// It provides govuk-frontend but adds no weight to the compiled CSS
+@import "components/helpers/govuk-frontend-settings";
+@import "govuk/settings/all";
+@import "govuk/tools/all";
+@import "govuk/helpers/all";

data/app/controllers/govuk_publishing_components/component_guide_controller.rb

@@ -5,6 +5,9 @@ module GovukPublishingComponents
     def index
       @component_docs = component_docs.all
       @gem_component_docs = gem_component_docs.all
+      @components_in_use_docs = components_in_use_docs.used_in_this_app
+      @components_in_use_sass = components_in_use_sass(false)
+      @components_in_use_print_sass = components_in_use_sass(true)
     end
 
     def show
@@ -36,6 +39,16 @@ module GovukPublishingComponents
       end
     end
 
+    def components_in_use_sass(print_styles)
+      print_path = "print/" if print_styles
+      additional_files = "@import 'govuk_publishing_components/govuk_frontend_support';\n"
+      additional_files << "@import 'govuk_publishing_components/component_support';\n" unless print_styles
+
+      components_in_use.map { |component|
+        "@import 'govuk_publishing_components/components/#{print_path}_#{component.gsub('_', '-')}';" if component_has_sass_file(component.gsub('_', '-'), print_styles)
+      }.join("\n").squeeze("\n").prepend(additional_files)
+    end
+
   private
 
     def component_docs
@@ -46,6 +59,27 @@ module GovukPublishingComponents
       @gem_component_docs ||= ComponentDocs.new(gem_components: true)
     end
 
+    def components_in_use_docs
+      @components_in_use_docs ||= ComponentDocs.new(gem_components: true, limit_to: components_in_use)
+    end
+
+    def components_in_use
+      matches = []
+
+      files = Dir["#{Rails.root}/app/views/**/*.html.erb"]
+      files.each do |file|
+        data = File.read(file)
+        matches << data.scan(/(govuk_publishing_components\/components\/[a-z_-]+)/)
+      end
+
+      matches.flatten.uniq.map(&:to_s).sort.map { |m| m.gsub('govuk_publishing_components/components/', '') }
+    end
+
+    def component_has_sass_file(component, print_styles)
+      print_path = "print/" if print_styles
+      Pathname.new(__dir__ + "/../../assets/stylesheets/govuk_publishing_components/components/#{print_path}_#{component}.scss").exist?
+    end
+
     def index_breadcrumb
       {
         title: GovukPublishingComponents::Config.component_guide_title,

data/app/models/govuk_publishing_components/component_docs.rb

@@ -1,7 +1,8 @@
 module GovukPublishingComponents
   # @private
   class ComponentDocs
-    def initialize(gem_components: false)
+    def initialize(gem_components: false, limit_to: false)
+      @limit_to = limit_to
       @documentation_directory = gem_components ? gem_documentation_directory : app_documentation_directory
     end
 
@@ -14,6 +15,10 @@ module GovukPublishingComponents
       fetch_component_docs.map { |component| build(component) }.sort_by(&:name)
     end
 
+    def used_in_this_app
+      fetch_component_docs.map { |component| build(component) if component_in_use(component[:id]) }.compact.sort_by(&:name)
+    end
+
   private
 
     def build(component)
@@ -25,6 +30,10 @@ module GovukPublishingComponents
       Dir[doc_files].sort.map { |file| parse_documentation(file) }
     end
 
+    def component_in_use(component)
+      return true if @limit_to.include?(component)
+    end
+
     def fetch_component_doc(id)
       file = Rails.root.join(@documentation_directory, "#{id}.yml")
       if !file.exist?

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

@@ -17,8 +17,44 @@
 </form>
 
 <% unless ENV["MAIN_COMPONENT_GUIDE"] %>
-  <h2 class="component-doc-h2">Components in this application</h2>
+  <h2 class="component-doc-h2">Gem components used by this app (<%= @components_in_use_docs.length %>)</h2>
 
+  <%= render "govuk_publishing_components/components/details", {
+    title: "Suggested Sass for this application"
+  } do %>
+    <%= render "govuk_publishing_components/components/textarea", {
+      label: {
+        text: "Add this to your application's main scss file"
+      },
+      name: "main-sass",
+      value: @components_in_use_sass
+    } %>
+    <%= render "govuk_publishing_components/components/textarea", {
+      label: {
+        text: "Add this to your application's print scss file"
+      },
+      name: "print-sass",
+      value: @components_in_use_print_sass
+    } %>
+  <% end %>
+<pre>
+
+</pre>
+
+  <ul class="component-list">
+    <% @components_in_use_docs.each do |component_doc| %>
+      <li>
+        <%= link_to component_doc.name, component_doc_path(component_doc.id), class: "govuk-link" %>
+        <p>
+          <%= component_doc.description %>
+        </p>
+      </li>
+    <% end %>
+  </ul>
+<% end %>
+
+<% unless ENV["MAIN_COMPONENT_GUIDE"] %>
+  <h2 class="component-doc-h2">Components in this application (<%= @component_docs.length %>)</h2>
   <ul class="component-list">
     <% @component_docs.each do |component_doc| %>
       <li>
@@ -30,7 +66,7 @@
     <% end %>
   </ul>
 
-  <h2 class="component-doc-h2">Components in the gem</h2>
+  <h2 class="component-doc-h2">All gem components (<%= @gem_component_docs.length %>)</h2>
 <% end %>
 
 <ul class="component-list">

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '21.25.0'.freeze
+  VERSION = '21.26.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 21.25.0
+  version: 21.26.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -431,6 +431,7 @@ files:
 - app/assets/stylesheets/component_guide/application.scss
 - app/assets/stylesheets/govuk_publishing_components/_all_components.scss
 - app/assets/stylesheets/govuk_publishing_components/_all_components_print.scss
+- app/assets/stylesheets/govuk_publishing_components/component_support.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_accordion.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_attachment-link.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_attachment.scss
@@ -548,6 +549,7 @@ files:
 - app/assets/stylesheets/govuk_publishing_components/components/print/_textarea.scss
 - app/assets/stylesheets/govuk_publishing_components/components/print/_title.scss
 - app/assets/stylesheets/govuk_publishing_components/components/print/_translation-nav.scss
+- app/assets/stylesheets/govuk_publishing_components/govuk_frontend_support.scss
 - app/controllers/govuk_publishing_components/application_controller.rb
 - app/controllers/govuk_publishing_components/component_guide_controller.rb
 - app/helpers/govuk_publishing_components/application_helper.rb