rubocop-rake 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08c0328080d816a5440b34c59982e558d8816b5c7c6b02b0a047631fe53b056f'
-  data.tar.gz: 354fb71bfa405da3dcc0818e3e7de4e8cafb4ba1bc1d484cf578ac80403eac1a
+  metadata.gz: 8abee9ef7094059a116c1dcb7ef0c36c9494351fd14f5ee57d064b5736318fa4
+  data.tar.gz: 24e4b728616fb46f871d917712504961b36ee4aed7f993689af1d20812f54e37
 SHA512:
-  metadata.gz: 98e781c7ee3a6861f4c8b7236e0afa989158b6259ec1e490109140aaeafeb0a9e0b8f6506e525d5b4e8c2cd4b92ff66563d1825763c4a5d688b77c6c1774c07b
-  data.tar.gz: b2b54fcd86a9e40bb34cd04998e577ae802c340041715e6b2eb79d10e7911bd2c95ae9ddb6d863a9669bd28a385eba2f608baa1ef1c49848795e9a2231c9d27a
+  metadata.gz: 0a47d61558777d3a42b5fc9e1dcc0ed5e12565cbf99fbadeef9a67eb9a9c604797986f52a1897c16c5eed1f7874590e56f916ebc8a0d44831d9c11d53bb1a310
+  data.tar.gz: eb65d73cbb79e4f1ab59bad336b7e23f236c221ff03cb46dd4418062f91c44fe0341a052334766dc382c195bfc678c6efdaa9a402175018160eb654020d0bba1

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+
+rvm:
+  - 2.4.7
+  - 2.5.6
+  - 2.6.4
+  - ruby-head
+
+cache: bundler
+bundler_args: --jobs=4 --retry=3
+sudo: false
+
+
+before_install: 'gem update --system'
+
+script:
+  - bundle exec rake
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Change log
+
+## master (unreleased)
+
+<!--
+
+### New features
+
+### Bug fixes
+
+### Changes
+
+-->
+
+## 0.2.0 (2019-09-17)
+
+### New features
+
+* [#5](https://github.com/pocke/rubocop-rake): Add `Rake/MethodDefinitionInTask`. ([@pocke][])
+
+## 0.1.0 (2019-09-04)
+
+### New features
+
+* The first release!
+* Add `Rake/Desc`. ([@pocke][])
+
+[@pocke]: https://github.com/pocke

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Masataka Pocke Kuwabara
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/config/default.yml

@@ -5,3 +5,11 @@ Rake/Desc:
   Include:
     - 'Rakefile'
     - '**/*.rake'
+
+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/cop/rake/method_definition_in_task.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rake
+      # This cop detects method 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
+      #     def helper_method
+      #       do_something
+      #     end
+      #   end
+      #
+      #   # bad
+      #   namespace :foo do
+      #     def helper_method
+      #       do_something
+      #     end
+      #   end
+      #
+      #   # good - It is also defined to the top level,
+      #   #        but it looks expected behavior.
+      #   def helper_method
+      #   end
+      #   task :foo do
+      #   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
+
+        def on_def(node)
+          return if in_class_definition?(node)
+          return unless 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
+end

data/lib/rubocop/cop/rake_cops.rb

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

data/lib/rubocop/rake/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Rake
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/rubocop-rake.gemspec

@@ -9,14 +9,14 @@ 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.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
   spec.licenses = ['MIT']
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["changelog_uri"] = "https://github.com/pocke/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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rake
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -33,7 +33,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -41,6 +44,7 @@ files:
 - config/default.yml
 - lib/rubocop-rake.rb
 - lib/rubocop/cop/rake/desc.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
@@ -53,6 +57,7 @@ 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
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -61,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="