ansaribrahim / catalogmythings

CatalogMyThings: A Ruby-based catalog app to manage and organize your books, music, and games with labels and genres.

CatalogMyThings

📗 Table of Contents

• 📗 Table of Contents
• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📚 CatalogMyThings 🎵🎮

CatalogMyThings is a Ruby-based cataloging application that helps you organize your collection of books, music albums, and games. 📖🎶🎮 It allows you to create, manage, and categorize items using labels and genres. 🏷️📚🎶 With an intuitive command-line interface, you can easily add, list, and archive items in your collection. 📁✨

🛠 Built With

Tech Stack

Ruby

• Ruby

IDE

• Visual Studio Code

Key Features

• Add and manage books, music albums, and games.
• Assign labels and genres to categorize your items.
• Archive items based on publish date or condition.
• User-friendly command-line interface for easy navigation.
• Data persistence using JSON files.
• Simple and efficient organization of your personal catalog.
• Gemfile
• Rubocop
• Gemfile.lock
• Unit Testing
• license

(back to top)

🚀 Live Demo

• Video Walkthrough

(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:

install ruby

Setup

Clone this repository to your desired folder:

cd my-folder git clone [email protected]:AnsarIbrahim/My_Things-Ruby-Capstone.git

Install

Install this project with:

  cd my-project
  gem install

Usage

To run the project, execute the following command:

• Clone the repository.
• Run ruby main.rb to start the application.
• Use the menu to add, list, and archive items.
• Enjoy effortless cataloging and organization!

Run tests

To run tests, run the following command:

  RSpec

Deployment

You can deploy this project using in Local Machine:

  ruby main.rb

(back to top)

👥 Authors

👤 Ansar Ibrahim

• GitHub
• LinkedIn
• Twitter

👤 Md. Porag Sarkar

• GitHub: @porag-m06
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Create Movie
• Create Source
• List all movies
• List all sources (e.g. 'From a friend', 'Online shop')
• Add a movie
• Deployment

(back to top)

🤝 Contributing

• Contributions, issues, and feature requests are welcome!
• Feel free to open issues or pull requests for bug fixes or enhancements.
• Follow the code of conduct and contribution guidelines.

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give it a ⭐️

(back to top)

🙏 Acknowledgments

• Microverse and my coding partner Md. Porag Sarkar 💖💖

(back to top)

📝 License

This project is MIT licensed.

(back to top)

catalogmythings's Issues

[1pt] All Game class properties

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

[2pt] The following options should be available

The following options should be available:

• List of games
• Add a game

[4pt] 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

Create a schema.sql

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] All Author class properties

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

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

[1pt] All data should be preserved

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

[1pt] Add unit tests

Add unit tests for all implemented methods.

[1pt] All data should be preserved

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

All data should be preserved

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

[1pt] Create MusicAlbum

Create MusicAlbum class in a separate .rb file.

[3pt] All Item class

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 a Game class

Create a Game class in a separate .rb file.

[3pt] The following options should be available

The following options should be available:

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

GROUP RUBY CAPSTONE PROJECT

This PR Contains:

This is the link to our Project: Project Link

We are two members in this group 2️⃣

• Md. Porag Sarkar is team member 1 and was assigned a task list for team member 1
• Ansar Ibrahim is team member 2 and was assigned a task list for team member 2

[1pt] The following options should be available

The following options should be available:

• List all authors (e.g. 'Stephen King')

[1pt] Create a Book class

Create a Book class in a separate .rb file.

[1pt] All MusicAlbum

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

[3pt] Implement startup

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] All Book class

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

[3pt] The following options

The following options should be available:

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

[3pt] Implement methods

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

[1pt] Create an Author class

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

[3pt] Implement methods

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] Create a schema.sql file

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

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)

[1pt] All Genre class

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

[3pt] Create Item class

Create Item class in a separate .rb file.

[4pt] 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

[3pt] Create a main.rb

Create a main.rb file that will serve as your console app entry-point.

[1pt] All Label class

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

[3pt] The diagram

Add all methods visible in the diagram.

[1pt] Create a Label class

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

[2pt] Create a schema.sql

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

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

• authors table

[1pt] Add unit tests

Add unit tests for all implemented methods.

[1pt] Create Genre class

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