Verified Commit ef2542f5 authored by Hercules Merscher's avatar Hercules Merscher 🌴
Browse files

fix: Rubocop offenses

parent 3b180dd3

lib/labkit/logging/field_validator.rb

+10 −11
Original line number Diff line number Diff line 
# frozen_string_literal: true



require 'set'

require 'json'

require 'yaml'

require "json"

require "yaml"



require_relative 'field_validator/config'

require_relative 'field_validator/log_interceptor'

require_relative 'field_validator/registry'

require_relative "field_validator/config"

require_relative "field_validator/log_interceptor"

require_relative "field_validator/registry"



module Labkit

  module Logging
@@ -46,14 +45,14 @@ module Labkit 


          return if detected_offenses.empty? && new_offenses.empty? && removed_offenses.empty?



          in_ci = ENV['CI'] == 'true'

          in_ci = ENV["CI"] == "true"



          output_ndjson(detected_offenses) if in_ci



          # Auto-remove fixed offenses (not in CI to avoid race conditions)

          handle_removed_offenses(removed_offenses) if removed_offenses.any? && !in_ci



          if ENV['LABKIT_LOGGING_TODO_UPDATE'] == 'true'

          if ENV["LABKIT_LOGGING_TODO_UPDATE"] == "true"

            handle_update(new_offenses)

          elsif new_offenses.any?

            handle_new_offenses(new_offenses)
@@ -98,7 +97,7 @@ module Labkit 
        end



        def handle_new_offenses(new_offenses)

          if ENV['CI'] == 'true' && Config.skip_ci_failure?

          if ENV["CI"] == "true" && Config.skip_ci_failure?

            warn baseline_generation_message(new_offenses)

          else

            warn report_new_offenses(new_offenses)
@@ -120,7 +119,7 @@ module Labkit 
            "Documentation: https://gitlab.com/gitlab-org/ruby/gems/labkit-ruby/-/blob/master/doc/FIELD_STANDARDIZATION.md",

            "",

            "--- Offenses Summary ---",

            "Total offenses: #{offenses.size} across #{offenses.map { |o| o['callsite'] }.uniq.size} file(s)",

            "Total offenses: #{offenses.size} across #{offenses.map { |o| o['callsite'] }.uniq.size} file(s)", # rubocop:disable Rails/Pluck

            ""

          ]

          lines.join("\n")
@@ -157,7 +156,7 @@ module Labkit 


          lines << ""

          lines << ("=" * 80)

          lines << "Total: #{new_offenses.size} new offense(s) in #{new_offenses.map { |o| o['callsite'] }.uniq.size} file(s)"

          lines << "Total: #{new_offenses.size} new offense(s) in #{new_offenses.map { |o| o['callsite'] }.uniq.size} file(s)" # rubocop:disable Rails/Pluck

          lines << ""

          lines << "See https://gitlab.com/gitlab-org/ruby/gems/labkit-ruby/-/blob/master/doc/FIELD_STANDARDIZATION.md"

          lines << ("=" * 80)

spec/labkit/logging/field_validator/config_spec.rb

+1 −1
Original line number Diff line number Diff line
@@ -94,7 +94,7 @@ RSpec.describe Labkit::Logging::FieldValidator::Config do 


        config = YAML.safe_load_file(config_path)

        expect(config['offenses'].size).to eq(2)

        expect(config['offenses'].map { |o| o['callsite'] }).to contain_exactly('existing.rb', 'new.rb')

        expect(config['offenses'].pluck('callsite')).to contain_exactly('existing.rb', 'new.rb')

      end

    end

spec/labkit/logging/field_validator_spec.rb

+1 −1
Original line number Diff line number Diff line
@@ -119,7 +119,7 @@ RSpec.describe Labkit::Logging::FieldValidator do 


        config = YAML.safe_load_file(config_path)

        expect(config['offenses'].size).to eq(2)

        expect(config['offenses'].map { |o| o['callsite'] }).to contain_exactly('old_file.rb', 'new_file.rb')

        expect(config['offenses'].pluck('callsite')).to contain_exactly('old_file.rb', 'new_file.rb')

      end



      it 'outputs success message with count' do

spec/labkit/logging/json_logger_spec.rb

+1 −1
Original line number Diff line number Diff line
@@ -177,7 +177,7 @@ RSpec.describe Labkit::Logging::JsonLogger do 
  end



  describe "reserved log keys" do

    let(:reserved_key_data) { described_class::RESERVED_LOG_KEYS.to_h { |k| [k, 42] } }

    let(:reserved_key_data) { described_class::RESERVED_LOG_KEYS.index_with { |_k| 42 } }

    let(:expected_error) { /^The following log keys used are reserved: #{described_class::RESERVED_LOG_KEYS.join(", ")}.*/ }



    shared_examples "raise error" do