brhanuhailu/ruby-capstone

[Catalogue_Of_My_Things] is a console app that will help to keep a record of different types of things one owns: books, music albums, movies, and games. Everything is based on the UML class diagram. The data is stored in JSON files but we also prepare a database with tables

📗 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
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [Catalogue_Of_My_Things]

[Catalogue_Of_My_Things] is a console app that will help to keep a record of different types of things one owns: books, music albums, movies, and games. Everything is based on the UML class diagram. The data is stored in JSON files but we also prepare a database with tables structure analogical the program's class structure.

🛠 Built With

Tech Stack

Server

• Ruby

Database

• PostgreSQL

Key Features

• [User Interface]
• [Add Database to store the whole data]
• [preserve data in json format]

(back to top)

🚀 Video Link

• Video Link

(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  sudo apt-get install ruby-full

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone  https://github.com/brhanuhailu/ruby-capstone.git

Install

Install this project with:

  cd project
  bundle install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run Linter tests, run the following command:

  rubocop

Run unit tests

To run unit tests, run the following command:

  Rspec

Deployment

Not applicable.

(back to top)

👥 Authors

👤 Daniel Matama

• GitHub: @Recillah-Khamala
• Twitter: @recillahk
• LinkedIn: Recillah Khamala

👤 Brhanu Hailu

• GitHub: @brhanuhailu
• Twitter: @tigrayfurtune
• LinkedIn: LinkedIn

👤 Yodit Abebe

• GitHub: @yodit93
• Twitter: @@yodtwit
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Add more unit tests]
• [Create complete databases]

(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 give a ⭐️ and We are so excited to accept you feedback to improve our profession.

(back to top)

🙏 Acknowledgments

we would like to thank Microverse

(back to top)

📝 License

This project is MIT licensed.

ruby-capstone's Issues

[2pt] Create Resource class

Create Add_resource class and methods

[2pt] Create Movies class

Create class for Movies and the necessary methods

[0.5pt] Create a main.rb file that will serve as your console app #2

Create the main console page for display the result

[1] Add unit test for Authors and Game

Add unit test for every method and class of authors and sources

[1] Set up Kanban board #1

Create Kanban board and create work division for our teams

[1pt] Create a schema.sql for MusicAlbum and Genre. TeamM2

create table for MusicAlbum and for Genre
with attributes name, id and item for genre and for music on spotfiy boolean

[1.5] Preserve data Game and Authors in .json file

Persist data of source and authors in the form of .json file

[0.5pt] Create Authors class #5. TeamM3

Create authors Class and methods

[0.5pt] Create a Label class. TeamM1

• 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] Create a source class

Create class of sources with it's necessary methods

[1pt] Add unit tests for Genre and MusicAlbum Class

operate unit tests using the Rspec for genre and MusicAlbum

[1pt] Create Source class

Create Source class with an association to the Item class in a separate .rb file.

Close all issues

Issues all

[0.5pt] Implement startup actions #4

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.

Revision

Revise Ruby

[1.5pt] Preserve Genre and Music Album data data in .json file

persisting the data of Genre and Music Album by saving collections in .json files.

[1pt] Create a schema.sql file for books and label class. TeamM1

Create a class of books and labels with their methods

Catalog of my things: divided requirements

Group task for the Catalog

• In this project we have three members
  • Team membeone : yodit93
  • Team member two: danielmatama
  • Team member three: brhanuhailu
• link Kanban board https://github.com/brhanuhailu/ruby-capstone/projects/1

[0.5pt] Create Item class in a separate .rb file. # 3

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

[0.5pt] Create Genre class

create a class Genre and detail method including the given attributes

[1pt] Create a schema.sql file for the Game and Author classes. TeamM3

add table Game and movies to the schema.sql file

[0.5pt] Create Game class #6

Create Game class with it's give attributes to pass in the methods

[1pt] Add unit tests for Book and Label class

add unit test for books an labels

[0.5pt] Create MusicAlbum class

[0.5pt] Create a Book class.TeamM1

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

[1pt] Create a schema.sql file for MusicAlbum and Genre

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

[1.5pt] Preserve data Book and Label in .json file .TeamM1

persist of data in json file

[2pt] Add unit tests for Game and Movies

add unit tests of all methods of the Games class

[3] Preserve data Games and Movies in .json file