rubocop-cask 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7bfd4f036ef39c44b9eb7b4674f42f9b01914c8
-  data.tar.gz: 22211aefd4d93daeb700fcdbb2b1749b539cbc5f
+  metadata.gz: 9cdfd026586c969df6476b261c953b19a97c0d96
+  data.tar.gz: f5eec7b28ca3f9011a73505bb1caef81ccc09ed4
 SHA512:
-  metadata.gz: 7ff1dfab7f15095c227549f4dc54d44c1cab1c398b64767c070c01e38d60b46f65f4c5233ae1a101111428a1e1bcfc436f8c18f1a2f43c9aa60c976a73134689
-  data.tar.gz: 5807adcf506a9da06929422184d3d831665abf94d5f532d0c11d801f86718812b78f54cb7023af5d7f8ccdae348ff452ddd65892def4bfa64ee3f703a824266a
+  metadata.gz: 087b2408052d624ca8c94b59de9314474261bdd63f728e0673763fc76a3a7e750ce4288d19580ff83d6342b722989e0bebb0dcd430692ca97efe90e117583ead
+  data.tar.gz: 05aed98a4ea27b6ac1060476de4aa6b0a70a52ba9e41c7c2ff12824b9fbea4ff994e93bbb9bd40a6e8d6e6a582d6b28b7b4902bda59bb43a7660e1f6c6169fb8

data/lib/rubocop-cask.rb

@@ -1,5 +1,9 @@
 require 'rubocop'
 
+require 'rubocop/cask/node_help'
+require 'rubocop/cask/cask_help'
+require 'rubocop/cask/cask_header'
+require 'rubocop/cask/cask_block'
 require 'rubocop/cask/version'
 require 'rubocop/cask/inject'
 

data/lib/rubocop/cask/cask_block.rb

@@ -0,0 +1,20 @@
+module RuboCop
+  module Cask
+    # 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
+      include CaskHelp
+
+      attr_reader :block_node
+
+      def initialize(block_node)
+        @block_node = block_node
+      end
+
+      def header
+        @header ||= CaskHeader.new(method_node(block_node))
+      end
+    end
+  end
+end

data/lib/rubocop/cask/cask_header.rb

@@ -0,0 +1,59 @@
+module RuboCop
+  module Cask
+    # 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_name(method_node)
+      end
+
+      def dsl_version
+        @dsl_version ||= key_node(pair_node).children.first
+      end
+
+      def cask_token
+        @cask_token ||= value_node(pair_node).children.first
+      end
+
+      def hash_node
+        @hash_node ||= hash_children(method_node).first
+      end
+
+      def pair_node
+        @pair_node ||= pair_children(hash_node).first
+      end
+    end
+  end
+end

data/lib/rubocop/cask/cask_help.rb

@@ -0,0 +1,32 @@
+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
+
+        on_cask(block_node, method_node, block_body)
+      end
+    end
+  end
+end

data/lib/rubocop/cask/node_help.rb

@@ -0,0 +1,81 @@
+module RuboCop
+  module Cask
+    # Helpers for traversing AST nodes
+    module NodeHelp
+      def root_node
+        processed_source.ast
+      end
+
+      def node?(node, type: nil)
+        return unless node.is_a?(Parser::AST::Node)
+        type ? node.type == type : true
+      end
+
+      def method?(node)
+        node?(node, type: :send)
+      end
+
+      def block?(node)
+        node?(node, type: :block)
+      end
+
+      def hash?(node)
+        node?(node, type: :hash)
+      end
+
+      def pair?(node)
+        node?(node, type: :pair)
+      end
+
+      def node_children(node, type: nil)
+        node.children.select { |e| node?(e, type: type) }
+      end
+
+      def method_children(node)
+        node_children(node, type: :send)
+      end
+
+      def block_children(node)
+        node_children(node, type: :block)
+      end
+
+      def hash_children(node)
+        node_children(node, type: :hash)
+      end
+
+      def pair_children(node)
+        node_children(node, type: :pair)
+      end
+
+      def method_node(block_node)
+        fail 'Not a block node' unless block?(block_node)
+        method_node, _args, _body = *block_node
+        method_node
+      end
+
+      def method_name(method_node)
+        fail 'Not a send node' unless method?(method_node)
+        _receiver, method_name, *_method_args = *method_node
+        method_name
+      end
+
+      def method_args(method_node)
+        fail 'Not a send node' unless method?(method_node)
+        _receiver, _method_name, *method_args = *method_node
+        method_args
+      end
+
+      def key_node(pair_node)
+        fail 'Not a pair node' unless pair?(pair_node)
+        key_node, _value_node = *pair_node
+        key_node
+      end
+
+      def value_node(pair_node)
+        fail 'Not a pair node' unless pair?(pair_node)
+        _key_node, value_node = *pair_node
+        value_node
+      end
+    end
+  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.0.1'
+      STRING = '0.1.0'
 
       def self.gem_version
         Gem::Version.new(STRING)

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

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 module RuboCop
   module Cop
     module Cask
