Switch to Standard for linting (#37)

jgarber623 · web-flow · commit e464e005dffa · 2023-11-26T22:42:05.000-05:00
* Remove RuboCop, add Standard

* Update Lint job to use Standard

* Add Git ignore blames file

* Standard: Style/StringLiterals

* Address additional Layout rules

* Address Style/QuotedSymbols warnings

* Additional linting updates

* Update ignored revisions file
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1,12 @@
+# Since git version 2.23, git-blame has a feature to ignore certain commits.
+#
+# This file contains a list of commits that are not likely what you are looking
+# for in `git blame`. You can set this file as a default ignore file for blame
+# by running the following command:
+#
+# $ git config blame.ignoreRevsFile .git-blame-ignore-revs
+
+c7f71425322c9f2e1b279ac5fa3a075fbd8ddc22
+1cae17eba50450ded5189de3fb5a59eed225b5a8
+604b1d7de4709812f393980acd773318265d2c06
+ae980701869802ee34dc4134d7d74246f7788db8
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -16,7 +16,7 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-      - run: bundle exec rubocop
+      - run: bundle exec standardrb
   test:
     name: Test
     runs-on: ubuntu-latest
diff --git a/.gitignore b/.gitignore
@@ -13,6 +13,10 @@
 # Used by dotenv library to load environment variables.
 # .env
 
+# Ignore history files.
+.irb_history
+.rdbg_history
+
 # Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
@@ -33,5 +37,5 @@ Gemfile.lock
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
-# Ignore cached RuboCop configuration files
-/.rubocop-*
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
diff --git a/.rubocop.yml b/.rubocop.yml
diff --git a/.simplecov b/.simplecov
@@ -3,7 +3,7 @@
 formatters = SimpleCov::Formatter.from_env(ENV)
 
 if RSpec.configuration.files_to_run.length > 1
-  require 'simplecov-console'
+  require "simplecov-console"
 
   formatters << SimpleCov::Formatter::Console
 end
diff --git a/.standard.yml b/.standard.yml
@@ -0,0 +1,2 @@
+format: progress
+parallel: true
diff --git a/Gemfile b/Gemfile
@@ -1,18 +1,14 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify gem's dependencies in webmention.gemspec
 gemspec
 
-gem 'debug'
-gem 'rake'
-gem 'rspec'
-gem 'rubocop'
-gem 'rubocop-packaging'
-gem 'rubocop-performance'
-gem 'rubocop-rake'
-gem 'rubocop-rspec'
-gem 'simplecov'
-gem 'simplecov-console'
-gem 'webmock'
+gem "debug"
+gem "rake"
+gem "rspec"
+gem "simplecov"
+gem "simplecov-console"
+gem "standard"
+gem "webmock"
diff --git a/Rakefile b/Rakefile
@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new
 
diff --git a/lib/webmention.rb b/lib/webmention.rb
@@ -1,24 +1,24 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
-require 'http'
-require 'indieweb/endpoints'
-require 'nokogiri'
+require "http"
+require "indieweb/endpoints"
+require "nokogiri"
 
-require_relative 'webmention/version'
+require_relative "webmention/version"
 
-require_relative 'webmention/client'
-require_relative 'webmention/url'
-require_relative 'webmention/request'
-require_relative 'webmention/response'
-require_relative 'webmention/error_response'
-require_relative 'webmention/verification'
+require_relative "webmention/client"
+require_relative "webmention/url"
+require_relative "webmention/request"
+require_relative "webmention/response"
+require_relative "webmention/error_response"
+require_relative "webmention/verification"
 
-require_relative 'webmention/parser'
-require_relative 'webmention/parsers/html_parser'
-require_relative 'webmention/parsers/json_parser'
-require_relative 'webmention/parsers/plaintext_parser'
+require_relative "webmention/parser"
+require_relative "webmention/parsers/html_parser"
+require_relative "webmention/parsers/json_parser"
+require_relative "webmention/parsers/plaintext_parser"
 
 module Webmention
   # Retrieve unique URLs mentioned by the provided URL.
diff --git a/lib/webmention/client.rb b/lib/webmention/client.rb
@@ -43,7 +43,7 @@ def initialize(source, vouch: nil)
     # :nocov:
     # @return [String]
     def inspect
-      "#<#{self.class}:#{format('%#0x', object_id)} " \
+      "#<#{self.class}:#{format("%#0x", object_id)} " \
         "source_url: #{source_url} " \
         "vouch_url: #{vouch_url}>"
     end
@@ -139,8 +139,10 @@ def request_options_for(target)
         vouch: vouch_url
       }
 
