# Blackcal [![Build Status](https://travis-ci.com/buren/blackcal.svg?branch=master)](https://travis-ci.com/buren/blackcal)

Create blacklist rules for calendars with ease. Supports recurring rules for certain weekdays, date numbers, hour of day.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'blackcal'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install blackcal

## Usage

Schedule Mondays and Tuesdays
```ruby
schedule = Blackcal::Schedule.new(weekdays: [:monday, :tuesday])
schedule.cover?('2019-01-01 19:00')
# => false
schedule.cover?('2019-01-02 11:00')
# => true
```

Schedule between 18pm and 7am every day
```ruby
schedule = Blackcal::Schedule.new(start_hour: 18, finish_hour: 7)
schedule.cover?('2019-01-01 19:00')
# => false
schedule.cover?('2019-01-01 11:00')
# => true
```

Schedule day 15 and 17 of month
```ruby
schedule = Blackcal::Schedule.new(days: [15, 17])
schedule.cover?('2019-01-15 19:00')
# => false
schedule.cover?('2019-01-01 11:00')
# => true
```

All options at once - schedule Tuesdays, day 15-25, between 18pm and 7am every day
```ruby
schedule = Blackcal::Schedule.new(
  weekdays: [:monday, :tuesday],
  start_hour: 18, finish_hour: 7,
  days: (15..25).to_a
)
schedule.cover?('2019-01-15 19:00')
# => false
schedule.cover?('2019-01-01 11:00')
# => true
```

Define when the schedule is active
```ruby
Blackcal::Schedule.new(start_time: '2018-01-01 11:00', finish_time: '2019-01-01 11:00')
```

Matrix representation
```ruby
schedule = Blackcal::Schedule.new(weekdays: :friday, start_hour: 10, finish_hour: 14)
schedule.to_matrix(start_date: '2018-09-14', finish_date: '2018-09-16')
# => [[true, ...], [true, ...]]
```

## 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 tags, 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/buren/blackcal.

## License

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