rubocop-cask 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eedae76807564012ce59a4b4a81af9751a851d2a
-  data.tar.gz: f7d783a06b07aaa8ddb2fdeec8f1ad9969851c40
+  metadata.gz: 4c174d108070beae46129bf27159a945ac505691
+  data.tar.gz: cf04f6d393b83b38a63e2f9bfc8ea12d4dfedef6
 SHA512:
-  metadata.gz: e3009d1c3e6233735a9d308720627f8e44a504270d730e52fb08b7734957bd4e4bd26d322a1baf3538e816b848dfcf533392ceb1fbc8c83c8b48ea4e0be9d90f
-  data.tar.gz: 65e425329851c85db2789774311a20b8fe6680638dc285ec703ee7e448be73e10bf6602de593ea639d855a912dd49355dd070c9fed9d2675e8e6e79fcf093e4c
+  metadata.gz: 0583722e3bba308c5ab2a4435ec89e8888cbab4f18535d7a1ba79f6c622682beafc372d8b935bac04dba082adef11c9f7cca3d91e7e459d4db525fe934f75f49
+  data.tar.gz: 22cdf650337a179ce424a0a82fa8e5e7fd4dfebcdb9cf58b561680b372b093206b1ea3b2e66c94d192a896384bc0708175af6fe7ea8b3411e5a9db0e74d041a5

data/lib/rubocop-cask.rb

@@ -3,7 +3,6 @@ require 'rubocop'
 require 'rubocop/cask/constants'
 require 'rubocop/cask/extend/string'
 require 'rubocop/cask/extend/astrolabe/node'
-require 'rubocop/cask/cask_help'
 require 'rubocop/cask/ast/cask_header'
 require 'rubocop/cask/ast/cask_block'
 require 'rubocop/cask/ast/stanza'
@@ -12,6 +11,7 @@ require 'rubocop/cask/inject'
 
 RuboCop::Cask::Inject.defaults!
 
+require 'rubocop/cop/cask/mixin/cask_help'
 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

@@ -26,7 +26,8 @@ module RuboCop
         end
 
         def stanzas
-          @stanzas ||= cask_body.each_descendant(:send)
+          @stanzas ||= cask_body.descendants
+            .select(&:stanza?)
             .map { |n| Stanza.new(n) }
         end
 

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

@@ -4,14 +4,12 @@ module RuboCop
       # This class wraps the AST method node that represents the cask header. It
       # includes various helper methods to aid cops in their analysis.
       class CaskHeader
-        include CaskHelp
-
-        attr_reader :method_node
-
         def initialize(method_node)
           @method_node = method_node
         end
 
+        attr_reader :method_node
+
         def dsl_version?
           hash_node
         end

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

@@ -3,9 +3,9 @@ require 'forwardable'
 module RuboCop
   module Cask
     module AST
-      # This class wraps the AST send node that encapsulates the method call
-      # that comprises the stanza. It includes various helper methods to aid
-      # cops in their analysis.
+      # This class wraps the AST send/block node that encapsulates the method
+      # call that comprises the stanza. It includes various helper methods to
+      # aid cops in their analysis.
       class Stanza
         extend Forwardable
 

data/lib/rubocop/cask/constants.rb

@@ -45,7 +45,6 @@ module RuboCop
       STANZA_GROUP_HASH =
         STANZA_GROUPS.each_with_object({}) do |stanza_group, hash|
           stanza_group.each { |stanza| hash[stanza] = stanza_group }
-          hash
         end.freeze
 
       STANZA_ORDER = STANZA_GROUPS.flatten.freeze

data/lib/rubocop/cask/extend/astrolabe/node.rb

@@ -18,6 +18,10 @@ module Astrolabe
       send_type? && CASK_METHOD_NAMES.include?(method_name)
     end
 
+    def stanza?
+      (send_type? || block_type?) && STANZA_ORDER.include?(method_name)
+    end
+
     def heredoc?
       loc.is_a?(Parser::Source::Map::Heredoc)
     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.0'
+      STRING = '0.2.1'
 
       def self.gem_version
         Gem::Version.new(STRING)

data/lib/rubocop/cop/cask/mixin/cask_help.rb

@@ -0,0 +1,16 @@
+module RuboCop
+  module Cop
+    module Cask
+      # Common functionality for cops checking casks
+      module CaskHelp
+        def on_block(block_node)
+          super if defined? super
+          return unless respond_to?(:on_cask)
+          return unless block_node.cask_block?
+
+          on_cask(block_node)
+        end
+      end
+    end
+  end
+end

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

@@ -17,7 +17,7 @@ module RuboCop
       #   end
       class NoDslVersion < Cop
         extend Forwardable
-        include RuboCop::Cask::CaskHelp
+        include CaskHelp
 
         MESSAGE = 'Use `%s` instead of `%s`'
 

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

@@ -9,7 +9,7 @@ module RuboCop
       # for more info.
       class StanzaGrouping < Cop
         extend Forwardable
