rubocop-cask 0.1.0 → 0.2.0

data/lib/rubocop/cop/cask/stanza_order.rb

@@ -0,0 +1,51 @@
+require 'forwardable'
+
+module RuboCop
+  module Cop
+    module Cask
+      # This cop checks that a cask's stanzas are ordered correctly.
+      # See https://github.com/caskroom/homebrew-cask/blob/master/CONTRIBUTING.md#stanza-order
+      # for more info.
+      class StanzaOrder < Cop
+        extend Forwardable
+        include RuboCop::Cask::CaskHelp
+
+        MESSAGE = '`%s` stanza out of order'
+
+        def on_cask(cask_node)
+          @cask_block = RuboCop::Cask::AST::CaskBlock.new(cask_node)
+          add_offenses
+        end
+
+        def autocorrect(stanza)
+          lambda do |corrector|
+            correct_stanza_index = toplevel_stanzas.index(stanza)
+            correct_stanza = sorted_toplevel_stanzas[correct_stanza_index]
+            corrector.replace(stanza.expression, correct_stanza.source)
+          end
+        end
+
+        private
+
+        attr_reader :cask_block
+        def_delegators :cask_block, :cask_node, :toplevel_stanzas,
+                       :sorted_toplevel_stanzas
+
+        def add_offenses
+          offending_stanzas.each do |stanza|
+            message = format(MESSAGE, stanza.stanza_name)
+            add_offense(stanza, stanza.expression, message)
+          end
+        end
+
+        def offending_stanzas
+          offending = []
+          toplevel_stanzas.each_with_index do |stanza, i|
+            offending << stanza unless stanza == sorted_toplevel_stanzas[i]
+          end
+          offending
+        end
+      end
+    end
+  end
+end

data/spec/rubocop/cop/cask/no_dsl_version_spec.rb

@@ -1,105 +1,84 @@
 describe RuboCop::Cop::Cask::NoDslVersion do
+  include CopSharedExamples
+
   subject(:cop) { described_class.new }
 
   context 'with header method `cask`' do
+    let(:header_method) { 'cask' }
+
     context 'with no dsl version' do
-      it 'passes' do
-        inspect_source(cop, [
-          "cask 'foo' do",
-          'end'
-        ])
-        expect(cop.offenses).to be_empty
-      end
+      let(:source) { "cask 'foo' do; end" }
+
+      include_examples 'does not report any offenses'
     end
 
     context 'with dsl version' do
-      it 'fails' do
-        inspect_source(cop, [
-          "cask :v1 => 'foo' do",
-          'end'
-        ])
-        expect(cop.offenses.size).to eq(1)
-        expect(cop.offenses.first.line).to eq(1)
-        expect(cop.messages)
-          .to eq(["Use `cask 'foo'` instead of `cask :v1 => 'foo'`"])
-        expect(cop.highlights)
-          .to eq(["cask :v1 => 'foo'"])
+      let(:source) { "cask :v1 => 'foo' do; end" }
+      let(:correct_source) { "cask 'foo' do; end" }
+      let(:expected_offenses) do
+        [
+          {
+            message: "Use `cask 'foo'` instead of `cask :v1 => 'foo'`",
+            severity: :convention,
+            line: 1,
+            column: 0,
+            source: "cask :v1 => 'foo'"
+          }
+        ]
       end
 
-      it 'autocorrects' do
-        new_source = autocorrect_source(cop, [
-          "cask :v1 => 'foo' do",
-          'end'
-        ])
-        expect(new_source).to eq([
-          "cask 'foo' do",
-          'end'
-        ].join("\n"))
-      end
+      include_examples 'reports offenses'
+
+      include_examples 'autocorrects offenses'
     end
 
     context 'with dsl version containing "test"' do
-      it 'fails' do
-        inspect_source(cop, [
-          "cask :v1test => 'foo' do",
-          'end'
-        ])
-        expect(cop.offenses.size).to eq(1)
-        expect(cop.offenses.first.line).to eq(1)
-        expect(cop.messages)
-          .to eq(["Use `test_cask 'foo'` instead of `cask :v1test => 'foo'`"])
-        expect(cop.highlights)
-          .to eq(["cask :v1test => 'foo'"])
+      let(:source) { "cask :v1test => 'foo' do; end" }
+      let(:correct_source) { "test_cask 'foo' do; end" }
+      let(:expected_offenses) do
+        [
+          {
+            message: "Use `test_cask 'foo'` instead of `cask :v1test => 'foo'`",
+            severity: :convention,
+            line: 1,
+            column: 0,
+            source: "cask :v1test => 'foo'"
+          }
+        ]
       end
 
-      it 'autocorrects' do
-        new_source = autocorrect_source(cop, [
-          "cask :v1test => 'foo' do",
-          'end'
-        ])
-        expect(new_source).to eq([
-          "test_cask 'foo' do",
-          'end'
-        ].join("\n"))
-      end
+      include_examples 'reports offenses'
+
+      include_examples 'autocorrects offenses'
     end
   end
 
   context 'with header method `test_cask`' do
     context 'with no dsl version' do
