mmsesay/catalog-of-my-things

A console app that will help you to keep a record of different types of things you won: books, music albums, movies, and games.

catalog-of-my-things

A console app that will help you to keep a record of different types of things you won: books, music albums, movies, and games.

Application Demo

Built With

• Ruby

Getting Started

The project comes shipped with linters config for ruby, so ensure you have Rubocop installed on your local environment

• To get a local copy of the repository please run the following commands on your terminal:
• $ git clone https://github.com/mmsesay/catalog-of-my-things.git
• $ cd catalog-of-my-things.
• $ run bundle install to couple all dependacies
• $ run ruby main.rb
• $ for test run rspec spec

👤 Muhammad Sesay

• GitHub: @mmsesay
• Twitter: @DeeMaejor
• LinkedIn: LinkedIn

👤 Cyril Iyadi

• GitHub: @see-why
• LinkedIn: C.Iyadi

👤 Henry Kc

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• my dog Perry for the comforting lick here and there

📝 License

• This project is MIT licensed.

catalog-of-my-things's Issues

[0.5pt] Implement method in the Book class

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] Add unit tests for all implemented methods.

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

[0.3pt] Create Music Album class

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.

[0.5pt] Implement Genre class Method

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)

[0.5pt] Implement method to Label Class

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)

[0.4pt] List all books

Please list all created books

[1pt] Add Unittests for books & labels

Add unit tests for all implemented methods.

[1pts] Preserve Author and Game class data

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

[1pts] Add schema.sql file with tables for Game and Author classes

• 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

[0.3pt] Create a Label class

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 m

[0.5pt] Implement can_be_archived method in Item class

can_be_archived?() in the Item class:

• should return true if published_date is older than 10 years
• otherwise, it should return false

[0.5] 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

[0.5pt] Preserve books & author data in .json files

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

Kanban Board Setup

In the Issue, we set up our project's kanban board and shared the tasks.
We are a 3 member team and the tasks are shared as follows:

• @mmsesay as Team Member 1
• @see-why as Team Member 2
• @HENRYKC24 as Team Member 3

[1pt] Create schema.sql file for books & lables

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

[0.3pt] Create Items 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.

• Add all methods visible in the diagram.

[0.5pt] Create a Game class

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

[1pts] Add schema.sql file with tables for Genre and MusicAlbum classes

• 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

[0.3pt] Create Genre class

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

[0.3pt] Create a Book class

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.

[0.5pt] Implement Music Album class method

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

[0.4pt] List all labels

Please list all labels (e.g. 'Gift', 'New')

[0.5pt] Add a book

Please enable the user to add a book

[1pt] Add unit tests for all implemented methods.

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

[1pt] Include following options

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

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

[1pts] 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.

[1pts] Preserve Genre and MusicAlbum class data

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

[1pts] Include options in details to console app:

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

[1pts] Include options in details to console app:

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

[0.5pts] Create a main.rb file

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

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

[0.5pt] Create an Author class

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