slotty 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87691a9de20b669f0f555aa296d7b3bdca7a60ed8388760b2842a603d431eb9d
-  data.tar.gz: d531edfa52945ea463d3ebb4beaee295a1f8e2e8122ebd3c83671dbde52bdc58
+  metadata.gz: 2ee8874189a13b9afe1a96fdbf374869d042dbee081c7e93d882a37a70cfdecb
+  data.tar.gz: 78705a44de3d72b5f6ee03a757698956d765f04d21429a4821b6c91ae869322a
 SHA512:
-  metadata.gz: dae671c77e03776d70cb76e2b6811bcdbb0dd0570e502ecec0c633043aa9fb86268bb61430c12b0f9e562106661caa4300ba879d64a80f8603187e8a41eb3d6a
-  data.tar.gz: d95d422495cf2deb9eb8879d5ae9f3dfe8e23ef3619723c1809e5e98df507c3967bf5dc34503a1ade345df020bc97aff35c48cbed131d706d90c3bb91d87631e
+  metadata.gz: 4130703e7deb8854d6c401f844957207a777484db2c34f349497c05fffb843bf5ea7517d5a3baf79b3a37ca7fcb672df3e0c781e0f97e810d54d3f9bb06ac7ec
+  data.tar.gz: be3e2c84168c5e89c9ecc79632548f191165f288799ac56ee26ca601daeca02826e3f8869899a0a8262c65a23c856bbdcfbd6624f74ff59b9300eebc71549845

data/.github/workflows/rspec.yml

@@ -0,0 +1,15 @@
+name: Run RSpec tests
+on: [push]
+jobs:
+  run-rspec-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3.0
+          bundler-cache: true
+      - name: Run tests
+        run: |
+          bundle exec rspec

data/.github/workflows/rubocop.yml

@@ -0,0 +1,16 @@
+name: Run Rubocop
+on: [push]
+jobs:
+  run-rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3.0
+          bundler-cache: true
+      - name: Run rubocop
+        run: |
+          bundle exec rubocop
+

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.0

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in slotty.gemspec
 gemspec

data/Gemfile.lock

@@ -1,35 +1,65 @@
 PATH
   remote: .
   specs:
-    slotty (0.1.0)
+    slotty (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.1)
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    parallel (1.24.0)
+    parser (3.3.1.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.63.5)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
+  arm64-darwin-23
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  bundler (~> 2.5.9)
+  rake (~> 13.2.1)
+  rspec (~> 3.13)
+  rubocop (~> 1.63)
   slotty!
 
 BUNDLED WITH
-   1.17.2
+   2.5.9

data/README.md

@@ -1,4 +1,6 @@
 # Slotty
