Rubocop

Author: RISCfuture

.github/workflows/ruby.yml

@@ -33,3 +33,24 @@ jobs:
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - name: Run unit tests
         run: bundle exec rake
+
+  linters:
+    name: Linters
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.1"
+          bundler-cache: true
+      - name: Run Rubocop
+        run: |
+          gem install rubocop-rspec rubocop-performance
+          git clone https://gist.github.com/65e21b9e8b0d1db285dcb4fc627b98fa.git .rubocop
+          cp .rubocop/.rubocop.yml .rubocop-ruby.yml
+          git clone https://gist.github.com/14cfa24d53c12bf385871e9b93b95c37.git .rubocop-rspec
+          cp .rubocop-rspec/.rubocop-rspec.yml .
+          cat .rubocop.yml | sed -e 's/~\/.rubocop/.rubocop/' | sed -e 's/.rubocop.yml/.rubocop-ruby.yml/' > .rubocop2.yml
+          mv .rubocop2.yml .rubocop.yml
+          rubocop --parallel

.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_from:
+  - ~/.rubocop.yml
+  - ~/.rubocop-rspec.yml
+
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
+    - Environments
+
+AllCops:
+  Exclude:
+    - "*.gemspec" # temporarily until we move off of juweiler

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'activerecord'

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 begin

lib/url_validation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'addressable/uri'
 require 'httpi'
 require 'active_support/core_ext/hash/except'
@@ -171,7 +173,7 @@ def url_accessible?(uri, options)
 
     check_host = options[:check_host]
     check_host ||= %w[http https] if options[:check_path]
-    if (schemes = Array.wrap(check_host)) && schemes.all? { |scheme| scheme.kind_of?(String) } && !schemes.include?(uri.scheme)
+    if (schemes = Array.wrap(check_host)) && schemes.all?(String) && !schemes.include?(uri.scheme)
       return true
     end
 
@@ -194,7 +196,7 @@ def http_url_accessible?(uri, options)
   def url_response_valid?(response, options)
     return true unless response.kind_of?(HTTPI::Response) && options[:check_path]
 
-    response_codes = options[:check_path] == true ? [400..499, 500..599] : Array.wrap(options[:check_path]).flatten
+    response_codes = (options[:check_path] == true) ? [400..499, 500..599] : Array.wrap(options[:check_path]).flatten
     return response_codes.none? do |code| # it's good if it's not a bad response
       case code # and it's a bad response if...
         when Range

spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause

spec/url_validator_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'active_model'
 
@@ -13,21 +15,21 @@ class Record
   end
 
   context '[basic]' do
-    it "should allow nil if :allow_nil is set" do
+    it "allows nil if :allow_nil is set" do
       @validator = described_class.new(attributes: %i[field], allow_nil: true)
       @validator.validate_each(@record, :field, nil)
       expect(@record.errors).to be_empty
     end
 
-    it "should allow \"\" if :allow_blank is set" do
+    it "allows '' if :allow_blank is set" do
       @validator = described_class.new(attributes: %i[field], allow_blank: true)
       @validator.validate_each(@record, :field, "")
       expect(@record.errors).to be_empty
     end
   end
 
   context '[format]' do
-    it "should only allow HTTP URLs if :scheme is set to 'http'" do
+    it "only allows HTTP URLs if :scheme is set to 'http'" do
       @validator = described_class.new(attributes: %i[field], scheme: 'http')
       @validator.validate_each(@record, :field, 'http://www.apple.com')
       expect(@record.errors).to be_empty
@@ -36,7 +38,7 @@ class Record
       expect(@record.errors[:field].first).to include('invalid_url')
     end
 
-    it "should only allow HTTP and HTTPS URLs if :scheme is set to %w(http https)" do
+    it "onlies allow HTTP and HTTPS URLs if :scheme is set to %w(http https)" do
       @validator = described_class.new(attributes: %i[field], scheme: %w[http https])
       @validator.validate_each(@record, :field, 'http://www.apple.com')
       expect(@record.errors).to be_empty
@@ -47,14 +49,14 @@ class Record
       expect(@record.errors[:field].first).to include('invalid_url')
     end
 
-    it "should try a default scheme if :default_scheme is set" do
+    it "tries a default scheme if :default_scheme is set" do
       @validator = described_class.new(attributes: %i[field], scheme: 'http', default_scheme: 'http')
       @validator.validate_each(@record, :field, 'www.apple.com')
       expect(@record.errors).to be_empty
     end
 
     context '[HTTP(S)]' do
