crown_marketplace_utils 0.1.0.beta.1 → 0.1.0.beta.3

data/lib/crown_marketplace_utils/gov_uk_helper/tag.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK Tag
+    #
+    # This helper is used for generating the tag component from the
+    # {https://design-system.service.gov.uk/components/tag GDS - Components - Tag}
+
+    module Tag
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+
+      # Generates the HTML for the GOV.UK Tag component
+      #
+      # @param text [String] the text for the tag
+      # @param colour [String] optional colour for the tag,
+      #                        see {https://design-system.service.gov.uk/components/tag/#additional-colours Tag - Additional colours}
+      #                        for available colours in GOV.UK Frontend
+      # @param govuk_tag_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_tag_options [String] :classes additional CSS classes for the tag HTML
+      # @option govuk_tag_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Tag
+      #                                     which can then be rendered on the page
+
+      def govuk_tag(text, colour = nil, **govuk_tag_options)
+        govuk_tag_classes = ['govuk-tag']
+        govuk_tag_classes << "govuk-tag--#{colour}" if colour
+        govuk_tag_classes << govuk_tag_options[:classes]
+
+        tag.strong(text, class: govuk_tag_classes, **(govuk_tag_options[:attributes] || {}))
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper.rb

@@ -1,15 +1,50 @@
 # 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/field'
+require_relative 'gov_uk_helper/field/character_count'
+require_relative 'gov_uk_helper/field/checkboxes'
+require_relative 'gov_uk_helper/field/input'
+require_relative 'gov_uk_helper/field/select'
+require_relative 'gov_uk_helper/field/textarea'
+require_relative 'gov_uk_helper/field/radios'
+require_relative 'gov_uk_helper/fieldset'
+require_relative 'gov_uk_helper/form_group'
+require_relative 'gov_uk_helper/header'
 require_relative 'gov_uk_helper/hint'
+require_relative 'gov_uk_helper/label'
+require_relative 'gov_uk_helper/notification_banner'
+require_relative 'gov_uk_helper/pagination'
+require_relative 'gov_uk_helper/step_by_step_navigation'
+require_relative 'gov_uk_helper/tag'
 
 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 Field
+    include Field::CharacterCount
+    include Field::Checkboxes
+    include Field::Input
+    include Field::Radios
+    include Field::Select
+    include Field::Textarea
+    include Fieldset
+    include FormGroup
+    include Header
     include Hint
+    include Label
+    include NotificationBanner
+    include Pagination
+    include StepByStepNavigation
+    include Tag
   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.3'
 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,127 +1,155 @@
 --- !ruby/object:Gem::Specification
 name: crown_marketplace_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta.1
+  version: 0.1.0.beta.3
 platform: ruby
 authors:
 - tim-s-ccs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '6.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.38.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.38.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.36'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.36'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.16'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 description: A Gem containing shared code for the CCS Crown Marketplace projects,
   for example view helpers
 email:
@@ -140,11 +168,27 @@ 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/field.rb
+- lib/crown_marketplace_utils/gov_uk_helper/field/character_count.rb
+- lib/crown_marketplace_utils/gov_uk_helper/field/checkboxes.rb
+- lib/crown_marketplace_utils/gov_uk_helper/field/input.rb
+- lib/crown_marketplace_utils/gov_uk_helper/field/radios.rb
+- lib/crown_marketplace_utils/gov_uk_helper/field/select.rb
+- lib/crown_marketplace_utils/gov_uk_helper/field/textarea.rb
+- lib/crown_marketplace_utils/gov_uk_helper/fieldset.rb
+- lib/crown_marketplace_utils/gov_uk_helper/form_group.rb
+- lib/crown_marketplace_utils/gov_uk_helper/header.rb
 - lib/crown_marketplace_utils/gov_uk_helper/hint.rb
+- lib/crown_marketplace_utils/gov_uk_helper/label.rb
+- lib/crown_marketplace_utils/gov_uk_helper/notification_banner.rb
+- lib/crown_marketplace_utils/gov_uk_helper/pagination.rb
+- lib/crown_marketplace_utils/gov_uk_helper/step_by_step_navigation.rb
+- lib/crown_marketplace_utils/gov_uk_helper/tag.rb
 - lib/crown_marketplace_utils/version.rb
 - sig/crown_marketplace_utils.rbs
 homepage: https://github.com/tim-s-ccs/crown_marketplace_utils

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