rubocop-cask 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d63ca3e510db69b8d8f41d4510b8a5c22e3fa924e77f24098db8c807db0be1f5
-  data.tar.gz: 914b9055ffb625f72a1b24c818dc86c4e3a61ad0c7f7168620b52acca8855945
+  metadata.gz: 22d2072108140f809e919c9f1bfe3c9a7fbf095c5d16b2db1a5eb1c1ac2f5db5
+  data.tar.gz: db42b732f5139900a29cc9d461f7c405ae861fd515b280a6b517d772985cf313
 SHA512:
-  metadata.gz: f5ff3d83882fbc630b5aa9ff880635d86f89971356badb2855f79750f741ba086f01e3710f86908f0ae29644a891fd958a4cec99d4ac04539fe3b7cf747b710e
-  data.tar.gz: 07d5b5f3858b593a7d26d39b4e804337f53fa6413354dc5efcd2e6789265dcad51860484ccd76c61aa84663b077e1d32f73ce0520103981208128f282b8e53fa
+  metadata.gz: 7cedcd755c015b5cdcd97245f8c7c4feef9e51d24cdacc0a033376facea45a83b8f83b0be53cfb23a851b6183f5fcabbc7a87c9d952a6d9cb37ed186b312dfb3
+  data.tar.gz: b99489754639d326f3d3fcc3323301a26d75e55b76e07d83ab88f6f8d9aaa5b6a44bc6073cea2c2f933681d9c4241b2fecb9e99cba6a6ac226608d6ce397a1c3

data/README.md

@@ -66,21 +66,21 @@ Cask/NoDslVersion:
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1. Fork it.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create new pull request.
 
 
 ## Maintaining
 
 To publish a new release:
 
-  1. update the version in `lib/rubocop/cask/version.rb`
-  2. run `bundle exec rake build` to run tests and generate the changelog
-  3. commit the changes
-  4. run `bundle exec rake release`
+  1. Update the version in `lib/rubocop/cask/version.rb`.
+  2. Run `bundle exec rake build` to run tests and generate the changelog.
+  3. Commit the changes.
+  4. Create a new tag on GitHub.
 
 
 ## License

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

@@ -26,6 +26,7 @@ module RuboCop
 
         def stanzas
           return [] unless cask_body
+
           @stanzas ||= cask_body.each_node
             .select(&:stanza?)
             .map { |node| Stanza.new(node, stanza_comments(node)) }

data/lib/rubocop/cask/version.rb

@@ -3,6 +3,6 @@ require 'rubygems'
 module RuboCop
   module Cask
     # Version information for the Cask RuboCop plugin.
-    VERSION = '0.21.0'.freeze
+    VERSION = '0.22.0'.freeze
   end
 end

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

@@ -30,6 +30,7 @@ module RuboCop
         def on_cask(cask_block)
           @cask_block = cask_block
           return unless homepage_stanza
+
           add_offenses
         end
 
@@ -122,6 +123,7 @@ module RuboCop
         def extract_url(stanza)
           string = stanza.stanza_node.children[2]
           return string.str_content if string.str_type?
+
           string.to_s.gsub(%r{.*"([a-z0-9]+\:\/\/[^"]+)".*}m, '\1')
         end
 

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

