rubocop-cask 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6a5b8a17cf24bee4d483755261047e0b8e36545
-  data.tar.gz: 411f20070b3fe9c196afa06df99e3bd495080346
+  metadata.gz: bb51eac3550f067eca7d72c40f8e328b22b5025c
+  data.tar.gz: 47d413dba32958d1ac635d8b2c6fbdd56408cef7
 SHA512:
-  metadata.gz: 4af05ad480b53239355e3622893caf33db75f510c161e18b6b9d44c1c4ef3207752b4c4d6b8a2b76c3eeaa50bdeab4b9e884d8984903b3f1cfa85949c4c8f45d
-  data.tar.gz: 30c12c402d6194e77bdf40077b0b8647da6103b64f7aabd6abde1c4fdfa20f09cc65d58d880bdf7457af6aaf5a0de76ec742792ac03818967073519644be348e
+  metadata.gz: 2c35ec1f44568927cdd99ebbab3fb0905dffa3452a6e8d3d29fee49cdea1f6480fa8dd86c4ba60686e6e46f294e816a1ea1bf2e5c45cab341faece793defedbc
+  data.tar.gz: 4abb51a80d7d1a24a1ae4fd300779da7bed220b539381e8a2b84c51ddfa63361d89798be085d300a39965a451ed9e22650819e3e94db975d18e71b6806559c82

data/README.md

