- Refactor with rubocop

Author: DannyBen

.github/workflows/test.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
-      matrix: { ruby: ['2.7', '3.0', '3.1'] }
+      matrix: { ruby: ['2.7', '3.0', '3.1', head] }
 
     steps:
     - name: Checkout code

.rubocop.yml

@@ -0,0 +1,19 @@
+inherit_gem:
+  rentacop: rentacop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'debug.rb'
+    - 'dev/**/*'
+
+# Allow `set_compline_vars` here, it is more readable
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/completely/tester.rb'
+
+# Allow long lines in specs and commands
+Layout/LineLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/completely/commands/**/*'

Gemfile

@@ -1,7 +1,8 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gem 'byebug'
 gem 'lp'
+gem 'rentacop'
 gem 'rspec'
 gem 'rspec_approvals'
 gem 'runfile'

bin/completely

@@ -8,9 +8,8 @@ runner = Completely::CLI.runner
 
 begin
   exit runner.run ARGV
-
 rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
   say! "!undred!#{e.class}!txtrst!\n#{e.message}"
   exit 1
-end
+end

bin/console

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
-require "irb"
-require "irb/completion" 
-require "completely"
+require 'irb'
+require 'irb/completion'
+require 'completely'
 
 include Completely
 
-IRB.start
+IRB.start

completely.gemspec

@@ -1,22 +1,22 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'date'
 require 'completely/version'
 
 Gem::Specification.new do |s|
   s.name        = 'completely'
   s.version     = Completely::VERSION
-  s.date        = Date.today.to_s
-  s.summary     = "Bash Completions Generator"
-  s.description = "Generate bash completion scripts using simple YAML configuration"
-  s.authors     = ["Danny Ben Shitrit"]
+  s.summary     = 'Bash Completions Generator'
+  s.description = 'Generate bash completion scripts using simple YAML configuration'
+  s.authors     = ['Danny Ben Shitrit']
   s.email       = 'db@dannyben.com'
   s.files       = Dir['README.md', 'lib/**/*.*']
   s.executables = ['completely']
   s.homepage    = 'https://github.com/dannyben/completely'
   s.license     = 'MIT'
-  s.required_ruby_version = ">= 2.7.0"
+  s.required_ruby_version = '>= 2.7.0'
 
   s.add_runtime_dependency 'colsole', '~> 0.6'
   s.add_runtime_dependency 'mister_bin', '~> 0.7'
+
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

lib/completely/cli.rb

@@ -9,8 +9,8 @@ module Completely
   class CLI
     def self.runner
       runner = MisterBin::Runner.new version: Completely::VERSION,
-        header: "Completely - Bash Completions Generator",
-        footer: "Run !txtpur!completely COMMAND --help!txtrst! for more information"
+        header: 'Completely - Bash Completions Generator',
+        footer: 'Run !txtpur!completely COMMAND --help!txtrst! for more information'
 
       runner.route 'init',      to: Commands::Init
       runner.route 'preview',   to: Commands::Preview

lib/completely/commands/base.rb

@@ -3,22 +3,21 @@
 module Completely
   module Commands
     class Base < MisterBin::Command
-
       class << self
         def param_config_path
-          param "CONFIG_PATH", "Path to the YAML configuration file [default: completely.yaml]\nCan also be set by an environment variable"
+          param 'CONFIG_PATH', "Path to the YAML configuration file [default: completely.yaml]\nCan also be set by an environment variable"
         end
 
         def option_function
-          option "-f --function NAME", "Modify the name of the function in the generated script"
+          option '-f --function NAME', 'Modify the name of the function in the generated script'
         end
 
         def environment_config_path
-          environment "COMPLETELY_CONFIG_PATH", "Path to a completely configuration file [default: completely.yaml]"
+          environment 'COMPLETELY_CONFIG_PATH', 'Path to a completely configuration file [default: completely.yaml]'
         end
 
         def environment_debug
-          environment "COMPLETELY_DEBUG", "It not empty, the generated script will include an additional debugging snippet that outputs the compline and current word to a text file when a completion is requested"
+          environment 'COMPLETELY_DEBUG', 'It not empty, the generated script will include an additional debugging snippet that outputs the compline and current word to a text file when a completion is requested'
         end
       end
 
@@ -46,7 +45,7 @@ def config_basename
 
       def syntax_warning
         say! "\n!txtred!WARNING:\nYour configuration is invalid."
-        say! "!txtred!All patterns must start with the same word."
+        say! '!txtred!All patterns must start with the same word.'
       end
     end
   end

lib/completely/commands/generate.rb

@@ -3,19 +3,19 @@
 module Completely
   module Commands
     class Generate < Base
-      help "Generate the bash completion script to a file"
+      help 'Generate the bash completion script to a file'
 
-      usage "completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]"
-      usage "completely generate (-h|--help)"
+      usage 'completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]'
+      usage 'completely generate (-h|--help)'
 
       option_function
-      option "-w --wrap NAME", "Wrap the completion script inside a function that echos the script. This is useful if you wish to embed it directly in your script"
+      option '-w --wrap NAME', 'Wrap the completion script inside a function that echos the script. This is useful if you wish to embed it directly in your script'
 
       param_config_path
-      param "OUTPUT_PATH", "Path to the output bash script. When not provided, the name of the input file will be used with a .bash extension\nCan also be set by an environment variable"
+      param 'OUTPUT_PATH', "Path to the output bash script. When not provided, the name of the input file will be used with a .bash extension\nCan also be set by an environment variable"
 
       environment_config_path
-      environment "COMPLETELY_OUTPUT_PATH", "Path to the output bash script"
+      environment 'COMPLETELY_OUTPUT_PATH', 'Path to the output bash script'
       environment_debug
 
       def run
@@ -31,7 +31,6 @@ def run
       def wrapper_function(wrapper_name)
         completions.wrapper_function wrapper_name
       end
-
     end
   end
 end

lib/completely/commands/init.rb

@@ -3,21 +3,19 @@
 module Completely
   module Commands
     class Init < Base
-      help "Create a new sample YAML configuration file"
+      help 'Create a new sample YAML configuration file'
 
-      usage "completely init [CONFIG_PATH]"
-      usage "completely init (-h|--help)"
+      usage 'completely init [CONFIG_PATH]'
+      usage 'completely init (-h|--help)'
 
       param_config_path
       environment_config_path
 
       def run
-        if File.exist? config_path
-          raise "File already exists: #{config_path}"
-        else
-          File.write config_path, sample
-          say "Saved !txtpur!#{config_path}"
-        end
+        raise "File already exists: #{config_path}" if File.exist? config_path
+
+        File.write config_path, sample
+        say "Saved !txtpur!#{config_path}"
       end
 
     private
@@ -27,9 +25,8 @@ def sample
       end
 
       def sample_path
-        @sample_path ||= File.expand_path "../templates/sample.yaml", __dir__
+        @sample_path ||= File.expand_path '../templates/sample.yaml', __dir__
       end
-
     end
   end
 end