Sara - Branches by sarashahbaig · Pull Request #36 · Ada-C12/hotel

sarashahbaig · 2019-09-09T07:16:12Z

Hotel

Congratulations! You're submitting your assignment!

Comprehension Questions

Question	Answer
What was a design challenge that you encountered on this project?	One of the design challenges that I encountered was figuring out how many classes I need to represent the objects that make up the hotel system. I was not sure what to track for the hotel system and what not to. For instance, I initially came up with multiple classes but then had to narrow it down. I ended up having a customer and room class just to be able to better track reservations.
What was a design decision you made that changed over time over the project?	As mentioned above, one of the design decisions that I changed over time was to decrease the number of classes that would make up the hotel system. Finally, I decided to use a customer and room class to keep track of the reservations.
What was a concept you gained clarity on, or a learning that you'd like to share?	This assignment helped me better understand how to test code for every step of program. Writing more tests gave me a better understanding of how to think about where my code would break and what things I need to take into consideration.
What is an example of a nominal test that you wrote for this assignment? What makes it a nominal case?	An example of a nominal test that I wrote was to make a simple hotel object given its id and name and then check if the attributes data types are the ones that I had defined in the class. Another test was to check the number of rooms that had been predefined.
What is an example of an edge case test that you wrote for this assignment? What makes it an edge case?	And example of edge case test that wrote was to check if the date range given is a valid date range. An edge case is one that tests the extremes of our program.
How do you feel you did in writing pseudocode first, then writing the tests and then the code?	I think I did a good job in following the steps of writing pseudocode first, then the tests and then the code. It made met solve the problems I faced writing this program easier to solve.

tildeee · 2019-09-15T18:38:35Z

Hotel

What We're Looking For

Test Inspection

Workflow	yes / yes but no test / no
Wave 1
List rooms	x
Reserve a room for a given date range	yes
Reserve a room (edge case)	edge cases get implemented and tested in the `reserve_room_on` method
List reservations for a given date	yes, no tests on edge cases
Calculate reservation price	yes
Invalid date range produces an error	yes, though tests only one case (end date before start date). What about end date on same day as start date?
Test coverage	yes
Wave 2
View available rooms for a given date range	implemented and with tests, but the tests and implementation are wrong
Reserving a room that is not available produces an error	yes, but this is confusing. Why is this implemented in `reserve_room_on` and not `make_reservation`? What's the difference between the two methods?
Test coverage	the tests don't cover edge cases thoroughly, aren't organized in `describe` blocks well, and they cover parts of the nominal cases
Wave 3
Create a block of rooms	no
Check if a block has rooms	no
Reserve a room from a block	no
Test coverage	no

Code Review

Baseline	Feedback
Used git regularly	I expect more detailed commit messages such as what kinds of changes you made for reservations. Usually messages are like "implements reserving rooms for valid dates" or "implements checking dates that they are valid" or "adds helper method to parse dates"
Answer comprehension questions	x
Design
Each class is responsible for a single piece of the program	Some classes are not used. Many methods are not responsible for a single piece of functionality.
Classes are loosely coupled	All of the functionality is in the `Hotel` class, such as checking for valid dates or calculating the cost
Fundamentals
Names variables, classes and modules appropriately	You have some typos in method names. Also, you have a `Duration` class and a `DateRange` class-- why do both exist? Your method names are also ambiguous. Your tests are not organized into `describe` and `it` blocks well, and aren't named accurately
Understanding of variable scope - local vs instance	largely, yes
Can create complex logical structures utilizing variables	There's a lot of duplication around dates and availability. Do you use the `Date` class or the `Duration` class? It is not consistent. How do you find availability? It is not consistent, because there isn't clarity on how to keep track of availability.
Appropriately uses methods to break down tasks into smaller simpler tasks	Yes! You did this well :)
Understands the differences between class and instance methods	yes
Appropriately uses iterators and `Enumerable` methods	yes, great job!
Appropriately writes and utilizes classes	Feel free to clean up your unused files and unused classes before submission. You wrote a lot of classes and instance methods inside of the classes that never get used, like `Duration`'s `overlap?` method
Appropriately utilizes modules as a namespace	yes
Wrap Up
There is a refactors.txt file	yes
The file provides a roadmap to future changes	There isn't a list of concrete changes you'd like to make besides more tests; during break week, I encourage you to take time and think about how to clean up your Hotel design! (We have break week homework for this)

