Merge pull request #48 from razanjoshi/increase_rubocop_coverages

Increase Rubocop coverage

.rubocop.yml

@@ -1,7 +1,9 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   NewCops: enable
-  Include:
-    - '**/Rakefile'
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
 
 Style/Documentation:
   Enabled: false

.rubocop_todo.yml

@@ -0,0 +1,53 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-10-01 18:26:34 UTC using RuboCop version 1.22.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'heartcheck.gemspec'
+
+# Offense count: 3
+# Configuration parameters: IgnoredMethods.
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/lib/heartcheck/caching_app/cache_spec.rb'
+
+# Offense count: 2
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/heartcheck.rb'
+
+# Offense count: 16
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 180
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 29
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'spec/lib/heartcheck/caching_app/cache_spec.rb'
+
+# Offense count: 12
+# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers.
+# SupportedStyles: snake_case, normalcase, non_integer
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
+
+# Offense count: 1
+Security/Open:
+  Exclude:
+    - 'lib/heartcheck/checks/watch_file.rb'

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in heartcheck.gemspec

lib/heartcheck.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Heartcheck
   require 'logger'
   require 'heartcheck/app'
@@ -65,11 +67,11 @@ def add(name, options = {}, &block)
       class_name = options.fetch(:class) { constantize(name) }
       instance = Checks.const_get(class_name).new
 
-      if block_given?
-        checks << instance.tap(&block)
-      else
-        checks << instance
-      end
+      checks << if block_given?
+                  instance.tap(&block)
+                else
+                  instance
+                end
     end
 
     # filter checks that are essential
@@ -90,7 +92,7 @@ def functional_checks
     #
     # @return [Array<Check>] checks that are not functional
     def dev_checks
-      checks.select { |ctx| !ctx.functional? }
+      checks.reject(&:functional?)
     end
 
     # filter checks that has some information
@@ -126,8 +128,8 @@ def executor
     #
     # @return [Heartcheck::Executors::Threaded]
     def use_threaded_executor!
-      require "concurrent"
-      require "heartcheck/executors/threaded"
+      require 'concurrent'
+      require 'heartcheck/executors/threaded'
 
       self.executor = Heartcheck::Executors::Threaded.new
     end
@@ -139,7 +141,7 @@ def use_threaded_executor!
     #
     # @return [Logger] a ruby logger to STDOUT and info level
     def default_logger
-      log = ::Logger.new(STDOUT)
+      log = ::Logger.new($stdout)
       log.level = ::Logger::INFO
       log
     end

lib/heartcheck/app.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'rack'
 require 'heartcheck/controllers/base'
 
-Dir.glob(File.expand_path('../controllers/*.rb', __FILE__))
-  .each { |x| require x }
+Dir.glob(File.expand_path('controllers/*.rb', __dir__)).sort.each { |x| require x }
 
 # A web app that's use rack
 module Heartcheck
@@ -19,7 +20,7 @@ class App
       '/inspect' => Controllers::Inspect,
       '/health_check' => Controllers::HealthCheck,
       '/environment' => Controllers::Environment
-    }
+    }.freeze
 
     # Sets up the rack application.
     #
@@ -58,7 +59,7 @@ def call(env)
     # @return [String] a response body
     def dispatch_action(req)
       controller = ROUTE_TO_CONTROLLER[req.path_info]
-      fail Heartcheck::Errors::RoutingError if controller.nil?
+      raise Heartcheck::Errors::RoutingError if controller.nil?
 
       Logger.info "Start [#{controller}] from #{req.ip} at #{Time.now}"
 

lib/heartcheck/caching_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'heartcheck/caching_app/cache'
 
 # A rack middleware to wrap around {Heartcheck::App} in a cache

lib/heartcheck/caching_app/cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'concurrent'
 
 module Heartcheck

lib/heartcheck/checks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'heartcheck/checks/base'
 require 'heartcheck/checks/firewall'
 require 'heartcheck/checks/process'

lib/heartcheck/checks/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Heartcheck
   module Checks
     # Base check that contains the common functionality for chechs
@@ -9,15 +11,15 @@ class Base
       #
       # @return [Boolean] (default: false)
       attr_accessor :functional
-      alias_method :functional?, :functional
+      alias functional? functional
 
       # When it is true the check will work just for `/dev` route.
       #   you can use it to create some check is not essential/functional for you app.
       #   For example you can execute some performance check.
       #
       # @return [Boolean] (default: false)
       attr_accessor :dev
-      alias_method :dev?, :dev
+      alias dev? dev
 
       # The name for identify the check in the result page
       #
