crown_marketplace_utils 0.1.0.beta.1 → 0.1.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06b0933612954153f5c6a0a37d666db46ad61709d6ce33705790b3f2906101ec
-  data.tar.gz: d8622845984e64cabf38557e3c0045cadf2265975c8a38a5bac6ab25ffd93119
+  metadata.gz: b6c289917a94a2f6ee322e356590757f9963509f1a6fa7951783a780e84d5fcf
+  data.tar.gz: 63639f4f2cf082ed69432dccdd0e41ced94dc909ec397d81550169229cf6ae06
 SHA512:
-  metadata.gz: 34d668ad1d821617e5cd81d9d040e32d5d9e503eb0e68c55757ecf945a1b38e25a59c3c08fadb4d15dd3158b7a238b1e933066748f3b7f3e5801574bea4474de
-  data.tar.gz: a5c067665e8af0370c960d7868af516aeb3b8d86453aa94c732841a6824d3cb32ed3d400be26e81608b643eff119f44b30b7a0fdb8d13c6715c59bcf00daa18f
+  metadata.gz: d5505418729cabf9849322dbbc8255c274063dca392c1cc5e3e9125db366811236efd120821b701f691fe32f28a94b19520f7a0425afb7d0bf6bc2c190025fe7
+  data.tar.gz: e243d5969928fbf7924d4b81206e77a5cfc6ce5e066aac4f7022f7495c8acc255ca0178ac43485ca4b2d7af285018b91925367f4655ab66069e49418c09a0d0f

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
 --color
 --require spec_helper

data/.rubocop.yml

@@ -108,3 +108,10 @@ Style/OptionalBooleanParameter:
 
 RSpec/VerifiedDoubleReference:
     Enabled: false
