solargraph-rails 0.2.0.pre → 0.2.2.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10a5f0ba2496f8b79f4e008ae3ca68f4cb193c31fdbdf95d18b65fc3850e703e
-  data.tar.gz: e21cff4b322b4b8547b9b06709f30fbd883108983570dfb3d44c50e83f335ecf
+  metadata.gz: f2ceb38938b95c2d2772c9b863053613a30f91fb6bfdcf3a8373de01b8c95484
+  data.tar.gz: f385b1fd2a0839ba5f8fd9c5476b068c56ddcac510382cd453c3524ce6f50d82
 SHA512:
-  metadata.gz: 6be898e5f949bb5e683dd5057bd85ae88ebdf19a8d5662b3d107c444ec54b24c71f6026c0877bcf0e1c59e6f7aa2ae21713c6067e0f1c9d2f8f3bb93e60813b6
-  data.tar.gz: a26cbfc730799c6308773ee01a900356227d624d3b0090992ae21a915f01f42964fba3a53ba6fd29ee19c49bad4ef4f45a81592de999b3f48cd82c23519df954
+  metadata.gz: 11d1095b3e45568950dff2ed39272e282507f093e9021143b0108242b01d4ccd568ec3932f9fdb68f2b7aeea6c95f359fbdb464630238c01e7a92fbcf434fa1e
+  data.tar.gz: 420248dfa30f8da3e279a0e0f77fd48f6e1057ddaa5ab97aeaef96e76aa738cdb64ddb7ef3974594f4edf7cacce912820e0ec260286826808928527f73ab06be

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# solargraph-rails changelog
+
+## Changes
+
+### v0.2.2.pre
+
+* Simplistic support for associations
+* Added dependency on ActiveSupport 6.1 for helpful String methods like `.camelize` and `.singularize`
+
+### v0.2.1
+
+* Update Solargraph to 0.41
+
+### v0.2.0
+First released version with no need to use --pre!
+
+* Updated dependencies with security warnings

data/Gemfile

@@ -4,6 +4,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 group :development, :test do
   gem 'byebug'
+  gem 'bundler-audit'
 end
 # Specify your gem's dependencies in solargraph_rails.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    solargraph-rails (0.2.2.pre.3)
+      activesupport (~> 6.1.3)
+      solargraph (~> 0.42.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.2)
+      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.1.1)
+    bundler-audit (0.8.0)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    e2mmap (0.1.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    mini_portile2 (2.5.3)
+    minitest (5.14.4)
+    nokogiri (1.11.7)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    reverse_markdown (2.0.0)
+      nokogiri
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.17.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.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    solargraph (0.42.3)
+      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.0.0)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.2.10)
+  bundler-audit
+  byebug
+  rake (~> 12.3.3)
+  rspec (~> 3.0)
+  solargraph-rails!
+
+BUNDLED WITH
+   2.2.16

data/README.md

@@ -1,7 +1,7 @@
 # Solargraph::Rails - Help solargraph with Rails
 
 ## Work in progress - here be dragons
-There are significant rough edges to this gem still. Don't use it if you're not willing to do things like build gems from source and install them locally. See `Installation` below for more info.
+There are significant rough edges to this gem still.
 
 ## Models
 Given a typical Rails model like this:
