Sha256: a4d569c78a280778773c619bd7c2c78de50decb058f8604449adeac8528c97bc

Contents?: true

Size: 1.96 KB

Versions: 1

Compression:

Stored size: 1.96 KB

Contents

# HappyFriday

This gem is capable of obtaining and determining HappyFriday.

## Installation

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

    $ bundle add HappyFriday

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

    $ gem install HappyFriday

## Usage

### HappyFriday decision
```rb
date = Date.new(2022, 5, 3)
HappyFriday.happyfriday?(date)
=> false

date = Date.new(2022, 5, 27)
HappyFriday.happyfriday?(date)
=> true
```

### Getting HappyFriday
You can get a HappyFriday for that month.
```rb
date = Date.new(2022, 5, 1)
HappyFriday.get_happy_friday(date)
=> 2022-05-27 00:00:00 +0900

date = Date.new(2022, 6, 1)
HappyFriday.get_happy_friday(date)
=> 2022-06-24 00:00:00 +0900
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake ` 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/HappyFriday. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/HappyFriday/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the HappyFriday project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/HappyFriday/blob/master/CODE_OF_CONDUCT.md).

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
HappyFriday-0.4.0 README.md