@@ -16,6 +16,7 @@ module RuboCop
           url = url_node.str_content
 
           return if url !~ %r{^.+://[^/]+$}
+
           add_offense(url_node, location: :expression,
                                 message: format(MSG_NO_SLASH, url: url))
         end

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

@@ -24,6 +24,7 @@ module RuboCop
         def on_cask(cask_block)
           @cask_header = cask_block.header
           return unless offense?
+
           offense
         end
 

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

@@ -42,6 +42,7 @@ module RuboCop
         def add_offenses
           toplevel_stanzas.each_cons(2) do |stanza, next_stanza|
             next unless next_stanza
+
             if missing_line_after?(stanza, next_stanza)
               add_offense_missing_line(stanza)
             elsif extra_line_after?(stanza, next_stanza)

data/spec/rubocop/cask_spec.rb

@@ -0,0 +1,37 @@
+describe RuboCop::Cask do
+  describe 'the default configuration file' do
+    subject(:default_config) {
+      RuboCop::ConfigLoader.load_file('config/default.yml')
+    }
+
+    let(:cop_names) {
+      cop_files = Dir.glob(File.join(__dir__, '..', '..', 'lib',
+                                     'rubocop', 'cop', 'cask', '*.rb'))
+      cop_files.map { |file|
+        cop_name = File.basename(file, '.rb')
+          .gsub(/(^|_)(.)/) { Regexp.last_match(2).upcase }
+
+        "Cask/#{cop_name}"
+      }
+    }
+
+    let(:cask_config_keys) {
+      default_config.keys.select { |k| k.start_with?('Cask/') }
+    }
+
+    it 'includes all cops' do
+      expect(cask_config_keys.sort).to eq(cop_names.sort)
+    end
+
+    matcher :have_a_description do
+      match do |cop_name|
+        expect(default_config[cop_name]['Description']).not_to be nil
+        expect(default_config[cop_name]['Description']).not_to include("\n")
+      end
+    end
+
+    it 'has a nicely formatted description for all cops' do
+      expect(cop_names).to all have_a_description
+    end
+  end
+end

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

@@ -3,176 +3,172 @@ describe RuboCop::Cop::Cask::HomepageMatchesUrl do
 
   subject(:cop) { described_class.new }
 
-  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'
+  context 'when the url matches the homepage 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
 
-    context 'and the url stanza has a referrer' do
-      context 'and no interpolation' do
-        let(:source) do
-          <<-CASK.undent
-            cask 'foo' do
-              url 'https://foo.example.com/foo.zip',
-                  referrer: 'https://example.com/foo/'
-              homepage 'https://foo.example.com'
-            end
-          CASK
+    include_examples 'does not report any offenses'
+  end
+
+  context 'when the url matches the homepage and the url stanza has ' \
+          'a referrer and no interpolation' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          url 'https://foo.example.com/foo.zip',
+              referrer: 'https://example.com/foo/'
+          homepage 'https://foo.example.com'
         end
+      CASK
+    end
 
-        include_examples 'does not report any offenses'
-      end
+    include_examples 'does not report any offenses'
+  end
 
-      context 'and interpolation' do
-        let(:source) do
-          <<-CASK.undent
-            cask 'foo' do
-              version '1.8.0_72,8.13.0.5'
-              url "https://foo.example.com/foo-\#{version.after_comma}-\#{version.minor}.\#{version.patch}.\#{version.before_comma.sub(\%r{.*_}, '')}.zip",
-                  referrer: 'https://example.com/foo/'
-              homepage 'https://foo.example.com'
-            end
-          CASK
+  context 'when the url matches the homepage and the url stanza has ' \
+          'a referrer and interpolation' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version '1.8.0_72,8.13.0.5'
+          url "https://foo.example.com/foo-\#{version.after_comma}-\#{version.minor}.\#{version.patch}.\#{version.before_comma.sub(\%r{.*_}, '')}.zip",
+              referrer: 'https://example.com/foo/'
+          homepage 'https://foo.example.com'
         end
-
-        include_examples 'does not report any offenses'
-      end
+      CASK
     end
 
-    context 'but there is a comment' do
-      context 'which does not match the url' do
-        let(:source) do
-          <<-CASK.undent
-            cask 'foo' do
-              # this is just a comment with information
-              url 'https://example.com/foo.zip'
-              homepage 'https://example.com'
-            end
-          CASK
+    include_examples 'does not report any offenses'
+  end
+
+  context 'when the url matches the homepage but there is a comment ' \
+          'which does not match the url' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          # this is just a comment with information
+          url 'https://example.com/foo.zip'
+          homepage 'https://example.com'
         end
+      CASK
+    end
 
-        include_examples 'does not report any offenses'
-      end
+    include_examples 'does not report any offenses'
+  end
 
-      context 'which matches the url' 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 `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'
-          }]
+  context 'when the url matches the homepage ' \
+          'but there is a comment matching the url' 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
-
-        include_examples 'reports offenses'
-      end
+      CASK
+    end
+    let(:expected_offenses) do
+      [{
+        message: '`foo.example.com` matches `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
 
   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/Homebrew/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'
-            }]
+    context 'when there is a comment matching the url ' \
+            'but not matching 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/Homebrew/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
+      include_examples 'reports offenses'
+    end
 