-      it "should not allow garbage URLs that still somehow pass the ridiculously open-ended RFC" do
+      it "does not allow garbage URLs that still somehow pass the ridiculously open-ended RFC" do
         @validator = described_class.new(attributes: %i[field])
 
         %w[
@@ -70,7 +72,7 @@ class Record
         end
       end
 
-      it "should not allow invalid scheme formats" do
+      it "does not allow invalid scheme formats" do
         @validator = described_class.new(attributes: %i[field])
         @validator.validate_each(@record, :field, ' https://www.apple.com')
         expect(@record.errors[:field].first).to include('invalid_url')
@@ -80,7 +82,7 @@ class Record
 
   context '[accessibility]' do
     context '[:check_host]' do
-      it "should only validate if the host is accessible when :check_host is set" do
+      it "only validates if the host is accessible when :check_host is set" do
         @validator = described_class.new(attributes: %i[field])
         @validator.validate_each(@record, :field, 'http://www.invalid.tld')
         expect(@record.errors).to be_empty
@@ -90,25 +92,25 @@ class Record
         expect(@record.errors[:field].first).to include('url_not_accessible')
       end
 
-      it "should not perform the accessibility check if :check_host is set to 'http' and the URL scheme is not HTTP" do
+      it "does not perform the accessibility check if :check_host is set to 'http' and the URL scheme is not HTTP" do
         @validator = described_class.new(attributes: %i[field], check_host: 'http')
         @validator.validate_each(@record, :field, 'https://www.invalid.tld')
         expect(@record.errors).to be_empty
       end
 
-      it "should only validate if the host is accessible when :check_host is set to 'http' and the URL scheme is HTTP" do
+      it "only validates if the host is accessible when :check_host is set to 'http' and the URL scheme is HTTP" do
         @validator = described_class.new(attributes: %i[field], check_host: 'http')
         @validator.validate_each(@record, :field, 'http://www.invalid.tld')
         expect(@record.errors[:field].first).to include('url_not_accessible')
       end
 
-      it "should not perform the accessibility check if :check_host is set to %w(http https) and the URL scheme is not HTTP(S)" do
+      it "does not perform the accessibility check if :check_host is set to %w(http https) and the URL scheme is not HTTP(S)" do
         @validator = described_class.new(attributes: %i[field], check_host: %w[http https], scheme: %w[ftp http https])
         @validator.validate_each(@record, :field, 'ftp://www.invalid.tld')
         expect(@record.errors).to be_empty
       end
 
-      it "should only validate if the host is accessible when :check_host is set to %w(http https) and the URL scheme is HTTP(S)" do
+      it "only validates if the host is accessible when :check_host is set to %w(http https) and the URL scheme is HTTP(S)" do
         @validator = described_class.new(attributes: %i[field], check_host: %w[http https])
         @validator.validate_each(@record, :field, 'http://www.invalid.tld')
         expect(@record.errors[:field].first).to include('url_not_accessible')
@@ -118,15 +120,15 @@ class Record
         expect(@record.errors[:field].first).to include('url_not_accessible')
       end
 
-      it "should only validate the host" do
+      it "only validates the host" do
         @validator = described_class.new(attributes: %i[field], check_host: true)
         @validator.validate_each(@record, :field, 'http://www.google.com/sdgsdgf')
         expect(@record.errors).to be_empty
       end
     end
 
     context '[:check_path]' do
-      it "should not validate if the response code is equal to the Integer value of this option" do
+      it "does not validate if the response code is equal to the Integer value of this option" do
         @validator = described_class.new(attributes: %i[field], check_path: 404)
         @validator.validate_each(@record, :field, 'http://www.google.com/sdgsdgf')
         expect(@record.errors[:field].first).to include('url_invalid_response')
@@ -138,7 +140,7 @@ class Record
         expect(@record.errors[:field]).to be_empty
       end
 
-      it "should not validate if the response code is equal to the Symbol value of this option" do
+      it "does not validate if the response code is equal to the Symbol value of this option" do
         @validator = described_class.new(attributes: %i[field], check_path: :not_found)
         @validator.validate_each(@record, :field, 'http://www.google.com/sdgsdgf')
         expect(@record.errors[:field].first).to include('url_invalid_response')
@@ -150,7 +152,7 @@ class Record
         expect(@record.errors[:field]).to be_empty
       end
 
-      it "should not validate if the response code is within the Range value of this option" do
+      it "does not validate if the response code is within the Range value of this option" do
         @validator = described_class.new(attributes: %i[field], check_path: 400..499)
         @validator.validate_each(@record, :field, 'http://www.google.com/sdgsdgf')
         expect(@record.errors[:field].first).to include('url_invalid_response')
@@ -162,7 +164,7 @@ class Record
         expect(@record.errors[:field]).to be_empty
       end
 
-      it "should not validate if the response code is equal to the Integer value contained in the Array value of this option" do
+      it "does not validate if the response code is equal to the Integer value contained in the Array value of this option" do
         @validator = described_class.new(attributes: %i[field], check_path: [404, 405])
         @validator.validate_each(@record, :field, 'http://www.google.com/sdgsdgf')
         expect(@record.errors[:field].first).to include('url_invalid_response')
@@ -174,7 +176,7 @@ class Record
         expect(@record.errors[:field]).to be_empty
       end
 
-      it "should not validate if the response code is equal to the Symbol value contained in the Array value of this option" do
+      it "does not validate if the response code is equal to the Symbol value contained in the Array value of this option" do
         @validator = described_class.new(attributes: %i[field], check_path: %i[not_found unauthorized])
         @validator.validate_each(@record, :field, 'http://www.google.com/sdgsdgf')
         expect(@record.errors[:field].first).to include('url_invalid_response')
@@ -186,7 +188,7 @@ class Record
         expect(@record.errors[:field]).to be_empty
       end
 
-      it "should not validate if the response code is equal to the Range value contained in the Array value of this option" do
+      it "does not validate if the response code is equal to the Range value contained in the Array value of this option" do
         @validator = described_class.new(attributes: %i[field], check_path: [400..499, 500..599])
         @validator.validate_each(@record, :field, 'http://www.google.com/sdgsdgf')
         expect(@record.errors[:field].first).to include('url_invalid_response')
@@ -198,37 +200,37 @@ class Record
         expect(@record.errors[:field]).to be_empty
       end
 
-      it "should skip validation by default" do
+      it "skips validation by default" do
         @validator = described_class.new(attributes: %i[field], check_path: nil)
         @validator.validate_each(@record, :field, 'http://www.google.com/sdgsdgf')
         expect(@record.errors[:field]).to be_empty
       end
 
-      it "should not validate 4xx and 5xx response codes if the value is true" do
+      it "does not validate 4xx and 5xx response codes if the value is true" do
         @validator = described_class.new(attributes: %i[field], check_path: true)
         @validator.validate_each(@record, :field, 'http://www.google.com/sdgsdgf')
         expect(@record.errors[:field].first).to include('url_invalid_response')
       end
 
-      it "should skip validation for non-HTTP URLs" do
+      it "skips validation for non-HTTP URLs" do
         @validator = described_class.new(attributes: %i[field], check_path: true, scheme: %w[ftp http https])
         @validator.validate_each(@record, :field, 'ftp://ftp.sdgasdgohaodgh.com/sdgjsdg')
         expect(@record.errors[:field]).to be_empty
       end
     end
 
     context '[:httpi_adapter]' do
-      it "should use the specified HTTPI adapter" do
+      it "uses the specified HTTPI adapter" do
         @validator = described_class.new(attributes: %i[field], httpi_adapter: :curl, check_host: true)
         expect(HTTPI).to receive(:get).once.with(an_instance_of(HTTPI::Request), :curl).and_return(false)
         @validator.validate_each(@record, :field, 'http://www.google.com/sdgsdgf')
       end
     end
 
     context '[:request_callback]' do
-      it "should be yielded the HTTPI request" do
+      it "is yielded the HTTPI request" do
         called     = false
-        @validator = described_class.new(attributes: %i[field], check_host: true, request_callback: ->(request) { called = true; expect(request).to be_kind_of(HTTPI::Request) })
+        @validator = described_class.new(attributes: %i[field], check_host: true, request_callback: ->(request) { called = true; expect(request).to be_a(HTTPI::Request) })
         @validator.validate_each(@record, :field, 'http://www.google.com/sdgsdgf')
         expect(called).to be(true)
       end