gitlab-styles 0.1.0

data/gitlab-styles.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitlab/styles/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gitlab-styles'
+  spec.version       = Gitlab::Styles::VERSION
+  spec.authors       = ['GitLab']
+  spec.email         = ['remy@rymai.me']
+
+  spec.summary       = 'GitLab style guides and shared style configs.'
+  spec.homepage      = 'https://github.com/gitlab-org/gitlab-styles'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rubocop', '~> 0.49'
+  spec.add_dependency 'rubocop-rspec', '~> 1.15'
+  spec.add_dependency 'rubocop-gitlab-security', '~> 0.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/gitlab/styles.rb

@@ -0,0 +1,6 @@
+require 'gitlab/styles/version'
+
+module Gitlab
+  module Styles
+  end
+end

data/lib/gitlab/styles/rubocop.rb

@@ -0,0 +1,30 @@
+require 'gitlab/styles/rubocop/cop/custom_error_class'
+require 'gitlab/styles/rubocop/cop/gem_fetcher'
+require 'gitlab/styles/rubocop/cop/active_record_serialize'
+require 'gitlab/styles/rubocop/cop/redirect_with_status'
+require 'gitlab/styles/rubocop/cop/polymorphic_associations'
+require 'gitlab/styles/rubocop/cop/project_path_helper'
+require 'gitlab/styles/rubocop/cop/active_record_dependent'
+require 'gitlab/styles/rubocop/cop/in_batches'
+require 'gitlab/styles/rubocop/cop/migration/add_column'
+require 'gitlab/styles/rubocop/cop/migration/add_column_with_default_to_large_table'
+require 'gitlab/styles/rubocop/cop/migration/add_concurrent_foreign_key'
+require 'gitlab/styles/rubocop/cop/migration/add_concurrent_index'
+require 'gitlab/styles/rubocop/cop/migration/add_index'
+require 'gitlab/styles/rubocop/cop/migration/add_timestamps'
+require 'gitlab/styles/rubocop/cop/migration/datetime'
+require 'gitlab/styles/rubocop/cop/migration/safer_boolean_column'
+require 'gitlab/styles/rubocop/cop/migration/hash_index'
+require 'gitlab/styles/rubocop/cop/migration/remove_concurrent_index'
+require 'gitlab/styles/rubocop/cop/migration/remove_index'
+require 'gitlab/styles/rubocop/cop/migration/reversible_add_column_with_default'
+require 'gitlab/styles/rubocop/cop/migration/timestamps'
+require 'gitlab/styles/rubocop/cop/migration/update_column_in_batches'
+require 'gitlab/styles/rubocop/cop/rspec/single_line_hook'
+
+module Gitlab
+  module Styles
+    module Rubocop
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/active_record_dependent.rb

@@ -0,0 +1,30 @@
+require_relative '../model_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        # Cop that prevents the use of `dependent: ...` in ActiveRecord models.
+        class ActiveRecordDependent < RuboCop::Cop::Cop
+          include ModelHelpers
+
+          MSG = 'Do not use `dependent: to remove associated data, ' \
+            'use foreign keys with cascading deletes instead'.freeze
+
+          METHOD_NAMES = [:has_many, :has_one, :belongs_to].freeze
+
+          def on_send(node)
+            return unless in_model?(node)
+            return unless METHOD_NAMES.include?(node.children[1])
+
+            node.children.last.each_node(:pair) do |pair|
+              key_name = pair.children[0].children[0]
+
+              add_offense(pair, :expression) if key_name == :dependent
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/active_record_serialize.rb

@@ -0,0 +1,22 @@
+require_relative '../model_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        # Cop that prevents the use of `serialize` in ActiveRecord models.
+        class ActiveRecordSerialize < RuboCop::Cop::Cop
+          include ModelHelpers
+
+          MSG = 'Do not store serialized data in the database, use separate columns and/or tables instead'.freeze
+
+          def on_send(node)
+            return unless in_model?(node)
+
+            add_offense(node, :selector) if node.children[1] == :serialize
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/custom_error_class.rb

