Ports - Elle #38

dev-elle-up · 2019-03-18T14:49:10Z

Hotel

Congratulations! You're submitting your assignment!

Comprehension Questions

Question	Answer
What was a design challenge that you encountered on this project?	One challenge was deciding what to do with the concept of a room. I considered making it a class but this didn't make sense for my design. I considered having the manager make the rooms but that gave manager more than one responsibility. I settled on making a Room module and this worked well for my design.
What was a design decision you made that changed over time over the project?	Originally the functionality of #ck_avail and #get_insert_index were going to be in the #make_res_for_room method. I decided to put them in their own methods because it's easier to understand what's happening and these methods are now usable on their own.
What was a concept you gained clarity on, or a learning that you'd like to share?	I gained some clarity on how to access methods from outside of a class. The concept also applied to using before-do (which works more like a class) and let (which works more like a method). I'm still not 100% solid on these concepts and I think they will become clearer with continued practice and review.
What is an example of a nominal test that you wrote for this assignment? What makes it a nominal case?	A nominal test I wrote is "Add a new reservation to an available room's reservations array". It adds two reservations to the same room on dates that are separated by a few days in between. This is a very common, normal use of the system, which makes this a nominal case.
What is an example of an edge case test that you wrote for this assignment? What makes it an edge case?	I wrote a test (res6_overlap_start) which tries to make a reservation with an end date that is contained within an existing multi-day reservation but with a start date that was available. This was an edge case because it tested a situation that could pass if only one end of the date range was tested. In a way, it makes sure the same logic used for sorting the reservations by date is not being used by the availability checker.
How do you feel you did in writing pseudocode first, then writing the tests and then the code?	I feel I was largely successful in using this process. I did this for almost every step and I think it helped achieve a high coverage (codecov).

…w passing. Ready to start writing code.

…ss and Manager class. Created tests for creation of rooms array. Generally got this much working.

…lize method.

…st of the reservation. Wrote tests for same. All passing.

…ed), and add the reseveration object to the array associated with (value of) the room number's key in rooms_reservations_hash. Test added for same, passing.

…urn a list (array) of rooms that have a reservation on that date. Along with the room number, the full date range of the reservation is returned.

…e range'. It's failing as desired.

…te range' test. The find_avail_fooms_for_dates method searches each array of reservations to find gaps between bookings and adds the associated available room number to an array, which is returned.

…e other small adjustments to clean up comments.

…ates. This is broken out of the previous function to allow for use in multiple places. Also added checks for 0 and 1 item arrays, as well as checking for availability before first reservation or after last reservation.

…eing added to the available rooms array. Everything else is working. Next: delete some things and re-write them.

… now see a list of rooms that are not reserved for a given date range, reserve an available room, and get an exception error when trying to make a reservation for an unavailable room. Need to build out more tests to check edge cases.

…ng dates.

…both for raising exceptions and for making reservations with shared check-in/check-out dates. (Wave 2 complete.)

CheezItMan · 2019-03-25T20:29:02Z

Hotel

What We're Looking For

Feature	Feedback
Baseline
Used git regularly	Good number of commits and good commit messages
Answer comprehension questions	Check, I'm glad you got more comfortable with calling methods and breaking things down into smaller steps.
Design
Each class is responsible for a single piece of the program	Check
Classes are loosely coupled	Your manager class is doing a bit too much of the work. Consider offloading some of it to `Reservation`. See my inline notes.
Wave 1
List rooms	Check
Reserve a room for a given date range	Check
List reservations for a given date	Check
Calculate reservation price	Check
Invalid date range produces an error	Check
Wave 2
View available rooms for a given date range	Check
Reserving a room that is not available produces an error	Check
Test coverage	100%
Wave 3	INCOMPLETE
Create a block of rooms
Check if a block has rooms
Reserve a room from a block
Test coverage
Fundamentals
Names variables, classes and modules appropriately	Check
Understanding of variable scope - local vs instance	Check
Can create complex logical structures utilizing variables	Check
Appropriately uses methods to break down tasks into smaller simpler tasks	Check
Understands the differences between class and instance methods	Check, see my notes on the `Room` class
Appropriately uses iterators and `Enumerable` methods	Check
Appropriately writes and utilizes classes	Check
Appropriately utilizes modules as a namespace	Check
Wrap Up
There is a refactors.txt file	MISSING
The file provides a roadmap to future changes	MISSING
Additional Feedback	Not bad, you hit many of the learning goals of the project, but obviously didn't get to wave 3. See my inline notes and ask any questions you have. While you didn't get to wave 3 and blocks you did well on waves 1 & 2.

