sevencop 0.19.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5664628e10057bbf8aed265ce915891333cdb0236e5c2ba3816e46d929d566ac
-  data.tar.gz: 52160da1f19f3621bdc623c5d840020a1da412a98011b58f3703e455a67715c8
+  metadata.gz: 2c8749d14f3f47fd27af7e3f83f5a31ab99c393082cc6b6a054dfdb78cc1d584
+  data.tar.gz: 183cfc453319b5cceda49fa1764c604c667c9ba82325c5f2b0db3d61ecb23309
 SHA512:
-  metadata.gz: 50120fa7354c41fe5228a3f252ce2c38dc041d005b1694efba98603c3db2ee33a42e49c7dd2d2b3dc5bf8dbc406fa948de312d20c5f9c68beafd7a075c2e752e
-  data.tar.gz: 751cda89e7bee353e85ecc990375ea70abca1db3fcf09d52f016be522767121c1015a7a5461767d666f3803f7ea3462355b66a8b5386fef5158ec61bccc0fc11
+  metadata.gz: a00296da37481256fa87d3188bf86234c9e0bffed432d211c0d563c544d99b6e3db90545bf3a253e07320538cb2d34785e5d186c491e9258bf14b0ab904b0820
+  data.tar.gz: 88c879ff1c21fcd60e25fcf2cb1c06947175baaa84a7877d583225e3cdb76c040af926a9a348e6b8dc920f3b86fd931d88a1f4201af162b3dbef729b4c14549a

data/Gemfile.lock

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

data/README.md

@@ -36,6 +36,7 @@ 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)

data/config/default.yml

@@ -2,12 +2,14 @@ Sevencop/AutoloadOrdered:
   Description: |
     Sort `autoload` in alphabetical order.
   Enabled: false
+  Safe: false
   VersionAdded: '0.12'
 
 Sevencop/HashElementOrdered:
   Description: |
     Sort Hash elements by key.
   Enabled: false
+  Safe: false
   VersionAdded: '0.6'
 
 Sevencop/MethodDefinitionArgumentsMultiline:
@@ -20,18 +22,21 @@ Sevencop/MethodDefinitionInIncluded:
   Description: |
     Do not define methods in `included` blocks.
   Enabled: false
+  Safe: false
   VersionAdded: '0.19'
 
 Sevencop/MethodDefinitionOrdered:
   Description: |
     Sort method definitions in alphabetical order.
   Enabled: false
+  Safe: false
   VersionAdded: '0.14'
 
 Sevencop/MethodDefinitionKeywordArgumentOrdered:
   Description: |
     Sort method definition keyword arguments in alphabetical order.
   Enabled: false
+  Safe: false
   VersionAdded: '0.13'
 
 Sevencop/RailsBelongsToOptional:
@@ -45,8 +50,16 @@ Sevencop/RailsInferredSpecType:
   Description: |
     Identifies redundant spec type.
   Enabled: false
+  Safe: false
   VersionAdded: '0.9'
 
+Sevencop/RailsMigrationReservedWordMysql:
+  Description: |
+    Avoid using MySQL reserved words as identifiers.
+  Enabled: false
+  Safe: false
+  VersionAdded: '0.20'
+
 Sevencop/RailsOrderField:
   Description: |
     Wrap safe SQL String by `Arel.sql`.
@@ -72,6 +85,7 @@ Sevencop/RequireOrdered:
   Description: |
     Sort `require` and `require_relative` in alphabetical order.
   Enabled: false
+  Safe: false
   VersionAdded: '0.16'
 
 Sevencop/RSpecDescribeHttpEndpoint:

data/data/reserved_words_mysql.txt

