rubocop-cask 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cdfd026586c969df6476b261c953b19a97c0d96
-  data.tar.gz: f5eec7b28ca3f9011a73505bb1caef81ccc09ed4
+  metadata.gz: eedae76807564012ce59a4b4a81af9751a851d2a
+  data.tar.gz: f7d783a06b07aaa8ddb2fdeec8f1ad9969851c40
 SHA512:
-  metadata.gz: 087b2408052d624ca8c94b59de9314474261bdd63f728e0673763fc76a3a7e750ce4288d19580ff83d6342b722989e0bebb0dcd430692ca97efe90e117583ead
-  data.tar.gz: 05aed98a4ea27b6ac1060476de4aa6b0a70a52ba9e41c7c2ff12824b9fbea4ff994e93bbb9bd40a6e8d6e6a582d6b28b7b4902bda59bb43a7660e1f6c6169fb8
+  metadata.gz: e3009d1c3e6233735a9d308720627f8e44a504270d730e52fb08b7734957bd4e4bd26d322a1baf3538e816b848dfcf533392ceb1fbc8c83c8b48ea4e0be9d90f
+  data.tar.gz: 65e425329851c85db2789774311a20b8fe6680638dc285ec703ee7e448be73e10bf6602de593ea639d855a912dd49355dd070c9fed9d2675e8e6e79fcf093e4c

data/README.md

