ankitt26 / catalog-of-my-things

In this Project we will create a console app that will help you to keep a record of different types of things you own: books, music albums, movies, and games.

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Catalog of my things]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 📽️ Presentation
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [Catalog of my things]

[Catalog of my things] is a console app where user can add and retrieve items in catalog: books, music albums, movies, and games. The data will be stored in JSON files where they can be retrieved.

🛠 Built With

Tech Stack

Ruby

• Ruby Programming Language

Key Features

• [Item Management]
• [Data Persistence]
• [User-Friendly Interface]

(back to top)

📽️ Presentation

📷 see video

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• ruby
• Text editor like VSCode

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone [email protected]:ankitt26/Catalog-of-my-things.git

Install

Install this project with:

  cd my-project
  bundle install

Usage

To run the project, execute the following command:

Example command:

  ruby main.rb

Run tests

To run tests, run the following command:

Example command:

  rspec spec

(back to top)

👥 Authors

👤 Falako Omotoyosi

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Charles Andrews

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Ankit Kushwaha

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Use database to store data]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• I would like to thank @forLoop94 , @toyman640 for collaborating on this Project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

catalog-of-my-things's Issues

[1pt] Implement add_item method in the Genre class - student B

• 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)

[1pt] Create a main.rb file - 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.

[1pt] Implement methods: add_item method - Student A

• 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)

[2pt] Add unit tests for all Book and Label class methods. - Student A

• Add unit tests for Book and Label methods.

[1pt] Implement methods: move_to_archive() - group task

• 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

[2pt] Add unit tests for game and author classes - student C

Add unit tests for all implemented methods.

[4pt] Add the following options in the main.rb - student B

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

[1pt] Implement can_be_archived?() in the MusicAlbum class - student B

• 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 ] Implement method can_be_archived? - group task

• In the Item class
  • should return true if published_date is older than 10 years
  • otherwise, it should return false

[1pt] Create a Label class with an association to the Item class - student A

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

- Each class from the UML class diagram should be created in a separate .rb file.

[1pt] Create MusicAlbum class in a separate .rb file - student B

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

[4pt] Add the following options to the main.rb file - student C

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

[2pt] Create a schema.sql file. - student A

• 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

[1pt] Create an Author class with an association to the Item class (in a separate .rb file) - student C

All Author 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 - student C

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

[1pt] Implement add_item method in the Author class - student C

• 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)

Set up a Kanban board

"We are a team of 3 people working on this project."

• The group task is assigned to - @ankitt26, @forLoop94 , @toyman640
• Student A - @ankitt26
• student B - @forLoop94
• Student C - @toyman640

Link of the project -: https://github.com/ankitt26/Catalog-of-my-things/projects/1

[1pt] Implement method : can_be_archived?() - student A

• 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

[1pt] Implement can_be_archived?() in the Game class - student C

• 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

[1pt] Create a Book class in a separate .rb file. - student A

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

- Each class from the UML class diagram should be created in a separate .rb file.

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

• 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. 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.

[2pt] Add unit tests for all implemented methods (Misic album and genre classes) - student B

[3pt] Update schema.sql file - student C

to include:

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

All game and author's data should be preserved by saving collections in .json files - student C

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

[1pt] Create Genre class with an association to the Item class (in a separate .rb file) - student B

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

[4pt]Add the following options in the main.rb file - student A

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

[3pt] preserve data in .json files. - Student A

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

[3pt] preserve data in .json files. - Student B

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

[3pt] Update the schema.sql file - student B

• include tables for music album and genre tables
• music_albums table (add all properties and associations from the parent Item class as table columns)
• genres table