rubocop-rake 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73d51636442d4cfdeb17f8f0001b51ead2a0628f2e79d8ebeb995ea2b8955915
-  data.tar.gz: cd0b14eeef0a9cd88caa7f98eb7cff6127bea2e81e16490191591fc68ba0ed6a
+  metadata.gz: 14304d50b67b9946c5962a7d4a120f924b1fa12f0236e51dab8b58d106b4a81c
+  data.tar.gz: d827d6b122b63d7ce6e012551d389f9e3ee34597d99e9d7b6739e533243d8fe7
 SHA512:
-  metadata.gz: 02406d1e2fb8f97db3db0312288e5a5b52a745d5a71eba48a042787e51d8f2040dae6f58243f261acb51d7d53f395038cf0b62904b46bd1d8adcb9def07c7c9d
-  data.tar.gz: 2b995b622090f8cb82ffdc91674ed54d022349f477ac7334fd75692a70baa03ad87178cad9475352905e8afdcd04d90830bdf24c27d910df0196af62959e1b1b
+  metadata.gz: 1079f85fad77e44350769a85a5d925d4ca46c249952d3903f6b0e4804ed22b8435a4e27f0a717296bf024389413852ee89f45ae36cad44c4106560914fe97f1e
+  data.tar.gz: f32b18ca6c6db87e80b6ee71bb754717aab1750fc4596949a6e4b2d001034319a5843d5b9771171e332ec9b9ff2e86a7af2ddbbfded90e6c35659d7ef5d7f078

data/.rubocop.yml

@@ -33,6 +33,9 @@ Style/PercentLiteralDelimiters:
   Exclude:
     - '*.gemspec'
 
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
 RSpec/ExampleLength:
   Enabled: false
 

data/CHANGELOG.md

@@ -2,12 +2,6 @@
 
 ## master (unreleased)
 
