gitlab-styles 0.1.0

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

@@ -0,0 +1,27 @@
+require_relative '../model_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        # Cop that prevents the use of polymorphic associations
+        class PolymorphicAssociations < RuboCop::Cop::Cop
+          include ModelHelpers
+
+          MSG = 'Do not use polymorphic associations, use separate tables instead'.freeze
+
+          def on_send(node)
+            return unless in_model?(node)
+            return unless node.children[1] == :belongs_to
+
+            node.children.last.each_node(:pair) do |pair|
+              key_name = pair.children[0].children[0]
+
+              add_offense(pair, :expression) if key_name == :polymorphic
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        class ProjectPathHelper < RuboCop::Cop::Cop
+          MSG = 'Use short project path helpers without explicitly passing the namespace: ' \
+            '`foo_project_bar_path(project, bar)` instead of ' \
+            '`foo_namespace_project_bar_path(project.namespace, project, bar)`.'.freeze
+
+          METHOD_NAME_PATTERN = /\A([a-z_]+_)?namespace_project(?:_[a-z_]+)?_(?:url|path)\z/
+
+          def on_send(node)
+            return unless method_name(node).to_s =~ METHOD_NAME_PATTERN
+
+            namespace_expr, project_expr = arguments(node)
+            return unless namespace_expr && project_expr
+
+            return unless namespace_expr.type == :send
+            return unless method_name(namespace_expr) == :namespace
+            return unless receiver(namespace_expr) == project_expr
+
+            add_offense(node, :selector)
+          end
+
+          def autocorrect(node)
+            helper_name = method_name(node).to_s.sub('namespace_project', 'project')
+
+            arguments = arguments(node)
+            arguments.shift # Remove namespace argument
+
+            replacement = "#{helper_name}(#{arguments.map(&:source).join(', ')})"
+
+            lambda do |corrector|
+              corrector.replace(node.source_range, replacement)
+            end
+          end
+
+          private
+
+          def receiver(node)
+            node.children[0]
+          end
+
+          def method_name(node)
+            node.children[1]
+          end
+
+          def arguments(node)
+            node.children[2..-1]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        # This cop prevents usage of 'redirect_to' in actions 'destroy' without specifying 'status'.
+        # See https://gitlab.com/gitlab-org/gitlab-ce/issues/31840
+        class RedirectWithStatus < RuboCop::Cop::Cop
+          MSG = 'Do not use "redirect_to" without "status" in "destroy" action'.freeze
+
+          def on_def(node)
+            return unless in_controller?(node)
+            return unless destroy?(node) || destroy_all?(node)
+
+            node.each_descendant(:send) do |def_node|
+              next unless redirect_to?(def_node)
+
+              methods = []
+
+              def_node.children.last.each_node(:pair) do |pair|
+                methods << pair.children.first.children.first
+              end
+
+              add_offense(def_node, :selector) unless methods.include?(:status)
+            end
+          end
+
+          private
+
+          def in_controller?(node)
+            node.location.expression.source_buffer.name.end_with?('_controller.rb')
+          end
+
+          def destroy?(node)
+            node.children.first == :destroy
+          end
+
+          def destroy_all?(node)
+            node.children.first == :destroy_all
+          end
+
+          def redirect_to?(node)
+            node.children[1] == :redirect_to
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/rspec/single_line_hook.rb

@@ -0,0 +1,42 @@
+require 'rubocop-rspec'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module RSpec
+          # This cop checks for single-line hook blocks
+          #
+          # @example
+          #
+          #   # bad
+          #   before { do_something }
+          #   after(:each) { undo_something }
+          #
+          #   # good
+          #   before do
+          #     do_something
+          #   end
+          #
+          #   after(:each) do
+          #     undo_something
+          #   end
+          class SingleLineHook < RuboCop::Cop::Cop
+            MESSAGE = "Don't use single-line hook blocks.".freeze
+
+            def_node_search :rspec_hook?, <<~PATTERN
+              (send nil {:after :around :before} ...)
+            PATTERN
+
+            def on_block(node)
+              return unless rspec_hook?(node)
+              return unless node.single_line?
+
+              add_offense(node, :expression, MESSAGE)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/migration_helpers.rb

@@ -0,0 +1,15 @@
+module Gitlab
+  module Styles
+    module Rubocop
+      # Module containing helper methods for writing migration cops.
+      module MigrationHelpers
+        # Returns true if the given node originated from the db/migrate directory.
+        def in_migration?(node)
+          dirname = File.dirname(node.location.expression.source_buffer.name)
+
+          dirname.end_with?('db/migrate', 'db/post_migrate')
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/model_helpers.rb

@@ -0,0 +1,15 @@
+module Gitlab
+  module Styles
+    module Rubocop
+      module ModelHelpers
+        # Returns true if the given node originated from the models directory.
+        def in_model?(node)
+          path = node.location.expression.source_buffer.name
+          models_path = File.join(Dir.pwd, 'app', 'models')
+
+          path.start_with?(models_path)
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/version.rb

@@ -0,0 +1,5 @@
+module Gitlab
+  module Styles
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-styles
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GitLab
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rubocop-gitlab-security
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- remy@rymai.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- default.yml
+- gitlab-styles.gemspec
+- lib/gitlab/styles.rb
+- lib/gitlab/styles/rubocop.rb
+- lib/gitlab/styles/rubocop/cop/active_record_dependent.rb
+- lib/gitlab/styles/rubocop/cop/active_record_serialize.rb
+- lib/gitlab/styles/rubocop/cop/custom_error_class.rb
+- lib/gitlab/styles/rubocop/cop/gem_fetcher.rb
+- lib/gitlab/styles/rubocop/cop/in_batches.rb
+- lib/gitlab/styles/rubocop/cop/migration/add_column.rb
+- lib/gitlab/styles/rubocop/cop/migration/add_column_with_default_to_large_table.rb
+- lib/gitlab/styles/rubocop/cop/migration/add_concurrent_foreign_key.rb
+- lib/gitlab/styles/rubocop/cop/migration/add_concurrent_index.rb
+- lib/gitlab/styles/rubocop/cop/migration/add_index.rb
+- lib/gitlab/styles/rubocop/cop/migration/add_timestamps.rb
+- lib/gitlab/styles/rubocop/cop/migration/datetime.rb
+- lib/gitlab/styles/rubocop/cop/migration/hash_index.rb
+- lib/gitlab/styles/rubocop/cop/migration/remove_concurrent_index.rb
+- lib/gitlab/styles/rubocop/cop/migration/remove_index.rb
+- lib/gitlab/styles/rubocop/cop/migration/reversible_add_column_with_default.rb
+- lib/gitlab/styles/rubocop/cop/migration/safer_boolean_column.rb
+- lib/gitlab/styles/rubocop/cop/migration/timestamps.rb
+- lib/gitlab/styles/rubocop/cop/migration/update_column_in_batches.rb
+- lib/gitlab/styles/rubocop/cop/polymorphic_associations.rb
+- lib/gitlab/styles/rubocop/cop/project_path_helper.rb
+- lib/gitlab/styles/rubocop/cop/redirect_with_status.rb
+- lib/gitlab/styles/rubocop/cop/rspec/single_line_hook.rb
+- lib/gitlab/styles/rubocop/migration_helpers.rb
+- lib/gitlab/styles/rubocop/model_helpers.rb
+- lib/gitlab/styles/version.rb
+homepage: https://github.com/gitlab-org/gitlab-styles
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: GitLab style guides and shared style configs.
+test_files: []