Dionisia - Edges - Hotel by larachan15 · Pull Request #37 · Ada-C10/hotel

larachan15 · 2018-09-10T15:56:36Z

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 decision I made was to not use a module. I started to create one, but then it didn’t make sense to me because this is a small project and I only had 3 classes. I also wasn’t sure if I should make a room class or not. But in the end, because I didn’t have a module, I decided to create the room class to try and make my 3 classes have as much single responsibility as possible.
Describe a concept that you gained more clarity on as you worked on this assignment.	I am still struggling with proper syntax. I had a LOT of errors in my code and so I’m becoming a lot better at reading through the stack trace. I also gained more clarity writing the tests. I definitely need to write more tests and this became a lot easier to do towards the end of the weekend.
Describe a nominal test that you wrote for this assignment.	I wrote a test to check to see if reservation_tracker calculated the cost_of_a_given_reservation properly
Describe an edge case test that you wrote for this assignment.	I wrote a test to check if a check_out_date was entered in before a check_in_date for reservation
How do you feel you did in writing pseudocode first, then writing the tests and then the code?	I think I need more practice with this. I didn’t write much psuedocode. I tried to diagram the relationships between the methods and the classes that I thought I needed and then wrote tests. I did switch into writing code first and then creating some tests after because I was running out of time and that process for me is still faster at this time.

…g test

…ange and rate.

…ts complete

…ests passing.

…ve 2

…ed with passing test

wq exit!

tildeee · 2018-09-21T01:30:59Z

Hotel

What We're Looking For

Feature	Feedback
Baseline
Used git regularly	x
Answer comprehension questions	x
Design
Each class is responsible for a single piece of the program	x
Classes are loosely coupled	x
Wave 1
List rooms	x
Reserve a room for a given date range	x
List reservations for a given date	x
Calculate reservation price	x
Invalid date range produces an error	x
Test coverage	x
Wave 2
View available rooms for a given date range	x
Reserving a room that is not available produces an error	? maybe I'm not seeing if this requirement is met
Test coverage	x... I expected more tests around date conflicts when creating reservations and for a lot more of your methods.
Wave 3
Create a block of rooms	x
Check if a block has rooms	x
Reserve a room from a block
Test coverage	getting there...
Fundamentals
Names variables, classes and modules appropriately	x
Understanding of variable scope - local vs instance	x
Can create complex logical structures utilizing variables	x yes!
Appropriately uses methods to break down tasks into smaller simpler tasks	x
Understands the differences between class and instance methods	x
Appropriately uses iterators and enumerables	x, you took ownership of this!
Appropriately writes and utilizes classes	x
Appropriately utilizes modules as a mechanism to encapsulate functionality	Didn't use a module in this project, and that's okay!
Wrap Up
There is a refactors.txt file
The file provides a roadmap to future changes
Additional Feedback

Dionisia! You did a great job with this project. I think the code is really clean and logical -- I am impressed by how slim ReservationTracker turned out, and I'm pleased with that! I think that your ability to feel comfortable in Ruby (using map, iteration, pop/array manipulation, classes, constants) contributed to how nice the code feels.

I'm adding a bunch of comments that I think will amplify... elevate ... your code style.

Overall, I feel that your tests are lacking. I think you acknowledge that based on your comprehension question answers, but I just wanted to say it out loud! It's just a shame because I think the code style is great, but I can't be confident that it's working as required because of the lack of tests.

Otherwise, the code looks great... If the code actually works accurately, then the code looks really great. To be quite clear: I don't trust that much of this code works as you'd like it to/there are more bugs than you think! But code-wise and design-wise, I think this is a great start. Good job!

tildeee · 2018-09-21T01:31:28Z

lib/block.rb

+  BLOCKRATE = 100
+
+  def initialize(check_in_date, check_out_date, block_of_rooms)
+    @id = SecureRandom.uuid


I think your use of the SecureRandom gem here to generate an ID is rad!

tildeee · 2018-09-21T01:31:45Z

lib/hotel.rb

+
+def hotel
+  return "hotel"
+end


Whoops! You should probably delete this file and all references to it.

tildeee · 2018-09-21T01:32:28Z

lib/reservation.rb

+    @check_in_date = check_in_date
+    @check_out_date = check_out_date
+    @room_number = room_number
+    raise StandardError, 'The end date cannot be before the start date.' if check_out_date <= check_in_date


I love that the logic to check if reservation dates are valid are in the Reservation itself. Nice decision :)

tildeee · 2018-09-21T01:33:00Z

lib/reservation.rb

+
+# module Hotel
+class Reservation
+  attr_reader :check_in_date, :check_out_date, :room_number, :nights_stayed


attr_readers are reserved for names of instance variables. :nights_stayed isn't the name of an instance var, it's the name of a method -- it doesn't need to be in this list!

tildeee · 2018-09-21T01:33:38Z

lib/reservation_tracker.rb

+  def initialize
+    @rooms = create_rooms
+    @reservations = []
+    @unreserved_rooms = []


Does this instance variable @unreserved_rooms ever get used? If it doesn't get used, can we get rid of it?

tildeee · 2018-09-21T01:34:05Z

lib/reservation_tracker.rb