-        context 'and does not have slashes' 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.org'
-              end
-            CASK
+    context 'when there is a comment matching the url ' \
+            'and does not have slashes' 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.org'
           end
+        CASK
+      end
 
-          include_examples 'does not report any offenses'
-        end
+      include_examples 'does not report any offenses'
+    end
 
-        context 'and has slashes' do
-          let(:source) do
-            <<-CASK.undent
-              cask 'foo' do
-                # example.com/vendor/app was verified as official when first introduced to the cask
-                url 'https://downloads.example.com/vendor/app/foo.zip'
-                homepage 'https://vendor.example.org/app/'
-              end
-            CASK
+    context 'when there is a comment matching the url and has slashes' do
+      let(:source) do
+        <<-CASK.undent
+          cask 'foo' do
+            # example.com/vendor/app was verified as official when first introduced to the cask
+            url 'https://downloads.example.com/vendor/app/foo.zip'
+            homepage 'https://vendor.example.org/app/'
           end
-
-          include_examples 'does not report any offenses'
-        end
+        CASK
       end
 
-      context 'which does not match 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.org/foo.zip'
-              homepage 'https://foo.example.com'
-            end
-          CASK
-        end
-        let(:expected_offenses) do
-          [{
-            message: '`example.com` does not match `example.org/foo.zip`',
-            severity: :convention,
-            line: 2,
-            column: 2,
-            source: '# example.com was verified as official when ' \
-                    'first introduced to the cask'
-          }]
-        end
+      include_examples 'does not report any offenses'
+    end
 
-        include_examples 'reports offenses'
+    context 'when there is a comment which does not match 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.org/foo.zip'
+            homepage 'https://foo.example.com'
+          end
+        CASK
+      end
+      let(:expected_offenses) do
+        [{
+          message: '`example.com` does not match `example.org/foo.zip`',
+          severity: :convention,
+          line: 2,
+          column: 2,
+          source: '# example.com was verified as official when ' \
+                  'first introduced to the cask'
+        }]
       end
+
+      include_examples 'reports offenses'
     end
 
-    context 'but the comment is missing' do
+    context 'when the comment is missing' do
       let(:source) do
         <<-CASK.undent
           cask 'foo' do

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

@@ -15,48 +15,46 @@ describe RuboCop::Cop::Cask::HomepageUrlTrailingSlash do
     include_examples 'does not report any offenses'
   end
 
-  context 'when the homepage url does not end with a slash' do
-    context 'but has a path' do
-      let(:source) do
-        <<-CASK.undent
-          cask 'foo' do
-            homepage 'https://foo.example.com/path'
-          end
-        CASK
-      end
-
-      include_examples 'does not report any offenses'
+  context 'when the homepage url does not end with a slash but has a path' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          homepage 'https://foo.example.com/path'
+        end
+      CASK
     end
 
-    context 'and has no path' do
-      let(:source) do
-        <<-CASK.undent
-          cask 'foo' do
-            homepage 'https://foo.example.com'
-          end
-        CASK
-      end
-      let(:correct_source) do
-        <<-CASK.undent
-          cask 'foo' do
-            homepage 'https://foo.example.com/'
-          end
-        CASK
-      end
-      let(:expected_offenses) do
-        [{
-          message: "'https://foo.example.com' must have a slash "\
-                   'after the domain.',
-          severity: :convention,
-          line: 2,
-          column: 11,
-          source: "'https://foo.example.com'"
-        }]
-      end
-
-      include_examples 'reports offenses'
-
-      include_examples 'autocorrects source'
+    include_examples 'does not report any offenses'
+  end
+
+  context 'when the homepage url does not end with a slash and has no path' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          homepage 'https://foo.example.com'
+        end
+      CASK
     end
+    let(:correct_source) do
+      <<-CASK.undent
+        cask 'foo' do
+          homepage 'https://foo.example.com/'
+        end
+      CASK
+    end
+    let(:expected_offenses) do
+      [{
+        message: "'https://foo.example.com' must have a slash "\
+                 'after the domain.',
+        severity: :convention,
+        line: 2,
+        column: 11,
+        source: "'https://foo.example.com'"
+      }]
+    end
+
+    include_examples 'reports offenses'
+
+    include_examples 'autocorrects source'
   end
 end

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

@@ -2,6 +2,7 @@ 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

data/spec/spec_helper.rb

@@ -7,7 +7,9 @@ if ENV['COVERAGE']
 end
 
 project_path = File.join(File.dirname(__FILE__), '..')
-Dir["#{project_path}/spec/support/**/*.rb"].each { |f| require f }
+Dir["#{project_path}/spec/support/**/*.rb"].each do |f|
+  require f
+end
 
 RSpec.configure do |config|
   config.order = :random
@@ -21,6 +23,5 @@ RSpec.configure do |config|
   end
 end
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(__dir__, '..', 'lib'))
 require 'rubocop-cask'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-cask
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Joshua Hagins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-16 00:00:00.000000000 Z
+date: 2018-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: public_suffix
@@ -16,28 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 0.59.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 0.59.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
       Code style checking for Homebrew-Cask files.
       A plugin for the RuboCop code style enforcing & linting tool.
@@ -81,7 +101,7 @@ files:
 - 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/cask_spec.rb
 - spec/rubocop/cop/cask/homepage_matches_url_spec.rb
 - spec/rubocop/cop/cask/homepage_url_trailing_slash_spec.rb
 - spec/rubocop/cop/cask/no_dsl_version_spec.rb
@@ -114,7 +134,7 @@ signing_key:
 specification_version: 4
 summary: Code style checking for Homebrew-Cask files
 test_files:
-- spec/project_spec.rb
+- spec/rubocop/cask_spec.rb
 - spec/rubocop/cop/cask/homepage_matches_url_spec.rb
 - spec/rubocop/cop/cask/homepage_url_trailing_slash_spec.rb
 - spec/rubocop/cop/cask/no_dsl_version_spec.rb

data/spec/project_spec.rb

@@ -1,34 +0,0 @@
-describe 'RuboCop Project' do
-  describe 'default configuration file' do
-    let(:cop_names) do
-      cop_files = Dir.glob(File.join(File.dirname(__FILE__), '..', 'lib',
-                                     'rubocop', 'cop', 'cask', '*.rb'))
-      cop_files.map do |file|
-        cop_name = File.basename(file, '.rb')
-          .gsub(/(^|_)(.)/) { Regexp.last_match(2).upcase }
-
-        "Cask/#{cop_name}"
-      end
-    end
-
-    subject(:default_config) do
-      RuboCop::ConfigLoader.load_file('config/default.yml')
-    end
-
-    let(:cask_config_keys) do
-      default_config.keys.select { |k| k.start_with?('Cask/') }
-    end
-
-    it 'has configuration for all cops' do
-      expect(cask_config_keys.sort).to eq(cop_names.sort)
-    end
-
-    it 'has a nicely formatted description for all cops' do
-      cop_names.each do |name|
-        description = default_config[name]['Description']
-        expect(description).not_to be_nil
-        expect(description).not_to include("\n")
-      end
-    end
-  end
-end