DinnerChoice 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68532a56489c04b4572b742b913205d0d66637bb49321ab4ff6443362f76ff0f
-  data.tar.gz: bae21f7dcb274268730a9c359b33880d8baee0c51273b10563557d28424d4a26
+  metadata.gz: b08f85a9d45ba4586c31cd74a09ee3a95872d3931aad55f7b3bab1dde49f07d7
+  data.tar.gz: a353614f5c060cd6030ea7d42711a4de92d2675e7155933016e04bc544ad5b73
 SHA512:
-  metadata.gz: d2ecab8b7b0d43ddb6b35b306b360e5010790cfb820177c34fb92dd1d2725569e84e398e7f2c14d96c1e6c6aee970353a80c1136597214224ba5664feb71ecff
-  data.tar.gz: 5ae156b71709d11679682bcde2437e2dac3aeec9ba9e11f839fe65e257e9daf7e0ec0d7a2ff0a669ce2b680250210444a8b4c2b9b033714863d70cb9d46ec827
+  metadata.gz: 5d51b1918ed4e5cd13321c2f701443d633130e91b1de8eef00a2e1ea97be4988f9777ff5bd58ec01d5df5fe36893c4f4a5fa02f99a46160161193da89ed1db02
+  data.tar.gz: bb162729a84d41a043b574b8ac57749be0b0cb3d90054ef165a8d955ed33af9249ff7fb48720159b3035885d592426f45ef8d6c5a4a570d604cd65f293722ca9

data/README.md

@@ -38,7 +38,7 @@ Users can delete any entry from the existing restaurants list. The ID of the res
 
 ### Outline of user interaction and experience
 
- * The user will find out how to interact with the terminal app by reading the contents of "<font color="#dddd00">MAIN MENU</font>". Then users can select from the main menu (input number, select from 1 to 6). By doing so, they can choose to use each feature. After executing a function, the main menu list will display again and ask the user to select again. User can leave the app by inputing '6' (or '6.', 'exit').
+ * The user will find out how to interact with the terminal app by reading the contents of "<font color="#dddd00">MAIN MENU</font>". Then users can select from the main menu (input number, select from 1 to 6). By doing so, they can choose to use each feature. After executing a function, the main menu list will display again and ask the user to select again. User can leave the app by inputing '6' (or '6.', 'exit').<br>
 
  ```
 MAIN MENU
@@ -54,9 +54,22 @@ Please select from the MAIN MENU (select numbers 1 to 6):
 See you next time!
 ```
 
-* Error handling: when input wrong selection (e.g. '7', '9' or other numbers/letters), the app will output an error message an ask the user to select from the menu again.
+* Error handling: When selecting functions from <font color="#dddd00">MAIN MENU</font>, if users input wrong selection (e.g. '7', '9' or other numbers/letters), the app will output an error message an ask the user to select from the menu again.<br>
 ```
-Sorry, I don't understand. Please select from 1 to 6.
+? ? ? ? ? ? ? ?
+Sorry I don't understand...
+Please select from 1 to 6, or input 'exit'.
+```
+* Error handling: Similarly, if users input wrong ID number to delete or update a restaurant entry, the app will output an error message and give users advice:<br>
+```
+? ? ? ? ? ? ? ?
+Sorry I don't understand...
+Please select ID from the existing restaurants list.
+```
+
+* Error handling: If users select delete or update function but the restaurants list is empty, the app will tell the user that the list is empty:<br>
+```
+List is empty, nothing to delete.
 ```
 
 ##### 1. Create new entry: 
@@ -71,13 +84,14 @@ How do you like this restaurant? please rate on a scale of 1-5, 1 being the lowe
 How much do you usually spend in this restaurant?
 > 
 ```
-* After adding a new restaurant, the app will calculate if the list count has increased by 1, if yes, then output a message telling users that the new entry has been successfully added.
+* After adding a new restaurant, the app will calculate if the list count has increased by 1, if yes, then output a message telling users that the new entry has been successfully added.<br>
 ```
 > > > > > > > > > > > > > > > > > > 
 New restaurant is successfully added!
 ```
 ##### 2. Display restaurants
-* If nothing is added to the default restaurants list, the default restaurants list will be displayed as below:
+* If nothing is added to the default restaurants list, the default restaurants list will be displayed as below:<bt>
+
 ```
 -------------------------
 ID: 1
@@ -101,18 +115,18 @@ Average Price: $17
 ```
 
 ##### 3. Delete an existing entry
-* The app will ask the user to select which restaurant to delete from the list (by selecting their ID).
+* The app will ask the user to select which restaurant to delete from the list (by selecting their ID).<br>
 ```
 Which restaurant do you want to delete from the list? Please input the ID number:
 > 
 ```
-* After deleting an existing entry, the app will calculate if the list count has decreased by 1, if yes, then output a message telling users that the entry has been successfully deleted:
+* After deleting an existing entry, the app will calculate if the list count has decreased by 1, if yes, then output a message telling users that the entry has been successfully deleted:<bt>
 ```
 > > > > > > > > > > > > > > > > > > 
 The restaurant is successfully deleted!
 ```
 ##### 4. Update info
-* The app will interact with users by asking which restaurant do they want to edit:
+* The app will interact with users by asking which restaurant do they want to edit:<br>
 ```
 Which restaurant do you want to edit? Please input the ID number:
 > 2
