chimwemwe007/ruby_capstone

Ruby Capstone Catalog.

This project is a Microverse ruby capstone and is a command line application built with Ruby. In this application the user can keep track of their books, games, and music albums.

The user also has the functionality to store all the labels, authors, and genres of the sections of the different items mentioned prior. The data will be stored in the JSON files and can be accessed everytime when the user opens the application.

Presentation

• Presentation Video

Built With:

• Ruby
• rspec

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Make sure you already installed Ruby version 3 or higher and Git.

Setup

1. Clone the repository using the below commands. git clone https://github.com/chimwemwe007/Ruby_Capstone

2. cd Ruby-Catalog

3. ruby main.rb

Usage Kindly modify the files as needed.

Authors

👤 Bengi Genc

• GitHub: @bengigo
• Twitter: @bengi_gb
• LinkedIn: bengi-genc

👤 Kidist Guta

• GitHub: @ney2
• Twitter: @GutaKidist
• LinkedIn: Kidish-guta

👤 Chimwemwe Mkandawire

• GitHub: @chimwemwe007
• Twitter: @chxmz
• LinkedIn: chimwemwe-mkandawire

🤝 Contributing

Contributions, Issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.

ruby_capstone's Issues

[3pts] Author class properties visible in the diagram should be defined and set up in the constructor method.

All Genre class properties visible in the diagram should be defined and set up in the constructor method.

[0.5pts] should add the input item to the collection of items.

[3pts] Create a schema.sql file for the games

Create a schema.sql file with tables that will be analogical to the structure of the classes that you created:

• Games table (add all properties and associations from the parent Item class as table columns).
• Authors table.

[1.5pts] implement add_item method in the Genre class.

• Should take an instance of the Item class as an input
• Should add the input item to the collection of items
• Should add self as a property of the item object (by using the correct setter from the item object)

[1.5pts] Implement move_to_archived method.

• Should reuse can_be_archived?() method
• Should change the archived property to true if the result of the can_be_archived?() method is true
• Should do nothing if the result of the can_be_archived?() method is false

[0.5pts] Create Item class in a separate .rb file.

All Item class properties visible in the diagram should be defined and set up in the constructor method.

[1pt] All Item class properties visible in the diagram should be defined and set up in the constructor method.

[2pts] Preserve Music album data in .json files.

All data should be preserved by saving collections in .json files.

[0.5pt] Create Book class in separate .rb file

All Book class properties visible in the diagram should be defined and set up in the constructor method.

[3pts] MusicAlbum class properties visible in the diagram should be defined and set up in the constructor method.

[1pt] Create a Game class in a separate .rb file.

All Game class properties visible in the diagram should be defined and set up in the constructor method.

[1.5pts] Implement add_item method in author class.

• Should take an instance of the Item class as an input.
• Should add the input item to the collection of items.
• Should add self as a property of the item object (by using the correct setter from the item object).

[1.5 pts] Implement can_be_archived method in the game class.

• Should override the method from the parent class
• Should return true if parent's method returns true AND if last_played_at is older than 2 years
• Otherwise, it should return false

[2pts] Add the following options to the books class

• List all books
• List all labels (e.g. 'Gift', 'New')
• Add a book

[3pts] Create an Author class.

• Author class crated with an association to the Item class (in a separate .rb file).
• All Author class properties visible in the diagram should be defined and set up in the constructor method.

[0.5pts] Add_item method should add self as a property of the item object (by using the correct setter from the item object)

[3pts] Add opetions to add music album.

[0.5pts] add_item method should take an instance of the Item class as an input.

[3pts] Add unit tests for music album class.

[1.5pts] Implement an_be_archived?() in the MusicAlbum class

• Should override the method from the parent class
• Should return true if parent's method returns true AND if on_spotify equals true
• Otherwise, it should return false

[1pt] Create Music Album class in a separate .rb file.

All MusicAlbum class properties visible in the diagram should be defined and set up in the constructor method.

[2pts] All Book class properties visible in the diagram should be defined and set up in the constructor method.

[0.5pt] Create a main.rb file in a separate file

Define the entry point for the main.rb
Implement startup actions:

• Present the user with a list of options to perform.
• Let users choose an option.
• If needed, ask for parameters for the option.
• Have a way to quit the app.

[3pts] Add unit tests for book class.

Add unit tests for all implemented method in the book class.

[2pts] Preserve game datai in .json files.

All data should be preserved by saving collections in .json files.

[2pts] Preserve book data in .json files.

All data should be preserved by saving collections in .json files.

[2pts] Add the following options to the musicAlbum class.

• List all music albums
• List all genres (e.g 'Comedy', 'Thriller')
• Add a music album

[5pts] Implement startup actions.

• Present the user with a list of options to perform.
• Let users choose an option.
• If needed, ask for parameters for the option.
• Have a way to quit the app.

Ruby group capstone: set up your Kanban board

https://github.com/chimwemwe007/Catalog_of_my_things-Ruby_Capstone/projects/1

• This is the link of our kanban board project for the ruby capsone.
• There are 3 members in our team :

#1. @Ney2 working with the book class.
#2 @chimwemwe007 / @chimz007 working on the music album class.
#3 @bengigo working on the game class.

[1pt] Create Genre class.

• Genre class created with an association to the Item class (in a separate .rb file).
• All Genre class properties visible in the diagram should be defined and set up in the constructor method.

[1pts] Create a Label class with an association to the Item class .

The label class properties are visible in the diagram should have an association with the item class and should be defined and set up in the constructor method.

[2pts] Add the following options to the game class

• List of games
• List all authors
• Add a game

[3pts] All Game class properties defined and set up in the constructor method.

[3pts] Add unit tests game class.

Add unit tests for all implemented methods.

[3pts] Create a schema.sql file for the music album

Create a schema.sql file with tables that will be analogical to the structure of the classes that you created:

• music_albums table (add all properties and associations from the parent Item class as table columns)
• genres table

[1.5pts] Implement can_be_archived? Method in the Book class

• Should override the method from the parent class
• Should return true if parent's method returns true OR if cover_state equals to "bad"
• Otherwise, it should return false

[1pts] Add all methods visible in the diagram.

[3pts] Create a schema.sql file for the book

Create a schema.sql file with tables that will be analogical to the structure of the classes that you created:

• Books table (add all properties and associations from the parent Item class as table columns)
• Labels table

[3pts] Add opetions to list albums.

[2pts] All Label class properties visible in the diagram should be defined and set up in the constructor method.

[1.5pts] Implement add_item method in the Label class

[0.5pts] Can be archived method should override the method from the parent class.

[1.5pts] Implement can_be_archived? method in the Item class

should return true if published_date is older than 10 years, otherwise, it should return false.