Overall 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!

Overall, you did a great job of putting into action a lot of our coding practices; You have a lot of good work around making large classes that rely on each other. You used composition correctly! You use instance variables and instance methods correctly! You used find, find_all, and a lot of other Enumerable methods well. I have a lot of confidence that your fundamentals in programming are exactly where we want them to be.

However, I think I see some discomfort around organizing code, and seeing how it all connects. It feels like you were trying to organize too much at the same time, and there's lack of clarity around how your tests and how your methods are organized. For example, tests were sometimes in the wrong area of the file! Other times, methods that were named one thing were doing something else. Another example is that sometimes you wrote a method in Class A that did Functionality A, and then you wrote a method in Class B that did the same functionality!

I'm leaving a lot of comments with questions to ask yourself that will help you organize your code. When you have well-organized code, then you can start to target your code and your time better. :)

You didn't install SimpleCov as part of the project directions :( With SimpleCov, you would see that you have 90.24% test coverage (as opposed to the required 95% test coverage). Don't forget our SimpleCov lesson, and let me know if you have any questions because we'll be using SimpleCov in the future.

Lastly, there are a lot of files that are in your project submission that don't get used. I encourage you to delete those as soon as you realize you don't need them. The less files you have, the easier it is to keep track of your code. :)

One more overall thought: We went through in class that we would not have a main.rb file for this project, and the designs I looked over on the first day of the project did not have a Customer class, and we talked about how Customer should not be a class because there were no requirements about it.

I'd love to know how you missed this information so we can make sure you get the same design information and hints as everyone else in class.

Overall, from your hotel project, I have full confidence that you have fundamental programming skills! I also see that we should spend time to make sure that you think of code organization and relationships between different pieces of code correctly. If we don't feel a little more comfortable about our file system and tests, it may give us challenges later.

tildeee · 2019-09-15T18:40:00Z

.gitignore

-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc


Hm, why did you delete the contents of this file?

tildeee · 2019-09-15T18:40:21Z

lib/duration.rb

+    attr_reader :start_date, :end_date
+
+    def initialize(start_date:, end_date:)
+      @start_date = convert_to_date(start_date)


Could we use Date.parse(start_date) instead of using the convert_to_date method?

tildeee · 2019-09-15T18:40:26Z

lib/duration.rb

+      end
+    end
+
+    def convert_to_date(date_str)


This method doesn't get tested!

tildeee · 2019-09-15T18:40:33Z

lib/duration.rb

+      return night_count
+    end
+
+    def overlap?(duration)


This method never gets tested OR used in any other file. Can we delete it, or can we refactor our code to use it?

tildeee · 2019-09-15T18:40:42Z

lib/experiment.rb

+# require_relative 'reservation'
+
+# one_reservation = Reservation.new(id:1, customer_id:2, room:303, duration:3, total_cost:300)
+# date_range = DateRange.new(id:, start_day:, end_day:)


Feel free to delete this file before project submission

tildeee · 2019-09-15T18:40:52Z

lib/hotel.rb

+    end
+
+    #list of rooms that are not reserverd
+    def get_availbale_rooms(date)


"available" is mispelled in your method name-- watch out!

tildeee · 2019-09-15T18:41:13Z

lib/hotel.rb

+    def get_availbale_rooms(date)
+      available_rooms = @rooms.find_all { |room| room.availability == true }
+      # rooms_date_range = available_rooms.find_all { |room| (date >= room.reservation.duration.start_date && date <= room.reservation.duration.end_date) }
+      return available_rooms


This method doesn't use the date parameter. Why not? What does it mean for a room to have availability? Isn't the requirement to find rooms that are available for a specific date? What does it mean when a room is "available"?

tildeee · 2019-09-15T18:41:27Z

lib/hotel.rb

+      return total_cost
+    end
+
+    def reserve_room_on(cust_id, room_number, start_date, end_date)


What is the difference between reserve_room_on and make_reservation? How can we change the name of these methods so that they are more clear about what they do and what the differences are?

tildeee · 2019-09-15T18:41:33Z

lib/hotel.rb