@@ -7,7 +7,7 @@
 [![Code Climate](https://codeclimate.com/github/caskroom/rubocop-cask/badges/gpa.svg)](https://codeclimate.com/github/caskroom/rubocop-cask)
 [![Inline docs](http://inch-ci.org/github/caskroom/rubocop-cask.svg)](http://inch-ci.org/github/caskroom/rubocop-cask)
 
-Cask-specific analysis for your Homebrew-Cask taps, as an extension to
+Cask-specific analysis for your [Homebrew-Cask](https://github.com/caskroom/homebrew-cask) taps, as an extension to
 [RuboCop](https://github.com/bbatsov/rubocop). Heavily inspired by [`rubocop-rspec`](https://github.com/nevir/rubocop-rspec).
 
 

data/config/default.yml

@@ -1,11 +1,15 @@
-Cask/NoDslVersion:
-  Description: 'Do not use the deprecated DSL version syntax in your cask header.'
+Cask/LicenseUnknownComment:
+  Description: 'Always follow `license :unknown` with the machine-generated TODO comment.'
   Enabled: true
 
-Cask/StanzaOrder:
-  Description: 'Ensure that cask stanzas are sorted correctly. More info at https://github.com/caskroom/homebrew-cask/blob/master/CONTRIBUTING.md#stanza-order'
+Cask/NoDslVersion:
+  Description: 'Do not use the deprecated DSL version syntax in your cask header.'
   Enabled: true
 
 Cask/StanzaGrouping:
   Description: 'Ensure that cask stanzas are grouped correctly. More info at https://github.com/caskroom/homebrew-cask/blob/master/CONTRIBUTING.md#stanza-order'
   Enabled: true
+
+Cask/StanzaOrder:
+  Description: 'Ensure that cask stanzas are sorted correctly. More info at https://github.com/caskroom/homebrew-cask/blob/master/CONTRIBUTING.md#stanza-order'
+  Enabled: true

data/lib/rubocop-cask.rb

@@ -12,6 +12,7 @@ require 'rubocop/cask/inject'
 RuboCop::Cask::Inject.defaults!
 
 require 'rubocop/cop/cask/mixin/cask_help'
+require 'rubocop/cop/cask/license_unknown_comment'
 require 'rubocop/cop/cask/no_dsl_version'
 require 'rubocop/cop/cask/stanza_order'
 require 'rubocop/cop/cask/stanza_grouping'

data/lib/rubocop/cask/ast/cask_block.rb

@@ -18,16 +18,15 @@ module RuboCop
 
         alias_method :cask_node, :block_node
 
-        def cask_body
-          cask_node.block_body
-        end
+        def_delegator :cask_node, :block_body, :cask_body
 
         def header
           @header ||= CaskHeader.new(cask_node.method_node)
         end
 
         def stanzas
-          @stanzas ||= cask_body.descendants
+          return [] unless cask_body
+          @stanzas ||= cask_body.each_node
             .select(&:stanza?)
             .map { |node| Stanza.new(node, stanza_comments(node)) }
         end

data/lib/rubocop/cask/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cask
     # Version information for the Cask RuboCop plugin.
     module Version
-      STRING = '0.2.2'
+      STRING = '0.3.0'
 
       def self.gem_version
         Gem::Version.new(STRING)

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

@@ -0,0 +1,74 @@
+require 'pry'
+
+module RuboCop
+  module Cop
+    module Cask
+      # This cop checks that if a cask uses `license :unknown`, it is followed
+      # on the same line by the machine-generated TODO comment.
+      class LicenseUnknownComment < Cop
+        include CaskHelp
+
+        COMMENT_TEXT = '# TODO: change license and remove this comment; ' \
+                       "':unknown' is a machine-generated placeholder"
+        MISSING_MSG = "Missing required comment: `#{COMMENT_TEXT}'"
+        INLINE_MSG = "Comment belongs on the same line as `license :unknown'"
+
+        def on_cask(cask_block)
+          license_stanza = cask_block.stanzas.find(&:license?)
+          return unless license_stanza && license_unknown?(license_stanza)
+          add_offenses(license_stanza)
+        end
+
+        def autocorrect(stanza)
+          lambda do |corrector|
+            comment = license_unknown_comment
+            remove_comment(corrector, comment) if comment
+            add_comment(corrector, stanza)
+          end
+        end
+
+        private
+
+        attr_reader :cask_block
+
+        def license_unknown?(stanza)
+          stanza.source.include?(':unknown')
+        end
+
+        def add_offenses(stanza)
+          comment = license_unknown_comment
+          add_missing_offense(stanza) unless comment
+          add_not_inline_offense(stanza, comment) if comment &&
+              !on_same_line?(stanza, comment)
+        end
+
+        def license_unknown_comment
+          processed_source.comments.find { |c| c.text == COMMENT_TEXT }
+        end
+
+        def add_missing_offense(stanza)
+          add_offense(stanza, stanza.source_range, MISSING_MSG)
+        end
+
+        def add_not_inline_offense(stanza, comment)
+          add_offense(stanza, comment.loc.expression, INLINE_MSG)
+        end
+
+        def on_same_line?(stanza, comment)
+          stanza.source_range.line == comment.loc.line
+        end
+
+        def remove_comment(corrector, comment)
+          line = comment.loc.line
+          length = processed_source[line - 1].length
+          range = source_range(processed_source.buffer, line, 0, length + 1)
+          corrector.remove(range)
+        end
+
+        def add_comment(corrector, stanza)
+          corrector.insert_after(stanza.source_range, " #{COMMENT_TEXT}")
+        end
+      end
+    end
+  end
+end

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

@@ -40,11 +40,11 @@ module RuboCop
         end
 
         def offending_stanzas
-          offending = []
-          toplevel_stanzas.each_with_index do |stanza, i|
-            offending << stanza unless stanza == sorted_toplevel_stanzas[i]
+          stanza_pairs = toplevel_stanzas.zip(sorted_toplevel_stanzas)
+          stanza_pairs.each_with_object([]) do |stanza_pair, offending_stanzas|
+            stanza, sorted_stanza = *stanza_pair
+            offending_stanzas << stanza unless stanza == sorted_stanza
           end
-          offending
         end
       end
     end

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

@@ -0,0 +1,87 @@
+describe RuboCop::Cop::Cask::LicenseUnknownComment do
+  include CopSharedExamples
+
+  subject(:cop) { described_class.new }
+  let(:license_unknown_comment) { described_class.const_get(:COMMENT_TEXT) }
+
+  context 'when cask has no license stanza' do
+    let(:source) { "cask 'foo' do; end" }
+
+    include_examples 'does not report any offenses'
+  end
+
+  context 'when license is not :unknown' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          license :mit
+        end
+      CASK
+    end
+
+    include_examples 'does not report any offenses'
+  end
+
+  context 'when license is :unknown' do
+    let(:correct_source) do
+      <<-CASK.undent
+        cask 'foo' do
+          license :unknown #{license_unknown_comment}
+        end
+      CASK
+    end
+
+    context 'with required comment on same line' do
+      let(:source) { correct_source }
+
+      include_examples 'does not report any offenses'
+    end
+
+    context 'with required comment on preceding line' do
+      let(:source) do
+        <<-CASK.undent
+          cask 'foo' do
+            #{license_unknown_comment}
+            license :unknown
+          end
+        CASK
+      end
+      let(:expected_offenses) do
+        [{
+          message: "Comment belongs on the same line as `license :unknown'",
+          severity: :convention,
+          line: 2,
+          column: 2,
+          source: "#{license_unknown_comment}"
+        }]
+      end
+
+      include_examples 'reports offenses'
+
+      include_examples 'autocorrects source'
+    end
+
+    context 'with required comment missing' do
+      let(:source) do
+        <<-CASK.undent
+          cask 'foo' do
+            license :unknown
+          end
+        CASK
+      end
+      let(:expected_offenses) do
+        [{
+          message: "Missing required comment: `#{license_unknown_comment}'",
+          severity: :convention,
+          line: 2,
+          column: 2,
+          source: 'license :unknown'
+        }]
+      end
+
+      include_examples 'reports offenses'
+
+      include_examples 'autocorrects source'
+    end
+  end
+end

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

@@ -16,15 +16,13 @@ describe RuboCop::Cop::Cask::NoDslVersion do
       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'"
-          }
-        ]
+        [{
+          message: "Use `cask 'foo'` instead of `cask :v1 => 'foo'`",
+          severity: :convention,
+          line: 1,
+          column: 0,
+          source: "cask :v1 => 'foo'"
+        }]
       end
 
       include_examples 'reports offenses'
@@ -36,15 +34,13 @@ describe RuboCop::Cop::Cask::NoDslVersion do
       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'"
-          }
-        ]
+        [{
+          message: "Use `test_cask 'foo'` instead of `cask :v1test => 'foo'`",
+          severity: :convention,
+          line: 1,
+          column: 0,
+          source: "cask :v1test => 'foo'"
+        }]
       end
 
       include_examples 'reports offenses'
@@ -64,16 +60,14 @@ describe RuboCop::Cop::Cask::NoDslVersion do
       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'"
-          }
-        ]
+        [{
+          message: "Use `test_cask 'foo'` instead of "\
+                   "`test_cask :v1 => 'foo'`",
+          severity: :convention,
+          line: 1,
+          column: 0,
+          source: "test_cask :v1 => 'foo'"
+        }]
       end
 
       include_examples 'reports offenses'

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

