mail_grabber 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf29f819e44c0b82ba7194db668acfda148ff75d29bb917d740c29e06679e538
-  data.tar.gz: e5245767ecd0f2d8a03addb7188a114fac0fe33ca755f5712a49b280a29c25e9
+  metadata.gz: aea5e39deacb823607303c62537b8eced611a1e121f3c0f098532b4aba5c2914
+  data.tar.gz: 8921cffcefaa54d1238acfdc5a1d8977d5ea45093470817a4829fec4fc2e850c
 SHA512:
-  metadata.gz: f893d4eef0f1dad96f06095e1e6d7bb68d13824681b051411883ba8a666894318c9d4efd3d61355403c8553e0c117b5b6e2eaea444956daed5ff6877420650eb
-  data.tar.gz: a63622f5775d3645bf0af9cd558fc4e77def84186ba259e30956582a6b8becf498835cbb2fa0f25921fb047e219eb5ab9ed0e168af27c0f11a63ce9ec039c61b
+  metadata.gz: 176f7dcea3dd597e1b9a7ef0178e60f6e457dc08a9bba0655c7a722ab944b659eb5ec02aef67840e48169d386a550b66272e36e0f71c1d1d1d37ea99f3fd0d27
+  data.tar.gz: f89030ad607b1bd7ae29377b7c1adcaceb3cc9d78d3cc439f28e8c27a9ac20cb2568ecaea5e41809352cd1d39fd2f430a1a7f5c7038dcb99c8f8f6af56c0e1ec

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change log
 
+## 1.2.0 (2022-05-26)
+
+### Changes
+
+* Drop Ruby 2.6 support.
+* Fix some grammar issues and typos.
+* Update bundler and gems.
+
+
 ## 1.1.0 (2021-12-31)
 
 ### Changes

data/lib/mail_grabber/database_helper.rb

@@ -20,9 +20,9 @@ module MailGrabber
 
     # 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 raise database helper error.
-    # Also ensure to close the database (important to close database if we are
-    # don't want to see database busy errors).
+    # 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).
     def connection
       database = open_database
       database.foreign_keys = 'ON'
@@ -43,8 +43,8 @@ module MailGrabber
     end
 
     # Create connection and execute many queries in transaction. It accepts
-    # block to execute queries. If something goes wrong it rolls back the
-    # changes and raise database helper error.
+    # 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|
         db.transaction
@@ -158,8 +158,8 @@ module MailGrabber
       object.cid if object.respond_to?(:cid)
     end
 
-    # Extract all parts from the Mail::Message object. If it is not multipart
-    # then it returns back with original object in an Array.
+    # Extract all parts from the Mail::Message object. If it is not multipart,
+    # then it returns with the original object in an Array.
     #
     # @param [Mail::Message] message
     #
@@ -168,7 +168,7 @@ module MailGrabber
       message.multipart? ? message.all_parts : [message]
     end
 
-    # Extract MIME type of the Mail::Part object. If it is nil then it returns
+    # Extract MIME type of the Mail::Part object. If it is nil, then it returns
     # with text/plain value.
     #
     # @param [Mail::Part] object
@@ -228,8 +228,9 @@ module MailGrabber
       end
     end
 
-    # Open a database connection with the database. Also it checks that the
-    # database is exist or not. If it does not exist then it creates a new one.
+    # 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
+    # one.
     #
     # @return [SQLite3::Database] a database object
     def open_database

data/lib/mail_grabber/delivery_method.rb

@@ -20,7 +20,7 @@ module MailGrabber
       store_mail(message)
     end
 
-    # Delivery method settings (needed when run mail.deliver! method)
+    # Delivery method settings (needed when run mail.deliver! method).
     def settings
       {}
     end

data/lib/mail_grabber/error.rb

@@ -2,10 +2,10 @@
 
 module MailGrabber
   class Error < StandardError
-    # Specific error class for errors if database error happen
+    # Specific error class for errors if database error happen.
     class DatabaseHelperError < Error; end
 
-    # Specific error class for errors if parameter is not given
+    # Specific error class for errors if parameter is not given.
     class WrongParameter < Error; end
   end
 end

data/lib/mail_grabber/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailGrabber
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/mail_grabber/web/application.rb

@@ -13,7 +13,7 @@ module MailGrabber
       attr_reader :request, :response
 
       # Method to call MailGrabber::Web::Application. This method will call the
-      # initialize method and returns back with response of the application.
+      # initialize method and returns with response of the application.
       #
       # @param [Hash] env the environment variables
       #
@@ -23,7 +23,7 @@ module MailGrabber
         new(env).response.finish
       end
 
-      # Initialize web application request and response then process the given
+      # Initialize web application request and response, then process the given
       # request.
       #
       # @param [Hash] env the environment variables
@@ -34,7 +34,7 @@ module MailGrabber
         process_request
       end
 
-      # Extract env['PATH_INFO'] value. If the path info is empty then it will
+      # Extract env['PATH_INFO'] value. If the path info is empty, then it will
       # return with root path.
       #
       # @return [String] path the requested path or the root path if this value
@@ -43,7 +43,7 @@ module MailGrabber
         @path ||= request.path_info.empty? ? '/' : request.path_info
       end
 
-      # This method returns back with extracted request parameters.
+      # This method returns with extracted request parameters.
       #
       # @return [Hash] params
       def params
@@ -64,12 +64,12 @@ module MailGrabber
         request.script_name
       end
 
-      # Parse the routes of the ApplicationRouter and tries to find matching
+      # Parse the routes of the ApplicationRouter and tries to find a matching
       # route for the request method, which was defined in the
-      # get, post, put, patch or delete blocks. If the 'extracted_params' is nil
-      # then it could not found any defined routes. If it can find a defined
-      # route then it saves the params and call the given block. If it cannot
-      # find anything then it will set response with 404 Not Found.
+      # get, post, put, patch or delete blocks. If the 'extracted_params' is
+      # nil, then it could not find any defined routes. If it can find a defined
+      # route, then it saves the params and call the given block. If it cannot
+      # find anything, then it will set the response with 404 Not Found.
       def process_request
         self.class.routes[request_method].each do |route|
           extracted_params = route.extract_params(path)

data/lib/mail_grabber/web/application_helper.rb

@@ -4,7 +4,7 @@ module MailGrabber
   module Web
     # Helper module for views
     module ApplicationHelper
-      # This method helps us that e.g. we can load style or javascript files
+      # This method helps us that e.g. we can load style or JavaScript files
       # when we are running this application standalone or in Ruby on Rails.
       def root_path
         script_name.to_s

data/lib/mail_grabber/web/application_router.rb

@@ -9,13 +9,13 @@ module MailGrabber
 
       Route =
         Struct.new(:pattern, :block) do
-          # Extract parameters from the given path. All routes has a
+          # Extract parameters from the given path. All routes have a
           # path pattern which helps to the router to find which block it should
-          # execute. If path contains request parameters like '/test/1' then
-          # it will match with the '/test/:id' pattern. In this case it will
+          # execute. If the path contains request parameters like '/test/1' then
+          # it will match with the '/test/:id' pattern. In this case, it will
           # return with '{"id" => "1"}' hash. If it is just a simple path like
-          # '/' and it has a pattern to match then it will return with '{}'.
-          # In the other case it will return with nil.
+          # '/' and it has a pattern to match, then it will return with '{}'.
+          # In the other case, it will return with nil.
           #
           # @param [String] path
           #

data/lib/mail_grabber/web/assets/javascripts/application.js

