rubocop-cask 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbc20c10c904e85b5435cb66eb293b5755f99a3f
-  data.tar.gz: 18e221eef63f6bcf2aa5f528da5a737f94bfb80c
+  metadata.gz: 20c70b535a7f7a0aade9f2fb33eec5a52c6ed63c
+  data.tar.gz: 67f22d2efeaa1e20df95f9737c50234d7c929501
 SHA512:
-  metadata.gz: c523902a6c35dc1c39ac5255922a02bab5b7a2977f1c976797abde9a2129e431421cec877f4358caea60a9000af2d77a72ca376f5a029058507fc52bbbcc1136
-  data.tar.gz: 9e10a050c4c8ed8967d131d62e78925bd24e3ea0f7cfd0f72d00bceac32f4aab910a61cb04eecb42125a797bd709ca0f3edcffb24d4edf8ea43dd3fed61c2456
+  metadata.gz: 34d53b4881babc3d66f6cabc6da513f9cf04fa46651ff6ef0e2e9ac3221abaec1145c1dbfa2c5820c46da891db63b1bb1a35be3a7629c8d3855034517671b412
+  data.tar.gz: d65f6a09b2ed8aaa99755a8f5a8bed5e117fa85ac0af9be6e494b13e77bca39add26b21b74e36dc6b89d8264a0aeb87d10708ed014a47aec502011385c81b540

data/config/default.yml

@@ -6,6 +6,10 @@ Cask/NoDslVersion:
   Description: 'Do not use the deprecated DSL version syntax in your cask header.'
   Enabled: true
 
+Cask/HomepageMatchesUrl:
+  Description: 'Ensure that the homepage and url match, otherwise add a comment. More info at https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/url.md#when-url-and-homepage-hostnames-differ-add-a-comment'
+  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

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.7.0'
+      STRING = '0.8.0'.freeze
 
       def self.gem_version
         Gem::Version.new(STRING)

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