-## 0.3.1 (2019-10-06)
-
-### Bug fixes
-
-* [#17](https://github.com/rubocop-hq/rubocop-rake/pull/17): Filter target files for Rake/ClassDefinitionInTask cop. ([@pocke][])
-
 <!--
 
 ### New features
@@ -18,6 +12,18 @@
 
 -->
 
+## 0.4.0 (2019-10-13)
+
+### New features
+
+* [#13](https://github.com/rubocop-hq/rubocop-rake/issues/13): Add Rake/DuplicateTask cop. ([@pocke][])
+
+## 0.3.1 (2019-10-06)
+
+### Bug fixes
+
+* [#17](https://github.com/rubocop-hq/rubocop-rake/pull/17): Filter target files for Rake/ClassDefinitionInTask cop. ([@pocke][])
+
 ## 0.3.0 (2019-09-25)
 
 ### New features

data/config/default.yml

@@ -1,23 +1,24 @@
+Rake:
+  Include:
+    - 'Rakefile'
+    - '**/*.rake'
+
 Rake/ClassDefinitionInTask:
   Description: 'Do not define a class or module in rake task, because it will be defined to the top level.'
   Enabled: true
   VersionAdded: '0.3.0'
-  Include:
-    - 'Rakefile'
-    - '**/*.rake'
 
 Rake/Desc:
   Description: 'Describe the task with `desc` method.'
   Enabled: true
   VersionAdded: '0.1.0'
-  Include:
-    - 'Rakefile'
-    - '**/*.rake'
+
+Rake/DuplicateTask:
+  Description: 'Do not define tasks with the same name'
+  Enabled: true
+  VersionAdded: '0.4.0'
 
 Rake/MethodDefinitionInTask:
   Description: 'Do not define a method in rake task, because it will be defined to the top level.'
   Enabled: true
   VersionAdded: '0.2.0'
-  Include:
-    - 'Rakefile'
-    - '**/*.rake'

data/lib/rubocop-rake.rb

@@ -9,5 +9,7 @@ require_relative 'rubocop/rake/inject'
 RuboCop::Rake::Inject.defaults!
 
 require_relative 'rubocop/cop/rake/helper/class_definition'
+require_relative 'rubocop/cop/rake/helper/on_task'
 require_relative 'rubocop/cop/rake/helper/task_definition'
+require_relative 'rubocop/cop/rake/helper/task_name'
 require_relative 'rubocop/cop/rake_cops'

data/lib/rubocop/cop/rake/desc.rb

@@ -28,16 +28,13 @@ module RuboCop
       #   end
       #
       class Desc < Cop
-        MSG = 'Describe the task with `desc` method.'
+        include Helper::OnTask
 
-        def_node_matcher :task?, <<~PATTERN
-          (send nil? :task ...)
-        PATTERN
+        MSG = 'Describe the task with `desc` method.'
 
-        def on_send(node)
-          return unless task?(node)
+        def on_task(node)
           return if task_with_desc?(node)
-          return if task_name(node) == :default
+          return if Helper::TaskName.task_name(node) == :default
 
           add_offense(node)
         end
@@ -53,23 +50,6 @@ module RuboCop
           desc_candidate.send_type? && desc_candidate.method_name == :desc
         end
 
-        private def task_name(node)
-          first_arg = node.arguments[0]
-          case first_arg&.type
-          when :sym, :str
-            return first_arg.value.to_sym
-          when :hash
-            return nil if first_arg.children.size != 1
-
-            pair = first_arg.children.first
-            key = pair.children.first
-            case key.type
-            when :sym, :str
-              key.value.to_sym
-            end
-          end
-        end
-
         private def parent_and_task(task_node)
           parent = task_node.parent
           return nil, task_node unless parent

data/lib/rubocop/cop/rake/duplicate_task.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rake
+      # If tasks are defined with the same name, Rake executes the both tasks
+      # in definition order.
+      # It is misleading sometimes. You should squash them into one definition.
+      # This cop detects it.
+      #
+      # @example
+      #   # bad
+      #   task :foo do
+      #     p 'foo 1'
+      #   end
+      #   task :foo do
+      #     p 'foo 2'
+      #   end
+      #
+      #   # good
+      #   task :foo do
+      #     p 'foo 1'
+      #     p 'foo 2'
+      #   end
+      #
+      class DuplicateTask < Cop
+        include Helper::OnTask
+
+        MSG = 'Task `%<task>s` is defined at both %<previous>s and %<current>s.'
+
+        def initialize(*)
+          super
+          @tasks = {}
+        end
+
+        def on_task(node)
+          namespaces = namespaces(node)
+          return if namespaces.include?(nil)
+
+          task_name = Helper::TaskName.task_name(node)
+          return unless task_name
+
+          full_name = [*namespaces.reverse, task_name].join(':')
+          if (previous = @tasks[full_name])
+            message = message_for_dup(previous: previous, current: node, task_name: full_name)
+            add_offense(node, message: message)
+          else
+            @tasks[full_name] = node
+          end
+        end
+
+        def namespaces(node)
+          ns = []
+
+          node.each_ancestor(:block) do |block_node|
+            send_node = block_node.send_node
+            next unless send_node.method_name == :namespace
+
+            name = Helper::TaskName.task_name(send_node)
+            ns << name
+          end
+
+          ns
+        end
+
+        def message_for_dup(previous:, current:, task_name:)
+          format(
+            MSG,
+            task: task_name,
+            previous: source_location(previous),
+            current: source_location(current),
+          )
+        end
+
+        def source_location(node)
+          range = node.location.expression
+          path = smart_path(range.source_buffer.name)
+          "#{path}:#{range.line}"
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rake/helper/on_task.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rake
+      module Helper
+        module OnTask
+          extend NodePattern::Macros
+
+          def_node_matcher :task?, <<~PATTERN
+            (send nil? :task ...)
+          PATTERN
+
+          def on_send(node)
+            return unless task?(node)
+
+            on_task(node)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rake/helper/task_name.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rake
+      module Helper
+        module TaskName
+          extend self
+
+          def task_name(node)
+            first_arg = node.arguments[0]
+            case first_arg&.type
+            when :sym, :str
+              return first_arg.value.to_sym
+            when :hash
+              return nil if first_arg.children.size != 1
+
+              pair = first_arg.children.first
+              key = pair.children.first
+              case key.type
+              when :sym, :str
+                key.value.to_sym
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rake_cops.rb

@@ -2,4 +2,5 @@
 
 require_relative 'rake/class_definition_in_task'
 require_relative 'rake/desc'
+require_relative 'rake/duplicate_task'
 require_relative 'rake/method_definition_in_task'

data/lib/rubocop/rake/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Rake
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rake
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-05 00:00:00.000000000 Z
+date: 2019-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -47,8 +47,11 @@ files:
 - lib/rubocop-rake.rb
 - lib/rubocop/cop/rake/class_definition_in_task.rb
 - lib/rubocop/cop/rake/desc.rb
+- lib/rubocop/cop/rake/duplicate_task.rb
 - lib/rubocop/cop/rake/helper/class_definition.rb
+- lib/rubocop/cop/rake/helper/on_task.rb
 - lib/rubocop/cop/rake/helper/task_definition.rb
+- lib/rubocop/cop/rake/helper/task_name.rb
 - lib/rubocop/cop/rake/method_definition_in_task.rb
 - lib/rubocop/cop/rake_cops.rb
 - lib/rubocop/rake.rb