Sha256: f4792aab2a0676c5291ca546871ada0dccb90506d43cbd186d17f80495f138ed

Contents?: true

Size: 1.71 KB

Versions: 59

Compression:

Stored size: 1.71 KB

Contents

# frozen_string_literal: true

require 'json'

module RuboCop
  # Converts RuboCop objects to and from the serialization format JSON.
  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)
      {
        # 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:   :uncorrected
      }
    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 = Parser::Source::Range.new(source_buffer,
                                             o['location']['begin_pos'],
                                             o['location']['end_pos'])
        Cop::Offense.new(o['severity'], location,
                         o['message'],
                         o['cop_name'], o['status'].to_sym)
      end
    end
  end
end

Version data entries

59 entries across 40 versions & 5 rubygems

Version Path
grape-extra_validators-2.0.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.79.0/lib/rubocop/cached_data.rb
rubocop-0.89.1 lib/rubocop/cached_data.rb
rubocop-0.89.0 lib/rubocop/cached_data.rb
rubocop-0.88.0 lib/rubocop/cached_data.rb
rbhint-0.87.1.rc1 lib/rubocop/cached_data.rb
rubocop-0.87.1 lib/rubocop/cached_data.rb
rubocop-0.87.0 lib/rubocop/cached_data.rb
rubocop-0.86.0 lib/rubocop/cached_data.rb
files.com-1.0.1 vendor/bundle/ruby/2.5.0/gems/rubocop-0.85.1/lib/rubocop/cached_data.rb
rbhint-0.85.1.rc2 lib/rubocop/cached_data.rb
rbhint-0.85.1.rc1 lib/rubocop/cached_data.rb
rubocop-0.85.1 lib/rubocop/cached_data.rb
rbhint-0.8.5.rc1 lib/rubocop/cached_data.rb
rubocop-0.85.0 lib/rubocop/cached_data.rb
rubocop-0.84.0 lib/rubocop/cached_data.rb
rubocop-0.83.0 lib/rubocop/cached_data.rb
rubocop-0.82.0 lib/rubocop/cached_data.rb
rubocop-0.81.0 lib/rubocop/cached_data.rb
rubocop-0.80.1 lib/rubocop/cached_data.rb
rubocop-0.80.0 lib/rubocop/cached_data.rb