sevencop 0.21.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97218861b57331e3ffaa577f6a7a7a7d9ec05d0b7f6d7a8034e41ab831854a5d
-  data.tar.gz: 076a2bb553cd96314b4c10144e943cd67a3c8bee532950d9945d54a8cbad96ad
+  metadata.gz: 0f1682050c56b200417e16dfd5e9f90898838834b29609ef01548b40ab4d4700
+  data.tar.gz: f44e1c9e38ee48b6719e7df278d7858d9f6dc846c3469a96d11975b5a0d572b9
 SHA512:
-  metadata.gz: 7dbc8187110fae79a6c21c61e2292d7f6e6d42a0f51bdf35066d281a2b44fa47e1b6a2fcc920fa192cda30dfd9c77b73836e57a518d61e5de1a7ff6fc97c3576
-  data.tar.gz: 0ad3d66a1ecbbec56054a771626e8cb22eb2bc425501fbe0b6f38290be315110de2875a73670bfead59e3cd854d41214f919178622e0807a07c91b2dac8a283e
+  metadata.gz: 5c3fe3df83f0a4aef3503cfe39d8d82262c1dfd3bdd5b8745922a2649991d56c208d9a6ccc8a6b2f87757e7cdb1423e33f97869a39f4172984c15b4941797df9
+  data.tar.gz: e9dc4ceaac5717391ba294a3995572e9cce89f3316104d2e2139af30fc994d60a9e13c0ee2eb864566b27b2e6d04ff634f0b714d1d93c0ce1f4d969294bf2da9

data/.rubocop.yml

@@ -13,6 +13,9 @@ AllCops:
 Gemspec/RequireMFA:
   Enabled: false
 
+Layout/LineLength:
+  Enabled: false
+
 Metrics:
   Enabled: false
 
@@ -49,6 +52,9 @@ Sevencop/MethodDefinitionKeywordArgumentOrdered:
 Sevencop/MethodDefinitionOrdered:
   Enabled: true
 
+Sevencop/RequireOrdered:
+  Enabled: true
+
 Style/Documentation:
   Enabled: false
 

data/Gemfile.lock

@@ -1,15 +1,25 @@
 PATH
   remote: .
   specs:
-    sevencop (0.21.0)
+    sevencop (0.23.0)
+      activesupport
       rubocop
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
     json (2.6.2)
+    minitest (5.16.3)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -50,6 +60,8 @@ GEM
     rubocop-rspec (2.13.1)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
 
 PLATFORMS

data/README.md

