zunairkhan811 / ruby-catalog-project

In this project, a console app is created that will help you to keep a record of different types of things you own: books, music albums, movies, and games. The data is stored in JSON files and a database with tables structure analogical is also created.

**Ruby-Catalog-Project**

# 📗 Table of Contents

• 📗 Table of Contents
• 📖 [Ruby-Catalog-Project]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • Walk-Through Video
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Test
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 [Ruby-Catalog-Project]

In this project, a console app is created that will help you to keep a record of different types of things you own: books, music albums, movies, and games. The data is stored in JSON files and a database with tables structure analogical is also created.

🛠 Built With

Tech Stack

Database

• Ruby

Key Features

• [List all books]
• [List all music albums]
• [List of games]
• [List all genres (e.g 'Comedy', 'Thriller')]
• [List all labels (e.g. 'Gift', 'New')]
• [List all authors (e.g. 'Stephen King')]
• [Add a book]
• [Add a music album]
• [Add a game]
• [All data preserved by saving collections in .json files.]

(back to top)

Walk-Through Video

Video

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby Installed on System.
• Terminal

Setup

Clone this repository to your desired folder:

https://github.com/zunairkhan811/Ruby-Catalog-Project.git

cd my-folder

  cd Ruby-Catalog-Project

Install

Install the project using the following

bundle install

Usage

To run the project, execute the following command:

ruby main.rb

Test

To run tests, execute the following command:

  rspec

👥 Authors

• GitHub: @zunairkhan811
• Twitter: @zunairkhan811
• LinkedIn: mzunairkhan

👤 Lawrence Amoafo

• GitHub: @Kwaku28
• Twitter: @kwakuamoafo
• LinkedIn: Lawrence Amoafo

👤 Ntwali Roland

• GitHub: @Roland-Ntwali
• Twitter: @_Ntwali
• LinkedIn: @Roland-Ntwali

🔭 Future Features

• [implement the frontend ]

(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

• Thanks to the Microverse team for the great curriculum.
• Thanks to the Code Reviewer(s) for the insightful feedback.

(back to top)

❓ FAQ

• [Can I Fork it and Improve on it]

  • [Yes, You can, feel free]

(back to top)

📝 License

This project is MIT licensed.

(back to top)

ruby-catalog-project's Issues

[3pt] Preserve Data

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

[3pt] Add game and author constructor

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

[3pt] Preserve Data

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

[3pt] Preserve Data

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

[3pt] Implement Methods

• Implement methods:
  • 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)
  • 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

[2pt] Make options available

• The following options should be available:
  - List all music albums
  - List all genres (e.g 'Comedy', 'Thriller')
  - Add a music album

[2pt] Make options available

• The following options should be available:
  - List of games
  - List all authors (e.g. 'Stephen King')
  - Add a game

[3pt] Add unit tests

• Add unit tests for all implemented methods.

[1pt] Create Music and genre class

• Create MusicAlbum class in a separate .rb file.
• Create Genre class with an association to the Item class (in a separate .rb file).

[1pt] Create game and author class

• Create a Game class in a separate .rb file.
• Create an Author class with an association to the Item class (in a separate .rb file).

[3pt] Implement Methods

• Implement methods:
  • 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)
  • 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

[3pt] Add and implement methods

• Add all methods visible in the diagram.
• 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

[3pt] Create Schema

• 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

[3pt] Create main.rb and implement startup

• Create a main.rb file that will serve as your console app entry-point.
• 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.

[3pt] Create Schema

• 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

[3pt] Implement Methods

• Implement methods:
  • 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)
  • 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

[2pt] Make options available

• The following options should be available:
  • List all books
  • List all labels (e.g. 'Gift', 'New')
  • Add a book

[3pt] Add Music and genre constructor

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

[3pt] Add book and label constructor

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

Make kanban board Template

• We are three team members in this Ruby-Catalog-Project
  - Team Member#1: Muhammad Zunair khan (@zunairkhan811)
  - Team Member#2: Lawrence Amoafo (@Kwaku28)
  - Team Member#3: Roland Ntwali (@Roland-Ntwali)
• Project Link

[1pt] Add item class properties

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.

[1pt] Create book and label class

• Create a Book class in a separate .rb file.
• Create a Label class with an association to the Item class (in a separate .rb file).

[3pt] Create Schema

• 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 a item class

Create Item class in a separate .rb file.

[3pt] Add unit tests

• Add unit tests for all implemented methods.

[3pt] Add unit tests

• Add unit tests for all implemented methods.