+
+RSpec/NestedGroups:
+    Max: 5
+
+RSpec/ExampleLength:
+    Exclude:
+        - 'spec/crown_marketplace_utils/gov_uk_helper/**/*'

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    crown_marketplace_utils (0.1.0.beta.1)
+    crown_marketplace_utils (0.1.0.beta.2)
+      actionview (>= 6.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -33,6 +33,26 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 At the moment this Gem only contains view helpers. It would be good in the future to add other kinds of modules to this gem so that they can be shared and managed in one place.
 
+### Helpers to create
+- Accordion
+- ~~Breadcrumbs~~
+- ~~Button~~
+- Checkboxes
+- CharacterCount
+- DateInput
+- ~~Details~~
+- ~~ErrorMessage~~
+- Fieldset
+- ~~FormGroup~~
+- Header
+- ~~Hint~~
+- NotificationBanner
+- Pagination
+- Radios
+- Select
+- StepByStepNavigation
+- TextInput
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/tim-s-ccs/crown_marketplace_utils.

data/crown_marketplace_utils.gemspec

@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'actionview', '>= 6.0'
+
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rails'
   spec.add_development_dependency 'rspec', '~> 3.2'

data/lib/crown_marketplace_utils/gov_uk_helper/breadcrumbs.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK Breadcrumbs
+    #
+    # This helper is used for generating the breadcrumbs component from the
+    # {https://design-system.service.gov.uk/components/breadcrumbs GDS - Components - Breadcrumbs}
+
+    module Breadcrumbs
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+      include ActionView::Helpers::UrlHelper
+
+      # Generates the HTML for the GOV.UK breadcrumbs component
+      #
+      # @param govuk_breadcrumb_items [Array<Hash>] An array of links for the breadcrumbs list. See {#govuk_breadcrumb_link} for details of the items in the array.
+      # @param govuk_breadcrumbs_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_breadcrumbs_options [String] :classes additional CSS classes for the breadcrums HTML
+      # @option govuk_breadcrumbs_options [Boolean] :collapse_on_mobile indicates if it is to colapse breadcrumbs on mobile
+      # @option govuk_breadcrumbs_options [Hash] :attributes any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Breadcrumbs
+      #                                     which can then be rendered on the page
+
+      def govuk_breadcrumbs(govuk_breadcrumb_items, **govuk_breadcrumbs_options)
+        govuk_breadcrumbs_classes = ['govuk-breadcrumbs']
+        govuk_breadcrumbs_classes << govuk_breadcrumbs_options[:classes]
+        govuk_breadcrumbs_classes << 'govuk-breadcrumbs--collapse-on-mobile' if govuk_breadcrumbs_options[:collapse_on_mobile]
+        govuk_breadcrumbs_options[:attributes] ||= {}
+
+        tag.div(class: govuk_breadcrumbs_classes, **govuk_breadcrumbs_options[:attributes]) do
+          tag.ol(class: 'govuk-breadcrumbs__list') do
+            capture do
+              govuk_breadcrumb_items.each { |govuk_breadcrumb_item| concat(govuk_breadcrumb_link(govuk_breadcrumb_item)) }
+            end
+          end
+        end
+      end
+
+      private
+
+      # Generates the HTML for each link in the breadcrumbs.
+      # It is called by {#govuk_breadcrumbs} which will pass in the breadcrum item.
+      #
+      # @param govuk_breadcrumb_item [Hash] a hash containg options for the breadcrumb item
+      #
+      # @option govuk_breadcrumb_item [String] :text the text for the link
+      # @option govuk_breadcrumb_item [String] :link the URI for the link. If blank it is assumed that this item relates to current page
+      # @option govuk_breadcrumb_item [Hash] :attributes any additional attributes that will added as part of the HTML.
+      #                                                  If the link is blank then it defaults to +{ aria: { current: 'page' } }+
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Breadcrumb list item
+
+      def govuk_breadcrumb_link(govuk_breadcrumb_item)
+        govuk_breadcrumb_item[:attributes] ||= {}
+
+        if govuk_breadcrumb_item[:link].present?
+          tag.li(class: 'govuk-breadcrumbs__list-item', **govuk_breadcrumb_item[:attributes]) do
+            link_to govuk_breadcrumb_item[:text], govuk_breadcrumb_item[:link], class: 'govuk-breadcrumbs__link'
+          end
+        else
+          (govuk_breadcrumb_item[:attributes][:aria] ||= {}).merge!({ current: 'page' })
+
+          tag.li(class: 'govuk-breadcrumbs__list-item', **govuk_breadcrumb_item[:attributes]) do
+            govuk_breadcrumb_item[:text]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/button.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK Button
+    #
+    # This helper is used for generating the button component from the
+    # {https://design-system.service.gov.uk/components/button GDS - Components - Button}
+
+    module Button
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+      include ActionView::Helpers::UrlHelper
+      include ActionView::Helpers::FormTagHelper
+
+      # Generates the HTML for the GOV.UK button component
+      #
+      # @param text [String] the text that will be shown in the button
+      # @param type [Symbol] the type of button that will be created.
+      #                      - :a will create a anchor tag
+      #                      - :submit will create a input with type submit
+      #                      - all other values will create a button with the type specified
+      # @param govuk_button_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_button_options [String] :classes additional CSS classes for the button HTML
+      # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
+      # @option govuk_button_options [String] :href the URI that will be used in anchor tag (only used if type is +:a+)
+      # @option govuk_button_options [ActionView::Helpers::FormBuilder] :form the form builder used to create the submit button (only used if type is +:submit+)
+      # @option govuk_button_options [Hash] :attributes ({ data: { module: 'govuk-button' } }) any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button
+      #                                     which can then be rendered on the page
+
+      def govuk_button(text, type = :a, **govuk_button_options)
+        govuk_button_classes = ['govuk-button']
+        govuk_button_classes << govuk_button_options[:classes]
+        govuk_button_options[:attributes] ||= {}
+        govuk_button_classes << 'govuk-button--disabled' if govuk_button_options[:attributes][:disabled]
+        (govuk_button_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-button' })
+
+        button_method = case type
+                        when :a
+                          :govuk_button_link
+                        when :submit
+                          :govuk_button_submit
+                        else
+                          :govuk_button_button
+                        end
+
+        send(button_method, text, type, govuk_button_classes, **govuk_button_options)
+      end
+
+      private
+
+      # Generates the HTML for the GOV.UK button component as an anchor tag.
+      # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
+      #
+      # @param text [String] the text that will be shown in the button
+      # @param _type [Symbol] unused as type has already been determined
+      # @param classes [String] additional CSS classes for the button HTML
+      # @param govuk_button_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
+      # @option govuk_button_options [String] :href the URI that will be used in anchor tag
+      # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as an anchor element
+      #                                     which can then be rendered on the page
+
+      def govuk_button_link(text, _type, classes, **govuk_button_options)
+        link_to(govuk_button_options[:href], class: classes, role: :button, draggable: false, **govuk_button_options[:attributes]) do
+          concat(text)
+          concat(govuk_start_button_icon) if govuk_button_options[:is_start_button]
+        end
+      end
+
+      # Generates the HTML for the GOV.UK button component as a button.
+      # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
+      #
+      # @param text [String] the text that will be shown in the button
+      # @param type [Symbol] the type of attribute of the button
+      # @param classes [String] additional CSS classes for the button HTML
+      # @param govuk_button_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
+      # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as a button element
+      #                                     which can then be rendered on the page
+
+      def govuk_button_button(text, type, classes, **govuk_button_options)
+        button_tag(class: classes, type: type, **govuk_button_options[:attributes]) do
+          concat(text)
+          concat(govuk_start_button_icon) if govuk_button_options[:is_start_button]
+        end
+      end
+
+      # Generates the HTML for the GOV.UK button component as an input.
+      # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
+      #
+      # @param text [String] the text that will be shown in the input
+      # @param _type [Symbol] unused as type has already been determined
+      # @param classes [String] additional CSS classes for the button HTML
+      # @param govuk_button_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_button_options [ActionView::Helpers::FormBuilder] :form the form builder used to create the submit button
+      # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as an input element
+      #                                     which can then be rendered on the page
+
+      def govuk_button_submit(text, _type, classes, **govuk_button_options)
+        govuk_button_options[:form].submit(text, class: classes, **govuk_button_options[:attributes])
+      end
+
+      # Generates the arrow for the start button option as part of {#govuk_button}
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the arrow for the start button
+
+      def govuk_start_button_icon
+        tag.svg(class: 'govuk-button__start-icon', xmlns: 'http://www.w3.org/2000/svg', width: 17.5, height: 19, viewBox: '0 0 33 40', aria: { hidden: true }, focusable: false) do
+          tag.path(fill: 'currentColor', d: 'M0 0h13l20 20-20 20H0l20-20z')
+        end
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/details.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'action_view'
+
 module CrownMarketplaceUtils
   module GovUkHelper
     # = GOV.UK Details
@@ -8,26 +10,30 @@ module CrownMarketplaceUtils
     # {https://design-system.service.gov.uk/components/details GDS - Components - Details}
 
     module Details
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+
       # Generates the HTML for the GOV.UK Details component
       #
       # @param summary_text [String] the summary text for the details element
-      # @param details_options [Hash] options that will be used in customising the HTML
+      # @param govuk_details_options [Hash] options that will be used in customising the HTML
       #
-      # @option details_options [String] :classes additional CSS classes for the error message HTML
-      # @option details_options [Hash] :attributes ({ data: { module: 'govuk-details' } }) any additional attributes that will added as part of the HTML
+      # @option govuk_details_options [String] :classes additional CSS classes for the error message HTML
+      # @option govuk_details_options [Hash] :attributes ({ data: { module: 'govuk-details' } }) any additional attributes that will added as part of the HTML
       #
       # @yield HTML that will be contained within the 'govuk-details__text' div
       #
       # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Details
       #                                     which can then be rendered on the page
 
-      def govuk_details(summary_text, **details_options, &block)
+      def govuk_details(summary_text, **govuk_details_options, &block)
         govuk_details_classes = ['govuk-details']
-        govuk_details_classes << details_options[:classes]
-        details_options[:attributes] ||= {}
-        (details_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-details' })
+        govuk_details_classes << govuk_details_options[:classes]
+        govuk_details_options[:attributes] ||= {}
+        (govuk_details_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-details' })
 
-        tag.details(class: govuk_details_classes, **details_options[:attributes]) do
+        tag.details(class: govuk_details_classes, **govuk_details_options[:attributes]) do
           capture do
             concat(tag.summary(tag.span(summary_text, class: 'govuk-details__summary-text'), class: 'govuk-details__summary'))
             concat(tag.div(class: 'govuk-details__text', &block))

data/lib/crown_marketplace_utils/gov_uk_helper/error_message.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'action_view'
+
 module CrownMarketplaceUtils
   module GovUkHelper
     # = GOV.UK Error Message
@@ -8,25 +10,30 @@ module CrownMarketplaceUtils
     # {https://design-system.service.gov.uk/components/error-message GDS - Components - Error message}
 
     module ErrorMessage
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+
       # Generates the HTML for the GOV.UK Error message component
       #
       # @param message [String] the message to be displayed
       # @param attribute [String, Symbol] the attribute that has an error
-      # @param error_message_options [Hash] options that will be used in customising the HTML
+      # @param govuk_error_message_options [Hash] options that will be used in customising the HTML
       #
-      # @option error_message_options [String] :classes additional CSS classes for the error message HTML
-      # @option error_message_options [String] :visually_hidden_text ('Error') visualy hidden text before the error message
-      # @option error_message_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      # @option govuk_error_message_options [String] :classes additional CSS classes for the error message HTML
+      # @option govuk_error_message_options [String] :visually_hidden_text ('Error') visualy hidden text before the error message
+      # @option govuk_error_message_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
       #
       # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Error message
       #                                     which can then be rendered on the page
 
-      def govuk_error_message(message, attribute, **error_message_options)
+      def govuk_error_message(message, attribute, **govuk_error_message_options)
         class_list = ['govuk-error-message']
-        class_list << error_message_options[:classes]
-        visually_hidden_text = error_message_options[:visually_hidden_text] || 'Error'
+        class_list << govuk_error_message_options[:classes]
+        visually_hidden_text = govuk_error_message_options[:visually_hidden_text] || 'Error'
+        govuk_error_message_options[:attributes] ||= {}
 
-        tag.p(id: "#{attribute}-error", class: class_list, **(error_message_options[:attributes] || {})) do
+        tag.p(id: "#{attribute}-error", class: class_list, **govuk_error_message_options[:attributes]) do
           capture do
             concat(tag.span("#{visually_hidden_text}: ", class: 'govuk-visually-hidden')) if visually_hidden_text.present?
             concat(message)
@@ -38,14 +45,14 @@ module CrownMarketplaceUtils
       #
       # @param model [ActiveModel] model that will be used to find the error message
       # @param attribute [String, Symbol] the attribute that has an error
-      # @param error_message_options [Hash] options that will be used in customising the HTML
+      # @param govuk_error_message_options [Hash] options that will be used in customising the HTML
       #
       # @option (see #govuk_error_message)
       #
       # @return (see #govuk_error_message)
 
-      def govuk_error_message_with_model(model, attribute, **error_message_options)
-        govuk_error_message(model.errors[attribute].first, attribute, **error_message_options)
+      def govuk_error_message_with_model(model, attribute, **govuk_error_message_options)
+        govuk_error_message(model.errors[attribute].first, attribute, **govuk_error_message_options)
       end
     end
   end

data/lib/crown_marketplace_utils/gov_uk_helper/form_group.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'action_view'
+require_relative 'error_message'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK FormGroup
+    #
+    # This helper is used for generating the form group component from the Government Design Systems
+
+    module FormGroup
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ErrorMessage
+
+      # Generates the HTML for the GOV.UK Form Group component
+      #
+      # @param attribute [String, Symbol] the attribute that the form group is for
+      # @param error_message [String] the error message to be displayed
+      # @param govuk_form_group_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_form_group_options [String] :classes additional CSS classes for the form group HTML
+      # @option govuk_form_group_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      #
+      # @yield HTML that will be contained within the 'govuk-form-group' div
+      #
+      # @yieldparam displayed_error_message [ActiveSupport::SafeBuffer] the HTML for the error message (if there is one)
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Form Group
+      #                                     which can then be rendered on the page
+
+      def govuk_form_group(attribute, error_message = nil, **govuk_form_group_options)
+        govuk_form_group_classes = ['govuk-form-group']
+        govuk_form_group_classes += ['govuk-form-group--error'] if error_message
+        govuk_form_group_classes << govuk_form_group_options[:classes]
+        govuk_form_group_options[:attributes] ||= {}
+
+        tag.div(class: govuk_form_group_classes, id: "#{attribute}-form-group", **govuk_form_group_options[:attributes]) do
+          yield((govuk_error_message(error_message, attribute) if error_message))
+        end
+      end
+
+      # Generates the HTML for the GOV.UK Form Group component using an ActiveModel
+      #
+      # @param model [ActiveModel] model that will be used to find an error message
+      # @param attribute [String, Symbol] the attribute that the form group is for
+      # @param govuk_form_group_options [Hash] options that will be used in customising the HTML
+      #
+      # @option (see #govuk_form_group)
+      #
+      # @yield (see #govuk_form_group)
+      #
+      # @yieldparam (see #govuk_form_group)
+      #
+      # @return (see #govuk_form_group)
+
+      def govuk_form_group_with_model(model, attribute, **govuk_form_group_options, &block)
+        govuk_form_group(attribute, model.errors[attribute].first, **govuk_form_group_options, &block)
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/hint.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'action_view'
+
 module CrownMarketplaceUtils
   module GovUkHelper
     # = GOV.UK Hint
@@ -7,22 +9,26 @@ module CrownMarketplaceUtils
     # This helper is used for generating the hint text component from the Government Design Systems
 
     module Hint
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+
       # Generates the HTML for the GOV.UK Hint component
       #
       # @param hint_text [String]  the hint text
-      # @param hint_options [Hash] options that will be used in customising the HTML
+      # @param govuk_hint_options [Hash] options that will be used in customising the HTML
       #
-      # @option hint_options [String] :classes additional CSS classes for the hint HTML
-      # @option hint_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      # @option govuk_hint_options [String] :classes additional CSS classes for the hint HTML
+      # @option govuk_hint_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
       #
       # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Hint
       #                                     which can then be rendered on the page
 
-      def govuk_hint(hint_text, **hint_options)
+      def govuk_hint(hint_text, **govuk_hint_options)
         govuk_hint_classes = ['govuk-hint']
-        govuk_hint_classes << hint_options[:classes]
+        govuk_hint_classes << govuk_hint_options[:classes]
+        govuk_hint_options[:attributes] ||= {}
 
-        tag.div(hint_text, class: govuk_hint_classes, **(hint_options[:attributes] || {}))
+        tag.div(hint_text, class: govuk_hint_classes, **govuk_hint_options[:attributes])
       end
     end
   end

data/lib/crown_marketplace_utils/gov_uk_helper.rb

@@ -1,15 +1,22 @@
 # frozen_string_literal: true
 
-require_relative 'gov_uk_helper/error_message'
+require_relative 'gov_uk_helper/breadcrumbs'
+require_relative 'gov_uk_helper/button'
 require_relative 'gov_uk_helper/details'
+require_relative 'gov_uk_helper/error_message'
+require_relative 'gov_uk_helper/form_group'
 require_relative 'gov_uk_helper/hint'
 
 module CrownMarketplaceUtils
-  # This module loads in all the GOV.UK Helper methods
+  # This module loads in all the GOV.UK Helper methods.
+  # These are a collection of view helpers to help render GOV.UK components
 
   module GovUkHelper
+    include Breadcrumbs
+    include Button
     include Details
     include ErrorMessage
+    include FormGroup
     include Hint
   end
 end

data/lib/crown_marketplace_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CrownMarketplaceUtils
-  VERSION = '0.1.0.beta.1'
+  VERSION = '0.1.0.beta.2'
 end

data/lib/crown_marketplace_utils.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
 require 'crown_marketplace_utils/gov_uk_helper'
-require 'crown_marketplace_utils/engine'
 
 require_relative 'crown_marketplace_utils/version'
 
+# = Crown Marketplace Utilities
+#
+# The Crown Marketplace Utilities module contains code that is used in both Crown Marketplace projects.
+# This includes:
+# - view helpers to render GOV.UK components
+
 module CrownMarketplaceUtils
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: crown_marketplace_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta.1
+  version: 0.1.0.beta.2
 platform: ruby
 authors:
 - tim-s-ccs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -140,10 +154,12 @@ files:
 - Rakefile
 - crown_marketplace_utils.gemspec
 - lib/crown_marketplace_utils.rb
-- lib/crown_marketplace_utils/engine.rb
 - lib/crown_marketplace_utils/gov_uk_helper.rb
+- lib/crown_marketplace_utils/gov_uk_helper/breadcrumbs.rb
+- lib/crown_marketplace_utils/gov_uk_helper/button.rb
 - lib/crown_marketplace_utils/gov_uk_helper/details.rb
 - lib/crown_marketplace_utils/gov_uk_helper/error_message.rb
+- lib/crown_marketplace_utils/gov_uk_helper/form_group.rb
 - lib/crown_marketplace_utils/gov_uk_helper/hint.rb
 - lib/crown_marketplace_utils/version.rb
 - sig/crown_marketplace_utils.rbs

data/lib/crown_marketplace_utils/engine.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/engine'
-
-module CrownMarketplaceUtils
-  class Engine < ::Rails::Engine
-    initializer 'crown_marketplace_utils.engine' do |_app|
-      ActiveSupport.on_load(:action_view) { include CrownMarketplaceUtils::GovUkHelper }
-    end
-  end
-end