crown_marketplace_utils

Crown Marketplace Utilities

The Crown Marketplace Utilities gem was created for use in the Crown Marketplace projects at the Crown Commercial Service. This project contains two applications (both use the Ruby on Rails framework):

• Crown Marketplace
• Crown Marketplace Legacy

As these projects share a lot of code it was thought useful to put that shared code into it's own gem, thus Crown Marketplace Utilities was created.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add crown_marketplace_utils

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install crown_marketplace_utils

Usage

To use this gem, simply add it to your Gemfile (as described above).

GOV.UK Helper

To include the helper methods from the GovUkHelper module, you can include it in your app/helpers/application_helper.rb like so:

module ApplicationHelper
  include CrownMarketplaceUtils::GovUkHelper
end 

This will give you access to a variety of GDS components to use in your application views. These are based on the components found in GOV.UK Frontend v4.3.1.

Documentation for the helper methods can be found at LINK TO RDOCS

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Future plans

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
• File Upload
• FormGroup
• Header
• Hint
• Label
• NotificationBanner
• Pagination
• Radios
• Select
• StepByStepNavigation
• TextArea
• TextInput
• Tag

CCS Helpers to look at after first release

• CCS Panel
• CCS Header

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tim-s-ccs/crown_marketplace_utils.

Licence

The gem is available as open source under the terms of the MIT Licence.