sevencop 0.18.4 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddb1ab8850e168dd10c98cf0954d8e9df26cf1b0d43c1019780c2ce76d84d8d6
-  data.tar.gz: d159188fae4618097806c22ef26825993b821f2277671011f9c89997056fb364
+  metadata.gz: 5664628e10057bbf8aed265ce915891333cdb0236e5c2ba3816e46d929d566ac
+  data.tar.gz: 52160da1f19f3621bdc623c5d840020a1da412a98011b58f3703e455a67715c8
 SHA512:
-  metadata.gz: 449aff2e37cf2abd954b38db5ee587401657f261b584097d4390ab23a76df991505561e7462e8683d950a126fb7675a2b0445a868fc0802ab7711d9a10cc9d2d
-  data.tar.gz: 5171d0b62826dd0d85371a7b81fcae4917a49a3cf1de2f4d19ed7e61f38e670c8bacc0e7afd2934aac060e889a44d7475013d031eaaed68d9d7006ab0b85f03f
+  metadata.gz: 50120fa7354c41fe5228a3f252ce2c38dc041d005b1694efba98603c3db2ee33a42e49c7dd2d2b3dc5bf8dbc406fa948de312d20c5f9c68beafd7a075c2e752e
+  data.tar.gz: 751cda89e7bee353e85ecc990375ea70abca1db3fcf09d52f016be522767121c1015a7a5461767d666f3803f7ea3462355b66a8b5386fef5158ec61bccc0fc11

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.18.4)
+    sevencop (0.19.1)
       rubocop
 
 GEM

data/README.md

@@ -31,6 +31,7 @@ Choose the cops you want to use and enable them on your .rubocop.yml.
 - [Sevencop/AutoloadOrdered](lib/rubocop/cop/sevencop/autoload_ordered.rb)
 - [Sevencop/HashElementOrdered](lib/rubocop/cop/sevencop/hash_element_ordered.rb)
 - [Sevencop/MethodDefinitionArgumentsMultiline](lib/rubocop/cop/sevencop/method_definition_arguments_multiline.rb)
+- [Sevencop/MethodDefinitionInIncluded](lib/rubocop/cop/sevencop/method_definition_in_included.rb)
 - [Sevencop/MethodDefinitionKeywordArgumentOrdered](lib/rubocop/cop/sevencop/method_definition_keyword_argument_ordered.rb)
 - [Sevencop/MethodDefinitionOrdered](lib/rubocop/cop/sevencop/method_definition_ordered.rb)
 - [Sevencop/RailsBelongsToOptional](lib/rubocop/cop/sevencop/rails_belongs_to_optional.rb)

data/config/default.yml

@@ -16,6 +16,12 @@ Sevencop/MethodDefinitionArgumentsMultiline:
   Enabled: false
   VersionAdded: '0.11'
 
+Sevencop/MethodDefinitionInIncluded:
+  Description: |
+    Do not define methods in `included` blocks.
+  Enabled: false
+  VersionAdded: '0.19'
+
 Sevencop/MethodDefinitionOrdered:
   Description: |
     Sort method definitions in alphabetical order.

data/lib/rubocop/cop/sevencop/method_definition_in_included.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Do not define methods in `included` blocks.
+      #
+      # @example
+      #   # bad
+      #   module A
+      #     extend ::ActiveSupport::Concern
+      #
+      #     included do
+      #       def foo
+      #       end
+      #     end
+      #   end
+      #
+      #   # good
+      #   module A
+      #     extend ::ActiveSupport::Concern
+      #
+      #     def foo
+      #     end
+      #   end
+      class MethodDefinitionInIncluded < RuboCop::Cop::Base
+        extend AutoCorrector
+
+        include RangeHelp
+        include VisibilityHelp
+
+        MSG = 'Do not define methods in `included` blocks.'
+
+        # @param node [RuboCop::AST::DefNode]
+        # @return [void]
+        def on_def(node)
+          block = find_ancestor_included_block(node)
+          return unless block
+
+          add_offense(node) do |corrector|
+            corrector.insert_before(
+              range_with_comments_and_lines(block),
+              "#{range_with_comments_and_lines(node).source}\n".sub(
+                /\bdef /, "#{node_visibility(node)} def "
+              )
+            )
+            corrector.remove(
+              range_with_comments_and_lines(node)
+            )
+          end
+        end
+
+        private
+
+        # @param range1 [Parser::Source::Range]
+        # @param range2 [Parser::Source::Range]
+        # @return [Parser::Source::Range]
+        def add_range(
+          range1,
+          range2
+        )
+          range1.with(
+            begin_pos: [range1.begin_pos, range2.begin_pos].min,
+            end_pos: [range1.end_pos, range2.end_pos].max
+          )
+        end
+
+        # @param node [RuboCop::AST::DefNode]
+        # @return [RuboCop::AST::BlockNode, nil]
+        def find_ancestor_included_block(node)
+          if node.parent&.block_type?
+            node.parent if node.parent.method?(:included)
+          elsif node.parent&.begin_type?
+            node.parent.parent if node.parent.parent&.block_type? && node.parent.parent&.method?(:included)
+          end
+        end
+
+        # @param node [RuboCop::AST::DefNode]
+        # @return [Boolean]
+        def private?(node)
+          node_visibility(node) == :private
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Paresr::Source::Range]
+        def range_with_comments(node)
+          ranges = [
+            node,
+            *processed_source.ast_with_comments[node]
+          ].map do |element|
+            element.location.expression
+          end
+          ranges.reduce do |result, range|
+            add_range(result, range)
+          end
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Parser::Source::Range]
+        def range_with_comments_and_lines(node)
+          range_by_whole_lines(
+            range_with_comments(node),
+            include_final_newline: true
+          )
+        end
+      end
+    end
+  end
+end

data/lib/sevencop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sevencop
-  VERSION = '0.18.4'
+  VERSION = '0.19.1'
 end

data/lib/sevencop.rb

@@ -7,6 +7,7 @@ require_relative 'sevencop/version'
 require_relative 'rubocop/cop/sevencop/autoload_ordered'
 require_relative 'rubocop/cop/sevencop/hash_element_ordered'
 require_relative 'rubocop/cop/sevencop/method_definition_arguments_multiline'
+require_relative 'rubocop/cop/sevencop/method_definition_in_included'
 require_relative 'rubocop/cop/sevencop/method_definition_keyword_argument_ordered'
 require_relative 'rubocop/cop/sevencop/method_definition_ordered'
 require_relative 'rubocop/cop/sevencop/rails_belongs_to_optional'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.18.4
+  version: 0.19.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2022-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -44,6 +44,7 @@ files:
 - lib/rubocop/cop/sevencop/autoload_ordered.rb
 - lib/rubocop/cop/sevencop/hash_element_ordered.rb
 - lib/rubocop/cop/sevencop/method_definition_arguments_multiline.rb
+- lib/rubocop/cop/sevencop/method_definition_in_included.rb
 - lib/rubocop/cop/sevencop/method_definition_keyword_argument_ordered.rb
 - lib/rubocop/cop/sevencop/method_definition_ordered.rb
 - lib/rubocop/cop/sevencop/rails_belongs_to_optional.rb