marcooquendoc/catalogofmythings-rubycapstone

Console app that will help keeping record of different types of things you own like: books, music albums, movies, and games

📗 Table of Contents

• 📗 Table of Contents
• 📖 Catalog of My Things - Ruby Capstone
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Project Documentation
    • Video
    • Diagram
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Catalog of My Things - Ruby Capstone

Catalog of My Things - Ruby Capstone is a simple console app that allows users to manage collections of the things they own.

🛠 Built With

Tech Stack

Client

• Ruby

Database

• PostgreSQL

Key Features

• [Create and manage data about my things]
• [Add a Book]
• [Add a Game]
• [Add a Music Album]
• [List all added items]
• [Keep track of books, music albums, movies, and games and other information]

(back to top)

🚀 Project Documentation

Please visit our zoom video presentation. Click the Link button.

Diagram

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

ruby version 2.7.0 or later

Setup

Clone this repository to your desired folder:

  git clone https://github.com/MarcoOquendoC/CatalogOfMyThings-RubyCapstone.git
  cd CatalogOfMyThings-RubyCapstone

Install

Install this project with:

  bundle install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

To run tests, run the following command:

  rspec src/spec

Deployment

Please visit and try the app. Click the button.

(back to top)

👥 Authors

Fábio Lima

• GitHub: @limavfabio
• Twitter: @limavfabio
• LinkedIn: LinkedIn

Marco Oquendo

• GitHub: @MarcoOquendoC.
• Twitter: @marcooquendoc.
• LinkedIn: Marco Vinicio Oquendo.

Miliyon Ayalew

• GitHub: @Miliyonayalew
• Twitter: @Miliyonayalew
• LinkedIn: Miliyonayalew

(back to top)

🔭 Future Features

• [Integration with PostgreSQL]
• [Refactor files and code to match the drawing below]
• [Refactor reading the data to get wired associations]

(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 leave a star.

(back to top)

🙏 Acknowledgments

I would like to thank everyone whose code was used or served as inspiration.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

catalogofmythings-rubycapstone's Issues

[1pt] Create genre.rb file

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

[1pt] Create music_album.rb file.

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

[1pt] Create schema for Genre and MusicAlbum tables

• 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

Add cool comments

Add cool comments

[1pt] Create an Author Class

• Create an Author class with an association to the Item class (in a separate .rb file).
• Author class properties visible in the diagram should be defined and set up in the constructor method.
  

[2pt] Preserve data for Genre and MusicAlbum classes

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

[2pt] Implement methods in the Author Class

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

[2pt] Add unit tests for MusicAlbum and Genre classes

• Add unit tests for all implemented methods.

[1pt] Add unit tests for Book#can_be_archived?

• Add unit tests for can_be_archived? in the Book class

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

[1pt] Add methods to Item class.

Implement methods:

• can_be_archived?

  • It should return true if published_date is older than 10 years. Otherwise return false.

• move_to_archive

  • It should reuse can_be_archived?() method
  • It should change the archived property to true if the result of the can_be_archived?() method is true.
  • It should do nothing if the result of the can_be_archived?() method is false.

[1pt] Add unit tests for add_item

• Add unit tests for add_item method in Label class

[2pt] Implement author and game options

The following options should be available:

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

[2pt] Preserve Game and Author data in .json files

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

[1pt] Create a schema.sql for Games and authors 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)
• authors table

Catalog Of My Things Kanban board

In this Milestone We @MarcoOquendoC, @Miliyonayalew and @limavfabio

Setup the Kanban Board based on the group task divided requirements, Below please find the kanban board link
Kanban Board Project link

This is a 3-member team and tasks were assigned as follows:

• Team Member #1 @limavfabio
• Team Member #2 @MarcoOquendoC
• Team Member #3 @Miliyonayalew

[2pt] Implement options for Book and Label classes

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

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

[2pt] Preserve data for Book and Label classes

• Preserve data for Book class in a .json file
• Preserve data for Label class in a .json file

[2pt] Add unit tests for Author methods

Add unit tests for all author class implemented methods.

[1pt] Create a schema.sql file for Book and Label tables

Create a schema.sql file with tables that will be analogical to the structure of the Book and Label classes:

• Books table (add all properties and associations from the parent Item class as table columns)
• Labels table

[1pt] Implement add_item method in the 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)

[1pt] Implement method 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

[2pt] 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] Create Item class

Create item.rb file.

• Create the class Item from the following diagram:

[1pt] Linters + Create a main.rb

• Setup the linters and conection to replit.
• Create app.rb file with basic class
• Create the file main.rb that will serve as the console app entry-point.

It should look like this:

require_relative 'app'

def main
  system('cls')
  system('clear')
  puts "________Welcome to Catalog Of My Things App!________\n "
  app = App.new
  app.run
end

main

[1pt] Update Readme File

• Add class diagram for the catalog of my things.
• Add file's distribution diagram.
• Add Live Demo link to replit webpage.
• Record Video describing the project

[2pt] Add options for Genre and MusicAlbum classes

The following options should be available:

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

[2pt] Implement methods for MusicAlbums and Genre classes

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

[1pt] Add unit tests for Label class

• Add unit tests for add_item method in the Label class

[1pt] Create a Game Class

• Create a Game class in a separate .rb file.
• Class properties visible in the diagram should be defined and set up in the constructor method.