solargraph-rails 0.2.0 → 0.2.2.pre.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df10b3b2f00a486c79433fbb7038ffbee966d3420022b3789a5fd00965769524
-  data.tar.gz: b1fb1d828e84a1f74d0f4ab644050fef127e3a019be3f5ef3592d0cb9893b0ac
+  metadata.gz: 7b1512086d26a2b7a883013b14d919163ea9f3155b67f6cf87ad956c46319857
+  data.tar.gz: f88b8cd47da267a95cb418d339e37ad0e25b975e5952eb19d7b6fb9c1d353d42
 SHA512:
-  metadata.gz: 31be19170418090a2f09e207b9c7a3c421ce74c17138730ce1670bddefbeffdbe0775158598aefd1630346a43beba6d5f4128705a236cf89765845b7b9170976
-  data.tar.gz: 2bfd1f0f082d1f52686ec6342ffc30fe84f374a5fe52dc5e8cad3a5995b28e7f0a9f99bf854a06b92e8926cbd5a4d3f3f5adbe498e95f726f49ee28fe74ac63d
+  metadata.gz: c09211c20651d6011f50b1aa6bc3b0c1ab961e868d9bfebdf25eb1c4ac2d0972c2735cddc5bbba8294726e8e63a4b3ad1c4c79db0b9c8d5d7be4aeb0c2dd5caf
+  data.tar.gz: 3be48e28a9eba627f15ff1543d933673f89abcf7b2ac268f1f69ab8414a21dac0cc5e6ae1b518148f165849cec1a0b224d8fa52b1dc94e50585be044ca282a32

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# solargraph-rails changelog
+
+## Changes
+
+### v0.2.2.pre.4
+* Loosen the dependency requirements
+
+### v0.2.2.pre.3
+* Update to solargraph 0.42.3
+* Determine return type of association using class_name argument
+
+### v0.2.2.pre.2
+
+* 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.lock

@@ -1,28 +1,39 @@
 PATH
   remote: .
   specs:
-    solargraph-rails (0.2.0.pre)
-      solargraph (~> 0.40.0)
+    solargraph-rails (0.2.2.pre.4)
+      activesupport
+      solargraph (>= 0.41.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.4)
+      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.1.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.1)
-    nokogiri (1.11.6)
+    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)
@@ -48,22 +59,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    rubocop (1.15.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.5.0, < 2.0)
+      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.40.4)
-      backport (~> 1.1)
+    solargraph (0.42.3)
+      backport (~> 1.2)
       benchmark
       bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
       e2mmap
       jaro_winkler (~> 1.5)
       kramdown (~> 2.3)
@@ -76,8 +88,11 @@ GEM
       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

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. You won't be able to use it if you're not willing to install a gem using `--pre`. 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.
@@ -63,13 +65,15 @@ This project is being used to write production code by the maintainer, but it is
 
 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 --pre`
+`gem install solargraph-rails`
 
 ####  Alternative: using bundler
-If you do want to use bundler, add `gem 'solargraph-rails', '0.2.0.pre'`
+If you do want to use bundler, add `gem 'solargraph-rails', '~> 0.2.0'`
 
 ### 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

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'
+    VERSION = '0.2.2.pre.4'
   end
 end

data/solargraph-rails.gemspec

@@ -25,5 +25,6 @@ Gem::Specification.new do |spec|
   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.41.1"
+  spec.add_runtime_dependency "activesupport"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2.pre.4
 platform: ruby
 authors:
 - Fritz Meissner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,30 @@ dependencies:
   name: solargraph
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.41.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.41.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Add reflection on ActiveModel dynamic attributes that will be created
   at runtime
 email:
@@ -77,18 +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
@@ -108,9 +128,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.3
 signing_key: