slotty 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87691a9de20b669f0f555aa296d7b3bdca7a60ed8388760b2842a603d431eb9d
-  data.tar.gz: d531edfa52945ea463d3ebb4beaee295a1f8e2e8122ebd3c83671dbde52bdc58
+  metadata.gz: 3ce087830c3a4b050ffdf7c1b22b7421e643fd377d1a5011995c5eb8a301d649
+  data.tar.gz: fba230d41f3fd7732de6b871b80cc5f7509ab2d54b204eab97913f0e60bb62d1
 SHA512:
-  metadata.gz: dae671c77e03776d70cb76e2b6811bcdbb0dd0570e502ecec0c633043aa9fb86268bb61430c12b0f9e562106661caa4300ba879d64a80f8603187e8a41eb3d6a
-  data.tar.gz: d95d422495cf2deb9eb8879d5ae9f3dfe8e23ef3619723c1809e5e98df507c3967bf5dc34503a1ade345df020bc97aff35c48cbed131d706d90c3bb91d87631e
+  metadata.gz: ab763cbad35a6322583759c42d9b38f8d31e566ad94885b3fbbc66c16a1c2efb28059841a52e1350ce48b57f8a5d4d908cc2adba4b5790a34d98629e3e8b1b36
+  data.tar.gz: c05da44d9004438d64389b0954e68a0718880fd39e4b0871eeaf03ced25b727beaad3b26544e080d0e468288b28ea148e18bece6ac9ac7e30fc577be34d2c9ef

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.0

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    slotty (0.1.0)
+    slotty (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    rake (10.5.0)
+    rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -27,9 +27,9 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.17)
-  rake (~> 10.0)
+  rake (~> 12.3.3)
   rspec (~> 3.0)
   slotty!
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/README.md

@@ -22,12 +22,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 +44,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/lib/slotty.rb

@@ -1,29 +1,40 @@
 require "slotty/version"
-require "slotty/validator"
+require "slotty/timeframe"
+require "slotty/slot"
 
 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: [])
+    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)
+      raise InvalidExclusionError, "exclude_times must be an array of time ranges" unless exclude_times.is_a?(Array) && exclude_times.all? { |t| t.is_a?(Range) }
+
+      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.has_overlaps?(exclude_times)
+          potential_slot = Slot.new(range: (potential_slot.begin + interval)..(potential_slot.begin + interval + slot_length))
 
           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)
 
-        potential_slot = (potential_slot.begin + timeframe)..(potential_slot.begin + timeframe + slot_length)
+        potential_slot = Slot.new(range: (potential_slot.begin + interval)..(potential_slot.begin + interval + slot_length))
       end
 
       slots

data/lib/slotty/slot.rb

@@ -0,0 +1,33 @@
+require "slotty/timeframe"
+
+module Slotty
+  class Slot
+    attr_reader :range, :begin, :end
+
+    def initialize(range:)
+      @range = range
+      @begin = range.begin
+      @end = range.end
+    end
+
+    def has_overlaps?(excluded_slots = [])
+      return false if excluded_slots.empty?
+
+      excluded_slots.any? do |exc_slot|
+        Timeframe.contains?(exc_slot, range)
+      end
+    end
+
+    def to_s
+      range.begin.strftime('%I:%M %p')
+    end
+
+    def full
+      {
+        start_time: range.begin,
+        end_time:   range.end,
+        time:       to_s
+      }
+    end
+  end
+end

data/lib/slotty/timeframe.rb

@@ -0,0 +1,20 @@
+module Slotty
+  class Timeframe
+    class << self
+      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
+
+      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,3 @@
 module Slotty
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/slotty.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slotty
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Hayden Rouille
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2020-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -72,8 +73,10 @@ 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:
@@ -94,7 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Generate available slots between time ranges

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