Merge branch 'eread/add-rubocop-to-project' into 'master'

Add Rubocop to project

See merge request gitlab-org/gitlab-docs!1289

4 files changed, 63 insertions, 4 deletions

diff --git a/.rubocop.yml b/.rubocop.yml
new file mode 100644
index 00000000..9cb085a6
--- /dev/null
+++ b/.rubocop.yml
@@ -0,0 +1,9 @@
+inherit_gem:
+  gitlab-styles:
+    - rubocop-default.yml
+
+CodeReuse/ActiveRecord:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
diff --git a/Gemfile b/Gemfile
index 170efc7e..1012faf1 100644
--- a/Gemfile
+++ b/Gemfile
@@ -25,4 +25,5 @@ group :test, :development do
   gem 'highline', '~> 2.0.3'
   gem 'rspec', '~> 3.10.0'
   gem 'pry-byebug', '~> 3.9.0', require: false
+  gem 'gitlab-styles', '~> 5.0.0', require: false
 end
diff --git a/Gemfile.lock b/Gemfile.lock
index 14d30bbb..a8172c6c 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -1,6 +1,12 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     adsf (1.4.3)
@@ -11,9 +17,10 @@ GEM
       eventmachine (~> 1.2)
       listen (~> 3.0)
       rack-livereload (~> 0.3)
-    asciidoctor (2.0.10)
+    asciidoctor (2.0.11)
     asciidoctor-plantuml (0.0.12)
       asciidoctor (>= 1.5.6, < 3.0.0)
+    ast (2.4.1)
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
@@ -32,6 +39,12 @@ GEM
     eventmachine (1.2.7)
     ffi (1.13.1)
     formatador (0.2.5)
+    gitlab-styles (5.0.0)
+      rubocop (~> 0.89.1)
+      rubocop-gitlab-security (~> 0.1.0)
+      rubocop-performance (~> 1.8.1)
+      rubocop-rails (~> 2.8)
+      rubocop-rspec (~> 1.44)
     gitlab_kramdown (0.10.0)
       asciidoctor-plantuml (= 0.0.12)
       kramdown (~> 2.3.0)
@@ -56,6 +69,8 @@ GEM
       concurrent-ruby (~> 1.0)
     highline (2.0.3)
     http_parser.rb (0.6.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
     json_schema (0.20.9)
     kramdown (2.3.0)
       rexml
@@ -65,6 +80,7 @@ GEM
     lumberjack (1.2.8)
     method_source (1.0.0)
     mini_portile2 (2.4.0)
+    minitest (5.14.2)
     nanoc (4.11.19)
       addressable (~> 2.5)
       colored (~> 1.2)
@@ -105,6 +121,8 @@ GEM
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     pastel (0.8.0)
       tty-color (~> 0.5)
     pry (0.13.1)
@@ -117,11 +135,13 @@ GEM
     rack (2.2.3)
     rack-livereload (0.3.17)
       rack
+    rainbow (3.0.0)
     rake (13.0.1)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     ref (2.0.0)
+    regexp_parser (1.8.2)
     rexml (3.2.4)
     rouge (3.24.0)
     rspec (3.10.0)
@@ -137,6 +157,30 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
+    rubocop (0.89.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
+    rubocop-gitlab-security (0.1.1)
+      rubocop (>= 0.51)
+    rubocop-performance (1.8.1)
+      rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.8.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.87.0)
+    rubocop-rspec (1.44.1)
+      rubocop (~> 0.87)
+      rubocop-ast (>= 0.7.1)
+    ruby-progressbar (1.10.1)
     sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
@@ -149,13 +193,17 @@ GEM
     shellany (0.0.1)
     slow_enumerator_tools (1.1.0)
     thor (1.0.1)
+    thread_safe (0.3.6)
     tomlrb (1.3.0)
     tty-color (0.5.2)
     tty-command (0.10.0)
       pastel (~> 0.8)
     tty-platform (0.3.0)
     tty-which (0.4.2)
-    zeitwerk (2.4.0)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
@@ -164,6 +212,7 @@ DEPENDENCIES
   adsf (~> 1.4.3)
   adsf-live (~> 1.4.3)
   builder (~> 3.2.4)
+  gitlab-styles (~> 5.0.0)
   gitlab_kramdown (~> 0.10.0)
   guard-nanoc
   highline (~> 2.0.3)
diff --git a/Rakefile b/Rakefile
index a90ae881..8e6d23a7 100644
--- a/Rakefile
+++ b/Rakefile
@@ -145,7 +145,7 @@ namespace :release do
     content.gsub!('X-Y', version.tr('.', '-'))
     content.gsub!('W-Z', chart_version(version).tr('.', '-'))
 
-    open(dockerfile, 'w') do |post|
+    File.open(dockerfile, 'w') do |post|
       post.puts content
     end
 
@@ -157,7 +157,7 @@ namespace :release do
     ci_yaml_content.gsub!("BRANCH_RUNNER: 'master'", "BRANCH_RUNNER: '"+version.tr('.', '-')+"-stable'")
     ci_yaml_content.gsub!("BRANCH_CHARTS: 'master'", "BRANCH_CHARTS: '"+chart_version(version).tr('.', '-')+"-stable'")
 
-    open(ci_yaml, 'w') do |post|
+    File.open(ci_yaml, 'w') do |post|
       post.puts ci_yaml_content
     end