rubocop-rake 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8abee9ef7094059a116c1dcb7ef0c36c9494351fd14f5ee57d064b5736318fa4
-  data.tar.gz: 24e4b728616fb46f871d917712504961b36ee4aed7f993689af1d20812f54e37
+  metadata.gz: 43a2bfee062536e5b93f61f3e3be4a2189ab8b694b4511c5b5be945229940607
+  data.tar.gz: 041a6a8562c844204db1757bf2503e33b641fa53eda3555cb7befe384dfe7845
 SHA512:
-  metadata.gz: 0a47d61558777d3a42b5fc9e1dcc0ed5e12565cbf99fbadeef9a67eb9a9c604797986f52a1897c16c5eed1f7874590e56f916ebc8a0d44831d9c11d53bb1a310
-  data.tar.gz: eb65d73cbb79e4f1ab59bad336b7e23f236c221ff03cb46dd4418062f91c44fe0341a052334766dc382c195bfc678c6efdaa9a402175018160eb654020d0bba1
+  metadata.gz: b4f7183c42528b767447731b7de87b025ba1f7f15f225658b162e00d204c3d5499c612a01d32ad06e41574daf0e6a8412da92f784de032635a412e171fdb3337
+  data.tar.gz: 8499dcd7ab87b21c251af73afde006f61832402277fb842eb05f55a5d5bff8a055f0c81c7963b63628ad60a53df442cd03fdf532c0b3707c1fd1bc03433d2ce7

data/.rubocop.yml

@@ -0,0 +1,41 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Metrics:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/UnneededPercentQ:
+  Exclude:
+    - '*.gemspec'
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - '*.gemspec'
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'lib/rubocop-rake.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-09-18 21:43:54 +0900 using RuboCop version 0.74.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/CHANGELOG.md

@@ -12,11 +12,21 @@
 
 -->
 
