Parliament::Grom::Decorators

parliament-grom-decorators is a gem created by the Parliamentary Digital Service to allow Grom::Node objects to be extended with alias methods.

NOTE: This gem is in active development and is likely to change at short notice. It is not recommended that you use this in any production environment.

Requirements

parliament-grom-decorators requires the following:

• Ruby
• Bundler

Installation

gem 'parliament-grom-decorators'

Usage

This gem's main function is to extend Grom::Node objects with alias methods.

Note: Comprehensive class documentation can be found on rubydocs.

Getting Started with Development

To clone the repository and set up the dependencies, run the following:

git clone https://github.com/ukparliament/parliament-grom-decorators.git
cd parliament-grom-decorators
bundle install

Running the tests

We use RSpec as our testing framework and tests can be run using:

bundle exec rake

Contributing

If you wish to submit a bug fix or feature, you can create a pull request and it will be merged pending a code review.

1. Fork the repository
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Ensure your changes are tested using Rspec
6. Create a new Pull Request