- Refactor with rubocop

Author: DannyBen

.github/workflows/test.yml

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

.rubocop.yml

@@ -0,0 +1,32 @@
+inherit_gem:
+  rentacop: rentacop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+
+# We allow `$stderr.puts` in a command line
+Style/StderrPuts:
+  Exclude:
+    - 'lib/madness/command_line.rb'
+
+# FIXME: These files have some complexities
+Metrics/PerceivedComplexity:
+  Exclude:
+    - lib/madness/command_line.rb
+
+# FIXME: These files have some complexities
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/madness/command_line.rb
+
+# FIXME: These files have some complexities
+Metrics/AbcSize:
+  Exclude:
+    - lib/madness/command_line.rb
+
+# FIXME: The `set_config` method needs to be renamed without conflicting
+#        with `config`
+Naming/AccessorMethodName:
+  Exclude:
+    - lib/madness/command_line.rb

Gemfile

@@ -1,26 +1,23 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-group :development do
+# gem 'jekyll'
 
-  # gem 'jekyll'
+# This gem is for local GitHub pages development, but it conflicts with
+# CmomonMarker (it requires a lower version than we need)
+# gem 'github-pages', group: :jekyll_plugins
 
-  # This gem is for local GitHub pages development, but it conflicts with
-  # CmomonMarker (it requires a lower version than we need)
-  # gem 'github-pages', group: :jekyll_plugins
-
-  gem 'byebug'
-  gem 'lp'
-  gem 'rack-test'
-  gem 'rdoc'
-  gem 'rspec'
-  gem 'rspec-html-matchers'
-  gem 'rspec_approvals'
-  gem 'runfile'
-  gem 'runfile-tasks'
-  gem 'sasstool'
-  gem 'simplecov'
-  gem 'yard'
-
-end
+gem 'byebug'
+gem 'lp'
+gem 'rack-test'
+gem 'rdoc'
+gem 'rentacop'
+gem 'rspec'
+gem 'rspec_approvals'
+gem 'rspec-html-matchers'
+gem 'runfile'
+gem 'runfile-tasks'
+gem 'sasstool'
+gem 'simplecov'
+gem 'yard'
 
 gemspec

bin/console

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
-require "irb"
-require "irb/completion" # easy tab completion
-require "madness"
+require 'irb'
+require 'irb/completion' # easy tab completion
+require 'madness'
 
 include Madness
 
-IRB.start
+IRB.start

bin/madness

@@ -10,4 +10,4 @@ rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
   say! "!undred!#{e.class}!txtrst!\n#{e.message}"
   exit 1
-end
+end

lib/madness.rb

@@ -6,4 +6,3 @@
 require 'requires'
 
 requires 'madness/refinements', 'madness/server_helper', 'madness'
-

lib/madness/breadcrumbs.rb

@@ -1,34 +1,35 @@
 module Madness
-
   # Handle breadcumbs generation by converting a path to an array
   # of links
   class Breadcrumbs
     using StringRefinements
-    
+
     attr_reader :path
 
     def initialize(path)
       @path = path
     end
 
     def links
-      path == "" ? [] : get_breadcrumbs
+      path == '' ? [] : breadcrumbs
     end
 
   private
 
-    def get_breadcrumbs
-      home = OpenStruct.new({ label: "Home", href: '/' })
+    def breadcrumbs
+      home = OpenStruct.new({ label: 'Home', href: '/' })
       result = breadcrumbs_maker(path).reverse.unshift home
       result.last.last = true
       result
     end
 
     def breadcrumbs_maker(partial_path)
       parent, basename = File.split partial_path
-      item = OpenStruct.new({
-        label: basename.to_label,
-        href: "/#{partial_path}" }
+      item = OpenStruct.new(
+        {
+          label: basename.to_label,
+          href:  "/#{partial_path}",
+        }
       )
       result = [item]
       result += breadcrumbs_maker parent unless parent == '.'

lib/madness/browser.rb

@@ -7,7 +7,8 @@ class Browser
     attr_reader :host, :port
 
     def initialize(host, port)
-      @host, @port = host, port
+      @host = host
+      @port = port
     end
 
     # Returns a URL based on host, port and MADNESS_FORCE_SSL.
@@ -51,7 +52,7 @@ def open
 
     # Runs the appropriate command (based on OS) to open a browser.
     def open!
-      system *open_command, err: File::NULL, in: File::NULL, out: File::NULL
+      system(*open_command, err: File::NULL, in: File::NULL, out: File::NULL)
     end
 
     # Returns the appropriate command (based on OS) to open a browser.

lib/madness/command_line.rb

@@ -4,16 +4,15 @@
 require 'docopt'
 
 module Madness
-
   # Handle command line execution. Used by bin/madness.
   class CommandLine
     include Singleton
     include Colsole
 
     # Process ARGV by putting it through docopt
-    def execute(argv=[])
+    def execute(argv = [])
       doc = File.read File.expand_path('docopt.txt', __dir__)
-      
+
       begin
         args = Docopt.docopt(doc, argv: argv, version: VERSION)
         handle args
@@ -49,7 +48,7 @@ def launch_server_with_options(args)
     # and static files folder.
     def launch_server
       unless File.directory? config.path
-        STDERR.puts "Invalid path (#{config.path})" 
+        $stderr.puts "Invalid path (#{config.path})"
         return
       end
 
@@ -61,7 +60,7 @@ def launch_server
     # Get the arguments as provided by docopt, and set them to our own
     # config object.
     def set_config(args)
-      config.path         = args['PATH']   if args['PATH']
+      config.path         = args['PATH'] if args['PATH']
       config.port         = args['--port'].to_i if args['--port']
       config.bind         = args['--bind'] if args['--bind']
       config.toc          = args['--toc']  if args['--toc']
@@ -76,7 +75,7 @@ def set_config(args)
       config.copy_code    = false   if args['--no-copy-code']
       config.shortlinks   = true    if args['--shortlinks']
       config.open         = true    if args['--open']
-      
+
       config.theme = File.expand_path(args['--theme'], config.path) if args['--theme']
     end
 
@@ -105,7 +104,7 @@ def create_theme(path)
       end
     end
 
-    # Say hello to everybody when the server starts, showing the known 
+    # Say hello to everybody when the server starts, showing the known
     # config.
     def show_status
       say_status :start, 'the madness'
@@ -115,7 +114,7 @@ def show_status
       say_status :use, config.filename if config.file_exist?
       say_status :theme, config.theme, :txtblu if config.theme
 
-      say "-" * 60
+      say '-' * 60
     end
 
     # Generate the table of contents file

lib/madness/directory.rb

@@ -9,7 +9,7 @@ class Directory
     def initialize(dir)
       @dir = dir
     end
-    
+
     def list
       @list ||= (dirs + files)
     end
@@ -18,9 +18,8 @@ def list
 
     def files
       result = Dir["#{dir}/#{config.dir_glob}"]
-      result.reject! do |f| 
-        basename = File.basename(f)
-        basename == 'README.md' or basename == 'index.md'
+      result.reject! do |f|
+        ['README.md', 'index.md'].include? File.basename(f)
       end
       result.nat_sort.map { |path| Item.new path, :file }
     end
@@ -33,6 +32,7 @@ def dirs
 
     def exclude?(path)
       return false unless config.exclude.is_a? Array
+
       basename = File.basename path
       config.exclude.each do |pattern|
         return true if basename =~ Regexp.new(pattern)
@@ -43,6 +43,5 @@ def exclude?(path)
     def config
       @config ||= Settings.instance
     end
-
   end
 end