rails-annotate-solargraph 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 641aad34ff5a1a7f98a1eca52baf74c311308b2e9e062cf8c5ac3c0186d1f1ec
-  data.tar.gz: 70657a49775862f8b50dc2e04f7b489b04f124cbfb4893f777f5a11f69b0ba51
+  metadata.gz: a3f9d275d9de0b0a37b8fae4f7f65ec2121ca25990ccfcc75e246e4c28711531
+  data.tar.gz: 1467357d585931d57d440d964a54ead827a964112757ef53a3253c86ac5d3790
 SHA512:
-  metadata.gz: 8a2c58e2d0dbb0dd0df66d1f2f04242095081c4159059c8830021cc16f9ece5222dc9fee73392757b88cf1798f5e53256a09fc2291585b8474c36db8777d64f2
-  data.tar.gz: 6335dab053b82ff232fdcc69c3453eea68ae44432bd6f4032f29ab812072e9053795955556f14578479bd47ebd37a3bfc6ac592254de63801d38369834dcc358
+  metadata.gz: d93389956d525b72fff9a08ab11bf48b65733fe3eed85c114fee771be0733b27205521d49512c8d3403a5ab1e6dbae699e40d434a10e642ec6eadc4426b42908
+  data.tar.gz: 225b3e7c0937c65940a7020162a0d2c2d91c1e83420a300d4d0740b187e16ca7119f554e61f73d20ce79fcb5e26a36b99051d8d0cfd3a17afd7c3e366e5cb977

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.5.1] - 2022-04-20
+
+- `ActiveRecord` scopes are now documented
+
 ## [0.5.0] - 2022-04-19
 
 - Add some static comments to the schema file to improve general Rails intellisense

data/Gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rails-annotate-solargraph.gemspec
 gemspec
 
+gem 'byebug'
 gem 'debug'
 gem 'git'
 gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails-annotate-solargraph (0.5.0)
+    rails-annotate-solargraph (0.5.1)
       rails (>= 5.0, < 8.0)
       solargraph
       yard
@@ -78,6 +78,7 @@ GEM
     backport (1.2.0)
     benchmark (0.2.0)
     builder (3.2.4)
+    byebug (11.1.3)
     concurrent-ruby (1.1.10)
     crass (1.0.6)
     debug (1.5.0)
@@ -221,6 +222,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
   debug
   git
   minitest (~> 5.0)

data/lib/rails/annotate/overrides.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class ActiveRecord::Base
+  class << self
+    alias orig_scope scope
+
+    def scope(*args, **kwargs, &block)
+      file_path, scope_line_number = caller.first.split(':')
+      scope_line_number = scope_line_number.to_i
+      scope_name = args.first
+      scope_proc = args[1]
+      proc_parameters = scope_proc.respond_to?(:parameters) ? scope_proc.parameters.map(&:last) : []
+      scope_line = nil
+      scope_model_class = self
+
+      ::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
+
+          scope_line = line.strip
+          break
+        end
+      end
+
+      ::Rails::Annotate::Solargraph::Model.add_scope(scope_name.to_sym, scope_model_class, proc_parameters, scope_line)
+
+      orig_scope(*args, **kwargs, &block)
+    end
+  end
+end

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

@@ -8,6 +8,8 @@ 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
 
@@ -32,6 +34,21 @@ module Rails
         TYPE_MAP.freeze
 
         class << self
+          # @return [Hash{Class => Array<Rails::Annotate::Solargraph::Model::Scope>}]
+          attr_reader :scopes
+
+          # @param name [Symbol]
+          # @param model_class [Class]
+          # @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)
+            @scopes ||= {}
+            @scopes[model_class] ||= []
+            @scopes[model_class] << scope
+            @scopes[model_class].sort_by! { |scope| scope.name }
+          end
+
           # @param klass [Class]
           # @return [String]
           def annotation_start(klass = nil)
@@ -95,7 +112,6 @@ module Rails
           end
 
           return new_file_content unless write
-          # debugger
           return new_file_content if old_content == new_file_content
 
           write_file @file_name, new_file_content
@@ -126,12 +142,51 @@ module Rails
             #   class #{@klass} < #{@klass.superclass}
           DOC
 
+          document_scopes(doc_string)
+          document_relations(doc_string)
+          document_fields(doc_string)
+
+          doc_string << <<~DOC.chomp
+            #   end
+            # #{annotation_end}
+          DOC
+
+          # uncomment the generated annotations if they're saved in the schema file
+          return doc_string.gsub(/^#\ {3}/, '').gsub(/^#\n/, "\n") if CONFIG.schema_file?
+
+          doc_string
+        end
+
+        private
+
+        # @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
+          end
+        end
+
+        # @param doc_string [String]
+        # @return [void]
+        def document_relations(doc_string)
           @klass.reflections.sort.each do |attr_name, reflection|
             next document_polymorphic_relation(doc_string, attr_name, reflection) if reflection.polymorphic?
 
             document_relation(doc_string, attr_name, reflection)
           end
+        end
 
+        # @param doc_string [String]
+        # @return [void]
+        def document_fields(doc_string)
           @klass.attribute_types.each do |name, attr_type|
             doc_string << <<~DOC
               #     # Database column `#{@klass.table_name}.#{name}`, type: `#{attr_type.type}`.
@@ -142,20 +197,9 @@ module Rails
               #     def #{name}; end
             DOC
           end
-
-          doc_string << <<~DOC.chomp
-            #   end
-            # #{annotation_end}
-          DOC
-
-          # uncomment the generated annotations if they're saved in the schema file
-          return doc_string.gsub(/^#\ {3}/, '').gsub(/^#\n/, "\n") if CONFIG.schema_file?
-
-          doc_string
         end
 
-        private
-
+        # @return [String, nil]
         def parse_clause
           return if CONFIG.schema_file?
 

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

@@ -3,7 +3,7 @@
 module Rails
   module Annotate
     module Solargraph
-      VERSION = '0.5.0'
+      VERSION = '0.5.1'
     end
   end
 end

data/lib/rails/annotate/solargraph.rb

@@ -8,6 +8,7 @@ require_relative "solargraph/configuration"
 require_relative "solargraph/terminal_colors"
 require_relative "solargraph/model"
 
+
 module Rails
   module Annotate
     module Solargraph
@@ -75,6 +76,7 @@ module Rails
           changed_files = []
           model_files = ::Dir[::File.join(::Rails.root, MODEL_DIR, '**/*.rb')].map { |file| file.sub("#{::Rails.root}/", '') }.to_set
 
+          require_relative "overrides"
           ::Rails.application.eager_load!
           model_classes.each do |subclass|
             subclass_file = ::File.join MODEL_DIR, "#{subclass.to_s.underscore}.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-annotate-solargraph
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Mateusz Drewniak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -83,6 +83,7 @@ files:
 - lib/generators/annotate/solargraph/install_generator.rb
 - lib/generators/annotate/solargraph/templates/.annotate_solargraph_schema
 - 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