solargraph 0.54.4 → 0.58.3

data/lib/solargraph/version.rb

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

data/lib/solargraph/views/_method.erb

@@ -2,33 +2,33 @@
     Namespace:
 </h2>
 <p>
-    <a href="solargraph:/document?query=<%= CGI.escape object.namespace.path %>"><%= object.namespace %></a>
+    <a href="solargraph:/document?query=<%= CGI.escape pin.namespace.path %>"><%= pin.namespace %></a>
 </p>
 <h2>
     Overview:
 </h2>
-<%= htmlify object.docstring %>
+<%= htmlify pin.docstring %>
 <p class="document-section">
-    <big><strong>Visibility:</strong></big> <%= object.visibility %>
+    <big><strong>Visibility:</strong></big> <%= pin.visibility %>
 </p>
-<% unless object.tags(:param).empty? %>
+<% unless pin.docstring.tags(:param).empty? %>
     <h2>
         Parameters:
     </h2>
     <ul>
-        <% object.tags(:param).each do |tag| %>
+        <% pin.docstring.tags(:param).each do |tag| %>
             <li>
                 <%= erb :_name_type_tag, layout: false, locals: {tag: tag} %>
             </li>
         <% end %>
     </ul>
 <% end %>
-<% unless object.tags(:raise).empty? %>
+<% unless pin.docstring.tags(:raise).empty? %>
 <h2>
     Raises:
 </h2>
 <ul>
-    <% object.tags(:raise).each do |tag| %>
+    <% pin.docstring.tags(:raise).each do |tag| %>
         <li>
             <%= erb :_name_type_tag, layout: false, locals: {tag: tag} %>
         </li>
@@ -38,20 +38,20 @@
 <h2>
     Returns:
 </h2>
-<% if object.tag(:return).nil? %>
+<% if pin.docstring.tag(:return).nil? %>
     <p>
         Undefined/unknown
     </p>
 <% else %>
     <ul>
-        <% object.tags(:return).each do |tag| %>
+        <% pin.tags(:return).each do |tag| %>
             <li>
                 <%= erb :_name_type_tag, layout: false, locals: {tag: tag} %>
             </li>
         <% end %>
     </ul>
 <% end %>
-<% examples = object.tags(:example) %>
+<% examples = pin.docstring.tags(:example) %>
 <% unless examples.nil? %>
     <% examples.each do |example| %>
         <h2>

data/lib/solargraph/views/_namespace.erb

@@ -1,12 +1,12 @@
 <h2>
     Overview:
 </h2>
-<%= htmlify object.docstring %>
+<%= htmlify pin.docstring %>
 <h2>
     Class Methods
 </h2>
 <ul class="doc-list">
-    <% object.meths(scope: :class).sort{|a, b| a.name <=> b.name}.each do |meth| %>
+    <% api_map.get_methods(pin.path, scope: :class, deep: false).sort{|a, b| a.name <=> b.name}.each do |meth| %>
         <li>
             <a href="solargraph:/document?query=<%= CGI.escape(meth.path) %>"><%= meth.name %></a>
         </li>
@@ -16,7 +16,7 @@
     Instance Methods
 </h2>
 <ul class="doc-list">
-    <% object.meths(scope: :instance).sort{|a, b| a.name <=> b.name}.each do |meth| %>
+    <% api_map.get_methods(pin.path, scope: :instance, deep: false).sort{|a, b| a.name <=> b.name}.each do |meth| %>
         <li>
             <a href="solargraph:/document?query=<%= CGI.escape(meth.path) %>"><%= meth.name %></a>
         </li>

data/lib/solargraph/views/document.erb

@@ -1,23 +1,23 @@
-<% objects.reverse.each do |object| %>
+<% pins.each do |pin| %>
     <h1>
