Sha256: 6d65c9313641dd087515f1a4e157481aa692e7678cf24f98da342cf6af40f917

Contents?: true

Size: 1.8 KB

Versions: 230

Compression:

Stored size: 1.8 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    class Generator
      # A class that injects a require directive into the root RuboCop file.
      # It looks for other directives that require files in the same (cop)
      # namespace and injects the provided one in alpha
      class ConfigurationInjector
        TEMPLATE = <<~YAML
          %<badge>s:
            Description: 'TODO: Write a description of the cop.'
            Enabled: pending
            VersionAdded: '%<version_added>s'
        YAML

        def initialize(configuration_file_path:, badge:, version_added: '<<next>>')
          @configuration_file_path = configuration_file_path
          @badge = badge
          @version_added = version_added
          @output = output
        end

        def inject
          target_line = find_target_line
          if target_line
            configuration_entries.insert(target_line, "#{new_configuration_entry}\n")
          else
            configuration_entries.push("\n#{new_configuration_entry}")
          end

          File.write(configuration_file_path, configuration_entries.join)

          yield if block_given?
        end

        private

        attr_reader :configuration_file_path, :badge, :version_added, :output

        def configuration_entries
          @configuration_entries ||= File.readlines(configuration_file_path)
        end

        def new_configuration_entry
          format(TEMPLATE, badge: badge, version_added: version_added)
        end

        def find_target_line
          configuration_entries.find.with_index do |line, index|
            next unless cop_name_line?(line)

            return index if badge.to_s < line
          end

          nil
        end

        def cop_name_line?(yaml)
          !/^[\s#]/.match?(yaml)
        end
      end
    end
  end
end

Version data entries

230 entries across 221 versions & 22 rubygems

Version Path
rubocop-1.71.0 lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.70.0 lib/rubocop/cop/generator/configuration_injector.rb
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.69.2 lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.69.1 lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.69.0 lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.68.0 lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.67.0 lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.66.1 lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.66.0 lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.65.1 lib/rubocop/cop/generator/configuration_injector.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.65.0 lib/rubocop/cop/generator/configuration_injector.rb
cm-admin-1.5.22 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/generator/configuration_injector.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/generator/configuration_injector.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/generator/configuration_injector.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/rubocop-1.64.1/lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.64.1 lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.63.4 lib/rubocop/cop/generator/configuration_injector.rb
rubocop-1.63.3 lib/rubocop/cop/generator/configuration_injector.rb