rubocop-gitlab_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc653c05f38b15dd3819c0b4ad9141d402c7f62809a3c2e8aaa931f75c3caa2a
+  data.tar.gz: 950eb51ff5dbcd2dc6bace396a7111d1689353f4d24c49dffe68deaecd6bd4ee
+SHA512:
+  metadata.gz: eb09f4a99cc22cb7a188088db6ad0b04161cb7b654a3542660426bb937cdb242e77a5b14b91c97b2951da93f303a227b67fa04e9e581e7aacb8c549d1630188f
+  data.tar.gz: 9ffd97a5bbbb30dfc6263b1376347cb9569c3e07655d913ae3bf7e0514faa065b3c1b604c933138fe50aa110788292ee57f76be080c789f71a1e0d2ba6601a13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Jonathan Georges
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# RuboCop GitLab Formatter
+
+A very simple [RuboCop](https://github.com/rubocop/rubocop) formatter that renders a json compliant with the [Gitlab CodeQuality format](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html#implementing-a-custom-tool).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-gitlab_formatter', require: false
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install rubocop-gitlab_formatter
+```
+
+## Usage
+
+```sh
+rubocop --require rubocop-gitlab_formatter --format RuboCop::Formatter::GitLabFormatter
+```
+
+Or require it in `.rubocop.yml`:
+
+```yaml
+require:
+  - rubocop-gitlab_formatter
+```
+
+The main purpose of the formatter is to be used with the [GitLab code quality](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html) report.
+
+Configure your `.gitlab-ci.yml` like that:
+
+```yaml
+rubocop:
+  artifacts:
+    reports:
+      codequality: codequality_reports.json
+  script:
+    - rubocop --require rubocop-gitlab_formatter --format RuboCop::Formatter::GitLabFormatter --out codequality_reports.json
+```
+
+And enjoy the Code Quality features :tada:
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jojos003/rubocop-gitlab_formatter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rubocop/formatter/gitlab_formatter.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'rubocop/formatter/base_formatter'
+
+module RuboCop
+  module Formatter
+    # A very simple RuboCop formatter for use with GitLab code quality artifact
+    # @see https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html#implementing-a-custom-tool
+    class GitLabFormatter < BaseFormatter
+      include PathUtil
+
+      SEVERITY_MAPPING = {
+        I: 'info',
+        R: 'minor',
+        C: 'minor',
+        W: 'major',
+        E: 'critical',
+        F: 'blocker'
+      }.freeze
+
+      attr_reader :output_array
+
+      def initialize(output, options = {})
+        super
+
+        @output_array = []
+      end
+
+      def file_finished(file, offenses)
+        offenses.each do |offense|
+          output_array << hash_for_offense(file, offense)
+        end
+      end
+
+      def finished(_inspected_files)
+        output.write output_array.to_json
+      end
+
+      def hash_for_offense(file, offense)
+        {
+          description: offense.message,
+          fingerprint: offense.hash,
+          severity: SEVERITY_MAPPING[offense.severity.code.to_sym],
+          location: hash_for_location(file, offense.location)
+        }
+      end
+
+      def hash_for_location(file, location)
+        {
+          path: smart_path(file),
+          lines: {
+            begin: location.line
+          }
+        }
+      end
+    end
+  end
+end

data/lib/rubocop-gitlab_formatter.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/formatter/gitlab_formatter'

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-gitlab_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Georges
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: A very simple RuboCop formatter that renders a json compliant with the
+  Gitlab CodeQuality format.
+email:
+- jojos003@free.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/rubocop-gitlab_formatter.rb
+- lib/rubocop/formatter/gitlab_formatter.rb
+homepage: https://github.com/jojos003/rubocop-gitlab_formatter
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/jojos003/rubocop-gitlab_formatter
+  source_code_uri: https://github.com/jojos003/rubocop-gitlab_formatter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A RuboCop formatter for GitLab CodeQuality reports
+test_files: []