@@ -85,7 +85,7 @@ var MailGrabberApplication = {
 
   /**
    * Initialize MailGrabber. Add some event listeners to the Reload and the
-   * Clear tabs then load messages and the default background.
+   * Clear tabs, then load messages and the default background.
    */
   init: function() {
     document

data/lib/mail_grabber/web/assets/javascripts/dom.js

@@ -1,8 +1,8 @@
 var MailGrabberDOM = {
   /**
-   * Change which content (message part) should show. When the page is loading
+   * Change which content (message part) should show. When the page is loading,
    * the HTML content will be active and the others will be hidden. When we
-   * click on tab e.g. Plain Text then this content will active and other
+   * click on tab e.g. Plain Text then this content will be active and other
    * hidden.
    *
    * @param {Object} event - which part we clicked
@@ -33,9 +33,9 @@ var MailGrabberDOM = {
   },
 
   /**
-   * Create a clone from an element e.g. template tag.
+   * Create a clone from an element, e.g. template tag.
    *
-   * @param {String} selector - which describe how find the element
+   * @param {String} selector - which describe how to find the element
    *
    * @return {Object} the clone of the found element
    */
@@ -44,7 +44,7 @@ var MailGrabberDOM = {
   },
 
   /**
-   * Show default backgroud image instead of any content.
+   * Show default background image instead of any content.
    */
   defaultBackground: function() {
     var messageContent =
@@ -62,7 +62,7 @@ var MailGrabberDOM = {
 
   /**
    * Delete all content (message list and message content as well),
-   * set default backgroud and the infinite scroll params when we click on
+   * set default background and the infinite scroll params when we click on
    * the Reload or Delete tabs.
    */
   deleteContent: function() {
@@ -76,7 +76,7 @@ var MailGrabberDOM = {
   },
 
   /**
-   * Root path which returns back with the server's root path. It can be empty
+   * Root path, which returns with the server's root path. It can be an empty
    * string or a string. It depends on how the server is running (standalone
    * or in Ruby on Rails).
    */

data/lib/mail_grabber/web/assets/javascripts/message_content.js

@@ -82,7 +82,7 @@ var MailGrabberMessageContent = {
 
   /**
    * Render the content of the message (all parts, inline attachments and
-   * attachments). Also it sets up event listeners of the HTML, PlainText,
+   * attachments). Also, it sets up event listeners of the HTML, PlainText,
    * Raw, Delete and Close tabs.
    *
    * @param {Object} response - the response of the get message request

data/lib/mail_grabber/web/assets/javascripts/message_html_part.js

@@ -1,6 +1,6 @@
 var MailGrabberMessageHtmlPart = {
   /**
-   * Render the HTML part of the message. If the message has inline images
+   * Render the HTML part of the message. If the message has inline images,
    * then it will render those images as well. An iframe will contain this
    * content.
    *

data/lib/mail_grabber/web/assets/javascripts/message_list.js

@@ -36,7 +36,7 @@ var MailGrabberMessageList = {
 
   /**
    * Render the list of the messages. Also add event listener when click on a
-   * message then it will load that conent.
+   * message then it will load that content.
    *
    * @param {Object} messages - the list of the given message.
    */

data/lib/mail_grabber/web/assets/javascripts/variables.js

@@ -17,7 +17,7 @@ var MailGrabberVariables = {
 
   /**
    * Params that we can follow how many messages we have on the list. We are
-   * loading 15 messages in every requests.
+   * loading 15 messages in every request.
    */
   page: 1,
   perPage: 15

data/lib/mail_grabber/web/assets/javascripts/web.js

@@ -1,6 +1,6 @@
 (function() {
   /**
-   * When DOM loaded then call MailGrabber's init function.
+   * When DOM loaded, then call MailGrabber's init function.
    */
   document.addEventListener('DOMContentLoaded', MailGrabberApplication.init);
 })();

data/lib/mail_grabber/web.rb

@@ -14,7 +14,8 @@ module MailGrabber
   module Web
     module_function
 
-    # Method which build a Rack application and run the Web::Application
+    # Method which build a Rack application and run the
+    # MailGrabber::Web::Application.
     def app
       @app ||= Rack::Builder.new do
         use Rack::Static,

data/lib/mail_grabber.rb

@@ -3,6 +3,6 @@
 require 'mail_grabber/error'
 require 'mail_grabber/database_helper'
 require 'mail_grabber/delivery_method'
-# If we are using this gem outside of Rails then do not load this code.
+# If we are using this gem outside of Rails, then do not load this code.
 require 'mail_grabber/railtie' if defined?(Rails)
 require 'mail_grabber/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_grabber
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Norbert Szivós
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-31 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -111,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="