@@ -0,0 +1,750 @@
+accessible
+account
+action
+active
+add
+admin
+after
+against
+aggregate
+algorithm
+all
+alter
+always
+analyse
+analyze
+and
+any
+array
+as
+asc
+ascii
+asensitive
+at
+attribute
+authentication
+auto_increment
+autoextend_size
+avg
+avg_row_length
+backup
+before
+begin
+between
+bigint
+binary
+binlog
+bit
+blob
+block
+bool
+boolean
+both
+btree
+buckets
+by
+byte
+cache
+call
+cascade
+cascaded
+case
+catalog_name
+chain
+challenge_response
+change
+changed
+channel
+char
+character
+charset
+check
+checksum
+cipher
+class_origin
+client
+clone
+close
+coalesce
+code
+collate
+collation
+column
+column_format
+column_name
+columns
+comment
+commit
+committed
+compact
+completion
+component
+compressed
+compression
+concurrent
+condition
+connection
+consistent
+constraint
+constraint_catalog
+constraint_name
+constraint_schema
+contains
+context
+continue
+convert
+cpu
+create
+cross
+cube
+cume_dist
+current
+current_date
+current_time
+current_timestamp
+current_user
+cursor
+cursor_name
+data
+database
+databases
+datafile
+date
+datetime
+day
+day_hour
+day_microsecond
+day_minute
+day_second
+deallocate
+dec
+decimal
+declare
+default
+default_auth
+definer
+definition
+delay_key_write
+delayed
+delete
+dense_rank
+des_key_file
+desc
+describe
+description
+deterministic
+diagnostics
+directory
+disable
+discard
+disk
+distinct
+distinctrow
+div
+do
+double
+drop
+dual
+dumpfile
+duplicate
+dynamic
+each
+else
+elseif
+empty
+enable
+enclosed
+encryption
+end
+ends
+enforced
+engine
+engine_attribute
+engines
+enum
+error
+errors
+escape
+escaped
+event
+events
+every
+except
+exchange
+exclude
+execute
+exists
+exit
+expansion
+expire
+explain
+export
+extended
+extent_size
+factor
+failed_login_attempts
+false
+fast
+faults
+fetch
+fields
+file
+file_block_size
+filter
+finish
+first
+first_value
+fixed
+float
+float4
+float8
+flush
+following
+follows
+for
+force
+foreign
+format
+found
+from
+full
+fulltext
+function
+general
+generated
+geomcollection
+geometry
+geometrycollection
+get
+get_format
+get_master_public_key
+get_source_public_key
+global
+grant
+grants
+group
+group_replication
+grouping
+groups
+gtid_only
+handler
+hash
+having
+help
+high_priority
+histogram
+history
+host
+hosts
+hour
+hour_microsecond
+hour_minute
+hour_second
+identified
+if
+ignore
+ignore_server_ids
+import
+in
+inactive
+index
+indexes
+infile
+initial
+initial_size
+initiate
+inner
+inout
+insensitive
+insert
+insert_method
+install
+instance
+int
+int1
+int2
+int3
+int4
+int8
+integer
+interval
+into
+invisible
+invoker
+io
+io_after_gtids
+io_before_gtids
+io_thread
+ipc
+is
+isolation
+issuer
+iterate
+join
+json
+json_table
+json_value
+key
+key_block_size
+keyring
+keys
+kill
+lag
+language
+last
+last_value
+lateral
+lead
+leading
+leave
+leaves
+left
+less
+level
+like
+limit
+linear
+lines
+linestring
+list
+load
+local
+localtime
+localtimestamp
+lock
+locked
+locks
+logfile
+logs
+long
+longblob
+longtext
+loop
+low_priority
+master
+master_auto_position
+master_bind
+master_compression_algorithms
+master_connect_retry
+master_delay
+master_heartbeat_period
+master_host
+master_log_file
+master_log_pos
+master_password
+master_port
+master_public_key_path
+master_retry_count
+master_server_id
+master_ssl
+master_ssl_ca
+master_ssl_capath
+master_ssl_cert
+master_ssl_cipher
+master_ssl_crl
+master_ssl_crlpath
+master_ssl_key
+master_ssl_verify_server_cert
+master_tls_ciphersuites
+master_tls_version
+master_user
+master_zstd_compression_level
+match
+max_connections_per_hour
+max_queries_per_hour
+max_rows
+max_size
+max_updates_per_hour
+max_user_connections
+maxvalue
+medium
+mediumblob
+mediumint
+mediumtext
+member
+memory
+merge
+message_text
+microsecond
+middleint
+migrate
+min_rows
+minute
+minute_microsecond
+minute_second
+mod
+mode
+modifies
+modify
+month
+multilinestring
+multipoint
+multipolygon
+mutex
+mysql_errno
+name
+names
+national
+natural
+nchar
+ndb
+ndbcluster
+nested
+network_namespace
+never
+new
+next
+no
+no_wait
+no_write_to_binlog
+nodegroup
+none
+not
+nowait
+nth_value
+ntile
+null
+nulls
+number
+numeric
+nvarchar
+of
+off
+offset
+oj
+old
+on
+one
+only
+open
+optimize
+optimizer_costs
+option
+optional
+optionally
+options
+or
+order
+ordinality
+organization
+others
+out
+outer
+outfile
+over
+owner
+pack_keys
+page
+parser
+partial
+partition
+partitioning
+partitions
+password
+password_lock_time
+path
+percent_rank
+persist
+persist_only
+phase
+plugin
+plugin_dir
+plugins
+point
+polygon
+port
+precedes
+preceding
+precision
+prepare
+preserve
+prev
+primary
+privilege_checks_user
+privileges
+procedure
+process
+processlist
+profile
+profiles
+proxy
+purge
+quarter
+query
+quick
+random
+range
+rank
+read
+read_only
+read_write
+reads
+real
+rebuild
+recover
+recursive
+redo_buffer_size
+redofile
+redundant
+reference
+references
+regexp
+registration
+relay
+relay_log_file
+relay_log_pos
+relay_thread
+relaylog
+release
+reload
+remote
+remove
+rename
+reorganize
+repair
+repeat
+repeatable
+replace
+replica
+replicas
+replicate_do_db
+replicate_do_table
+replicate_ignore_db
+replicate_ignore_table
+replicate_rewrite_db
+replicate_wild_do_table
+replicate_wild_ignore_table
+replication
+require
+require_row_format
+reset
+resignal
+resource
+respect
+restart
+restore
+restrict
+resume
+retain
+return
+returned_sqlstate
+returning
+returns
+reuse
+reverse
+revoke
+right
+rlike
+role
+rollback
+rollup
+rotate
+routine
+row
+row_count
+row_format
+row_number
+rows
+rtree
+savepoint
+schedule
+schema
+schema_name
+schemas
+second
+second_microsecond
+secondary
+secondary_engine
+secondary_engine_attribute
+secondary_load
+secondary_unload
+security
+select
+sensitive
+separator
+serial
+serializable
+server
+session
+set
+share
+show
+shutdown
+signal
+signed
+simple
+skip
+slave
+slow
+smallint
+snapshot
+socket
+some
+soname
+sounds
+source
+source_auto_position
+source_bind
+source_compression_algorithms
+source_connect_retry
+source_delay
+source_heartbeat_period
+source_host
+source_log_file
+source_log_pos
+source_password
+source_port
+source_public_key_path
+source_retry_count
+source_ssl
+source_ssl_ca
+source_ssl_capath
+source_ssl_cert
+source_ssl_cipher
+source_ssl_crl
+source_ssl_crlpath
+source_ssl_key
+source_ssl_verify_server_cert
+source_tls_ciphersuites
+source_tls_version
+source_user
+source_zstd_compression_level
+spatial
+specific
+sql
+sql_after_gtids
+sql_after_mts_gaps
+sql_before_gtids
+sql_big_result
+sql_buffer_result
+sql_cache
+sql_calc_found_rows
+sql_no_cache
+sql_small_result
+sql_thread
+sql_tsi_day
+sql_tsi_hour
+sql_tsi_minute
+sql_tsi_month
+sql_tsi_quarter
+sql_tsi_second
+sql_tsi_week
+sql_tsi_year
+sqlexception
+sqlstate
+sqlwarning
+srid
+ssl
+stacked
+start
+starting
+starts
+stats_auto_recalc
+stats_persistent
+stats_sample_pages
+status
+stop
+storage
+stored
+straight_join
+stream
+string
+subclass_origin
+subject
+subpartition
+subpartitions
+super
+suspend
+swaps
+switches
+system
+table
+table_checksum
+table_name
+tables
+tablespace
+temporary
+temptable
+terminated
+text
+than
+then
+thread_priority
+ties
+time
+timestamp
+timestampadd
+timestampdiff
+tinyblob
+tinyint
+tinytext
+tls
+to
+trailing
+transaction
+trigger
+triggers
+true
+truncate
+type
+types
+unbounded
+uncommitted
+undefined
+undo
+undo_buffer_size
+undofile
+unicode
+uninstall
+union
+unique
+unknown
+unlock
+unregister
+unsigned
+until
+update
+upgrade
+usage
+use
+use_frm
+user
+user_resources
+using
+utc_date
+utc_time
+utc_timestamp
+validation
+value
+values
+varbinary
+varchar
+varcharacter
+variables
+varying
+vcpu
+view
+virtual
+visible
+wait
+warnings
+week
+weight_string
+when
+where
+while
+window
+with
+without
+work
+wrapper
+write
+x509
+xa
+xid
+xml
+xor
+year
+year_month
+zerofill
+zone

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

@@ -0,0 +1,249 @@
+# 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

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -12,6 +12,7 @@ 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.20.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -41,6 +41,7 @@ files:
 - README.md
 - Rakefile
 - config/default.yml
+- data/reserved_words_mysql.txt
 - lib/rubocop/cop/sevencop/autoload_ordered.rb
 - lib/rubocop/cop/sevencop/hash_element_ordered.rb
 - lib/rubocop/cop/sevencop/method_definition_arguments_multiline.rb
@@ -49,6 +50,7 @@ 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