solargraph 0.49.0 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0b66abd5cf5a0376d5521532dda16db328592eb38bac6acd84f997b19cb328c
-  data.tar.gz: 51e038df27bae1457393c7ff023c9951b0f8919267678e29aab2e21efeb2b1a8
+  metadata.gz: 3a6e7990068e276537a53e6af24d45685d73aba32af134def16d8a66ea671f64
+  data.tar.gz: 57292437f34d43394a161fe4909eb27931d5d33e1b367276faecc7b0132525e9
 SHA512:
-  metadata.gz: 9b8310748d4754c27fd62763ce1bd8759fc43fc825b1b40353d4537130f2b6143cdb59101da679a8b4a7fb0778430eeac2eccbb845f7a9a5ac11f402b3a71461
-  data.tar.gz: 1b2f79f5396a3c056d0b2acbcb49d6c1385b02a49b33edbe1a3e452a7b451b9b87547b8b8d5974a17e25ea2f5c21db8dd315d2b3d856fb3c7ce2d300a4595c70
+  metadata.gz: 1d751b364593fa60cc51c3b9a67086c7a8006dcfe37107daaba4ca1db3f001da28eb289978d81fbe7e84c3a5c9add902417731479517be61269acd958456a057
+  data.tar.gz: 1c38faac70a696f81c5063d5ef64341a41a8d244c47c070ab557dbef8e4ca2180f5c22d5d0338c4b6f24598ea27850895bed2eab7c4d747b7bb2efeb71309eb2

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 0.50.0 - December 5, 2023
+- Remove .travis.yml as its not longer used (#627)
+- Fix empty string case when processing requires (#644)
+- Fix scope() method call on wrong object (#670)
+- Parse comments that start with multiple hashes (#667)
+- Use XDG_CACHE_HOME if it exists (#664)
+- Add rbs mention to readme (#693)
+- Remove Atom from the readme (#692)
+- Add more metadata to the gemspec (#691)
+- Do not deprecate clear command
+- Library#locate_ref returns nil for unresolved requires (#675)
+- Hide deprecated commands
+- List command
+- Fixes (or ignores) ffi crash (#676)
+- increase sleep time on cataloger (#677)
+- YardMap ignores absolute paths (#678)
+- Clarify macros vs. directives
+- Infer complex types from method calls
+- Default cache uses XDG_CACHE_HOME default (#664)
+
 ## 0.49.0 - April 9, 2023
 - Better union type handling
 - First version of RBS support

data/README.md

@@ -28,10 +28,6 @@ Plug-ins and extensions are available for the following editors:
     * Extension: https://marketplace.visualstudio.com/items?itemName=castwide.solargraph
     * GitHub: https://github.com/castwide/vscode-solargraph
 
-* **Atom**
-    * Package: https://atom.io/packages/ruby-solargraph
-    * GitHub: https://github.com/castwide/atom-solargraph
-
 * **Sublime Text**
     * Extension: https://packagecontrol.io/packages/LSP
     * GitHub: https://github.com/sublimelsp/LSP
@@ -71,6 +67,8 @@ As of version 0.33.0, Solargraph includes a [type checker](https://github.com/ca
 
 ### Updating Core Documentation
 
+As of version 0.49.0, Solargraph uses [rbs](https://github.com/ruby/rbs) for core and stdlib documentation. The following only applies to prior versions.
+
 The Solargraph gem ships with documentation for Ruby 2.2.2. You can download documentation for other Ruby versions from the command line.
 
     $ solargraph list-cores      # List the installed documentation versions

data/SPONSORS.md

@@ -7,9 +7,11 @@ The following people and organizations provide funding or other resources. [Beco
 ## Linked Sponsors
 
 - **[Calyptix Security](https://www.calyptix.com/)**
+- **[Lightward](https://lightward.com)**
 
 ## Named Sponsors
 
 - Akira Yamada
+- Jesus Castello
 - Joel Drapper
-- Yutaka Tachibana
+- Spencer

data/lib/solargraph/cache.rb

@@ -9,7 +9,9 @@ module Solargraph
       def base_dir
         # The directory is not stored in a variable so it can be overridden
         # in specs.
-        ENV['SOLARGRAPH_CACHE'] || File.join(Dir.home, '.solargraph', 'cache')
+        ENV['SOLARGRAPH_CACHE'] ||
+          ENV['XDG_CACHE_HOME'] ? File.join(ENV['XDG_CACHE_HOME'], 'solargraph') :
+          File.join(Dir.home, '.cache', 'solargraph')
       end
 
       # The working directory for the current Ruby and Solargraph versions.

data/lib/solargraph/complex_type.rb

@@ -113,7 +113,7 @@ module Solargraph
       return self unless selfy?
       red = reduce_class(dst)
       result = @items.map { |i| i.self_to red }
-      ComplexType.parse(*result.map(&:tag))
+      ComplexType.parse(*result.map(&:to_s))
     end
 
     def nullable?
@@ -169,7 +169,7 @@ module Solargraph
           paren_stack = 0
           base = String.new
           subtype_string = String.new
-          type_string.each_char do |char|
+          type_string&.each_char do |char|
             if char == '='
               #raise ComplexTypeError, "Invalid = in type #{type_string}" unless curly_stack > 0
             elsif char == '<'

data/lib/solargraph/language_server/host/cataloger.rb

@@ -34,7 +34,7 @@ module Solargraph
           Thread.new do
             until stopped?
               tick
-              sleep 0.01
+              sleep 0.1
             end
           end
         end

data/lib/solargraph/library.rb

@@ -258,6 +258,10 @@ module Solargraph
       api_map.locate_pins(location).map { |pin| pin.realize(api_map) }
     end
 
+    # Match a require reference to a file.
+    #
+    # @param location [Location]
+    # @return [Location, nil]
     def locate_ref location
       map = source_map_hash[location.filename]
       return if map.nil?
@@ -268,7 +272,7 @@ module Solargraph
         next unless source_map_hash.key?(full)
         return Location.new(full, Solargraph::Range.from_to(0, 0, 0, 0))
       end
-      # api_map.yard_map.require_reference(pin.name)
+      nil
     rescue FileNotFoundError
       nil
     end

data/lib/solargraph/pin/base_variable.rb

@@ -56,7 +56,7 @@ module Solargraph
           end
         end
         return ComplexType::UNDEFINED if types.empty?
-        ComplexType.try_parse(*types.map(&:tag))
+        ComplexType.try_parse(*types.map(&:to_s))
       end
 
       def == other

data/lib/solargraph/shell.rb

@@ -71,7 +71,7 @@ module Solargraph
       STDOUT.puts "Configuration file initialized."
     end
 
-    desc 'download-core [VERSION]', 'Download core documentation [deprecated]'
+    desc 'download-core [VERSION]', 'Download core documentation [deprecated]', hide: true
     long_desc %(
       The `download-core` command is deprecated. Current versions of Solargraph
       use RBS for core and stdlib documentation.
@@ -82,7 +82,7 @@ module Solargraph
       puts 'Current versions of Solargraph use RBS for core and stdlib documentation.'
     end
 
-    desc 'list-cores', 'List the local documentation versions [deprecated]'
+    desc 'list-cores', 'List the local documentation versions [deprecated]', hide: true
     long_desc %(
       The `list-cores` command is deprecated. Current versions of Solargraph use
       RBS for core and stdlib documentation.
@@ -93,7 +93,7 @@ module Solargraph
       puts 'Current versions of Solargraph use RBS for core and stdlib documentation.'
     end
 
-    desc 'available-cores', 'List available documentation versions [deprecated]'
+    desc 'available-cores', 'List available documentation versions [deprecated]', hide: true
     long_desc %(
       The `available-cores` command is deprecated. Current versions of Solargraph
       use RBS for core and stdlib documentation.
@@ -108,7 +108,6 @@ module Solargraph
     long_desc %(
       This command will delete all core and gem documentation from the cache.
     )
-    # @deprecated
     def clear
       puts "Deleting the cached documentation"
       Solargraph::Cache.clear
@@ -195,7 +194,18 @@ module Solargraph
       puts "Scanned #{directory} (#{api_map.pins.length} pins) in #{time.real} seconds."
     end
 
-    desc 'bundle', 'Generate documentation for bundled gems [deprecated]'
+    desc 'list', 'List the files in the workspace and the total count'
+    option :count, type: :boolean, aliases: :c, desc: 'Display the file count only', default: false
+    option :directory, type: :string, aliases: :d, desc: 'The directory to read', default: '.'
+    def list
+      workspace = Solargraph::Workspace.new(options[:directory])
+      unless options[:count]
+        workspace.filenames.each { |f| puts f }
+      end
+      puts "#{workspace.filenames.length} files total."
+    end
+
+    desc 'bundle', 'Generate documentation for bundled gems [deprecated]', hide: true
     long_desc %(
       The `bundle` command is deprecated. Solargraph currently uses RBS instead.
     )
@@ -205,7 +215,7 @@ module Solargraph
       puts 'The `bundle` command is deprecated. Solargraph currently uses RBS instead.'
     end
 
-    desc 'rdoc GEM [VERSION]', 'Use RDoc to cache documentation [deprecated]'
+    desc 'rdoc GEM [VERSION]', 'Use RDoc to cache documentation [deprecated]', hide: true
     long_desc %(
       The `rdoc` command is deprecated. Solargraph currently uses RBS instead.
     )

data/lib/solargraph/source/chain/call.rb

@@ -199,7 +199,7 @@ module Solargraph
         # @param name_pin [Pin::Base]
         # @return [Array<Pin::Base>]
         def super_pins api_map, name_pin
-          pins = api_map.get_method_stack(name_pin.namespace, name_pin.name, scope: name_pin.scope)
+          pins = api_map.get_method_stack(name_pin.namespace, name_pin.name, scope: name_pin.context.scope)
           pins.reject{|p| p.path == name_pin.path}
         end
 

data/lib/solargraph/source/chain.rb

@@ -162,7 +162,7 @@ module Solargraph
           sorted = possibles.map { |t| t.rooted? ? "::#{t}" : t.to_s }.sort { |a, _| a == 'nil' ? 1 : 0 }
           ComplexType.parse(*sorted)
         else
-          possibles.first
+          ComplexType.parse(possibles.map(&:to_s).join(', '))
         end
         return type if context.nil? || context.return_type.undefined?
         type.self_to(context.return_type.namespace)

data/lib/solargraph/source_map/mapper.rb

@@ -12,7 +12,7 @@ module Solargraph
 
       private_class_method :new
 
-      MACRO_REGEXP = /(@\!method|@\!attribute|@\!visibility|@\!domain|@\!macro|@\!parse|@\!override)/.freeze
+      DIRECTIVE_REGEXP = /(@\!method|@\!attribute|@\!visibility|@\!domain|@\!macro|@\!parse|@\!override)/.freeze
 
       # Generate the data.
       #
@@ -65,7 +65,7 @@ module Solargraph
       end
 
       def process_comment source_position, comment_position, comment
-        return unless comment.encode('UTF-8', invalid: :replace, replace: '?') =~ MACRO_REGEXP
+        return unless comment.encode('UTF-8', invalid: :replace, replace: '?') =~ DIRECTIVE_REGEXP
         cmnt = remove_inline_comment_hashes(comment)
         parse = Solargraph::Source.parse_docstring(cmnt)
         last_line = 0
@@ -198,6 +198,8 @@ module Solargraph
           namespace.domains.concat directive.tag.types unless directive.tag.types.nil?
         when 'override'
           pins.push Pin::Reference::Override.new(location, directive.tag.name, docstring.tags)
+        when 'macro'
+          # @todo Handle macros
         end
       end
 
@@ -211,7 +213,7 @@ module Solargraph
         started = false
         comment.lines.each { |l|
           # Trim the comment and minimum leading whitespace
-          p = l.encode('UTF-8', invalid: :replace, replace: '?').gsub(/^#/, '')
+          p = l.encode('UTF-8', invalid: :replace, replace: '?').gsub(/^#+/, '')
           if num.nil? && !p.strip.empty?
             num = p.index(/[^ ]/)
             started = true
@@ -226,7 +228,7 @@ module Solargraph
 
       # @return [void]
       def process_comment_directives
-        return unless @code.encode('UTF-8', invalid: :replace, replace: '?') =~ MACRO_REGEXP
+        return unless @code.encode('UTF-8', invalid: :replace, replace: '?') =~ DIRECTIVE_REGEXP
         code_lines = @code.lines
         @source.associated_comments.each do |line, comments|
           src_pos = line ? Position.new(line, code_lines[line].to_s.chomp.index(/[^\s]/) || 0) : Position.new(code_lines.length, 0)

data/lib/solargraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Solargraph
-  VERSION = '0.49.0'
+  VERSION = '0.50.0'
 end

data/lib/solargraph/yard_map.rb

@@ -219,8 +219,8 @@ module Solargraph
     def pins_for_require r, already_errored
       result = []
       begin
-        name = r.split('/').first
-        return [] if @source_gems.include?(name) || @gem_paths.key?(name)
+        name = r.split('/').first.to_s
+        return [] if name.empty? || @source_gems.include?(name) || @gem_paths.key?(name)
         spec = spec_for_require(name)
         @gem_paths[name] = spec.full_gem_path
 
@@ -282,7 +282,7 @@ module Solargraph
     # @param path [String]
     # @return [Gem::Specification]
     def spec_for_require path
-      name = path.split('/').first
+      name = path.split('/').first.to_s
       spec = Gem::Specification.find_by_name(name, @gemset[name])
 
       # Avoid loading the spec again if it's going to be skipped anyway

data/solargraph.gemspec

@@ -16,7 +16,10 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://solargraph.org'
   s.license     = 'MIT'
   s.executables = ['solargraph']
-  s.metadata["funding_uri"] = "https://www.patreon.com/castwide"
+  s.metadata["funding_uri"]     = "https://www.patreon.com/castwide"
+  s.metadata["bug_tracker_uri"] = "https://github.com/castwide/solargraph/issues"
+  s.metadata["changelog_uri"]   = "https://github.com/castwide/solargraph/blob/master/CHANGELOG.md"
+  s.metadata["source_code_uri"] = "https://github.com/castwide/solargraph"
 
   s.required_ruby_version = '>= 2.6'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.49.0
+  version: 0.50.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-09 00:00:00.000000000 Z
+date: 2023-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -307,7 +307,6 @@ files:
 - ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -566,6 +565,9 @@ licenses:
 - MIT
 metadata:
   funding_uri: https://www.patreon.com/castwide
+  bug_tracker_uri: https://github.com/castwide/solargraph/issues
+  changelog_uri: https://github.com/castwide/solargraph/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/castwide/solargraph
 post_install_message:
 rdoc_options: []
 require_paths:

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0
-  - jruby-head
-matrix:
-  include:
-    - rvm: 2.7
-      os: osx
-  allow_failures:
-    - rvm: jruby-head
-before_install:
-- gem update --system
-- gem install bundler
-before_script: yard gems
-script: rspec