Sha256: 683643507cff98168863b58b05c6364bd8a076b3f320c9e548c075cd5ac8cf6a

Contents?: true

Size: 1.97 KB

Versions: 11

Compression:

Stored size: 1.97 KB

Contents

# frozen_string_literal: true

require 'json'

module RuboCop
  # Converts RuboCop objects to and from the serialization format JSON.
  # @api private
  class CachedData
    def initialize(filename)
      @filename = filename
    end

    def from_json(text)
      deserialize_offenses(JSON.parse(text))
    end

    def to_json(offenses)
      JSON.dump(offenses.map { |o| serialize_offense(o) })
    end

    private

    def serialize_offense(offense)
      status = :uncorrected if %i[corrected corrected_with_todo].include?(offense.status)
      {
        # Calling #to_s here ensures that the serialization works when using
        # other json serializers such as Oj. Some of these gems do not call
        # #to_s implicitly.
        severity: offense.severity.to_s,
        location: {
          begin_pos: offense.location.begin_pos,
          end_pos: offense.location.end_pos
        },
        message:  message(offense),
        cop_name: offense.cop_name,
        status:   status || offense.status
      }
    end

    def message(offense)
      # JSON.dump will fail if the offense message contains text which is not
      # valid UTF-8
      offense.message.dup.force_encoding(::Encoding::UTF_8).scrub
    end

    # Restore an offense object loaded from a JSON file.
    def deserialize_offenses(offenses)
      source_buffer = Parser::Source::Buffer.new(@filename)
      source_buffer.source = File.read(@filename, encoding: Encoding::UTF_8)
      offenses.map! do |o|
        location = location_from_source_buffer(o, source_buffer)
        Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym)
      end
    end

    def location_from_source_buffer(offense, source_buffer)
      begin_pos = offense['location']['begin_pos']
      end_pos = offense['location']['end_pos']
      if begin_pos.zero? && end_pos.zero?
        Cop::Offense::NO_LOCATION
      else
        Parser::Source::Range.new(source_buffer, begin_pos, end_pos)
      end
    end
  end
end

Version data entries

11 entries across 11 versions & 4 rubygems

Version Path
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cached_data.rb
rubocop-1.67.0 lib/rubocop/cached_data.rb
rubocop-1.66.1 lib/rubocop/cached_data.rb
rubocop-1.66.0 lib/rubocop/cached_data.rb
rubocop-1.65.1 lib/rubocop/cached_data.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cached_data.rb
rubocop-1.65.0 lib/rubocop/cached_data.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/rubocop-1.64.1/lib/rubocop/cached_data.rb
rubocop-1.64.1 lib/rubocop/cached_data.rb
rubocop-1.63.4 lib/rubocop/cached_data.rb
rubocop-1.63.3 lib/rubocop/cached_data.rb