Add rubocop and clean up some code items

Author: h-m-m

.rubocop.yml

@@ -0,0 +1,65 @@
+# 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
+
+plugins:
+- rubocop-capybara
+- rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+# Conveniences because we're using Jekyll
+
+RSpec/DescribeClass:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 15
+
+# end Jekyl-specific choices
+
+# Settings copied over from team preferences for Partner Portal
+
+RSpec/NotToNot:
+  EnforcedStyle: to_not
+
+Capybara/NegationMatcher:
+  EnforcedStyle: not_to
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+RSpec/ExpectChange:
+  # A couple people expressed a preference for block
+  EnforcedStyle: block
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: err
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: consistent
+
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/FirstArgumentIndentation:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+# End team settings from Partner Portal

Gemfile

@@ -1,23 +1,28 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 ruby File.read('.ruby-version').strip
 
 gem 'jekyll', '~> 4.3.0'
-gem 'jekyll-sass-converter', '~> 3.0.0'
-gem 'kramdown-parser-gfm', '~> 1.0'
 gem 'jekyll-redirect-from'
+gem 'jekyll-sass-converter', '~> 3.0.0'
 gem 'jekyll-sitemap'
+gem 'kramdown-parser-gfm', '~> 1.0'
 
 group :development, :test do
   gem 'pry-byebug'
+  gem 'rubocop', require: false
+  gem 'rubocop-capybara', require: false
+  gem 'rubocop-rspec', require: false
 end
 
 group :test do
   gem 'capybara'
   gem 'html-proofer', '~> 4.0'
   gem 'nokogiri', '>= 1.10.5'
-  gem 'rackup' # required for `Capybara.server = :webrick`
   gem 'rack-jekyll'
+  gem 'rackup' # required for `Capybara.server = :webrick`
   gem 'rspec'
   gem 'rspec_junit_formatter', require: false
   gem 'selenium-webdriver'

Gemfile.lock

@@ -3,6 +3,7 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
     base64 (0.3.0)
     bigdecimal (3.1.8)
     byebug (12.0.0)
