solargraph-arc 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f641277bcc7f3c74cb9f54ce2b9b4fbed6659bbb18d7220f557133874dcbf01
+  data.tar.gz: 3ad1bafb9a1976a233d8ce47bc9d551cd68b08c1aed272e95e9512aadd471227
+SHA512:
+  metadata.gz: a3ceb156986b4249722188c9403c27d3dd48dd4912cf228827128a33d6cb6a58ae9326f2f482c32603cf7a191478a083eeb959849a1e1d7891bf0f5b29365620
+  data.tar.gz: 806f4b1d9dc59fcdf148f3ee89c52215481505c2469a8e91c2a2e36d6de8daf6743382eed58ebff0c98114cc8826056440f501bb8c5dda9e700a4bc840feff23

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Debug log**
+
+Run the following command in the project you are having problems:
+```
+ruby -r'solargraph-arc' -e 'Solargraph::Arc::Debug.run()'
+```
+
+and paste the output here

data/.github/workflows/ruby.yml

@@ -0,0 +1,41 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - '2.5'
+          # - '2.6'
+          # - '2.7'
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Install Rails 5 deps
+      run: (cd spec/rails5; bundle install; yard gems)
+    - name: Install Rails 6 deps
+      run: (cd spec/rails6; bundle install; yard gems)
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,7 @@
+tmp/examples.txt
+.DS_Store
+.gem
+spec/rails5/log/
+spec/rails5/tmp/
+spec/rails6/log/
+spec/rails6/tmp/

data/.projections.json

@@ -0,0 +1,5 @@
+{
+  "*": {
+    "make": "bundle exec rspec {file}"
+  }
+}

data/.rspec

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

data/.solargraph.yml

