Space - Cathy #21

cojenco · 2020-03-09T05:50:25Z

Assignment Submission: Hotel

Congratulations! You're submitting your assignment. Please reflect on the assignment with these questions.

Reflection

Question	Answer
What was a design challenge that you encountered on this project?	Where to hold the reservations and how a hotel block should fit in. Which class should hold this information and which needed to be its own class.
What was a design decision you made that changed over time over the project?	At first I had two containers for my reservations. After mid-point review, I decided to remove one of the containers and only let each room hold its own reservations. Looking back, I would refactor that again.
What was a concept you gained clarity on, or a learning that you'd like to share?	All the little things and managing dependencies. Also breaking up methods into smaller methods. While breaking up methods and calling methods, then I also gained clarity on which classes should have an inheritance or composition relationship.
What is an example of a nominal test that you wrote for this assignment? What makes it a nominal case?	For the DateRange #overlapping method, a nominal case was testing an obvious date range that entirely overlapped and a date range that did not overlap at all.
What is an example of an edge case test that you wrote for this assignment? What makes it an edge case?	For the DateRange #overlapping method, one of the edge case was testing a date range that only overlapped the check-in date or check-out date.
How do you feel you did in writing pseudocode first, then writing the tests and then the code?	I did stick to the principal of writing the test first, red, green and refactor. I still need more practice on pseudocode.

…od and tests.

…or and tests.

… reservation_test.

…of date_range.

…ions

…ions. Added corresponding tests.

…sion.

… to room @bookings.

…en making a reservation, it will be added to room's tracking collection.

… tests.

…ve3.

…nd #get_total_price method.

…rooms method to also consider blocks.

kaidamasaki · 2020-03-17T02:55:33Z

Hotel

Section 1: Major Learning Goals

Criteria	yes/no, and optionally any details/lines of code to reference
Practices SRP by having at least two separate classes with distinct responsibilities, and test files for these two classes	✔️
Overall, demonstrates understanding instance variables vs. local variables. (There aren't unnecessarily too many instance variables, when it should be a local variable)	✔️
For each test file, tests demonstrate an understanding of instantiating objects properly, and using Arrange-Act-Assert	✔️
Practices pseudocode and TDD, and reflected on it by filling out the reflection questions	✔️
Practices git with at least 15 small commits and meaningful commit messages	✔️

Section 2: Code Review and Testing Requirements

Criteria	yes/no, and optionally any details/lines of code to reference
There is a class that represents a reservation, and a second class that holds/manages a collection of reservations through composition (instance variable)	✔️
The logic for checking if a reservation's date overlaps with another reservation's date is complex logic that is separated into method(s) (and potentially class(es))	✔️
The logic for checking if a reservation's date overlaps with another reservation's date has unit tests	✔️
All of the given tests run and pass	✔️
A test coverage tool is installed and used, and shows 95% test coverage	✔️ 🎉 100%! 🎉

Section 3: Feature Requirements

Feature Requirement: There is a method that...	yes/no
gives back a list of rooms, and it's tested	✔️
creates a specific reservation for a room for a given date range, and it has nominal test cases	✔️
creates a specific reservation for a room for a given date range, and it tests an edge case, such as no available room, or invalid date range	✔️
gives back a list of reservations on a given date. Its tests include a test that makes several reservations for a given date	✔️ (Tests on with multiple on the same day are borderline.)
calculates the total price for a reservation	✔️
gives back a list of available rooms for a given date range, and it has nominal test cases	✔️
gives back a list of available rooms for a given date range, and it has edge test cases, such as no available room, or invalid date range	(No edge case test.)
creates a block of rooms	✔️
reserves a room from a block	(Not implemented.)

Overall Feedback

Overall Feedback	Criteria	yes/no
Green (Meets/Exceeds Standards)	14+ total in all sections	✔️
Yellow (Approaches Standards)	9-13 total in all sections
Red (Not at Standard)	0-8 total in all sections, or assignment is breaking/doesn’t run with less than 5 minutes of debugging

Additional Feedback

Great work overall! You've built your first project with minimal starting code. This represents an incredible milestone in your journey, and you should be proud of yourself!

I am particularly impressed by the way that you went about writing your tests. You had really strong set up and assertion checks throughout your project.

It might make sense to re-think how you implemented blocks. The way you have it you just make a series of unrelated reservations. Once you've reserved a block of rooms you should be able to reserve those rooms through that block, but not outside of it. (They aren't just a bulk purchase of reservations with a discount.)

This project was extremely difficult though and just completing the basic functionality of blocks is a victory!

Code Style Bonus Awards

Was the code particularly impressive in code style for any of these reasons (or more...?)

Quality	Yes?
Perfect Indentation	✅
Elegant/Clever
Descriptive/Readable
Concise
Logical/Organized	✅