@@ -51,8 +51,10 @@ 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
-This is coming soon.
+## 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`:
+
+ ![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.
@@ -61,26 +63,20 @@ This project is being used to write production code by the maintainer, but it is
 
 ###  Install `solargraph` v0.40+ and `solargraph_rails` locally
 
-SG v0.40 and solargraph_rails are unreleased at time of writing. You'll need to install both locally:
-
-1. Clone solargraph and update version.rb to 0.40.0
-2. Run `gem build` in the root of your clone to create `solargraph-0.40.0.gem`
-3. Clone solargraph_rails 
-4. Run `gem build` in the root of your clone to create `solargraph_rails-0.1.1.gem`
-5. From the root of your Rails app, install solargraph locally: `gem install --local /path/to/solargraph-0.40.0.gem`
-6. From the root of your Rails app, install solargraph_rails locally: `gem install --local /path/to/solargraph_rails-0.1.1.gem`
+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 gems outside of bundler
-This is the path described above. 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", path: "/path/to/my_solargraph"` and `gem "solargraph_rails", path: "/path/to/my_solargraph_rails"` instead of steps 5 & 6 above.
+If you do want to use bundler, add `gem 'solargraph-rails', '~> 0.2.0'`
+
+### Add `solargraph-rails` to your `.solargraph.yml`
 
-### Add `solargraph_rails` to your `.solargraph.yml`
+(if you don't have a `.solargraph.yml` in your project root, you can run `solargraph config` to add one)
 
 ```
 plugins:
-  - solargraph_rails
+  - solargraph-rails
 ```
 
 ### Add annotate
@@ -92,9 +88,9 @@ 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
 
-`api_map = Solargraph::ApiMap.load(Rails.root)`
+`api_map = Solargraph::ApiMap.load(Rails.root.to_s)`
 
-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.
+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.
 
 Once you have an instance of `Solargraph::ApiMap`, you can interrogate it with Solargraph code like:
 

data/lib/solargraph-rails.rb

@@ -5,6 +5,10 @@ require 'solargraph/rails/version'
 require_relative 'solargraph/rails/pin_creator'
 require_relative 'solargraph/rails/ruby_parser'
 require_relative 'solargraph/rails/files_loader'
+require_relative 'solargraph/rails/meta_source/association/belongs_to_matcher'
+require_relative 'solargraph/rails/meta_source/association/has_many_matcher'
+require_relative 'solargraph/rails/meta_source/association/has_one_matcher'
+require_relative 'solargraph/rails/meta_source/association/has_and_belongs_to_many_matcher'
 
 module Solargraph
   module Rails

data/lib/solargraph/rails/meta_source/association/belongs_to_matcher.rb

@@ -0,0 +1,24 @@
+module MetaSource
+  module Association
+    class BelongsToMatcher
+      attr_reader :name
+
+      def match?(line)
+        line =~ /belongs_to\s+:([a-z_]*)/
+        @name = Regexp.last_match(1)
+
+        return unless @name
+
+        return @name unless line =~ /class_name:\s+["']([A-Za-z0-9]+)/
+
+        @type = Regexp.last_match(1)
+
+        @name
+      end
+
+      def type
+        @type || name&.camelize
+      end
+    end
+  end
+end

data/lib/solargraph/rails/meta_source/association/has_and_belongs_to_many_matcher.rb

@@ -0,0 +1,24 @@
+module MetaSource
+  module Association
+    class HasAndBelongsToManyMatcher
+      attr_reader :name
+
+      def match?(line)
+        line =~ /has_and_belongs_to_many\s+:([a-z_]*)/
+        @name = Regexp.last_match(1)
+
+        return unless @name
+
+        if line =~ /class_name:\s+["']([A-Za-z0-9]+)/
+          @type = Regexp.last_match(1)
+        end
+
+        @name
+      end
+
+      def type
+        "ActiveRecord::Associations::CollectionProxy<#{@type || name.singularize.camelize}>"
+      end
+    end
+  end
+end

data/lib/solargraph/rails/meta_source/association/has_many_matcher.rb

@@ -0,0 +1,24 @@
+module MetaSource
+  module Association
+    class HasManyMatcher
+      attr_reader :name
+
+      def match?(line)
+        line =~ /has_many\s+:([a-z_]*)/
+        @name = Regexp.last_match(1)
+
+        return unless @name
+
+        if line =~ /class_name:\s+["']([A-Za-z0-9]+)/
+          @type = Regexp.last_match(1)
+        end
+
+        @name
+      end
+
+      def type
+        "ActiveRecord::Associations::CollectionProxy<#{@type || name.singularize.camelize}>"
+      end
+    end
+  end
+end

data/lib/solargraph/rails/meta_source/association/has_one_matcher.rb

@@ -0,0 +1,24 @@
+module MetaSource
+  module Association
+    class HasOneMatcher
+      attr_reader :name
+
+      def match?(line)
+        line =~ /has_one\s+:([a-z_]*)/
+        @name = Regexp.last_match(1)
+
+        return unless @name
+
+        if line =~ /class_name:\s+["']([A-Za-z0-9]+)/
+          @type = Regexp.last_match(1)
+        end
+
+        @name
+      end
+
+      def type
+        @type || name.camelize
+      end
+    end
+  end
+end

data/lib/solargraph/rails/pin_creator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/string'
+
 module Solargraph
   module Rails
     class PinCreator
@@ -50,13 +52,32 @@ module Solargraph
           end
         end
 
+        parser.on_ruby_line do |line|
+          matcher = ruby_matchers.find do |m|
+            m.match?(line)
+          end
+
+          if matcher
+            loc = Solargraph::Location.new(
+              path,
+              Solargraph::Range.from_to(
+                parser.current_line_number,
+                0,
+                parser.current_line_number,
+                parser.current_line_length - 1
+              )
+            )
+            model_attrs << { name: matcher.name, type: matcher.type, location: loc }
+          end
+        end
+
         parser.parse
 
         Solargraph::Logging.logger.info "Adding #{model_attrs.count} attributes as pins"
         model_attrs.map do |attr|
           Solargraph::Pin::Method.new(
             name: attr[:name],
-            comments: "@return [#{type_translation[attr[:type]]}]",
+            comments: "@return [#{type_translation.fetch(attr[:type], attr[:type])}]",
             location: attr[:location],
             closure: Solargraph::Pin::Namespace.new(name: module_names.join('::') + "::#{model_name}"),
             scope: :instance,
@@ -65,6 +86,14 @@ module Solargraph
         end
       end
 
+      def ruby_matchers
+        [
+          MetaSource::Association::BelongsToMatcher.new,
+          MetaSource::Association::HasManyMatcher.new,
+          MetaSource::Association::HasOneMatcher.new,
+          MetaSource::Association::HasAndBelongsToManyMatcher.new
+        ]
+      end
       def col_with_type(line)
         line
           .gsub(/[\(\),:\d]/, '')

data/lib/solargraph/rails/ruby_parser.rb

@@ -6,6 +6,7 @@ module Solargraph
       def initialize(file_contents: '')
         @lines = file_contents.lines
         @comment_handlers = []
+        @non_comment_handlers = []
         @class_handlers = []
         @module_handlers = []
       end
@@ -22,6 +23,10 @@ module Solargraph
         @module_handlers << blk
       end
 
+      def on_ruby_line(&blk)
+        @non_comment_handlers << blk
+      end
+
       def parse
         @lines
           .map(&:rstrip)
@@ -32,6 +37,8 @@ module Solargraph
           if is_comment?(line)
             comment_content = line.gsub(/#\s*/, '')
             @comment_handlers.each { |handler| handler.call(comment_content) }
+          else
+            @non_comment_handlers.each { |handler| handler.call(line) }
           end
 
           if is_class?(line)

data/lib/solargraph/rails/version.rb

@@ -1,5 +1,5 @@
 module Solargraph
   module Rails
-    VERSION = '0.2.0.pre'
+    VERSION = '0.2.2.pre.3'
   end
 end

data/solargraph-rails.gemspec

@@ -21,9 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "bundler", "~> 2.2.10"
   spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 
-  spec.add_runtime_dependency "solargraph", "~> 0.40.0"
+  spec.add_runtime_dependency "solargraph", "~> 0.42.1"
+  spec.add_runtime_dependency "activesupport", "~> 6.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre
+  version: 0.2.2.pre.3
 platform: ruby
 authors:
 - Fritz Meissner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-09 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.42.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.42.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
 description: Add reflection on ActiveModel dynamic attributes that will be created
   at runtime
 email:
@@ -77,17 +91,24 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - 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
 - lib/solargraph/rails/files_loader.rb
+- lib/solargraph/rails/meta_source/association/belongs_to_matcher.rb
+- lib/solargraph/rails/meta_source/association/has_and_belongs_to_many_matcher.rb
+- lib/solargraph/rails/meta_source/association/has_many_matcher.rb
+- lib/solargraph/rails/meta_source/association/has_one_matcher.rb
 - lib/solargraph/rails/pin_creator.rb
 - lib/solargraph/rails/ruby_parser.rb
 - lib/solargraph/rails/version.rb
@@ -111,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Solargraph plugin that adds Rails-specific code through a Convention