@@ -0,0 +1,19 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters: []
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: []
+plugins: []
+max_files: 5000

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+# 0.1.0
+
+Initial alpha

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+# gem 'solargraph', path: "../solargraph"
+# gem 'rspec'
+# gem 'activesupport'
+# gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    solargraph-arc (0.2.0)
+      activesupport (~> 6.1.4.1)
+      solargraph (~> 0.44.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    e2mmap (0.1.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    nokogiri (1.12.5-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.0.3.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    regexp_parser (2.1.1)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
+      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.4)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    solargraph (0.44.2)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.1.0)
+    tilt (2.0.10)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    yard (0.9.26)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pry (~> 0.14.1)
+  rake (~> 10.0)
+  rspec (~> 3.9.0)
+  solargraph-arc!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,76 @@
+# Solargraph ARC
+
+[Solargraph](https://solargraph.org/) **A**wesome **R**ails **C**completions
+
+## Features
+
+- fixes autocompletion for multi-level classes defined in 1 line `class Foo::Bar::Baz`. See https://github.com/castwide/solargraph/issues/506
+- autocomplete database columns by parsing db/schema.rb
+- autocomplete of model relations
+- parsing of `delegate` calls
+- completions for methods generated by Devise (`current_user`, `sign_in_and_redirect`, etc)
+- better support for running solargraph outside bundle
+- better completion inside controllers. `request`, `response`, `params`, etc.
+- autocomplete inside routes.rb
+- autocomplete inside migrations
+- completions for methods generated by ActiveStorage
+- better ActiveRecord completions
+
+Still, due to dynamic nature of some Rails code, not all completion candidates are returned. Things get worse when you chain methods.
+Without type information, Solargraph cannot deduce the object you are calling methods on.
+
+For an up to date coverage report, please see https://github.com/alisnic/solargraph-arc/tree/master/coverage.
+
+## Supported Ruby/Rails versions
+
+This gem currently supports:
+- Ruby 2.5, 2.6, and 2.7. Ruby 3.0 [almost](https://github.com/alisnic/solargraph-arc/issues/16) works
+- Rails 5 and Rails 6
+
+## Usage
+
+1. Install gem and [make sure your editor is integrated with it](https://solargraph.org/)
+
+    ```
+    gem install solargraph-arc
+    ```
+
+2. If you project does not have a solagraph config, generate one using `solargraph config`
+2. update your project `.solargraph.yml`:
+
+    ```yml
+    # ...
+    plugins:
+      - solargraph-arc
+    ```
+2. if you use solargraph from bundle, don't forget to include `solagraph-arc` in your Gemfile
+2. **IMPORTANT**: Make sure yard documentation is built for your project (solargraph uses it for completions)
+Execute this in your project root:
+
+    ```
+    $ yard gems
+    ```
+
+    otherwise a lot of completions won't work
+
+## Contributing
+
+1. create fork and clone the repo
+2. install gem deps `bundle install`
+3. install dummy rails5 app deps and build its yard cache
+
+    ```
+    $ cd spec/rails5
+    $ bundle install && yard gems
+    $ cd ../../
+    ```
+
+3. install dummy rails6 app deps and build its yard cache
+
+    ```
+    $ cd spec/rails6
+    $ bundle install && yard gems
+    $ cd ../../
+    ```
+4. now tests should pass locally and you can try different changes
+5. sumbit PR

data/coverage/rails5.json

@@ -0,0 +1,114 @@
+[
+  {
+    "class_name": "ActionController::Base",
+    "total": 434,
+    "covered": 149,
+    "typed": 13,
+    "percent_covered": 34.3,
+    "percent_typed": 3.0
+  },
+  {
+    "class_name": "ActionDispatch::Routing::Mapper",
+    "total": 142,
+    "covered": 126,
+    "typed": 8,
+    "percent_covered": 88.7,
+    "percent_typed": 5.6
+  },
+  {
+    "class_name": "ActiveJob::Base",
+    "total": 172,
+    "covered": 88,
+    "typed": 8,
+    "percent_covered": 51.2,
+    "percent_typed": 4.7
+  },
+  {
+    "class_name": "ActiveRecord::Base",
+    "total": 688,
+    "covered": 299,
+    "typed": 13,
+    "percent_covered": 43.5,
+    "percent_typed": 1.9
+  },
+  {
+    "class_name": "Array",
+    "total": 99,
+    "covered": 95,
+    "typed": 7,
+    "percent_covered": 96.0,
+    "percent_typed": 7.1
+  },
+  {
+    "class_name": "Class",
+    "total": 112,
+    "covered": 104,
+    "typed": 8,
+    "percent_covered": 92.9,
+    "percent_typed": 7.1
+  },
+  {
+    "class_name": "Date",
+    "total": 166,
+    "covered": 162,
+    "typed": 8,
+    "percent_covered": 97.6,
+    "percent_typed": 4.8
+  },
+  {
+    "class_name": "DateTime",
+    "total": 193,
+    "covered": 123,
+    "typed": 8,
+    "percent_covered": 63.7,
+    "percent_typed": 4.1
+  },
+  {
+    "class_name": "File",
+    "total": 83,
+    "covered": 79,
+    "typed": 8,
+    "percent_covered": 95.2,
+    "percent_typed": 9.6
+  },
+  {
+    "class_name": "Hash",
+    "total": 110,
+    "covered": 106,
+    "typed": 7,
+    "percent_covered": 96.4,
+    "percent_typed": 6.4
+  },
+  {
+    "class_name": "Integer",
+    "total": 110,
+    "covered": 106,
+    "typed": 8,
+    "percent_covered": 96.4,
+    "percent_typed": 7.3
+  },
+  {
+    "class_name": "Kernel",
+    "total": 56,
+    "covered": 54,
+    "typed": 4,
+    "percent_covered": 96.4,
+    "percent_typed": 7.1
+  },
+  {
+    "class_name": "String",
+    "total": 117,
+    "covered": 113,
+    "typed": 8,
+    "percent_covered": 96.6,
+    "percent_typed": 6.8
+  },
+  {
+    "class_name": "Time",
+    "total": 192,
+    "covered": 187,
+    "typed": 8,
+    "percent_covered": 97.4,
+    "percent_typed": 4.2
+  }
+]

data/coverage/rails6.json

@@ -0,0 +1,114 @@
+[
+  {
+    "class_name": "ActionController::Base",
+    "total": 435,
+    "covered": 147,
+    "typed": 13,
+    "percent_covered": 33.8,
+    "percent_typed": 3.0
+  },
+  {
+    "class_name": "ActionDispatch::Routing::Mapper",
+    "total": 139,
+    "covered": 126,
+    "typed": 8,
+    "percent_covered": 90.6,
+    "percent_typed": 5.8
+  },
+  {
+    "class_name": "ActiveJob::Base",
+    "total": 187,
+    "covered": 107,
+    "typed": 8,
+    "percent_covered": 57.2,
+    "percent_typed": 4.3
+  },
+  {
+    "class_name": "ActiveRecord::Base",
+    "total": 800,
+    "covered": 321,
+    "typed": 10,
+    "percent_covered": 40.1,
+    "percent_typed": 1.3
+  },
+  {
+    "class_name": "Array",
+    "total": 103,
+    "covered": 101,
+    "typed": 7,
+    "percent_covered": 98.1,
+    "percent_typed": 6.8
+  },
+  {
+    "class_name": "Class",
+    "total": 108,
+    "covered": 104,
+    "typed": 8,
+    "percent_covered": 96.3,
+    "percent_typed": 7.4
+  },
+  {
+    "class_name": "Date",
+    "total": 169,
+    "covered": 167,
+    "typed": 10,
+    "percent_covered": 98.8,
+    "percent_typed": 5.9
+  },
+  {
+    "class_name": "DateTime",
+    "total": 196,
+    "covered": 121,
+    "typed": 8,
+    "percent_covered": 61.7,
+    "percent_typed": 4.1
+  },
+  {
+    "class_name": "File",
+    "total": 85,
+    "covered": 83,
+    "typed": 8,
+    "percent_covered": 97.6,
+    "percent_typed": 9.4
+  },
+  {
+    "class_name": "Hash",
+    "total": 115,
+    "covered": 113,
+    "typed": 7,
+    "percent_covered": 98.3,
+    "percent_typed": 6.1
+  },
+  {
+    "class_name": "Integer",
+    "total": 107,
+    "covered": 105,
+    "typed": 8,
+    "percent_covered": 98.1,
+    "percent_typed": 7.5
+  },
+  {
+    "class_name": "Kernel",
+    "total": 55,
+    "covered": 54,
+    "typed": 4,
+    "percent_covered": 98.2,
+    "percent_typed": 7.3
+  },
+  {
+    "class_name": "String",
+    "total": 115,
+    "covered": 113,
+    "typed": 8,
+    "percent_covered": 98.3,
+    "percent_typed": 7.0
+  },
+  {
+    "class_name": "Time",
+    "total": 198,
+    "covered": 194,
+    "typed": 10,
+    "percent_covered": 98.0,
+    "percent_typed": 5.1
+  }
+]

data/lib/solargraph/arc/annotations.rb

@@ -0,0 +1,60 @@
+# The following comments fill some of the gaps in Solargraph's understanding of
+# Rails apps. Since they're all in YARD, they get mapped in Solargraph but
+# ignored at runtime.
+#
+# You can put this file anywhere in the project, as long as it gets included in
+# the workspace maps. It's recommended that you keep it in a standalone file
+# instead of pasting it into an existing one.
+#
+# @!parse
+#   class ActionController::Base
+#     include ActionController::MimeResponds
+#     include ActionController::Redirecting
+#     include ActionController::Cookies
+#     include AbstractController::Rendering
+#     extend ActiveSupport::Callbacks::ClassMethods
+#     extend ActiveSupport::Rescuable::ClassMethods
+#     extend AbstractController::Callbacks::ClassMethods
+#     extend ActionController::RequestForgeryProtection::ClassMethods
+#   end
+#   class ActionDispatch::Routing::Mapper
+#     include ActionDispatch::Routing::Mapper::Base
+#     include ActionDispatch::Routing::Mapper::HttpHelpers
+#     include ActionDispatch::Routing::Mapper::Redirection
+#     include ActionDispatch::Routing::Mapper::Scoping
+#     include ActionDispatch::Routing::Mapper::Concerns
+#     include ActionDispatch::Routing::Mapper::Resources
+#     include ActionDispatch::Routing::Mapper::CustomUrls
+#   end
+#   class Rails
+#     # @return [Rails::Application]
+#     def self.application; end
+#   end
+#   class Rails::Application
+#     # @return [ActionDispatch::Routing::RouteSet]
+#     def routes; end
+#   end
+#   class ActionDispatch::Routing::RouteSet
+#     # @yieldself [ActionDispatch::Routing::Mapper]
+#     def draw; end
+#   end
+#   class ActiveRecord::Base
+#     extend ActiveRecord::QueryMethods
+#     extend ActiveRecord::FinderMethods
+#     extend ActiveRecord::Associations::ClassMethods
+#     extend ActiveRecord::Inheritance::ClassMethods
+#     extend ActiveRecord::ModelSchema::ClassMethods
+#     extend ActiveRecord::Transactions::ClassMethods
+#     extend ActiveRecord::Scoping::Named::ClassMethods
+#     include ActiveRecord::Persistence
+#   end
+# @!override ActiveRecord::FinderMethods#find
+#   @overload find(id)
+#     @param id [Integer]
+#     @return [self]
+#   @overload find(list)
+#     @param list [Array]
+#     @return [Array<self>]
+#   @overload find(*args)
+#     @return [Array<self>]
+#   @return [self, Array<self>]

data/lib/solargraph/arc/autoload.rb

@@ -0,0 +1,48 @@
+module Solargraph
+  module Arc
+    class Autoload
+      def self.instance
+        @instance ||= self.new
+      end
+
+      def process(source_map, ns, ds)
+        return [] unless ds.size == 1 && ns.path.include?("::")
+        Solargraph.logger.debug("[Arc][Autoload] seeding class tree for #{ns.path}")
+
+        root_ns = source_map.pins.find {|p| p.path == "" }
+        namespace_stubs(root_ns, ns)
+      end
+
+      def namespace_stubs(root_ns, ns)
+        parts = ns.path.split("::")
+
+        candidates = parts.each_with_index.reduce([]) do |acc, (_, i)|
+          acc + [parts[0..i].join("::")]
+        end.reject {|el| el == ns.path }
+
+        previous_ns = root_ns
+        pins = []
+
+        parts[0..-2].each_with_index do |name, i|
+          gates = candidates[0..i].reverse + [""]
+          path = gates.first
+          next if path == ns.path
+
+          previous_ns = Solargraph::Pin::Namespace.new(
+            type:       :class,
+            location:   ns.location,
+            closure:    previous_ns,
+            name:       name,
+            comments:   ns.comments,
+            visibility: :public,
+            gates:      gates[1..-1]
+          )
+
+          pins << previous_ns
+        end
+
+        pins
+      end
+    end
+  end
+end

data/lib/solargraph/arc/debug.rb

@@ -0,0 +1,30 @@
+module Solargraph
+  module Arc
+    class Debug
+      def self.run(query=nil)
+        self.new.run(query)
+      end
+
+      def run(query)
+        Solargraph.logger.level = Logger::DEBUG
+
+        api_map = Solargraph::ApiMap.load('./')
+
+        puts "Ruby version: #{RUBY_VERSION}"
+        puts "Solargraph version: #{Solargraph::VERSION}"
+        puts "Solargraph ARC version: #{Solargraph::Arc::VERSION}"
+
+        return unless query
+
+        puts "Known methods for #{query}"
+
+        pin = api_map.pins.find {|p| p.path == query }
+        return unless pin
+
+        api_map.get_complex_type_methods(pin.return_type).each do |pin|
+          puts "- #{pin.path}"
+        end
+      end
+    end
+  end
+end