Use rubocop autocorrect and modify the code

Author: mziyut

.github/workflows/test.yml

@@ -25,3 +25,13 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - run: bundle exec rspec
+
+  rubocop:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.1"
+          bundler-cache: true
+      - run: bundle exec rubocop

.rubocop.yml

@@ -1,14 +1,3 @@
-# The behavior of RuboCop can be controlled via the .rubocop.yml
-# configuration file. It makes it possible to enable/disable
-# certain cops (checks) and to alter their behavior if they accept
-# any parameters. The file can be placed either in your home
-# directory or in some project directory.
-#
-# RuboCop will start looking for the configuration file in the directory
-# where the inspected file is and continue its way up to the root directory.
-#
-# See https://docs.rubocop.org/rubocop/configuration
-
 inherit_from: .rubocop_todo.yml
 
 require:

.rubocop_todo.yml

@@ -1,86 +1,23 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --exclude-limit 99999`
-# on 2022-10-12 03:59:15 UTC using RuboCop version 1.36.0.
+# on 2022-10-12 04:57:08 UTC using RuboCop version 1.36.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
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/DeprecatedAttributeAssignment:
-  Exclude:
-    - 'ruboty-github.gemspec'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
-# Include: **/*.gemspec
-Gemspec/OrderedDependencies:
-  Exclude:
-    - 'ruboty-github.gemspec'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequireMFA:
-  Exclude:
-    - 'ruboty-github.gemspec'
-
 # Offense count: 1
 # Configuration parameters: Include.
 # Include: **/*.gemspec
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'ruboty-github.gemspec'
 
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: leading, trailing
-Layout/DotPosition:
-  Exclude:
-    - 'spec/ruboty/handlers/github_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Width, AllowedPatterns, IgnoredPatterns.
-Layout/IndentationWidth:
-  Exclude:
-    - 'lib/ruboty/github/actions/create_deploy_pull_request.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
-# SupportedStyles: space, no_space
-# SupportedStylesForEmptyBraces: space, no_space
-Layout/SpaceInsideBlockBraces:
-  Exclude:
-    - 'lib/ruboty/github/actions/base.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: final_newline, final_blank_line
-Layout/TrailingEmptyLines:
-  Exclude:
-    - 'Rakefile'
-
 # Offense count: 1
 Lint/UnreachableCode:
   Exclude:
     - 'lib/ruboty/github/actions/close_issue.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
-Lint/UnusedBlockArgument:
-  Exclude:
-    - 'lib/ruboty/github/actions/base.rb'
-
 # Offense count: 1
 # Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
@@ -89,7 +26,7 @@ Metrics/AbcSize:
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 15
+  Max: 14
 
 # Offense count: 2
 # Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
@@ -103,22 +40,6 @@ Naming/PredicateName:
     - 'lib/ruboty/github/actions/base.rb'
     - 'lib/ruboty/github/actions/close_issue.rb'
 
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: PreferredName.
-Naming/RescuedExceptionsVariableName:
-  Exclude:
-    - 'lib/ruboty/github/actions/close_issue.rb'
-    - 'lib/ruboty/github/actions/create_issue.rb'
-    - 'lib/ruboty/github/actions/create_pull_request.rb'
-    - 'lib/ruboty/github/actions/search_issues.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Performance/ConstantRegexp:
-  Exclude:
-    - 'lib/ruboty/handlers/github.rb'
-
 # Offense count: 3
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
@@ -139,12 +60,6 @@ RSpec/NoExpectationExample:
   Exclude:
     - 'spec/ruboty/handlers/github_spec.rb'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/CollectionCompact:
-  Exclude:
-    - 'lib/ruboty/github/actions/base.rb'
-
 # Offense count: 9
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
@@ -161,134 +76,6 @@ Style/Documentation:
     - 'lib/ruboty/github/actions/search_issues.rb'
     - 'lib/ruboty/handlers/github.rb'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Style/EmptyCaseCondition:
-  Exclude:
-    - 'lib/ruboty/github/actions/base.rb'
-    - 'lib/ruboty/github/actions/close_issue.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/ExpandPathArguments:
-  Exclude:
-    - 'ruboty-github.gemspec'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowedVars.
-Style/FetchEnvVar:
-  Exclude:
-    - 'lib/ruboty/github/actions/base.rb'
-
-# Offense count: 16
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'lib/ruboty/github.rb'
-    - 'lib/ruboty/github/actions/base.rb'
-    - 'lib/ruboty/github/actions/close_issue.rb'
-    - 'lib/ruboty/github/actions/create_deploy_pull_request.rb'
-    - 'lib/ruboty/github/actions/create_issue.rb'
-    - 'lib/ruboty/github/actions/create_pull_request.rb'
-    - 'lib/ruboty/github/actions/merge_pull_request.rb'
-    - 'lib/ruboty/github/actions/remember.rb'
-    - 'lib/ruboty/github/actions/search_issues.rb'
-    - 'lib/ruboty/github/version.rb'
-    - 'lib/ruboty/handlers/github.rb'
-    - 'ruboty-github.gemspec'
-    - 'spec/ruboty/handlers/github_spec.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
-Style/GuardClause:
-  Exclude:
-    - 'lib/ruboty/github/actions/create_deploy_pull_request.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/IfUnlessModifier:
-  Exclude:
-    - 'lib/ruboty/github/actions/create_deploy_pull_request.rb'
-
-# Offense count: 3
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: literals, strict
-Style/MutableConstant:
-  Exclude:
-    - 'lib/ruboty/github/actions/base.rb'
-    - 'lib/ruboty/github/version.rb'
-    - 'lib/ruboty/handlers/github.rb'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'lib/ruboty/handlers/github.rb'
-    - 'spec/ruboty/handlers/github_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/PerlBackrefs:
-  Exclude:
-    - 'lib/ruboty/github/actions/create_deploy_pull_request.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: implicit, explicit
-Style/RescueStandardError:
-  Exclude:
-    - 'lib/ruboty/github/actions/close_issue.rb'
-    - 'lib/ruboty/github/actions/create_issue.rb'
-    - 'lib/ruboty/github/actions/create_pull_request.rb'
-    - 'lib/ruboty/github/actions/search_issues.rb'
-
-# Offense count: 109
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'Rakefile'
-    - 'lib/ruboty/github.rb'
-    - 'lib/ruboty/github/actions/base.rb'
-    - 'lib/ruboty/github/actions/close_issue.rb'
-    - 'lib/ruboty/github/actions/create_deploy_pull_request.rb'
-    - 'lib/ruboty/github/actions/create_issue.rb'
-    - 'lib/ruboty/github/actions/create_pull_request.rb'
-    - 'lib/ruboty/github/actions/search_issues.rb'
-    - 'lib/ruboty/github/version.rb'
-    - 'lib/ruboty/handlers/github.rb'
-    - 'ruboty-github.gemspec'
-    - 'spec/ruboty/handlers/github_spec.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 13
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArguments:
-  Exclude:
-    - 'lib/ruboty/handlers/github.rb'
-    - 'spec/ruboty/handlers/github_spec.rb'
-
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInHashLiteral:
-  Exclude:
-    - 'lib/ruboty/github/actions/base.rb'
-    - 'spec/ruboty/handlers/github_spec.rb'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.

CHANGELOG.md

@@ -2,6 +2,7 @@
 - Add `search issues` command
 - Support test on GitHub Actions
 - Add rubocop, rubocop-rake, rubocop-performance, rubocop-rspec gems
+- Use rubocop autocorrect and modify the code
 
 ## 0.2.3
 - Fix typo

Gemfile

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

Rakefile

@@ -1,2 +1,3 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'

lib/ruboty/github.rb

@@ -1,14 +1,16 @@
-require "active_support/core_ext/string/strip"
-require "octokit"
+# frozen_string_literal: true
 
-require "ruboty"
-require "ruboty/github/actions/base"
-require "ruboty/github/actions/close_issue"
-require "ruboty/github/actions/create_issue"
-require "ruboty/github/actions/create_pull_request"
-require "ruboty/github/actions/create_deploy_pull_request"
-require "ruboty/github/actions/merge_pull_request"
-require "ruboty/github/actions/remember"
-require "ruboty/github/actions/search_issues"
-require "ruboty/github/version"
-require "ruboty/handlers/github"
+require 'active_support/core_ext/string/strip'
+require 'octokit'
+
+require 'ruboty'
+require 'ruboty/github/actions/base'
+require 'ruboty/github/actions/close_issue'
+require 'ruboty/github/actions/create_issue'
+require 'ruboty/github/actions/create_pull_request'
+require 'ruboty/github/actions/create_deploy_pull_request'
+require 'ruboty/github/actions/merge_pull_request'
+require 'ruboty/github/actions/remember'
+require 'ruboty/github/actions/search_issues'
+require 'ruboty/github/version'
+require 'ruboty/handlers/github'

lib/ruboty/github/actions/base.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Ruboty
   module Github
     module Actions
       class Base
-        NAMESPACE = "github"
+        NAMESPACE = 'github'
 
         attr_reader :message
 
@@ -17,7 +19,7 @@ def access_tokens
         end
 
         def body
-          message[:description] || ""
+          message[:description] || ''
         end
 
         def sender_name
@@ -45,14 +47,14 @@ def repository
         end
 
         def client_options
-          client_options_with_nil_value.reject {|key, value| value.nil? }
+          client_options_with_nil_value.compact
         end
 
         def client_options_with_nil_value
           {
             access_token: access_token,
             api_endpoint: api_endpoint,
-            web_endpoint: web_endpoint,
+            web_endpoint: web_endpoint
           }
         end
 
@@ -66,11 +68,10 @@ def api_endpoint
 
         # @note GITHUB_HOST will be deprecated on the next major version
         def github_base_url
-          case
-          when ENV["GITHUB_BASE_URL"]
-            ENV["GITHUB_BASE_URL"]
-          when ENV["GITHUB_HOST"]
-            "https://#{ENV['GITHUB_HOST']}"
+          if ENV.fetch('GITHUB_BASE_URL', nil)
+            ENV.fetch('GITHUB_BASE_URL', nil)
+          elsif ENV.fetch('GITHUB_HOST', nil)
+            "https://#{ENV.fetch('GITHUB_HOST', nil)}"
           end
         end
       end