orbacle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b560995e47155365bd986cb4ef871acf85fb7cb4753c098f7f7f60bf86cb0a30
+  data.tar.gz: 37ce9c0971c5b2afeee80687daf0cb1aede67e82bc43dfd207223244c1398d0b
+SHA512:
+  metadata.gz: 546a7ca50aa3c04276a13a934e41cda17836fa795d33391c6d3420e0b4764d0a643940c141a58277e9e41f5b4ddebbd2deb4b0c6a10ff61931621e565012aed3
+  data.tar.gz: d9834d7895f9ce459516104d3011fa88e4b06d8fb5178fc13dfcd776fd731692ad505d3e91886399a71387beafc3c6af6ceb300ee3fe62d2a1bac64655683209

data/.gitignore

@@ -0,0 +1,4 @@
+*.db
+*.gem
+data.js
+tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+
+## 0.1.0
+
+* First public version released

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,119 @@
+PATH
+  remote: .
+  specs:
+    orbacle (0.1.0)
+      lsp-protocol (>= 0.0.3)
+      parser (~> 2.4.0.2)
+      priority_queue_cxx
+      rgl (~> 0.5.3)
+      rubytree (~> 0.9.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    anima (0.3.0)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2)
+      equalizer (~> 0.0.11)
+    ast (2.4.0)
+    byebug (10.0.2)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    hash_diff (0.6.3)
+    ice_nine (0.11.2)
+    json (1.8.6)
+    lazy_priority_queue (0.1.1)
+    lsp-protocol (0.0.3)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    mini_portile2 (2.3.0)
+    morpher (0.2.6)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      anima (~> 0.3.0)
+      ast (~> 2.2)
+      concord (~> 0.1.5)
+      equalizer (~> 0.0.9)
+      ice_nine (~> 0.11.0)
+      procto (~> 0.0.2)
+    mutant (0.8.14)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      anima (~> 0.3.0)
+      ast (~> 2.2)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.3)
+      equalizer (~> 0.0.9)
+      ice_nine (~> 0.11.1)
+      memoizable (~> 0.4.2)
+      morpher (~> 0.2.6)
+      parallel (~> 1.3)
+      parser (>= 2.3.1.4, < 2.5)
+      procto (~> 0.0.2)
+      regexp_parser (~> 0.4.3)
+      unparser (~> 0.2.5)
+    mutant-rspec (0.8.14)
+      mutant (~> 0.8.14)
+      rspec-core (>= 3.4.0, < 3.7.0)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    priority_queue_cxx (0.3.4)
+    procto (0.0.3)
+    regexp_parser (0.4.13)
+    rgl (0.5.3)
+      lazy_priority_queue (~> 0.1.0)
+      stream (~> 0.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    ruby-prof (0.17.0)
+    rubytree (0.9.7)
+      json (~> 1.8)
+      structured_warnings (~> 0.2)
+    stream (0.5)
+    structured_warnings (0.3.0)
+    thread_safe (0.3.6)
+    unparser (0.2.7)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.3)
+      equalizer (~> 0.0.9)
+      parser (>= 2.3.1.2, < 2.6)
+      procto (~> 0.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9)
+  byebug
+  hash_diff (~> 0.6.2)
+  mutant-rspec
+  nokogiri (>= 1.8.4)
+  orbacle!
+  rspec
+  ruby-prof
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rafał Łasocha
+
+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/Makefile

@@ -0,0 +1,57 @@
+mutant:
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::Builder#handle_int"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::Builder#handle_float"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::Builder#handle_rational"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::Builder#handle_complex"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::Builder#handle_bool"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::DefineBuiltins"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::RubyParser"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::ConstantsTree"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::FindDefinitionUnderPosition"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::LangServer"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::Engine"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#add_lambda"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#get_lambda"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#get_instance_methods_from_class_id"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#find_instance_method_from_class_id"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#get_instance_methods_from_class_name"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#find_instance_method_from_class_name"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#get_class_methods_from_class_name"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#find_class_method_from_class_name"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#find_super_method"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#change_method_visibility"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#get_class"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#add_klass"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#add_mod"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#get_module"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#get_definition"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#get_parent_of"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#set_type_of"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#type_of"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#get_eigenclass_of_definition"
+	@MUTANT_TESTING=true bundle exec mutant --include lib --require orbacle --use rspec "Orbacle::GlobalTree#get_methods"
+
+test: test-unit test-performance
+
+test-unit:
+	bundle exec rspec --tag "~performance" spec
+
+test-performance:
+	bundle exec rspec --tag performance spec
+
+refresh-stats:
+	bundle exec ruby script/fetch_most_popular_rubygems_list.rb
+
+bundle:
+	bundle install
+
+index-itself:
+	bundle exec exe/orbaclerun index
+
+setup: bundle
+
+build:
+	@gem build orbacle.gemspec
+
+install: build
+	@gem install orbacle-0.0.1.gem