@@ -0,0 +1,112 @@
+require 'forwardable'
+
+module RuboCop
+  module Cop
+    module Cask
+      # This cop checks that a cask's homepage matches the download url,
+      # or if it doesn't, checks if a comment in the form
+      # `# example.com was verified as official when first introduced to the cask`
+      # is present.
+      class HomepageMatchesUrl < Cop
+        extend Forwardable
+        include CaskHelp
+
+        MSG_NO_MATCH = '`%s` does not match `%s`'.freeze
+
+        MSG_MISSING = '`%s` does not match `%s`, a comment in the form of ' \
+                      '`# example.com was verified as official when first ' \
+                      'introduced to the cask` has to be added above the ' \
+                      '`url` stanza'.freeze
+
+        MSG_UNNECESSARY = '`%s` matches `%s`, the comment above the `url` ' \
+                          'stanza is unnecessary'.freeze
+
+        def on_cask(cask_block)
+          @cask_block = cask_block
+          add_offenses
+        end
+
+        private
+
+        attr_reader :cask_block
+        def_delegators :cask_block, :cask_node, :toplevel_stanzas,
+                       :sorted_toplevel_stanzas
+
+        def add_offenses
+          toplevel_stanzas.select(&:url?).each do |url|
+            if url_match_homepage?(url)
+              next unless comment?(url)
+              add_offense_unnecessary_comment(url)
+            elsif !comment?(url)
+              add_offense_missing_comment(url)
+            elsif !comment_matches_url?(url)
+              add_offense_no_match(url)
+            end
+          end
+        end
+
+        def add_offense_missing_comment(stanza)
+          range = stanza.source_range
+          add_offense(range, range, format(MSG_MISSING, url(stanza), homepage))
+        end
+
+        def add_offense_unnecessary_comment(stanza)
+          comment = comment(stanza).loc.expression
+          add_offense(comment,
+                      comment,
+                      format(MSG_UNNECESSARY, url(stanza), homepage))
+        end
+
+        def add_offense_no_match(stanza)
+          comment = comment(stanza).loc.expression
+          add_offense(comment,
+                      comment,
+                      format(MSG_NO_MATCH, url_from_comment(stanza), url(stanza)))
+        end
+
+        def comment?(stanza)
+          !stanza.comments.empty?
+        end
+
+        def comment(stanza)
+          stanza.comments.last
+        end
+
+        def url_from_comment(stanza)
+          comment(stanza).text
+            .sub(/.*# ([^ ]*) was verified as official when first introduced to the cask$/, '\1')
+        end
+
+        def comment_matches_url?(stanza)
+          url(stanza).include?(url_from_comment(stanza))
+        end
+
+        def strip_http(url)
+          url.sub(%r{^.*://(?=www\.)?}, '')
+        end
+
+        def extract_stanza(stanza)
+          stanza.source
+            .sub(/#{stanza.stanza_name} \'(.*)\'/, '\1')
+            .sub(/#{stanza.stanza_name} \"(.*)\"/, '\1')
+        end
+
+        def domain(url)
+          strip_http(url).gsub(%r{^([^/]+).*}, '\1')
+        end
+
+        def url_match_homepage?(url)
+          url(url).include?(homepage)
+        end
+
+        def url(stanza)
+          domain(extract_stanza(stanza))
+        end
+
+        def homepage
+          url(toplevel_stanzas.find(&:homepage?))
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,7 @@ module RuboCop
         extend Forwardable
         include CaskHelp
 
-        MESSAGE = 'Use `%s` instead of `%s`'
+        MESSAGE = 'Use `%s` instead of `%s`'.freeze
 
         def on_cask(cask_block)
           @cask_header = cask_block.header

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

@@ -11,10 +11,10 @@ module RuboCop
         include CaskHelp
 
         MISSING_LINE_MSG = 'stanza groups should be separated by a single ' \
-                           'empty line'
+                           'empty line'.freeze
 
         EXTRA_LINE_MSG = 'stanzas within the same group should have no lines ' \
-                         'between them'
+                         'between them'.freeze
 
         def on_cask(cask_block)
           @cask_block = cask_block

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

@@ -10,7 +10,7 @@ module RuboCop
         extend Forwardable
         include CaskHelp
 
-        MESSAGE = '`%s` stanza out of order'
+        MESSAGE = '`%s` stanza out of order'.freeze
 
         def on_cask(cask_block)
           @cask_block = cask_block

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/homepage_matches_url'
 require 'rubocop/cop/cask/no_dsl_version'
 require 'rubocop/cop/cask/stanza_order'
 require 'rubocop/cop/cask/stanza_grouping'

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

@@ -0,0 +1,118 @@
+describe RuboCop::Cop::Cask::HomepageMatchesUrl 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 the url matches the homepage' do
+    context 'and there is no comment' do
+      let(:source) do
+        <<-CASK.undent
+          cask 'foo' do
+            url 'https://foo.example.com/foo.zip'
+            homepage 'https://foo.example.com'
+          end
+        CASK
+      end
+
+      include_examples 'does not report any offenses'
+    end
+
+    context 'but there is a comment' do
+      let(:source) do
+        <<-CASK.undent
+          cask 'foo' do
+            # foo.example.com was verified as official when first introduced to the cask
+            url 'https://foo.example.com/foo.zip'
+            homepage 'https://foo.example.com'
+          end
+        CASK
+      end
+      let(:expected_offenses) do
+        [{
+          message: '`foo.example.com` matches `foo.example.com`, ' \
+                   'the comment above the `url` stanza is unnecessary',
+          severity: :convention,
+          line: 2,
+          column: 2,
+          source: '# foo.example.com was verified as official when ' \
+                  'first introduced to the cask'
+        }]
+      end
+
+      include_examples 'reports offenses'
+    end
+  end
+
+  context 'when the url does not match the homepage' do
+    context 'and there is a comment' do
+      context 'which matches the url' do
+        let(:source) do
+          <<-CASK.undent
+            cask 'foo' do
+              # example.com was verified as official when first introduced to the cask
+              url 'https://example.com/foo.zip'
+              homepage 'https://foo.example.com'
+            end
+          CASK
+        end
+
+        include_examples 'does not report any offenses'
+      end
+
+      context 'which does not match the url' do
+        let(:source) do
+          <<-CASK.undent
+            cask 'foo' do
+              # example.org was verified as official when first introduced to the cask
+              url 'https://example.com/foo.zip'
+              homepage 'https://foo.example.com'
+            end
+          CASK
+        end
+        let(:expected_offenses) do
+          [{
+            message: '`example.org` does not match `example.com`',
+            severity: :convention,
+            line: 2,
+            column: 2,
+            source: '# example.org was verified as official when ' \
+                    'first introduced to the cask'
+          }]
+        end
+
+        include_examples 'reports offenses'
+      end
+    end
+
+    context 'but the comment is missing' do
+      let(:source) do
+        <<-CASK.undent
+          cask 'foo' do
+            url 'https://example.com/foo.zip'
+            homepage 'https://foo.example.com'
+          end
+        CASK
+      end
+      let(:expected_offenses) do
+        [{
+          message: '`example.com` does not match `foo.example.com`, a ' \
+                   'comment in the form of `# example.com was verified as ' \
+                   'official when first introduced to the cask` has to be ' \
+                   'added above the `url` stanza',
+          severity: :convention,
+          line: 2,
+          column: 2,
+          source: "url 'https://example.com/foo.zip'"
+        }]
+      end
+
+      include_examples 'reports offenses'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-cask
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Joshua Hagins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-30 00:00:00.000000000 Z
+date: 2016-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -61,11 +61,13 @@ files:
 - lib/rubocop/cask/extend/string.rb
 - lib/rubocop/cask/inject.rb
 - lib/rubocop/cask/version.rb
+- lib/rubocop/cop/cask/homepage_matches_url.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/homepage_matches_url_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
@@ -97,6 +99,7 @@ specification_version: 4
 summary: Code style checking for Homebrew-Cask files
 test_files:
 - spec/project_spec.rb
+- spec/rubocop/cop/cask/homepage_matches_url_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