Pipes - Sarah Read-Brown - Hotel #47

SRBusiness · 2017-09-11T16:03:27Z

Hotel

Congratulations! You're submitting your assignment!

Comprehension Questions

Question	Answer
Describe a design decision you had to make when working on this project. What options were you considering? What helped you make your final decision?	One thing we talked about doing in my group was handling the dates and date ranges in a more traditional calendar format, where we would create a whole year of dates. We ended up not doing that because we felt like it was a lot of work and that we could accomplish the same thing by searching through a collection of reservations vs having an object for each date.
Describe a concept that you gained more clarity on as you worked on this assignment.	The block concept was really abstract to me in the beginning of this assignment and I didn't realize until the end how vital the room class and objects would be to its success. As I went about building the block class I was struggling with how to deal with rooms once they had been assigned to a block. After struggling for awhile I realized that I could add a state attribute to rooms and use that to store data on if rooms a block have been reserved.
Describe a nominal test that you wrote for this assignment.	For reserving a room from within a block I wrote a test to make sure that the method would change the state of rooms from false (non reserved) to true (reserved)
Describe an edge case test that you wrote for this assignment.	I wrote a test to make sure that user input for dates needed to be date objects.
How do you feel you did in writing pseudocode first, then writing the tests and then the code?	For this project it was harder than previous ones to stick to writing the test code. I found that the sheer size of my reservations class made it hard not to get sucked into writing code first. For the smaller classes it was much easier to follow the order of operations listed in this question.

…s them

…d to be called later

…e rooms

…or edge case anything that isn't a date object

… method

…ults to nil

…test specs so they all pass again

…ng to reserve more then 5 rooms

droberts-sea · 2017-09-19T19:32:03Z

Hotel

What We're Looking For

Feature	Feedback
Baseline
Used git regularly	yes - good work
Answer comprehension questions	yes
Design
Each class is responsible for a single piece of the program	mostly - it seems like `Reservations` has eaten some of the responsibility that ought to be part of `DateRange`
Classes are loosely coupled	yes - good work
Wave 1
List rooms	yes
Reserve a room for a given date range	yes
List reservations for a given date	yes
Calculate reservation price	yes
Invalid date range produces an error	yes
Test coverage	yes
Wave 2
View available rooms for a given date range	yes
Reserving a room that is not available produces an error	yes
Test coverage	some - see inline comment
Wave 3
Create a block of rooms	yes
Check if a block has rooms	some - see inline comment
Reserve a room from a block	yes
Test coverage	yes
Additional Feedback

Good job overall. There are a couple places where your design could be improved, particularly around the interaction between Blocks and Rooms and in delegating responsibility to DateRange, but for the most part it seems well-thought-out and deliberate. Your specific method code is well-organized and easy to read, and your test coverage is solid. Keep up the hard work!

droberts-sea · 2017-09-19T18:49:53Z

lib/date_range.rb

+
+    def valid_date?
+      valid_input?
+      if @check_in > @check_out


Nitpick: I like that these validations are called from your constructor, but I think the code would be a little more readable if they were invoked directly, rather than via make_nights_arr.

droberts-sea · 2017-09-19T18:51:50Z

lib/reservations.rb

+    def update_room_state(rooms_to_book,num_rooms,state)
+      num_rooms.times do |i|
+        rooms_to_book[i].booked = state
+      end


You could use an each loop here with the same effect.

droberts-sea · 2017-09-19T19:06:55Z

lib/reservations.rb

+      range = DateRange.new(check_in,check_out).nights_arr
+      range.each do |date|
+        @all_reservations.each do |booking|
+          if booking.date_range.nights_arr.include?(date)


Instead of looping through every date in the range, it might be a little cleaner to write a method DateRange#overlap?(other). Then this loop could be simplified to:

booked_rooms = [] range = DateRange.new(check_in,check_out) @all_reservations.each do |booking| if booking.date_range.overlap?(range) # add rooms to booked_rooms end end return booked_rooms

It's doing the same work, but I would argue this version is more readable, and does a better job of separating responsibilities. It also makes testing easier!

droberts-sea · 2017-09-19T19:10:18Z

lib/block.rb

+      @block_info = block_info
+    end
+
+    def rooms_available_block


Because this method is already inside the Block class, you shouldn't need to add _block to the name.

droberts-sea · 2017-09-19T19:11:54Z

lib/block.rb

+      @rooms.each do |room|
+        if room.booked == false || room.booked == nil
+          rooms_available << room
+        end


This method for keeping track of which rooms are reserved is an interesting idea, but I believe you will run into trouble if you have multiple blocks for different dates containing the same rooms. Because the Room instances are shared between blocks, marking a room reserved for one block will make it reserved for all blocks.

droberts-sea · 2017-09-19T19:13:06Z

lib/reservations.rb

+    end
+
+    def reserve_from_block(block, num_rooms)
+      rooms_to_book = block.rooms_available_block


I really like that you call a method on block here rather than manipulating its state directly. Good example of loose coupling.

droberts-sea · 2017-09-19T19:19:34Z

specs/reservations_spec.rb

+      arr_booked.length.must_equal arr_booked_unique.length
+    end
+    it "returns an empty array if nothing is booked" do
+      @hotel.check_reservations(@check_in + 1,@check_out + + 1).must_be_empty


