rubycritic_gitlab_code_quality 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f86e0e0e0021871b5d4edfa6f42c2318734f5816953dbddc03fb7f30c7a41363
+  data.tar.gz: b7d4d3918b31c0f7de271280187d54a350009e3f6eed71d101447bdea4b7479d
+SHA512:
+  metadata.gz: 80797587a95b4bb4e54eb027a6b3c63c07db3245caa684c7e883c028430faec8c006a8537b7f574fa47d233f4ceced0cee095b999bd2e6fef52c2e883569956d
+  data.tar.gz: 3ab009bf63ef7d61e83cb06df9df28a84c2aab9b9c49beec47db65866ccf399c0b6b3c855cc307b6448c060ae86686e98d8bcfbeeed3b703f0e1fbeee147a5d4

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-21
+
+- Initial release

data/README.md

@@ -0,0 +1,35 @@
+# RubycriticGitlabQualityFormatter
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubycritic_gitlab_quality_formatter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/rubycritic_gitlab_quality_formatter.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/generator/gitlab.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RubycriticGitlabCodeQuality::Generator
+  class Gitlab
+    def initialize(analysed_modules)
+      @analysed_modules = analysed_modules
+    end
+
+    # Generate the JSON report file for GitLab Code Quality
+    def generate_report
+      json_report = JSON.pretty_generate(build_report)
+      FileUtils.mkdir_p(file_directory) # Ensure output directory exists:contentReference[oaicite:7]{index=7}
+      File.write(file_pathname, json_report)
+    end
+
+    private
+
+    def file_directory
+      RubyCritic::Config.root
+    end
+
+    def file_pathname
+      File.join(file_directory, 'gl-code-quality-report.json')
+    end
+
+    # Build the JSON array of issues (as a pretty-printed JSON string)
+    def build_report
+      @analysed_modules.each_with_object([]) do |mod, issues|
+        mod.smells.each do |smell|
+          locations = smell.locations
+          issues << issue_hash(smell, locations)
+        end
+      end
+    end
+
+    # Determine if a smell should be included as a "critical" issue
+    # def critical_issue?(smell)
+    #   type = smell.type
+    #   # Exclude trivial naming/code style smells
+    #   return false if type =~ /Uncommunicative/  # e.g. UncommunicativeVariableName
+    #   # (Add other minor smell types to exclude if needed)
+    #   # If the smell has a numeric score (e.g. complexity score), we can require it be high:
+    #   if smell.respond_to?(:score) && smell.score.is_a?(Numeric)
+    #     return false if smell.score < 15  # skip low-impact complexity (<15, not very complex)
+    #   end
+    #   true  # include by default if not filtered out
+    # end
+
+    # Construct the issue hash for a given smell and a specific location
+    def issue_hash(smell, locations)
+      main_location = locations.first
+      {
+        type: 'issue',
+        description: smell.message,
+        check_name: smell.type,
+        fingerprint: Utilits.fingerprint(smell, main_location),
+        severity: Utilits.severity(smell),
+        location: {
+          path: Utilits.relative_path(main_location.pathname.to_s),
+          lines: { begin: main_location.line },
+          other_locations: Utilits.additional_locations_hash(locations)
+        },
+        categories: [Utilits.category(smell)]
+      }
+    end
+  end
+end

data/lib/rubycritic_gitlab_code_quality/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubycriticGitlabCodeQuality
+  VERSION = "0.1.0"
+end

data/lib/rubycritic_gitlab_code_quality.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "rubycritic_gitlab_code_quality/version"
+
+module RubycriticGitlabCodeQuality
+  require_relative "generator/gitlab"
+  require_relative "utilits"
+end

data/lib/utilits.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Utilits
+  class << self
+    # Helper to get relative file path (without "./") from a Pathname or string
+    def relative_path(file_path)
+      path = file_path.to_s
+      path.sub(%r{^\.\/}, '')
+    end
+
+    def fingerprint(smell, location)
+      # Use a stable combination of attributes to generate an MD5 hash
+      data = "#{smell.type}|#{smell.context}|#{smell.message}|#{location.pathname}|#{location.line}"
+      Digest::MD5.hexdigest(data)
+    end
+
+    def category(smell)
+      case smell.type.to_s
+      when /Complex|TooManyStatements|LongParameterList/
+        "Complexity"
+      when /Duplicate/
+        "Duplication"
+      when /Irresponsible|FeatureEnvy|UtilityFunction|Clarity|NilCheck|ControlParameter/
+        "Clarity"
+      else
+        "Clarity" # default to Clarity if not matched, since we filtered out pure style issues
+      end
+    end
+
+    def additional_locations_hash(locations)
+      additional_locations = locations[1..]
+      return nil if additional_locations.empty?
+
+      additional_locations.map do
+        { path: relative_path(it.pathname.to_s),
+          lines: { begin: it.line } }
+      end
+    end
+
+    # Map the smell to a severity level for GitLab (info, minor, major, critical, blocker)
+    def severity(smell)
+      score = smell.score
+      return "info" unless score
+
+      case score
+      when 0..9
+        "info"
+      when 10..29
+        "minor"
+      when 30..80
+        "major"
+      else
+        "critical"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: rubycritic_gitlab_code_quality
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- n.kats
+bindir: exe
+cert_chain: []
+date: 2025-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubycritic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.9.2
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/generator/gitlab.rb
+- lib/rubycritic_gitlab_code_quality.rb
+- lib/rubycritic_gitlab_code_quality/version.rb
+- lib/utilits.rb
+licenses: []
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: gitlab code quality formatter for use with gitlab CI.
+test_files: []