data/README.md

@@ -0,0 +1,53 @@
+[![CircleCI](https://circleci.com/gh/swistak35/orbacle/tree/master.svg?style=svg)](https://circleci.com/gh/swistak35/orbacle/tree/master)
+
+# Orbacle
+
+<img src="http://swistak35.com/img/orbacle-logo.png" alt="Orbacle logo" width="100px" align="left" />
+
+Language server using engine allowing for smart jump-to-definitions, understanding metaprogramming definitions, refactoring and more.
+
+Doing as MSc thesis for [Institute of Computer Science, University of Wrocław](http://ii.uni.wroc.pl).
+
+## Objectives
+
+Create a language server for ruby, which can be used across different code editors, like Vim, Emacs or Atom. Focus on understanding of the code in order to provide best functionalities of "go-to definition", autocompletion and refactorings. The idea is to infer information about variables (i.e. their "types"), **without requiring developer to write any annotations**, just like IDEs do that - through static analysis.
+
+## Current status
+
+Currently language server supports:
+* hover request - information about "type" of an expression
+* jump to definition - jump to definition of constant or method
+
+## Setup
+
+### Prerequisite indexing
+
+1. Install `orbacle` gem.
+2. Run `orbaclerun -d <your_project_directory> index`
+
+It will show you how long does it take to index your project, i.e. how long do you have to wait after editor start to have language server functional underneath.
+
+### Vim
+
+Using `vim-plug`:
+
+```
+Plug 'autozimu/LanguageClient-neovim', { 'branch': 'next', 'do': 'bash install.sh' }
+
+let g:LanguageClient_serverCommands = {
+  \ 'ruby': ['orbaclerun', 'file-server'],
+  \ }
+nnoremap <localleader>lj :call LanguageClient_textDocument_definition()<CR>
+nnoremap T :call LanguageClient_textDocument_hover()<CR>
+" timeout has to be bigger than time needed to index your project
+let g:LanguageClient_waitOutputTimeout = 240
+```
+
+## Contributing
+
+Currently I do not accept contributions, as this is part of MSc thesis. However features ideas and bug reports are accepted.
+
+## Bibliography
+
+* [Tern](http://marijnhaverbeke.nl/blog/tern.html)
+* Fast Interprocedural Class Analysis, Greg DeFouw, David Grove, Craig Chambers, July 1997

data/circle.yml

@@ -0,0 +1,82 @@
+version: 2
+jobs:
+  build-2.3.7:
+    docker:
+      - image: circleci/ruby:2.3.7
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: ~/vendor/bundle
+    steps:
+      - checkout
+      - restore_cache:
+          key: bundle-v2-{{ checksum "Gemfile.lock" }}
+      - run: make bundle
+      - save_cache:
+          key: bundle-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ~/vendor/bundle
+      - run: make test
+      - run: make index-itself
+  build-2.4.4:
+    docker:
+      - image: circleci/ruby:2.4.4
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: ~/vendor/bundle
+    steps:
+      - checkout
+      - restore_cache:
+          key: bundle-v2-{{ checksum "Gemfile.lock" }}
+      - run: make bundle
+      - save_cache:
+          key: bundle-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ~/vendor/bundle
+      - run: make test
+      - run: make index-itself
+  build-2.5.1:
+    docker:
+      - image: circleci/ruby:2.5.1
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: ~/vendor/bundle
+    steps:
+      - checkout
+      - restore_cache:
+          key: bundle-v2-{{ checksum "Gemfile.lock" }}
+      - run: make bundle
+      - save_cache:
+          key: bundle-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ~/vendor/bundle
+      - run: make test
+      - run: make index-itself
+  mutant:
+    docker:
+      - image: circleci/ruby:2.5.1
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: ~/vendor/bundle
+    steps:
+      - checkout
+      - restore_cache:
+          key: bundle-v2-{{ checksum "Gemfile.lock" }}
+      - run: make bundle
+      - save_cache:
+          key: bundle-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ~/vendor/bundle
+      - run: make mutant
+
+workflows:
+  version: 2
+  main:
+    jobs:
+      - build-2.3.7
+      - build-2.4.4
+      - build-2.5.1
+      - mutant

data/exe/orbaclerun

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'orbacle'
+
+cli = Orbacle::CommandLineInterface.new
+cli.(ARGV)

data/index.html

@@ -0,0 +1,106 @@
+<html>
+<head>
+  <script type="text/javascript" src="http://localhost:5000/data.js"></script>
+  <script>
+    function showFile(uri) {
+      found_element = window.orbacleFiles.find(function(elem) { return (elem[0] == uri) })
+      filetext = atob(found_element[1]);
+	  window.currentRawText = filetext;
+      code = document.getElementById('code')
+      code.innerHTML = window.currentRawText
+
+      const nodelist = document.getElementById('nodelist');
+      const nodesForFile = orbacleNodes.filter(function(node) { return (node[2] == uri)});
+      nodelist.innerHTML = nodesForFile.map(function(node) { return (`<tr onclick='highlight(${node[3]}, ${node[4]}, ${node[5]}, ${node[6]}, "${node[1]}")'><td>${node[3]}:${node[4]} - ${node[5]}:${node[6]}</td><td>${node[0]}</td><td>${node[1]}</td></tr>`)}).join("\n");
+    }
+
+    function highlight(startLine, startCharacter, endLine, endCharacter, type) {
+      oldLines = window.currentRawText.split("\n")
+	  code = document.getElementById('code')
+if (startLine == endLine) {
+  startLineContent = oldLines[startLine];
+  newStartLineContent = startLineContent.substr(0, startCharacter) + '<b>' + startLineContent.substr(startCharacter, endCharacter - startCharacter + 1) + '</b>' + startLineContent.substr(endCharacter + 1);
+  oldLines[startLine] = newStartLineContent;
+} else {
+  startLineContent = oldLines[startLine];
+  newStartLineContent = startLineContent.substr(0, startCharacter) + '<b>' + startLineContent.substr(startCharacter);
+  oldLines[startLine] = newStartLineContent;
+
+  endLineContent = oldLines[endLine];
+  newEndLineContent = endLineContent.substr(0, endCharacter + 1) + '</b>' + endLineContent.substr(endCharacter + 1);
+  oldLines[endLine] = newEndLineContent;
+}
+code.innerHTML = oldLines.join("\n");
+
+const typeNode = document.getElementById('type')
+typeNode.innerHTML = `Type of selected element: <b>${type}<b>`;
+    }
+
+    window.onload = function(e){ 
+	  const filesList = document.getElementById('fileslist');
+      const filePaths = orbacleFiles.map(function(file) { return file[0]; });
+      filesList.innerHTML = filePaths.map(function(file) { return (`<a href='#' onclick='showFile("${file}");'>${file}</a>`) }).join(" | ");
+    }
+  </script>
+  <style>
+    #code b {
+      background-color: red;
+    }
+
+    #files, #left, #type, #code, #nodes {
+      border: black 1px solid;
+      display: block;
+    }
+
+    #files  {
+      width: 100%;
+    }
+
+    #left {
+      float: left;
+      width: 700px;
+    }
+
+    #type {
+      float: left;
+        width: 100%;
+      height: 50px;
+      text-align: center;
+    }
+
+    #code {
+      float: left;
+      width: 100%;
+      font-family: "Courier New", Courier, monospace;
+      white-space: pre-wrap;
+      max-height: 700px;
+      overflow-y: scroll;
+    }
+
+	#nodes {
+	  width: 700px;
+      float: left;
+      max-height: 700px;
+      overflow-y: scroll;
+	}
+
+  </style>
+</head>
+<body>
+  <div id="files">
+    <ul id="fileslist">
+      <li><a onclick="showFile('data_flow_graph.rb')">data_flow_graph.rb</a></li>
+    </ul>
+  </div>
+  <div id="left">
+    <div id="type">Unknown</div>
+    <div id="code">
+      Load some file on the left
+    </div>
+  </div>
+  <div id="nodes">
+    <table id="nodelist">
+    </table>
+  </div>
+</body>
+</html>