@@ -24,9 +24,9 @@ Sevencop/MethodDefinitionOrdered:
   Enabled: true
 ```
 
-## Cops
+Note that all cops are `Enabled: false` by default.
 
-Choose the cops you want to use and enable them on your .rubocop.yml.
+## Cops
 
 - [Sevencop/AutoloadOrdered](lib/rubocop/cop/sevencop/autoload_ordered.rb)
 - [Sevencop/FactoryBotAssociationOption](lib/rubocop/cop/sevencop/factory_bot_association_option.rb)
@@ -38,12 +38,9 @@ Choose the cops you want to use and enable them on your .rubocop.yml.
 - [Sevencop/MethodDefinitionOrdered](lib/rubocop/cop/sevencop/method_definition_ordered.rb)
 - [Sevencop/RailsBelongsToOptional](lib/rubocop/cop/sevencop/rails_belongs_to_optional.rb)
 - [Sevencop/RailsInferredSpecType](lib/rubocop/cop/sevencop/rails_inferred_spec_type.rb)
-- [Sevencop/RailsMigrationReservedWordMysql](lib/rubocop/cop/sevencop/rails_migration_reserved_word_mysql.rb)
 - [Sevencop/RailsOrderField](lib/rubocop/cop/sevencop/rails_order_field.rb)
 - [Sevencop/RailsUniquenessValidatorExplicitCaseSensitivity](lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb)
 - [Sevencop/RailsWhereNot](lib/rubocop/cop/sevencop/rails_where_not.rb)
 - [Sevencop/RequireOrdered](lib/rubocop/cop/sevencop/require_ordered.rb)
 - [Sevencop/RSpecDescribeHttpEndpoint](lib/rubocop/cop/sevencop/rspec_describe_http_endpoint.rb)
 - [Sevencop/RSpecExamplesInSameGroup](lib/rubocop/cop/sevencop/rspec_examples_in_same_group.rb)
-
-Note that all cops are `Enabled: false` by default.

data/config/default.yml

@@ -82,15 +82,6 @@ Sevencop/RailsInferredSpecType:
   Safe: false
   VersionAdded: '0.9'
 
-Sevencop/RailsMigrationReservedWordMysql:
-  Description: |
-    Avoid using MySQL reserved words as identifiers.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.20'
-  Include:
-    - db/migrate/**/*.rb
-
 Sevencop/RailsOrderField:
   Description: |
     Wrap safe SQL String by `Arel.sql`.

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

@@ -58,7 +58,7 @@ module RuboCop
               <
                 $(pair
                   (sym :factory)
-                  (sym _)
+                  sym
                 )
                 ...
               >

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

@@ -41,7 +41,7 @@ module RuboCop
         # @param node [RuboCop::AST::SendNode]
         # @return [void]
         def on_send(node)
-          wrong_associations_in(node).each do |association|
+          bad_associations_in(node).each do |association|
             add_offense(association) do |corrector|
               autocorrect(corrector, association)
             end
@@ -51,7 +51,7 @@ module RuboCop
         private
 
         # @!method explicit_association?(node)
-        #   @param node [RuboCop::AST::Node]
+        #   @param node [RuboCop::AST::SendNode]
         #   @return [Boolean]
         def_node_matcher :explicit_association?, <<~PATTERN
           (send
@@ -62,7 +62,7 @@ module RuboCop
         PATTERN
 
         # @!method implicit_association?(node)
-        #   @param node [RuboCop::AST::Node]
+        #   @param node [RuboCop::AST::SendNode]
         #   @return [Boolean]
         def_node_matcher :implicit_association?, <<~PATTERN
           (send
@@ -111,56 +111,56 @@ module RuboCop
           node.arguments.one?
         end
 
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Array<RuboCop::AST::Node>]
-        def children_of_factory_block(node)
-          block = node.parent
-          return [] unless block
-          return [] unless block.block_type?
-
-          if block.body.begin_type?
-            block.body.children
-          else
-            [block.body]
-          end
-        end
-
-        # @param method_name [Symbol]
-        # @return [Boolean]
-        def non_implicit_association_method_name?(method_name)
-          cop_config['NonImplicitAssociationMethodNames'].include?(method_name.to_s)
-        end
-
         # @param node [RuboCop::AST::SendNode]
         # @return [Boolean]
-        def wrong?(node)
+        def bad?(node)
           case style
           when :explicit
-            wrong_to_explicit_style?(node)
+            bad_to_explicit_style?(node)
           when :implicit
-            wrong_to_implicit_style?(node)
+            bad_to_implicit_style?(node)
           end
         end
 
         # @param node [RuboCop::AST::SendNode]
         # @return [Array<RuboCop::AST::SendNode>]
-        def wrong_associations_in(node)
+        def bad_associations_in(node)
           children_of_factory_block(node).select do |child|
-            wrong?(child)
+            bad?(child)
           end
         end
 
-        # @param node [RuboCop::AST::Node]
+        # @param node [RuboCop::AST::SendNode]
         # @return [Boolean]
-        def wrong_to_explicit_style?(node)
+        def bad_to_explicit_style?(node)
           implicit_association?(node)
         end
 
         # @param node [RuboCop::AST::SendNode]
         # @return [Boolean]
-        def wrong_to_implicit_style?(node)
+        def bad_to_implicit_style?(node)
           explicit_association?(node) && autocorrectable_to_implicit_style?(node)
         end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Array<RuboCop::AST::Node>]
+        def children_of_factory_block(node)
+          block = node.parent
+          return [] unless block
+          return [] unless block.block_type?
+
+          if block.body.begin_type?
+            block.body.children
+          else
+            [block.body]
+          end
+        end
+
+        # @param method_name [Symbol]
+        # @return [Boolean]
+        def non_implicit_association_method_name?(method_name)
+          cop_config['NonImplicitAssociationMethodNames'].include?(method_name.to_s)
+        end
       end
     end
   end

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

@@ -73,7 +73,7 @@ module RuboCop
             _*
             ({ hash | kwargs }
               (pair ...)*
-              $(pair (sym :type) (sym _))
+              $(pair (sym :type) sym)
               (pair ...)*
             )
           )

data/lib/sevencop/config_loader.rb

@@ -5,23 +5,24 @@ require 'rubocop'
 module Sevencop
   # Merge default RuboCop config with plugin config.
   class ConfigLoader
-    PLUGIN_CONFIG_PATH = ::File.expand_path(
-      '../../config/default.yml',
-      __dir__
-    )
-
     class << self
+      # @param path [String]
       # @return [RuboCop::Config]
-      def call
-        new.call
+      def call(path:)
+        new(path: path).call
       end
     end
 
+    # @param path [String]
+    def initialize(path:)
+      @path = path
+    end
+
     # @return [RuboCop::Config]
     def call
       ::RuboCop::ConfigLoader.merge_with_default(
         plugin_config,
-        PLUGIN_CONFIG_PATH
+        @path
       )
     end
 
@@ -31,7 +32,7 @@ module Sevencop
     def plugin_config
       config = ::RuboCop::Config.new(
         plugin_config_hash,
-        PLUGIN_CONFIG_PATH
+        @path
       )
       config.make_excludes_absolute
       config
@@ -41,7 +42,7 @@ module Sevencop
     def plugin_config_hash
       ::RuboCop::ConfigLoader.send(
         :load_yaml_configuration,
-        PLUGIN_CONFIG_PATH
+        @path
       )
     end
   end

data/lib/sevencop/rubocop_extension.rb

@@ -6,5 +6,10 @@ require_relative 'config_loader'
 
 RuboCop::ConfigLoader.instance_variable_set(
   :@default_configuration,
-  Sevencop::ConfigLoader.call
+  Sevencop::ConfigLoader.call(
+    path: ::File.expand_path(
+      '../../config/default.yml',
+      __dir__
+    )
+  )
 )

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -14,7 +14,6 @@ require_relative 'rubocop/cop/sevencop/method_definition_keyword_argument_ordere
 require_relative 'rubocop/cop/sevencop/method_definition_ordered'
 require_relative 'rubocop/cop/sevencop/rails_belongs_to_optional'
 require_relative 'rubocop/cop/sevencop/rails_inferred_spec_type'
-require_relative 'rubocop/cop/sevencop/rails_migration_reserved_word_mysql'
 require_relative 'rubocop/cop/sevencop/rails_order_field'
 require_relative 'rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity'
 require_relative 'rubocop/cop/sevencop/rails_where_not'

data/sevencop.gemspec

@@ -28,5 +28,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'activesupport'
   spec.add_runtime_dependency 'rubocop'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +66,6 @@ files:
 - lib/rubocop/cop/sevencop/method_definition_ordered.rb
 - lib/rubocop/cop/sevencop/rails_belongs_to_optional.rb
 - lib/rubocop/cop/sevencop/rails_inferred_spec_type.rb
-- lib/rubocop/cop/sevencop/rails_migration_reserved_word_mysql.rb
 - lib/rubocop/cop/sevencop/rails_order_field.rb
 - lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb
 - lib/rubocop/cop/sevencop/rails_where_not.rb

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

@@ -1,249 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Avoid using MySQL reserved words as identifiers.
-      #
-      # @example
-      #   # bad
-      #   # NOTE: `role` is a reserved word in MySQL.
-      #   add_column :users, :role, :string
-      #
-      #   # good
-      #   add_column :users, :some_other_good_name, :string
-      class RailsMigrationReservedWordMysql < RuboCop::Cop::Base
-        COLUMN_TYPE_METHOD_NAMES = ::Set.new(
-          %i[
-            bigint
-            binary
-            blob
-            boolean
-            date
-            datetime
-            decimal
-            float
-            integer
-            numeric
-            primary_key
-            string
-            text
-            time
-          ]
-        ).freeze
-
-        MSG = 'Avoid using MySQL reserved words as identifiers.'
-
-        # Obtained from https://dev.mysql.com/doc/refman/8.0/en/keywords.html.
-        PATH_TO_RESERVED_WORDS_FILE = File.expand_path(
-          '../../../../data/reserved_words_mysql.txt',
-          __dir__
-        ).freeze
-
-        RESTRICT_ON_SEND = [
-          :add_column,
-          :add_index,
-          :add_reference,
-          :create_join_table,
-          :create_table,
-          :rename,
-          :rename_column,
-          :rename_index,
-          :rename_table,
-          *COLUMN_TYPE_METHOD_NAMES
-        ].freeze
-
-        class << self
-          # @return [Array<String>]
-          def reserved_words
-            @reserved_words ||= ::Set.new(
-              ::File.read(PATH_TO_RESERVED_WORDS_FILE).split("\n")
-            ).freeze
-          end
-        end
-
-        # @param node [RuboCop::AST::DefNode]
-        # @return [void]
-        def on_send(node)
-          offended_identifier_nodes_from(node).each do |identifier_node|
-            add_offense(identifier_node)
-          end
-        end
-
-        private
-
-        # @!method index_name_option_from_add_index(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::Node, nil]
-        def_node_matcher :index_name_option_from_add_index, <<~PATTERN
-          (send
-            nil?
-            :add_index
-            _
-            _
-            (hash
-              <
-                (pair
-                  (sym :name)
-                  $_
-                )
-              >
-              ...
-            )
-          )
-        PATTERN
-
-        # @!method index_name_option_from_add_reference(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::Node, nil]
-        def_node_matcher :index_name_option_from_add_reference, <<~PATTERN
-          (send
-            nil?
-            :add_reference
-            _
-            _
-            (hash
-              <
-                (pair
-                  (sym :index)
-                  (hash
-                    <
-                      (pair
-                        (sym :name)
-                        $_
-                      )
-                    >
-                    ...
-                  )
-                )
-              >
-              ...
-            )
-          )
-        PATTERN
-
-        # @!method index_name_option_from_column_type(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::Node, nil]
-        def_node_matcher :index_name_option_from_column_type, <<~PATTERN
-          (send
-            (lvar _)
-            COLUMN_TYPE_METHOD_NAMES
-            _
-            (hash
-              <
-                (pair
-                  (sym :index)
-                  (hash
-                    <
-                      (pair
-                        (sym :name)
-                        $_
-                      )
-                      ...
-                    >
-                  )
-                )
-                ...
-              >
-            )
-          )
-        PATTERN
-
-        # @!method table_name_option_from(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::Node, nil]
-        def_node_matcher :table_name_option_from, <<~PATTERN
-          (send
-            nil?
-            :create_join_table
-            _
-            _
-            (hash
-              <
-                (pair
-                  (sym :table_name)
-                  $_
-                )
-                ...
-              >
-            )
-          )
-        PATTERN
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Array<RuboCop::AST::Node>]
-        def identifier_column_name_nodes_from(node)
-          case node.method_name
-          when :add_column, :rename
-            [node.arguments[1]]
-          when :rename_column
-            [node.arguments[2]]
-          when *COLUMN_TYPE_METHOD_NAMES
-            [node.arguments[0]]
-          else
-            []
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Array<RuboCop::AST::Node>]
-        def identifier_index_name_nodes_from(node)
-          case node.method_name
-          when :add_index
-            [index_name_option_from_add_index(node)].compact
-          when :add_reference
-            [index_name_option_from_add_reference(node)].compact
-          when :rename_index
-            [node.arguments[2]]
-          when *COLUMN_TYPE_METHOD_NAMES
-            [index_name_option_from_column_type(node)].compact
-          else
-            []
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Array<RuboCop::AST::Node>]
-        def identifier_nodes_from(node)
-          identifier_table_name_nodes_from(node) +
-            identifier_column_name_nodes_from(node) +
-            identifier_index_name_nodes_from(node)
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Array<RuboCop::AST::Node>]
-        def identifier_table_name_nodes_from(node)
-          case node.method_name
-          when :create_join_table
-            [table_name_option_from(node)].compact
-          when :create_table
-            [node.arguments[0]]
-          when :rename_table
-            [node.arguments[1]]
-          else
-            []
-          end
-        end
-
-        # @param node [RuboCop::AST::Node]
-        # @return [Array<RuboCop::AST::Node>]
-        def offended_identifier_nodes_from(node)
-          identifier_nodes_from(node).select do |identifier_node|
-            reserved_word_identifier_node?(identifier_node)
-          end
-        end
-
-        # @param node [RuboCop::AST::Node]
-        # @return [Boolean]
-        def reserved_word_identifier_node?(node)
-          return false unless node.respond_to?(:value)
-
-          self.class.reserved_words.include?(node.value.to_s)
-        end
-      end
-    end
-  end
-end