Update documentation

Author: norbertszivos

CHANGELOG.md

@@ -4,14 +4,14 @@
 
 ### Bug fixes
 
-* Add base64 gem as a dependency because from Ruby 3.4 this is not a standard gem.
+* Add the base64 gem as a dependency because, from Ruby 3.4, this is not a standard gem.
 
 
 ## 1.4.0 (2025-01-07)
 
 ### Changes
 
-* Upgrade sqlite3 to version 2.0.4
+* Upgrade the sqlite3 gem to version 2.0.4
 * Add Ruby 3.4 support.
 * Drop Ruby 2.7 support.
 * Update bundler and gems.
@@ -21,16 +21,16 @@
 
 ### Changes
 
-* Update webrick to version 1.8.2 because of security issues.
-* Upgrade rackup to version 2.1.0
+* Update the webrick gem to version 1.8.2 because of security issues.
+* Upgrade the rackup gem to version 2.1.0
 * Update gems.
 
 
 ## 1.3.6 (2024-03-05)
 
 ### Changes
 
-* Update rack to version 3.0.9.1 because of security issues.
+* Update the rack gem to version 3.0.9.1 because of security issues.
 * Update gems.
 
 
@@ -40,7 +40,7 @@
 
 * Add Ruby 3.3 support.
 * Update bundler and gems.
-* Replace apparition gem to cuprite gem.
+* Replace the apparition gem with the cuprite gem.
 
 
 ## 1.3.4 (2023-05-19)
@@ -55,7 +55,7 @@
 
 ### Changes
 
-* Update rack to version 3.0.7 because of security issues.
+* Update the rack gem to version 3.0.7 because of security issues.
 * Update gem description.
 * Update gems.
 
@@ -64,15 +64,15 @@
 
 ### Changes
 
-* Update rack to version 3.0.4.2 because of security issues.
+* Update the rack gem to version 3.0.4.2 because of security issues.
 * Update bundler and gems.
 
 
 ## 1.3.1 (2023-01-25)
 
 ### Changes
 
-* Update rack to version 3.0.4.1 because of security issues.
+* Update the rack gem to version 3.0.4.1 because of security issues.
 * Update bundler and gems.
 
 ### Bug fixes
@@ -85,22 +85,22 @@
 ### Changes
 
 * Replace rack to rackup gem as a dependency.
-  In the rack 3.x gem it was extracted rackup command, Rack::Server, Rack::Handler, Rack::Lobster and related code into a separate gem.
+  In the rack 3.x gem it was extracted rackup command, Rack::Server, Rack::Handler, Rack::Lobster, and related code into the rackup gem.
 * Update bundler and gems.
 
 ### Bug fixes
 
 * Fix infinite scroll.
-  In the new Chrome browser, the scrollTop is a float and not an integer. Because of that, the infinite scroll was stopped working.
+  In the new Chrome browser, the scrollTop is a float and not an integer. Because of that, the infinite scroll stopped working.
 * Override webrick server for capybara in RSpec configuration.
-  At this moment capybara does not support the new rack/rackup changes.
+  At this moment, capybara does not support the new rack/rackup changes.
 
 
 ## 1.2.1 (2022-05-27)
 
 ### Changes
 
-* Update rack to version 2.2.3.1 because of security issues.
+* Update the rack gem to version 2.2.3.1 because of security issues.
 
 
 ## 1.2.0 (2022-05-26)
@@ -123,23 +123,23 @@
 
 ### Bug fixes
 
-* Update apparition gem from github to fix issues.
+* Update the apparition gem from GitHub to fix issues.
 
 
 ## 1.0.0 (2021-04-02)
 
 ### Changes
 
 * Update documentation.
-* Change JavaScript to hide HTML tab if mail does not have HTML part.
+* Change JavaScript to hide the HTML tab if the mail does not have an HTML part.
 * Refactoring the JavaScript code.
