Merge pull request #3091 from GauthamGoli/audit_line_rubocop_part_3

audit: Port line_problems to rubocop and add tests part 3

3 files changed, 279 insertions, 8 deletions

diff --git a/Library/Homebrew/test/rubocops/conflicts_cop_spec.rb b/Library/Homebrew/test/rubocops/conflicts_cop_spec.rb
index 4fbab6c9e..3af0f9669 100644
--- a/Library/Homebrew/test/rubocops/conflicts_cop_spec.rb
+++ b/Library/Homebrew/test/rubocops/conflicts_cop_spec.rb
@@ -22,7 +22,7 @@ describe RuboCop::Cop::FormulaAudit::Conflicts do
                               column: 2,
                               source: source }]
 
-      inspect_source(cop, source)
+      inspect_source(cop, source, "/homebrew-core/Formula/foo@2.0.rb")
 
       expected_offenses.zip(cop.offenses).each do |expected, actual|
         expect_offense(expected, actual)
@@ -36,7 +36,7 @@ describe RuboCop::Cop::FormulaAudit::Conflicts do
           desc 'Bar'
         end
       EOS
-      inspect_source(cop, source)
+      inspect_source(cop, source, "/homebrew-core/Formula/foo@2.0.rb")
       expect(cop.offenses).to eq([])
     end
   end
diff --git a/Library/Homebrew/test/rubocops/formula_desc_cop_spec.rb b/Library/Homebrew/test/rubocops/formula_desc_cop_spec.rb
index 74ce478fb..48342e8bc 100644
--- a/Library/Homebrew/test/rubocops/formula_desc_cop_spec.rb
+++ b/Library/Homebrew/test/rubocops/formula_desc_cop_spec.rb
@@ -37,7 +37,7 @@ describe RuboCop::Cop::FormulaAuditStrict::DescLength do
 
       msg = <<-EOS.undent
         Description is too long. "name: desc" should be less than 80 characters.
-        Length is calculated as Foo + desc. (currently 95)
+        Length is calculated as foo + desc. (currently 95)
       EOS
       expected_offenses = [{ message: msg,
                              severity: :convention,
@@ -45,7 +45,7 @@ describe RuboCop::Cop::FormulaAuditStrict::DescLength do
                              column: 2,
                              source: source }]
 
-      inspect_source(cop, source)
+      inspect_source(cop, source, "/homebrew-core/Formula/foo.rb")
       expected_offenses.zip(cop.offenses).each do |expected, actual|
         expect_offense(expected, actual)
       end
@@ -62,7 +62,7 @@ describe RuboCop::Cop::FormulaAuditStrict::DescLength do
 
       msg = <<-EOS.undent
         Description is too long. "name: desc" should be less than 80 characters.
-        Length is calculated as Foo + desc. (currently 98)
+        Length is calculated as foo + desc. (currently 98)
       EOS
       expected_offenses = [{ message: msg,
                              severity: :convention,
@@ -70,7 +70,7 @@ describe RuboCop::Cop::FormulaAuditStrict::DescLength do
                              column: 2,
                              source: source }]
 
-      inspect_source(cop, source)
+      inspect_source(cop, source, "/homebrew-core/Formula/foo.rb")
       expected_offenses.zip(cop.offenses).each do |expected, actual|
         expect_offense(expected, actual)
       end
@@ -156,7 +156,7 @@ describe RuboCop::Cop::FormulaAuditStrict::Desc do
                              column: 8,
                              source: source }]
 
-      inspect_source(cop, source)
+      inspect_source(cop, source, "/homebrew-core/Formula/foo.rb")
       expected_offenses.zip(cop.offenses).each do |expected, actual|
         expect_offense(expected, actual)
       end
@@ -176,7 +176,7 @@ describe RuboCop::Cop::FormulaAuditStrict::Desc do
         end
       EOS
 
-      corrected_source = autocorrect_source(cop, source)
+      corrected_source = autocorrect_source(cop, source, "/homebrew-core/Formula/foo.rb")
       expect(corrected_source).to eq(correct_source)
     end
   end
