rails-annotate-solargraph 0.5.3 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f47a9a65cb37174ca12847169325afbecef1182e7d34bf555accf5551fbb7f1c
-  data.tar.gz: 97d1aae264b49adc45222847f6d2f25278abacec90134226cc7c023e205df6d5
+  metadata.gz: 58575ab157cd56c94cd086172ab769ca710e29bd15a72403a0fd0829357bab11
+  data.tar.gz: 896fdff02aa40756ecc427ef542225080581cc10f039e7a960371c22174e7891
 SHA512:
-  metadata.gz: fa14e6c6068da07e1a4df3c2e41c021882ee65178fe124f2a729001964624900aa0578173870fac7bfac26bb474e530261a561a9082e267dfc8d4a48c3a3adc8
-  data.tar.gz: 84a6120026334a68f175c8fba73ddee4720d9d6913b52ef36cfc797409543a444419000d3a687843ee57cd1ad264523f761b2988984a74137079b67f413bb396
+  metadata.gz: d2bebaf3939fd7958b8e64fbe0cf27a397734093dda12143d5ee5fce28efc66cb199260b4e6e2f907e135f62be418df4952ec188478e1f1a6683fedcdd7527e1
+  data.tar.gz: 74a3f24690f3871be28af866deb5913e664ef71d8ae194e88d1f4883c09415dfa81430267fa8db42bd71b48709ee7229edf6315a00029d32c8bdbb4ee0f36720

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 Style/StringLiterals:
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.7.6
+3.0.6

data/.vscode/settings.json

@@ -6,8 +6,11 @@
     "gsub",
     "inet",
     "klass",
+    "lstrip",
     "rakefile",
+    "rstrip",
     "solargraph",
+    "stringio",
     "yieldparam"
   ]
 }

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.5.4] - 2022-08-12
+
+- Improve scope documenting
+- Split tests into unit tests and integration tests
+- Remove solargraph from dependencies
+- Improve file update messages
+
 ## [0.5.3] - 2022-04-20
 
 - fix a minor bug which in some rails apps prevented scopes from being documented

data/Gemfile

@@ -6,7 +6,6 @@ source "https://rubygems.org"
 gemspec
 
 gem 'byebug'
-gem 'debug'
 gem 'git'
 gem "minitest", "~> 5.0"
 gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -1,75 +1,75 @@
 PATH
   remote: .
   specs:
-    rails-annotate-solargraph (0.5.3)
+    rails-annotate-solargraph (0.5.5)
+      parser (~> 3)
       rails (>= 5.0, < 8.0)