-        include RuboCop::Cask::CaskHelp
+        include CaskHelp
 
         MISSING_LINE_MSG = 'stanza groups should be separated by a single ' \
                            'empty line'

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

@@ -8,7 +8,7 @@ module RuboCop
       # for more info.
       class StanzaOrder < Cop
         extend Forwardable
-        include RuboCop::Cask::CaskHelp
+        include CaskHelp
 
         MESSAGE = '`%s` stanza out of order'
 

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

@@ -29,7 +29,7 @@ describe RuboCop::Cop::Cask::NoDslVersion do
 
       include_examples 'reports offenses'
 
-      include_examples 'autocorrects offenses'
+      include_examples 'autocorrects source'
     end
 
     context 'with dsl version containing "test"' do
@@ -49,7 +49,7 @@ describe RuboCop::Cop::Cask::NoDslVersion do
 
       include_examples 'reports offenses'
 
-      include_examples 'autocorrects offenses'
+      include_examples 'autocorrects source'
     end
   end
 
@@ -78,7 +78,7 @@ describe RuboCop::Cop::Cask::NoDslVersion do
 
       include_examples 'reports offenses'
 
-      include_examples 'autocorrects offenses'
+      include_examples 'autocorrects source'
     end
   end
 end

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

@@ -54,7 +54,7 @@ describe RuboCop::Cop::Cask::StanzaGrouping do
 
     include_examples 'reports offenses'
 
-    include_examples 'autocorrects offenses'
+    include_examples 'autocorrects source'
   end
 
   context 'when many stanzas are incorrectly grouped' do
@@ -129,28 +129,24 @@ describe RuboCop::Cop::Cask::StanzaGrouping do
 
     include_examples 'reports offenses'
 
-    include_examples 'autocorrects offenses'
+    include_examples 'autocorrects source'
   end
 
-  context 'when a stanza includes a heredoc' do
+  context 'when caveats stanza is incorrectly grouped' do
     let(:source) do
-      <<-CASK.undent
+      format(<<-CASK.undent, caveats.strip)
         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'
+          %s
         end
       CASK
     end
     let(:correct_source) do
-      <<-CASK.undent
+      format(<<-CASK.undent, caveats.strip)
         cask 'foo' do
           version :latest
           sha256 :no_check
@@ -158,21 +154,82 @@ describe RuboCop::Cop::Cask::StanzaGrouping do
           url 'https://foo.example.com/foo.zip'
           name 'Foo'
 
+          app 'Foo.app'
+
+          %s
+        end
+      CASK
+    end
+
+    context 'when caveats is a one-line string' do
+      let(:caveats) { "caveats 'This is a one-line caveat.'" }
+
+      include_examples 'autocorrects source'
+    end
+
+    context 'when caveats is a heredoc' do
+      let(:caveats) do
+        <<-CAVEATS.undent
           caveats <<-EOS.undent
-            This is a multiline caveat.
+              This is a multiline caveat.
+
+              Let's hope it doesn't cause any problems!
+            EOS
+        CAVEATS
+      end
+
+      include_examples 'autocorrects source'
+    end
 
-            Let's hope it doesn't cause any problems!
-          EOS
+    context 'when caveats is a block' do
+      let(:caveats) do
+        <<-CAVEATS.undent
+          caveats do
+              puts 'This is a multiline caveat.'
 
+              puts "Let's hope it doesn't cause any problems!"
+            end
+        CAVEATS
+      end
+
+      include_examples 'autocorrects source'
+    end
+  end
+
+  context 'when the postflight stanza is 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'
           app 'Foo.app'
+          postflight do
+            puts 'We have liftoff!'
+          end
         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'
 
-    it 'autocorrects as expected' do
-      new_source = autocorrect_source(cop, source)
-      expect(new_source).to eq(Array(correct_source).join("\n"))
+          postflight do
+            puts 'We have liftoff!'
+          end
+        end
+      CASK
     end
+
+    include_examples 'autocorrects source'
   end
 
   # TODO: detect incorrectly grouped stanzas in nested expressions

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

@@ -54,7 +54,7 @@ describe RuboCop::Cop::Cask::StanzaOrder do
 
     include_examples 'reports offenses'
 
-    include_examples 'autocorrects offenses'
+    include_examples 'autocorrects source'
   end
 
   context 'when many stanzas are out of order' do
@@ -118,7 +118,7 @@ describe RuboCop::Cop::Cask::StanzaOrder do
 
     include_examples 'reports offenses'
 
-    include_examples 'autocorrects offenses'
+    include_examples 'autocorrects source'
   end
 
   context 'when a stanza appears multiple times' do
@@ -150,22 +150,80 @@ describe RuboCop::Cop::Cask::StanzaOrder do
     end
 
     it 'preserves the original order' do
-      new_source = autocorrect_source(cop, source)
-      expect(new_source).to eq(Array(correct_source).join("\n"))
+      expect_autocorrected_source(cop, source, correct_source)
     end
   end
 
-  context 'when a stanza includes a heredoc' do
+  context 'when the caveats stanza is out of order' do
     let(:source) do