@@ -41,15 +41,13 @@ describe RuboCop::Cop::Cask::StanzaGrouping do
       CASK
     end
     let(:expected_offenses) do
-      [
-        {
-          message: extra_line_msg,
-          severity: :convention,
-          line: 3,
-          column: 0,
-          source: "\n"
-        }
-      ]
+      [{
+        message: extra_line_msg,
+        severity: :convention,
+        line: 3,
+        column: 0,
+        source: "\n"
+      }]
     end
 
     include_examples 'reports offenses'
@@ -95,36 +93,31 @@ describe RuboCop::Cop::Cask::StanzaGrouping do
       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',"
-        }
-      ]
+      [{
+        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'

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

@@ -34,22 +34,19 @@ describe RuboCop::Cop::Cask::StanzaOrder do
       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'
-        }
-      ]
+      [{
+        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'
@@ -83,37 +80,32 @@ describe RuboCop::Cop::Cask::StanzaOrder do
       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" \
+      [{
+        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'
-        }
-      ]
+      }, {
+        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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-cask
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Joshua Hagins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-04 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,11 +47,13 @@ files:
 - lib/rubocop/cask/extend/string.rb
 - lib/rubocop/cask/inject.rb
 - lib/rubocop/cask/version.rb
+- lib/rubocop/cop/cask/license_unknown_comment.rb
 - lib/rubocop/cop/cask/mixin/cask_help.rb
 - lib/rubocop/cop/cask/no_dsl_version.rb
 - lib/rubocop/cop/cask/stanza_grouping.rb
 - lib/rubocop/cop/cask/stanza_order.rb
 - spec/project_spec.rb
+- spec/rubocop/cop/cask/license_unknown_comment_spec.rb
 - spec/rubocop/cop/cask/no_dsl_version_spec.rb
 - spec/rubocop/cop/cask/stanza_grouping_spec.rb
 - spec/rubocop/cop/cask/stanza_order_spec.rb
@@ -83,6 +85,7 @@ specification_version: 4
 summary: Code style checking for Homebrew-Cask files
 test_files:
 - spec/project_spec.rb
+- spec/rubocop/cop/cask/license_unknown_comment_spec.rb
 - spec/rubocop/cop/cask/no_dsl_version_spec.rb
 - spec/rubocop/cop/cask/stanza_grouping_spec.rb
 - spec/rubocop/cop/cask/stanza_order_spec.rb