Faculty Helpers

Installation

Add these lines to your application's Gemfile:

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

And then execute:

$ bundle

Or install it yourself as:

$ gem install uoy-faculty-helpers

Usage

• human_boolean(boolean)
  • true => Yes, false => No
• human_readable_bytes(bytes)
  • 1_048_576 => 1 MiB
• number_to_day(day)
  • 1 => Monday ... 7 => Sunday
• number_to_short_day(day)
  • 1 => Mon ... 7 => Sun
• ordinal(number)
  • 1 => st, 2 => nd
• ordinalize(number)
  • 1 => 1st, 2 => 2nd

Durations

Useful for handling Postgres intervals in ruby. Mostly lifted from rails, but without the bloat of activesupport. You can only add / subtract date intervals for now, but this can be extended in the future if required.

duration = FacultyHelpers::Duration.parse('P3M')
new_date = duration.add_to(date)

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