-        <%= object.name %>
-        <% if object.is_a?(YARD::CodeObjects::MethodObject) and !object.parameters.empty? %>
-            <small>(<%= object.parameters.map {|p| "#{p[0]}#{p[1] and p[0].end_with?(':') ? ' ' : (p[1] ? ' = ' : '')}#{p[1]}"}.join(', ') %>)</small>
+        <%= pin.name %>
+        <% if pin.is_a?(Solargraph::Pin::Method) && !pin.parameters.empty? %>
+            <small>(<%= pin.parameters.map {|p| "#{p[0]}#{p[1] and p[0].end_with?(':') ? ' ' : (p[1] ? ' = ' : '')}#{p[1]}"}.join(', ') %>)</small>
         <% end %>
     </h1>
-    <% unless object.files.empty? %>
+    <% unless pins.map(&:location).compact.empty? %>
         <h2>
             Defined in:
         </h2>
         <ul>
-            <% object.files.each do |f| %>
+            <% pins.map(&:location).compact.map(&:filename).each do |f| %>
                 <li><%= f %></li>
             <% end %>
         </ul>
     <% end %>
-    <% if object.is_a?(YARD::CodeObjects::NamespaceObject) %>
-        <%= erb :_namespace, layout: false, locals: {object: object} %>
-    <% elsif object.is_a?(YARD::CodeObjects::MethodObject) %>
-        <%= erb :_method, layout: false, locals: {object: object} %>
+    <% if pin.is_a?(Solargraph::Pin::Namespace) %>
+        <%= erb :_namespace, layout: false, locals: {api_map: api_map, pin: pin} %>
+    <% elsif pin.is_a?(Solargraph::Pin::Method) %>
+        <%= erb :_method, layout: false, locals: {api_map: api_map, pin: pin} %>
     <% end %>
 <% end %>

data/lib/solargraph/workspace/config.rb