@@ -104,7 +106,6 @@ def add_service(service)
         @services << service
       end
 
-
       # It is used to add a service that will use when check run.
       #
       # @return [Array<Hash>]
@@ -143,7 +144,7 @@ def uri_info
 
       def informations
         info
-      rescue => e
+      rescue StandardError => e
         { 'error' => e.message }
       end
 
@@ -173,9 +174,9 @@ def validation
               validate
             end
           end
-        rescue Heartcheck::Errors::Warning => w
-          @errors = [{ type: 'warning', message: w.message }]
-        rescue => e
+        rescue Heartcheck::Errors::Warning => e
+          @errors = [{ type: 'warning', message: e.message }]
+        rescue StandardError => e
           @errors = [e.message]
         end
         @errors

lib/heartcheck/checks/firewall.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Heartcheck
   module Checks
     class Firewall < Base
@@ -7,12 +9,10 @@ def services
 
       def validate
         services.each do |service|
-          begin
-            Net::Telnet.new(service.params).close
-          rescue Errno::ECONNREFUSED; nil
-          rescue
-            append_error(service)
-          end
+          Net::Telnet.new(service.params).close
+        rescue Errno::ECONNREFUSED; nil
+        rescue StandardError
+          append_error(service)
         end
       end
 

lib/heartcheck/checks/process.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 module Heartcheck
   module Checks
     class Process < Base
       def validate
         services.each do |service|
-          begin
-            pid = get_pid(service)
-            ::Process.kill(0, pid)
-          rescue Errno::ESRCH
-            append_error(service, pid)
-          end
+          pid = get_pid(service)
+          ::Process.kill(0, pid)
+        rescue Errno::ESRCH
+          append_error(service, pid)
         end
       end
 
@@ -19,11 +19,7 @@ def custom_error(service, pid)
       end
 
       def get_pid(service)
-        if service[:pid]
-          service[:pid]
-        else
-          File.read(service[:file]).to_i
-        end
+        service[:pid] || File.read(service[:file]).to_i
       end
     end
   end

lib/heartcheck/checks/watch_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Heartcheck
@@ -9,8 +11,8 @@ def add_service(options)
 
       def validate
         services.each do |service|
-          if not service[:runtime].eql? installed(service[:file])
-            @errors << "App outdated, check /monitoring/info for more details!"
+          unless service[:runtime].eql? installed(service[:file])
+            @errors << 'App outdated, check /monitoring/info for more details!'
           end
         end
       end

lib/heartcheck/controllers/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack'
 require 'multi_json'
 
@@ -7,7 +9,7 @@ module Heartcheck
   module Controllers
     class Base
       def index
-        fail NotImplementError
+        raise NotImplementError
       end
 
       protected
@@ -18,6 +20,7 @@ def check(who)
       end
 
       private
+
       def formatter
         Heartcheck.formatter
       end

lib/heartcheck/controllers/dev.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Heartcheck
   module Controllers
     class Dev < Base
@@ -27,7 +29,7 @@ def index
       def time_diff
         start_time = Time.now
         yield
-        '%.2f ms' % ((Time.now - start_time) * 1_000)
+        format('%.2f ms', ((Time.now - start_time) * 1_000))
       end
     end
   end

lib/heartcheck/controllers/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sys-uname'
 
 module Heartcheck
@@ -6,9 +8,9 @@ class Environment < Base
       def index
         MultiJson.dump(
           {
-            :system_info => Hash[Sys::Uname.uname.each_pair.to_a],
-            :ruby_version => RUBY_VERSION,
-            :rails_version => defined?(Rails) ? Rails::VERSION::STRING : '(none)'
+            system_info: Sys::Uname.uname.each_pair.to_a.to_h,
+            ruby_version: RUBY_VERSION,
+            rails_version: defined?(Rails) ? Rails::VERSION::STRING : '(none)'
           }
         )
       end

lib/heartcheck/controllers/essential.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Heartcheck
   module Controllers
     class Essential < Base

lib/heartcheck/controllers/functional.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Heartcheck
   module Controllers
     class Functional < Base

lib/heartcheck/controllers/health_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Heartcheck
   module Controllers
     class HealthCheck < Base

lib/heartcheck/controllers/info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Heartcheck
   module Controllers
     class Info < Base

lib/heartcheck/controllers/inspect.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Heartcheck
   module Controllers
     class Inspect < Base

lib/heartcheck/errors.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'heartcheck/errors/routing_error'
 require 'heartcheck/errors/warning'

lib/heartcheck/errors/routing_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Heartcheck
   module Errors
     class RoutingError < RuntimeError