badger-99/ruby_catalogue

An app to organize books, music albums, and games.

RUBY CATALOGUE

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 📽 Video Presentation
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Ruby Catalogue

Ruby Catalogue is a ruby-based application for storing information about books, music albums and games.

🛠 Built With

Tech Stack

Language

• Ruby

Key Features

• User-input error validation
• Data persistance across user sessions

(back to top)

📽 Video Presentation

• Video Presentation

(back to top)

💻 Getting Started

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

• Clone this project.
• Open it in VS code.
• Run bundle install to install the dependencies

Prerequisites

In order to run this project you need:

• Ruby 3.2 or later with devkit.
• Ruby linters - Mainly for consistent styling.
• VS code, or a code editor of your choice.

Setup

Clone this repository to your desired folder:

  git clone https://github.com/badger-99/ruby_group_capstone.git

Usage

Run ruby main.rb in the termnial to start the UI and proceede to view or record your books, music albums, or games.

Run tests

Use rspec in the terminal to run the tests.

Deployment

This project does not need to be deployed.

(back to top)

👥 Authors

👤 Alfred M.

• GitHub: @badger-99
• X: @AlfredMkg
• LinkedIn: in/alfredmkg

👤 malikhaiderkhan

• GitHub: @malikhaiderkhan
• X: @malikhaiderkha
• LinkedIn: @malikhaiderkhan

👤 Devendra-alt

• GitHub: @devendra-alt
• X: @Devendra5101
• LinkedIn: Devendra Mulewa

(back to top)

🔭 Future Features

• Storing Data in Database
• Removing Entries from the catalogue

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give it a star ⭐️.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing the resources and guidelines that made this project possible.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

ruby_catalogue's Issues

Team1 [0.5pt] Create a Label class with an association to the Item class (in a separate .rb file)

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

Team3 [0.5pt] 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.

Team3 [0.5pt] Implement `can_be_archived?()` 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

Team3 [0.5pt] Create an Author class 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.

Team1 [1pt] All data should be preserved by saving collections in .json files

Team2 [1pt] Add unit tests for all implmented methods

Team3 [1.5pt] 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

[1pt] Create a main.rb file that will serve as your console app entry-point. (group task)

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. Description to be added

Team2 [0.5pt] 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)

Team2 [1.5pt] The following options should be available in the UI

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

Team3 [1.5pt] The following options should be available in the UI

• List of games
• List all authors (e.g. 'Stephen King')
• Add a game

Team3 [0.5pt] Implement `add_item` method in the 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)

Team2 [0.5pt] Create MusicAlbum class in a separate .rb file

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

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

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

Team2 [1pt] All data should be preserved by saving collections in .json files

Team1 [1pt] Add unit tests for all implemented methods

Team2 [0.5pt] Create Genre class 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.

Team 3 [0.5pt] Create an Author class 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.

[1pt] Add all methods visible in the diagram (group task)

• Implement methods:
  • can_be_archived?() in the Item class
    • Should return true if published_date is older than 10 years
    • Otherwise, it should return false
  • move_to_archive() in the Item class
    • 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

KANBAN Board Setup

There are three members in our team for the Ruby Group Capstone Project

• Team member 1 -> @malikhaiderkhan
• Team member 2 -> @badger-99
• Team member 3 -> @devendra-alt

Our KANBAN board 👨‍💻 ⏭️

Team1 [0.5pt] Implement `can_be_archived?()` 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

Team1 [0.5pt] Implement `add_item` method in the Label 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)

Team3 [1pt] All data should be preserved by saving collections in .json files

Team1 [1.5pt] 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

Team2 [0.5pt] Implement `can_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

Team3 [1pt] Add unit tests for all implemented methods

Team2 [1.5pt] 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

Team1 [1.5pt] The following options sould be available in the UI

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

[1pt] Create Item class in a separate .rb file (group task)

All Item class properties visible in the diagram should be defined and set up in the constructor method. Exception: properties for the 1-to-many relationships should NOT be set in the constructor method. Instead, they should have a custom setter method created.