theforeman-rubocop 0.0.4 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dec7eda262ed8ce64a081f73d79ab7ca5dbf8ecfe3c764603cd354ed876f2608
-  data.tar.gz: c665678918e1ff4447bb680602de6969efabcf670a4cea6bb96633180330b777
+  metadata.gz: 3b23533cc1c2840595ce95428c7257398a1304359180f2315f48711a5e2523d5
+  data.tar.gz: bf0688392785412597d665321895354a6f08931ee03e7a8eba761f45a3e0c87e
 SHA512:
-  metadata.gz: 614d380c95d209a784b6e4def72fa6d75e5eed9532f0274f07d736d965facf05fe3a539d16f92b9849aa3c7b51881260dda07a13e2061da6308f2f0dcfcc02df
-  data.tar.gz: cc33b094bb9d3dea816fd9b8d8902536d618d0281d7797aafd5eb7726ff37534ecf11f162d5535cac14a22d63c6293721f78392a47654d208060b40f9163ca4e
+  metadata.gz: d9743933fb61cdd5dc31ec345dc8b317375d742b3b3cb64f99595ceb1428f5dff8ef897aba4188e755c363feb76762ec683ca4de94bfb38aa80798e4e0cc63df
+  data.tar.gz: c80ded9bdf978a0c12e620e488c64eb35b50351b82c602b2c46a33ff03c3a31e4029d76ee18cd036a47b7f01c2e250ce4d4afbf647e06e71819038a3b4206f64

data/.github/workflows/gem-push.yml

@@ -1,8 +1,9 @@
 name: Publish RubyGem
 
 on:
-  tags:
-    - v*
+  create:
+      tags:
+      - v*
 
 jobs:
   publish_ghp:
@@ -40,11 +41,6 @@ jobs:
 
       - run: gem build *.gemspec
       - name: Publish to RubyGems
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem push *.gem
+        run: gem push *.gem
         env:
           GEM_HOST_API_KEY: "Bearer ${{secrets.RUBYGEM_API_KEY}}"

data/README.md

@@ -14,6 +14,8 @@ Instead of defining the rules for plugin per plugin, plugins can include default
 
 ## Usage
 
+There is also a [guide how to run this in GH action](docs/github_action.md)
+
 ```ruby
 # Gemfile
 gem 'theforeman-rubocop', '~> 0.0.4'
@@ -21,26 +23,39 @@ gem 'theforeman-rubocop', '~> 0.0.4'
 
 And configure in the `.rubocop.yml`.
 
-### Easiest config - get all
+### Easiest config - all opinionated Cops `strict`
+
+```yaml
+inherit_gem:
+  theforeman-rubocop:
+    - strict.yml
+```
 
+### Basic style - `default`, performance and rails cops
 ```yaml
 inherit_gem:
   theforeman-rubocop:
-    - all.yml
+    - default.yml
 ```
 
-### Basic style and performance cops
+### Not intrusive style - `lenient`
+It is similar to default, but has some not as important cops disabled.
+See `rules/style_lenient.yml` for disabled cops.
+
 ```yaml
 inherit_gem:
   theforeman-rubocop:
-    - all.yml
+    - lenient.yml
 ```
 
-### All cops, including newly introduced ones
+### All opinionated cops with new ones - `strictest`
+If you want to closely follow what RuboCop introduces in its new versions, use this level.
+It is the same as `strict`, but enables the newly introduced cops.
+
 ```yaml
 inherit_gem:
   theforeman-rubocop:
-    - edge.yml
+    - strictest.yml
 ```
 
 ### Choose just some cops
@@ -51,11 +66,14 @@ Cops are splited in categories for your convenience, so you can opt-out some cop
 ```yaml
 inherit_gem:
   theforeman-rubocop:
-    - rules/style.yml
+    - rules/base.yml
     - rules/ruby_target.yml
+    - rules/style.yml
+    - rules/metrics.yml
     - rules/performance.yml
     - rules/rails.yml
     - rules/minitest.yml
+    - rules/style_lenient.yml
 
 AllCops:
   NewCops: disable

data/default.yml

@@ -1,8 +1,10 @@
 inherit_from:
   - rules/base.yml
+  - rules/ruby_target.yml
   - rules/style.yml
-  - rules/style_permissive.yml
   - rules/performance.yml
+  - rules/rails.yml
+  - rules/to_decide.yml
 
 AllCops:
   NewCops: disable

data/docs/github_action.md

@@ -0,0 +1,51 @@
+# How to run RuboCop in GH action
+
+## Foreman plugin
+
+We will cover how to do use this in Foreman plugin. It should work for any rubygem the same tho.
+
+Rubocop doesn't benefit from running in the full Foreman environment so it is actually better to have own dependency in Gemfile on it.
+We are then able to run the rubocop directly in the plugin folder, which is much faster as we install only the plugin dependencies, not the full foreman dependencies.
+
+In theory, you can just `gem install theforeman-foreman` in the action, but it is discouraged as it is then hard to synchronize what version you use in the CI.
+
+### Plugin `Gemfile`
+
+```ruby
+  source 'https://rubygems.org'
+gemspec
+
+# We use special group rubocop so we can opt out from all dependencies but rubocop.
+gem 'theforeman-rubocop', '~> 0.1.0', groups: %i[development rubocop]
+```
+
+### GH action
+
+Following GH action will run
+
+```yaml
+name: Ruby Testing
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_WITHOUT: development:test
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7 # Currently supported ruby verion
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop -P --format github
+  view_specs:
+    runs-on: ubuntu-latest
+    needs: rubocop
+    # .... Whatever you run as tests if you run them in GH actions
+```