-      opts.transform_values { |value| value.to_s.strip }
-          .delete_if { |_, value| value.empty? }
+      opts.transform_values! { |value| value.to_s.strip }
+      opts.reject! { |_, value| value.empty? }
+
+      opts
     end
   end
 end
diff --git a/lib/webmention/error_response.rb b/lib/webmention/error_response.rb
@@ -27,7 +27,7 @@ def initialize(message, request)
     # :nocov:
     # @return [String]
     def inspect
-      "#<#{self.class}:#{format('%#0x', object_id)} " \
+      "#<#{self.class}:#{format("%#0x", object_id)} " \
         "message: #{message}>"
     end
     # :nocov:
diff --git a/lib/webmention/parsers/html_parser.rb b/lib/webmention/parsers/html_parser.rb
@@ -4,24 +4,24 @@ module Webmention
   module Parsers
     # @api private
     class HtmlParser < Parser
-      @mime_types = ['text/html']
+      @mime_types = ["text/html"]
 
       Client.register_parser(self)
 
       HTML_ATTRIBUTES_MAP = {
-        'cite'   => %w[blockquote del ins q],
-        'data'   => %w[object],
-        'href'   => %w[a area],
-        'poster' => %w[video],
-        'src'    => %w[audio embed img source track video],
-        'srcset' => %w[img source]
+        "cite" => %w[blockquote del ins q],
+        "data" => %w[object],
+        "href" => %w[a area],
+        "poster" => %w[video],
+        "src" => %w[audio embed img source track video],
+        "srcset" => %w[img source]
       }.freeze
 
       CSS_SELECTORS_ARRAY = HTML_ATTRIBUTES_MAP.flat_map do |attribute, names|
         names.map { |name| "#{name}[#{attribute}]" }
       end.freeze
 
-      ROOT_NODE_SELECTORS_ARRAY = ['.h-entry .e-content', '.h-entry', 'body'].freeze
+      ROOT_NODE_SELECTORS_ARRAY = [".h-entry .e-content", ".h-entry", "body"].freeze
 
       private_constant :HTML_ATTRIBUTES_MAP
       private_constant :CSS_SELECTORS_ARRAY
@@ -30,8 +30,9 @@ class HtmlParser < Parser
       # @return [Array<String>] An array of absolute URLs.
       def results
         @results ||=
-          extract_urls_from(*url_attributes).map { |url| response_uri.join(url).to_s }
-                                            .grep(Parser::URI_REGEXP)
+          extract_urls_from(*url_attributes)
+            .map { |url| response_uri.join(url).to_s }
+            .grep(Parser::URI_REGEXP)
       end
 
       private
@@ -46,8 +47,8 @@ def doc
       # @return [Array<String>]
       def extract_urls_from(*attributes)
         attributes.flat_map do |attribute|
-          if attribute.name == 'srcset'
-            attribute.value.split(',').map { |value| value.strip.match(/^\S+/).to_s }
+          if attribute.name == "srcset"
+            attribute.value.split(",").map { |value| value.strip.match(/^\S+/).to_s }
           else
             attribute.value
           end
diff --git a/lib/webmention/parsers/json_parser.rb b/lib/webmention/parsers/json_parser.rb
@@ -4,7 +4,7 @@ module Webmention
   module Parsers
     # @api private
     class JsonParser < Parser
