rubocop-cask 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc41b93e46d74f5a11c71dda2ca017d9f7adca15
-  data.tar.gz: 7464060b75c9104bb9ff85948c738d19f63f750c
+  metadata.gz: 24d992c9eea4197d74d5c85d4a61fe4cace1527e
+  data.tar.gz: bf06c75b18669a7bf7e64a0a6919e8797d55c5ea
 SHA512:
-  metadata.gz: 6a35ab58a638ea9425891964a4f407c807574db4608b99ae7e7962bc7b6d1ba7f4551e8cacc9601cb47febf98ed16be0099efa08ad16b6ed2a2745b771003391
-  data.tar.gz: bc2361de09827a110939c2a7717640002f18b0fb1f42a2074ea1392ac901c6742a553bb2cb99ed60223666eff8e2c5d3bd0602bccfa891079678054c4d462acc
+  metadata.gz: 2da13aead784851dea5e2889aeb14106e788630225200fa9f058b9e8b186b9ab2e0a33442f5dff1918204cfe24938bff13cfc8230a40484c74225c514e2c28f4
+  data.tar.gz: 575ec4e8f2149ec6b8681ba8ad2eed4407fecfd43b00a458df677f19d9c8039ccc4f2b7a05a1facfe9d579451101d2d1f8c42b825bb4a673e6840de1fd78ee16

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

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

@@ -12,11 +12,17 @@ module RuboCop
         extend Forwardable
         include CaskHelp
 
+        REFERENCE_URL = 'https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/url.md#when-url-and-homepage-hostnames-differ-add-a-comment'.freeze
+
+        COMMENT_FORMAT = /# [^ ]+ was verified as official when first introduced to the cask/
+
         MSG_NO_MATCH = '`%s` does not match `%s`'.freeze
 
         MSG_MISSING = '`%s` does not match `%s`, a comment has to be added ' \
-                      'above the `url` stanza. For details, see ' \
-                      'https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/url.md#when-url-and-homepage-hostnames-differ-add-a-comment'.freeze
+                      'above the `url` stanza. For details, see ' + REFERENCE_URL
+
+        MSG_WRONG_FORMAT = '`%s` does not match the expected comment format. ' \
+                           'For details, see ' + REFERENCE_URL
 
         MSG_UNNECESSARY = '`%s` matches `%s`, the comment above the `url` ' \
                           'stanza is unnecessary'.freeze
@@ -34,35 +40,53 @@ module RuboCop
 
         def add_offenses
           toplevel_stanzas.select(&:url?).each do |url|
-            if url_match_homepage?(url)
-              next unless comment?(url) && comment_matches_url?(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
+            next if add_offense_unnecessary_comment(url)
+            next if add_offense_missing_comment(url)
+            next if add_offense_no_match(url)
+            next if add_offense_wrong_format(url)
           end
         end
 
+        def add_offense_unnecessary_comment(stanza)
+          return unless comment?(stanza)
+          return unless url_match_homepage?(stanza)
+          return unless comment_matches_url?(stanza)
+
+          comment = comment(stanza).loc.expression
+          add_offense(comment,
+                      comment,
+                      format(MSG_UNNECESSARY, domain(stanza), homepage))
+        end
+
         def add_offense_missing_comment(stanza)
+          return if url_match_homepage?(stanza)
+          return if !url_match_homepage?(stanza) && comment?(stanza)
+
           range = stanza.source_range
           url_domain = domain(stanza)
           add_offense(range, range, format(MSG_MISSING, url_domain, homepage, url_domain))
         end
 
-        def add_offense_unnecessary_comment(stanza)
+        def add_offense_no_match(stanza)
+          return if url_match_homepage?(stanza)
+          return unless comment?(stanza)
+          return if !url_match_homepage?(stanza) && comment_matches_url?(stanza)
+
           comment = comment(stanza).loc.expression
           add_offense(comment,
                       comment,
-                      format(MSG_UNNECESSARY, domain(stanza), homepage))
+                      format(MSG_NO_MATCH, url_from_comment(stanza), full_url(stanza)))
         end
 
-        def add_offense_no_match(stanza)
+        def add_offense_wrong_format(stanza)
+          return if url_match_homepage?(stanza)
+          return unless comment?(stanza)
+          return if comment_matches_format?(stanza)
+
           comment = comment(stanza).loc.expression
           add_offense(comment,
                       comment,
-                      format(MSG_NO_MATCH, url_from_comment(stanza), full_url(stanza)))
+                      format(MSG_WRONG_FORMAT, comment(stanza).text))
         end
 
         def comment?(stanza)
@@ -73,9 +97,13 @@ module RuboCop
           stanza.comments.last
         end
 
+        def comment_matches_format?(stanza)
+          comment(stanza).text =~ COMMENT_FORMAT
+        end
+
         def url_from_comment(stanza)
           comment(stanza).text
-            .sub(/.*# ([^ ]*) was verified as official when first introduced to the cask$/, '\1')
+            .sub(/[^ ]*# ([^ ]+) .*/, '\1')
         end
 
         def comment_matches_url?(stanza)

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

@@ -93,6 +93,31 @@ describe RuboCop::Cop::Cask::HomepageMatchesUrl do
   context 'when the url does not match the homepage' do
     context 'and there is a comment' do
       context 'which matches the url' do
+        context 'but does not match the expected format' do
+          let(:source) do
+            <<-CASK.undent
+              cask 'foo' do
+                # example.com was verified as official
+                url 'https://example.com/foo.zip'
+                homepage 'https://foo.example.org'
+              end
+            CASK
+          end
+          let(:expected_offenses) do
+            [{
+              message: '`# example.com was verified as official` does not ' \
+                       'match the expected comment format. For details, see ' \
+                      'https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/url.md#when-url-and-homepage-hostnames-differ-add-a-comment',
+              severity: :convention,
+              line: 2,
+              column: 2,
+              source: '# example.com was verified as official'
+            }]
+          end
+
+          include_examples 'reports offenses'
+        end
+
         context 'and does not have slashes' do
           let(:source) do
             <<-CASK.undent

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-cask
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Joshua Hagins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2016-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.43.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.43.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 description: |2
@@ -63,7 +63,10 @@ extra_rdoc_files:
 - MIT-LICENSE.md
 - README.md
 files:
+- MIT-LICENSE.md
+- README.md
 - config/default.yml
+- lib/rubocop-cask.rb
 - lib/rubocop/cask/ast/cask_block.rb
 - lib/rubocop/cask/ast/cask_header.rb
 - lib/rubocop/cask/ast/stanza.rb
@@ -77,9 +80,6 @@ files:
 - lib/rubocop/cop/cask/no_dsl_version.rb
 - lib/rubocop/cop/cask/stanza_grouping.rb
 - lib/rubocop/cop/cask/stanza_order.rb
-- lib/rubocop-cask.rb
-- MIT-LICENSE.md
-- README.md
 - spec/project_spec.rb
 - spec/rubocop/cop/cask/homepage_matches_url_spec.rb
 - spec/rubocop/cop/cask/no_dsl_version_spec.rb
@@ -97,17 +97,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Code style checking for Homebrew-Cask files