kaidamasaki

Great job! Here are some ways you can tidy up and clarify your code. 😄

kaidamasaki · 2020-03-16T22:34:48Z

lib/date_range.rb

+      nights = (@end_date - @start_date).to_i
+      return nights


You don't need to assign to a variable before returning:

Suggested change

nights = (@end_date - @start_date).to_i

return nights

return (@end_date - @start_date).to_i

kaidamasaki · 2020-03-16T22:35:18Z

lib/date_range.rb

+      return true if date >= @start_date && date < @end_date
+      return false


You can directly return the boolean condition:

Suggested change

return true if date >= @start_date && date < @end_date

return false

return date >= @start_date && date < @end_date

kaidamasaki · 2020-03-16T22:38:02Z

lib/date_range.rb

+    # your library code should assume that it's receiving Date objects to start
+    def initialize(start_date, end_date)
+      raise ArgumentError.new("Please pass in Date class instances.") if !(start_date.is_a? Date) || !(end_date.is_a? Date)
+      raise ArgumentError.new("Live in the present! Dates should not be prior to today.") if start_date < Date.today


It's helpful to include the bad arguments in message of the ArgumentError:

Suggested change

raise ArgumentError.new("Live in the present! Dates should not be prior to today.") if start_date < Date.today

raise ArgumentError.new("Live in the present! Dates should not be prior to today. Bad start_date: #{start_date}") if start_date < Date.today

kaidamasaki · 2020-03-16T22:38:24Z

lib/no_availability_error.rb

@@ -0,0 +1,3 @@
+
+class NoAvailabilityError < StandardError


Custom exception class! 🎉

kaidamasaki · 2020-03-16T22:39:28Z

lib/reservation.rb

+    attr_reader :id, :start_date, :end_date, :date_range, :room_id, :block
+    attr_accessor :cost
+
+    @@next_id = 1


Generally we advise against using a class variable. In this case it's not too bad but it would be preferable to have this stored in the SystemCoordinator.

kaidamasaki · 2020-03-16T22:42:54Z

lib/system_coordinator.rb

+    def list_rooms
+      return rooms
+    end


You don't need both a list_rooms method and an attr_reader on rooms, you should pick one.

kaidamasaki · 2020-03-16T22:53:15Z

lib/system_coordinator.rb

+
+    def find_reservations_room_date(room_id, date_range)
+      selected_room = find_room(room_id)
+      reservations_room_date = selected_room.bookings.reject{|reservation|false == reservation.date_range.overlapping(date_range)}


This can be simplified using select:

Suggested change

reservations_room_date = selected_room.bookings.reject{|reservation|false == reservation.date_range.overlapping(date_range)}

reservations_room_date = selected_room.bookings.select {|reservation| reservation.date_range.overlapping(date_range)}

kaidamasaki · 2020-03-16T22:54:39Z

lib/system_coordinator.rb

+              status = false if item.date_range.overlapping(given_range)
+            end
+          end
+          available_rooms << room if true == status


You don't need to compare to true here since status is a boolean value:

Suggested change

available_rooms << room if true == status

available_rooms << room if status

kaidamasaki · 2020-03-16T23:03:06Z

lib/system_coordinator.rb

+  class SystemCoordinator    
+    attr_reader :rooms
+
+    @@next_block = 1


This definitely doesn't need to be a class variable since there will only be one SystemCoordinator instantiated.

kaidamasaki · 2020-03-16T23:06:19Z

lib/system_coordinator.rb

+      rooms_in_block = []
+
+      room_array.each do |room|
+        if room.is_available(date_range) == false


This can be clarified using an unless:

Suggested change

if room.is_available(date_range) == false

unless room.is_available(date_range)

cojenco added 30 commits March 2, 2020 13:16

Add coverage directory to .gitignore file

94cb11e

Added SimpleCov into test helper

0b568c4

Setup files and gems. Started DateRange class and tests.

f3ed103

Revised DateRange tests using more of Date.today

6cd1e66

Added DateRange#count_nights method and tests.

8f69ba5

Added DateRange#include method and tests.

7f9a473

Added DateRange#overlapping method and tests. Revised #including meth…

d6abc6e

…od and tests.

Created Reservation#initialize and #get_price methods and tests.

1d16a53

Added Room#initialize method and tests

255b4a8

Added @rooms to SystemCoordinator constructor. Revised Room construct…

2e1e6b5

…or and tests.

Revised Room@cost to be a Float, and changed corresponding tests.

c35d83e

Revised Reservation class to pass in date_range as parameter. Revised…

326034f

… reservation_test.

Added back Reservation#get_price tests.

205f236

Added DateRange#include_date method to pass in specific date instead …

543b708

…of date_range.

Added SystemCoordinator#find_reservation_by_date method and @Reservat…

17d6682

