🏷️ School Library

This is the fifth 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

The project follows Object Oriented Programming using Ruby. This repository includes ten class files (Person / Student / Teacher / Classroom / Book / Rental / Nameable / Decorator / Capitalize / Trimmer). Special class App for handling all app operations and a file main.rb as entry point for it. Module Storage used for handling JSON files read & write. Decorator design pattern is implemented for adding several operations on name variable in Person class. Several associations exist bewteen some classes. All data is preserved inside three files (books.json / people.json / rentals.json). Unit testing is carried on ten classes (Person / Student / Teacher / Classroom / Book / Rental / Nameable / Decorator / Capitalize / Trimmer). Every method in the above classes has an example test case inside specs directory.

📌 Tech Stack:

• Code built with Ruby
• Unit tests uses RSpec
• Linting is done with Rubocop

📌 Key Features:

• Class Nameable is a parent class for both Person & Decorator
• Class Person is a parent class for both Student & Teacher
• Class Decorator is a parent class for both Capitalize & Trimmer
• Class Person includes a constructor & four methods
• Constructor in Person class includes three arguments (age / name / parent_permission)
• First method in Person class is a public method called add_rental
• Second method in Person class is a public method called can_use_services
• Third method in Person class is an unherited method called correct_name
• Fourth method in Person class is a private method called of_age
• Class Student includes a constructor & four methods
• Constructor in Student class includes three arguments (classroom / age / name / parent_permission)
• First method in Student class is a public method called play_hooky
• Second method in Student class is a static method called input_arguments
• Third method in Student class is a public method called generate_string
• Fourth method in Student class is a static method called parse_string
• Constructor in Teacher class includes three arguments (specialization / age / name / parent_permission)
• First method in Teacher class is a public method that overrides can_use_services from parent class
• Second method in Teacher class is a static method called input_arguments
• Third method in Teacher class is a public method called generate_string
• Fourth method in Teacher class is a static method called parse_string
• Class Nameable includes one method correct_name that raises an exception
• Class Decorator includes only constructor that passes a Nameable object
• Class Capitalize includes one inherited method correct_name & overrides it
• Class Trimmer includes one inherited method correct_name & overrides it
• Class Classroom includes a constructor & three methods
• Constructor in Classroom includes one argument label
• First method in Classroom class is public method add_student
• Second method in Classroom class is a public method called generate_string
• Third method in Classroom class is a static method called parse_string
• Class Book includes a constructor & three methods
• Constructor in Book includes two arguments (title / author)
• First method in Book class is public method add_rental
• Second method in Book class is a public method called generate_string
• Third method in Book class is a static method called parse_string
• Class Rental includes only one constructor & three methods
• First method in Rental class is a static method called input_arguments
• Second method in Rental class is a public method called generate_string
• Third method in Rental class is a static method called parse_string
• Constructor in Book includes three arguments (date / book / person)
• First method in Book class is a static method called input_arguments
• Second method in Book class is a public method called generate_string
• Third method in Book class is a static method called parse_string
• Class App includes a constructor & twelve methods
• Constructor in App initializes several empty arrays
• Entry point in main.rb file with infinite loop
• Module Storage includes two methods (read_file / write_file)

back to top

🛠️ Instructions

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

📌 Prerequisites:

• You need Ruby language 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:

• 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