@@ -14,34 +16,43 @@ module RuboCop
       #     ...
       #   end
       class NoDslVersion < Cop
+        extend Forwardable
+        include RuboCop::Cask::CaskHelp
+
         MESSAGE = 'Use `%s` instead of `%s`'
 
-        CASK_METHOD_NAMES = [:cask, :test_cask]
+        def on_cask(_block_node, method_node, _block_body)
+          @cask_header = cask_header(method_node)
+          return unless offense?
+          offense
+        end
 
-        def on_block(node)
-          method, _args, _body = node.children
-          _receiver, method_name, object = method.children
-          return unless CASK_METHOD_NAMES.include?(method_name)
-          check(method_name, object)
+        def autocorrect(method_node)
+          @cask_header = cask_header(method_node)
+          lambda do |corrector|
+            corrector.replace(header_range, preferred_header_str)
+          end
         end
 
         private
 
-        def check(method_name, object)
-          return unless object.type == :hash
-          message = build_message(method_name, object)
-          add_offense(object, :expression, message)
+        def_delegator :@cask_header, :source_range, :header_range
+        def_delegators :@cask_header, :header_str, :preferred_header_str
+
+        def cask_header(method_node)
+          RuboCop::Cask::CaskHeader.new(method_node)
+        end
+
+        def offense?
+          @cask_header.dsl_version?
+        end
+
+        def offense
+          add_offense(@cask_header.method_node, header_range, error_msg)
         end
 
-        def build_message(method_name, object)
-          left, right = *object.children.first
-          cask_token = right.children.first
-          dsl_version_str = left.children.first.to_s
-          new_method_name =
-            dsl_version_str.include?('test') ? :test_cask : method_name
-          preferred_header = "#{new_method_name} '#{cask_token}'"
-          actual_header = "#{method_name} #{object.loc.expression.source}"
-          format(MESSAGE, preferred_header, actual_header)
+        def error_msg
+          format(MESSAGE, preferred_header_str, header_str)
         end
       end
     end

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

@@ -1,58 +1,105 @@
 describe RuboCop::Cop::Cask::NoDslVersion do
   subject(:cop) { described_class.new }
 
-  it 'checks for dsl version in cask header' do
-    inspect_source(cop, [
-      "cask :v1 => 'foo' do",
-      'end'
-    ])
-    expect(cop.offenses.size).to eq(1)
-    expect(cop.offenses.first.line).to eq(1)
-    expect(cop.messages)
-      .to eq(["Use `cask 'foo'` instead of `cask :v1 => 'foo'`"])
-    expect(cop.highlights)
-      .to eq([":v1 => 'foo'"])
-  end
+  context 'with header method `cask`' do
+    context 'with no dsl version' do
+      it 'passes' do
+        inspect_source(cop, [
+          "cask 'foo' do",
+          'end'
+        ])
+        expect(cop.offenses).to be_empty
+      end
+    end
 
-  it 'checks for dsl version with test in cask header' do
-    inspect_source(cop, [
-      "cask :v1test => 'foo' do",
-      'end'
-    ])
-    expect(cop.offenses.size).to eq(1)
-    expect(cop.offenses.first.line).to eq(1)
-    expect(cop.messages)
-      .to eq(["Use `test_cask 'foo'` instead of `cask :v1test => 'foo'`"])
-    expect(cop.highlights)
-      .to eq([":v1test => 'foo'"])
-  end
+    context 'with dsl version' do
+      it 'fails' do
+        inspect_source(cop, [
+          "cask :v1 => 'foo' do",
+          'end'
+        ])
+        expect(cop.offenses.size).to eq(1)
+        expect(cop.offenses.first.line).to eq(1)
+        expect(cop.messages)
+          .to eq(["Use `cask 'foo'` instead of `cask :v1 => 'foo'`"])
+        expect(cop.highlights)
+          .to eq(["cask :v1 => 'foo'"])
+      end
 
