solargraph-rails 1.0.0.pre.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 134394397585a1df968b364e98d20b8e38a2fb6294833bfe8bbcfb81b13c545f
-  data.tar.gz: cb4e7fe2906a0769c95e8a3e7de08b6d0188b4dd8d509db2e001006e9367e6db
+  metadata.gz: 674da2b5a3f833920c2c92893cfa936cb430e23e0bae6a7712b91cebe4b2815f
+  data.tar.gz: e7950faaeacc82868a4d91ceba186fc31aa78a6fe5e257969e9907ceb2b54656
 SHA512:
-  metadata.gz: c7acc8b51be9a665bcca385a67bcee5eed0ffd9e697c155bfab4e5e94dcd691cb4ccab4f04c09306166c99e9802e3276e9895374540d3df7b3c979c59be582d4
-  data.tar.gz: 4de5589904080422ed72fec8d76e4679a53df812f551c7e99d5d0e6fc7a6cabefe5256a6403dab04ae96e0fd79ec85c92f7a171502202afdb7403e30b266ee04
+  metadata.gz: e3d254a4d99b5a85eb4f588d89014dc0bd349af5f702e3c42f011c5bc3dac6ad27901f3ab4267d04f277e011fe7124d20223e2864be241e48d7d50c932c82e9a
+  data.tar.gz: 21f12ce2c310c873f4b1d7539c30be580a57437f1411553bbad073e174cc29dea8ec85f761e569cb546e0719c5dbe51477cb5efce25f2f0834e92c0b6b5570ec

data/.github/workflows/ruby.yml

@@ -10,7 +10,7 @@ name: Ruby
 on:
   workflow_dispatch: {}
   pull_request:
-    branches: [master]
+    branches: [main]
 
 jobs:
   test:
@@ -32,5 +32,7 @@ jobs:
         run: (cd spec/rails5; bundle install; yard gems)
       - name: Install Rails 6 deps
         run: (cd spec/rails6; bundle install; yard gems)
+      - name: Install Rails 7 deps
+        run: (cd spec/rails7; bundle install; yard gems)
       - name: Run tests
         run: bundle exec rspec

data/.gitignore

@@ -11,6 +11,8 @@ spec/rails5/log/
 spec/rails5/tmp/
 spec/rails6/log/
 spec/rails6/tmp/
+spec/rails7/log/
+spec/rails7/tmp/
 .projections.json
 .byebug_history
 

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 ## Changes
 
+### v1.0.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
+
 ### v1.0.0.pre.1
 
 https://github.com/alisnic/solargraph-arc was merged, with the following features:

data/DEVELOPMENT.md

@@ -19,8 +19,16 @@
     $ bundle install && yard gems
     $ cd ../../
     ```
-4. now tests should pass locally and you can try different changes
-5. sumbit PR
+
+4. install dummy rails7 app deps and build its yard cache
+
+    ```
+    $ cd spec/rails7
+    $ bundle install && yard gems
+    $ cd ../../
+    ```
+5. now tests should pass locally and you can try different changes
+6. sumbit PR
 
 ## Completion coverage tracking
 
@@ -74,10 +82,10 @@ In case of option 2, don't forget to remove the flag after yml file has been upd
 
 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:
+All you have to do is execute the script and pass it a path to rails app:
 
 ```
-ruby path/to/generate_definitions.rb
+ruby script/generate_definitions.rb spec/rails6
 ```
 
 Make sure to review the script and uncomment relevant parts

data/README.md

@@ -1,8 +1,5 @@
 # Solargraph::Rails - Help solargraph with Rails
 
-## Work in progress - here be dragons
-There are significant rough edges to this gem still.
-
 ## Models
 Given a typical Rails model like this:
 
@@ -27,50 +24,33 @@ class MyBook < ApplicationRecord
 end
 ```
 
