theforeman-rubocop 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56e4900920ca6ad6e7559e62658fc8e94b13e2ab8f271df397acf6e73443cb90
-  data.tar.gz: 052cb67edccee299ba06af861f8f567e257ac62db6d96f68a025eb417008cebe
+  metadata.gz: f933f45fd6966bc09f46ba494268c9e93a26b1817ee530cf9967098f5ebaed4a
+  data.tar.gz: e6743de32b593b8c307908395e5b86dd6367f0265a4249f1f435a79d29b94663
 SHA512:
-  metadata.gz: 7113b1156b475fe25b60c18ee4fd0cebe20a4e9299965b7adfd23008319de42f006ffa11bd37937fcb0d97b2cd0f890fc52464decc98f01312107c89f6600744
-  data.tar.gz: 957a747731c40f0e4f100908b9de78fe196bc8d3811a9805cc5bccfca588bab9619f4a95516ffa574c266c05ff1e2238000d793400bef0e50b1f85d9e60ec1f8
+  metadata.gz: 1fefc5ca7d7899ec5882cc2d204c2b37892614746781e3762ecaecd370e5348c2d4320157ac19d3b15d0c759f8662ce8489226b77468566d0f6045f516673836
+  data.tar.gz: d402190a05d300b66a913af3bc7bb263442e90643dae4c45dbc961f95f99e925a6da0f67e12b755f7fbdb7d5d310cfef12ae1cab4b03132f23003f3feaaaf451

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

@@ -1,8 +1,9 @@
 name: Publish RubyGem
 
 on:
-  tags:
-    - v*
+  create:
+      tags:
+      - v*
 
 jobs:
   publish_ghp:

data/README.md

@@ -14,33 +14,48 @@ 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.2'
+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,10 +1,9 @@
 inherit_from:
+  - rules/base.yml
+  - rules/ruby_target.yml
   - rules/style.yml
   - rules/performance.yml
+  - rules/rails.yml
 
 AllCops:
   NewCops: disable
-  Exclude:
-    - 'db/schema.rb'
-    - 'node_modules/**/*'
-    - 'vendor/**/*'

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,3 @@
+inherit_from:
+  - default.yml
+  - rules/style_lenient.yml

data/lib/theforeman/rubocop/version.rb

@@ -1,5 +1,5 @@
 module Theforeman
   module Rubocop
-    VERSION = '0.0.3'.freeze
+    VERSION = '0.1.0'.freeze
   end
 end

data/minitest.yml

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

data/rules/base.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - 'db/schema.rb'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'

data/rules/metrics.yml

@@ -0,0 +1,8 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'test/**/*'

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,13 +25,9 @@ Style/Documentation:
 Style/EmptyMethod:
   EnforcedStyle: expanded
 
-# Support both, Ruby 1.9 hashmap and hash-rocket syntax
+# Enforce ruby19 style
 Style/HashSyntax:
-  EnforcedStyle: no_mixed_keys
-
-# Both double and single quotes are OK
-Style/StringLiterals:
-  Enabled: false
+  EnforcedStyle: ruby19_no_mixed_keys
 
 Style/TernaryParentheses:
   EnforcedStyle: require_parentheses_when_complex

data/rules/style_lenient.yml

@@ -0,0 +1,31 @@
+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
+
+# disabled until we can configure "+" as concat sign
+Style/LineEndConcatenation:
+  Enabled: false
+
+# Both double and single quotes are OK
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+  MinSize: 1
+
+Style/WordArray:
+  Enabled: false

data/strict.yml

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

data/strictest.yml

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

data/theforeman-rubocop.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = IO.readlines('AUTHORS', encoding: 'utf-8').map(&:strip)
   spec.email         = ['foreman-dev@googlegroups.com']
 
-  spec.summary       = 'This gem guides and shares rubocop style configs.'
+  spec.summary       = 'Shared Rubocop configuration for theforeman.org family of projects.'
   spec.homepage      = 'https://github.com/theforeman/theforeman-rubocop'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -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.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Ondřej Ezr
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2021-12-08 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,20 +146,26 @@ 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/performance.yml
 - rules/rails.yml
 - rules/ruby_target.yml
 - rules/style.yml
+- rules/style_lenient.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
@@ -160,8 +180,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: This gem guides and shares rubocop style configs.
+summary: Shared Rubocop configuration for theforeman.org family of projects.
 test_files: []

data/all.yml

@@ -1,6 +0,0 @@
-inherit_from:
-  - default.yml
-  - rules/ruby_target.yml
-  - rules/rails.yml
-  - rules/minitest.yml
-

data/edge.yml

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