theforeman-rubocop 0.0.6 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbbe548f51498820c292bf44965d764dbdab91c1d193a829231d6249bf7e7daf
-  data.tar.gz: 84927a1cfba2eee92b2fbc55baace5559d66c97188e45ed2354c1e7ffe6c1a8b
+  metadata.gz: 4e9eb8f575e916fcab0745eb7276223aa6dcb811a15d07c2060797c5f39052f7
+  data.tar.gz: 036dd53d4ef286f78a8e19a516943760a7d639b2802001fc1dac4a0d01d60c9a
 SHA512:
-  metadata.gz: d7d2faf2f935f170891ac00a820767d7052191b094bd4a2533fd24c84c3f0fc46907a74d62a6f7db6541fa970123bbb274ef52ee492ca248eba2ac7db83fed2f
-  data.tar.gz: 127c9be12615fcac2b0c8995364f86e9f7df6c012a1fa7c2d051dcfff55d7382fc630b786cc68218f34354329c8a1604bd0abb1814ff5f0fce77347fe047e353
+  metadata.gz: e3de58bbbb56e96a03f537a33c06584db876f9c6d6afacc8425925f2958e5eed0ec6b0c51b92463d77c81cd43179cd3b957618cd96ad36ee7fc8adaef492a58c
+  data.tar.gz: 5b15ed628bfce839978f14afd07a2c854c273f520633c4819796851aa074f13c135f50d8c2aee62bf01007c04fb948a1413038c9ca20e7a33b818db30571736f

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

@@ -1,50 +1,17 @@
 name: Publish RubyGem
 
 on:
-  tags:
-    - v*
+  create:
+      tags:
+      - v*
 
 jobs:
-  publish_ghp:
-    name: Build + Publish on GHP
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-
-    - run: gem build *.gemspec
-    - name: Publish to GPR
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-      env:
-        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
-        OWNER: ${{ github.repository_owner }}
-
   publish_rubygems:
     name: Build + Publish on RubyGems
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: 2.6.x
-
-      - 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
-        env:
-          GEM_HOST_API_KEY: "Bearer ${{secrets.RUBYGEM_API_KEY}}"
+        uses: dawidd6/action-publish-gem@v1
+        with:
+          api_key: ${{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'

data/default.yml

@@ -4,6 +4,8 @@ inherit_from:
   - rules/style.yml
   - rules/performance.yml
   - rules/rails.yml
+  - rules/to_decide.yml
+  - rules/minitest.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

@@ -1,3 +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.6'.freeze
+    VERSION = '0.1.2'.freeze
   end
 end

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_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/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/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.6
+  version: 0.1.2
 platform: ruby
 authors:
 - Ondřej Ezr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-30 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
@@ -133,17 +147,20 @@ files:
 - AUTHORS
 - README.md
 - default.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_lenient.yml
+- rules/to_decide.yml
 - strict.yml
 - strictest.yml
 - theforeman-rubocop.gemspec
@@ -165,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Shared Rubocop configuration for theforeman.org family of projects.