@@ -132,6 +146,7 @@ The restaurant is successfully edited!
 ![avatar](docs/Plan_UML_Chart.png)
 
 ### Implementation plan
+![avatar](docs/Trello_board.png)
 Please refer to my [Trello board][board].
 
 [board]: https://trello.com/b/sG3Qx1Wr/dinnerchoiceterminal-app "Trello board"
@@ -141,7 +156,7 @@ Please refer to my [Trello board][board].
 
 #### 1. Install ruby:
 
-* Install Homebrew: <br>
+* Install Homebrew (for MacOS users): <br>
 Homebrew is a package manager for Mac. It will allow us to easily install ruby. Run the following command in terminal:
 ```
 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
@@ -186,6 +201,8 @@ If you see this message (or similar message containing ```2.7.0```) in terminal,
 ```
 ruby 2.7.0p0 (2019-12-25 revision 647ee6f091) [x86_64-darwin18]
 ```
+
+REQUIRED RUBY VERSION: ```>= 2.3.0```
 #### 2. Install Gem
 
 * You can find the gem ```DinnerChoice 0.1.1``` on rubygems.org --  see link: [DinnerChoice](https://rubygems.org/gems/DinnerChoice)
@@ -223,16 +240,37 @@ irb(main):001:0> require "DinnerChoice"
 
 
 Then you should be able to use the DinnerChoice app!
-#### 4. Uninstall Gem
+#### 5. Uninstall Gem
 * The uninstall command removes the gems you have installed.
 ```
 $ gem uninstall DinnerChoice
 Successfully uninstalled DinnerChoice 0.1.1
 ```
+#### 5. For Linux and windows users
+* For Linux users, please follow [this guide](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-18-04) to install ```rbenv```. Other steps are similar to the steps mentioned above.
+
+* For windows users, you need to use a virtual machine to run [Ubuntu](https://ubuntu.com/), you can use some software called [VMware Workstation](https://www.vmware.com/products/workstation-pro.html). This will allow you to run the Ubuntu OS virtually. Once succeeded, follow the previous guide to install rbenv and Gem.
 
 ## Usage
 ### Help documentation
+Please also see the "Outline of user interaction and experience" section.
+
+In order to use it users need to select the options displayed in <font color="#dddd00">MAIN MENU</font> (select number from 1 to 6, or input "exit" to leave the app).
+
+1. Create new restaurant entry:<br> 
+In order to create a new restaurant, users need to input "1", and then add name, address, rating and average meal price. If the entry is successfully added, a message will tell the user that a new entry is successfully added.
+
+2. Display restaurants list: <br>
+If users select "2", the default restaurants list will appear on screen which allow the users to review and compare the restaurants.
+
+3. Delete an existing restaurant entry:<br>
+In order to delete an entry, users need to input the ID of the restaurant that needs to be deleted. If nothing is in the list, the app will tell the user that nothing is in the list.
+
+4. Update an existing restaurant entry:<br>
+When selected the "Update info" selection (number 4) in <font color="#dddd00">MAIN MENU</font>, the app will ask the users to input the ID of the restaurant that needs to be updated and input the specific attribute, new content of the attribute in order to update information.
 
+5. Make a choice from the existing restaurants list:<br>
+Once "Make a choice" function is selected, the app will display a randomly selected item from the current restaurants list.
 
 ## Tests
 I used manual testing to test my app. You can find a spreadsheet in Google file:
@@ -256,4 +294,7 @@ Everyone interacting in the DinnerChoice project's codebases, issue trackers, ch
 
 * Vector Illustration https://undraw.co/illustrations
 * [Restaurants near Southern Cross station](https://www.zomato.com/melbourne/fast-food?group_id=31153)
-* [An introduction of decidophobia](https://www.bustle.com/articles/157828-5-signs-you-might-have-decidophobia-or-fear-of-making-decisions)
+* [An introduction of decidophobia](https://www.bustle.com/articles/157828-5-signs-you-might-have-decidophobia-or-fear-of-making-decisions)
+* [How To Install Ruby on Rails with rbenv on Ubuntu](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-18-04)
+* [Ubuntu](https://ubuntu.com/)
+* [vmware](https://www.vmware.com/products/workstation-pro.html)

data/lib/DinnerChoice/version.rb

@@ -1,3 +1,3 @@
 module DinnerChoice
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: DinnerChoice
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Lanzhou Jiang
@@ -51,6 +51,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - DinnerChoice-0.1.1.gem
+- DinnerChoice-0.1.2.gem
 - DinnerChoice.gemspec
 - Gemfile
 - Gemfile.lock
@@ -64,6 +65,7 @@ files:
 - docs/Ascii_art_banner.png
 - docs/Dinner_choice.png
 - docs/Plan_UML_Chart.png
+- docs/Trello_board.png
 - lib/.DS_Store
 - lib/DinnerChoice.rb
 - lib/DinnerChoice/controllers/DinnerChoiceController.rb