solargraph-rails 0.2.2.pre.4 → 1.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b1512086d26a2b7a883013b14d919163ea9f3155b67f6cf87ad956c46319857
-  data.tar.gz: f88b8cd47da267a95cb418d339e37ad0e25b975e5952eb19d7b6fb9c1d353d42
+  metadata.gz: 134394397585a1df968b364e98d20b8e38a2fb6294833bfe8bbcfb81b13c545f
+  data.tar.gz: cb4e7fe2906a0769c95e8a3e7de08b6d0188b4dd8d509db2e001006e9367e6db
 SHA512:
-  metadata.gz: c09211c20651d6011f50b1aa6bc3b0c1ab961e868d9bfebdf25eb1c4ac2d0972c2735cddc5bbba8294726e8e63a4b3ad1c4c79db0b9c8d5d7be4aeb0c2dd5caf
-  data.tar.gz: 3be48e28a9eba627f15ff1543d933673f89abcf7b2ac268f1f69ab8414a21dac0cc5e6ae1b518148f165849cec1a0b224d8fa52b1dc94e50585be044ca282a32
+  metadata.gz: c7acc8b51be9a665bcca385a67bcee5eed0ffd9e697c155bfab4e5e94dcd691cb4ccab4f04c09306166c99e9802e3276e9895374540d3df7b3c979c59be582d4
+  data.tar.gz: 4de5589904080422ed72fec8d76e4679a53df812f551c7e99d5d0e6fc7a6cabefe5256a6403dab04ae96e0fd79ec85c92f7a171502202afdb7403e30b266ee04

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-rails' -e 'Solargraph::Rails::Debug.run()'
+```
+
+and paste the output here

data/.github/workflows/ruby.yml

@@ -0,0 +1,36 @@
+# 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:
+  workflow_dispatch: {}
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - "2.7"
+          - "3.0"
+          - "3.1"
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        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

@@ -6,6 +6,14 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store
+spec/rails5/log/
+spec/rails5/tmp/
+spec/rails6/log/
+spec/rails6/tmp/
+.projections.json
+.byebug_history
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

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

@@ -2,6 +2,25 @@
 
 ## Changes
 
+### v1.0.0.pre.1
+
+https://github.com/alisnic/solargraph-arc was merged, with the following 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
+- 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
+
+### v0.3.0
+* Require String inflection monkeypatches directly to avoid error from ActiveSupport v7
+* Remove Gemfile.lock from version control
+
 ### v0.2.2.pre.4
 * Loosen the dependency requirements
 

data/DEVELOPMENT.md

@@ -0,0 +1,83 @@
+# Solargraph-Rails development guide
+
+## 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
+
+## Completion coverage tracking
+
+Solargraph-Rails uses a [set of yaml files](https://github.com/iftheshoefritz/solargraph-rails/tree/master/spec/definitions) to track coverage of found completions.
+Those yaml files are generated at runtime from a dummy [rails5](https://github.com/iftheshoefritz/solargraph-rails/tree/master/spec/rails5) or [rails6](https://github.com/iftheshoefritz/solargraph-rails/tree/master/spec/rails6) app.
+
+The main goal is to catch any regressions in case of any change. In case a method completion is marked completed and it is not found in solargraph completions, the tests will fail.
+
+### Checking coverage
+
+To see what is completion coverage for solargraph-rails, run the tests with the `PRINT_STATS=true` environment variable:
+
+```
+$ PRINT_STATS=true bundle exec rspec
+```
+
+What you will see in test output is reported coverage for classes that are tracked:
+
+```
+{:class_name=>"ActiveRecord::Base", :total=>800, :covered=>321, :typed=>10, :percent_covered=>40.1, :percent_typed=>1.3}
+  provides completions for ActiveRecord::Base
+```
+
+### Updating assertions
+
+In case an improvement is made, and more completions are found then being asserted, tests will throw a warning:
+
+```
+ActionDispatch::Routing::Mapper.try! is marked as skipped in spec/definitions/rails5/routes.yml, but is actually present.
+Consider setting skip=false
+  provides completions for ActionDispatch::Routing::Mapper
+```
+
+In this case there are 2 options:
+1. Manually updating yml file and setting `skip: false` for that method
+2. Updating yml file in place by passing `update: true` to assertion:
+
+```diff
+     assert_matches_definition(
+       map,
+       'ActionDispatch::Routing::Mapper',
+       'rails5/routes',
++      update: true
+     )
+   end
+```
+
+In case of option 2, don't forget to remove the flag after yml file has been updated. Also review git diff, to make sure that no regressions have been set (skip=true was set for entries which previously had skip=false)
+
+### Generating assertions
+
+In case a new set of assertion files has to be created (for a new Rails version for example), a script can be used - https://github.com/iftheshoefritz/solargraph-rails/blob/master/script/generate_definitions.rb.
+
+All you have to do is to go to the same Rails app root, and execute the script:
+
+```
+ruby path/to/generate_definitions.rb
+```
+
+Make sure to review the script and uncomment relevant parts

data/README.md

@@ -52,23 +52,25 @@ Solargraph won't know about attributes that you add during a session. Restart yo
 For my setup with Emacs, that means running `M-x lsp-workspace-restart`, YMMV in other editors.
 
 ## Associations (experimental)
-There is very hacky and simplistic support for `belongs_to` and `has_many` macros, if you are willing to use `gem install solargraph-rails --pre`:
+There is simplistic support for `belongs_to` and `has_many` macros:
 
  ![Experimental autocomplete and go to definition of associations](assets/solar_rails_associations.gif)
 
 ## Known issues
 This project is being used to write production code by the maintainer, but it is still WIP. Check out the issues tab and contribute if you are interested.
 
+Association support is slightly less functional in Rails 7.
+
 ## Installation
 
-###  Install `solargraph` v0.40+ and `solargraph_rails` locally
+###  Install `solargraph` and `solargraph-rails` locally
 
 Typically gems like these are not installed via the Gemfile, because most projects have more than one contributor and other contributors might have different setups for their editors in mind. Instead you need to use `gem install`.
 
 `gem install solargraph-rails`
 
 ####  Alternative: using bundler
-If you do want to use bundler, add `gem 'solargraph-rails', '~> 0.2.0'`
+If you do want to use bundler, add `gem 'solargraph-rails'`
 
 ### Add `solargraph-rails` to your `.solargraph.yml`
 

data/lib/solargraph/rails/annotate.rb

@@ -0,0 +1,44 @@
+module Solargraph
+  module Rails
+    class Annotate
+      def self.instance
+        @instance ||= self.new
+      end
+
+      def self.reset
+        @instance = nil
+      end
+
+      def initialize
+        @schema_present = File.exist?('db/schema.rb')
+      end
+
+      def process(source_map, ns)
+        return [] if @schema_present
+        return [] unless source_map.filename.include?('app/models')
+
+        pins = []
+        walker = Walker.from_source(source_map.source)
+        walker.comments.each do |_, snip|
+          name, type = snip.text.gsub(/[\(\),:\d]/, '').split[1..2]
+
+          next unless name && type
+
+          ruby_type = Schema::RUBY_TYPES[type.to_sym]
+          next unless ruby_type
+
+          pins <<
+            Util.build_public_method(
+              ns,
+              name,
+              types: [ruby_type],
+              location:
+                Solargraph::Location.new(source_map.filename, snip.range)
+            )
+        end
+
+        pins
+      end
+    end
+  end
+end

data/lib/solargraph/rails/annotations.rb

@@ -0,0 +1,50 @@
+# 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

data/lib/solargraph/rails/autoload.rb

@@ -0,0 +1,53 @@
+module Solargraph
+  module Rails
+    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(
+          "[Rails][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([]) { |acc, (_, i)| acc + [parts[0..i].join('::')] }
+            .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/rails/debug.rb

@@ -0,0 +1,30 @@
+module Solargraph
+  module Rails
+    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 Rails version: #{Solargraph::Rails::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 { |pin| puts "- #{pin.path}" }
+      end
+    end
+  end
+end

data/lib/solargraph/rails/delegate.rb

@@ -0,0 +1,42 @@
+module Solargraph
+  module Rails
+    class Delegate
+      def self.instance
+        @instance ||= self.new
+      end
+
+      def process(source_map, ns)
+        return [] unless source_map.code.include?('delegate')
+
+        walker = Walker.from_source(source_map.source)
+        pins = []
+
+        walker.on :send, [nil, :delegate] do |ast|
+          methods =
+            ast.children[2..-1]
+              .map { |c| c.children.first }
+              .select { |s| s.is_a?(Symbol) }
+
+          methods.each do |meth|
+            pins <<
+              Util.build_public_method(
+                ns,
+                meth.to_s,
+                location: Util.build_location(ast, ns.filename)
+              )
+          end
+        end
+
+        walker.walk
+
+        if pins.any?
+          Solargraph.logger.debug(
+            "[Rails][Delegate] added #{pins.map(&:name)} to #{ns.path}"
+          )
+        end
+
+        pins
+      end
+    end
+  end
+end

data/lib/solargraph/rails/devise.rb

@@ -0,0 +1,48 @@
+module Solargraph
+  module Rails
+    class Devise
+      def self.instance
+        @instance ||= self.new
+      end
+
+      def process(source_map, ns)
+        if source_map.filename.include?('app/models')
+          process_model(source_map.source, ns)
+        else
+          []
+        end
+      end
+
+      private
+
+      def process_model(source, ns)
+        walker = Walker.from_source(source)
+        pins = []
+
+        walker.on :send, [nil, :devise] do |ast|
+          modules =
+            ast.children[2..-1]
+              .map { |c| c.children.first }
+              .select { |s| s.is_a?(Symbol) }
+
+          modules.each do |mod|
+            pins <<
+              Util.build_module_include(
+                ns,
+                "Devise::Models::#{mod.to_s.capitalize}",
+                Util.build_location(ast, ns.filename)
+              )
+          end
+        end
+
+        walker.walk
+        if pins.any?
+          Solargraph.logger.debug(
+            "[Rails][Devise] added #{pins.map(&:name)} to #{ns.path}"
+          )
+        end
+        pins
+      end
+    end
+  end
+end

data/lib/solargraph/rails/model.rb

@@ -0,0 +1,100 @@
+module Solargraph
+  module Rails
+    class Model
+      def self.instance
+        @instance ||= self.new
+      end
+
+      def process(source_map, ns)
+        return [] unless source_map.filename.include?('app/models')
+
+        walker = Walker.from_source(source_map.source)
+        pins = []
+
+        walker.on :send, [nil, :belongs_to] do |ast|
+          pins << singular_association(ns, ast)
+        end
+
+        walker.on :send, [nil, :has_one] do |ast|
+          pins << singular_association(ns, ast)
+        end
+
+        walker.on :send, [nil, :has_many] do |ast|
+          pins << plural_association(ns, ast)
+        end
+
+        walker.on :send, [nil, :has_and_belongs_to_many] do |ast|
+          pins << plural_association(ns, ast)
+        end
+
+        walker.on :send, [nil, :scope] do |ast|
+          name = ast.children[2].children.last
+
+          method_pin =
+            Util.build_public_method(
+              ns,
+              name.to_s,
+              types: ns.return_type.map(&:tag),
+              scope: :class,
+              location: Util.build_location(ast, ns.filename)
+            )
+
+          if ast.children.last.type == :block
+            location = ast.children.last.location
+            block_pin =
+              source_map.locate_block_pin(location.line, location.column)
+            method_pin.parameters.concat(block_pin.parameters.clone)
+          end
+          pins << method_pin
+        end
+
+        walker.walk
+        if pins.any?
+          Solargraph.logger.debug(
+            "[Rails][Model] added #{pins.map(&:name)} to #{ns.path}"
+          )
+        end
+        pins
+      end
+
+      def plural_association(ns, ast)
+        relation_name = ast.children[2].children.first
+        class_name =
+          extract_custom_class_name(ast) ||
+            relation_name.to_s.singularize.camelize
+
+        Util.build_public_method(
+          ns,
+          relation_name.to_s,
+          types: ["ActiveRecord::Associations::CollectionProxy<#{class_name}>"],
+          location: Util.build_location(ast, ns.filename)
+        )
+      end
+
+      def singular_association(ns, ast)
+        relation_name = ast.children[2].children.first
+        class_name =
+          extract_custom_class_name(ast) || relation_name.to_s.camelize
+
+        Util.build_public_method(
+          ns,
+          relation_name.to_s,
+          types: [class_name],
+          location: Util.build_location(ast, ns.filename)
+        )
+      end
+
+      def extract_custom_class_name(ast)
+        options = ast.children[3..-1].find { |n| n.type == :hash }
+        return unless options
+
+        class_name_pair =
+          options.children.find do |n|
+            n.children[0].deconstruct == %i[sym class_name] &&
+              n.children[1].type == :str
+          end
+        class_name_pair && class_name_pair.children.last.children.last
+      end
+    end
+  end
+end