govuk-components 0.5.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa7fa8f024a27bd045223fc37e575201c45a3dad2c09e70cef94d141b8d8530b
-  data.tar.gz: fbbf3aa3f874a3cd92f51185ddfc3822c4c60c4396d69dc7b790b0da54370361
+  metadata.gz: '094a8aaa90e8f699ce0844e4770b91f8fc62b7481d9cd2be1fbe480726163f96'
+  data.tar.gz: b170c99c2ac73c56bf502f26ba232d2abfef6459cebf52c53677e70b8a84c646
 SHA512:
-  metadata.gz: b85ce98f023c5b80694ce1184b42292982de71e40ae225514d5e16b8ba6d42e0a32b9614b92b7a5863c9b0af9a9e76605941ba6230bc25a278b16784dd182a07
-  data.tar.gz: 042e6e923591e2e03a8d246639607614ef998acea7ad0e2a6e1a5cf7fe419c067175f20da3aa4b7ea1631976686bd07f6ffbf7a1b3e905ba8bf45462034e365c
+  metadata.gz: 7802eb767bbcf892ab6f3fa5c149db8629f1002bafc2a787e15e67f6317d33df7f23f646f39d92280b8d3db542537ea2b023823548180e51e79042ad19401c18
+  data.tar.gz: f5b2381662b5c79be177c19a5fa98757e61b8f852f28316b7c12cf3589164bf582f20b83a6632f00576d723597063c130dfcb84db6e1d52a0f7fa6971b3e3c21

data/README.md

@@ -1,29 +1,33 @@
-**This gem is under heavy development and the API is likely to change.**
-
 # GOV.UK Components
 