+    def reserve_room_on(cust_id, room_number, start_date, end_date)
+      room = @rooms.find { |room| room.number == room_number }
+      if room.availability == false || room.reservation != nil
+        raise ArgumentError.new "This room is already reserved"


Minor suggestion: Instead of an ArgumentError, could we raise a more specific kind of error, or create a new custom Error class?

tildeee · 2019-09-15T18:41:43Z

lib/main.rb

+  end
+end
+
+HotelBooking.main


Feel free to delete this file before project submission

tildeee · 2019-09-15T18:41:52Z

lib/room.rb

+      @id = id
+      @number = number
+      @cost = cost,
+              @availability = availability,


Why are there commas here and the line above? Also, watch your indentation!

tildeee · 2019-09-15T18:41:59Z

lib/room.rb

+      @reservation = reservation
+    end
+
+    def total_cost()


This method isn't implemented or used anywhere else, so feel free to delete this method

tildeee · 2019-09-15T18:42:22Z

lib/customer.rb

+      @name = name
+    end
+  end
+end


No tests! Maybe this is a result of realizing that our project doesn't require Customers being implemented, so it was hard to understand what to test a Customer to do :)

tildeee · 2019-09-15T18:42:38Z

test/duration_test.rb

+      }.must_raise ArgumentError
+    end
+  end
+  describe "" do


Don't forget to add a description to your describe blocks. If you can't find a good name, then maybe you need to think about how you're organizing your code

tildeee · 2019-09-15T18:43:02Z

test/hotel_test.rb

+      end
+    end
+
+    describe "add_customer" do


Hm, did we have a requirement to make sure that we could add a customer?

tildeee · 2019-09-15T18:43:08Z

test/hotel_test.rb

+    end
+
+    describe "add_customer" do
+      it "checks the number of customers before and after" do


Good test though!

tildeee · 2019-09-15T18:43:19Z

test/hotel_test.rb

+    before do
+      @reservation_list = @hotel.reservations
+    end
+    it "reservation should be a list" do


Maybe a more accurate sentence is "reservation_list starts as an empty array"

tildeee · 2019-09-15T18:43:36Z

test/hotel_test.rb

+      end
+    end
+
+    it "get the total cost for a given reservation" do


This test isn't in a describe block that is accurate-- it's in the describe block named "test list of reservations". Could we make a different describe block with a name that is more accurate, and put this test inside there? Or could we rename the current describe block so it's more accurate?

tildeee · 2019-09-15T18:43:59Z

test/hotel_test.rb

+        cust_id = @customer.id
+        @hotel.make_reservation(cust_id, "2019-09-01", "2019-09-05")
+        available_rooms = @hotel.get_availbale_rooms(date)
+        expect(available_rooms.length).must_equal 19


What happens if you make a reservation for "2999-01-01" to "2999-01-05"? Your available_rooms.length for available rooms on date (2019-09-02) is 18, not 19. Your implementation doesn't use date, and your tests don't check for this case!

tildeee · 2019-09-15T18:44:09Z

test/hotel_test.rb

+      end
+      it "reserve an already reserve room" do
+        cust_id = @customer.id
+        @hotel.make_reservation(cust_id, "2019-09-01", "2019-09-05")


Why do we use make_reservation and reserve_room_on? Is there a way that our code could be refactored so only one of these methods exists?

tildeee · 2019-09-15T18:44:28Z

test/reservation_test.rb

+                                          duration: @duration)
+  end
+
+  describe "cost" do


You can put multiple it blocks in one describe block. Right now, you have two describe blocks that are both named "cost"... instead, consider moving the it blocks under the same describe block.

tildeee · 2019-09-15T18:44:52Z

lib/room.rb

+    def total_cost()
+    end
+  end
+end


You have no tests for Room :(

sarashahbaig added 16 commits September 3, 2019 18:51

intial setup

aeb0cd4

basic hotel

869c586

basic room

fdb9e0b

basic date-range

5e94fcd

basic setup code

ee9410f

Merge branch 'master' of https://github.com/Ada-C12/hotel

3fe4ffc

added spec

26b8480

added hotel tests

27258d5

code for duration/range

8397e45

code for hotel

155f10a

code for resrvaion

3da5913

test_helper updated

5f1c8c5

fix room to choose

b65c14f

wave2 done

fcbc2c5

Merge branch 'my-code'

adc7ec1

refactors.txt added

38c1908