- Refactor with rentactop ruleset

Author: DannyBen

.gitignore

@@ -5,7 +5,6 @@
 /doc
 /Gemfile.lock
 /gems
-/rc.md
 /spec/tmp
 /tmp
 /toc.txt

.rubocop.yml

@@ -1,57 +1,37 @@
+require: rubocop-rspec
+
 inherit_gem:
-  google-style: google-style.yml
+  rentacop: rentacop.yml
 
 AllCops:
   TargetRubyVersion: 2.7
 
+# The `ConfigValidator` class is a DSL, give it some complexity leeway
 Metrics/AbcSize:
   Exclude:
   - lib/bashly/config_validator.rb
 
-Metrics/BlockLength:
-  Exclude:
-  - 'spec/**/*_spec.rb'
-
+# (same as previous rule)
 Metrics/CyclomaticComplexity:
   Exclude:
   - lib/bashly/config_validator.rb
 
+# (same as previous rule)
 Metrics/PerceivedComplexity:
   Exclude:
   - lib/bashly/config_validator.rb
 
+# (same as previous rule)
 Metrics/MethodLength:
   Exclude:
   - lib/bashly/config_validator.rb
 
+# Guard clauses are less readable in the case of `ConfigValidator` 
 Style/GuardClause:
   Exclude:
   - lib/bashly/config_validator.rb
 
-Style/RescueStandardError:
-  Exclude:
-  - bin/bashly
-
-Style/MixinUsage:
+# Commands may include long lines
+Layout/LineLength:
   Exclude:
-  - bin/*
-  - spec/spec_helper.rb
-
-Layout/ArgumentAlignment: { Enabled: false }
-Layout/CaseIndentation: { Enabled: false }
-Layout/ElseAlignment: { Enabled: false }
-Layout/EndAlignment: { Enabled: false }
-Layout/IndentationWidth: { Enabled: false }
-Layout/LineLength: { Enabled: false }
-Layout/MultilineMethodCallIndentation: { Enabled: false }
-Lint/ElseLayout: { Enabled: false }
-Lint/NonAtomicFileOperation: { Enabled: false }
-Metrics/ClassLength: { Enabled: false }
-Style/AccessorGrouping: { Enabled: false }
-Style/Documentation: { Enabled: false }
-Style/EmptyElse: { Enabled: false }
-Style/FormatString: { Enabled: false }
-Style/PercentLiteralDelimiters: { Enabled: false }
-Style/SymbolArray: { Enabled: false }
-Style/WordArray: { Enabled: false }
-Style/StringConcatenation: { Enabled: false }
+    - 'lib/bashly/commands/*'

Gemfile

@@ -1,12 +1,14 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "byebug"
-gem "google-style"
-gem "lp"
-gem "rspec"
-gem "rspec_approvals"
-gem "runfile"
-gem "runfile-tasks"
-gem "simplecov"
+gem 'byebug'
+gem 'lp'
+gem 'rentacop', path: '/vagrant/gems/rentacop'
+gem 'rspec'
+gem 'rspec_approvals'
+gem 'rubocop'
+gem 'rubocop-rspec'
+gem 'runfile'
+gem 'runfile-tasks'
+gem 'simplecov'
 
 gemspec

Runfile

@@ -52,35 +52,4 @@ action :examples do
   end
 end
 
-
-command :rubocop
-
-help   "Save RuboCop Inspection Report"
-action :save do |args|
-  say "generating report at rc.md"
-  system "bundle exec rubocop -fm -o rc.md"
-end
-
-help   "Fix a single rule"
-usage  "fix RULE"
-action :fix do |args|
-  rule = args['RULE']
-  say "!txtgrn!fixing #{rule}"
-  system "bundle exec rubocop -a --only #{rule}"
-end
-
-help   "Check all or a single rule"
-usage  "check [RULE]"
-action :check do |args|
-  rule = args['RULE']
-  if rule
-    say "!txtgrn!checking #{rule}"
-    system "bundle exec rubocop --only #{rule}"
-  else
-    system "bundle exec rubocop"
-  end
-end
-
-endcommand
-
 require './debug.rb' if File.exist? 'debug.rb'

bashly.gemspec

@@ -1,34 +1,35 @@
-lib = File.expand_path "lib", __dir__
+lib = File.expand_path 'lib', __dir__
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
-require "bashly/version"
+require 'bashly/version'
 
 Gem::Specification.new do |s|
-  s.name        = "bashly"
+  s.name        = 'bashly'
   s.version     = Bashly::VERSION
-  s.summary     = "Bash Command Line Tool Generator"
-  s.description = "Generate bash command line tools using YAML configuration"
-  s.authors     = ["Danny Ben Shitrit"]
-  s.email       = "db@dannyben.com"
-  s.files       = Dir["README.md", "lib/**/*"]
-  s.executables = ["bashly"]
-  s.homepage    = "https://github.com/dannyben/bashly"
-  s.license     = "MIT"
-  s.required_ruby_version = ">= 2.7.0"
+  s.summary     = 'Bash Command Line Tool Generator'
+  s.description = 'Generate bash command line tools using YAML configuration'
+  s.authors     = ['Danny Ben Shitrit']
+  s.email       = 'db@dannyben.com'
+  s.files       = Dir['README.md', 'lib/**/*']
+  s.executables = ['bashly']
+  s.homepage    = 'https://github.com/dannyben/bashly'
+  s.license     = 'MIT'
+  s.required_ruby_version = '>= 2.7.0'
 
   # Sensitive dependencies, stricter version requirements