-[![Build Status](https://travis-ci.com/DFE-Digital/govuk-components.svg?branch=master)](https://travis-ci.com/DFE-Digital/govuk-components)
+[![Tests](https://github.com/DFE-Digital/govuk-components/workflows/Tests/badge.svg)](https://github.com/DFE-Digital/govuk-components/actions?query=workflow%3ATests)
+[![Maintainability](https://api.codeclimate.com/v1/badges/cbcbc140f300b920d833/maintainability)](https://codeclimate.com/github/DFE-Digital/govuk-components/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/cbcbc140f300b920d833/test_coverage)](https://codeclimate.com/github/DFE-Digital/govuk-components/test_coverage)
+[![GitHub license](https://img.shields.io/github/license/DFE-Digital/govuk-components)](https://github.com/DFE-Digital/govuk-components/blob/master/LICENSE)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=DFE-Digital/govuk-components)](https://dependabot.com)
+[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-3.10.2-brightgreen)](https://design-system.service.gov.uk)
 
 This gem provides a suite of reusable components for the [GOV.UK Design System](https://design-system.service.gov.uk/). It is intended to provide a lightweight alternative to the [GOV.UK Publishing Components](https://github.com/alphagov/govuk_publishing_components) library and is built with Github's [ViewComponent](https://github.com/github/view_component) framework.  ViewComponent will be [supported natively in Rails 6.1](https://edgeguides.rubyonrails.org/layouts_and_rendering.html#rendering-objects).
 
 ## What's included
 
-| Component name                                                         | Helper                   |
-| --------------                                                         | ------                   |
-| [Accordion](app/components/govuk_component/accordion.rb)               | `govuk_accordion`        |
-| [Back link](app/components/govuk_component/back_link.rb)               | `govuk_back_link`        |
-| [Breadcrumbs](app/components/govuk_component/breadcrumbs.rb)           | `govuk_breadcrumbs`      |
-| [Details](app/components/govuk_component/details.rb)                   | `govuk_details`          |
-| [Footer](app/components/govuk_component/footer.rb)                     | `govuk_footer`           |
-| [Header](app/components/govuk_component/header.rb)                     | `govuk_header`           |
-| [Inset text](app/components/govuk_component/inset_text.rb)             | `govuk_inset_text`       |
-| [Panel](app/components/govuk_component/panel.rb)                       | `govuk_panel`            |
-| [Phase banner](app/components/govuk_component/phase_banner.rb)         | `govuk_phase_banner`     |
-| [Start now button](app/components/govuk_component/start_now_button.rb) | `govuk_start_now_button` |
-| [Summary list](app/components/govuk_component/summary_list.rb)         | `govuk_summary_list`     |
-| [Tabs](app/components/govuk_component/tabs.rb)                         | `govuk_tabs`             |
-| [Tag](app/components/govuk_component/tag.rb)                           | `govuk_tag`              |
-| [Warning text](app/components/govuk_component/warning.rb)              | `govuk_warning`          |
+| Component name                                                               | Helper                      |
+| --------------                                                               | ------                      |
+| [Accordion](app/components/govuk_component/accordion.rb)                     | `govuk_accordion`           |
+| [Back link](app/components/govuk_component/back_link.rb)                     | `govuk_back_link`           |
+| [Breadcrumbs](app/components/govuk_component/breadcrumbs.rb)                 | `govuk_breadcrumbs`         |
+| [Details](app/components/govuk_component/details.rb)                         | `govuk_details`             |
+| [Footer](app/components/govuk_component/footer.rb)                           | `govuk_footer`              |
+| [Header](app/components/govuk_component/header.rb)                           | `govuk_header`              |
+| [Inset text](app/components/govuk_component/inset_text.rb)                   | `govuk_inset_text`          |
+| [Notification banner](app/components/govuk_component/notification_banner.rb) | `govuk_notification_banner` |
+| [Panel](app/components/govuk_component/panel.rb)                             | `govuk_panel`               |
+| [Phase banner](app/components/govuk_component/phase_banner.rb)               | `govuk_phase_banner`        |
+| [Start now button](app/components/govuk_component/start_now_button.rb)       | `govuk_start_now_button`    |
+| [Summary list](app/components/govuk_component/summary_list.rb)               | `govuk_summary_list`        |
+| [Tabs](app/components/govuk_component/tabs.rb)                               | `govuk_tabs`                |
+| [Tag](app/components/govuk_component/tag.rb)                                 | `govuk_tag`                 |
+| [Warning text](app/components/govuk_component/warning.rb)                    | `govuk_warning`             |
 
 ### Helpers
 

data/app/components/govuk_component/base.rb

@@ -11,7 +11,7 @@ class GovukComponent::Base < ViewComponent::Base
   # with slots feel more DSL-like
   def self.wrap_slot(name)
     define_method(%(add_#{name})) do |*args, **kwargs, &block|
-      self.slot(name, *args, **kwargs, &block)
+      slot(name, *args, **kwargs, &block)
     end
   end
 end

data/app/components/govuk_component/footer.rb

@@ -29,7 +29,7 @@ private
   end
 
   def default_licence
-    link = link_to("Open Government Licence v3.0", "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/")
+    link = link_to("Open Government Licence v3.0", "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/", class: %w(govuk-footer__link))
 
     raw(%(All content is available under the #{link}, except where otherwise stated))
   end

data/app/components/govuk_component/notification_banner.html.erb

@@ -0,0 +1,19 @@
+<%= tag.div(class: classes.append(success_class).compact, **html_attributes, role: "region", aria: { labelledby: title_id }, data: data_params) do %>
+  <div class="govuk-notification-banner__header">
+    <%= content_tag(title_tag, class: "govuk-notification-banner__title", id: title_id) do %>
+      <%= title %>
+    <% end %>
+  </div>
+  <div class="govuk-notification-banner__content">
+    <% headings.each do |heading| %>
+      <p class="govuk-notification-banner__heading">
+        <%= heading.text %>
+        <% if heading.link_target && heading.link_text %>
+          <%= link_to(heading.link_text, heading.link_target, class: "govuk-notification-banner__link") %>.
+        <% end %>
+      </p>
+    <% end %>
+
+    <%= content %>
+  </div>
+<% end %>

data/app/components/govuk_component/notification_banner.rb

@@ -0,0 +1,59 @@
+class GovukComponent::NotificationBanner < GovukComponent::Base
+  attr_reader :title, :title_id, :success, :title_heading_level, :disable_auto_focus
+
+  include ViewComponent::Slotable
+  with_slot :heading, collection: true, class_name: 'Heading'
+  wrap_slot(:heading)
+
+  def initialize(title:, success: false, title_heading_level: 2, title_id: "govuk-notification-banner-title", disable_auto_focus: nil, classes: [], html_attributes: {})
+    super(classes: classes, html_attributes: html_attributes)
+
+    @title               = title
+    @title_id            = title_id
+    @success             = success
+    @title_heading_level = title_heading_level
+    @disable_auto_focus  = disable_auto_focus
+  end
+
+  def success_class
+    %(govuk-notification-banner--success) if success?
+  end
+
+  def success?
+    @success
+  end
+
+  def render?
+    headings.any?
+  end
+
+  def title_tag
+    fail "title_heading_level must be a number between 1 and 6" unless title_heading_level.is_a?(Integer) && title_heading_level.in?(1..6)
+
+    "h#{title_heading_level}"
+  end
+
+  class Heading < ViewComponent::Slot
+    attr_accessor :text, :link_target, :link_text
+
+    def initialize(text:, link_text: nil, link_target: nil)
+      @text = text
+      @link_text = link_text
+      @link_target = link_target
+    end
+
+    def default_classes
+      %w(govuk-notification-banner__heading)
+    end
+  end
+
+private
+
+  def default_classes
+    %w(govuk-notification-banner)
+  end
+
+  def data_params
+    { "module" => "govuk-notification-banner", "disable-auto-focus" => disable_auto_focus }.compact
+  end
+end

data/app/components/govuk_component/tag.rb

@@ -21,7 +21,7 @@ private
   end
 
   def colour_class
-    return nil unless @colour.present?
+    return nil if @colour.blank?
 
     fail("invalid tag colour #{@colour}, supported colours are #{COLOURS.to_sentence}") unless @colour.in?(COLOURS)
 

data/app/components/govuk_component/traits/custom_classes.rb

@@ -1,7 +1,6 @@
 module GovukComponent
   module Traits
     module CustomClasses
-
       def classes
         default_classes.concat(Array.wrap(@classes))
       end
@@ -15,7 +14,7 @@ module GovukComponent
     private
 
       def parse_classes(classes)
-        return [] unless classes.present?
+        return [] if classes.blank?
 
         case classes
         when Array

data/app/helpers/govuk_components_helper.rb

@@ -7,6 +7,7 @@ module GovukComponentsHelper
     govuk_footer: 'GovukComponent::Footer',
     govuk_header: 'GovukComponent::Header',
     govuk_inset_text: 'GovukComponent::InsetText',
+    govuk_notification_banner: 'GovukComponent::NotificationBanner',
     govuk_panel: 'GovukComponent::Panel',
     govuk_phase_banner: 'GovukComponent::PhaseBanner',
     govuk_start_now_button: 'GovukComponent::StartNowButton',
@@ -18,7 +19,7 @@ module GovukComponentsHelper
     define_method(name) do |*args, **kwargs, &block|
       capture do
         render(klass.constantize.new(*args, **kwargs)) do |com|
-          block.call(com) unless block.blank?
+          block.call(com) if block.present?
         end
       end
     end

data/app/helpers/govuk_link_helper.rb

@@ -1,14 +1,26 @@
 module GovukLinkHelper
-  def govuk_link_to(*args, **kwargs, &block)
-    link_to(*args, **{ class: 'govuk-link' }.deep_merge(kwargs), &block)
+  def govuk_link_to(*args, button: false, **kwargs, &block)
+    link_to(*args, **inject_class(kwargs, class_name: link_class(button)), &block)
   end
 
-  def govuk_mail_to(*args, **kwargs, &block)
-    mail_to(*args, **{ class: 'govuk-link' }.deep_merge(kwargs), &block)
+  def govuk_mail_to(*args, button: false, **kwargs, &block)
+    mail_to(*args, **inject_class(kwargs, class_name: link_class(button)), &block)
   end
 
   def govuk_button_to(*args, **kwargs)
-    button_to(*args, **{ class: 'govuk-button' }.deep_merge(kwargs))
+    button_to(*args, **inject_class(kwargs, class_name: 'govuk-button'))
+  end
+
+private
+
+  def inject_class(attributes, class_name:)
+    attributes.with_indifferent_access.tap do |attrs|
+      attrs[:class] = Array.wrap(attrs[:class]).prepend(class_name)
+    end
+  end
+
+  def link_class(button)
+    button ? 'govuk-button' : 'govuk-link'
   end
 end
 

data/lib/govuk/components/engine.rb

@@ -6,4 +6,4 @@ module Govuk
   end
 end
 
-Dir[Govuk::Components::Engine.root.join(*%w(app helpers *.rb))].each { |f| require f }
+Dir[Govuk::Components::Engine.root.join("app", "helpers", "*.rb")].sort.each { |f| require f }

data/lib/govuk/components/version.rb

@@ -1,5 +1,5 @@
 module Govuk
   module Components
-    VERSION = '0.5.0'
+    VERSION = '1.0.1'.freeze
   end
 end

metadata

@@ -1,51 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: govuk-components
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.1
 platform: ruby
 authors:
 - DfE developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.22.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.18.1
+        version: 2.25.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.22.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.18.1
+        version: 2.25.0
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -114,6 +114,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A collection of components intended to ease the building of GOV.UK Design
   System web applications
 email:
@@ -139,6 +167,8 @@ files:
 - app/components/govuk_component/header.html.erb
 - app/components/govuk_component/header.rb
 - app/components/govuk_component/inset_text.rb
+- app/components/govuk_component/notification_banner.html.erb
+- app/components/govuk_component/notification_banner.rb
 - app/components/govuk_component/panel.html.erb
 - app/components/govuk_component/panel.rb
 - app/components/govuk_component/phase_banner.html.erb