mahammad-mostafa / things-catalogue

This is the capstone project of the fourth module in the Microverse program. It is a console app for handling items inside a catalogue built with Ruby & PostgreSQL.

🏷️ Things Catalogue

This is the capstone project of the fourth module in the Microverse program.
Check the below contents for further details about this project.

📗 Contents

• Description
• Instructions
• Authors
• Future
• Contributions
• Support
• Acknowledgements
• License

📖 Description

This repository is about a catalogue of different item types that the user can add or display. There is one parent class Item and three children classes (Book / MusicAlbum / Game). Three classes (Label / Genre / Author) have one to many association with Item class. Built unit tests for implemented methods of seven classes (Item / Book / MusicAlbum / Game / Label / Genre / Author). Created database tables for items data inside schema.sql file.

📌 Live Demo:

• Watch the project presentation from here

📌 Tech Stack:

• Application uses Ruby
• Unit tests run with RSpec
• Linting is done with Rubocop
• Schema file uses PostgreSQL

📌 Key Features:

• User is given the option to either add new item or display a list
• Available item types to add (book / music album / game)
• Available list types to display (books / albums / games / labels / genres / authors)
• Adding any new item will require the use to select (label / genre / author) form a list or create new ones
• All items created by the user are stored in json files and reloaded after restart

back to top

🛠️ Instructions

You can easily download or fork this repository and work on it immadiately!

📌 Prerequisites:

• You need Ruby language & PostgreSQL database installed

📌 Installation:

• To install all gem dependencies run

bundle install

📌 Development:

• Run main.rb file with

ruby main.rb

📌 Tests:

• To run unit tests navigate to specs directory and run:

rspec . -f d

back to top

👥 Authors

📌 Mahammad:

• GitHub
• Twitter
• LinkedIn

📌 Alexander:

• GitHub
• LinkedIn

📌 Austin:

• GitHub

back to top

🔭 Future

Some additional features I may implement in the project:

• Use Rails framework with this project
• Implement better visual interface

back to top

🤝🏻 Contributions

Wish to contribute to this project?
Contributions, issues, and feature requests are more than welcome!
Feel free to check the issues page too.

back to top

⭐️ Support

Like this project? Show your support by starring!

back to top

🙏🏻 Acknowledgements

I thank everyone at Microverse for guiding me through this project.

back to top

📝 License

This project is MIT licensed.

back to top

things-catalogue's Issues

[1pt] Unit tests - Austin

• Add unit tests for all implemented methods.

[2pt] Author class - Alexander

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

[2pt] Book options - Mahammad

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

[1pt] Unit tests - Alexander

• Add unit tests for all implemented methods.

[2pt] MusicAlbum options - Austin

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

[1pt] Unit tests - Mahammad

• Add unit tests for all implemented methods.

[2pt] Label class - Mahammad

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

[1pt] Main file - Group

• 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

[1pt] Database schema - Austin

• 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

[1pt] Data storage - Austin

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

[1pt] Data storage - Alexander

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

[2pt] Book class - Mahammad

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

[1pt] Data storage - Mahammad

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

[2pt] Game class - Alexander

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

[2pt] MusicAlbum class - Austin

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

Kanban board

We are a team of 3 persons:

• Team member 1: @mahammad-mostafa
• Team member 2: @stino-x
• Team member 3: @alexansaa

Check our project tasks from here:
https://github.com/users/mahammad-mostafa/projects/1

[1pt] Database schema - Alexander

• 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

[2pt] Item class - Group

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

[2pt] Genre class - Austin

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

[2pt] Game options - Alexander

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

[1pt] Database schema - Mahammad

• 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