-  it 'ignores cask header with no dsl version' do
-    inspect_source(cop, [
-      "cask 'foo' do",
-      'end'
-    ])
-    expect(cop.offenses).to be_empty
-  end
+      it 'autocorrects' do
+        new_source = autocorrect_source(cop, [
+          "cask :v1 => 'foo' do",
+          'end'
+        ])
+        expect(new_source).to eq([
+          "cask 'foo' do",
+          'end'
+        ].join("\n"))
+      end
+    end
 
-  it 'checks for dsl version in test_cask header' do
-    inspect_source(cop, [
-      "test_cask :v1 => 'foo' do",
-      'end'
-    ])
-    expect(cop.offenses.size).to eq(1)
-    expect(cop.offenses.first.line).to eq(1)
-    expect(cop.messages)
-      .to eq(["Use `test_cask 'foo'` instead of `test_cask :v1 => 'foo'`"])
-    expect(cop.highlights)
-      .to eq([":v1 => 'foo'"])
+    context 'with dsl version containing "test"' do
+      it 'fails' do
+        inspect_source(cop, [
+          "cask :v1test => 'foo' do",
+          'end'
+        ])
+        expect(cop.offenses.size).to eq(1)
+        expect(cop.offenses.first.line).to eq(1)
+        expect(cop.messages)
+          .to eq(["Use `test_cask 'foo'` instead of `cask :v1test => 'foo'`"])
+        expect(cop.highlights)
+          .to eq(["cask :v1test => 'foo'"])
+      end
+
+      it 'autocorrects' do
+        new_source = autocorrect_source(cop, [
+          "cask :v1test => 'foo' do",
+          'end'
+        ])
+        expect(new_source).to eq([
+          "test_cask 'foo' do",
+          'end'
+        ].join("\n"))
+      end
+    end
   end
 
-  it 'ignores test_cask header with no dsl version' do
-    inspect_source(cop, [
-      "test_cask 'foo' do",
-      'end'
-    ])
-    expect(cop.offenses).to be_empty
+  context 'with header method `test_cask`' do
+    context 'with no dsl version' do
+      it 'passes' do
+        inspect_source(cop, [
+          "test_cask 'foo' do",
+          'end'
+        ])
+        expect(cop.offenses).to be_empty
+      end
+    end
+
+    context 'with dsl version' do
+      it 'fails' do
+        inspect_source(cop, [
+          "test_cask :v1 => 'foo' do",
+          'end'
+        ])
+        expect(cop.offenses.size).to eq(1)
+        expect(cop.offenses.first.line).to eq(1)
+        expect(cop.messages)
+          .to eq(["Use `test_cask 'foo'` instead of `test_cask :v1 => 'foo'`"])
+        expect(cop.highlights)
+          .to eq(["test_cask :v1 => 'foo'"])
+      end
+
+      it 'autocorrects' do
+        new_source = autocorrect_source(cop, [
+          "test_cask :v1 => 'foo' do",
+          'end'
+        ])
+        expect(new_source).to eq([
+          "test_cask 'foo' do",
+          'end'
+        ].join("\n"))
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-cask
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Joshua Hagins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,13 +39,17 @@ files:
 - README.md
 - config/default.yml
 - lib/rubocop-cask.rb
+- lib/rubocop/cask/cask_block.rb
+- lib/rubocop/cask/cask_header.rb
+- lib/rubocop/cask/cask_help.rb
 - lib/rubocop/cask/inject.rb
+- lib/rubocop/cask/node_help.rb
 - lib/rubocop/cask/version.rb
 - lib/rubocop/cop/cask/no_dsl_version.rb
 - spec/project_spec.rb
 - spec/rubocop/cop/cask/no_dsl_version_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/jawshooah/rubocop-cask
+homepage: https://github.com/caskroom/rubocop-cask
 licenses:
 - MIT
 metadata: {}
@@ -65,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Code style checking for Homebrew-Cask files