@@ -66,10 +67,13 @@ GEM
       jekyll (>= 3.7, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
+    json (2.12.2)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
     liquid (4.0.4)
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
@@ -84,8 +88,12 @@ GEM
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.26.3)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
+    prism (1.4.0)
     pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -127,6 +135,27 @@ GEM
     rspec-support (3.13.1)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.76.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-capybara (2.22.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
     rubyzip (2.4.1)
     safe_yaml (1.0.5)
     sass-embedded (1.80.6)
@@ -167,6 +196,9 @@ DEPENDENCIES
   rackup
   rspec
   rspec_junit_formatter
+  rubocop
+  rubocop-capybara
+  rubocop-rspec
   selenium-webdriver
 
 RUBY VERSION

_config.yml

@@ -44,10 +44,13 @@ exclude:
   - .sass-cache/
   - .jekyll-cache/
   - assets/scss
+  - bin
   - gemfiles/
   - Gemfile
   - Gemfile.lock
   - node_modules/
+  - scripts
+  - spec
   - vendor/bundle/
   - vendor/cache/
   - vendor/gems/

_plugins/content_code.rb

@@ -1,25 +1,37 @@
+# frozen_string_literal: true
+
 require 'rouge'
 
 # Include tabindex for accessibility reasons
 # See: https://github.com/rouge-ruby/rouge?tab=readme-ov-file#formatters
-class Rouge::Formatters::HTMLPygmentsA11y < Rouge::Formatters::HTMLPygments
-  def stream(tokens, &b)
-    yield %(<div class="highlight"><pre class="#{@css_class}" tabindex="0"><code>)
-    @inner.stream(tokens, &b)
-    yield "</code></pre></div>"
+module Rouge
+  module Formatters
+    class HTMLPygmentsA11y < Rouge::Formatters::HTMLPygments
+      def stream(tokens, &)
+        yield %(<div class="highlight"><pre class="#{@css_class}" tabindex="0"><code>)
+        @inner.stream(tokens, &)
+        yield '</code></pre></div>'
+      end
+    end
   end
 end
 
-class Rouge::Formatters::HTMLLegacyA11y < Rouge::Formatters::HTMLLegacy
-  def initialize(opts={})
-    @formatter = opts[:inline_theme] ? Rouge::Formatters::HTMLInline.new(opts[:inline_theme])
-               : Rouge::Formatters::HTML.new
+module Rouge
+  module Formatters
+    class HTMLLegacyA11y < Rouge::Formatters::HTMLLegacy
+      def initialize(opts = {}) # rubocop:disable Lint/MissingSuper
+        @formatter = if opts[:inline_theme]
+                       Rouge::Formatters::HTMLInline.new(opts[:inline_theme])
+                     else
+                       Rouge::Formatters::HTML.new
+                     end
 
+        @formatter = Rouge::Formatters::HTMLTable.new(@formatter, opts) if opts[:line_numbers]
 
-    @formatter = Rouge::Formatters::HTMLTable.new(@formatter, opts) if opts[:line_numbers]
+        return unless opts.fetch(:wrap, true)
 
-    if opts.fetch(:wrap, true)
-      @formatter = Rouge::Formatters::HTMLPygmentsA11y.new(@formatter, opts.fetch(:css_class, 'codehilite'))
+        @formatter = Rouge::Formatters::HTMLPygmentsA11y.new(@formatter, opts.fetch(:css_class, 'codehilite'))
+      end
     end
   end
 end

_plugins/content_typography.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module Kramdown
   module Parser
     class Kramdown
+      # rubocop:disable Naming/MethodParameterName
       prepend(Module.new do
         def add_link(el, *args)
           add_link_class!(el) if el.type == :a
-          super(el, *args)
+          super
         end
 
         def parse_autolink
@@ -17,6 +20,7 @@ def add_link_class!(el)
           el.attr['class'] = [*el.attr['class'], 'usa-link'].join(' ')
         end
       end)
+      # rubocop:enable Naming/MethodParameterName
     end
   end
 end

_plugins/copy_to_destination.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Jekyll
   module CopyToDestination
     class CopyGenerator < Generator
-      def generate(site)
+      def generate(site) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
         folders = site.config['copy_to_destination'] || []
 
         static_files = folders.map do |relative_path|

_plugins/pretty_jsonify.rb

@@ -1,13 +1,11 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module LoginGov
   module PrettyJsonify
     def pretty_jsonify(input)
-      json = if input.kind_of?(String)
-        JSON.parse(input)
-      else
-        json
-      end
+      json = JSON.parse(input) if input.is_a?(String)
 
       JSON.pretty_generate(json)
     end

_plugins/yaml_content_disposition.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'webrick'
 
 module Jekyll
   module Commands
     class Serve
       class Servlet < WEBrick::HTTPServlet::FileHandler
         prepend(Module.new do
-          def do_GET(req, res)
+          def do_GET(req, res) # rubocop:disable Naming/MethodName
             res.header.merge!('Content-Disposition' => 'attachment') if req.path.end_with?('.yml')
             super
           end

scripts/htmlproofer

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # Run HTMLProofer via Ruby so we can do advanced things like ignore bad peer certificates which turn
 # up in external links.
 require 'html-proofer'
@@ -22,7 +24,7 @@ proofer_options.merge!(
   typhoeus: {
     ssl_verifypeer: false,
     ssl_verifyhost: 0,
-    followlocation: false,
+    followlocation: false
   },
   swap_urls: {
     "http://localhost:#{site_config['port']}" => 'https://developers.login.gov'
@@ -39,7 +41,6 @@ proofer.before_request do |request|
   # Some URLs behave differently if `accept-language` header is not included. Remove this in the
   # future if it's no longer needed.
   request.options[:headers]['Accept-Language'] = '*'
-  
 end
 
 proofer.run