-The various Ruby intellisense tools are ok at knowing that there is a `MyBook` constant, and some (including Solargraph) are even aware that objects like `MyBook.new` have a method `.my_method`. But what about those magical dynamic attributes that ActiveRecord creates when Rails starts up? You can see these listed at the top of the file under `# == Schema Information`, the comments helpfully added by the Annotate gem.
+The various Ruby intellisense tools are ok at knowing that there is a `MyBook` constant, and some (including Solargraph) are aware that objects like `MyBook.new` have a method `.my_method`. But what about those magical dynamic attributes that ActiveRecord creates when Rails starts up? You can see these listed at the top of the file under `# == Schema Information`, the comments helpfully added by the Annotate gem.
 
 Since these attributes are only created at runtime, static analysis alone can't identify them. Your editor has no idea that these attributes exist, but they're amongst the most common things that you will work with in any Rails app.
 
-That's where this plugin for Solargraph comes in: it parses the schema comments left by Annotate and uses those to give Solargraph some extra hints.
-
-With this you get autocompletion on ActiveRecord attributes:
-
- ![Autocompletion of dynamic attributes like created_at](assets/solar_rails_autocomplete.gif)
- 
-... and go to definition commands take you to the schema comment for that column:
-
+That's where this plugin for Solargraph comes in: it parses the database schema and YARD docs of various gems to give Solargraph some extra hints. For instance database attributes:
 
- ![Go to definition of dynamic attributes like created_at](assets/solar_rails_goto.gif)
+ ![Go to attribute schema definition](assets/sg_rails_1_0_go_to_attribute_definition.gif)
 
-... and peek commands show you documentation about the attribute:
+ ... or ActiveRecord finders:
 
- ![Peek at documentation of attributes like created_at, author, etc.](assets/peek.png)
+ ![ActiveRecord method support](assets/sg_rails_1_0_activerecord_support.gif)
 
-### Reload workspace after migrations
-Solargraph won't know about attributes that you add during a session. Restart your LSP workspace to get the new attributes.
+ ... or associations:
 
-For my setup with Emacs, that means running `M-x lsp-workspace-restart`, YMMV in other editors.
+ ![Association support](assets/sg_rails_1_0_association_completion.gif)
 
-## Associations (experimental)
-There is simplistic support for `belongs_to` and `has_many` macros:
+ ... or routes file:
 