+## 0.3.0 (2019-09-25)
+
+### New features
+
+* [#6](https://github.com/rubocop-hq/rubocop-rake/issues/6): Add `Rake/ClassDefinitionInTask` cop. ([@pocke][])
+
+### Bug fixes
+
+* [#8](https://github.com/rubocop-hq/rubocop-rake/issues/8): Make Rake/Desc to not require description for the default task. ([@pocke][])
+
 ## 0.2.0 (2019-09-17)
 
 ### New features
 
-* [#5](https://github.com/pocke/rubocop-rake): Add `Rake/MethodDefinitionInTask`. ([@pocke][])
+* [#5](https://github.com/rubocop-hq/rubocop-rake/pull/5): Add `Rake/MethodDefinitionInTask`. ([@pocke][])
 
 ## 0.1.0 (2019-09-04)
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in rubocop-rake.gemspec
@@ -5,3 +7,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem 'rspec'
+gem 'rubocop-rspec'

data/README.md

@@ -34,5 +34,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/rubocop-rake.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubocop-hq/rubocop-rake.
 

data/Rakefile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-task :default => :spec
+task default: %i[rubocop spec]
 
 require 'rspec/core/rake_task'
 
@@ -28,3 +30,8 @@ task :new_cop, [:cop] do |_task, args|
 
   puts generator.todo
 end
+
+desc 'Run rubocop'
+task :rubocop do
+  sh 'rubocop'
+end

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "rubocop/rake"

data/config/default.yml

@@ -1,3 +1,8 @@
+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'
+
 Rake/Desc:
   Description: 'Describe the task with `desc` method.'
   Enabled: true

data/lib/rubocop-rake.rb

@@ -8,4 +8,6 @@ require_relative 'rubocop/rake/inject'
 
 RuboCop::Rake::Inject.defaults!
 
+require_relative 'rubocop/cop/rake/helper/class_definition'
+require_relative 'rubocop/cop/rake/helper/task_definition'
 require_relative 'rubocop/cop/rake_cops'

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rake
+      # This cop detects class or module definition in a task or namespace,
+      # because it is defined to the top level.
+      # It is confusing because the scope looks in the task or namespace,
+      # but actually it is defined to the top level.
+      #
+      # @example
+      #   # bad
+      #   task :foo do
+      #     class C
+      #     end
+      #   end
+      #
+      #   # bad
+      #   namespace :foo do
+      #     module M
+      #     end
+      #   end
+      #
+      #   # good - It is also defined to the top level,
+      #   #        but it looks expected behavior.
+      #   class C
+      #   end
+      #   task :foo do
+      #   end
+      #
+      class ClassDefinitionInTask < Cop
+        MSG = 'Do not define a %<type>s in rake task, because it will be defined to the top level.'
+
+        def on_class(node)
+          return if Helper::ClassDefinition.in_class_definition?(node)
+          return unless Helper::TaskDefinition.in_task_or_namespace?(node)
+
+          add_offense(node)
+        end
+
+        def message(node)
+          format(MSG, type: node.type)
+        end
+
+        alias on_module on_class
+      end
+    end
+  end
+end

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

@@ -7,6 +7,9 @@ module RuboCop
       # It is useful as a documentation of task. And Rake does not display
       # task that does not have `desc` by `rake -T`.
       #
+      # Note: This cop does not require description for the default task,
+      #       because the default task is executed with `rake` without command.
+      #
       # @example
       #   # bad
       #   task :do_something
@@ -25,7 +28,7 @@ module RuboCop
       #   end
       #
       class Desc < Cop
-        MSG = 'Describe the task with `desc` method.'.freeze
+        MSG = 'Describe the task with `desc` method.'
 
         def_node_matcher :task?, <<~PATTERN
           (send nil? :task ...)
@@ -34,6 +37,7 @@ module RuboCop
         def on_send(node)
           return unless task?(node)
           return if task_with_desc?(node)
+          return if task_name(node) == :default
 
           add_offense(node)
         end
@@ -49,11 +53,29 @@ 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
           return parent, task_node unless parent.block_type?
 
+          # rubocop:disable Style/GuardClause
           if parent.children.find_index(task_node) == 0
             # when task {}
             return parent.parent, parent
@@ -61,6 +83,7 @@ module RuboCop
             # when something { task }
             return parent, task_node
           end
+          # rubocop:enable Style/GuardClause
         end
       end
     end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rake
+      module Helper
+        module ClassDefinition
+          extend NodePattern::Macros
+          extend self
+
+          def_node_matcher :class_definition?, <<~PATTERN
+            {
+              class module sclass
+              (block
+                (send (const {nil? cbase} {:Class :Module}) :new)
+                args
+                _
+              )
+            }
+          PATTERN
+
+          def in_class_definition?(node)
+            node.each_ancestor(:class, :module, :sclass, :block).any? do |a|
+              class_definition?(a)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rake
+      module Helper
+        module TaskDefinition
+          extend NodePattern::Macros
+          extend self
+
+          def_node_matcher :task_or_namespace?, <<-PATTERN
+            (block
+              (send _ {:task :namespace} ...)
+              args
+              _
+            )
+          PATTERN
+
+          def in_task_or_namespace?(node)
+            node.each_ancestor(:block).any? do |a|
+              task_or_namespace?(a)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -31,51 +31,16 @@ module RuboCop
       #   end
       #
       class MethodDefinitionInTask < Cop
-        MSG = 'Do not define a method in rake task, because it will be defined to the top level.'.freeze
-
-        def_node_matcher :bad_method?, <<~PATTERN
-          (send nil? :bad_method ...)
-        PATTERN
-
-        def_node_matcher :class_definition?, <<~PATTERN
-          {
-            class module sclass
-            (block
-              (send (const {nil? cbase} {:Class :Module}) :new)
-              args
-              _
-            )
-          }
-        PATTERN
-
-        def_node_matcher :task_or_namespace?, <<-PATTERN
-          (block
-            (send _ {:task :namespace} ...)
-            args
-            _
-          )
-        PATTERN
+        MSG = 'Do not define a method in rake task, because it will be defined to the top level.'
 
         def on_def(node)
-          return if in_class_definition?(node)
-          return unless in_task_or_namespace?(node)
+          return if Helper::ClassDefinition.in_class_definition?(node)
+          return unless Helper::TaskDefinition.in_task_or_namespace?(node)
 
           add_offense(node)
         end
 
         alias on_defs on_def
-
-        private def in_class_definition?(node)
-          node.each_ancestor(:class, :module, :sclass, :block).any? do |a|
-            class_definition?(a)
-          end
-        end
-
-        private def in_task_or_namespace?(node)
-          node.each_ancestor(:block).any? do |a|
-            task_or_namespace?(a)
-          end
-        end
       end
     end
   end

data/lib/rubocop/cop/rake_cops.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
+require_relative 'rake/class_definition_in_task'
 require_relative 'rake/desc'
 require_relative 'rake/method_definition_in_task'

data/lib/rubocop/rake.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require "rubocop/rake/version"
 
 module RuboCop
+  # :nodoc:
   module Rake
     class Error < StandardError; end
 

data/lib/rubocop/rake/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Rake
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/rubocop-rake.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/rubocop/rake/version'
 
 Gem::Specification.new do |spec|
@@ -8,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{A RuboCop plugin for Rake}
   spec.description   = %q{A RuboCop plugin for Rake}
-  spec.homepage      = "https://github.com/pocke/rubocop-rake"
+  spec.homepage      = "https://github.com/rubocop-hq/rubocop-rake"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
   spec.licenses = ['MIT']
 
@@ -16,11 +18,11 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "https://github.com/pocke/rubocop-rake/blob/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/rubocop-hq/rubocop-rake/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
@@ -29,4 +31,3 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'rubocop'
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rake
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2019-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -33,6 +33,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -43,21 +45,24 @@ files:
 - bin/setup
 - config/default.yml
 - lib/rubocop-rake.rb
+- lib/rubocop/cop/rake/class_definition_in_task.rb
 - lib/rubocop/cop/rake/desc.rb
+- lib/rubocop/cop/rake/helper/class_definition.rb
+- lib/rubocop/cop/rake/helper/task_definition.rb
 - lib/rubocop/cop/rake/method_definition_in_task.rb
 - lib/rubocop/cop/rake_cops.rb
 - lib/rubocop/rake.rb
 - lib/rubocop/rake/inject.rb
 - lib/rubocop/rake/version.rb
 - rubocop-rake.gemspec
-homepage: https://github.com/pocke/rubocop-rake
+homepage: https://github.com/rubocop-hq/rubocop-rake
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/pocke/rubocop-rake
-  source_code_uri: https://github.com/pocke/rubocop-rake
-  changelog_uri: https://github.com/pocke/rubocop-rake/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/rubocop-hq/rubocop-rake
+  source_code_uri: https://github.com/rubocop-hq/rubocop-rake
+  changelog_uri: https://github.com/rubocop-hq/rubocop-rake/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: