Helpers

This is a template for new gems. The first thing you should do is to rename everything. Use underscores, not hyphens:

rake rename name=data_wrangler

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/helpers. To experiment with that code, run bin/console for an interactive prompt.

TODO: Update details in the gemspec file

TODO: Set the GEMFURY_PUSH_TOKEN secret (see LastPass).

TODO: Delete this and the text above, and describe your gem

Installation

Add these lines to your application's Gemfile:

source 'https://gem.fury.io/universityofyork/' do
  gem 'uoy-faculty-helpers', '~> 0.1', require: 'helpers'
end

And then execute:

$ bundle

Or install it yourself as:

$ gem install uoy-faculty-helpers

Usage

TODO: Write usage instructions here

Development

Versioning

Your Gem's version is picked up automatically from lib/helpers.rb. When any changes are pushed to master, after the normal CI tasks the pipeline will push to gemfury automatically. The usual workflow is:

• For minor changes, update VERSION and make the change in a single commit

• For anything else, create a branch and set VERSION to the version you're aiming to release for. Make the changes; when the branch is merged, the gem will be uploaded.

Note that gemfury will never overwrite an existing gem version, even if the old one is yanked!

Running tests

Tests can be run via rake: bundle exec rake spec - this doesn't run performance tests; they can be run separately via bundle exec rake perf.

You can also run rspec normally e.g. bundle exec rspec -fd.

Identifying Performance Tests

If you have performance tests that take a while, tag the context / describe block like this:

context 'when foo is bar baz', :perf do
  ...
end

Contributing

Bug reports and pull requests are welcome at https://github.com/university-of-york/faculty-dev-helpers-gem