-      it 'passes' do
-        inspect_source(cop, [
-          "test_cask 'foo' do",
-          'end'
-        ])
-        expect(cop.offenses).to be_empty
-      end
+      let(:source) { "test_cask 'foo' do; end" }
+
+      include_examples 'does not report any offenses'
     end
 
     context 'with dsl version' do
-      it 'fails' do
-        inspect_source(cop, [
-          "test_cask :v1 => 'foo' do",
-          'end'
-        ])
-        expect(cop.offenses.size).to eq(1)
-        expect(cop.offenses.first.line).to eq(1)
-        expect(cop.messages)
-          .to eq(["Use `test_cask 'foo'` instead of `test_cask :v1 => 'foo'`"])
-        expect(cop.highlights)
-          .to eq(["test_cask :v1 => 'foo'"])
+      let(:source) { "test_cask :v1 => 'foo' do; end" }
+      let(:correct_source) { "test_cask 'foo' do; end" }
+      let(:expected_offenses) do
+        [
+          {
+            message: "Use `test_cask 'foo'` instead of "\
+                     "`test_cask :v1 => 'foo'`",
+            severity: :convention,
+            line: 1,
+            column: 0,
+            source: "test_cask :v1 => 'foo'"
+          }
+        ]
       end
 
-      it 'autocorrects' do
-        new_source = autocorrect_source(cop, [
-          "test_cask :v1 => 'foo' do",
-          'end'
-        ])
-        expect(new_source).to eq([
-          "test_cask 'foo' do",
-          'end'
-        ].join("\n"))
-      end
+      include_examples 'reports offenses'
+
+      include_examples 'autocorrects offenses'
     end
   end
 end

data/spec/rubocop/cop/cask/stanza_grouping_spec.rb

