lsif_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f71116bf688f9097e2f5558c7450adfc6d504f3e599936cb8cdbf8ddd7a9f69
+  data.tar.gz: 75786976bacdebb1edcdf212769e86658c1b78792ebe19f9b376f03b234f15b5
+SHA512:
+  metadata.gz: 40e600e6e4eced8240842366c9249843d83ddb397aca4a8d3d4257fdee47da06641edbf56e38068690db85bfa3a8274a2474c0a84727c5c38a03cf871f665cc7
+  data.tar.gz: 03ee795e0476f0292eb500742abf333652fff876f96c8dff2b7a859f006ece09b982b81be454758fcbe2a7ba87532f8ad44611b66989e39b16a22f746be6efd0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lsif_parser.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    lsif_parser (0.1.0)
+      rouge (~> 3.17)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rouge (3.17.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  lsif_parser!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Igor Drozdov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# LsifParser
+
+A library for parsing LSIF files using Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lsif_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lsif_parser
+
+## Usage
+
+Examples of using a particular class of the library can be found in the tests
+(`spec` folder)
+
+The basic usage with default strategy (and the one exposed by the binary)
+processes an LSIF file and creates a folder with JSON files which imitate the
+structure of the original project:
+
+Project structure:
+
+```
+app
+  controllers
+    application_controller.rb
+  models
+    application.rb
+  root.rb
+```
+
+Code navigation data structure:
+
+```
+app
+  controllers
+    application_controller.rb.json
+  models
+    application.rb.json
+  root.rb.json
+```
+
+```ruby
+LsifParser::IO.process('dump.lsif', doc_prefix: '/Users/igordrozdov/Documents/Projects/project')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and merge requests are welcome on GitLab at https://gitlab.com/igor-drozdov/lsif_parser.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'lsif_parser'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/lsif_parser

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.join(__dir__, '..', 'lib')
+
+require 'lsif_parser'
+
+raise 'Please specify file name as the first argument' unless ARGV[0]
+raise 'Please specify doc prefix as the second argument' unless ARGV[1]
+
+LsifParser::IO.process(ARGV[0], doc_prefix: ARGV[1])

data/lib/lsif_parser.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'lsif_parser/version'
+require 'lsif_parser/io'
+require 'lsif_parser/docs'
+require 'lsif_parser/ranges'
+require 'lsif_parser/hovers'
+require 'lsif_parser/highlight'
+require 'lsif_parser/docs_strategy'
+require 'lsif_parser/ranges_strategy'

data/lib/lsif_parser/docs.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module LsifParser
+  # Processes and stores documents data and links to their ranges
+  class Docs
+    PREFIX = 'file://'
+
+    attr_reader :docs, :doc_ranges, :ranges
+
+    def initialize(prefix)
+      @prefix = prefix.delete_prefix('/')
+      @docs = {}
+      @doc_ranges = {}
+      @ranges = Ranges.new
+    end
+
+    def read(line)
+      case line['label']
+      when 'document'
+        add(line)
+      when 'contains'
+        add_ranges(line)
+      else
+        @ranges.read(line)
+      end
+    end
+
+    def each
+      docs.each do |id, path|
+        next if path.start_with?(PREFIX)
+
+        yield id, path
+      end
+    end
+
+    def find(id)
+      @docs[id]
+    end
+
+    private
+
+    def add(line)
+      id = line['id']
+      url = line['uri']
+
+      docs[id] =
+        url
+        .delete_prefix("#{PREFIX}/#{prefix}")
+        .delete_prefix('/')
+    end
+
+    def add_ranges(line)
+      @doc_ranges[line['outV']] = line['inVs']
+    end
+
+    attr_reader :prefix
+  end
+end

data/lib/lsif_parser/docs_strategy.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'fileutils'
+require 'lsif_parser/ranges_strategy'
+
+module LsifParser
+  # Creates a folder json files with code navigation data
+  # The folder imitates the structure of the original folder
+  class DocsStrategy
+    def initialize(ranges_strategy: RangesStrategy.new)
+      @ranges_strategy = ranges_strategy
+    end
+
+    def process(file_path, docs)
+      docs.each do |id, path|
+        ranges_for_file = @ranges_strategy.process(docs.doc_ranges[id], docs)
+
+        _, source_file_name = File.split(file_path)
+        file_dir, file_name = File.split(path)
+        absolute_dir, = FileUtils.mkdir_p("#{source_file_name}.tmp/#{file_dir}")
+
+        File.open([absolute_dir, "#{file_name}.json"].join('/'), 'w') do |f|
+          f.write(JSON.dump(ranges_for_file))
+        end
+      end
+    end
+  end
+end

data/lib/lsif_parser/highlight.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'rouge'
+
+module LsifParser
+  # Highlight hovers
+  class Highlight
+    # HTML formatter for a hover
+    class HTMLGitlab < Rouge::Formatters::HTML
+      tag 'html_gitlab'
+
+      def initialize(tag: nil)
+        @line_number = 1
+        @tag = tag
+      end
+
+      def stream(tokens)
+        is_first = true
+        token_lines(tokens) do |line|
+          yield "\n" unless is_first
+          is_first = false
+
+          yield %(<span id="LC#{@line_number}" class="line" lang="#{@tag}">)
+          line.each { |token, value| yield span(token, value.chomp) }
+          yield %(</span>)
+
+          @line_number += 1
+        end
+      end
+    end
+
+    def self.run(hover)
+      lexer = Rouge::Lexer.find_fancy(hover['language'])
+      tag = lexer.tag
+      tokens = lexer.lex(hover['value'], continue: false)
+      HTMLGitlab.format(tokens, tag: tag)
+    end
+  end
+end

data/lib/lsif_parser/hovers.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module LsifParser
+  # Processes and stores hovers data for ranges
+  class Hovers
+    def initialize
+      @data = {}
+      @refs = {}
+      @hovers = {}
+    end
+
+    def read(line)
+      case line['label']
+      when 'hoverResult'
+        add_data(line)
+      when 'textDocument/hover'
+        add(line)
+      when 'textDocument/references'
+        add_refs(line)
+      end
+    end
+
+    def for(id)
+      ref_id = @refs[id]
+      hover_id = @hovers[ref_id]
+      @data[hover_id]
+    end
+
+    private
+
+    def add(line)
+      @hovers[line['outV']] = line['inV']
+    end
+
+    def add_data(line)
+      @data[line['id']] = line['result']['contents']
+    end
+
+    def add_refs(line)
+      @refs[line['inV']] = line['outV']
+    end
+  end
+end

data/lib/lsif_parser/io.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'lsif_parser/docs_strategy'
+
+module LsifParser
+  # Processes an LSIF file
+  class IO
+    def self.process(path, doc_prefix: '', docs_strategy: DocsStrategy.new)
+      docs = Docs.new(doc_prefix)
+
+      File.open(path, 'r').each_line do |raw_line|
+        line = JSON.parse(raw_line)
+
+        docs.read(line)
+      end
+
+      docs_strategy.process(path, docs)
+    end
+  end
+end

data/lib/lsif_parser/ranges.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module LsifParser
+  # Processes and stores ranges data and links to their hovers and definitions
+  class Ranges
+    def initialize
+      @ranges = {}
+      @def_refs = {}
+      @hovers = Hovers.new
+    end
+
+    def read(line)
+      case line['label']
+      when 'range'
+        add(line)
+      when 'item'
+        add_item(line)
+      else
+        @hovers.read(line)
+      end
+    end
+
+    def find(id)
+      @ranges[id]
+    end
+
+    def hover_for(id)
+      @hovers.for(id)
+    end
+
+    def def_ref_for(id)
+      @def_refs[id]
+    end
+
+    private
+
+    def add(line)
+      id = line['id']
+      start_data = line['start']
+
+      @ranges[id] = {
+        start_line: start_data['line'],
+        start_char: start_data['character']
+      }
+    end
+
+    def add_item(line)
+      type = line['property']
+
+      return unless %w[definitions references].include?(type)
+
+      line['inVs'].each do |range_id|
+        @ranges[range_id]&.merge!(ref_id: line['outV'])
+      end
+
+      return unless type == 'definitions'
+
+      @def_refs[line['outV']] = {
+        id: line['inVs'].first,
+        doc_id: line['document']
+      }
+    end
+  end
+end

data/lib/lsif_parser/ranges_strategy.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'lsif_parser/highlight'
+
+module LsifParser
+  # Serializes ranges data with hovers and definition paths
+  class RangesStrategy
+    def process(ranges, docs)
+      ranges&.map do |range_id|
+        range = docs.ranges.find(range_id)
+        ref_id = range[:ref_id]
+
+        {
+          start_line: range[:start_line],
+          start_char: range[:start_char],
+          definition_path: def_path_for(docs, ref_id),
+          hover: hover_for(docs, ref_id)
+        }
+      end
+    end
+
+    private
+
+    def hover_for(docs, ref_id)
+      docs.ranges.hover_for(ref_id)&.map do |hover|
+        # Documentation for a method which is added as comments
+        # is stored as a raw string value in LSIF file
+        next { value: hover } unless hover.is_a?(Hash)
+
+        { language: hover['language'], value: Highlight.run(hover) }
+      end
+    end
+
+    def def_path_for(docs, ref_id)
+      def_ref = docs.ranges.def_ref_for(ref_id)
+      range = def_ref && docs.ranges.find(def_ref[:id])
+
+      return unless range
+
+      "#{docs.find(def_ref[:doc_id])}#L#{range[:start_line] + 1}"
+    end
+  end
+end

data/lib/lsif_parser/version.rb

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

data/lsif_parser.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lsif_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lsif_parser'
+  spec.version       = LsifParser::VERSION
+  spec.authors       = ['Igor Drozdov']
+  spec.email         = ['idrozdov@gitlab.com']
+
+  spec.summary       = 'Parse LSIF files using Ruby'
+  spec.description   = 'Parse LSIF files using Ruby'
+  spec.homepage      = 'https://gitlab.com/igor.drozdov/lsif_parser'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem
+  # that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rouge', '~> 3.17'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: lsif_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Drozdov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.17'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Parse LSIF files using Ruby
+email:
+- idrozdov@gitlab.com
+executables:
+- lsif_parser
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/lsif_parser
+- lib/lsif_parser.rb
+- lib/lsif_parser/docs.rb
+- lib/lsif_parser/docs_strategy.rb
+- lib/lsif_parser/highlight.rb
+- lib/lsif_parser/hovers.rb
+- lib/lsif_parser/io.rb
+- lib/lsif_parser/ranges.rb
+- lib/lsif_parser/ranges_strategy.rb
+- lib/lsif_parser/version.rb
+- lsif_parser.gemspec
+homepage: https://gitlab.com/igor.drozdov/lsif_parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Parse LSIF files using Ruby
+test_files: []