rubocop-cask 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c174d108070beae46129bf27159a945ac505691
-  data.tar.gz: cf04f6d393b83b38a63e2f9bfc8ea12d4dfedef6
+  metadata.gz: d6a5b8a17cf24bee4d483755261047e0b8e36545
+  data.tar.gz: 411f20070b3fe9c196afa06df99e3bd495080346
 SHA512:
-  metadata.gz: 0583722e3bba308c5ab2a4435ec89e8888cbab4f18535d7a1ba79f6c622682beafc372d8b935bac04dba082adef11c9f7cca3d91e7e459d4db525fe934f75f49
-  data.tar.gz: 22cdf650337a179ce424a0a82fa8e5e7fd4dfebcdb9cf58b561680b372b093206b1ea3b2e66c94d192a896384bc0708175af6fe7ea8b3411e5a9db0e74d041a5
+  metadata.gz: 4af05ad480b53239355e3622893caf33db75f510c161e18b6b9d44c1c4ef3207752b4c4d6b8a2b76c3eeaa50bdeab4b9e884d8984903b3f1cfa85949c4c8f45d
+  data.tar.gz: 30c12c402d6194e77bdf40077b0b8647da6103b64f7aabd6abde1c4fdfa20f09cc65d58d880bdf7457af6aaf5a0de76ec742792ac03818967073519644be348e

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

@@ -9,11 +9,12 @@ module RuboCop
       class CaskBlock
         extend Forwardable
 
-        def initialize(block_node)
+        def initialize(block_node, comments)
           @block_node = block_node
+          @comments = comments
         end
 
-        attr_reader :block_node
+        attr_reader :block_node, :comments
 
         alias_method :cask_node, :block_node
 
@@ -28,7 +29,7 @@ module RuboCop
         def stanzas
           @stanzas ||= cask_body.descendants
             .select(&:stanza?)
-            .map { |n| Stanza.new(n) }
+            .map { |node| Stanza.new(node, stanza_comments(node)) }
         end
 
         def toplevel_stanzas
@@ -56,6 +57,15 @@ module RuboCop
         def stanza_order_index(stanza)
           Constants::STANZA_ORDER.index(stanza.stanza_name)
         end
+
+        def stanza_comments(stanza_node)
+          comments_hash[stanza_node.loc]
+        end
+
+        def comments_hash
+          @comments_hash ||= Parser::Source::Comment
+            .associate_locations(cask_node, comments)
+        end
       end
     end
   end

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

@@ -9,22 +9,31 @@ module RuboCop
       class Stanza
         extend Forwardable
 
-        def initialize(method_node)
+        def initialize(method_node, comments)
           @method_node = method_node
+          @comments = comments
         end
 
-        attr_reader :method_node
+        attr_reader :method_node, :comments
 
         alias_method :stanza_node, :method_node
 
         def_delegator :stanza_node, :method_name, :stanza_name
         def_delegator :stanza_node, :parent, :parent_node
 
-        def expression
+        def source_range
           stanza_node.expression
         end
 
-        def_delegator :expression, :source
+        def source_range_with_comments
+          comments.reduce(source_range) do |range, comment|
+            range.join(comment.loc.expression)
+          end
+        end
+
+        def_delegator :source_range, :source
+        def_delegator :source_range_with_comments, :source,
+                      :source_with_comments
 
         def stanza_group
           Constants::STANZA_GROUP_HASH[stanza_name]

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

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

@@ -8,7 +8,9 @@ module RuboCop
           return unless respond_to?(:on_cask)
           return unless block_node.cask_block?
 
-          on_cask(block_node)
+          comments = processed_source.comments
+          cask_block = RuboCop::Cask::AST::CaskBlock.new(block_node, comments)
+          on_cask(cask_block)
         end
       end
     end

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

@@ -21,8 +21,8 @@ module RuboCop
 
         MESSAGE = 'Use `%s` instead of `%s`'
 
-        def on_cask(cask_node)
-          @cask_header = cask_header(cask_node.method_node)
+        def on_cask(cask_block)
+          @cask_header = cask_block.header
           return unless offense?
           offense
         end

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

@@ -17,8 +17,8 @@ module RuboCop
         EXTRA_LINE_MSG = 'stanzas within the same group should have no lines ' \
                          'between them'
 
-        def on_cask(cask_node)
-          @cask_block = RuboCop::Cask::AST::CaskBlock.new(cask_node)
+        def on_cask(cask_block)
+          @cask_block = cask_block
           @line_ops = {}
           add_offenses
         end
@@ -69,7 +69,7 @@ module RuboCop
         end
 
         def index_of_line_after(stanza)
-          stanza.expression.last_line
+          stanza.source_range.last_line
         end
 
         def add_offense_missing_line(stanza)

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

@@ -12,8 +12,8 @@ module RuboCop
 
         MESSAGE = '`%s` stanza out of order'
 
-        def on_cask(cask_node)
-          @cask_block = RuboCop::Cask::AST::CaskBlock.new(cask_node)
+        def on_cask(cask_block)
+          @cask_block = cask_block
           add_offenses
         end
 
@@ -21,7 +21,8 @@ module RuboCop
           lambda do |corrector|
             correct_stanza_index = toplevel_stanzas.index(stanza)
             correct_stanza = sorted_toplevel_stanzas[correct_stanza_index]
-            corrector.replace(stanza.expression, correct_stanza.source)
+            corrector.replace(stanza.source_range_with_comments,
+                              correct_stanza.source_with_comments)
           end
         end
 
@@ -34,7 +35,7 @@ module RuboCop
         def add_offenses
           offending_stanzas.each do |stanza|
             message = format(MESSAGE, stanza.stanza_name)
-            add_offense(stanza, stanza.expression, message)
+            add_offense(stanza, stanza.source_range_with_comments, message)
           end
         end
 

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

@@ -232,6 +232,48 @@ describe RuboCop::Cop::Cask::StanzaGrouping do
     include_examples 'autocorrects source'
   end
 
+  context 'when a stanza has a comment' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+          # comment with an empty line between
+
+          # comment directly above
+          postflight do
+            puts 'We have liftoff!'
+          end
+          url 'https://foo.example.com/foo.zip'
+          name 'Foo'
+          app 'Foo.app'
+        end
+      CASK
+    end
+    let(:correct_source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+
+          # comment with an empty line between
+
+          # comment directly above
+          postflight do
+            puts 'We have liftoff!'
+          end
+
+          url 'https://foo.example.com/foo.zip'
+          name 'Foo'
+
+          app 'Foo.app'
+        end
+      CASK
+    end
+
+    include_examples 'autocorrects source'
+  end
+
   # TODO: detect incorrectly grouped stanzas in nested expressions
   context 'when stanzas are nested in a conditional expression' do
     let(:source) do

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

@@ -154,6 +154,39 @@ describe RuboCop::Cop::Cask::StanzaOrder do
     end
   end
 
+  context 'when a stanza has a comment' do
+    let(:source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          # comment with an empty line between
+
+          # comment directly above
+          postflight do
+            puts 'We have liftoff!'
+          end
+          sha256 :no_check
+        end
+      CASK
+    end
+    let(:correct_source) do
+      <<-CASK.undent
+        cask 'foo' do
+          version :latest
+          sha256 :no_check
+          # comment with an empty line between
+
+          # comment directly above
+          postflight do
+            puts 'We have liftoff!'
+          end
+        end
+      CASK
+    end
+
+    include_examples 'autocorrects source'
+  end
+
   context 'when the caveats stanza is out of order' do
     let(:source) do
       format(<<-CASK.undent, caveats.strip)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-cask
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Joshua Hagins