+[![Rubocop](https://github.com/haydenrou/slotty/actions/workflows/rubocop.yml/badge.svg)](https://github.com/haydenrou/slotty/actions/workflows/rubocop.yml/badge.svg)
+[![Rspec](https://github.com/haydenrou/slotty/actions/workflows/rspec.yml/badge.svg)](https://github.com/haydenrou/slotty/actions/workflows/rspec.yml/badge.svg)
 
 Slotty provides a way of determining available slots within a time frame. An example would be where a service provider needs to take bookings.
 
@@ -22,12 +24,11 @@ Or install it yourself as:
 
 ```ruby
 Slotty.get_slots(
-  from: Time.new(2020, 05, 01, 8, 00),
-  to: Time.new(2020, 05, 01, 11, 00),
-  slot_length: 60 * 60,
-  timeframe: 15 * 60,
+  for_range: Time.new(2020, 05, 01, 8, 00)..Time.new(2020, 05, 01, 11, 00),
+  slot_length_mins: 60,
+  interval_mins: 15,
   exclude_times: [
-    { start: Time.new(2020, 05, 01, 9, 01), end: Time.new(2020, 05, 01, 9, 59) },
+    Time.new(2020, 05, 01, 9, 00)..Time.new(2020, 05, 01, 10, 00)
   ]
 )
 
@@ -45,6 +46,8 @@ Slotty.get_slots(
 # ]
 ```
 
+If you want to just receive the human times back (i.e. "10:00 AM"), you can pass `for: :to_s` to `#get_slots`
+
 ## 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.

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "slotty"
+require 'bundler/setup'
+require 'slotty'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "slotty"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/slotty/slot.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'slotty/timeframe'
+
+module Slotty
+  # The Slot class represents a time slot and provides methods to check
+  # for overlaps with excluded slots and to format the time slot as a string.
+  class Slot
+    attr_reader :range, :begin, :end
+
+    # Initializes a Slot instance with a specified range.
+    #
+    # @param range [Range] The time range for the slot.
+    def initialize(range:)
+      @range = range
+      @begin = range.begin
+      @end = range.end
+    end
+
+    # Checks if the slot has overlaps with any of the excluded slots.
+    #
+    # @param excluded_slots [Array<Range>] An array of ranges representing excluded slots.
+    # @return [Boolean] true if there are overlaps with any excluded slots, otherwise false.
+    def overlaps?(excluded_slots = [])
+      return false if excluded_slots.empty?
+
+      excluded_slots.any? do |exc_slot|
+        Timeframe.contains?(exc_slot, range)
+      end
+    end
+
+    # Returns the start time of the slot formatted as a string.
+    #
+    # @return [String] The formatted start time of the slot.
+    def to_s
+      range.begin.strftime('%I:%M %p')
+    end
+
+    # Returns a hash representation of the slot with detailed time information.
+    #
+    # @return [Hash] A hash containing the start time, end time, and formatted time.
+    def full
+      {
+        start_time: range.begin,
+        end_time: range.end,
+        time: to_s
+      }
+    end
+  end
+end

data/lib/slotty/timeframe.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Slotty
+  # The Timeframe class provides methods to determine if one time range
+  # covers or contains another time range.
+  class Timeframe
+    class << self
+      # Determines if the surrounding_range completely covers the included_range.
+      #
+      # @param surrounding_range [Range] The range that is expected to cover the other.
+      # @param included_range [Range] The range that is expected to be covered.
+      # @return [Boolean] true if surrounding_range covers included_range, otherwise false.
+      def covers?(surrounding_range, included_range)
+        starts_before = surrounding_range.begin <= included_range.begin
+        ends_after = surrounding_range.end >= included_range.end
+
+        starts_before && ends_after
+      end
+
+      # Determines if the potential_slot is contained within the excluder range.
+      #
+      # @param excluder [Range] The range that potentially excludes another.
+      # @param potential_slot [Range] The range that is expected to be contained.
+      # @return [Boolean] true if potential_slot is within excluder, otherwise false.
+      def contains?(excluder, potential_slot)
+        start_within = potential_slot.begin >= excluder.begin && potential_slot.begin < excluder.end
+        end_within = potential_slot.end > excluder.begin && potential_slot.end <= excluder.end
+
+        start_within || end_within
+      end
+    end
+  end
+end

data/lib/slotty/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Slotty
-  VERSION = "0.1.0"
+  VERSION = '1.1.0'
 end

data/lib/slotty.rb

@@ -1,32 +1,83 @@
-require "slotty/version"
-require "slotty/validator"
+# frozen_string_literal: true
 
+require 'slotty/version'
+require 'slotty/timeframe'
+require 'slotty/slot'
+
+# The Slotty module provides methods to generate time slots based on a specified
+# range, slot length, and interval. It also allows for excluding specific time
+# slots from the generated list.
 module Slotty
-  class Error < StandardError; end
+  InvalidFormatError = Class.new(StandardError)
+  InvalidDateError = Class.new(StandardError)
+  InvalidSlotLengthError = Class.new(StandardError)
+  InvalidIntervalError = Class.new(StandardError)
+  InvalidExclusionError = Class.new(StandardError)
 
   class << self
-    def get_slots(from:, to:, slot_length:, timeframe:, exclude_times: [])
+    # Retrieves available slots within a specified range, considering slot length,
+    # interval between slots, and any times to be excluded.
+    #
+    # @param for_range [Range] The range within which to generate slots.
+    # @param slot_length_mins [Integer] The length of each slot in minutes.
+    # @param interval_mins [Integer] The interval between the start of each slot in minutes.
+    # @param as [Symbol] The format in which to return the slots (:full by default).
+    # @param exclude_times [Array<Range>] An array of time ranges to be excluded.
+    # @raise [InvalidDateError] If for_range is not a Range.
+    # @raise [InvalidSlotLengthError] If slot_length_mins is not an integer.
+    # @raise [InvalidIntervalError] If interval_mins is not an integer.
+    # @raise [InvalidExclusionError] If exclude_times is not an array of ranges.
+    # @raise [InvalidFormatError] If the format specified in `as` is invalid.
+    # @return [Array<Object>] An array of slots in the specified format.
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+    def get_slots(for_range:,
+                  slot_length_mins:,
+                  interval_mins:,
+                  as: :full,
+                  exclude_times: [])
+      raise InvalidDateError, 'for_value must be type of Range' unless for_range.is_a?(Range)
+      raise InvalidSlotLengthError, 'slot_length_mins must be an integer' unless slot_length_mins.is_a?(Integer)
+      raise InvalidIntervalError, 'interval_mins must be an integer' unless interval_mins.is_a?(Integer)
+
+      unless exclude_times.is_a?(Array) && exclude_times.all? do |t|
+               t.is_a?(Range)
+             end
+        raise InvalidExclusionError,
+              'exclude_times must be an array of time ranges'
+      end
+
+      slot_length = slot_length_mins * 60
+      interval = interval_mins * 60
+
       slots = Array.new(0)
 
-      potential_slot = from..(from + slot_length)
+      potential_slot = Slot.new(range: for_range.begin..(for_range.begin + slot_length))
 
-      while (from..to).cover?(potential_slot)
-        if Validator.has_overlaps?(potential_slot, exclude_times)
-          potential_slot = (potential_slot.begin + timeframe)..(potential_slot.begin + timeframe + slot_length)
+      while Timeframe.covers?(for_range, potential_slot)
+        if potential_slot.overlaps?(exclude_times)
+          range = (potential_slot.begin + interval)..(potential_slot.begin + interval + slot_length)
+          potential_slot = Slot.new(range:)
 
           next
         end
 
-        slots << {
-          start_time: potential_slot.begin,
-          end_time:   potential_slot.end,
-          time:       potential_slot.begin.strftime('%H:%M %p')
-        }
+        raise InvalidFormatError, 'cannot format slot in this way' unless potential_slot.respond_to?(as)
+
+        slots << potential_slot.send(as)
+
+        range = (potential_slot.begin + interval)..(potential_slot.begin + interval + slot_length)
 
-        potential_slot = (potential_slot.begin + timeframe)..(potential_slot.begin + timeframe + slot_length)
+        potential_slot = Slot.new(range:)
       end
 
       slots
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
   end
 end

data/slotty.gemspec

@@ -1,29 +1,34 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "slotty/version"
+require 'slotty/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "slotty"
+  spec.name          = 'slotty'
   spec.version       = Slotty::VERSION
-  spec.authors       = ["Hayden Rouille"]
-  spec.email         = ["hayden@rouille.dev"]
+  spec.authors       = ['Hayden Rouille']
+  spec.email         = ['hayden@rouille.dev']
 
-  spec.summary       = %q{Generate available slots between time ranges}
-  spec.description   = %q{Slotty will determine the available time slots for a given period, taking in a set of pre-existing busy periods and a timeframe of the appointment}
-  spec.homepage      = "https://github.com/haydenrou/slotty"
-  spec.license       = "MIT"
+  spec.summary       = 'Generate available slots between time ranges'
+  spec.description   = "Slotty will determine the available time slots for a given period, taking in a set of \
+                        pre-existing busy periods and a timeframe of the appointment"
+  spec.homepage      = 'https://github.com/haydenrou/slotty'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 3.3.0'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.5.9'
+  spec.add_development_dependency 'rake', '~> 13.2.1'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'rubocop', '~> 1.63'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slotty
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Hayden Rouille
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2024-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,53 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.5.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.5.9
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.63'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.63'
 description: Slotty will determine the available time slots for a given period, taking
-  in a set of pre-existing busy periods and a timeframe of the appointment
+  in a set of                         pre-existing busy periods and a timeframe of
+  the appointment
 email:
 - hayden@rouille.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".tool-versions"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -72,14 +89,16 @@ files:
 - bin/console
 - bin/setup
 - lib/slotty.rb
-- lib/slotty/validator.rb
+- lib/slotty/slot.rb
+- lib/slotty/timeframe.rb
 - lib/slotty/version.rb
+- slotty-0.1.0.gem
 - slotty.gemspec
 homepage: https://github.com/haydenrou/slotty
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,15 +106,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Generate available slots between time ranges
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.1
-before_install: gem install bundler -v 1.17.2

data/lib/slotty/validator.rb

@@ -1,21 +0,0 @@
-module Slotty
-  class Validator
-    class << self
-      def has_overlaps?(slot, excluded_slots = [])
-        return false if excluded_slots.empty?
-
-        excluded_slots.any? do |excluder|
-          excluder_overlaps_slot_start = (excluder[:start]..excluder[:end]).include? slot.begin
-          excluder_overlaps_slot_end   = (excluder[:start]..excluder[:end]).include? slot.end
-          slot_overlaps_excluder_start = (slot.begin..slot.end).include? excluder[:start]
-          slot_overlaps_excluder_end   = (slot.begin..slot.end).include? excluder[:end]
-
-          excluder_overlaps_slot_start |
-            excluder_overlaps_slot_end |
-            slot_overlaps_excluder_start |
-            slot_overlaps_excluder_end
-        end
-      end
-    end
-  end
-end