@@ -0,0 +1,194 @@
+describe RuboCop::Cop::Cask::StanzaGrouping do
+  include CopSharedExamples
+
+  subject(:cop) { described_class.new }
+  let(:missing_line_msg) do
+    'stanza groups should be separated by a single empty line'
+  end
+  let(:extra_line_msg) do
+    'stanzas within the same group should have no lines between them'
+  end
+
+  context 'when no stanzas are incorrectly grouped' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+        end
+      CASK
+    end
+
+    include_examples 'does not report any offenses'
+  end
+
+  context 'when one stanza is incorrectly grouped' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+
+          sha256 :no_check
+        end
+      CASK
+    end
+    let(:correct_source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+        end
+      CASK
+    end
+    let(:expected_offenses) do
+      [
+        {
+          message: extra_line_msg,
+          severity: :convention,
+          line: 3,
+          column: 0,
+          source: "\n"
+        }
+      ]
+    end
+
+    include_examples 'reports offenses'
+
+    include_examples 'autocorrects offenses'
+  end
+
+  context 'when many stanzas are incorrectly grouped' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+          url 'https://foo.example.com/foo.zip'
+
+          name 'Foo'
+
+          homepage 'https://foo.example.com'
+          license :mit
+
+          app 'Foo.app'
+          uninstall :quit => 'com.example.foo',
+                    :kext => 'com.example.foo.kextextension'
+        end
+      CASK
+    end
+    let(:correct_source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+
+          url 'https://foo.example.com/foo.zip'
+          name 'Foo'
+          homepage 'https://foo.example.com'
+          license :mit
+
+          app 'Foo.app'
+
+          uninstall :quit => 'com.example.foo',
+                    :kext => 'com.example.foo.kextextension'
+        end
+      CASK
+    end
+    let(:expected_offenses) do
+      [
+        {
+          message: missing_line_msg,
+          severity: :convention,
+          line: 4,
+          column: 0,
+          source: "  url 'https://foo.example.com/foo.zip'"
+        },
+        {
+          message: extra_line_msg,
+          severity: :convention,
+          line: 5,
+          column: 0,
+          source: "\n"
+        },
+        {
+          message: extra_line_msg,
+          severity: :convention,
+          line: 7,
+          column: 0,
+          source: "\n"
+        },
+        {
+          message: missing_line_msg,
+          severity: :convention,
+          line: 12,
+          column: 0,
+          source: "  uninstall :quit => 'com.example.foo',"
+        }
+      ]
+    end
+
+    include_examples 'reports offenses'
+
+    include_examples 'autocorrects offenses'
+  end
+
+  context 'when a stanza includes a heredoc' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+          url 'https://foo.example.com/foo.zip'
+          name 'Foo'
+          caveats <<-EOS.undent
+            This is a multiline caveat.
+
+            Let's hope it doesn't cause any problems!
+          EOS
+          app 'Foo.app'
+        end
+      CASK
+    end
+    let(:correct_source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+
+          url 'https://foo.example.com/foo.zip'
+          name 'Foo'
+
+          caveats <<-EOS.undent
+            This is a multiline caveat.
+
+            Let's hope it doesn't cause any problems!
+          EOS
+
+          app 'Foo.app'
+        end
+      CASK
+    end
+
+    it 'autocorrects as expected' do
+      new_source = autocorrect_source(cop, source)
+      expect(new_source).to eq(Array(correct_source).join("\n"))
+    end
+  end
+
+  # TODO: detect incorrectly grouped stanzas in nested expressions
+  context 'when stanzas are nested in a conditional expression' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          if true
+            version :latest
+
+            sha256 :no_check
+          end
+        end
+      CASK
+    end
+
+    include_examples 'does not report any offenses'
+  end
+end

data/spec/rubocop/cop/cask/stanza_order_spec.rb

@@ -0,0 +1,213 @@
+describe RuboCop::Cop::Cask::StanzaOrder do
+  include CopSharedExamples
+
+  subject(:cop) { described_class.new }
+
+  context 'when no stanzas are out of order' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+        end
+      CASK
+    end
+
+    include_examples 'does not report any offenses'
+  end
+
+  context 'when one pair of stanzas is out of order' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          sha256 :no_check
+          version :latest
+        end
+      CASK
+    end
+    let(:correct_source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+        end
+      CASK
+    end
+    let(:expected_offenses) do
+      [
+        {
+          message: '`sha256` stanza out of order',
+          severity: :convention,
+          line: 2,
+          column: 2,
+          source: 'sha256 :no_check'
+        },
+        {
+          message: '`version` stanza out of order',
+          severity: :convention,
+          line: 3,
+          column: 2,
+          source: 'version :latest'
+        }
+      ]
+    end
+
+    include_examples 'reports offenses'
+
+    include_examples 'autocorrects offenses'
+  end
+
+  context 'when many stanzas are out of order' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          url 'https://foo.example.com/foo.zip'
+          uninstall :quit => 'com.example.foo',
+                    :kext => 'com.example.foo.kext'
+          version :latest
+          app 'Foo.app'
+          sha256 :no_check
+        end
+      CASK
+    end
+    let(:correct_source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+          url 'https://foo.example.com/foo.zip'
+          app 'Foo.app'
+          uninstall :quit => 'com.example.foo',
+                    :kext => 'com.example.foo.kext'
+        end
+      CASK
+    end
+    let(:expected_offenses) do
+      [
+        {
+          message: '`url` stanza out of order',
+          severity: :convention,
+          line: 2,
+          column: 2,
+          source: "url 'https://foo.example.com/foo.zip'"
+        },
+        {
+          message: '`uninstall` stanza out of order',
+          severity: :convention,
+          line: 3,
+          column: 2,
+          source: "uninstall :quit => 'com.example.foo',\n" \
+                "            :kext => 'com.example.foo.kext'"
+        },
+        {
+          message: '`version` stanza out of order',
+          severity: :convention,
+          line: 5,
+          column: 2,
+          source: 'version :latest'
+        },
+        {
+          message: '`sha256` stanza out of order',
+          severity: :convention,
+          line: 7,
+          column: 2,
+          source: 'sha256 :no_check'
+        }
+      ]
+    end
+
+    include_examples 'reports offenses'
+
+    include_examples 'autocorrects offenses'
+  end
+
+  context 'when a stanza appears multiple times' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          name 'Foo'
+          url 'https://foo.example.com/foo.zip'
+          name 'FancyFoo'
+          version :latest
+          app 'Foo.app'
+          sha256 :no_check
+          name 'FunkyFoo'
+        end
+      CASK
+    end
+    let(:correct_source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+          url 'https://foo.example.com/foo.zip'
+          name 'Foo'
+          name 'FancyFoo'
+          name 'FunkyFoo'
+          app 'Foo.app'
+        end
+      CASK
+    end
+
+    it 'preserves the original order' do
+      new_source = autocorrect_source(cop, source)
+      expect(new_source).to eq(Array(correct_source).join("\n"))
+    end
+  end
+
+  context 'when a stanza includes a heredoc' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          name 'Foo'
+          url 'https://foo.example.com/foo.zip'
+          caveats <<-EOS.undent
+            This is a multiline caveat.
+
+            Let's hope it doesn't cause any problems!
+          EOS
+          version :latest
+          app 'Foo.app'
+          sha256 :no_check
+        end
+      CASK
+    end
+    let(:correct_source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+          url 'https://foo.example.com/foo.zip'
+          name 'Foo'
+          app 'Foo.app'
+          caveats <<-EOS.undent
+            This is a multiline caveat.
+
+            Let's hope it doesn't cause any problems!
+          EOS
+        end
+      CASK
+    end
+
+    it 'autocorrects as expected' do
+      new_source = autocorrect_source(cop, source)
+      expect(new_source).to eq(Array(correct_source).join("\n"))
+    end
+  end
+
+  # TODO: detect out-of-order stanzas in nested expressions
+  context 'when stanzas are nested in a conditional expression' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          if true
+            sha256 :no_check
+            version :latest
+          end
+        end
+      CASK
+    end
+
+    include_examples 'does not report any offenses'
+  end
+end