- ![Experimental autocomplete and go to definition of associations](assets/solar_rails_associations.gif)
+ ![Routes file support](assets/sg_rails_1_0_routes_support.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.
+and more!
 
 ## Installation
 
-###  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`.
+###  Install `solargraph` and `solargraph-rails`
 
-`gem install solargraph-rails`
-
-####  Alternative: using bundler
-If you do want to use bundler, add `gem 'solargraph-rails'`
+If you add them to your Gemfile, you'll have to tell your IDE plugin to use bundler to load the right version of solargraph.
 
 ### Add `solargraph-rails` to your `.solargraph.yml`
 
@@ -81,28 +61,29 @@ plugins:
   - solargraph-rails
 ```
 
-### Add annotate
-Add schema comments your model files using [Annotate](https://github.com/ctran/annotate_models/). At the moment Solargraph::Rails assumes your schema comments are at the top of the source file.
-
-## Development
+### Build YARD docs
+In the project root, run `yard gems`.
 
-Fork the project, start hacking, put up a PR :).
-
-When you make changes, you probably need to shut down solargraph and restart it (maybe that requires you to shut down your whole editor?). You can speed up the feedback loop by running
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/iftheshoefritz/solargraph_rails.
 
-`api_map = Solargraph::ApiMap.load(Rails.root.to_s)`
+1. create fork and clone the repo
 
-in the console of the Rails project where solargraph-rails is installed. This may require restarting the rails console each time, and possibly killing Spring.
+2. install gem deps `bundle install`
 
-Once you have an instance of `Solargraph::ApiMap`, you can interrogate it with Solargraph code like:
+3. install dummy rails app deps and build the yard cache:
 
-`pins = api_map.get_methods('MyBook')`
+```
+$ cd spec/rails5
+$ bundle install && yard gems
+$ cd ../../
+```
 
-More examples here: https://solargraph.org/guides/code-examples
+(and the same for rails 6 and rails 7)
 
-## Contributing
+4. now tests should pass locally and you can try different changes
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/iftheshoefritz/solargraph_rails.
+5. sumbit PR
 
 ## License
 

data/lib/solargraph/rails/annotate.rb

@@ -15,7 +15,7 @@ module Solargraph
 
       def process(source_map, ns)
         return [] if @schema_present
-        return [] unless source_map.filename.include?('app/models')
+        return [] unless Model.valid_filename?(source_map.filename)
 
         pins = []
         walker = Walker.from_source(source_map.source)

data/lib/solargraph/rails/devise.rb

@@ -6,7 +6,7 @@ module Solargraph
       end
 
       def process(source_map, ns)
-        if source_map.filename.include?('app/models')
+        if Model.valid_filename?(source_map.filename)
           process_model(source_map.source, ns)
         else
           []

data/lib/solargraph/rails/model.rb

@@ -5,8 +5,12 @@ module Solargraph
         @instance ||= self.new
       end
 
+      def self.valid_filename?(filename)
+        filename.include?('app/models')
+      end
+
       def process(source_map, ns)
-        return [] unless source_map.filename.include?('app/models')
+        return [] unless self.class.valid_filename?(source_map.filename)
 
         walker = Walker.from_source(source_map.source)
         pins = []
@@ -28,6 +32,7 @@ module Solargraph
         end
 
         walker.on :send, [nil, :scope] do |ast|
+          next if ast.children[2].nil?
           name = ast.children[2].children.last
 
           method_pin =

data/lib/solargraph/rails/schema.rb

@@ -16,7 +16,10 @@ module Solargraph
         json: 'Hash',
         bigint: 'Integer',
         uuid: 'String',
-        inet: 'IPAddr'
+        inet: 'IPAddr',
+        citext: 'String',
+        binary: 'String',
+        timestamp: 'ActiveSupport::TimeWithZone'
       }
 
       def self.instance
@@ -33,10 +36,9 @@ module Solargraph
 
       def process(source_map, ns)
         return [] unless @schema_present
-        return [] unless source_map.filename.include?('app/models')
+        return [] unless Model.valid_filename?(source_map.filename)
 
-        table_name = infer_table_name(ns)
-        table = schema[table_name]
+        table = find_table(source_map, ns)
 
         return [] unless table
 
@@ -68,10 +70,27 @@ module Solargraph
           end
       end
 
-      # TODO: support custom table names, by parsing `self.table_name = ` invokations
-      # inside model
-      def infer_table_name(ns)
-        ns.name.underscore.pluralize
+      def find_table(source_map, ns)
+        table_name = nil
+        walker = Walker.from_source(source_map.source)
+        walker.on :send, [:self, :table_name=, :str] do |ast|
+          table_name = ast.children.last.children.first
+        end
+        walker.walk
+
+        # always use explicit table name if present
+        return schema[table_name] if table_name
+
+        infer_table_names(ns).filter_map { |table_name| schema[table_name] }.first
+      end
+
+      def infer_table_names(ns)
+        table_name = ns.name.tableize
+        if ns.namespace.present?
+          [ns.path.tableize.tr('/', '_'), table_name]
+        else
+          [table_name]
+        end
       end
 
       def extract_schema(ast)

data/lib/solargraph/rails/storage.rb

@@ -6,7 +6,7 @@ module Solargraph
       end
 
       def process(source_map, ns)
-        return [] unless source_map.filename.include?('app/models')
+        return [] unless Model.valid_filename?(source_map.filename)
 
         walker = Walker.from_source(source_map.source)
         pins = []

data/lib/solargraph/rails/version.rb

@@ -1,5 +1,5 @@
 module Solargraph
   module Rails
-    VERSION = '1.0.0.pre.1'
+    VERSION = '1.0.1'
   end
 end

data/lib/solargraph/rails/walker.rb

@@ -2,12 +2,51 @@ module Solargraph
   module Rails
     class Walker
       class Hook
-        attr_reader :args, :proc, :node_type
+        attr_reader :node_type
         def initialize(node_type, args, &block)
           @node_type = node_type
           @args = args
           @proc = Proc.new(&block)
         end
+
+        def visit(node)
+          return unless matches?(node)
+
+          if @proc.arity == 1
+            @proc.call(node)
+          elsif @proc.arity == 2
+            walker = Walker.new(node)
+            @proc.call(node, walker)
+            walker.walk
+          end
+        end
+
+        private
+
+        def matches?(node)
+          return unless node.type == node_type
+          return unless node.children
+          return true if @args.empty?
+
+          a_child_matches = node.children.first.is_a?(::Parser::AST::Node) && node.children.any? do |child|
+            child.is_a?(::Parser::AST::Node) &&
+              match_children(child.children, @args[1..-1])
+          end
+
+          return true if a_child_matches
+
+          match_children(node.children)
+        end
+
+        def match_children(children, args = @args)
+          args.each_with_index.all? do |arg, i|
+            if children[i].is_a?(::Parser::AST::Node)
+              children[i].type == arg
+            else
+              children[i] == arg
+            end
+          end
+        end
       end
 
       # https://github.com/castwide/solargraph/issues/522
@@ -45,45 +84,10 @@ module Solargraph
       def traverse(node)
         return unless node.is_a?(::Parser::AST::Node)
 
-        @hooks[node.type].each { |hook| try_match(node, hook) }
+        @hooks[node.type].each { |hook| hook.visit(node) }
 
         node.children.each { |child| traverse(child) }
       end
-
-      def try_match(node, hook)
-        return unless node.type == hook.node_type
-        return unless node.children
-
-        matched =
-          hook.args.empty? || if node.children.first.is_a?(::Parser::AST::Node)
-            node.children.any? do |child|
-              child.is_a?(::Parser::AST::Node) &&
-                match_children(hook.args[1..-1], child.children)
-            end
-          else
-            match_children(hook.args, node.children)
-          end
-
-        if matched
-          if hook.proc.arity == 1
-            hook.proc.call(node)
-          elsif hook.proc.arity == 2
-            walker = Walker.new(node)
-            hook.proc.call(node, walker)
-            walker.walk
-          end
-        end
-      end
-
-      def match_children(args, children)
-        args.each_with_index.all? do |arg, i|
-          if children[i].is_a?(::Parser::AST::Node)
-            children[i].type == arg
-          else
-            children[i] == arg
-          end
-        end
-      end
     end
   end
 end

data/script/generate_definitions.rb

@@ -106,29 +106,36 @@ Rails.application.routes.draw do
   File.write('routes.yml', report.deep_stringify_keys.to_yaml)
 end
 
-# [Array, String, Time, Date, Class, DateTime, File, Hash, Integer, Kernel].each do |klass|
-#   test = case klass
-#   when Time
-#     Time.now
-#   when Date
-#     Date.today
-#   when File
-#     false
-#   else
-#     klass.new rescue false
-#   end
-#
-#   report = core_ext_report(klass, test=test)
-#   File.write("#{klass.to_s}.yml", report.deep_stringify_keys.to_yaml)
-# end
-
-# binding.pry
+[
+  Array,
+  String,
+  Time,
+  Date,
+  Class,
+  DateTime,
+  File,
+  Hash,
+  Integer,
+  Kernel
+].each do |klass|
+  test =
+    case klass
+    when Time
+      Time.now
+    when Date
+      Date.today
+    when File
+      false
+    else
+      begin
+        klass.new
+      rescue StandardError
+        false
+      end
+    end
 
-# File.write("activerecord.yml", result.deep_stringify_keys.to_yaml)
+  report = core_ext_report(klass, test = test)
+  File.write("#{klass.to_s}.yml", report.deep_stringify_keys.to_yaml)
+end
 
-# report = build_report(
-#   ActionController::Base,
-#   own_class_methods(ActionController::Base),
-#   own_instance_methods(ActionController::Base)
-# )
-# File.write("actioncontroller.yml", report.deep_stringify_keys.to_yaml)
+# binding.pry

data/solargraph-rails.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.files =
     `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(test|spec|features)/})
+      f.match(%r{^(assets|test|spec|features)/})
     end
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Fritz Meissner
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2022-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,10 +100,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- assets/peek.png
-- assets/solar_rails_associations.gif
-- assets/solar_rails_autocomplete.gif
-- assets/solar_rails_goto.gif
 - bin/console
 - bin/setup
 - lib/solargraph-rails.rb
@@ -127,7 +123,7 @@ homepage: https://github.com/iftheshoefritz/solargraph-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -138,12 +134,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.3.11
+signing_key: 
 specification_version: 4
 summary: Solargraph plugin that adds Rails-specific code through a Convention
 test_files: []