Merge pull request #16979 from Homebrew/rspec-cleanup

Enable and fix RSpec/DescribedClassModuleWrapping

Library/.rubocop.yml

@@ -230,19 +230,12 @@ RSpec/AnyInstance:
   Enabled: false
 RSpec/DescribeClass:
   Enabled: false
-RSpec/FilePath:
-  Enabled: false
 RSpec/SpecFilePathFormat:
   Enabled: false
 RSpec/StubbedMock:
   Enabled: false
 RSpec/SubjectStub:
   Enabled: false
-
-# We use `allow(:foo).to receive(:bar)` everywhere.
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-
 # These were ever-growing numbers, not useful.
 RSpec/ExampleLength:
   Enabled: false
@@ -253,9 +246,16 @@ RSpec/NestedGroups:
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
 
+RSpec/DescribedClassModuleWrapping:
+  Enabled: true
+RSpec/FilePath:
+  SpecSuffixOnly: true
 # Annoying to have these autoremoved.
 RSpec/Focus:
   AutoCorrect: false
+# We use `allow(:foo).to receive(:bar)` everywhere.
+RSpec/MessageSpies:
+  EnforcedStyle: receive
 
 # Try getting rid of these.
 Sorbet/ConstantsFromStrings:

Library/Homebrew/formula_auditor.rb

@@ -3,6 +3,7 @@
 
 require "deprecate_disable"
 require "formula_text_auditor"
+require "formula_versions"
 require "resource_auditor"
 
 module Homebrew

Library/Homebrew/test/cask/download_spec.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-module Cask
+RSpec.describe Cask::Download, :cask do
-  RSpec.describe Download, :cask do
   describe "#verify_download_integrity" do
     subject(:verification) { described_class.new(cask).verify_download_integrity(downloaded_path) }
 
-      let(:cask) { instance_double(Cask, token: "cask", sha256: expected_sha256) }
+    let(:cask) { instance_double(Cask::Cask, token: "cask", sha256: expected_sha256) }
     let(:cafebabe) { "cafebabecafebabecafebabecafebabecafebabecafebabecafebabecafebabe" }
     let(:deadbeef) { "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef" }
     let(:computed_sha256) { cafebabe }
@@ -55,5 +54,4 @@ module Cask
       end
     end
   end
-  end
 end

Library/Homebrew/test/formula_free_port_spec.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require "socket"
-require "formula_free_port"
-
-module Homebrew
-  RSpec.describe FreePort do
-    include described_class
-
-    describe "#free_port" do
-      it "returns a free TCP/IP port" do
-        # IANA suggests user port from 1024 to 49151
-        # and dynamic port for 49152 to 65535
-        # http://www.iana.org/assignments/port-numbers
-        min_port = 1024
-        max_port = 65535
-        port = free_port
-
-        expect(port).to be_between(min_port, max_port)
-        expect { TCPServer.new(port).close }.not_to raise_error
-      end
-    end
-  end
-end

Library/Homebrew/test/formula_text_auditor_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "formula_text_auditor"
+
+RSpec.describe Homebrew::FormulaTextAuditor do
+  alias_matcher :have_trailing_newline, :be_trailing_newline
+
+  let(:dir) { mktmpdir }
+
+  def formula_text(name, body = nil)
+    path = dir/"#{name}.rb"
+
+    path.write <<~RUBY
+      class #{Formulary.class_s(name)} < Formula
+        #{body}
+      end
+    RUBY
+
+    described_class.new(path)
+  end
+
+  specify "simple valid Formula" do
+    ft = formula_text "valid", <<~RUBY
+      url "https://www.brew.sh/valid-1.0.tar.gz"
+    RUBY
+
+    expect(ft).to have_trailing_newline
+
+    expect(ft =~ /\burl\b/).to be_truthy
+    expect(ft.line_number(/desc/)).to be_nil
+    expect(ft.line_number(/\burl\b/)).to eq(2)
+    expect(ft).to include("Valid")
+  end
+
+  specify "#trailing_newline?" do
+    ft = formula_text "newline"
+    expect(ft).to have_trailing_newline
+  end
+end

Library/Homebrew/test/free_port_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "socket"
+require "formula_free_port"
+
+RSpec.describe Homebrew::FreePort do
+  include described_class
+
+  describe "#free_port" do
+    it "returns a free TCP/IP port" do
+      # IANA suggests user port from 1024 to 49151
+      # and dynamic port for 49152 to 65535
+      # http://www.iana.org/assignments/port-numbers
+      min_port = 1024
+      max_port = 65535
+      port = free_port
+
+      expect(port).to be_between(min_port, max_port)
+      expect { TCPServer.new(port).close }.not_to raise_error
+    end
+  end
+end

Library/Homebrew/test/rubocops/exec_shell_metacharacters_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rubocops/shell_commands"
+
+RSpec.describe RuboCop::Cop::Homebrew::ExecShellMetacharacters do
+  subject(:cop) { described_class.new }
+
+  context "when auditing exec calls" do
+    it "reports aan offense when output piping is used" do
+      expect_offense(<<~RUBY)
+        fork do
+          exec "foo bar > output"
+               ^^^^^^^^^^^^^^^^^^ Homebrew/ExecShellMetacharacters: Don't use shell metacharacters in `exec`. Implement the logic in Ruby instead, using methods like `$stdout.reopen`.
+        end
+      RUBY
+    end
+
+    it "reports no offenses when no metacharacters are used" do
+      expect_no_offenses(<<~RUBY)
+        fork do
+          exec "foo bar"
+        end
+      RUBY
+    end
+  end
+end

Library/Homebrew/test/rubocops/shell_commands_spec.rb

@@ -2,10 +2,7 @@
 
 require "rubocops/shell_commands"
 
-module RuboCop
+RSpec.describe RuboCop::Cop::Homebrew::ShellCommands do
-  module Cop
-    module Homebrew
-      ::RSpec.describe ShellCommands do
   subject(:cop) { described_class.new }
 
   context "when auditing shell commands" do
@@ -211,30 +208,4 @@ module RuboCop
       RUBY
     end
   end
-      end
-
-      ::RSpec.describe ExecShellMetacharacters do
-        subject(:cop) { described_class.new }
-
-        context "when auditing exec calls" do
-          it "reports aan offense when output piping is used" do
-            expect_offense(<<~RUBY)
-              fork do
-                exec "foo bar > output"
-                     ^^^^^^^^^^^^^^^^^^ Homebrew/ExecShellMetacharacters: Don't use shell metacharacters in `exec`. Implement the logic in Ruby instead, using methods like `$stdout.reopen`.
-              end
-            RUBY
-          end
-
-          it "reports no offenses when no metacharacters are used" do
-            expect_no_offenses(<<~RUBY)
-              fork do
-                exec "foo bar"
-              end
-            RUBY
-          end
-        end
-      end
-    end
-  end
 end