availability_scheduler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b691938d809bc5e817e33032cb4f122dae5469a2ed9caf2db996ce5803d1581a
+  data.tar.gz: 478e41afa5112ca380c81e6506dd49d0a6b2c7bc42bf23683ddcb862ec18cb7d
+SHA512:
+  metadata.gz: 1a7c69a44b77f459c7d79804b56d9f8d4e6a2fb28bad04d088f9b480a20939a4f0590465bcfee46de50d113137905c8213b545e52e24d78998a80661ac313b12
+  data.tar.gz: 7ffc31e84d9835f5a41ac87b1511f467506e02e7fce026a9dd21d2b59bf4805ce7789ef9067d796b13cd08dc54df4c4f14c99081be69ca1bdbaa69b64638c554

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-factory_bot
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - 'lib/generators/**/*'
+    - 'vendor/**/*'
+    - 'availability_scheduler.gemspec'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-01
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Paweł Strącała
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,139 @@
+
+# AvailabilityScheduler
+
+`AvailabilityScheduler` is a Ruby on Rails gem for managing user availability and scheduling appointments. It ensures appointments are booked within the user's available time slots and prevents overlapping bookings. The gem supports both recurring weekly schedules and one-off special schedules.
+
+## Features
+
+- Manage weekly recurring schedules and one-off special schedules for users.
+- Book appointments within a user’s availability.
+- Prevent overlapping appointments.
+- Validate availability before confirming an appointment.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'availability_scheduler'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Next, run the generator to create the necessary migration files:
+
+```bash
+rails generate availability_scheduler:install
+```
+
+Finally, migrate your database:
+
+```bash
+rails db:migrate
+```
+
+## Usage
+
+### Setting Weekly Schedules
+
+Define recurring weekly schedules for users.
+
+```ruby
+# Define a weekly schedule for a user
+AvailabilityScheduler::WeeklySchedule.create!(
+  user_id: 1,
+  day_of_week: 1, # Monday
+  start_time: '09:00',
+  end_time: '17:00'
+)
+```
+
+### Setting Special Schedules
+
+Define one-off special schedules for specific dates.
+
+```ruby
+# Define a special schedule for a specific date
+AvailabilityScheduler::SpecialSchedule.create!(
+  user_id: 1,
+  date: '2024-09-10',
+  start_time: '10:00',
+  end_time: '14:00'
+)
+```
+
+### Booking an Appointment
+
+Book an appointment with validation to ensure it’s within the user’s availability.
+
+```ruby
+AvailabilityScheduler::Appointment.create!(
+  booker_id: 2, # User making the booking
+  booked_user_id: 1, # User being booked
+  date: '2024-09-10',
+  start_time: '11:00',
+  end_time: '12:00'
+)
+```
+
+### Fetching Availability for a User
+
+You can fetch the availability of a user for a given month using the `AvailabilityScheduler::Availability::FetchForUser` service. This service returns a hash where each day of the month is mapped to an array of availability time periods.
+
+#### Example
+
+```ruby
+availability_service = AvailabilityScheduler::Availability::FetchForUser.new(user_id: 1, date: '05-2024')
+availability = availability_service.call
+
+availability.each do |date, periods|
+  if periods.any?
+    periods.each do |period|
+      puts "#{date}: Available from #{period[:start_time]} to #{period[:end_time]}"
+    end
+  else
+    puts "#{date}: Not available"
+  end
+end
+```
+Example output:
+```ruby
+{
+  "2024-05-01" => [{ start_time: "09:00", end_time: "10:00" }, { start_time: "11:00", end_time: "16:00" }],
+  "2024-05-02" => [],
+  "2024-05-03" => [{ start_time: "10:00", end_time: "14:00" }],
+  # ...
+}
+```
+
+### Validation Example
+
+The gem will automatically validate whether the appointment is within the availability and if it overlaps with any other appointments.
+
+```ruby
+appointment = AvailabilityScheduler::Appointment.new(
+  booker_id: 2,
+  booked_user_id: 1,
+  date: '2024-09-10',
+  start_time: '11:00',
+  end_time: '12:00'
+)
+
+if appointment.save
+  puts 'Appointment successfully booked!'
+else
+  puts appointment.errors.full_messages
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/yourusername/availability_scheduler](https://github.com/yourusername/availability_scheduler).
+
+## License
+
+This project is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/availability_scheduler/base.rb

@@ -0,0 +1,5 @@
+module AvailabilityScheduler
+  class Base < ActiveRecord::Base
+    self.abstract_class = true # primary_abstract_class
+  end
+end

data/lib/availability_scheduler/models/appointment.rb

@@ -0,0 +1,49 @@
+module AvailabilityScheduler
+  class Appointment < Base
+    self.table_name = 'appointments'
+
+    validates :booker_id, :booked_user_id, :date, :start_time, :end_time, presence: true
+    validate :user_has_schedule
+    validate :within_availability, if: lambda {
+      start_time.present? && end_time.present? && date.present? && errors[:base].blank?
+    }
+    validate :no_overlap, if: -> { errors[:base].blank? }
+
+    private
+
+    def user_has_schedule
+      return if SpecialSchedule.exists?(user_id: booked_user_id) || WeeklySchedule.exists?(user_id: booked_user_id)
+
+      errors.add(:base, 'The booked user does not have any available schedules.')
+    end
+
+    def within_availability
+      return if special_schedule_exists?
+      return if weekly_schedule_exists?
+
+      errors.add(:base, 'Appointment is not within the availability of the booked user.')
+    end
+
+    def no_overlap
+      overlapping_appointments = Appointment.where(booked_user_id: booked_user_id, date: date)
+                                            .where.not(id: id)
+                                            .where('start_time < ? AND end_time > ?', end_time, start_time)
+
+      return unless overlapping_appointments.exists?
+
+      errors.add(:base, 'Appointment overlaps with another appointment.')
+    end
+
+    def special_schedule_exists?
+      SpecialSchedule.where(user_id: booked_user_id, date: date)
+                     .where('start_time <= ? AND end_time >= ?', start_time, end_time)
+                     .exists?
+    end
+
+    def weekly_schedule_exists?
+      WeeklySchedule.where(user_id: booked_user_id, day_of_week: date.wday)
+                    .where('start_time <= ? AND end_time >= ?', start_time, end_time)
+                    .exists?
+    end
+  end
+end

data/lib/availability_scheduler/models/special_schedule.rb

@@ -0,0 +1,21 @@
+module AvailabilityScheduler
+  class SpecialSchedule < Base
+    self.table_name = 'special_schedules'
+
+    validates :user_id, presence: true
+    validates :date, :start_time, :end_time, presence: true
+    validate :no_time_overlap
+
+    private
+
+    def no_time_overlap
+      overlapping_schedule = SpecialSchedule.where(user_id: user_id, date: date)
+                                            .where.not(id: id)
+                                            .where('start_time < ? AND end_time > ?', end_time, start_time)
+
+      return unless overlapping_schedule.exists?
+
+      errors.add(:base, 'Special schedule overlaps with another special schedule.')
+    end
+  end
+end

data/lib/availability_scheduler/models/weekly_schedule.rb

@@ -0,0 +1,23 @@
+module AvailabilityScheduler
+  class WeeklySchedule < Base
+    self.table_name = 'weekly_schedules'
+
+    validates :user_id, presence: true
+    validates :day_of_week, inclusion: { in: 0..6 } # monday 0 .. sunday 6
+    validates :start_time, :end_time, presence: true
+
+    validate :no_time_overlap
+
+    private
+
+    def no_time_overlap
+      overlapping_schedules = WeeklySchedule.where(user_id: user_id, day_of_week: day_of_week)
+                                            .where.not(id: id)
+                                            .where('start_time < ? AND end_time > ?', end_time, start_time)
+
+      return unless overlapping_schedules.exists?
+
+      errors.add(:base, 'Weekly schedule overlaps with another weekly schedule.')
+    end
+  end
+end

data/lib/availability_scheduler/railtie.rb

@@ -0,0 +1,7 @@
+require 'rails/railtie'
+
+module AvailabilityScheduler
+  class Railtie < Rails::Railtie
+    # Kod, który ma być uruchomiony po załadowaniu Rails (np. dodanie generatorów)
+  end
+end

data/lib/availability_scheduler/services/availability/fetch_for_user.rb

@@ -0,0 +1,50 @@
+module AvailabilityScheduler
+  module Availability
+    class FetchForUser
+      def initialize(user_id:, date:)
+        @user_id = user_id
+        @start_date = Date.strptime(date, '%m-%Y')
+        @end_date = @start_date.end_of_month
+      end
+
+      def call
+        availability = {}
+
+        special_schedules = SpecialSchedule.where(user_id: @user_id, date: @start_date..@end_date)
+
+        weekly_schedules = WeeklySchedule.where(user_id: @user_id)
+
+        (@start_date..@end_date).each do |date|
+          availability[date.strftime('%d-%m-%Y')] = daily_availability(date, special_schedules, weekly_schedules)
+        end
+
+        availability
+      end
+
+      private
+
+      attr_reader :user_id, :start_date, :end_date
+
+      def daily_availability(date, special_schedules, weekly_schedules)
+        special_schedules_for_day = special_schedules.select { |schedule| schedule.date == date }
+        availability = special_schedules_for_day.map do |schedule|
+          single_time(schedule)
+        end
+
+        return availability if availability.present?
+
+        weekly_schedules_for_day = weekly_schedules.select { |schedule| schedule.day_of_week == date.wday }
+        weekly_schedules_for_day.map do |schedule|
+          single_time(schedule)
+        end
+      end
+
+      def single_time(schedule)
+        {
+          start_time: schedule.start_time.strftime('%H:%M'),
+          end_time: schedule.end_time.strftime('%H:%M')
+        }
+      end
+    end
+  end
+end

data/lib/availability_scheduler/version.rb

@@ -0,0 +1,3 @@
+module AvailabilityScheduler
+  VERSION = '0.1.0'.freeze
+end

data/lib/availability_scheduler.rb

@@ -0,0 +1,11 @@
+require 'availability_scheduler/railtie' if defined?(Rails)
+
+module AvailabilityScheduler
+  class Error < StandardError; end
+
+  autoload :Base, 'availability_scheduler/base'
+  autoload :WeeklySchedule, 'availability_scheduler/models/weekly_schedule'
+  autoload :SpecialSchedule, 'availability_scheduler/models/special_schedule'
+  autoload :Appointment, 'availability_scheduler/models/appointment'
+  autoload :Availability, 'availability_scheduler/services/availability/fetch_for_user'
+end

data/lib/generators/availability_scheduler/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module AvailabilityScheduler
+  module Generators
+    class InstallGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      class_option :force, type: :boolean, default: true, desc: "Overwrite existing migrations"
+
+      argument :name, type: :string, default: 'default_value', optional: true
+
+      def create_migrations
+        migration_template 'create_weekly_schedules.rb', 'db/migrate/create_weekly_schedules.rb'
+        migration_template 'create_special_schedules.rb', 'db/migrate/create_special_schedules.rb'
+        migration_template 'create_appointments.rb', 'db/migrate/create_appointments.rb'
+      end
+    end
+  end
+end

data/lib/generators/availability_scheduler/templates/create_appointments.rb

@@ -0,0 +1,17 @@
+class CreateAppointments < ActiveRecord::Migration[6.0]
+  def change
+    create_table :appointments do |t|
+      t.integer :booker_id, null: false
+      t.integer :booked_user_id, null: false
+      t.date :date, null: false
+      t.time :start_time, null: false
+      t.time :end_time, null: false
+
+      t.timestamps
+    end
+
+    add_index :appointments,
+              %i[booked_user_id date start_time end_time],
+              unique: true, name: 'index_appointments_on_booked_user_id_and_time'
+  end
+end

data/lib/generators/availability_scheduler/templates/create_special_schedules.rb

@@ -0,0 +1,14 @@
+class CreateSpecialSchedules < ActiveRecord::Migration[6.0]
+  def change
+    create_table :special_schedules do |t|
+      t.integer :user_id, null: false
+      t.date :date, null: false
+      t.time :start_time, null: false
+      t.time :end_time, null: false
+
+      t.timestamps
+    end
+
+    add_index :special_schedules, %i[user_id date]
+  end
+end

data/lib/generators/availability_scheduler/templates/create_weekly_schedules.rb

@@ -0,0 +1,14 @@
+class CreateWeeklySchedules < ActiveRecord::Migration[6.0]
+  def change
+    create_table :weekly_schedules do |t|
+      t.integer :user_id, null: false
+      t.integer :day_of_week, null: false
+      t.time :start_time, null: false
+      t.time :end_time, null: false
+
+      t.timestamps
+    end
+
+    add_index :weekly_schedules, :user_id
+  end
+end

data/sig/availability_scheduler.rbs

@@ -0,0 +1,4 @@
+module AvailabilityScheduler
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: availability_scheduler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paweł Strącała
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-07 00:00:00.000000000 Z
+dependencies: []
+description: This gem allows scheduling availability for resources, including weekly
+  schedules and special one-day exceptions.
+email:
+- pawel.stracala@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/availability_scheduler.rb
+- lib/availability_scheduler/base.rb
+- lib/availability_scheduler/models/appointment.rb
+- lib/availability_scheduler/models/special_schedule.rb
+- lib/availability_scheduler/models/weekly_schedule.rb
+- lib/availability_scheduler/railtie.rb
+- lib/availability_scheduler/services/availability/fetch_for_user.rb
+- lib/availability_scheduler/version.rb
+- lib/generators/availability_scheduler/install_generator.rb
+- lib/generators/availability_scheduler/templates/create_appointments.rb
+- lib/generators/availability_scheduler/templates/create_special_schedules.rb
+- lib/generators/availability_scheduler/templates/create_weekly_schedules.rb
+- sig/availability_scheduler.rbs
+homepage: https://github.com/Ununuk/availability_scheduler
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Ununuk/availability_scheduler
+  source_code_uri: https://github.com/Ununuk/availability_scheduler
+  changelog_uri: https://github.com/Ununuk/availability_scheduler/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A gem for scheduling availability for resources.
+test_files: []