@@ -0,0 +1,68 @@
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        # This cop makes sure that custom error classes, when empty, are declared
+        # with Class.new.
+        #
+        # @example
+        #   # bad
+        #   class FooError < StandardError
+        #   end
+        #
+        #   # okish
+        #   class FooError < StandardError; end
+        #
+        #   # good
+        #   FooError = Class.new(StandardError)
+        class CustomErrorClass < RuboCop::Cop::Cop
+          MSG = 'Use `Class.new(SuperClass)` to define an empty custom error class.'.freeze
+
+          def on_class(node)
+            _klass, parent, body = node.children
+
+            return if body
+
+            parent_klass = class_name_from_node(parent)
+
+            return unless parent_klass && parent_klass.to_s.end_with?('Error')
+
+            add_offense(node, :expression)
+          end
+
+          def autocorrect(node)
+            klass, parent, _body = node.children
+            replacement = "#{class_name_from_node(klass)} = Class.new(#{class_name_from_node(parent)})"
+
+            lambda do |corrector|
+              corrector.replace(node.source_range, replacement)
+            end
+          end
+
+          private
+
+          # The nested constant `Foo::Bar::Baz` looks like:
+          #
+          #   s(:const,
+          #     s(:const,
+          #       s(:const, nil, :Foo), :Bar), :Baz)
+          #
+          # So recurse through that to get the name as written in the source.
+          #
+          def class_name_from_node(node, suffix = nil)
+            return unless node&.type == :const
+
+            name = node.children[1].to_s
+            name = "#{name}::#{suffix}" if suffix
+
+            if node.children[0]
+              class_name_from_node(node.children[0], name)
+            else
+              name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/gem_fetcher.rb

@@ -0,0 +1,41 @@
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        # This cop prevents usage of the `git` and `github` arguments to `gem` in a
+        # `Gemfile` in order to avoid additional points of failure beyond
+        # rubygems.org.
+        class GemFetcher < RuboCop::Cop::Cop
+          MSG = 'Do not use gems from git repositories, only use gems from RubyGems.'.freeze
+
+          GIT_KEYS = [:git, :github].freeze
+
+          def on_send(node)
+            return unless gemfile?(node)
+
+            func_name = node.children[1]
+            return unless func_name == :gem
+
+            node.children.last.each_node(:pair) do |pair|
+              key_name = pair.children[0].children[0].to_sym
+              if GIT_KEYS.include?(key_name)
+                add_offense(node, pair.source_range, MSG)
+              end
+            end
+          end
+
+          private
+
+          def gemfile?(node)
+            node
+              .location
+              .expression
+              .source_buffer
+              .name
+              .end_with?("Gemfile")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/in_batches.rb

@@ -0,0 +1,20 @@
+require_relative '../model_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        # Cop that prevents the use of `in_batches`
+        class InBatches < RuboCop::Cop::Cop
+          MSG = 'Do not use `in_batches`, use `each_batch` from the EachBatch module instead'.freeze
+
+          def on_send(node)
+            return unless node.children[1] == :in_batches
+
+            add_offense(node, :selector)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/migration/add_column.rb