data/lenient.yml

@@ -0,0 +1,4 @@
+inherit_from:
+  - default.yml
+  - rules/style_lenient.yml
+  - rules/minitest_lenient.yml

data/lib/theforeman/rubocop/version.rb

@@ -1,5 +1,5 @@
 module Theforeman
   module Rubocop
-    VERSION = '0.0.4'.freeze
+    VERSION = '0.1.1'.freeze
   end
 end

data/minitest.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - rules/minitest.yml

data/rules/minitest.yml

@@ -1,2 +1,5 @@
 require:
   - rubocop-minitest
+
+Minitest/MultipleAssertions:
+  Max: 5

data/rules/minitest_lenient.yml

@@ -0,0 +1,2 @@
+Minitest/MultipleAssertions:
+  Enabled: false

data/rules/style.yml

@@ -5,6 +5,9 @@ Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
   IndentationWidth: 2
 
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
@@ -22,6 +25,10 @@ Style/Documentation:
 Style/EmptyMethod:
   EnforcedStyle: expanded
 
+# Enforce ruby19 style
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
 Style/TernaryParentheses:
   EnforcedStyle: require_parentheses_when_complex
 

data/rules/{style_permissive.yml → style_lenient.yml}

@@ -1,7 +1,13 @@
+Naming/VariableNumber:
+  Enabled: false
+
 # Don't prefer is_a? over kind_of?
 Style/ClassCheck:
   Enabled: false
 
+Style/HashAsLastArrayItem:
+  Enabled: false
+
 # Support both, Ruby 1.9 hashmap and hash-rocket syntax
 Style/HashSyntax:
   EnforcedStyle: no_mixed_keys
@@ -14,6 +20,9 @@ Style/LineEndConcatenation:
 Style/StringLiterals:
   Enabled: false
 
+Style/StringConcatenation:
+  Enabled: false
+
 Style/SymbolArray:
   EnforcedStyle: brackets
   MinSize: 1

data/rules/to_decide.yml

@@ -0,0 +1,3 @@
+# We need to decide if we want to allow releasing from CI
+Gemspec/RequireMFA:
+  Enabled: false

data/{all.yml → strict.yml}

@@ -1,11 +1,12 @@
 inherit_from:
   - rules/base.yml
+  - rules/ruby_target.yml
   - rules/style.yml
   - rules/performance.yml
   - rules/metrics.yml
-  - rules/ruby_target.yml
   - rules/rails.yml
   - rules/minitest.yml
+  - rules/to_decide.yml
 
 AllCops:
   NewCops: disable

data/strictest.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - strict.yml
+
+AllCops:
+  NewCops: enable

data/theforeman-rubocop.gemspec

@@ -20,12 +20,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '~> 0.89.0'
+  spec.add_dependency 'rubocop', '~> 1.23.0'
   spec.add_dependency 'rubocop-checkstyle_formatter', '~> 0.4.0'
-  spec.add_dependency 'rubocop-rspec', '~> 1.43.2'
-  spec.add_dependency 'rubocop-minitest', '~> 0.10.1'
+  spec.add_dependency 'rubocop-rspec', '~> 2.0'
+  spec.add_dependency 'rubocop-minitest', '~> 0.17.0'
   spec.add_dependency 'rubocop-performance', '~> 1.8.1'
-  spec.add_dependency 'rubocop-rails', '~> 2.8.1'
+  spec.add_dependency 'rubocop-rails', '~> 2.12.4'
+  spec.add_dependency 'rubocop-graphql', '~> 0.11.2'
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theforeman-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.1
 platform: ruby
 authors:
 - Ondřej Ezr
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.89.0
+        version: 1.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.89.0
+        version: 1.23.0
 - !ruby/object:Gem::Dependency
   name: rubocop-checkstyle_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.43.2
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.43.2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.12.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.12.4
+- !ruby/object:Gem::Dependency
+  name: rubocop-graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description: 
+description:
 email:
 - foreman-dev@googlegroups.com
 executables: []
@@ -132,23 +146,28 @@ files:
 - ".github/workflows/gem-push.yml"
 - AUTHORS
 - README.md
-- all.yml
 - default.yml
-- edge.yml
+- docs/github_action.md
+- lenient.yml
 - lib/theforeman/rubocop/version.rb
+- minitest.yml
 - rules/base.yml
 - rules/metrics.yml
 - rules/minitest.yml
+- rules/minitest_lenient.yml
 - rules/performance.yml
 - rules/rails.yml
 - rules/ruby_target.yml
 - rules/style.yml
-- rules/style_permissive.yml
+- rules/style_lenient.yml
+- rules/to_decide.yml
+- strict.yml
+- strictest.yml
 - theforeman-rubocop.gemspec
 homepage: https://github.com/theforeman/theforeman-rubocop
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,8 +182,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Shared Rubocop configuration for theforeman.org family of projects.
 test_files: []

data/edge.yml

@@ -1,9 +0,0 @@
-inherit_from:
-  - all.yml
-
-AllCops:
-  NewCops: enable
-
-# Enforce ruby19 style
-Style/HashSyntax:
-  EnforcedStyle: ruby19_no_mixed_keys