rivasbolinga / my-things

Console app that helps to keep a record of different type of things we can own like books, music albums movies and games

Ruby Group Capstone: Catalog of My Things

📗 Table of Contents

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

📖 Catalog of My Things

Catalog of My Things is a console app that will help a user to keep a record of different types of things he owns: books, music albums, and games. Everything will be based on the UML class diagram presented above. The data will be stored in JSON files but we will also prepare a database with tables structure analogical to our program's class structure.

🛠 Built With

Tech Stack

Client

• Ruby
• Rspec

Database

• PostgreSQL

Key Features

• 1 - User interface where the user can choose between a variety of options

  

• 2 - All the data is preserved in json files

• 3 - Create as part of a collaborative project

• 4 - All data is stored in a database

(back to top)

🎥 Video Demonstration

You can see the Video demonstration 📍 here.

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

 gem install bundler

Setup

Clone this repository to your desired folder:

  cd my-folder
  git https://github.com/rivasbolinga/my-things.git

Install

Install this project with:

  cd my-things
  bundle install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run tests, run the following command:

  rspec spec

(back to top)

👥 Authors

👤 Andrea Rivas

• GitHub: @rivasbolinga
• Twitter: @AndreaRivasPal
• LinkedIn: andrearivaspalacios

👤 Christian Romuald Momo Tonfack

• GitHub: @momo-87
• Twitter: @Momo-yde
• LinkedIn: christian-momo

👤 Mohamad Almeari

• GitHub: @mohametalmeari
• Twitter: @MohametAlmeari
• LinkedIn: mohamet-almeari

(back to top)

🔭 Future Features

• Add Movie class
• Remove and update options
• Create more relationships between the classes

(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 the Microverse community for their supports.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

my-things's Issues

[4pt] Implement methods for Game and Author classes.

• 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

[4pt] Implement methods for Label and Book classes.

• 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

[3pts] Create 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

[2pt] Create Game and Author classes.

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

[2pts] Create MusicAlbum and Genre classes

• Create MusicAlbum class in a separate .rb file.
• Create Genre class with an association to the Item class (in a separate .rb file).
• 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.

[3pts] Unit tests for Book and Label methods.

Add unit tests for all implemented methods:

• add_item method in the Label class
• can_be_archived?() in the Book class

[3pts] Create schema.sql file.

• 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

[3pts] Unit tests for Game and Author methods.

Add unit tests for the implemented methods:

• add_item method in the Author class
• can_be_archived?() in the Game class

[3pts] Add unit test for MusicAlbum and Genre Methods

Add unit tests for:

• add_item method in the Genre class
• can_be_archived?() in the MusicAlbum class

[3pts] Creating data model

Build the project schema by creating and running the necessary migration files following the ERD diagram.

[5pts] Preserve All Data

• The following options should be available:
  • List all music albums
  • List all genres (e.g 'Comedy', 'Thriller')
  • Add a music album
• All data should be preserved by saving collections in .json files.

[5pts] Preserve all data.

• The following options should be available:
  • List of games
  • List all authors (e.g. 'Stephen King')
  • Add a game
• All data should be preserved by saving collections in .json files.

[2pt] Create Book and Label classes.

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

[3pts] Create Schema.sql file

• 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

[2pt] Implement Methods (Group task)

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

[5pts] Preserve all data.

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

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

[2pt] Create UI (Group task)

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

Ruby group capstone

https://github.com/rivasbolinga/my-things/projects/1
We are three people working together
Student A: @momo-87
Student B: @mohametalmeari
Student C: @rivasbolinga

Project documentation video: https://drive.google.com/file/d/1c0XJ-86VcacXnDZTQ67CyTB1Hj5Rl6rV/view?usp=sharing

[2pt] Create Item class (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.
• Add all methods visible in the diagram.

[4pts] Implement Methods for MusicAlbum and Genre Class

• 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