@@ -0,0 +1,56 @@
+require_relative '../../migration_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module Migration
+          # Cop that checks if columns are added in a way that doesn't require
+          # downtime.
+          class AddColumn < RuboCop::Cop::Cop
+            include MigrationHelpers
+
+            WHITELISTED_TABLES = [:application_settings].freeze
+
+            MSG = '`add_column` with a default value requires downtime, ' \
+              'use `add_column_with_default` instead'.freeze
+
+            def on_send(node)
+              return unless in_migration?(node)
+
+              name = node.children[1]
+
+              return unless name == :add_column
+
+              # Ignore whitelisted tables.
+              return if table_whitelisted?(node.children[2])
+
+              opts = node.children.last
+
+              return unless opts&.type == :hash
+
+              opts.each_node(:pair) do |pair|
+                if hash_key_type(pair) == :sym && hash_key_name(pair) == :default
+                  add_offense(node, :selector)
+                end
+              end
+            end
+
+            def table_whitelisted?(symbol)
+              symbol&.type == :sym &&
+                WHITELISTED_TABLES.include?(symbol.children[0])
+            end
+
+            def hash_key_type(pair)
+              pair.children[0].type
+            end
+
+            def hash_key_name(pair)
+              pair.children[0].children[0]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/migration/add_column_with_default_to_large_table.rb

@@ -0,0 +1,59 @@
+require_relative '../../migration_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module Migration
+          # This cop checks for `add_column_with_default` on a table that's been
+          # explicitly blacklisted because of its size.
+          #
+          # Even though this helper performs the update in batches to avoid
+          # downtime, using it with tables with millions of rows still causes a
+          # significant delay in the deploy process and is best avoided.
+          #
+          # See https://gitlab.com/gitlab-com/infrastructure/issues/1602 for more
+          # information.
+          class AddColumnWithDefaultToLargeTable < RuboCop::Cop::Cop
+            include MigrationHelpers
+
+            MSG = 'Using `add_column_with_default` on the `%s` table will take a ' \
+              'long time to complete, and should be avoided unless absolutely ' \
+              'necessary'.freeze
+
+            LARGE_TABLES = %i[
+              ci_pipelines
+              ci_builds
+              events
+              issues
+              merge_request_diff_files
+              merge_request_diffs
+              merge_requests
+              namespaces
+              notes
+              projects
+              routes
+              users
+            ].freeze
+
+            def_node_matcher :add_column_with_default?, <<~PATTERN
+              (send nil :add_column_with_default $(sym ...) ...)
+            PATTERN
+
+            def on_send(node)
+              return unless in_migration?(node)
+
+              matched = add_column_with_default?(node)
+              return unless matched
+
+              table = matched.to_a.first
+              return unless LARGE_TABLES.include?(table)
+
+              add_offense(node, :expression, format(MSG, table))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/migration/add_concurrent_foreign_key.rb

@@ -0,0 +1,31 @@
+require_relative '../../migration_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module Migration
+          # Cop that checks if `add_concurrent_foreign_key` is used instead of
+          # `add_foreign_key`.
+          class AddConcurrentForeignKey < RuboCop::Cop::Cop
+            include MigrationHelpers
+
+            MSG = '`add_foreign_key` requires downtime, use `add_concurrent_foreign_key` instead'.freeze
+
+            def on_send(node)
+              return unless in_migration?(node)
+
+              name = node.children[1]
+
+              add_offense(node, :selector) if name == :add_foreign_key
+            end
+
+            def method_name(node)
+              node.children.first
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/migration/add_concurrent_index.rb

@@ -0,0 +1,38 @@
+require_relative '../../migration_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module Migration
+          # Cop that checks if `add_concurrent_index` is used with `up`/`down` methods
+          # and not `change`.
+          class AddConcurrentIndex < RuboCop::Cop::Cop
+            include MigrationHelpers
+
+            MSG = '`add_concurrent_index` is not reversible so you must manually define ' \
+              'the `up` and `down` methods in your migration class, using `remove_concurrent_index` in `down`'.freeze
+
+            def on_send(node)
+              return unless in_migration?(node)
+
+              name = node.children[1]
+
+              return unless name == :add_concurrent_index
+
+              node.each_ancestor(:def) do |def_node|
+                next unless method_name(def_node) == :change
+
+                add_offense(def_node, :name)
+              end
+            end
+
+            def method_name(node)
+              node.children.first
+            end
+          end
+        end
+      end
+    end
+  end
+end