-      @mime_types = ['application/json']
+      @mime_types = ["application/json"]
 
       Client.register_parser(self)
 
diff --git a/lib/webmention/parsers/plaintext_parser.rb b/lib/webmention/parsers/plaintext_parser.rb
@@ -4,7 +4,7 @@ module Webmention
   module Parsers
     # @api private
     class PlaintextParser < Parser
-      @mime_types = ['text/plain']
+      @mime_types = ["text/plain"]
 
       Client.register_parser(self)
 
diff --git a/lib/webmention/request.rb b/lib/webmention/request.rb
@@ -9,8 +9,8 @@ class Request
         max_hops: 20
       },
       headers: {
-        accept: '*/*',
-        user_agent: 'Webmention Client (https://rubygems.org/gems/webmention)'
+        accept: "*/*",
+        user_agent: "Webmention Client (https://rubygems.org/gems/webmention)"
       },
       timeout_options: {
         connect_timeout: 5,
@@ -82,7 +82,7 @@ def initialize(method, url, **options)
     # :nocov:
     # @return [String]
     def inspect
-      "#<#{self.class}:#{format('%#0x', object_id)} " \
+      "#<#{self.class}:#{format("%#0x", object_id)} " \
         "method: #{method.upcase}, " \
         "url: #{uri}>"
     end
@@ -93,8 +93,7 @@ def inspect
     # @return [Webmention::Response, Webmention::ErrorResponse]
     def perform
       Response.new(client.request(method, uri, options), self)
-    rescue HTTP::Error,
-           OpenSSL::SSL::SSLError => e
+    rescue HTTP::Error, OpenSSL::SSL::SSLError => e
       ErrorResponse.new(e.message, self)
     end
 
diff --git a/lib/webmention/response.rb b/lib/webmention/response.rb
@@ -49,7 +49,7 @@ def initialize(response, request)
     # :nocov:
     # @return [String]
     def inspect
-      "#<#{self.class}:#{format('%#0x', object_id)} " \
+      "#<#{self.class}:#{format("%#0x", object_id)} " \
         "code: #{code.inspect}, " \
         "reason: #{reason}, " \
         "url: #{request.uri}>"
diff --git a/lib/webmention/url.rb b/lib/webmention/url.rb
@@ -23,7 +23,7 @@ def initialize(url)
     # :nocov:
     # @return [String]
     def inspect
-      "#<#{self.class}:#{format('%#0x', object_id)} " \
+      "#<#{self.class}:#{format("%#0x", object_id)} " \
         "uri: #{uri}>"
     end
     # :nocov:
diff --git a/lib/webmention/verification.rb b/lib/webmention/verification.rb
@@ -14,7 +14,7 @@ def initialize(source_url, target_url, vouch_url: nil)
     # :nocov:
     # @return [String]
     def inspect
-      "#<#{self.class}:#{format('%#0x', object_id)} " \
+      "#<#{self.class}:#{format("%#0x", object_id)} " \
         "source_url: #{source_url} " \
         "target_url: #{target_url} " \
         "vouch_url: #{vouch_url}>"
diff --git a/lib/webmention/version.rb b/lib/webmention/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Webmention
-  VERSION = '7.0.0'
+  VERSION = "7.0.0"
 end
diff --git a/spec/lib/webmention/error_response_spec.rb b/spec/lib/webmention/error_response_spec.rb
@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 RSpec.describe Webmention::ErrorResponse do
-  subject(:error_response) { described_class.new('foo', request) }
+  subject(:error_response) { described_class.new("foo", request) }
 
   let(:request) { instance_double(Webmention::Request) }
 
   it { is_expected.not_to be_ok }
-  it { is_expected.to have_attributes(message: 'foo', request: request) }
+  it { is_expected.to have_attributes(message: "foo", request: request) }
 end
diff --git a/spec/lib/webmention/parsers/html_parser_results_spec.rb b/spec/lib/webmention/parsers/html_parser_results_spec.rb
@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
-RSpec.describe Webmention::Parsers::HtmlParser, '#results' do
-  subject(:results) { described_class.new(response_body, 'https://jgarber.example/foo').results }
+RSpec.describe Webmention::Parsers::HtmlParser, "#results" do
+  subject(:results) { described_class.new(response_body, "https://jgarber.example/foo").results }
 
-  context 'when response body contains no URLs' do
+  context "when response body contains no URLs" do
     let(:response_body) { load_fixture(:sample_post_no_links) }
 
     it { is_expected.to eq([]) }
   end
 
-  context 'when response body contains URLs within an h-entry' do
+  context "when response body contains URLs within an h-entry" do
     let(:response_body) { load_fixture(:sample_post) }
 
     let(:extracted_urls) do
       [
-        'https://aaronpk.example/post/1',
-        'https://aaronpk.example/post/2',
-        'https://aaronpk.example/post/2',
-        'https://jgarber.example',
-        'https://aaronpk.example/image.jpg',
-        'https://aaronpk.example/image-1x.jpg',
-        'https://aaronpk.example/image-2x.jpg'
+        "https://aaronpk.example/post/1",
+        "https://aaronpk.example/post/2",
+        "https://aaronpk.example/post/2",
+        "https://jgarber.example",
+        "https://aaronpk.example/image.jpg",
+        "https://aaronpk.example/image-1x.jpg",
+        "https://aaronpk.example/image-2x.jpg"
       ]
     end
 
diff --git a/spec/lib/webmention/parsers/json_parser_results_spec.rb b/spec/lib/webmention/parsers/json_parser_results_spec.rb
@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-RSpec.describe Webmention::Parsers::JsonParser, '#results' do
-  subject(:results) { described_class.new(response_body, 'https://jgarber.example/foo').results }
+RSpec.describe Webmention::Parsers::JsonParser, "#results" do
+  subject(:results) { described_class.new(response_body, "https://jgarber.example/foo").results }
 
-  context 'when response body contains no URLs' do
-    let(:response_body) { load_fixture(:sample_post_no_links, 'json') }
+  context "when response body contains no URLs" do
+    let(:response_body) { load_fixture(:sample_post_no_links, "json") }
 
     it { is_expected.to eq([]) }
   end
 
-  context 'when response body contains URLs' do
-    let(:response_body) { load_fixture(:sample_post, 'json') }
+  context "when response body contains URLs" do
+    let(:response_body) { load_fixture(:sample_post, "json") }
 
     let(:extracted_urls) do
       [
-        'https://target.example.com/post/100',
-        'https://target.example.com/post/200',
-        'https://target.example.com/post/100'
+        "https://target.example.com/post/100",
+        "https://target.example.com/post/200",
+        "https://target.example.com/post/100"
       ]
     end
 
diff --git a/spec/lib/webmention/parsers/plaintext_parser_results_spec.rb b/spec/lib/webmention/parsers/plaintext_parser_results_spec.rb
diff --git a/spec/lib/webmention/request_perform_spec.rb b/spec/lib/webmention/request_perform_spec.rb
diff --git a/spec/lib/webmention_mentioned_urls_spec.rb b/spec/lib/webmention_mentioned_urls_spec.rb
diff --git a/spec/lib/webmention_send_webmention_spec.rb b/spec/lib/webmention_send_webmention_spec.rb
diff --git a/spec/lib/webmention_send_webmentions_spec.rb b/spec/lib/webmention_send_webmentions_spec.rb
diff --git a/spec/lib/webmention_verify_webmention_spec.rb b/spec/lib/webmention_verify_webmention_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
diff --git a/spec/support/fixtures_helper.rb b/spec/support/fixtures_helper.rb
diff --git a/webmention.gemspec b/webmention.gemspec
