Eventuale

Eventuale manages simple, independent daily calendars for Active Record models.

Installation

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

gem "eventuale"

Usage

The model needs start:datetime, duration:integer (minutes), and position:integer. Declare any additional calendar scope just as you would with positioning:

If the model does not have those columns yet, generate a migration first:

bin/rails generate eventuale:install Appointment

class Appointment < ApplicationRecord
  belongs_to :doctor
  eventualmente on: :doctor
end

Each doctor's events are positioned and timed independently for each calendar date. The basic API is advance, postpone, advance_by(int), postpone_by(int), move_to(position_or_datetime), reschedule(start:, duration:), append(attributes), and prepend(attributes). Scheduling operations recalculate positions and contiguous start times together, so position order always matches the timeline.

Use reschedule when changing an event's start and/or duration:

appointment.reschedule(start: new_start, duration: 30)

Use the dedicated scheduling methods instead of updating start, duration, or position directly through Active Record. Ordinary model attributes can still be updated normally.

Eventuale deliberately does not define multi-day event behavior yet.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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/[USERNAME]/eventuale. 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 Eventuale project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.