-      solargraph
       yard
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actioncable (7.0.6)
+      actionpack (= 7.0.6)
+      activesupport (= 7.0.6)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activestorage (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actionmailbox (7.0.6)
+      actionpack (= 7.0.6)
+      activejob (= 7.0.6)
+      activerecord (= 7.0.6)
+      activestorage (= 7.0.6)
+      activesupport (= 7.0.6)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      actionview (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actionmailer (7.0.6)
+      actionpack (= 7.0.6)
+      actionview (= 7.0.6)
+      activejob (= 7.0.6)
+      activesupport (= 7.0.6)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.2.3)
-      actionview (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-      rack (~> 2.0, >= 2.2.0)
+    actionpack (7.0.6)
+      actionview (= 7.0.6)
+      activesupport (= 7.0.6)
+      rack (~> 2.0, >= 2.2.4)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activestorage (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actiontext (7.0.6)
+      actionpack (= 7.0.6)
+      activerecord (= 7.0.6)
+      activestorage (= 7.0.6)
+      activesupport (= 7.0.6)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actionview (7.0.6)
+      activesupport (= 7.0.6)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.2.3)
-      activesupport (= 7.0.2.3)
+    activejob (7.0.6)
+      activesupport (= 7.0.6)
       globalid (>= 0.3.6)
-    activemodel (7.0.2.3)
-      activesupport (= 7.0.2.3)
-    activerecord (7.0.2.3)
-      activemodel (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-    activestorage (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    activemodel (7.0.6)
+      activesupport (= 7.0.6)
+    activerecord (7.0.6)
+      activemodel (= 7.0.6)
+      activesupport (= 7.0.6)
+    activestorage (7.0.6)
+      actionpack (= 7.0.6)
+      activejob (= 7.0.6)
+      activerecord (= 7.0.6)
+      activesupport (= 7.0.6)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.2.3)
+    activesupport (7.0.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -79,54 +79,46 @@ GEM
     benchmark (0.2.0)
     builder (3.2.4)
     byebug (11.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     crass (1.0.6)
-    debug (1.5.0)
-      irb (>= 1.3.6)
-      reline (>= 0.2.7)
+    date (3.3.3)
     diff-lcs (1.5.0)
-    digest (3.1.0)
     e2mmap (0.1.0)
-    erubi (1.10.0)
+    erubi (1.12.0)
     git (1.10.2)
       rchardet (~> 1.8)
-    globalid (1.0.0)
+    globalid (1.1.0)
       activesupport (>= 5.0)
-    i18n (1.10.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    io-console (0.5.11)
-    irb (1.4.1)
-      reline (>= 0.3.0)
     jaro_winkler (1.5.4)
     kramdown (2.3.2)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    loofah (2.16.0)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
       mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
     mini_portile2 (2.8.0)
     minitest (5.15.0)
-    net-imap (0.2.3)
-      digest
+    net-imap (0.3.6)
+      date
       net-protocol
-      strscan
-    net-pop (0.1.1)
-      digest
+    net-pop (0.1.2)
       net-protocol
+    net-protocol (0.2.1)
       timeout
-    net-protocol (0.1.3)
-      timeout
-    net-smtp (0.3.1)
-      digest
+    net-smtp (0.3.3)
       net-protocol
-      timeout
-    nio4r (2.5.8)
+    nio4r (2.5.9)
     nokogiri (1.13.4)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
@@ -136,31 +128,32 @@ GEM
     parser (3.1.1.0)
       ast (~> 2.4.1)
     racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (7.0.2.3)
-      actioncable (= 7.0.2.3)
-      actionmailbox (= 7.0.2.3)
-      actionmailer (= 7.0.2.3)
-      actionpack (= 7.0.2.3)
-      actiontext (= 7.0.2.3)
-      actionview (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activemodel (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activestorage (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.6)
+      actioncable (= 7.0.6)
+      actionmailbox (= 7.0.6)
+      actionmailer (= 7.0.6)
+      actionpack (= 7.0.6)
+      actiontext (= 7.0.6)
+      actionview (= 7.0.6)
+      activejob (= 7.0.6)
+      activemodel (= 7.0.6)
+      activerecord (= 7.0.6)
+      activestorage (= 7.0.6)
+      activesupport (= 7.0.6)
       bundler (>= 1.15.0)
-      railties (= 7.0.2.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+      railties (= 7.0.6)
+    rails-dom-testing (2.1.1)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.6)
+      actionpack (= 7.0.6)
+      activesupport (= 7.0.6)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
@@ -169,8 +162,6 @@ GEM
     rake (13.0.6)
     rchardet (1.8.0)
     regexp_parser (2.2.1)
-    reline (0.3.1)
-      io-console (~> 0.5)
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
@@ -202,20 +193,19 @@ GEM
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
     sqlite3 (1.4.2)
-    strscan (3.0.1)
     thor (1.2.1)
     tilt (2.0.10)
-    timeout (0.2.0)
-    tzinfo (2.0.4)
+    timeout (0.4.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
     webrick (1.7.0)
-    websocket-driver (0.7.5)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     yard (0.9.27)
       webrick (~> 1.7.0)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.9)
 
 PLATFORMS
   arm64-darwin-20
@@ -223,7 +213,6 @@ PLATFORMS
 
 DEPENDENCIES
   byebug
-  debug
   git
   minitest (~> 5.0)
   rails-annotate-solargraph!

data/README.md

@@ -74,7 +74,7 @@ end
 
 There are a few values for this option:
 
-- `:schema_file` -- default value, annotations get saved to a special file `app/models/annotate_solargraph_schema.rb`
+- `:schema_file` -- default value, annotations get saved to a special file `.annotate_solargraph_schema`
 - `:bottom` -- annotations are appended to the model files
 - `:top` -- annotations are prepended to the model files
 
@@ -90,9 +90,59 @@ $ rake annotate:solargraph:generate
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Setup
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To setup this gem for development you should use the setup script.
+
+```sh
+$ bin/setup
+```
+
+### Console
+
+You can access an IRB with this entire gem preloaded like this
+
+```sh
+$ bin/console
+```
+
+### Tests
+
+You can run all tests with:
+
+```sh
+$ rake test
+```
+
+All unit tests:
+
+```sh
+$ rake test:unit
+```
+
+All integration tests:
+
+```sh
+$ rake test:integration
+```
+
+### Release
+
+To release a new version, update the version number in `version.rb`, and then run
+
+```sh
+$ bundle exec rake release
+```
+
+This will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Local installation
+
+To install this gem onto your local machine, run
+
+```sh
+$ bundle exec rake install
+```
 
 ## Contributing
 

data/Rakefile

@@ -3,10 +3,28 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/rails/**/*_test.rb"]
+::Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.libs << 'test/fixtures'
+  # ignore tests of rails apps
+  t.test_files = ::FileList['test/**/*_test.rb'] - ::FileList['test/dummy/**/*_test.rb']
+end
+
+::Rake::TestTask.new('test:unit') do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.libs << 'test/fixtures'
+  # ignore tests of rails apps
+  t.test_files = ::FileList['test/unit/**/*_test.rb']
+end
+
+::Rake::TestTask.new('test:integration') do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.libs << 'test/fixtures'
+  # ignore tests of rails apps
+  t.test_files = ::FileList['test/integration/**/*_test.rb']
 end
 
 require "rubocop/rake_task"

data/lib/generators/annotate/solargraph/install_generator.rb

@@ -16,7 +16,10 @@ module Annotate
           template ::Rails::Annotate::Solargraph::SCHEMA_FILE_NAME, ::Rails::Annotate::Solargraph::SCHEMA_RAILS_PATH
 
           solargraph_config_file = ::File.join(::Rails.root, ::Rails::Annotate::Solargraph::SOLARGRAPH_FILE_NAME)
-          system 'solargraph config' unless ::File.exist? solargraph_config_file
+          unless ::File.exist? solargraph_config_file
+            template(::Rails::Annotate::Solargraph::SOLARGRAPH_FILE_NAME, ::Rails::Annotate::Solargraph::SOLARGRAPH_FILE_PATH)
+          end
+
           solargraph_config = ::YAML.load_file solargraph_config_file
           solargraph_config['include'] = solargraph_config['include'] || []
           solargraph_config['include'].unshift ::Rails::Annotate::Solargraph::SCHEMA_RAILS_PATH

data/lib/generators/annotate/solargraph/templates/.solargraph.yml

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

data/lib/rails/annotate/overrides.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'parser/current'
+
 class ActiveRecord::Base
   class << self
     alias orig_scope scope
@@ -10,22 +12,28 @@ class ActiveRecord::Base
       scope_name = args.first
       scope_proc = args[1]
       proc_parameters = scope_proc.respond_to?(:parameters) ? scope_proc.parameters.map(&:last) : []
-      scope_line = nil
+      scope_definition = ::String.new
       scope_model_class = self
+      scope_lines = 0
+      scope_indentation = nil
 
       ::File.open(file_path) do |file|
         file.each_line.with_index(1) do |line, current_line_number|
-          next unless current_line_number == scope_line_number
+          next if current_line_number < scope_line_number
+          break if scope_lines > 50
+
+          scope_indentation ||= line.length - line.lstrip.length
+          scope_definition << "#{line.rstrip[scope_indentation..]}\n"
+          scope_lines += 1
 
-          scope_line = line.strip
-          break
+          break if ::Parser::CurrentRuby.new.parse ::Parser::Source::Buffer.new('(string)', source: scope_definition)
         end
       end
 
-      ::Rails::Annotate::Solargraph::Model.add_scope(scope_name.to_sym, scope_model_class, proc_parameters, scope_line)
+      ::Rails::Annotate::Solargraph::Model.add_scope(scope_name.to_sym, scope_model_class, proc_parameters, scope_definition)
 
       orig_scope(*args, **kwargs, &block)
-    rescue
+    rescue ::StandardError
       orig_scope(*args, **kwargs, &block)
     end
   end

data/lib/rails/annotate/solargraph/configuration.rb

@@ -17,8 +17,11 @@ module Rails
 
         # @param val [Symbol]
         def annotation_position=(val)
-          raise Error, "`annotation_position` is incorrect! Got `#{val.inspect}`, expected a member of `#{ANNOTATION_POSITIONS.inspect}`" \
-           unless ANNOTATION_POSITIONS.include?(val)
+          unless ANNOTATION_POSITIONS.include?(val)
+            raise Error,
+                  "`annotation_position` is incorrect! Got `#{val.inspect}`, " \
+                  "expected a member of `#{ANNOTATION_POSITIONS.inspect}`"
+          end
 
           @annotation_position = val
         end

data/lib/rails/annotate/solargraph/model.rb

@@ -8,10 +8,9 @@ module Rails
       class Model
         using TerminalColors::Refinement
 
-        Scope = ::Struct.new(:name, :model_class, :proc_parameters, :definition, keyword_init: true)
-
         # @return [Regexp]
-        MAGIC_COMMENT_REGEXP = /(^#\s*encoding:.*(?:\n|r\n))|(^# coding:.*(?:\n|\r\n))|(^# -\*- coding:.*(?:\n|\r\n))|(^# -\*- encoding\s?:.*(?:\n|\r\n))|(^#\s*frozen_string_literal:.+(?:\n|\r\n))|(^# -\*- frozen_string_literal\s*:.+-\*-(?:\n|\r\n))/.freeze
+        MAGIC_COMMENT_REGEXP =
+          /(^#\s*encoding:.*(?:\n|r\n))|(^# coding:.*(?:\n|\r\n))|(^# -\*- coding:.*(?:\n|\r\n))|(^# -\*- encoding\s?:.*(?:\n|\r\n))|(^#\s*frozen_string_literal:.+(?:\n|\r\n))|(^# -\*- frozen_string_literal\s*:.+-\*-(?:\n|\r\n))/
 
         # @return [Hash{Symbol => String}]
         TYPE_MAP = {
@@ -45,11 +44,17 @@ module Rails
           # @param proc_parameters [Array<Symbol>]
           # @param definition [String]
           def add_scope(name, model_class, proc_parameters, definition)
-            scope = Scope.new(name: name, model_class: model_class, proc_parameters: proc_parameters, definition: definition)
+            scope = Scope.new(
+              name: name,
+              model_class: model_class,
+              proc_parameters: proc_parameters,
+              definition: definition
+            )
+
             @scopes ||= {}
             @scopes[model_class] ||= []
             @scopes[model_class] << scope
-            @scopes[model_class].sort_by! { |scope| scope.name }
+            @scopes[model_class].sort_by!(&:name)
           end
 
           # @param klass [Class]
@@ -82,7 +87,12 @@ module Rails
         # @param klass [Class]
         def initialize(klass)
           @klass = klass
-          @file_name = CONFIG.schema_file? ? SCHEMA_RAILS_PATH : ::File.join(::Rails.root, MODEL_DIR, "#{klass.to_s.underscore}.rb")
+          @file_name =
+            if CONFIG.schema_file?
+              SCHEMA_RAILS_PATH
+            else
+              ::File.join(::Rails.root, MODEL_DIR, "#{klass.to_s.underscore}.rb")
+            end
         end
 
         # @return [String]
@@ -100,10 +110,11 @@ module Rails
           self.class.annotation_regexp(@klass)
         end
 
-        # @param :write [Boolean]
+        # @param write [Boolean]
         # @return [String] New file content.
         def annotate(write: true)
           old_content, file_content = remove_annotation write: false
+          return old_content if @klass.abstract_class
 
           if CONFIG.annotation_position == :top
             magic_comments = file_content.scan(MAGIC_COMMENT_REGEXP).flatten.compact.join
@@ -121,7 +132,7 @@ module Rails
           new_file_content
         end
 
-        # @param :write [Boolean]
+        # @param write [Boolean]
         # @return [Array<String>] Old file content followed by new content.
         def remove_annotation(write: true)
           return ['', ''] unless ::File.exist?(@file_name)
@@ -162,18 +173,16 @@ module Rails
 
         private
 
+        # @return [Array<Scope>]
+        def scopes
+          self.class.scopes[@klass]
+        end
+
         # @param doc_string [String]
         # @return [void]
         def document_scopes(doc_string)
-          self.class.scopes[@klass]&.each do |scope|
-            doc_string << <<~DOC
-              #     # Scope `#{scope.name.inspect}`.
-              #     #
-              #     #     #{scope.definition}
-              #     #
-              #     # @return [Array<#{@klass}>, nil]
-              #     def self.#{scope.name}(#{scope.proc_parameters.join(', ')}); end
-            DOC
+          scopes&.each do |scope|
+            doc_string << scope.documentation
           end
         end
 
@@ -219,9 +228,9 @@ module Rails
         # @param content [String]
         # @return [void]
         def write_file(file_name, content)
-          ::FileUtils.touch(file_name) unless ::File.exists?(file_name)
+          ::FileUtils.touch(file_name) unless ::File.exist?(file_name)
           ::File.write(file_name, content)
-          puts "modify".rjust(12).with_styles(:bold, :green) + "  #{relative_file_name(file_name)}"
+          puts "modify".rjust(12).with_styles(:bold, :green) + "  #{relative_file_name(file_name)} (#{@klass})"
         end
 
         # @return [String]

data/lib/rails/annotate/solargraph/scope.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Rails
+  module Annotate
+    module Solargraph
+      # Represents a scope on an ActiveRecord Model.
+      class Scope
+        # @param name [Symbol]
+        attr_reader :name
+        # @param model_class [Class]
+        attr_reader :model_class
+        # @param proc_parameters [Array<Symbol>]
+        attr_reader :proc_parameters
+        # @param definition [String]
+        attr_reader :definition
+
+        # @param name [Symbol]
+        # @param model_class [Class]
+        # @param proc_parameters [Array<Symbol>]
+        # @param definition [String]
+        def initialize(name:, model_class:, proc_parameters:, definition:)
+          @name = name
+          @model_class = model_class
+          @proc_parameters = proc_parameters
+          @definition = definition
+          freeze
+        end
+
+        # @return [String]
+        def documentation
+          <<~DOC
+            #     # Scope `#{@name.inspect}`.
+            #     #
+            #{documented_definition}
+            #     #
+            #     # @return [Array<#{@model_class}>, nil]
+            #     #{signature}
+          DOC
+        end
+
+        private
+
+        # @return [String]
+        def signature
+          args = @proc_parameters.join(', ')
+
+          "def self.#{@name}(#{args}); end"
+        end
+
+        # @return [String]
+        def documented_definition
+          result = ::String.new
+          @definition.each_line do |line|
+            result << "#     #     #{line}"
+          end
+
+          result.chomp
+        end
+      end
+    end
+  end
+end

data/lib/rails/annotate/solargraph/terminal_colors.rb

@@ -69,6 +69,7 @@ module Rails
             end
           end
         end
+
       end
     end
   end

data/lib/rails/annotate/solargraph/version.rb

@@ -3,7 +3,7 @@
 module Rails
   module Annotate
     module Solargraph
-      VERSION = '0.5.3'
+      VERSION = '0.5.5'
     end
   end
 end

data/lib/rails/annotate/solargraph.rb

@@ -6,11 +6,12 @@ require 'fileutils'
 require_relative "solargraph/version"
 require_relative "solargraph/configuration"
 require_relative "solargraph/terminal_colors"
+require_relative "solargraph/scope"
 require_relative "solargraph/model"
 
 begin
   require_relative "overrides"
-rescue
+rescue ::StandardError
   nil
 end
 
@@ -31,6 +32,8 @@ module Rails
       # @return [String]
       SOLARGRAPH_FILE_NAME = '.solargraph.yml'
       # @return [String]
+      SOLARGRAPH_FILE_PATH = SOLARGRAPH_FILE_NAME
+      # @return [String]
       SCHEMA_FILE_NAME = '.annotate_solargraph_schema'
       # @return [String]
       SCHEMA_RAILS_PATH = SCHEMA_FILE_NAME
@@ -58,11 +61,31 @@ module Rails
 
         # @return [Array<ActiveRecord::Base>]
         def model_classes
-          @model_classes ||= (::ApplicationRecord rescue ::ActiveRecord::Base).subclasses.sort_by(&:name)
+          @model_classes ||= begin
+            base_abstract_class = begin
+              ::ApplicationRecord
+            rescue
+              ::ActiveRecord::Base
+            end
+
+            extract_subclasses(base_abstract_class).sort_by(&:name)
+          end
         end
 
         private
 
+        # @param klass [Class]
+        # @return [Array<Class>]
+        def extract_subclasses(klass)
+          result = []
+          klass.subclasses.each do |k|
+            result << k
+            result.concat(extract_subclasses(k))
+          end
+
+          result
+        end
+
         include TerminalColors
 
         def create_schema_file

data/rails-annotate-solargraph.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "Annotate ActiveRecord models with schema comments formatted in YARD that are compatible with Solargraph."
   spec.homepage = "https://gitlab.com/mateuszdrewniak/rails-annotate-solargraph"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://gitlab.com/mateuszdrewniak/rails-annotate-solargraph"
@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency 'rails', ">= 5.0", '< 8.0'
-  spec.add_dependency 'solargraph'
+  spec.add_dependency 'parser', '~> 3'
   spec.add_dependency 'yard'
 
   # For more information and examples about making a new gem, check out our

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-annotate-solargraph
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.5
 platform: ruby
 authors:
 - Mateusz Drewniak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2023-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,19 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: solargraph
+  name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -82,11 +82,13 @@ files:
 - bin/setup
 - lib/generators/annotate/solargraph/install_generator.rb
 - lib/generators/annotate/solargraph/templates/.annotate_solargraph_schema
+- lib/generators/annotate/solargraph/templates/.solargraph.yml
 - lib/generators/annotate/solargraph/templates/rails_annotate_solargraph.rake
 - lib/rails/annotate/overrides.rb
 - lib/rails/annotate/solargraph.rb
 - lib/rails/annotate/solargraph/configuration.rb
 - lib/rails/annotate/solargraph/model.rb
+- lib/rails/annotate/solargraph/scope.rb
 - lib/rails/annotate/solargraph/terminal_colors.rb
 - lib/rails/annotate/solargraph/version.rb
 - rails-annotate-solargraph.gemspec
@@ -106,14 +108,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Annotate ActiveRecord models with schema comments formatted in YARD that