CheezItMan · 2019-03-25T20:13:04Z

lib/room.rb

+
+  def self.make_rooms
+    rooms_res_hash = {}
+    (1..NUM_OF_ROOMS).each { |i| rooms_res_hash[i] = [] }


Interesting a hash of rooms with the number being the key, and the value being an array of reservations. Nice!

CheezItMan · 2019-03-25T20:14:11Z

lib/manager.rb

+    attr_accessor :rooms_reservations_hash
+
+    def initialize
+      @rooms_reservations_hash = Room.make_rooms


I like having this class method in Room. However since you never make an instance of the Room class, maybe instead make Room a module, or have make_rooms as a private factor method in Manager.

Thanks Chris. Room actually is a module! :-D It's in the room.rb file. Is this an acceptable setup or would it be better to eliminate the room.rb file and move that code into manager.rb?

I like having this class method in Room. However since you never make an instance of the Room class, maybe instead make Room a module, or have make_rooms as a private factor method in Manager.

CheezItMan · 2019-03-25T20:16:28Z

lib/manager.rb

+        end
+      end
+
+      return res_on_date # array with [[1, "2019-06-10 through 2019-06-12"], [room_num, "date through date"], etc]


This works, but I'd suggest that it would be easier as an array of hashes with the keys room and reservation_date, just for readability.

CheezItMan · 2019-03-25T20:20:03Z

lib/manager.rb

+        (res_0.ckout_date <= ckin) || (ckout <= res_0.ckin_date) ? true : false
+      else # there is more than one reservation in the array
+        # check left and right ends of the reservation array
+        return true if (ckout <= res_0.ckin_date)


Your code maintains your reservations listed in order, later if you take advantage of things Shruti will teach you like binary search some actions like finding a reservation or finding overlapping reservations may be more efficient.

Nice

CheezItMan · 2019-03-25T20:21:18Z

lib/manager.rb

+      return avail_rooms
+    end
+
+    def print_available_rooms_for_dates(ckin, ckout)


In the future I'd recommend that you separate the roles of printing information and managing rooms and reservations. Printing things out is something I'd do in a driver method or class.

Hi Chris, are you talking about lines 75 & 76? I think those were a couple of puts statements that I was using to test/debug and just forgot to comment them out. My print method is directly below, starting on line 87. Is this what you mean, or am I still missing a concept? I think you might be saying that my Manager class is currently acting as a driver class as well as validating the availability of the reservation dates.

This method print_available_rooms_for_dates is doing printing that should probably be pulled into a separate module

CheezItMan · 2019-03-25T20:21:47Z

lib/manager.rb

+      return avail_rooms
+    end
+
+    def get_insert_index(res_array, new_res)


Just a note for CS Fun. You could speed this up with a binary search. Something to remember.

CheezItMan · 2019-03-25T20:22:38Z

lib/reservation.rb

+module Hotel
+  class Reservation
+    attr_reader :ckin_date, :ckout_date, :date_range_string_array, :num_nights_of_stay, :base_cost
+


Consider moving the checking for overlapping a date with the reservation to this class, so it could handle more actions that deal with a specific reservation. It might simplify your manager class.

Also calculating the cost of a reservation is probably best done as a method just in case the dates change (extremely minor point).

CheezItMan · 2019-03-25T20:24:27Z

spec/manager_spec.rb

