From 6f3af4c78699aef07610093b805dc5f715d2dcc5 Mon Sep 17 00:00:00 2001 From: ridwanullahi Date: Mon, 13 Mar 2023 18:04:44 +0100 Subject: [PATCH 1/8] add person, student, and teacher entities --- .github/workflows/linter.yml | 20 ++++++++++ .github/workflows/tree.yml | 19 +++++++++ GemFile | 1 + GemFile.lock | 33 ++++++++++++++++ README.md | 74 ++++++++++++++++++++++++++++++++++++ person.rb | 41 ++++++++++++++++++++ rubocop.yml | 52 +++++++++++++++++++++++++ student.rb | 16 ++++++++ teacher.rb | 17 +++++++++ 9 files changed, 273 insertions(+) create mode 100644 .github/workflows/linter.yml create mode 100644 .github/workflows/tree.yml create mode 100644 GemFile create mode 100644 GemFile.lock create mode 100644 README.md create mode 100644 person.rb create mode 100644 rubocop.yml create mode 100644 student.rb create mode 100644 teacher.rb diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml new file mode 100644 index 0000000..3b33c28 --- /dev/null +++ b/.github/workflows/linter.yml @@ -0,0 +1,20 @@ +name: Linters + +on: pull_request + +jobs: + rubocop: + name: Rubocop + runs-on: ubuntu-22.04 + + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-ruby@v1 + with: + ruby-version: ">=3.1.x" + - name: Setup Rubocop + run: | + gem install --no-document rubocop -v '>= 1.0, < 2.0' # https://docs.rubocop.org/en/stable/installation/ + [ -f .rubocop.yml ] || wget https://raw.githubusercontent.com/microverseinc/linters-config/master/ruby/.rubocop.yml + - name: Rubocop Report + run: rubocop --color \ No newline at end of file diff --git a/.github/workflows/tree.yml b/.github/workflows/tree.yml new file mode 100644 index 0000000..f786456 --- /dev/null +++ b/.github/workflows/tree.yml @@ -0,0 +1,19 @@ +name: Tests + +on: pull_request + +jobs: + rspec: + name: RSpec + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-ruby@v1 + with: + ruby-version: 3.1.x + - name: Setup RSpec + run: | + [ -f Gemfile ] && bundle + gem install --no-document rspec -v '>=3.0, < 4.0' + - name: RSpec Report + run: rspec --force-color --format documentation \ No newline at end of file diff --git a/GemFile b/GemFile new file mode 100644 index 0000000..207f505 --- /dev/null +++ b/GemFile @@ -0,0 +1 @@ +gem 'rubocop', '>= 1.0', '< 2.0' \ No newline at end of file diff --git a/GemFile.lock b/GemFile.lock new file mode 100644 index 0000000..a74bc02 --- /dev/null +++ b/GemFile.lock @@ -0,0 +1,33 @@ +GEM + specs: + ast (2.4.2) + json (2.6.3) + parallel (1.22.1) + parser (3.2.1.1) + ast (~> 2.4.1) + rainbow (3.1.1) + regexp_parser (2.7.0) + rexml (3.2.5) + rubocop (1.48.0) + json (~> 2.3) + parallel (~> 1.10) + parser (>= 3.2.0.0) + rainbow (>= 2.2.2, < 4.0) + regexp_parser (>= 1.8, < 3.0) + rexml (>= 3.2.5, < 4.0) + rubocop-ast (>= 1.26.0, < 2.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 2.4.0, < 3.0) + rubocop-ast (1.27.0) + parser (>= 3.2.1.0) + ruby-progressbar (1.13.0) + unicode-display_width (2.4.2) + +PLATFORMS + x64-mingw-ucrt + +DEPENDENCIES + rubocop (>= 1.0, < 2.0) + +BUNDLED WITH + 2.3.26 diff --git a/README.md b/README.md new file mode 100644 index 0000000..187aff8 --- /dev/null +++ b/README.md @@ -0,0 +1,74 @@ +## **Description** +**OOP School Library** Aims to create a simple library management system for a school using Ruby programming language. The system should allow librarians to add books to the library, track books that are checked out by students, and manage student accounts. + +## **Prerequisites:** +- Basic Knowledge of [Ruby](https://www.educative.io/blog/intro-to-ruby-tutorial) Programming Language +- Basic Knowledge of [Git](https://www.freecodecamp.org/news/git-and-github-for-beginners/) Command + +- Watch [video](https://www.youtube.com/watch?v=RGOj5yH7evk) to get started in Git + + +## **Build With:** + +- [Ruby](https://www.educative.io/blog/intro-to-ruby-tutorial) + +## **INSTALLATION** + +To install the application, follow these steps: + +- Install Ruby 2.7 or later on your system. You can download it from the official Ruby website: https://www.ruby-lang.org/en/downloads/ + +- Clone this repository using Git: +```bash +git clone https://github.com/Ridwanullahi-code/OOP-School-Library.git +``` +
OR
+ +```bash +git clone git@github.com:Ridwanullahi-code/OOP-School-Library.git +``` +- Navigate to the project directory: +```bash + cd OOP-School-Library +``` +- Install the required gems: +```bash + bundle install +``` +## **USAGE** +To run the application, follow these steps: +- Navigate to the project directory: +```bash + cd OOP-School-Library +``` +- Run the application: +```bash + ruby main.rb +``` +- Follow the on-screen prompts to use the application. + +## **Show your support** + +Give a ⭐️ if you like this project! + +## **Authors** + +- Github: [Ridwan](https://github.com/Ridwanullahi-code) +- LinkedIn: [Ridwan](https://www.linkedin.com/in/ajayi-ridwan/) + +## 🚀 **About Me** + +I'm full stack software developer, Computer science, and Microverse student. + +**Stack:** Python, JavaScript, Bootstrap, Ruby, Rails, React, Redux. Available for hire! +## 🤝 **Contributing** +If you would like to contribute to this project, please fork the repository, make your changes, and submit a pull request. Please make sure to follow the coding style and write tests for your changes. + +Feel free to check the [issues page](https://github.com/Ridwanullahi-code/OOP-School-Library/issues/) +## **Acknowledgements** + +- [Microverse](https://www.microverse.org/) + +## **License** + +This project is [MIT](https://choosealicense.com/licenses/mit/LICENSE) licensed. diff --git a/person.rb b/person.rb new file mode 100644 index 0000000..c7f3770 --- /dev/null +++ b/person.rb @@ -0,0 +1,41 @@ +# frozen_string_literal: true + +# person class store person information and properties +class Person + attr_accessor :name, :age + attr_reader :id + + def initialize(age, name = 'Unknown', parent_permission: true) + @id = generate_id + @age = age + @name = name + @parent_permission = parent_permission + end + + def display_info + { 'id' => @id, 'name' => @name, 'age' => @age } + end + + def update_info(name, age) + @name = name + @age = age + end + + def can_use_services + if of_age || @parent_permission + true + elsif !of_age || !@parent_permission + false + end + end + + private + + def of_age + @age.to_i >= 18 + end + + def generate_id + rand(1..100) + end +end diff --git a/rubocop.yml b/rubocop.yml new file mode 100644 index 0000000..4948d48 --- /dev/null +++ b/rubocop.yml @@ -0,0 +1,52 @@ +AllCops: + NewCops: enable + Exclude: + - "Guardfile" + - "Rakefile" + - "node_modules/**/*" + + DisplayCopNames: true + +Layout/LineLength: + Max: 120 +Metrics/MethodLength: + Max: 20 +Metrics/AbcSize: + Max: 50 +Metrics/ClassLength: + Max: 150 +Metrics/BlockLength: + IgnoredMethods: ['describe'] + Max: 30 + + +Style/Documentation: + Enabled: false +Style/ClassAndModuleChildren: + Enabled: false +Style/EachForSimpleLoop: + Enabled: false +Style/AndOr: + Enabled: false +Style/DefWithParentheses: + Enabled: false +Style/FrozenStringLiteralComment: + EnforcedStyle: never + +Layout/HashAlignment: + EnforcedColonStyle: key +Layout/ExtraSpacing: + AllowForAlignment: false +Layout/MultilineMethodCallIndentation: + Enabled: true + EnforcedStyle: indented +Lint/RaiseException: + Enabled: false +Lint/StructNewOverride: + Enabled: false +Style/HashEachMethods: + Enabled: false +Style/HashTransformKeys: + Enabled: false +Style/HashTransformValues: + Enabled: false \ No newline at end of file diff --git a/student.rb b/student.rb new file mode 100644 index 0000000..50a6fde --- /dev/null +++ b/student.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +require_relative('./person') +# student class store student information and properties +class Student < Person + attr_accessor :classroom + + def initialize(classroom) + @classroom = classroom + super(age, name, parent_permission: true) + end + + def play_hook + "¯\(ツ)/¯" + end +end diff --git a/teacher.rb b/teacher.rb new file mode 100644 index 0000000..b2a204c --- /dev/null +++ b/teacher.rb @@ -0,0 +1,17 @@ +# frozen_string_literal: true + +require_relative('./person') +# class to store teacher information and methods +class Teacher < Person + attr_accessor :specialization + + def initialize(age, name, specialization, parent_permission: false) + @specialization = specialization + super(age, name, parent_permission: parent_permission) + end + + def can_use_services + (of_age || !of_age) || (@parent_permission || !@parent_permission) + end +end + From 0df90d92b83f963c17f7590bd5a9843316def029 Mon Sep 17 00:00:00 2001 From: ridwanullahi Date: Mon, 13 Mar 2023 18:08:17 +0100 Subject: [PATCH 2/8] correct linter error --- teacher.rb | 1 - 1 file changed, 1 deletion(-) diff --git a/teacher.rb b/teacher.rb index b2a204c..93edc2f 100644 --- a/teacher.rb +++ b/teacher.rb @@ -14,4 +14,3 @@ def can_use_services (of_age || !of_age) || (@parent_permission || !@parent_permission) end end - From c4b4baf84f0d60aae831eebea8ed9b7d9fdc565b Mon Sep 17 00:00:00 2001 From: ridwanullahi Date: Mon, 13 Mar 2023 18:22:44 +0100 Subject: [PATCH 3/8] correct linter error --- rubocop.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rubocop.yml b/rubocop.yml index 4948d48..2e6c2bc 100644 --- a/rubocop.yml +++ b/rubocop.yml @@ -1,4 +1,4 @@ -AllCops: +`AllCops: NewCops: enable Exclude: - "Guardfile" From d44a3c1e1e78f8cddbda5819bbfe90961fd01991 Mon Sep 17 00:00:00 2001 From: ridwanullahi Date: Mon, 13 Mar 2023 18:25:31 +0100 Subject: [PATCH 4/8] correct linter error --- rubocop.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rubocop.yml b/rubocop.yml index 2e6c2bc..4948d48 100644 --- a/rubocop.yml +++ b/rubocop.yml @@ -1,4 +1,4 @@ -`AllCops: +AllCops: NewCops: enable Exclude: - "Guardfile" From 0496b321620be3d10460cebdf8ab5258a2991cd9 Mon Sep 17 00:00:00 2001 From: ridwanullahi Date: Tue, 14 Mar 2023 08:19:23 +0100 Subject: [PATCH 5/8] correct linter error --- rubocop.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rubocop.yml b/rubocop.yml index 4948d48..508a3a9 100644 --- a/rubocop.yml +++ b/rubocop.yml @@ -16,7 +16,7 @@ Metrics/AbcSize: Metrics/ClassLength: Max: 150 Metrics/BlockLength: - IgnoredMethods: ['describe'] + AllowedMethods: ['describe'] Max: 30 From e70a51b972337c8e21f42998fd6e7abfdfc4fbf0 Mon Sep 17 00:00:00 2001 From: ridwanullahi Date: Tue, 14 Mar 2023 08:32:47 +0100 Subject: [PATCH 6/8] correct linter error --- .github/workflows/{linter.yml => linters.yml} | 0 .github/workflows/{tree.yml => tests.yml} | 0 rubocop.yml => .rubocop.yml | 0 GemFile | 3 ++- GemFile.lock | 1 + person.rb | 2 -- student.rb | 4 +--- teacher.rb | 2 -- 8 files changed, 4 insertions(+), 8 deletions(-) rename .github/workflows/{linter.yml => linters.yml} (100%) rename .github/workflows/{tree.yml => tests.yml} (100%) rename rubocop.yml => .rubocop.yml (100%) diff --git a/.github/workflows/linter.yml b/.github/workflows/linters.yml similarity index 100% rename from .github/workflows/linter.yml rename to .github/workflows/linters.yml diff --git a/.github/workflows/tree.yml b/.github/workflows/tests.yml similarity index 100% rename from .github/workflows/tree.yml rename to .github/workflows/tests.yml diff --git a/rubocop.yml b/.rubocop.yml similarity index 100% rename from rubocop.yml rename to .rubocop.yml diff --git a/GemFile b/GemFile index 207f505..64f6df6 100644 --- a/GemFile +++ b/GemFile @@ -1 +1,2 @@ -gem 'rubocop', '>= 1.0', '< 2.0' \ No newline at end of file +source "https://rubygems.org" +gem 'rubocop', '>= 1.0', '< 2.0' diff --git a/GemFile.lock b/GemFile.lock index a74bc02..40454d9 100644 --- a/GemFile.lock +++ b/GemFile.lock @@ -1,4 +1,5 @@ GEM + remote: https://rubygems.org/ specs: ast (2.4.2) json (2.6.3) diff --git a/person.rb b/person.rb index c7f3770..aba9a17 100644 --- a/person.rb +++ b/person.rb @@ -1,5 +1,3 @@ -# frozen_string_literal: true - # person class store person information and properties class Person attr_accessor :name, :age diff --git a/student.rb b/student.rb index 50a6fde..ecd32f1 100644 --- a/student.rb +++ b/student.rb @@ -1,5 +1,3 @@ -# frozen_string_literal: true - require_relative('./person') # student class store student information and properties class Student < Person @@ -11,6 +9,6 @@ def initialize(classroom) end def play_hook - "¯\(ツ)/¯" + '¯(ツ)/¯' end end diff --git a/teacher.rb b/teacher.rb index 93edc2f..2ed30df 100644 --- a/teacher.rb +++ b/teacher.rb @@ -1,5 +1,3 @@ -# frozen_string_literal: true - require_relative('./person') # class to store teacher information and methods class Teacher < Person From e13858308dc8dea8bd5bdd1f8f63166c34c90f8a Mon Sep 17 00:00:00 2001 From: ridwanullahi Date: Tue, 14 Mar 2023 09:44:45 +0100 Subject: [PATCH 7/8] update readme file --- README.md | 123 +++++++++++++++++++++++++++++++++++++++++++++------- nameable.rb | 4 ++ 2 files changed, 111 insertions(+), 16 deletions(-) create mode 100644 nameable.rb diff --git a/README.md b/README.md index 187aff8..a210534 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,62 @@ -## **Description** + + +# 📗 Table of Contents + +- [📖 About the Project](#about-project) + - [🛠 Built With](#built-with) + - [Tech Stack](#tech-stack) + - [Key Features](#key-features) + - [🚀 Live Demo](#live-demo) +- [💻 Getting Started](#getting-started) + - [Prerequisites](#prerequisites) + - [Setup](#setup) + - [Install](#install) + - [Usage](#usage) + - [Run tests](#run-tests) + - [Deployment](#triangular_flag_on_post-deployment) +- [👥 Authors](#authors) +- [🔭 Future Features](#future-features) +- [🤝 Contributing](#contributing) +- [⭐️ Show your support](#support) +- [📝 License](#license) + + + +# 📖 OOP School Library + **OOP School Library** Aims to create a simple library management system for a school using Ruby programming language. The system should allow librarians to add books to the library, track books that are checked out by students, and manage student accounts. +## 🛠 Built With + +### Tech Stack + +
+ Client + +
+ + + +### Key Features + +- **Decodes morse code into human readable format** + +