diff --git a/Library/Homebrew/test/rubocops/lines_cop_spec.rb b/Library/Homebrew/test/rubocops/lines_cop_spec.rb
index b0ed8f4d1..31aafbcf8 100644
--- a/Library/Homebrew/test/rubocops/lines_cop_spec.rb
+++ b/Library/Homebrew/test/rubocops/lines_cop_spec.rb
@@ -200,5 +200,276 @@ describe RuboCop::Cop::FormulaAudit::Miscellaneous do
         expect_offense(expected, actual)
       end
     end
+
+    it "with invalid rebuild" do
+      source = <<-EOS.undent
+        class Foo < Formula
+          desc "foo"
+          url 'http://example.com/foo-1.0.tgz'
+          bottle do
+            rebuild 0
+            sha256 "fe0679b932dd43a87fd415b609a7fbac7a069d117642ae8ebaac46ae1fb9f0b3" => :sierra
+          end
+        end
+      EOS
+
+      expected_offenses = [{  message: "'rebuild 0' should be removed",
+                              severity: :convention,
+                              line: 5,
+                              column: 4,
+                              source: source }]
+
+      inspect_source(cop, source)
+
+      expected_offenses.zip(cop.offenses).each do |expected, actual|
+        expect_offense(expected, actual)
+      end
+    end
+
+    it "with OS.linux? check" do
+      source = <<-EOS.undent
+        class Foo < Formula
+          desc "foo"
+          url 'http://example.com/foo-1.0.tgz'
+          bottle do
+            if OS.linux?
+              nil
+            end
+            sha256 "fe0679b932dd43a87fd415b609a7fbac7a069d117642ae8ebaac46ae1fb9f0b3" => :sierra
+          end
+        end
+      EOS
+
+      expected_offenses = [{  message: "Don't use OS.linux?; Homebrew/core only supports macOS",
+                              severity: :convention,
+                              line: 5,
+                              column: 7,
+                              source: source }]
+
+      inspect_source(cop, source, "/homebrew-core/")
+
+      expected_offenses.zip(cop.offenses).each do |expected, actual|
+        expect_offense(expected, actual)
+      end
+    end
+
+    it "with fails_with :llvm" do
+      source = <<-EOS.undent
+        class Foo < Formula
+          desc "foo"
+          url 'http://example.com/foo-1.0.tgz'
+          bottle do
+            sha256 "fe0679b932dd43a87fd415b609a7fbac7a069d117642ae8ebaac46ae1fb9f0b3" => :sierra
+          end
+          fails_with :llvm do
+            build 2335
+            cause "foo"
+          end
+        end
+      EOS
+
+      expected_offenses = [{  message: "'fails_with :llvm' is now a no-op so should be removed",
+                              severity: :convention,
+                              line: 7,
+                              column: 2,
+                              source: source }]
+
+      inspect_source(cop, source)
+
+      expected_offenses.zip(cop.offenses).each do |expected, actual|
+        expect_offense(expected, actual)
+      end
+    end
+
+    it "with def test" do
+      source = <<-EOS.undent
+        class Foo < Formula
+          desc "foo"
+          url 'http://example.com/foo-1.0.tgz'
+
+          def test
+            assert_equals "1", "1"
+          end
+        end
+      EOS
+
+      expected_offenses = [{  message: "Use new-style test definitions (test do)",
+                              severity: :convention,
+                              line: 5,
+                              column: 2,
+                              source: source }]
+
+      inspect_source(cop, source)
+
+      expected_offenses.zip(cop.offenses).each do |expected, actual|
+        expect_offense(expected, actual)
+      end
+    end
+
+    it "with def options" do
+      source = <<-EOS.undent
+        class Foo < Formula
+          desc "foo"
+          url 'http://example.com/foo-1.0.tgz'
+
+          def options
+            [["--bar", "desc"]]
+          end
+        end
+      EOS
+
+      expected_offenses = [{  message: "Use new-style option definitions",
+                              severity: :convention,
+                              line: 5,
+                              column: 2,
+                              source: source }]
+
+      inspect_source(cop, source)
+
+      expected_offenses.zip(cop.offenses).each do |expected, actual|
+        expect_offense(expected, actual)
+      end
+    end
+
+    it "with deprecated skip_clean call" do
+      source = <<-EOS.undent
+        class Foo < Formula
+          desc "foo"
+          url 'http://example.com/foo-1.0.tgz'
+          skip_clean :all
+        end
+      EOS
+
+      expected_offenses = [{ message: <<-EOS.undent.chomp,
+                              `skip_clean :all` is deprecated; brew no longer strips symbols
+                                      Pass explicit paths to prevent Homebrew from removing empty folders.
+                             EOS
+                             severity: :convention,
+                             line: 4,
+                             column: 2,
+                             source: source }]
+
+      inspect_source(cop, source)
+
+      expected_offenses.zip(cop.offenses).each do |expected, actual|
+        expect_offense(expected, actual)
+      end
+    end
+
+    it "with build.universal?" do
+      source = <<-EOS.undent
+        class Foo < Formula
+          desc "foo"
+          url 'http://example.com/foo-1.0.tgz'
+          if build.universal?
+             "foo"
+          end
+        end
+      EOS
+
+      expected_offenses = [{  message: "macOS has been 64-bit only since 10.6 so build.universal? is deprecated.",
+                              severity: :convention,
+                              line: 4,
+                              column: 5,
+                              source: source }]
+
+      inspect_source(cop, source)
+
+      expected_offenses.zip(cop.offenses).each do |expected, actual|
+        expect_offense(expected, actual)
+      end
+    end
+
+    it "with ENV.universal_binary" do
+      source = <<-EOS.undent
+        class Foo < Formula
+          desc "foo"
+          url 'http://example.com/foo-1.0.tgz'
+          if build?
+             ENV.universal_binary
+          end
+        end
+      EOS
+
+      expected_offenses = [{  message: "macOS has been 64-bit only since 10.6 so ENV.universal_binary is deprecated.",
+                              severity: :convention,
+                              line: 5,
+                              column: 5,
+                              source: source }]
+
+      inspect_source(cop, source)
+
+      expected_offenses.zip(cop.offenses).each do |expected, actual|
+        expect_offense(expected, actual)
+      end
+    end
+
+    it "with ENV.universal_binary" do
+      source = <<-EOS.undent
+        class Foo < Formula
+          desc "foo"
+          url 'http://example.com/foo-1.0.tgz'
+          if build?
+             ENV.x11
+          end
+        end
+      EOS
+
+      expected_offenses = [{  message: 'Use "depends_on :x11" instead of "ENV.x11"',
+                              severity: :convention,
+                              line: 5,
+                              column: 5,
+                              source: source }]
+
+      inspect_source(cop, source)
+
+      expected_offenses.zip(cop.offenses).each do |expected, actual|
+        expect_offense(expected, actual)
+      end
+    end
+
+    it "with ruby-macho alternatives" do
+      source = <<-EOS.undent
+        class Foo < Formula
+          desc "foo"
+          url 'http://example.com/foo-1.0.tgz'
+          system "install_name_tool", "-id"
+        end
+      EOS
+
+      expected_offenses = [{  message: 'Use ruby-macho instead of calling "install_name_tool"',
+                              severity: :convention,
+                              line: 4,
+                              column: 10,
+                              source: source }]
+
+      inspect_source(cop, source)
+
+      expected_offenses.zip(cop.offenses).each do |expected, actual|
+        expect_offense(expected, actual)
+      end
+    end
+
+    it "with npm install without language::Node args" do
+      source = <<-EOS.undent
+        class Foo < Formula
+          desc "foo"
+          url 'http://example.com/foo-1.0.tgz'
+          system "npm", "install"
+        end
+      EOS
+
+      expected_offenses = [{  message: "Use Language::Node for npm install args",
+                              severity: :convention,
+                              line: 4,
+                              column: 2,
+                              source: source }]
+
+      inspect_source(cop, source)
+
+      expected_offenses.zip(cop.offenses).each do |expected, actual|
+        expect_offense(expected, actual)
+      end
+    end
   end
 end