+      expect(this_manager.rooms_reservations_hash[9][0].ckin_date.to_s).must_equal "2019-05-29"
+    end
+
+    it "Reservation is allowed if check in or check out is same as another reservation's check in or check out date" do


Good test! 👍

…t doesn't exist'.

…ject design.

…lso not broken.

…OOOO

…nto Reservation in order to decouple. Pulled the length of stay and cost calculations out of the initialize method and into instance methods. Also renamed self.get_date_conflicts to self.ck_dates_are_available for clarity and increased intuition about what is returned.

dev-elle-up added 16 commits March 13, 2019 14:48

Set up spec helper and got minitest configured. First test failed, no…

44001ab

…w passing. Ready to start writing code.

Organized set up of Hotel and Room modules as well as Reservation cla…

e517688

…ss and Manager class. Created tests for creation of rooms array. Generally got this much working.

Made initialize for Reservations class and wrote tests for the initia…

86906c6

…lize method.

Removed spec/coverage/* from git tracking.

026ceb9

Added calculations for reservation date range, nights of stay, and co…

3a3fa35

…st of the reservation. Wrote tests for same. All passing.

Added a method to create a reservation, assign it to a room (hard-cod…

d1a460d

…ed), and add the reseveration object to the array associated with (value of) the room number's key in rooms_reservations_hash. Test added for same, passing.

Wrote method to search existing reservations for a given date and ret…

a982f8e

…urn a list (array) of rooms that have a reservation on that date. Along with the room number, the full date range of the reservation is returned.

Updated test to check for date inside of range.

d0ea0e5

Added a test for 'Display a list of rooms not reserved on a given dat…

debb9a8

…e range'. It's failing as desired.

Wrote methods for 'Display a list of rooms not reserved on a given da…

352fdac

…te range' test. The find_avail_fooms_for_dates method searches each array of reservations to find gaps between bookings and adds the associated available room number to an array, which is returned.

Added a test for reserving an available room for given date. Made som…

231da25

…e other small adjustments to clean up comments.

Working on fixing #find_avail_rooms_for_dates. Room numbers are not b…

3238853

…eing added to the available rooms array. Everything else is working. Next: delete some things and re-write them.

Wrote tests for edge cases trying to make reservations with overlappi…

cc082ad

…ng dates.

Finalized tests for reserving a room. Many edge cases accounted for, …

c9b06ce

…both for raising exceptions and for making reservations with shared check-in/check-out dates. (Wave 2 complete.)

CheezItMan reviewed Mar 25, 2019

View reviewed changes

dev-elle-up added 8 commits March 30, 2019 12:03

Completed the 'design activity'.

5c97e9e

Created and fixed test for 'Won't add a new reservation to a room tha…

42d116a

…t doesn't exist'.

Completed design activity, including plans for improving my Hotel pro…

069a489

…ject design.

Started to move ck_avail from manager to reservation. Not finished, a…

dfad3fd

…lso not broken.

Successfully moved the date conflict checker to Reservation. WOOOOOOH…

936e67f

…OOOO

Cleaned up comments.

74fc4a5

Renamed #date_range_as_strings to #date_range_string.

0081a2c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ports - Elle #38

Ports - Elle #38

dev-elle-up commented Mar 18, 2019 •

edited

Loading

CheezItMan commented Mar 25, 2019

CheezItMan Mar 25, 2019

CheezItMan Mar 25, 2019

dev-elle-up Mar 30, 2019

CheezItMan Mar 25, 2019

CheezItMan Mar 25, 2019

CheezItMan Mar 25, 2019

dev-elle-up Mar 30, 2019

CheezItMan Apr 5, 2019

CheezItMan Mar 25, 2019

CheezItMan Mar 25, 2019

CheezItMan Mar 25, 2019

Ports - Elle #38

Are you sure you want to change the base?

Ports - Elle #38

Conversation

dev-elle-up commented Mar 18, 2019 • edited Loading

Hotel

Comprehension Questions

CheezItMan commented Mar 25, 2019

Hotel

What We're Looking For

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dev-elle-up commented Mar 18, 2019 •

edited

Loading