+
+  # accesses the list of reservations for a specific date
+  def list_of_reservations(date)
+    return @reservations.find_all { |reservation| reservation.nights_stayed == date }


Does this code actually work? It looks fishy to me, and I can't tell because there aren't any tests! :(

tildeee · 2018-09-21T01:36:05Z

lib/reservation_tracker.rb

+     # set the rooms_not_reserved method and arguments to a local variable.
+     unreserved_rooms = rooms_not_reserved(check_in_date, check_out_date)
+     if unreserved_rooms.length == 0
+      raise ArgumentError, 'No Available Rooms for Given Dates'


Instead of raising an ArgumentError, it might make more sense to make your own custom error or just raise StandardError!

tildeee · 2018-09-21T01:36:51Z

lib/reservation_tracker.rb

+  def rooms_not_reserved(check_in_date, check_out_date)
+    # if the reservations array is empty, this returns an array of available room numbers. If there are no reservations, all rooms can be reserved.
+    return @rooms.map { |room| room.room_number } if @reservations.empty?
+    unreserved_rooms = @rooms.map { |room| room.room_number }


Love how dense and juicy and exciting the above two lines are!

tildeee · 2018-09-21T01:37:04Z

lib/reservation_tracker.rb

+  # checks to see if a room is available and reserves the first available room for a given date range. Uses the rooms_not reserved method.
+  def reserve_room(check_in_date, check_out_date)
+     # set the rooms_not_reserved method and arguments to a local variable.
+     unreserved_rooms = rooms_not_reserved(check_in_date, check_out_date)


I love this line! Very clear what's going on here.

tildeee · 2018-09-21T01:39:10Z

lib/reservation_tracker.rb

+    # if @reservation.empty? is not empty
+    @reservations.each { |reservation|
+      if (reservation.check_in_date >= check_in_date && reservation.check_in_date <= check_out_date) || (reservation.check_out_date >= check_in_date && reservation.check_out_date <= check_out_date)
+        unreserved_rooms.delete(reservation.room_number)


This is a very funny assumption you're putting here:

For the call .delete to work, this assumes that the array unreserved_rooms is an array full room numbers (originally stemming from @rooms) that are unique. If they aren't unique, then this call to delete might not do what you expect... so if the requirement changes that the hotel does not have unique room numbers, this may introduce bugs here.

tildeee · 2018-09-21T01:41:10Z

lib/reservation_tracker.rb

+
+    @blocks.each { |block|
+        if (block.check_in_date >= check_in_date &&  block.check_in_date <= check_out_date) || (block.check_out_date >= check_in_date && block.check_out_date <= check_out_date)
+          unreserved_rooms - block.rooms


This is cool code here! I like it. However... the - isn't destructive. It just does the subtraction, and the result isn't stored anywhere. Observe in irb:

a = [1,2,3] b = [1,2] a - b # => returns [3], as expected # a is still [1,2,3] # b is still [1,2]

So the subtraction doesn't do anything!

tildeee · 2018-09-21T01:41:33Z

lib/reservation_tracker.rb

+  def reserve_room(check_in_date, check_out_date)
+     # set the rooms_not_reserved method and arguments to a local variable.
+     unreserved_rooms = rooms_not_reserved(check_in_date, check_out_date)
+     if unreserved_rooms.length == 0


The indentation here is off ;)

larachan15 added 22 commits September 4, 2018 11:34

Add coverage directory to .gitignore file

37185c8

First commit w/ guard

d647a3c

added room.rb with one passing test

380801e

room.rb with all tests written so far passing

332855b

simplified room class to take a room_number only

a4dc534

added reservation class with check_in, check_out and room. Has workin…

2f79288

…g test

created booking_range and rate definitions.

d7fb0cd

updated reservation.rb and spec file with passing tests for booking_r…

ad67f98

…ange and rate.

Add DS_Store to gitignore

a969eda

can access the list of all of the rooms in the hotel with passing tes…

cbc8582

…ts complete

can reserve a room for a given date range with passing test

b5ff6f6

accesses the list of reservations for a specific date with passing test

a2b9e42

Wave 1 finished with get the total cost for a given reservation and t…

030ce24

…ests passing.

added test for nightsstayed definition in reservation.rb

d691eec

Fixed typo in list of reservations definition. Added some code for wa…

0bf146e

…ve 2

created with is_room_available, one failing test and rooms_not_reserv…

a7cfbe5

…ed with passing test

wave 2 complete with passing tests

f21593b

wq exit!

added a couple of tests.

8b3b4e8

added a block class and spec sheet with passing tests.

d5404ec

added BlockReservation to reservation.rb with passing test.

b6848da

added block section to rooms not reserved definition. Fixed test.

eea072e

added method to create a block with passing test.

97d3845

tildeee reviewed Sep 21, 2018

View reviewed changes

lib/hotel.rb

def hotel

return "hotel"

end

Copy link

tildeee Sep 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops! You should probably delete this file and all references to it.

tildeee reviewed Sep 21, 2018

View reviewed changes

Added design-activity.md and answered prompts.

4fd6a9b

Conversation

larachan15 commented Sep 10, 2018

Hotel

Comprehension Questions

Uh oh!

tildeee commented Sep 21, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Hotel

What We're Looking For

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tildeee commented Sep 21, 2018 •

edited

Loading