…ions. Added corresponding tests.

Added @bookings to Room and updated tests

9026b3e

Added Room#add_booking_to_room method and tests.

81831db

Added SystemCoordinator#find_reservations_room_date method and tests.

1c4c686

Added SystemCoordinator#find_availabile_rooms method and tests.

f5d36d4

Added SystemCoordinator#make_reservation method and tests initial ver…

f074a79

…sion.

Added SystemCoordinator#find_room method and tests.

4baafe9

Revised SystemCoordinator#make_reservation method to push reservating…

83984e0

… to room @bookings.

Added SystemCoordinator#list_rooms method and tests.

a3bdc8f

Added more tests for #make_reservation and cleaned up draft.

b4ae83e

Deleted @Reservations container. Only Room holds its reservations. Wh…

e008545

…en making a reservation, it will be added to room's tracking collection.

Switched #get_price from Reservation to Room class. Revised tests.

86d90f6

Added SystemCoordinator#build_rooms method for the constructor. Added…

9667db6

… tests.

Revised @cost to be attr_accessor in Room class.

eb2d44d

Formatting and adding comments.

d85a9d3

Added tests for SystemCoordinator.

e8b9edb

cojenco added 21 commits March 5, 2020 16:41

Created a NoAvailabilityError class and yet to implement.

c997c2c

Added Block class and test file and updated test helper.

8a8177c

Initial version for Wave2. Design thoughts and psuedocode starting Wa…

a427012

…ve3.

Added comments.

36551ca

Revised Reservation to be superclass. Added @cost instance variable a…

c65c308

…nd #get_total_price method.

Block class inherits from Reservation. Built constructor and tests.

1b63121

Added #exactly_matching method and tests.

ee8f691

Renamed block_id and restored back to original naming.

2f46e39

Revised methods to integrate the Block class and concept. Revised tests.

9929095

Added Room#is_available method and tests.

d1a89b5

Added #make_specific_block method and tests. Revised #find_available_…

bd2940f

…rooms method to also consider blocks.

Cleaning up formatting and code.

434be2e

Added Room#change_rate method and tests.

b67560e

Fixed spelling typo. Revised #list_rooms methods to accomodate CLI.

8df9b3d

Added main.rb

ff0ac77

Added Require_Relative and revised syntax to accomodate CLI.

b017ab5

Added small driver methods to the main.rb file.

def524f

Revised #list_rooms method for main and coordinator files.

24a9b36

Added refactors.txt

5047dc8

Revised #list_rooms method.

9f18e56

Clean up comments.

8c0c0cb

kaidamasaki reviewed Mar 17, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Space - Cathy #21

Space - Cathy #21

Uh oh!

cojenco commented Mar 9, 2020

Uh oh!

kaidamasaki commented Mar 17, 2020

Uh oh!

kaidamasaki left a comment

Uh oh!

kaidamasaki Mar 16, 2020

Uh oh!

kaidamasaki Mar 16, 2020

Uh oh!

kaidamasaki Mar 16, 2020

Uh oh!

kaidamasaki Mar 16, 2020

Uh oh!

kaidamasaki Mar 16, 2020

Uh oh!

kaidamasaki Mar 16, 2020

Uh oh!

kaidamasaki Mar 16, 2020

Uh oh!

kaidamasaki Mar 16, 2020

Uh oh!

kaidamasaki Mar 16, 2020

Uh oh!

kaidamasaki Mar 16, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	nights = (@end_date - @start_date).to_i
	return nights
	return (@end_date - @start_date).to_i

		return true if date >= @start_date && date < @end_date
		return false

	return true if date >= @start_date && date < @end_date
	return false
	return date >= @start_date && date < @end_date

	raise ArgumentError.new("Live in the present! Dates should not be prior to today.") if start_date < Date.today
	raise ArgumentError.new("Live in the present! Dates should not be prior to today. Bad start_date: #{start_date}") if start_date < Date.today

	reservations_room_date = selected_room.bookings.reject{\|reservation\|false == reservation.date_range.overlapping(date_range)}
	reservations_room_date = selected_room.bookings.select {\|reservation\| reservation.date_range.overlapping(date_range)}

	available_rooms << room if true == status
	available_rooms << room if status

	if room.is_available(date_range) == false
	unless room.is_available(date_range)

Space - Cathy #21

Are you sure you want to change the base?

Space - Cathy #21

Uh oh!

Conversation

cojenco commented Mar 9, 2020

Assignment Submission: Hotel

Reflection

Uh oh!

kaidamasaki commented Mar 17, 2020

Hotel

Section 1: Major Learning Goals

Section 2: Code Review and Testing Requirements

Section 3: Feature Requirements

Overall Feedback

Additional Feedback

Code Style Bonus Awards

Uh oh!

kaidamasaki left a comment

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