charliegucci / T1A2

Ruby Terminal Application for Bird Database

SOFTWARE DEVELOPMENT PLAN

Written by: Wilson Esmundo

Introduction

---

This Section describes a summary of essential information listed below:

• Statement of Purpose and Scope
• Features
• User Interaction and Experience
• Control Flow Diagram
• Implementation Plan
• Development Log
• Application Implementation
• Test Application Results
• Developers Operation

Statement Purpose

---

The purpose of this Terminal Application is to help Bird enthusiast specifically collectors and breeders of Agapornis Roseicollis also known as Rosyfaced or Lovebirds managed, organised and tracked bird in hand. It also provides access to Genetic Mutation calculator to enable the breeder the possible genetic outcome for any combination of breeding pair.

Identifying birds are easy when there are only three to five pairs to begin with, however, when they start to hatch in which they are between one to seven, it starts to get complicated. Most likely, they will produce birds that are identical and will be hard to distinguish. After about three months, they may have a new batch of hatchlings and when you put them all together in one flight cage, you will no longer be able to keep track of their ages and remember which pair they came from.

This app is developed to help breeders have differentiation of birds in keeping and make this a valuable resource to the user by recording any vital information by using the journal option. Some breeders also look for specific colour so an access to genetic mutation calculator comes in handy. Having a database as such would allow the user to make sure that the bird is mature enough to breed.

Features

---

• The Terminal Application functions as a database with specific characteristics to describe individual bird entry for record management. All data entered will be stored in a separate text file for future retrieval of information. Database of birds can be shown in a list sorted by the the moment they were encoded in the application. Each bird database can also be deleted in the application which subsequently updates the said text file. The said function is the first option in the main menu so users can easily add Bird information instantly with typing only the Bird Identification number as the initial input and the rest of it will be shown as menu choices.
  

• Another vital function of the Terminal application is the ability to link the user to the website which is necessary to Bird breeders. New breeders issues were always the colour of the birds they want to produce. Some will questioned how come the same colours of birds always shows up whenever they breed. Whenever the user chooses the Bird Colour Calculator, it will load a website which has a very simple interface for users to interact. They just need to enter information about the possible birds they want to breed and the website will list all the possible combination of colours and mutation incase they breed that said pair.
  

• Final feature of the Terminal application is the Bird Journal. All bird breeders encounters problem especially if their stocks were already large and often times overlook things because of the volume of birds they have. Problem such as running out of food, medication or supplements of birds, also situations like negligence because breeders failed to check something on their aviary. With the Bird Journal, they can add as many notes they want by going to the Bird Journal option and choose add Journal. They will also be provided an option to list every journals they've added and like the first feature, all data will be saved in a specific text file for future retrieval. Lastly, they have option to delete specific notes which will be updated in the text file.
  

User Interaction and Experience

---

The users of the Terminal Application were able to meet the following criteria:

• Ease of Menu
  The Terminal application has a Menu choices so users will be able to visualize the functionality of the program by selection options.
  

• Ease of Navigation
  Most users of the application were not familiar with the Terminal through their computer but since the app has built in Menu system, users will be able to use just arrow and enter key to navigate through the application which lessen typographical errors.
  

• User Friendly
  The application wont complicate things for the users, since it has a clean menu and uses arrow keys for navigation, its simplicity and function will be suitable for non techy users.
  

• Less Errors
  With is designed, end user will commit less mistakes thus preventing the application to run its function in addition to its error handling process set in place for those unseen bugs in the program.

• Control Flow Diagram

---

Please find attached pdf file of the Control Flow Diagram.

• Implementation Plan

---

We were given 12 days to finish the Terminal Application thus implementation of plan is essential in providing successful outcome.
The priority for the project is the partial Documentation and the Bird Database feature and was given 2-3 days to complete. I choose to prioritize this feature because I believe this will be the blueprint of my application and other features can be with the same format. On the other hand documentation is important and as I go along with the project, bits and piece of information will be added to the documentation. As illustrated below in the Trello board, we provided checklist for both Documentation and Adding Database features.







The next task were Adding Journal and still continuing the Documentation and were given 2 days deadline. Since we already did the Add Database feature on the previous task, we will have a guidelines on how to do the Adding Journal feature and pretty much it will be the same concept as the previous feature. Trello board shown below.





The next task was still Documentation and added Deleting function of Database and Journal and were given 2-3 days to complete. Like I said in the previous paragraph, Documentation will still be ongoing and this time it will be together with the Delete Database feature as shown in the Trello board below together will its individual checklist.






Finally the Bird Colour Calculator and Documentation were finished last. Since this feature is the easiest to do we put it on the last priority and also by this time we should be finishing the rest of the documentation as shown on the Trello board below.

Development Log

---

Please see attached file
Click here

Application Implementation

---

Please see attached file
Click here

Test Application Results

---

• Test 1
  

Saving the User Input written in a yaml file called @collection.yml

Check first if the file was empty afterwards run the program and user input all the data, checked the yaml file and all the data type where not saved. Code was shown below.

Test : Fail

code:

File.open("@collection.yml", "a") { |file| file.write(@collection.to_yaml) }

Run another test using different parameter this time instead of using append, we used write this time and do the same process as above and all the datas were saved this time. Code shown below.

Test : Pass

code:

File.open("@collection.yml", "w") { |file| file.write(@collection.to_yaml) }

• Test 2
  Deleting user input saved in a yaml file called @collection.yml
  

Check first if theres data saved in the file, once done user execute the delete command and check the file if its deleted. All data still in placed. Code shown below.

Test : Fail

code:

user_input = gets.chomp
if user_input == "y" 
    File.open("@collection.yml", "a") { |file| file.write(@collection.to_yaml) }
else
    delete_stocks
end

Run another test using different parameter this time instead of using append, we used write this time and do the same process as above and all the datas were saved this time. Code shown below.

Test: Pass

code:

user_input = gets.chomp
if user_input == "y" 
    File.open("@collection.yml", "w") { |file| file.write(@collection.to_yaml) }
else
    delete_stocks
end

Developers Operation

---

For the GitHub repository
Please click here