Skip to content

Latest commit

 

History

History
73 lines (43 loc) · 2.5 KB

README.md

File metadata and controls

73 lines (43 loc) · 2.5 KB
Raw

rspec-iso8601

Gem Version License: MIT

This gem provides RSpec string matchers for ISO8601 date/time strings. It was inspired by rspec-uuid.

Installation

Add this line to your application's Gemfile:

gem 'rspec-iso8601'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rspec-iso8601

And require it (spec_helper.rb is a good place):

require "rspec/iso8601"

Usage

expect(your_string).to be_an_iso8601_string

# Or use the alias:
expect(your_hash).to match(abc: an_iso8601_string)

By default, the matcher doesn't care how many microseconds your ISO8601 string contains, if any. But you can tell it to be more restrictive:

# With a keyword argument:
expect(your_string).to be_an_iso8601_string(precision: 3)

# With a chained method:
expect(your_string).to be_an_iso8601_string.with_precision(3)

You can also restrict matches to strings with the UTC "Z" offset designator:

expect(your_string).to be_an_iso8601_string.in_utc

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/splitwise/rspec-iso8601. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

Everyone interacting in the RSpec::ISO8601 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.