-      <<-CASK.undent
+      format(<<-CASK.undent, caveats.strip)
         cask 'foo' do
           name 'Foo'
           url 'https://foo.example.com/foo.zip'
+          %s
+          version :latest
+          app 'Foo.app'
+          sha256 :no_check
+        end
+      CASK
+    end
+    let(:correct_source) do
+      format(<<-CASK.undent, caveats.strip)
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+          url 'https://foo.example.com/foo.zip'
+          name 'Foo'
+          app 'Foo.app'
+          %s
+        end
+      CASK
+    end
+
+    context 'when caveats is a one-line string' do
+      let(:caveats) { "caveats 'This is a one-line caveat.'" }
+
+      include_examples 'autocorrects source'
+    end
+
+    context 'when caveats is a heredoc' do
+      let(:caveats) do
+        <<-CAVEATS.undent
           caveats <<-EOS.undent
-            This is a multiline caveat.
+              This is a multiline caveat.
+
+              Let's hope it doesn't cause any problems!
+            EOS
+        CAVEATS
+      end
+
+      include_examples 'autocorrects source'
+    end
+
+    context 'when caveats is a block' do
+      let(:caveats) do
+        <<-CAVEATS.undent
+          caveats do
+              puts 'This is a multiline caveat.'
 
-            Let's hope it doesn't cause any problems!
-          EOS
+              puts "Let's hope it doesn't cause any problems!"
+            end
+        CAVEATS
+      end
+
+      include_examples 'autocorrects source'
+    end
+  end
+
+  context 'when the postflight stanza is out of order' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          name 'Foo'
+          url 'https://foo.example.com/foo.zip'
+          postflight do
+            puts 'We have liftoff!'
+          end
           version :latest
           app 'Foo.app'
           sha256 :no_check
@@ -180,19 +238,14 @@ describe RuboCop::Cop::Cask::StanzaOrder do
           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
+          postflight do
+            puts 'We have liftoff!'
+          end
         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
+    include_examples 'autocorrects source'
   end
 
   # TODO: detect out-of-order stanzas in nested expressions

data/spec/support/cop_shared_examples.rb

@@ -1,25 +1,32 @@
 module CopSharedExamples
   shared_examples 'does not report any offenses' do
     it 'does not report any offenses' do
-      inspect_source(cop, source)
-      expect(cop.offenses).to be_empty
+      expect_no_offenses(cop, source)
     end
   end
 
   shared_examples 'reports offenses' do
     it 'reports offenses' do
-      inspect_source(cop, source)
-      expect(cop.offenses.size).to eq(expected_offenses.size)
-      expected_offenses.zip(cop.offenses).each do |expected, actual|
-        expect_offense(expected, actual)
-      end
+      expect_reported_offenses(cop, source, expected_offenses)
     end
   end
 
-  shared_examples 'autocorrects offenses' do
-    it 'autocorrects offenses' do
-      new_source = autocorrect_source(cop, source)
-      expect(new_source).to eq(Array(correct_source).join("\n"))
+  shared_examples 'autocorrects source' do
+    it 'autocorrects source' do
+      expect_autocorrected_source(cop, source, correct_source)
+    end
+  end
+
+  def expect_no_offenses(cop, source)
+    inspect_source(cop, source)
+    expect(cop.offenses).to be_empty
+  end
+
+  def expect_reported_offenses(cop, source, expected_offenses)
+    inspect_source(cop, source)
+    expect(cop.offenses.size).to eq(expected_offenses.size)
+    expected_offenses.zip(cop.offenses).each do |expected, actual|
+      expect_offense(expected, actual)
     end
   end
 
@@ -30,4 +37,9 @@ module CopSharedExamples
     expect(actual.column).to eq(expected[:column])
     expect(actual.location.source).to eq(expected[:source])
   end
+
+  def expect_autocorrected_source(cop, source, correct_source)
+    new_source = autocorrect_source(cop, source)
+    expect(new_source).to eq(Array(correct_source).join("\n"))
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-cask
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Joshua Hagins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-03 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,12 +42,12 @@ files:
 - lib/rubocop/cask/ast/cask_block.rb
 - lib/rubocop/cask/ast/cask_header.rb
 - lib/rubocop/cask/ast/stanza.rb
-- lib/rubocop/cask/cask_help.rb
 - lib/rubocop/cask/constants.rb
 - lib/rubocop/cask/extend/astrolabe/node.rb
 - lib/rubocop/cask/extend/string.rb
 - lib/rubocop/cask/inject.rb
 - lib/rubocop/cask/version.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

data/lib/rubocop/cask/cask_help.rb

@@ -1,14 +0,0 @@
-module RuboCop
-  module Cask
-    # Common functionality for cops checking casks
-    module CaskHelp
-      def on_block(block_node)
-        super if defined? super
-        return unless respond_to?(:on_cask)
-        return unless block_node.cask_block?
-
-        on_cask(block_node)
-      end
-    end
-  end
-end