-* Change the documentation uri in the gemspec file.
+* Change the documentation URI in the gemspec file.
 * Update .rubocop.yml.
 * Update gems.
 
 ### Bug fixes
 
-* Fix 3x load message list when reload tab and infinite scroll was used.
+* Fix the 3x load message list when reloading the tab, and infinite scroll was used.
 
 
 ## 1.0.0.rc1 (2021-03-20)

CONTRIBUTING.md

@@ -9,9 +9,9 @@ do so.
 
 * Check that the issue has not already been reported.
 * Check that the issue has not already been fixed in the latest code.
-* Be clear, concise and precise in your description of the problem.
+* Be clear, concise, and precise in your description of the problem.
 * Open an issue with a descriptive title and summary.
-* Include any relevant code to the issue summary.
+* Include any relevant code in the issue summary.
 
 ## Pull requests
 

README.md

@@ -9,8 +9,8 @@
 
 **MailGrabber** is yet another solution to inspect sent emails.
 
-It has two part:
-- delivery method to grab emails and store into a database
+It has two parts:
+- delivery method to grab emails and store them in a database
 - simple rack web interface to check those emails
 
 ## Installation
@@ -29,7 +29,9 @@ Or install it yourself as:
 
     $ gem install mail_grabber
 
-## Usage
+## Documentation
+
+### How Tos
 
 - [How to use MailGrabber in a Ruby script or IRB console](https://github.com/MailToolbox/mail_grabber/blob/main/docs/usage_in_script_or_console.md)
 - [How to use MailGrabber in Ruby on Rails](https://github.com/MailToolbox/mail_grabber/blob/main/docs/usage_in_ruby_on_rails.md)
@@ -43,7 +45,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 To release a new version:
 
 - Update [CHANGELOG.md](https://github.com/MailToolbox/mail_grabber/blob/main/CHANGELOG.md)
-- Update the version number in `version.rb` manually or use `gem-release` gem and run `gem bump -v major|minor|patch|rc|beta`.
+- Update the version number in `version.rb` manually or use the `gem-release` gem and run `gem bump -v major|minor|patch|rc|beta`.
 - Build gem with `bundle exec rake build`.
 - Run `bundle install` to update gemfiles and commit the changes.
 - Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

docs/usage_in_ruby_on_rails.md

@@ -1,14 +1,14 @@
 # How to use MailGrabber in Ruby on Rails
 
-Add `mail_grabber` gem to the `Gemfile` and run `bundle install`.
+Add the `mail_grabber` gem to the `Gemfile` and run `bundle install`.
 
 Then change `config/environments/development.rb` file.
 
 ```ruby
 config.action_mailer.delivery_method = :mail_grabber
 ```
 
-Also add route that we can reach MailGrabber web interface. Let's change `config/routes.rb` file.
+Also, add a route that we can reach the MailGrabber web interface. Let's change the `config/routes.rb` file.
 
 ```ruby
 require 'mail_grabber/web'
@@ -18,7 +18,7 @@ Rails.application.routes.draw do
 end
 ```
 
-So now we should add a mailer method. Let's create `app/mailers/test_mailer.rb` file.
+So now we should add a mailer method. Let's create the `app/mailers/test_mailer.rb` file.
 
 ```ruby
 class TestMailer < ApplicationMailer
@@ -30,19 +30,19 @@ class TestMailer < ApplicationMailer
 end
 ```
 
-Then we should add views (the body) of this email, so create `app/views/test_mailer/send_test.html.erb`
+Then we should add views (the body) of this email, so create the `app/views/test_mailer/send_test.html.erb`
 
 ```erb
 <p>Test email body</p>
 ```
 
-and `app/views/test_mailer/send_test.text.erb`.
+and the `app/views/test_mailer/send_test.text.erb` files.
 
 ```erb
 Test email body
 ```
 
-In the `rails console` we can try it out.
+In the `rails console`, we can try it out.
 
 ```ruby
 TestMailer.send_test.deliver_now
@@ -97,4 +97,4 @@ TestMailer.send_test.deliver_now
 #=> #<Mail::Message:61160, Multipart: true, Headers: <Date: Sat, 20 Mar 2021 16:56:34 +0100>, <From: from@example.com>, <To: to@example.com>, <Message-ID: <60561b32d6d5a_12424ebdc947a5@local.mail>>, <Subject: Test email>, <Mime-Version: 1.0>, <Content-Type: multipart/alternative; boundary="--==_mimepart_60561b32d4370_12424ebdc946bb"; charset=UTF-8>, <Content-Transfer-Encoding: 7bit>>
 ```
 
-Then we can check grabbed emails on the web interface. If the Rails server is running, then open a browser and visit on the `http://localhost:3000/mail_grabber` page.
+Then we can check the grabbed emails on the web interface. If the Rails server is running, then open a browser and visit on the `http://localhost:3000/mail_grabber` page.

docs/usage_in_script_or_console.md

@@ -12,7 +12,7 @@ MailGrabber::DeliveryMethod.new.deliver!(message)
 # => true
 ```
 
-Or add `MailGrabber::DeliveryMethod` to `mail.delivery_method`.
+Or add the `MailGrabber::DeliveryMethod` to the `mail.delivery_method`.
 
 ```ruby
 mail = Mail.new(from: 'from@example.com', to: 'to@example.com', subject: 'Test email', body: 'Test email body')
@@ -30,7 +30,7 @@ mail.deliver!
 # => #<Mail::Message:2100, Multipart: false, Headers: <Date: Sat, 20 Mar 2021 16:13:05 +0100>, <From: from@example.com>, <To: to@example.com>, <Message-ID: <60561101cd2b5_113b37e4309b5@local.mail>>, <Subject: Test email>, <Mime-Version: 1.0>, <Content-Type: text/plain>, <Content-Transfer-Encoding: 7bit>>
 ```
 
-Then we can check grabbed emails on the web interface. To do that, we need a `config.ru` file with the following content.
+Then we can check the grabbed emails on the web interface. To do that, we need a `config.ru` file with the following content.
 
 ```ruby
 require 'mail_grabber/web'

lib/mail_grabber/database_helper.rb

@@ -18,11 +18,11 @@ module DatabaseHelper
       }
     }.freeze
 
-    # Create connection to the SQLite3 database. Use foreign_keys pragmas that
-    # we can use DELETE CASCADE option. It accepts block to execute queries.
-    # If something goes wrong, then it raises a database helper error.
-    # Also ensure to close the database (important to close database if we don't
-    # want to see database busy errors).
+    # Create a connection to the SQLite3 database. Use foreign_keys pragmas so
+    # that we can use the DELETE CASCADE option. It accepts a block to execute
+    # queries. If something goes wrong, then it raises a database helper error.
+    # Also, ensure to close the database (important to close the database if we
+    # don't want to see database busy errors).
     def connection
       database = open_database
       database.foreign_keys = 'ON'
@@ -34,16 +34,16 @@ def connection
       database&.close
     end
 
-    # Create connection and execute a query.
+    # Create a connection and execute a query.
     #
-    # @param [String] query which query we would like to execute
-    # @param [Array] args any arguments which we will use in the query
+    # @param [String] query which query would we like to execute
+    # @param [Array] args any arguments that we will use in the query
     def connection_execute(query, args = [])
       connection { |db| db.execute(query, args) }
     end
 
-    # Create connection and execute many queries in transaction. It accepts
-    # block to execute queries. If something goes wrong, it rolls back the
+    # Create a connection and execute many queries in a transaction. It accepts
+    # a block to execute queries. If something goes wrong, it rolls back the
     # changes and raises a database helper error.
     def connection_execute_transaction
       connection do |db|
@@ -91,10 +91,10 @@ def select_message_parts_by(id)
     end
 
     # Helper method to get a specific number of messages. We can specify which
-    # part of the table we need and how many messages want to see.
+    # part of the table we need and how many messages we want to see.
     #
     # @param [String/Integer] page which part of the table want to see
-    # @param [String/Integer] per_page how many messages gives back
+    # @param [String/Integer] per_page how many messages give back
     def select_messages_by(page, per_page)
       page = page.to_i
       per_page = per_page.to_i
@@ -130,8 +130,8 @@ def attachment(object)
       object.attachment? ? 1 : 0
     end
 
-    # Convert the given message or body to utf8 string. Needs this that we can
-    # send it as JSON.
+    # Convert the given message or body to utf8 string. Needs this so that we
+    # can send it as JSON.
     #
     # @param [Mail::Message/Mail::Body] object
     #
@@ -151,7 +151,7 @@ def encode_if_attachment(object, string)
       object.attachment? ? Base64.encode64(string) : string
     end
 
-    # Extract cid value from the Mail::Part.
+    # Extract the cid value from the Mail::Part.
     #
     # @param [Mail::Part] object
     #
@@ -170,12 +170,12 @@ def extract_mail_parts(message)
       message.multipart? ? message.all_parts : [message]
     end
 
-    # Extract MIME type of the Mail::Part object. If it is nil, then it returns
-    # with text/plain value.
+    # Extract the MIME type of the Mail::Part object. If it is nil, then it
+    # returns with a text/plain value.
     #
     # @param [Mail::Part] object
     #
-    # @return [String] with MIME type of the part
+    # @return [String] with the MIME type of the part
     def extract_mime_type(object)
       object.mime_type || 'text/plain'
     end
@@ -234,8 +234,8 @@ def insert_into_mail_part(db, message)
       end
     end
 
-    # Open a database connection with the database. Also, it checks that the
-    # database is existing or not. If it does not exist, then it creates a new
+    # Open a database connection with the database. Also, it checks whether the
+    # database exists or not. If it does not exist, then it creates a new
     # one.
     #
     # @return [SQLite3::Database] a database object

lib/mail_grabber/database_queries.rb

@@ -2,9 +2,9 @@
 
 module MailGrabber
   module DatabaseQueries
-    # Create mail table if it is not exist.
+    # Create a mail table if it does not exist.
     #
-    # @param [SQLite3::Database] db to execute create table query
+    # @param [SQLite3::Database] db to execute the create table query
     def create_mail_table(db)
       db.execute(<<-SQL)
         CREATE TABLE IF NOT EXISTS mail (
@@ -20,9 +20,9 @@ def create_mail_table(db)
       SQL
     end
 
-    # Create mail part table if it is not exist.
+    # Create a mail part table if it does not exist.
     #
-    # @param [SQLite3::Database] db to execute create table query
+    # @param [SQLite3::Database] db to execute the create table query
     def create_mail_part_table(db)
       db.execute(<<-SQL)
         CREATE TABLE IF NOT EXISTS mail_part (
@@ -81,7 +81,7 @@ def insert_into_mail_part_query
       SQL
     end
 
-    # Select messages with pagination query.
+    # Select messages with a pagination query.
     #
     # @return [Srting] with the select messages query
     def select_messages_with_pagination_query

lib/mail_grabber/delivery_method.rb

@@ -7,8 +7,8 @@ class DeliveryMethod
     # Initialize MailGrabber delivery method (Rails needs it).
     def initialize(options = {}); end
 
-    # Catch and save messages into the database that we can check those messages
-    # in MailGrabber web application.
+    # Catch and save messages into the database so that we can check those
+    # messages in the MailGrabber web application.
     #
     # @param [Mail::Message] message what we would like to send
     def deliver!(message)
@@ -20,7 +20,7 @@ def deliver!(message)
       store_mail(message)
     end
 
-    # Delivery method settings (needed when run mail.deliver! method).
+    # Delivery method settings (needed when running the mail.deliver! method).
     def settings
       {}
     end