@@ -1,239 +1,255 @@
-# frozen_string_literal: true
-
-require 'yaml'
-
-module Solargraph
-  class Workspace
-    # Configuration data for a workspace.
-    #
-    class Config
-      # The maximum number of files that can be added to a workspace.
-      # The workspace's .solargraph.yml can override this value.
-      MAX_FILES = 5000
-
-      # @return [String]
-      attr_reader :directory
-
-      # @todo To make this strongly typed we'll need a record syntax
-      # @return [Hash{String => Array, Hash, Integer, nil}]
-      attr_reader :raw_data
-
-      # @param directory [String]
-      def initialize directory = ''
-        @directory = File.absolute_path(directory)
-        @raw_data = config_data
-        included
-        excluded
-      end
-
-      # An array of files included in the workspace (before calculating excluded files).
-      #
-      # @return [Array<String>]
-      def included
-        return [] if directory.empty? || directory == '*'
-        @included ||= process_globs(@raw_data['include'])
-      end
-
-      # An array of files excluded from the workspace.
-      #
-      # @return [Array<String>]
-      def excluded
-        return [] if directory.empty? || directory == '*'
-        @excluded ||= process_exclusions(@raw_data['exclude'])
-      end
-
-      # @param filename [String]
-      def allow? filename
-        filename = File.absolute_path(filename, directory)
-        filename.start_with?(directory) &&
-          !excluded.include?(filename) &&
-          excluded_directories.none? { |d| filename.start_with?(d) }
-      end
-
-      # The calculated array of (included - excluded) files in the workspace.
-      #
-      # @return [Array<String>]
-      def calculated
-        Solargraph.logger.info "Indexing workspace files in #{directory}" unless @calculated || directory.empty? || directory == '*'
-        @calculated ||= included - excluded
-      end
-
-      # An array of domains configured for the workspace.
-      # A domain is a namespace that the ApiMap should include in the global
-      # namespace. It's typically used to identify available DSLs.
-      #
-      # @return [Array<String>]
-      def domains
-        raw_data['domains']
-      end
-
-      # An array of required paths to add to the workspace.
-      #
-      # @return [Array<String>]
-      def required
-        raw_data['require']
-      end
-
-      # An array of load paths for required paths.
-      #
-      # @return [Array<String>]
-      def require_paths
-        raw_data['require_paths'] || []
-      end
-
-      # An array of reporters to use for diagnostics.
-      #
-      # @return [Array<String>]
-      def reporters
-        raw_data['reporters']
-      end
-
-      # A hash of options supported by the formatter
-      #
-      # @sg-ignore pending https://github.com/castwide/solargraph/pull/905
-      # @return [Hash]
-      def formatter
-        raw_data['formatter']
-      end
-
-      # An array of plugins to require.
-      #
-      # @return [Array<String>]
-      def plugins
-        raw_data['plugins']
-      end
-
-      # The maximum number of files to parse from the workspace.
-      #
-      # @sg-ignore pending https://github.com/castwide/solargraph/pull/905
-      # @return [Integer]
-      def max_files
-        raw_data['max_files']
-      end
-
-      private
-
-      # @return [String]
-      def global_config_path
-        ENV['SOLARGRAPH_GLOBAL_CONFIG'] ||
-          File.join(Dir.home, '.config', 'solargraph', 'config.yml')
-      end
-
-      # @return [String]
-      def workspace_config_path
-        return '' if @directory.empty?
-        File.join(@directory, '.solargraph.yml')
-      end
-
-      # @return [Hash{String => Array<undefined>, Hash{String => undefined}, Integer}]
-      def config_data
-        workspace_config = read_config(workspace_config_path)
-        global_config = read_config(global_config_path)
-
-        defaults = default_config
-        defaults.merge({'exclude' => []}) unless workspace_config.nil?
-
-        defaults
-          .merge(global_config || {})
-          .merge(workspace_config || {})
-      end
-
-      # Read a .solargraph yaml config
-      #
-      # @param config_path [String]
-      # @return [Hash{String => Array, Hash, Integer}, nil]
-      def read_config config_path = ''
-        return nil if config_path.empty?
-        return nil unless File.file?(config_path)
-        YAML.safe_load(File.read(config_path))
-      end
-
-      # @return [Hash{String => Array, Hash, Integer}]
-      def default_config
-        {
-          'include' => ['**/*.rb'],
-          'exclude' => ['spec/**/*', 'test/**/*', 'vendor/**/*', '.bundle/**/*'],
-          'require' => [],
-          'domains' => [],
-          'reporters' => %w[rubocop require_not_found],
-          'formatter' => {
-            'rubocop' => {
-              'cops' => 'safe',
-              'except' => [],
-              'only' => [],
-              'extra_args' =>[]
-            }
-          },
-          'require_paths' => [],
-          'plugins' => [],
-          'max_files' => MAX_FILES
-        }
-      end
-
-      # Get an array of files from the provided globs.
-      #
-      # @param globs [Array<String>]
-      # @return [Array<String>]
-      def process_globs globs
-        result = globs.flat_map do |glob|
-          Dir[File.absolute_path(glob, directory)]
-            .map{ |f| f.gsub(/\\/, '/') }
-            .select { |f| File.file?(f) }
-        end
-        result
-      end
-
-      # Modify the included files based on excluded directories and get an
-      # array of additional files to exclude.
-      #
-      # @param globs [Array<String>]
-      # @return [Array<String>]
-      def process_exclusions globs
-        remainder = globs.select do |glob|
-          if glob_is_directory?(glob)
-            exdir = File.absolute_path(glob_to_directory(glob), directory)
-            included.delete_if { |file| file.start_with?(exdir) }
-            false
-          else
-            true
-          end
-        end
-        process_globs remainder
-      end
-
-      # True if the glob translates to a whole directory.
-      #
-      # @example
-      #   glob_is_directory?('path/to/dir')       # => true
-      #   glob_is_directory?('path/to/dir/**/*)   # => true
-      #   glob_is_directory?('path/to/file.txt')  # => false
-      #   glob_is_directory?('path/to/*.txt')     # => false
-      #
-      # @param glob [String]
-      # @return [Boolean]
-      def glob_is_directory? glob
-        File.directory?(glob) || File.directory?(glob_to_directory(glob))
-      end
-
-      # Translate a glob to a base directory if applicable
-      #
-      # @example
-      #   glob_to_directory('path/to/dir/**/*') # => 'path/to/dir'
-      #
-      # @param glob [String]
-      # @return [String]
-      def glob_to_directory glob
-        glob.gsub(/(\/\*|\/\*\*\/\*\*?)$/, '')
-      end
-
-      # @return [Array<String>]
-      def excluded_directories
-        # @type [Array<String>]
-        excluded = @raw_data['exclude']
-        excluded
-          .select { |g| glob_is_directory?(g) }
-          .map { |g| File.absolute_path(glob_to_directory(g), directory) }
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Solargraph
+  class Workspace
+    # Configuration data for a workspace.
+    #
+    class Config
+      # The maximum number of files that can be added to a workspace.
+      # The workspace's .solargraph.yml can override this value.
+      MAX_FILES = 5000
+
+      # @return [String]
+      attr_reader :directory
+
+      # @todo To make JSON strongly typed we'll need a record syntax
+      # @return [Hash{String => undefined, nil}]
+      attr_reader :raw_data
+
+      # @param directory [String]
+      def initialize directory = ''
+        @directory = File.absolute_path(directory)
+        @raw_data = config_data
+        included
+        excluded
+      end
+
+      # An array of files included in the workspace (before calculating excluded files).
+      #
+      # @return [Array<String>]
+      def included
+        return [] if directory.empty? || directory == '*'
+        @included ||= process_globs(@raw_data['include'])
+      end
+
+      # An array of files excluded from the workspace.
+      #
+      # @return [Array<String>]
+      def excluded
+        return [] if directory.empty? || directory == '*'
+        @excluded ||= process_exclusions(@raw_data['exclude'])
+      end
+
+      # @param filename [String]
+      def allow? filename
+        filename = File.absolute_path(filename, directory)
+        filename.start_with?(directory) &&
+          !excluded.include?(filename) &&
+          excluded_directories.none? { |d| filename.start_with?(d) }
+      end
+
+      # The calculated array of (included - excluded) files in the workspace.
+      #
+      # @return [Array<String>]
+      def calculated
+        Solargraph.logger.info "Indexing workspace files in #{directory}" unless @calculated || directory.empty? || directory == '*'
+        @calculated ||= included - excluded
+      end
+
+      # An array of domains configured for the workspace.
+      # A domain is a namespace that the ApiMap should include in the global
+      # namespace. It's typically used to identify available DSLs.
+      #
+      # @return [Array<String>]
+      # @sg-ignore Need to validate config
+      def domains
+        raw_data['domains']
+      end
+
+      # An array of required paths to add to the workspace.
+      #
+      # @return [Array<String>]
+      # @sg-ignore Need to validate config
+      def required
+        raw_data['require']
+      end
+
+      # An array of load paths for required paths.
+      #
+      # @return [Array<String>]
+      def require_paths
+        raw_data['require_paths'] || []
+      end
+
+      # An array of reporters to use for diagnostics.
+      #
+      # @sg-ignore Need to validate config
+      # @return [Array<String>]
+      def reporters
+        raw_data['reporters']
+      end
+
+      # A hash of options supported by the formatter
+      #
+      # @sg-ignore Need to validate config
+      # @return [Hash]
+      def formatter
+        raw_data['formatter']
+      end
+
+      # An array of plugins to require.
+      #
+      # @sg-ignore Need to validate config
+      # @return [Array<String>]
+      def plugins
+        raw_data['plugins']
+      end
+
+      # The maximum number of files to parse from the workspace.
+      #
+      # @sg-ignore Need to validate config
+      # @return [Integer]
+      def max_files
+        raw_data['max_files']
+      end
+
+      # @return [Hash{Symbol => Symbol}]
+      def type_checker_rules
+        # @type [Hash{String => String}]
+        raw_rules = raw_data.fetch('type_checker', {}).fetch('rules', {})
+        raw_rules.to_h do |k, v|
+          [k.to_sym, v.to_sym]
+        end
+      end
+
+      private
+
+      # @return [String]
+      def global_config_path
+        ENV['SOLARGRAPH_GLOBAL_CONFIG'] ||
+          File.join(Dir.home, '.config', 'solargraph', 'config.yml')
+      end
+
+      # @return [String]
+      def workspace_config_path
+        return '' if @directory.empty?
+        File.join(@directory, '.solargraph.yml')
+      end
+
+      # @return [Hash{String => undefined}]
+      def config_data
+        workspace_config = read_config(workspace_config_path)
+        global_config = read_config(global_config_path)
+
+        defaults = default_config
+        defaults.merge({'exclude' => []}) unless workspace_config.nil?
+
+        defaults
+          .merge(global_config || {})
+          .merge(workspace_config || {})
+      end
+
+      # Read a .solargraph yaml config
+      #
+      # @param config_path [String]
+      # @return [Hash{String => Array, Hash, Integer}, nil]
+      def read_config config_path = ''
+        return nil if config_path.empty?
+        return nil unless File.file?(config_path)
+        YAML.safe_load(File.read(config_path))
+      end
+
+      # @return [Hash{String => Array, Hash, Integer}]
+      def default_config
+        {
+          'include' => ['Rakefile', 'Gemfile', '*.gemspec', '**/*.rb'],
+          'exclude' => ['spec/**/*', 'test/**/*', 'vendor/**/*', '.bundle/**/*'],
+          'require' => [],
+          'domains' => [],
+          'reporters' => %w[rubocop require_not_found],
+          'formatter' => {
+            'rubocop' => {
+              'cops' => 'safe',
+              'except' => [],
+              'only' => [],
+              'extra_args' =>[]
+            }
+          },
+          'type_checker' => {
+            'rules' => { }
+          },
+          'require_paths' => [],
+          'plugins' => [],
+          'max_files' => MAX_FILES
+        }
+      end
+
+      # Get an array of files from the provided globs.
+      #
+      # @param globs [Array<String>]
+      # @return [Array<String>]
+      def process_globs globs
+        result = globs.flat_map do |glob|
+          Dir[File.absolute_path(glob, directory)]
+            .map{ |f| f.gsub(/\\/, '/') }
+            .select { |f| File.file?(f) }
+        end
+        result
+      end
+
+      # Modify the included files based on excluded directories and get an
+      # array of additional files to exclude.
+      #
+      # @param globs [Array<String>]
+      # @return [Array<String>]
+      def process_exclusions globs
+        remainder = globs.select do |glob|
+          if glob_is_directory?(glob)
+            exdir = File.absolute_path(glob_to_directory(glob), directory)
+            included.delete_if { |file| file.start_with?(exdir) }
+            false
+          else
+            true
+          end
+        end
+        process_globs remainder
+      end
+
+      # True if the glob translates to a whole directory.
+      #
+      # @example
+      #   glob_is_directory?('path/to/dir')       # => true
+      #   glob_is_directory?('path/to/dir/**/*)   # => true
+      #   glob_is_directory?('path/to/file.txt')  # => false
+      #   glob_is_directory?('path/to/*.txt')     # => false
+      #
+      # @param glob [String]
+      # @return [Boolean]
+      def glob_is_directory? glob
+        File.directory?(glob) || File.directory?(glob_to_directory(glob))
+      end
+
+      # Translate a glob to a base directory if applicable
+      #
+      # @example
+      #   glob_to_directory('path/to/dir/**/*') # => 'path/to/dir'
+      #
+      # @param glob [String]
+      # @return [String]
+      def glob_to_directory glob
+        glob.gsub(/(\/\*|\/\*\*\/\*\*?)$/, '')
+      end
+
+      # @return [Array<String>]
+      def excluded_directories
+        # @type [Array<String>]
+        excluded = @raw_data['exclude']
+        excluded
+          .select { |g| glob_is_directory?(g) }
+          .map { |g| File.absolute_path(glob_to_directory(g), directory) }
+      end
+    end
+  end
+end