@@ -1,11 +1,11 @@
 # RuboCop Cask
 
 [![Gem Version](https://badge.fury.io/rb/rubocop-cask.svg)](http://badge.fury.io/rb/rubocop-cask)
-[![Dependency Status](https://gemnasium.com/jawshooah/rubocop-cask.svg)](https://gemnasium.com/jawshooah/rubocop-cask)
-[![Build Status](https://travis-ci.org/jawshooah/rubocop-cask.svg?branch=master)](https://travis-ci.org/jawshooah/rubocop-cask)
-[![Coverage Status](https://img.shields.io/codeclimate/coverage/github/jawshooah/rubocop-cask.svg)](https://codeclimate.com/github/jawshooah/rubocop-cask)
-[![Code Climate](https://codeclimate.com/github/jawshooah/rubocop-cask/badges/gpa.svg)](https://codeclimate.com/github/jawshooah/rubocop-cask)
-[![Inline docs](http://inch-ci.org/github/jawshooah/rubocop-cask.svg)](http://inch-ci.org/github/jawshooah/rubocop-cask)
+[![Dependency Status](https://gemnasium.com/caskroom/rubocop-cask.svg)](https://gemnasium.com/caskroom/rubocop-cask)
+[![Build Status](https://travis-ci.org/caskroom/rubocop-cask.svg?branch=master)](https://travis-ci.org/caskroom/rubocop-cask)
+[![Coverage Status](https://img.shields.io/codeclimate/coverage/github/caskroom/rubocop-cask.svg)](https://codeclimate.com/github/caskroom/rubocop-cask)
+[![Code Climate](https://codeclimate.com/github/caskroom/rubocop-cask/badges/gpa.svg)](https://codeclimate.com/github/caskroom/rubocop-cask)
+[![Inline docs](http://inch-ci.org/github/caskroom/rubocop-cask.svg)](http://inch-ci.org/github/caskroom/rubocop-cask)
 
 Cask-specific analysis for your Homebrew-Cask taps, as an extension to
 [RuboCop](https://github.com/bbatsov/rubocop). Heavily inspired by [`rubocop-rspec`](https://github.com/nevir/rubocop-rspec).
@@ -78,7 +78,7 @@ Cask/NoDslVersion:
 For running the spec files, this project depends on RuboCop's spec helpers. This means that in order to run the specs locally, you need a (shallow) clone of the RuboCop repository:
 
 ```bash
-git clone --depth 1 git://github.com/bbatsov/rubocop.git vendor/rubocop
+git submodule update --init --depth 1 vendor/rubocop
 ```
 
 ## License

data/config/default.yml

@@ -1,3 +1,11 @@
 Cask/NoDslVersion:
   Description: 'Do not use the deprecated DSL version syntax in your cask header.'
   Enabled: true
+
+Cask/StanzaOrder:
+  Description: 'Ensure that cask stanzas are sorted correctly. More info at https://github.com/caskroom/homebrew-cask/blob/master/CONTRIBUTING.md#stanza-order'
+  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.rb

@@ -1,12 +1,17 @@
 require 'rubocop'
 
-require 'rubocop/cask/node_help'
+require 'rubocop/cask/constants'
+require 'rubocop/cask/extend/string'
+require 'rubocop/cask/extend/astrolabe/node'
 require 'rubocop/cask/cask_help'
-require 'rubocop/cask/cask_header'
-require 'rubocop/cask/cask_block'
+require 'rubocop/cask/ast/cask_header'
+require 'rubocop/cask/ast/cask_block'
+require 'rubocop/cask/ast/stanza'
 require 'rubocop/cask/version'
 require 'rubocop/cask/inject'
 
 RuboCop::Cask::Inject.defaults!
 
 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

@@ -0,0 +1,61 @@
+require 'forwardable'
+
+module RuboCop
+  module Cask
+    module AST
+      # This class wraps the AST block node that represents the entire cask
+      # definition. It includes various helper methods to aid cops in their
+      # analysis.
+      class CaskBlock
+        extend Forwardable
+
+        def initialize(block_node)
+          @block_node = block_node
+        end
+
+        attr_reader :block_node
+
+        alias_method :cask_node, :block_node
+
+        def cask_body
+          cask_node.block_body
+        end
+
+        def header
+          @header ||= CaskHeader.new(cask_node.method_node)
+        end
+
+        def stanzas
+          @stanzas ||= cask_body.each_descendant(:send)
+            .map { |n| Stanza.new(n) }
+        end
+
+        def toplevel_stanzas
+          @toplevel_stanzas ||= stanzas.select(&:toplevel_stanza?)
+        end
+
+        def sorted_toplevel_stanzas
+          @sorted_toplevel_stanzas ||= sort_stanzas(toplevel_stanzas)
+        end
+
+        private
+
+        def sort_stanzas(stanzas)
+          stanzas.sort do |s1, s2|
+            i1, i2 = [s1, s2].map { |s| stanza_order_index(s) }
+            if i1 != i2
+              i1 - i2
+            else
+              i1, i2 = [s1, s2].map { |s| stanzas.index(s) }
+              i1 - i2
+            end
+          end
+        end
+
+        def stanza_order_index(stanza)
+          Constants::STANZA_ORDER.index(stanza.stanza_name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module RuboCop
+  module Cask
+    module AST
+      # 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
+
+        def dsl_version?
+          hash_node
+        end
+
+        def test_cask?
+          header_method_name == :test_cask || dsl_version.to_s.include?('test')
+        end
+
+        def header_str
+          @header_str ||= source_range.source
+        end
+
+        def source_range
+          @source_range ||= method_node.loc.expression
+        end
+
+        def preferred_header_str
+          "#{preferred_header_method_name} '#{cask_token}'"
+        end
+
+        def preferred_header_method_name
+          test_cask? ? :test_cask : :cask
+        end
+
+        def header_method_name
+          @header_method_name ||= method_node.method_name
+        end
+
+        def dsl_version
+          @dsl_version ||= pair_node.key_node.children.first
+        end
+
+        def cask_token
+          @cask_token ||= pair_node.val_node.children.first
+        end
+
+        def hash_node
+          @hash_node ||= method_node.each_child_node(:hash).first
+        end
+
+        def pair_node
+          @pair_node ||= hash_node.each_child_node(:pair).first
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+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.
+      class Stanza
+        extend Forwardable
+
+        def initialize(method_node)
+          @method_node = method_node
+        end
+
+        attr_reader :method_node
+
+        alias_method :stanza_node, :method_node
+
+        def_delegator :stanza_node, :method_name, :stanza_name
+        def_delegator :stanza_node, :parent, :parent_node
+
+        def expression
+          stanza_node.expression
+        end
+
+        def_delegator :expression, :source
+
+        def stanza_group
+          Constants::STANZA_GROUP_HASH[stanza_name]
+        end
+
+        def same_group?(other)
+          stanza_group == other.stanza_group
+        end
+
+        def toplevel_stanza?
+          parent_node.parent.cask_block?
+        end
+
+        def ==(other)
+          self.class == other.class && stanza_node == other.stanza_node
+        end
+
+        alias_method :eql?, :==
+
+        Constants::STANZA_ORDER.each do |stanza_name|
+          class_eval <<-EOS, __FILE__, __LINE__
+            def #{stanza_name}?
+              stanza_name == :#{stanza_name}
+            end
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cask/cask_help.rb

@@ -2,30 +2,12 @@ module RuboCop
   module Cask
     # Common functionality for cops checking casks
     module CaskHelp
-      include NodeHelp
-
-      CASK_METHOD_NAMES = %i(cask test_cask)
-
-      def cask?(block_node)
-        block?(block_node) && cask_method?(method_node(block_node))
-      end
-
-      def cask_method?(method_node)
-        CASK_METHOD_NAMES.include?(method_name(method_node))
-      end
-
-      def cask_children(node)
-        node_children(node).select { |e| cask?(e) }
-      end
-
       def on_block(block_node)
         super if defined? super
         return unless respond_to?(:on_cask)
-        return unless cask?(block_node)
-
-        method_node, _args, block_body = *block_node
+        return unless block_node.cask_block?
 
-        on_cask(block_node, method_node, block_body)
+        on_cask(block_node)
       end
     end
   end

data/lib/rubocop/cask/constants.rb

@@ -0,0 +1,54 @@
+module RuboCop
+  module Cask
+    # Constants available globally for use in all Cask cops.
+    module Constants
+      CASK_METHOD_NAMES = [:cask, :test_cask].freeze
+
+      STANZA_GROUPS = [
+        [:version, :sha256],
+        [:url, :appcast, :name, :homepage, :license, :gpg],
+        [
+          :auto_updates,
+          :accessibility_access,
+          :conflicts_with,
+          :depends_on,
+          :container
+        ],
+        [
+          :suite,
+          :app,
+          :pkg,
+          :installer,
+          :binary,
+          :colorpicker,
+          :font,
+          :input_method,
+          :internet_plugin,
+          :prefpane,
+          :qlplugin,
+          :screen_saver,
+          :service,
+          :audio_unit_plugin,
+          :vst_plugin,
+          :artifact,
+          :stage_only
+        ],
+        [:preflight],
+        [:postflight],
+        [:uninstall_preflight],
+        [:uninstall_postflight],
+        [:uninstall],
+        [:zap],
+        [:caveats]
+      ].freeze
+
+      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
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Astrolabe
+  # Extensions for Astrolabe's AST Node class
+  class Node
+    include RuboCop::Cask::Constants
+
+    def_matcher :method_node, '{$(send ...) (block $(send ...) ...)}'
+    def_matcher :block_args,  '(block _ $_ _)'
+    def_matcher :block_body,  '(block _ _ $_)'
+
+    def_matcher :key_node,    '{(pair $_ _) (hash (pair $_ _) ...)}'
+    def_matcher :val_node,    '{(pair _ $_) (hash (pair _ $_) ...)}'
+
+    def cask_block?
+      block_type? && method_node.cask_header?
+    end
+
+    def cask_header?
+      send_type? && CASK_METHOD_NAMES.include?(method_name)
+    end
+
+    def heredoc?
+      loc.is_a?(Parser::Source::Map::Heredoc)
+    end
+
+    def expression
+      base_expression = loc.expression
+      descendants.select(&:heredoc?).reduce(base_expression) do |expr, node|
+        expr.join(node.loc.heredoc_end)
+      end
+    end
+  end
+end

data/lib/rubocop/cask/extend/string.rb

@@ -0,0 +1,6 @@
+# Utility method extensions for String
+class String
+  def undent
+    gsub(/^.{#{(slice(/^ +/) || '').length}}/, '')
+  end
+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.1.0'
+      STRING = '0.2.0'
 
       def self.gem_version
         Gem::Version.new(STRING)

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

@@ -21,8 +21,8 @@ module RuboCop
 
         MESSAGE = 'Use `%s` instead of `%s`'
 
-        def on_cask(_block_node, method_node, _block_body)
-          @cask_header = cask_header(method_node)
+        def on_cask(cask_node)
+          @cask_header = cask_header(cask_node.method_node)
           return unless offense?
           offense
         end
@@ -40,7 +40,7 @@ module RuboCop
         def_delegators :@cask_header, :header_str, :preferred_header_str
 
         def cask_header(method_node)
-          RuboCop::Cask::CaskHeader.new(method_node)
+          RuboCop::Cask::AST::CaskHeader.new(method_node)
         end
 
         def offense?

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

@@ -0,0 +1,96 @@
+require 'forwardable'
+require 'pry'
+
+module RuboCop
+  module Cop
+    module Cask
+      # This cop checks that a cask's stanzas are grouped correctly.
+      # See https://github.com/caskroom/homebrew-cask/blob/master/CONTRIBUTING.md#stanza-order
+      # for more info.
+      class StanzaGrouping < Cop
+        extend Forwardable
+        include RuboCop::Cask::CaskHelp
+
+        MISSING_LINE_MSG = 'stanza groups should be separated by a single ' \
+                           'empty line'
+
+        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)
+          @line_ops = {}
+          add_offenses
+        end
+
+        def autocorrect(range)
+          lambda do |corrector|
+            case line_ops[range.line - 1]
+            when :insert
+              corrector.insert_before(range, "\n")
+            when :remove
+              corrector.remove(range)
+            end
+          end
+        end
+
+        private
+
+        attr_reader :cask_block, :line_ops
+        def_delegators :cask_block, :cask_node, :toplevel_stanzas
+
+        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)
+              add_offense_extra_line(stanza)
+            end
+          end
+        end
+
+        def missing_line_after?(stanza, next_stanza)
+          !(stanza.same_group?(next_stanza) ||
+            empty_line_after?(stanza))
+        end
+
+        def extra_line_after?(stanza, next_stanza)
+          stanza.same_group?(next_stanza) &&
+            empty_line_after?(stanza)
+        end
+
+        def empty_line_after?(stanza)
+          source_line_after(stanza).empty?
+        end
+
+        def source_line_after(stanza)
+          processed_source[index_of_line_after(stanza)]
+        end
+
+        def index_of_line_after(stanza)
+          stanza.expression.last_line
+        end
+
+        def add_offense_missing_line(stanza)
+          line_index = index_of_line_after(stanza)
+          line_ops[line_index] = :insert
+          add_offense(line_index, MISSING_LINE_MSG)
+        end
+
+        def add_offense_extra_line(stanza)
+          line_index = index_of_line_after(stanza)
+          line_ops[line_index] = :remove
+          add_offense(line_index, EXTRA_LINE_MSG)
+        end
+
+        def add_offense(line_index, msg)
+          line_length = [processed_source[line_index].size, 1].max
+          range = source_range(processed_source.buffer, line_index + 1, 0,
+                               line_length)
+          super(range, range, msg)
+        end
+      end
+    end
+  end
+end