(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: + ## **Prerequisites:** - Basic Knowledge of [Ruby](https://www.educative.io/blog/intro-to-ruby-tutorial) Programming Language - Basic Knowledge of [Git](https://www.freecodecamp.org/news/git-and-github-for-beginners/) Command @@ -8,10 +64,14 @@ - Watch [video](https://www.youtube.com/watch?v=RGOj5yH7evk) to get started in Git -## **Build With:** + -- [Ruby](https://www.educative.io/blog/intro-to-ruby-tutorial) - ## **INSTALLATION** To install the application, follow these steps: @@ -47,28 +107,59 @@ To run the application, follow these steps: ``` - Follow the on-screen prompts to use the application. -## **Show your support** + + +## 👥 Authors + +👤 **Ajayi Ridwan** -Give a ⭐️ if you like this project! +- GitHub: [@Ridwanullahi-code](https://github.com/Ridwanullahi-code) +- Twitter: [@Ridwanullahi22](https://twitter.com/twitterhandle) +- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ajayi-ridwan/) -## **Authors** +

(back to top)

-- Github: [Ridwan](https://github.com/Ridwanullahi-code) -- LinkedIn: [Ridwan](https://www.linkedin.com/in/ajayi-ridwan/) + + +## 🤝 Contributing +If you would like to contribute to this project, please fork the repository, make your changes, and submit a pull request. Please make sure to follow the coding style and write tests for your changes. +Feel free to check the [issues page](https://github.com/Ridwanullahi-code/OOP-School-Library/issues/) ## 🚀 **About Me** I'm full stack software developer, Computer science, and Microverse student. **Stack:** Python, JavaScript, Bootstrap, Ruby, Rails, React, Redux. Available for hire! -## 🤝 **Contributing** -If you would like to contribute to this project, please fork the repository, make your changes, and submit a pull request. Please make sure to follow the coding style and write tests for your changes. -Feel free to check the [issues page](https://github.com/Ridwanullahi-code/OOP-School-Library/issues/) -## **Acknowledgements** +

(back to top)

+ + + +## ⭐️ Show your support + +If you like this project... + +Feel free to give it a start + +

(back to top)

+ + + +## 🙏 Acknowledgments + +> Give credit to everyone who inspired your codebase. +> Thanks Microverse for providing us with the right material to aid this project development + +

(back to top)

+ +

(back to top)

+ + + +## 📝 License -- [Microverse](https://www.microverse.org/) +This project is [MIT](./LICENSE) licensed. -## **License** +_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._ -This project is [MIT](https://choosealicense.com/licenses/mit/LICENSE) licensed. +

(back to top)

\ No newline at end of file diff --git a/nameable.rb b/nameable.rb new file mode 100644 index 0000000..e3e1dfd --- /dev/null +++ b/nameable.rb @@ -0,0 +1,4 @@ +class Nameable + + +end \ No newline at end of file From 85866fb424a5d8173a441c72ef5257a5dd8785a1 Mon Sep 17 00:00:00 2001 From: ridwanullahi Date: Tue, 14 Mar 2023 09:48:13 +0100 Subject: [PATCH 8/8] update readme file --- nameable.rb | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 nameable.rb diff --git a/nameable.rb b/nameable.rb deleted file mode 100644 index e3e1dfd..0000000 --- a/nameable.rb +++ /dev/null @@ -1,4 +0,0 @@ -class Nameable - - -end \ No newline at end of file