-  s.add_runtime_dependency "completely", "~> 0.5.0"
-  s.add_runtime_dependency "gtx", "~> 0.1.0"
+  s.add_runtime_dependency 'completely', '~> 0.5.0'
+  s.add_runtime_dependency 'gtx', '~> 0.1.0'
 
-  s.add_runtime_dependency "colsole", "~> 0.7"
-  s.add_runtime_dependency "filewatcher", "~> 2.0"
-  s.add_runtime_dependency "lp", "~> 0.2"
-  s.add_runtime_dependency "mister_bin", "~> 0.7"
-  s.add_runtime_dependency "requires", "~> 0.2"
+  s.add_runtime_dependency 'colsole', '~> 0.7'
+  s.add_runtime_dependency 'filewatcher', '~> 2.0'
+  s.add_runtime_dependency 'lp', '~> 0.2'
+  s.add_runtime_dependency 'mister_bin', '~> 0.7'
+  s.add_runtime_dependency 'requires', '~> 0.2'
 
   s.metadata = {
-    "bug_tracker_uri"   => "https://github.com/DannyBen/bashly/issues",
-    "changelog_uri"     => "https://github.com/DannyBen/bashly/blob/master/CHANGELOG.md",
-    "homepage_uri"      => "https://bashly.dannyb.co/",
-    "source_code_uri"   => "https://github.com/DannyBen/bashly"
+    'bug_tracker_uri'       => 'https://github.com/DannyBen/bashly/issues',
+    'changelog_uri'         => 'https://github.com/DannyBen/bashly/blob/master/CHANGELOG.md',
+    'homepage_uri'          => 'https://bashly.dannyb.co/',
+    'source_code_uri'       => 'https://github.com/DannyBen/bashly',
+    'rubygems_mfa_required' => 'true',
   }
 end

bin/bashly

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
-require "bashly"
-require "colsole"
+require 'bashly'
+require 'colsole'
 include Colsole
 
 runner = Bashly::CLI.runner
@@ -11,7 +11,7 @@ rescue Bashly::Interrupt
   say! "\nGoodbye"
   exit 1
 rescue => e
-  puts e.backtrace.reverse if ENV["DEBUG"]
+  puts e.backtrace.reverse if ENV['DEBUG']
   say! "!undred!#{e.class}!txtrst!\n#{e.message}"
   exit 1
 end

bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 
-require "irb"
-require "irb/completion"
-require "bashly"
+require 'irb'
+require 'irb/completion'
+require 'bashly'
 
 include Bashly
 

helpers/example.rb

@@ -2,7 +2,7 @@
 class Example
   class << self
     def dirs
