Implementation

.github/workflows/linters.yml

@@ -0,0 +1,20 @@
+name: Linters
+
+on: pull_request
+
+jobs:
+  rubocop:
+    name: Rubocop
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v3
+      - 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

.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:
+  AllowedMethods: ['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

Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# gem "rails"
+gem 'rubocop', '>= 1.0', '< 2.0'

Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rubocop (1.57.0)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  rubocop (>= 1.0, < 2.0)
+
+BUNDLED WITH
+   2.4.10

LICENSE → LICENSE.md

@@ -1,6 +1,6 @@
-MIT License
+## MIT License
 
-Copyright (c) 2023 Mahammad Mostafa
+*Copyright (c) 2023 Mahammad Mostafa*
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -0,0 +1,146 @@
+<a name="title"></a>
+
+<!-- TITLE -->
+
+# 🏷️ Enumerable Methods 
+
+This is the fourth project of the fourth module in the **Microverse** program.
+<br/>
+Check the below contents for further details about this project.
+
+<!-- CONTENTS -->
+
+# 📗 Contents
+
+- [Description](#description)
+- [Instructions](#instructions)
+- [Authors](#authors)
+- [Future](#future)
+- [Contributions](#contributions)
+- [Support](#support)
+- [Acknowledgements](#acknowledgements)
+- [License](#license)
+
+<!-- DESCRIPTION -->
+
+<a name="description"></a>
+
+# 📖 Description
+
+This repository includes a class file `MyList` & a module file `MyEnumerable`.
+
+
+📌 **Tech Stack:**
+- Code built with `Ruby`
+
+📌 **Key Features:**
+- Class `MyList` includes a module & contains two methods
+- First method is to intialize the class with an array instance `list`
+- Second method `each` implements looping through `list` instance
+- Module `MyEnumerable` contains methods for several array operations
+- First method `all` checks if all elements of `list` array meets a comparison
+- Second method `any` checks if any element of `list` array meets a comparison
+- Third method `filter` return a new array if any element of `list` array meets a condition
+- Fourth method `min` returns the minimum value in `list` array
+- Fifth method `max` returns the maximum value in `list` array
+
+<p align="right"><a href="#title">back to top</a></p>
+
+<!-- INSTRUCTIONS -->
+
+<a name="instructions"></a>
+
+# 🛠️ 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 project with
+```
+ruby list.rb
+```
+
+<p align="right"><a href="#title">back to top</a></p>
+
+<!-- AUTHORS -->
+
+<a name="authors"></a>
+
+# 👥 Authors
+
+📌 **Mahammad:**
+- [GitHub](https://github.com/mahammad-mostafa)
+- [Twitter](https://twitter.com/mahammad_mostfa)
+- [LinkedIn](https://linkedin.com/in/mahammad-mostafa)
+
+📌 **Carlos:**
+- [GitHub](https://github.com/CarlosZ96)
+
+📌 **Austin:**
+- [GitHub](https://github.com/stino-x)
+
+<p align="right"><a href="#title">back to top</a></p>
+
+<!-- FUTURE -->
+
+<a name="future"></a>
+
+# 🔭 Future
+
+Some additional features I may implement in the project:
+- [ ] Implement Object oriented programming
+
+<p align="right"><a href="#title">back to top</a></p>
+
+<!-- CONTRIBUTIONS -->
+
+<a name="contributions"></a>
+
+# 🤝🏻 Contributions
+
+Wish to contribute to this project?
+<br/>
+Contributions, issues, and feature requests are more than welcome!
+<br/>
+Feel free to check the [issues](../../issues) page too.
+
+<p align="right"><a href="#title">back to top</a></p>
+
+<!-- SUPPORT -->
+
+<a name="support"></a>
+
+# ⭐️ Support
+
+Like this project? Show your support by starring!
+
+<p align="right"><a href="#title">back to top</a></p>
+
+<!-- ACKNOWLEDGEMENTS -->
+
+<a name="acknowledgements"></a>
+
+# 🙏🏻 Acknowledgements
+
+I thank everyone at **Microverse** for guiding me through this project.
+
+<p align="right"><a href="#title">back to top</a></p>
+
+<!-- LICENSE -->
+
+<a name="license"></a>
+
+# 📝 License
+
+This project is [MIT](LICENSE.md) licensed.
+
+<p align="right"><a href="#title">back to top</a></p>

enumarable.rb

@@ -0,0 +1,29 @@
+module MyEnumerable
+  def all?
+    each { |element| return false unless yield element }
+    true
+  end
+
+  def any?
+    each { |element| return true if yield element }
+    false
+  end
+
+  def filter
+    result = []
+    each { |element| result.append(element) if yield element }
+    result
+  end
+
+  def min
+    result = nil
+    each { |element| result = element if result.nil? || result > element }
+    result
+  end
+
+  def max
+    result = nil
+    each { |element| result = element if result.nil? || result < element }
+    result
+  end
+end

list.rb

@@ -0,0 +1,16 @@
+require './enumarable'
+
+class MyList
+  include MyEnumerable
+  def initialize(array)
+    @list = array
+  end
+
+  def each
+    counter = 0
+    until counter == @list.size
+      yield @list[counter]
+      counter += 1
+    end
+  end
+end