solargraph-rails 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8535143a29b76e1a9800e728bbc2c6d8d996dde200a162c4ad7b2747c859f3cb
-  data.tar.gz: 8fb9ee00b1486f63489b788bbc49db1301027ae47928f0aec1c686bdd0f0b6d0
+  metadata.gz: 136534eb40ae838dfcc2a78abb2e6e0bc0c9cf187c6b1d86095dda51e876aa24
+  data.tar.gz: d90e381a7a65f81900252347da41b2b2b46721e9f3e57930a90c9e00f0b480b4
 SHA512:
-  metadata.gz: 013c47d9b9b382bb11da4f8463aeb5bdf94afe71bdcac2c8bce2609d1d81cc3a7f9857bc2003665615d2538a2ca6be43550b3ba14a21144315011c2d607a8475
-  data.tar.gz: 280e6f1520de2562a725da745d4d2295150660403c2eb02177cdbfbe3784e0c048d34363cbd431d59891226716c836517d0f197435cd01d5248252db56a9246c
+  metadata.gz: 770b2ae68e6baa102d4474925394e05750580bed3726abb7e965a04f320d4ac14d3108dd8a0360ae340971b522579178dcf2fca6df15cbdab2d3ecc2bc0a488f
+  data.tar.gz: 641c7f310938d271bcaeb58dc4aefbca9d5d61aa53f4a33272c38025cbf5a6e2da469920441c2f22d17dbae7ebc926ec5aedbfae6feea0622a84968784cc009d

data/.github/workflows/ruby.yml

@@ -1,9 +1,7 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+# To debug locally:
+#   npm install -g act
+#   act act pull_request
+#
 
 name: Ruby
 
@@ -14,32 +12,65 @@ on:
 
 jobs:
   test:
-    # older versions of Ruby want openssl1 which is not on ubuntu-latest
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby-version:
-          - "2.7"
           - "3.0"
+#          - "3.1"
+#          - "3.2"
+#          - "3.3"
+#          - "3.4"
         solargraph-version:
-          - "0.44.3"
-          - "0.45.0"
-          - "0.46.0"
-          - "0.47.2"
+          - "0.48.0"
+          - "0.49.0"
+          - "0.50.0"
+          - "0.51.2"
+          - "0.52.0"
+          - "0.54.6.alpha"
+        rails-version:
+          - "7"
       fail-fast: false
 
     steps:
       - uses: actions/checkout@v2
-      - name: Cache RVM
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler: latest
+          bundler-cache: true
+
+
+      - name: Install child bundle
+        run: |
+          set -x
+          export MATRIX_SOLARGRAPH_VERSION="${{ matrix.solargraph-version }}"
+          export BUNDLE_PATH=$(pwd)/vendor/bundle
+          cd "spec/rails${{ matrix.rails-version }}"
+          bundle install
+
+      - name: cache gem annotations
         uses: actions/cache@v3
-        id: rvm
+        id: dot-cache
         with:
-          key: ${{ runner.os }}-rvm-${{ matrix.ruby-version }}
+          key: ${{ runner.os }}-dot-cache-${{ matrix.ruby-version }}
           path: |
-            /home/runner/.rvm
-            /home/runner/.yardoc
-            #/usr/local/rvm/
+            /home/runner/.cache
+
+      - name: bundle list
+        run: bundle list && cat Gemfile.lock && find vendor -name Gemfile
+
       #- name: Setup upterm session
       #  uses: lhotari/action-upterm@v1
-      - name: Test
-        run: "/bin/bash ./ci.sh ${{ matrix.ruby-version }} ${{ matrix.solargraph-version}}"
+
+      - name: RSpec
+        run: |
+          set -x
+          echo $MATRIX_SOLARGRAPH_VERSION
+          export MATRIX_SOLARGRAPH_VERSION="${{ matrix.solargraph-version }}"
+          export BUNDLE_PATH=$(pwd)/vendor/bundle
+          ruby --version
+          bundle install
+          bundle exec solargraph gems || true
+          bundle exec solargraph version
+          bundle exec rspec spec/solargraph-rails

data/.gitignore

@@ -7,10 +7,6 @@
 /spec/reports/
 /tmp/
 .DS_Store
-spec/rails5/log/
-spec/rails5/tmp/
-spec/rails6/log/
-spec/rails6/tmp/
 spec/rails7/log/
 spec/rails7/tmp/
 .projections.json
@@ -19,3 +15,5 @@ spec/rails7/tmp/
 # rspec failure tracking
 .rspec_status
 Gemfile.lock
+/.Gemfile
+vendor

data/CHANGELOG.md

@@ -2,6 +2,47 @@
 
 ## Changes
 
+### v1.1.2
+
+Features / fixes:
+
+- fix bad gemspec solargraph dependency
+- additional pre-packaged Rails type definitions (Thanks, @grncdr!)
+
+Internal improvements:
+
+- Use normal ruby source for extra YARD annotations (Thanks, @grncdr!)
+- Speed up CI for recent Solargraph version fresh builds
+- spec reliability fixes
+-
+
+### v1.1.1
+
+New maintainer: @apiology
+
+Features / fixes:
+
+- support tsvector type columns in migrations (#55)
+- support recent Solargraph releases
+  - fix incorrect return type in Walker.normalize_ast
+  - limit Solargraph versions to those that support global conventions for now pending new Solargraph release (<0.53 for now)
+  - limit Solargraph versions to tested versions (>0.48)
+- additional built-in annotations for better completions and types
+- work around ActiveSupport 7.0.x core\_ext Logger bug
+
+Internal improvements:
+
+- revive and improve CI workflow for higher quality releases (Huge thanks to @grncdr!)
+  - cache YARD gem annotations for faster GitHub workflows via RubyGems plugin
+  - track definition skips by Solargraph version
+  - remove testing of Rails 5/6; retain and revive Rails 7 testing
+  - sync type definitions with current functionality
+  - switch to more recent Solargraph releases in CI matrix
+- support recent Solargraph versions in specs
+- use `Solargraph::ApiMap.load_with_cache` when available in specs for eager type loading
+- use .Gemfile pattern to allow local untracked Gemfile changes
+- better support for updating definitions
+
 ### v1.1.0
 
 - remove pinned solargraph version

data/DEVELOPMENT.md

@@ -4,36 +4,27 @@
 
 1. create fork and clone the repo
 2. install gem deps `bundle install`
-3. install dummy rails5 app deps and build its yard cache
+3. install dummy Rails app deps and build its yard cache
 
     ```
-    $ cd spec/rails5
-    $ bundle install && yard gems
-    $ cd ../../
-    ```
-
-3. install dummy rails6 app deps and build its yard cache
-
-    ```
-    $ cd spec/rails6
+    $ cd spec/rails7
     $ bundle install && yard gems
     $ cd ../../
     ```
+4. now tests should pass locally and you can try different changes
+5. submit PR
 
-4. install dummy rails7 app deps and build its yard cache
+## Debugging workflow / test matrix issues locally
 
-    ```
-    $ cd spec/rails7
-    $ bundle install && yard gems
-    $ cd ../../
-    ```
-5. now tests should pass locally and you can try different changes
-6. sumbit PR
+```sh
+npm install -g act
+act pull_request
+```
 
 ## Completion coverage tracking
 
 Solargraph-Rails uses a [set of yaml files](https://github.com/iftheshoefritz/solargraph-rails/tree/master/spec/definitions) to track coverage of found completions.
-Those yaml files are generated at runtime from a dummy [rails5](https://github.com/iftheshoefritz/solargraph-rails/tree/master/spec/rails5) or [rails6](https://github.com/iftheshoefritz/solargraph-rails/tree/master/spec/rails6) app.
+Those yaml files are generated at runtime from a dummy [Rails 7 app](https://github.com/iftheshoefritz/solargraph-rails/tree/master/spec/rails7).
 
 The main goal is to catch any regressions in case of any change. In case a method completion is marked completed and it is not found in solargraph completions, the tests will fail.
 
@@ -85,7 +76,19 @@ In case a new set of assertion files has to be created (for a new Rails version
 All you have to do is execute the script and pass it a path to rails app:
 
 ```
-ruby script/generate_definitions.rb spec/rails6
+ruby script/generate_definitions.rb spec/rails7
 ```
 
 Make sure to review the script and uncomment relevant parts
+
+## Preparing a release (maintainers)
+
+1. Look up [most recent release](https://rubygems.org/gems/solargraph-rails)
+2. Open up commit list(https://github.com/iftheshoefritz/solargraph-rails/compare/v1.1.1...main)
+3. Update [CHANGELOG.md](./CHANGELOG.md)
+4. Flip to 'files changed view' and refine updates
+5. Bump [version](./lib/solargraph/rails/version.rb) appropriately
+6. Create branch, commit and merge changes - "Prepare for vX.Y.Z release", branch: prepare_vX.Y.Z_release
+7. `git config branch.main.remote`
+8. Ensure your local main branch is directly from iftheshoefritz:
+9. `git checkout main && git pull && bundle exec rake release`

data/Gemfile

@@ -1,10 +1,52 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Kind of ugly, but works. The setup-ruby action forces gems to be installed to vendor/bundle
+# If we use it naively we end up with vendor/bundle  and spec/rails7/vendor/bundle, which
+# breaks all the tests because docs are generated in two different directories.
+#
+# So if we just install the rails deps at the same time, we have a single cache and a single
+# directory for gems.
+rails_version = ENV['MATRIX_RAILS_VERSION'] || '7'
+instance_eval File.read(File.expand_path("spec/rails#{rails_version}/Gemfile", __dir__))
+
+solargraph_version = (ENV['CI'] && ENV['MATRIX_SOLARGRAPH_VERSION'])
+
+# ensure that YARD docs get cached by ruby/setup-ruby in GitHub
+# Actions if using an older version of solargraph that needs user to
+# run `yard gems` manually
+if solargraph_version
+  solargraph_minor_version = solargraph_version.split('.')[1].to_i
+  solargraph_major_version = solargraph_version.split('.')[0].to_i
+  if solargraph_version && solargraph_major_version == 0 && solargraph_minor_version < 53
+    plugin 'auto_yard', path: File.expand_path('ci/auto_yard', __dir__)
+    STDERR.puts("Using auto_yard plugin at #{File.expand_path('ci/auto_yard', __dir__)}")
+  end
+end
 
 group :development, :test do
-  gem 'byebug'
   gem 'bundler-audit'
+  gem 'debug'
+  gem 'byebug'
 end
+
+if rails_version == '7'
+  # https://stackoverflow.com/questions/79360526/uninitialized-constant-activesupportloggerthreadsafelevellogger-nameerror
+  gem "concurrent-ruby", '<=1.3.5'
+end
+
 # Specify your gem's dependencies in solargraph_rails.gemspec
 gemspec
+
+solargraph_force_ci_version = (ENV['CI'] && ENV['MATRIX_SOLARGRAPH_VERSION'])
+
+if solargraph_force_ci_version == '0.54.6.alpha'
+  gem 'solargraph',
+      github: 'apiology/solargraph',
+      branch: 'v54-alpha'
+    # path: '../solargraph'
+end
+
+# Local gemfile for development tools, etc.
+local_gemfile = File.expand_path(".Gemfile", __dir__)
+instance_eval File.read local_gemfile if File.exist? local_gemfile

data/README.md

@@ -74,16 +74,14 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ifthes
 3. install dummy rails app deps and build the yard cache:
 
 ```
-$ cd spec/rails5
+$ cd spec/rails7
 $ bundle install && yard gems
 $ cd ../../
 ```
 
-(and the same for rails 6 and rails 7)
-
 4. now tests should pass locally and you can try different changes
 
-5. sumbit PR
+5. submit PR
 
 ## License
 

data/ci/auto_yard/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/ci/auto_yard/auto_yard.gemspec

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = 'auto_yard'
+  spec.version = '0.0.1'
+  spec.authors = ['Stephen Sugden']
+  spec.email = ['grncdr@users.noreply.github.com']
+
+  spec.summary = 'Run yard gems automatically after bundle install'
+  spec.description = spec.summary
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.homepage = 'https://github.com'
+  spec.metadata['homepage_uri'] = spec.homepage
+
+  spec.files = ['plugins.rb']
+end

data/ci/auto_yard/plugins.rb

@@ -0,0 +1,11 @@
+Bundler::Plugin.add_hook('after-install-all') do
+  system('bundle exec yard gems')
+  cmd = 'bundle exec yard gems --plugin solargraph'
+  STDERR.puts("Installing yard info using #{cmd.inspect}")
+  # Attempt to run yard, and if it fails, try again - sometimes YARD gets indigestion on a given gem
+  system(cmd + ' || ' + cmd)
+  STDERR.puts("Installed yard info using #{cmd.inspect}")
+rescue StandardError => e
+  STDERR.puts("Error running yard gems: #{e.message}")
+  STDERR.puts("Backtrace:\n#{e.backtrace}")
+end

data/lib/solargraph/rails/annotations/README.md

@@ -0,0 +1,5 @@
+# annotations
+
+Code in this directory is _not_ loaded or evaluated at runtime, either by solargraph or your application.
+
+The code in [rails_api.rb](../rails_api.rb) loads each of these files inside a YARD  `@!parse` directive.

data/lib/solargraph/rails/annotations/action_controller.rb

@@ -0,0 +1,29 @@
+class ActionController::Base
+  include ActionController::MimeResponds
+  include ActionController::Redirecting
+  include ActionController::Cookies
+  include AbstractController::Rendering
+  extend ActiveSupport::Callbacks::ClassMethods
+  extend ActiveSupport::Rescuable::ClassMethods
+  extend AbstractController::Callbacks::ClassMethods
+  extend ActionController::RequestForgeryProtection::ClassMethods
+
+  # @return [ActionDispatch::Response]
+  def response; end
+  # @return [ActionDispatch::Request]
+  def request; end
+  # @return [ActionDispatch::Request::Session]
+  def session; end
+  # @return [ActionDispatch::Flash::FlashHash]
+  def flash; end
+end
+
+class ActionController::Metal
+  # @return [ActionController::Parameters]
+  def params; end
+end
+
+class ActionController::Cookies
+  # @return [ActionDispatch::Cookies::CookieJar]
+  def cookies; end
+end

data/lib/solargraph/rails/annotations/action_dispatch.rb

@@ -0,0 +1,26 @@
+module ActionDispatch
+  module Flash
+    class FlashHash
+      # @return [ActionDispatch::Flash::FlashNow]
+      def now; end
+    end
+  end
+
+  module Routing
+    class Mapper
+      include ActionDispatch::Routing::Mapper::Base
+      include ActionDispatch::Routing::Mapper::HttpHelpers
+      include ActionDispatch::Routing::Mapper::Redirection
+      include ActionDispatch::Routing::Mapper::Scoping
+      include ActionDispatch::Routing::Mapper::Concerns
+      include ActionDispatch::Routing::Mapper::Resources
+      include ActionDispatch::Routing::Mapper::CustomUrls
+    end
+
+    class RouteSet
+      # @yieldself [ActionDispatch::Routing::Mapper]
+      # @yieldreceiver [ActionDispatch::Routing::Mapper]
+      def draw; end
+    end
+  end
+end

data/lib/solargraph/rails/annotations/action_mailer.rb

@@ -0,0 +1,7 @@
+class ActionMailer::Base
+  # @return [self]
+  def self.with(**params); end
+  #
+  # @return [ActionMailer::MessageDelivery]
+  def mail(**params); end
+end

data/lib/solargraph/rails/annotations/active_record.rb

@@ -0,0 +1,54 @@
+class ActiveRecord::ConnectionAdapters::SchemaStatements
+  # @yieldparam [ActiveRecord::ConnectionAdapters::TableDefinition]
+  def create_table; end
+  # @yieldparam [ActiveRecord::ConnectionAdapters::TableDefinition]
+  def create_join_table; end
+  # @yieldparam [ActiveRecord::ConnectionAdapters::Table]
+  def change_table; end
+end
+
+# this module doesn't really exist, it's here to avoid repeating these mixins
+module ActiveRecord::RelationMethods
+  include Enumerable
+  include ActiveRecord::QueryMethods
+  include ActiveRecord::FinderMethods
+  include ActiveRecord::Calculations
+  include ActiveRecord::Batches
+end
+
+class ActiveRecord::Relation
+  include ActiveRecord::RelationMethods
+end
+
+class ActiveRecord::Base
+  extend Enumerable
+  extend ActiveRecord::QueryMethods
+  extend ActiveRecord::FinderMethods
+  extend ActiveRecord::Calculations
+  extend ActiveRecord::Batches
+  extend ActiveRecord::Associations::ClassMethods
+  extend ActiveRecord::Inheritance::ClassMethods
+  extend ActiveRecord::ModelSchema::ClassMethods
+  extend ActiveRecord::Transactions::ClassMethods
+  extend ActiveRecord::Scoping::Named::ClassMethods
+  extend ActiveRecord::RelationMethods
+  include ActiveRecord::Persistence
+end
+
+# @!override ActiveRecord::Batches#find_each
+#   @yieldparam_single_parameter
+
+# @!override ActiveRecord::Calculations#count
+#   @return [Integer, Hash]
+# @!override ActiveRecord::Calculations#pluck
+#   @overload pluck(one)
+#     @return [Array]
+#   @overload pluck(one, two, *more)
+#     @return [Array<Array>]
+
+# @!override ActiveRecord::QueryMethods::WhereChain#not
+#   @return_single_parameter
+# @!override ActiveRecord::QueryMethods::WhereChain#missing
+#   @return_single_parameter
+# @!override ActiveRecord::QueryMethods::WhereChain#associated
+#   @return_single_parameter

data/lib/solargraph/rails/annotations/active_support.rb

@@ -0,0 +1,5 @@
+# @!override ActiveSupport::Rescuable::ClassMethods#rescue_from
+#   @return [void]
+
+# @!override ActiveSupport::DescendantsTracker#subclasses
+#   @return [Array<Class>]

data/lib/solargraph/rails/annotations/date.rb

@@ -0,0 +1,31 @@
+require 'date'
+require 'active_support/core_ext'
+
+class Date
+  # @param form [Symbol]
+  # @return [Time]
+  def to_time(form = :local); end
+
+  # @return [Rational, self]
+  def -(other); end
+
+  # @return [self]
+  def +(other); end
+
+  # @return [String]
+  def readable_inspect; end
+
+  # @return [-1, 0, 1, nil]
+  def compare_with_coercion(other); end
+
+  # @return [-1, 0, 1, nil]
+  def <=>(other); end
+
+  # @return [::Time]
+  def to_time; end
+end
+
+class DateTime
+  # @return [String]
+  def readable_inspect; end
+end

data/lib/solargraph/rails/annotations/object.rb

@@ -0,0 +1,7 @@
+class Object
+  # @return [self, nil]
+  def presence; end
+
+  # @return [self, nil]
+  def presence_in(x); end
+end

data/lib/solargraph/rails/annotations/rails.rb

@@ -0,0 +1,14 @@
+class Rails
+  # @return [Rails::Application]
+  def self.application; end
+end
+
+class Rails::Engine
+  # @return [ActionDispatch::Routing::RouteSet]
+  def routes; end
+end
+
+class Rails::Application
+  # @return [ActionDispatch::Routing::RouteSet]
+  def routes; end
+end

data/lib/solargraph/rails/annotations/stdlib_requires.rb

@@ -0,0 +1,66 @@
+# See issue #54
+class Object
+  require 'abbrev'
+  require 'base64'
+  require 'benchmark'
+  require 'bigdecimal'
+  require 'bundler'
+  require 'cgi'
+  require 'coverage'
+  require 'csv'
+  require 'date'
+  require 'delegate'
+  require 'did_you_mean'
+  require 'digest'
+  require 'drb'
+  require 'English'
+  require 'erb'
+  require 'error_highlight'
+  require 'expect'
+  require 'fiddle'
+  require 'fileutils'
+  require 'find'
+  require 'forwardable'
+  require 'getoptlong'
+  require 'ipaddr'
+  require 'irb'
+  require 'json'
+  require 'kconv'
+  require 'logger'
+  require 'mkmf'
+  require 'monitor'
+  require 'mutex_m'
+  require 'objspace'
+  require 'observer'
+  require 'open3'
+  require 'openssl'
+  require 'open-uri'
+  require 'optionparser'
+  require 'optparse'
+  require 'ostruct'
+  require 'pathname'
+  require 'prettyprint'
+  require 'pstore'
+  require 'psych'
+  require 'racc'
+  require 'rdoc'
+  require 'readline'
+  require 'reline'
+  require 'resolv'
+  require 'resolv-replace'
+  require 'ripper'
+  require 'rubygems'
+  require 'securerandom'
+  require 'shellwords'
+  require 'singleton'
+  require 'socket'
+  require 'tempfile'
+  require 'timeout'
+  require 'time'
+  require 'tmpdir'
+  require 'tsort'
+  require 'un'
+  require 'uri'
+  require 'weakref'
+  require 'yaml'
+end

data/lib/solargraph/rails/annotations/time.rb

@@ -0,0 +1,30 @@
+require 'time'
+
+class Time
+  # @return [Boolean]
+  def eql_with_coercion(other); end
+
+  # @return [-1, 0, 1, nil]
+  def compare_with_coercion(other); end
+
+  # @return [-1, 0, 1, nil]
+  def compare_without_coercion(other); end
+
+  # @return [-1, 0, 1, nil]
+  def <=>(other); end
+
+  # @return [Time]
+  def +(other); end
+
+  # @param seconds [Integer, Float]
+  # @param microseconds [Integer]
+  # @param utc [Boolean]
+  # @return [Time]
+  def self.at(seconds, microseconds = 0, utc = false); end
+
+  # @return [Time]
+  def to_time; end
+
+  # @return [Time]
+  def +(other); end
+end

data/lib/solargraph/rails/rails_api.rb

@@ -5,70 +5,18 @@ module Solargraph
         @instance ||= self.new
       end
 
-      def global(yard_map)
-        return [] if yard_map.required.empty?
-
-        ann = File.read(File.dirname(__FILE__) + '/annotations.rb')
-        source = Solargraph::Source.load_string(ann, 'annotations.rb')
-        map = Solargraph::SourceMap.map(source)
-
-        Solargraph.logger.debug(
-          "[Rails][Rails] found #{map.pins.size} pins in annotations"
-        )
-
-        overrides =
-          YAML
-            .load_file(File.dirname(__FILE__) + '/types.yml')
-            .map do |meth, data|
-              if data['return']
-                Util.method_return(meth, data['return'])
-              elsif data['yieldself']
-                Solargraph::Pin::Reference::Override.from_comment(
-                  meth,
-                  "@yieldself [#{data['yieldself'].join(',')}]"
-                )
-              elsif data['yieldparam']
-                Solargraph::Pin::Reference::Override.from_comment(
-                  meth,
-                  "@yieldparam [#{data['yieldparam'].join(',')}]"
-                )
-              end
-            end
-
-        ns =
-          Solargraph::Pin::Namespace.new(
-            name: 'ActionController::Base',
-            gates: ['ActionController::Base']
-          )
-
-        definitions = [
-          Util.build_public_method(
-            ns,
-            'response',
-            types: ['ActionDispatch::Response'],
-            location: Util.dummy_location('whatever.rb')
-          ),
-          Util.build_public_method(
-            ns,
-            'request',
-            types: ['ActionDispatch::Request'],
-            location: Util.dummy_location('whatever.rb')
-          ),
-          Util.build_public_method(
-            ns,
-            'session',
-            types: ['ActionDispatch::Request::Session'],
-            location: Util.dummy_location('whatever.rb')
-          ),
-          Util.build_public_method(
-            ns,
-            'flash',
-            types: ['ActionDispatch::Flash::FlashHash'],
-            location: Util.dummy_location('whatever.rb')
-          )
-        ]
+      def extra_source_maps
+        @extra_source_maps ||= Dir[File.join(__dir__, 'annotations', '*.rb')].to_h do |path|
+          code = File.read(path)
+          source = Solargraph::Source.load_string(code, path)
+          map = Solargraph::SourceMap.map(source)
+          [File.basename(path, '.rb'), map]
+        end
+      end
 
-        map.pins + definitions + overrides
+      # @param yard_map [YardMap]
+      def global(_yard_map)
+        extra_source_maps.values.flat_map(&:pins)
       end
 
       def local(source_map, ns)

data/lib/solargraph/rails/schema.rb

@@ -19,6 +19,7 @@ module Solargraph
         inet: 'IPAddr',
         citext: 'String',
         binary: 'String',
+        tsvector: 'String',
         timestamp: 'ActiveSupport::TimeWithZone'
       }
 
@@ -86,7 +87,7 @@ module Solargraph
 
       def infer_table_names(ns)
         table_name = ns.name.tableize
-        if ns.namespace.present?
+        if ns.namespace && !ns.namespace.empty?
           [ns.path.tableize.tr('/', '_'), table_name]
         else
           [table_name]

data/lib/solargraph/rails/version.rb

@@ -1,5 +1,5 @@
 module Solargraph
   module Rails
-    VERSION = '1.1.0'
+    VERSION = '1.1.2'
   end
 end

data/lib/solargraph/rails/walker.rb

@@ -49,15 +49,8 @@ module Solargraph
         end
       end
 
-      # https://github.com/castwide/solargraph/issues/522
       def self.normalize_ast(source)
-        ast = source.node
-
-        if ast.is_a?(::Parser::AST::Node)
-          ast
-        else
-          NodeParser.parse_with_comments(source.code, source.filename)
-        end
+        NodeParser.parse_with_comments(source.code, source.filename)
       end
 
       def self.from_source(source)

data/lib/solargraph-rails.rb

@@ -1,18 +1,20 @@
 require 'solargraph'
+require 'logger'
+require 'active_support'
 require 'active_support/core_ext/string/inflections'
 
-require_relative 'solargraph/rails/util.rb'
-require_relative 'solargraph/rails/schema.rb'
-require_relative 'solargraph/rails/annotate.rb'
-require_relative 'solargraph/rails/autoload.rb'
-require_relative 'solargraph/rails/model.rb'
-require_relative 'solargraph/rails/devise.rb'
-require_relative 'solargraph/rails/walker.rb'
-require_relative 'solargraph/rails/rails_api.rb'
-require_relative 'solargraph/rails/delegate.rb'
-require_relative 'solargraph/rails/storage.rb'
-require_relative 'solargraph/rails/debug.rb'
-require_relative 'solargraph/rails/version.rb'
+require_relative 'solargraph/rails/util'
+require_relative 'solargraph/rails/schema'
+require_relative 'solargraph/rails/annotate'
+require_relative 'solargraph/rails/autoload'
+require_relative 'solargraph/rails/model'
+require_relative 'solargraph/rails/devise'
+require_relative 'solargraph/rails/walker'
+require_relative 'solargraph/rails/rails_api'
+require_relative 'solargraph/rails/delegate'
+require_relative 'solargraph/rails/storage'
+require_relative 'solargraph/rails/debug'
+require_relative 'solargraph/rails/version'
 
 module Solargraph
   module Rails

data/solargraph-rails.gemspec

@@ -2,6 +2,10 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'solargraph/rails/version'
 
+
+solargraph_force_ci_version = (ENV['CI'] && ENV['MATRIX_SOLARGRAPH_VERSION'])
+solargraph_version = solargraph_force_ci_version ? [solargraph_force_ci_version] : [">= 0.48.0", '<0.53.0']
+
 Gem::Specification.new do |spec|
   spec.name = 'solargraph-rails'
   spec.version = Solargraph::Rails::VERSION
@@ -27,6 +31,11 @@ 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'
+  # Solargraph temporarily dropped support for Convention.global in
+  # 0.53 - this should be lifted after it returns:
+  #
+  # https://github.com/castwide/solargraph/pull/877
+  spec.add_runtime_dependency 'solargraph', *solargraph_version
+
   spec.add_runtime_dependency 'activesupport'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Fritz Meissner
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.48.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.53.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.48.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.53.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -102,10 +108,23 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- ci.sh
+- ci/auto_yard/.gitignore
+- ci/auto_yard/auto_yard.gemspec
+- ci/auto_yard/lib/.keep
+- ci/auto_yard/plugins.rb
 - lib/solargraph-rails.rb
 - lib/solargraph/rails/annotate.rb
-- lib/solargraph/rails/annotations.rb
+- lib/solargraph/rails/annotations/README.md
+- lib/solargraph/rails/annotations/action_controller.rb
+- lib/solargraph/rails/annotations/action_dispatch.rb
+- lib/solargraph/rails/annotations/action_mailer.rb
+- lib/solargraph/rails/annotations/active_record.rb
+- lib/solargraph/rails/annotations/active_support.rb
+- lib/solargraph/rails/annotations/date.rb
+- lib/solargraph/rails/annotations/object.rb
+- lib/solargraph/rails/annotations/rails.rb
+- lib/solargraph/rails/annotations/stdlib_requires.rb
+- lib/solargraph/rails/annotations/time.rb
 - lib/solargraph/rails/autoload.rb
 - lib/solargraph/rails/debug.rb
 - lib/solargraph/rails/delegate.rb
@@ -114,7 +133,6 @@ files:
 - lib/solargraph/rails/rails_api.rb
 - lib/solargraph/rails/schema.rb
 - lib/solargraph/rails/storage.rb
-- lib/solargraph/rails/types.yml
 - lib/solargraph/rails/util.rb
 - lib/solargraph/rails/version.rb
 - lib/solargraph/rails/walker.rb
@@ -124,7 +142,7 @@ homepage: https://github.com/iftheshoefritz/solargraph-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,8 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Solargraph plugin that adds Rails-specific code through a Convention
 test_files: []

data/ci.sh

@@ -1,34 +0,0 @@
-#!/bin/bash
-set -e
-# when running in github actions:
-RVM_PATH=/home/runner/.rvm
-# when running locally using act:
-#RVM_PATH=/usr/local/rvm
-MATRIX_RUBY_VERSION=$1
-MATRIX_SOLARGRAPH_VERSION=$2
-
-if [[ ! -d $RVM_PATH ]]; then
-  # this fetches the develop version; using -s stable should fetch the latest stable, but has a gpg error:
-  curl -sSL https://get.rvm.io | bash -s
-fi
-
-# when running in github actions:
-source /home/runner/.rvm/scripts/rvm
-# when running locally in Act container:
-#source /usr/local/rvm/scripts/rvm
-
-
-#rvm package install openssl # hack because ubuntu won't give us openSSL
-rvm install ruby $MATRIX_RUBY_VERSION
-rvm use $MATRIX_RUBY_VERSION
-gem install bundler
-
-echo "s/gem 'solargraph'/gem 'solargraph', '${MATRIX_SOLARGRAPH_VERSION}'/" > command.sed
-
-(cd spec/rails5; sed -i -f ../../command.sed Gemfile; cat Gemfile; bundle install; yard gems)
-(cd spec/rails6; sed -i -f ../../command.sed Gemfile; cat Gemfile; bundle install; yard gems)
-(cd spec/rails7; sed -i -f ../../command.sed Gemfile; cat Gemfile; bundle install; yard gems)
-
-bundle install
-
-bundle exec rspec

data/lib/solargraph/rails/annotations.rb

@@ -1,50 +0,0 @@
-# The following comments fill some of the gaps in Solargraph's understanding of
-# Rails apps. Since they're all in YARD, they get mapped in Solargraph but
-# ignored at runtime.
-#
-# You can put this file anywhere in the project, as long as it gets included in
-# the workspace maps. It's recommended that you keep it in a standalone file
-# instead of pasting it into an existing one.
-#
-# @!parse
-#   class ActionController::Base
-#     include ActionController::MimeResponds
-#     include ActionController::Redirecting
-#     include ActionController::Cookies
-#     include AbstractController::Rendering
-#     extend ActiveSupport::Callbacks::ClassMethods
-#     extend ActiveSupport::Rescuable::ClassMethods
-#     extend AbstractController::Callbacks::ClassMethods
-#     extend ActionController::RequestForgeryProtection::ClassMethods
-#   end
-#   class ActionDispatch::Routing::Mapper
-#     include ActionDispatch::Routing::Mapper::Base
-#     include ActionDispatch::Routing::Mapper::HttpHelpers
-#     include ActionDispatch::Routing::Mapper::Redirection
-#     include ActionDispatch::Routing::Mapper::Scoping
-#     include ActionDispatch::Routing::Mapper::Concerns
-#     include ActionDispatch::Routing::Mapper::Resources
-#     include ActionDispatch::Routing::Mapper::CustomUrls
-#   end
-#   class Rails
-#     # @return [Rails::Application]
-#     def self.application; end
-#   end
-#   class Rails::Application
-#     # @return [ActionDispatch::Routing::RouteSet]
-#     def routes; end
-#   end
-#   class ActionDispatch::Routing::RouteSet
-#     # @yieldself [ActionDispatch::Routing::Mapper]
-#     def draw; end
-#   end
-#   class ActiveRecord::Base
-#     extend ActiveRecord::QueryMethods
-#     extend ActiveRecord::FinderMethods
-#     extend ActiveRecord::Associations::ClassMethods
-#     extend ActiveRecord::Inheritance::ClassMethods
-#     extend ActiveRecord::ModelSchema::ClassMethods
-#     extend ActiveRecord::Transactions::ClassMethods
-#     extend ActiveRecord::Scoping::Named::ClassMethods
-#     include ActiveRecord::Persistence
-#   end

data/lib/solargraph/rails/types.yml

@@ -1,24 +0,0 @@
-ActionController::Metal#params:
-  return: ["ActionController::Parameters"]
-ActiveRecord::FinderMethods#find:
-  return: ["self", "Array<self>"]
-ActionController::Cookies#cookies:
-  return: ["ActionDispatch::Cookies::CookieJar"]
-ActionDispatch::Flash::FlashHash#now:
-  return: ["ActionDispatch::Flash::FlashNow"]
-ActiveRecord::QueryMethods#where:
-  return: ["self", "ActiveRecord::Relation", "ActiveRecord::QueryMethods::WhereChain"]
-ActiveRecord::QueryMethods#not:
-  return: ["ActiveRecord::QueryMethods::WhereChain"]
-ActiveRecord::FinderMethods#find_by:
-  return: ["self", "nil"]
-Rails.application:
-  return: ["Rails::Application"]
-ActionDispatch::Routing::RouteSet#draw:
-  yieldself: ["ActionDispatch::Routing::Mapper"]
-ActiveRecord::ConnectionAdapters::SchemaStatements#create_table:
-  yieldparam: ["ActiveRecord::ConnectionAdapters::TableDefinition"]
-ActiveRecord::ConnectionAdapters::SchemaStatements#create_join_table:
-  yieldparam: ["ActiveRecord::ConnectionAdapters::TableDefinition"]
-ActiveRecord::ConnectionAdapters::SchemaStatements#change_table:
-  yieldparam: ["ActiveRecord::ConnectionAdapters::Table"]