-      @dirs ||= Dir["examples/*"].select { |f| File.directory? f }
+      @dirs ||= Dir['examples/*'].select { |f| File.directory? f }
     end
 
     def all
@@ -16,7 +16,7 @@ def executables
 
   attr_reader :dir
 
-  def initialize dir
+  def initialize(dir)
     @dir = dir
   end
 
@@ -45,13 +45,13 @@ def test_commands
     result = File.read(filename)
       .split(/\s*### Try Me ###\s*/).last
       .split("\n")
-      .reject { |line| line.empty? or line.start_with? "#" }
+      .reject { |line| line.empty? or line.start_with? '#' }
     abort "Can't find ### Try Me ### marker in #{filename}" if result.empty?
     result
   end
 
   def test_output
-    result = ""
+    result = ''
     test_commands.each do |command|
       result += "### `$ #{command}`\n\n"
       result += "```shell\n"
@@ -69,9 +69,9 @@ def regenerate_readme
   end
 
   def generated_readme
-    marker = "-----"
+    marker = '-----'
     content = readme.split(marker)[0].strip
-    extra_files = ""
+    extra_files = ''
     if content =~ /<!-- include: (.*) -->/
       included_files = ::Regexp.last_match(1).split
       extra_files = files_markdown included_files
@@ -97,7 +97,7 @@ def generated_readme
     MARKDOWN
   end
 
-  def files_markdown files
+  def files_markdown(files)
     result = []
     files.each do |file|
       lang = markdown_lang file
@@ -110,19 +110,20 @@ def files_markdown files
     result.join "\n"
   end
 
-  def markdown_lang file
+  def markdown_lang(file)
     result = langs[File.extname file]
     raise "Cannot determine language for #{file}" unless result
+
     result
   end
 
   def langs
     @langs ||= {
-      "" => "bash",
-      ".sh" => "bash",
-      ".ini" => "ini",
-      ".yml" => "yaml",
-      ".yaml" => "yaml"
+      ''      => 'bash',
+      '.sh'   => 'bash',
+      '.ini'  => 'ini',
+      '.yml'  => 'yaml',
+      '.yaml' => 'yaml',
     }
   end
 

lib/bashly.rb

@@ -1,17 +1,17 @@
-require "requires"
+require 'requires'
 
-if ENV["BYEBUG"]
-  require "byebug"
-  require "lp"
+if ENV['BYEBUG']
+  require 'byebug'
+  require 'lp'
 end
 
-requires "bashly/concerns"
+requires 'bashly/concerns'
 
-requires "bashly/extensions"
-requires "bashly/settings"
-requires "bashly/exceptions"
-requires "bashly/refinements"
-requires "bashly/script/base"
-requires "bashly/commands/base"
-requires "bashly/libraries/base"
-requires "bashly"
+requires 'bashly/extensions'
+requires 'bashly/settings'
+requires 'bashly/exceptions'
+requires 'bashly/refinements'
+requires 'bashly/script/base'
+requires 'bashly/commands/base'
+requires 'bashly/libraries/base'
+requires 'bashly'

lib/bashly/cli.rb

@@ -1,19 +1,19 @@
-require "mister_bin"
+require 'mister_bin'
 
 module Bashly
   # The CLI class is used by the bashly binary and forwards incoming CLI
   # commands to the relevant Bashly::Commands class
   class CLI
     def self.runner
       runner = MisterBin::Runner.new version: Bashly::VERSION,
-        header: "Bashly - Bash CLI Generator",
+        header: 'Bashly - Bash CLI Generator',
         footer: "Help: !txtpur!bashly COMMAND --help!txtrst!\nDocs: !undblu!https://bashly.dannyb.co"
 
-      runner.route "init",      to: Commands::Init
-      runner.route "preview",   to: Commands::Preview
-      runner.route "validate",  to: Commands::Validate
-      runner.route "generate",  to: Commands::Generate
-      runner.route "add",       to: Commands::Add
+      runner.route 'init',      to: Commands::Init
+      runner.route 'preview',   to: Commands::Preview
+      runner.route 'validate',  to: Commands::Validate
+      runner.route 'generate',  to: Commands::Generate
+      runner.route 'add',       to: Commands::Add
 
       runner
     end