Good coverage for this method.

droberts-sea · 2017-09-19T19:20:55Z

specs/reservations_spec.rb

+      @hotel.make_reservation(@check_in + 2, @check_out + 2,20)
+    end
+    describe "make a block " do
+      it "will create a block, " do


Good use of a nested describe to organize things.

droberts-sea · 2017-09-19T19:23:03Z

specs/reservations_spec.rb

+    it "returns an empty array if everything is booked" do
+      @hotel.make_reservation(@check_in,@check_out,18)
+      @hotel.check_availability(@check_in,@check_out).must_be_empty
+    end


There are a number of other cases I'd be interested in exploring around when a room is considered available. My full list includes:

Not available:

Same dates

Overlaps in the front

Overlaps in the back

Completely contained

Completely containing

Available:

Completely before

Completely after

Ends on the checkin date

Starts on the checkout date

…ed some of the code in check_reservations class

SRBusiness added 30 commits September 5, 2017 16:57

Add spechelper and rakefile

627ed96

update gitignore

e7af91b

Create reservations file with basic architecture and psedocode

02af24f

Create reservations spec file and updates spec helper

78febe7

Add room class and spec files

d608723

create daterange and booking files and specs

4deac25

Adds test for daterange spec initialize

17ec899

Changes the name of reservation class to booking for clarity

3b34daa

Adds attr reader helper to date range class file

97fb45f

Adds spec test for valid date method that includes a custom exception

876b033

Created custom exception that will raise for an invalid date range

ccc6b10

adds tests and method code for make nights arr method

95de54d

Adds room class spec tests and then the logic for rooms class to apas…

fd2fb92

…s them

Wrote tests for booking class spec file

d241790

Added make nights array method to initialize method so it doesn't nee…

6eb9948

…d to be called later

Adds attr reader helper method to booking class

3499b13

Adds some hash comments and updates spec tests for booking spec

d495c37

Update total cost of booking in initialize

08c533a

Adds room creation to initialize method for reservation class

d86ef75

Cleans up spacing and comments

a7e7a94

Add spec test for check reservations method, skipped some tests

d6a4885

Wrote check reservation method passes every test except returns uniqu…

3a12eb7

…e rooms

updates spec test to test for unique returns

72797cc

update instances of rooms class in testing methods

ff52fe2

sketched out make reservation method

190c630

DRY up spec tests

06b3aa8

Adds check availability method in reservations class

46cf793

Added a method for checking user input for checkin and out and test f…

7fefb84

…or edge case anything that isn't a date object

Adds more tests for make reservations method

87141c0

Addd a new custom exception for invalid numbers of rooms requested

0f12b18

SRBusiness added 24 commits September 8, 2017 11:56

Changes a conditional statement from and to or in date range validate…

13dd2dc

… method

Attempt to DRY up reservations spec tests

1ebef79

Removes white space

bc65f72

Minor formating changes and white space work in lib directory

0e03759

Dry up date range and booking spec

1380c48

Adds block.rb file

097396b

Adding a new parameter for booking class called block infor that defa…

570072f

…ults to nil

Adds block to spec helper file

2413e55

updates make reservation method with new parameter for booking class

ad8791c

playing with total cost method for booking and block classes

f4a76c9

first pass at adding block logic

e195727

Back track to get my old tests working

a26eee4

changed the booking and block class parameters and then modified the …

92cb777

…test specs so they all pass again

Refactored check availability in block method

79a34c7

adds booked to attr reader method

d36e017

Updates accessor in rooms class

27262e8

Got make reservations method to work with block logic

e3c9c59

Update enough rooms method to that is raises exception for block tryi…

d787e1f

…ng to reserve more then 5 rooms

Adds new test specs

dcd97fa

adds new method to update room state

affc5f2

Clean up old hashed out code from block spec

535c97b

Clean up old hashed out code from reservations

7341b7f

Cleaned up Block class

da1e6f4

Making comments for future work

af98d6e

droberts-sea reviewed Sep 19, 2017

View reviewed changes

SRBusiness added 4 commits October 1, 2017 14:35

Adds design activity

a5be186

update design activity doc

e5f5e4c

updated reservations method to have an overlap? method which simplifi…

bb57886

…ed some of the code in check_reservations class

More comments in design file

557305c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pipes - Sarah Read-Brown - Hotel #47

Pipes - Sarah Read-Brown - Hotel #47

SRBusiness commented Sep 11, 2017

droberts-sea commented Sep 19, 2017

droberts-sea Sep 19, 2017

droberts-sea Sep 19, 2017

droberts-sea Sep 19, 2017

droberts-sea Sep 19, 2017

droberts-sea Sep 19, 2017

droberts-sea Sep 19, 2017

droberts-sea Sep 19, 2017

droberts-sea Sep 19, 2017

droberts-sea Sep 19, 2017

Pipes - Sarah Read-Brown - Hotel #47

Are you sure you want to change the base?

Pipes - Sarah Read-Brown - Hotel #47

Conversation

SRBusiness commented Sep 11, 2017

Hotel

Comprehension Questions

droberts-sea commented Sep 19, 2017

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