jimeh-solargraph 0.40.4.0

data/lib/solargraph/type_checker/checks.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class TypeChecker
+    # Helper methods for performing type checks
+    #
+    module Checks
+      module_function
+
+      # Compare an expected type with an inferred type. Common usage is to
+      # check if the type declared in a method's @return tag matches the type
+      # inferred from static analysis of the code.
+      #
+      # @param api_map [ApiMap]
+      # @param expected [ComplexType]
+      # @param inferred [ComplexType]
+      # @return [Boolean]
+      def types_match? api_map, expected, inferred
+        return true if expected.to_s == inferred.to_s
+        matches = []
+        expected.each do |exp|
+          found = false
+          inferred.each do |inf|
+            # if api_map.super_and_sub?(fuzz(inf), fuzz(exp))
+            if either_way?(api_map, inf, exp)
+              found = true
+              matches.push inf
+              break
+            end
+          end
+          return false unless found
+        end
+        inferred.each do |inf|
+          next if matches.include?(inf)
+          found = false
+          expected.each do |exp|
+            # if api_map.super_and_sub?(fuzz(inf), fuzz(exp))
+            if either_way?(api_map, inf, exp)
+              found = true
+              break
+            end
+          end
+          return false unless found
+        end
+        true
+      end
+
+      # @param api_map [ApiMap]
+      # @param expected [ComplexType]
+      # @param inferred [ComplexType]
+      # @return [Boolean]
+      def any_types_match? api_map, expected, inferred
+        return duck_types_match?(api_map, expected, inferred) if expected.duck_type?
+        expected.each do |exp|
+          next if exp.duck_type?
+          inferred.each do |inf|
+            # return true if exp == inf || api_map.super_and_sub?(fuzz(inf), fuzz(exp))
+            return true if exp == inf || either_way?(api_map, inf, exp)
+          end
+        end
+        false
+      end
+
+      # @param api_map [ApiMap]
+      # @param expected [ComplexType]
+      # @param inferred [ComplexType]
+      # @return [Boolean]
+      def duck_types_match? api_map, expected, inferred
+        raise ArgumentError, 'Expected type must be duck type' unless expected.duck_type?
+        expected.each do |exp|
+          next unless exp.duck_type?
+          quack = exp.to_s[1..-1]
+          return false if api_map.get_method_stack(inferred.namespace, quack, scope: inferred.scope).empty?
+        end
+        true
+      end
+
+      # @param type [ComplexType]
+      # @return [String]
+      def fuzz type
+        if type.parameters?
+          type.name
+        else
+          type.tag
+        end
+      end
+
+      # @param api_map [ApiMap]
+      # @param cls1 [ComplexType]
+      # @param cls2 [ComplexType]
+      # @return [Boolean]
+      def either_way?(api_map, cls1, cls2)
+        f1 = fuzz(cls1)
+        f2 = fuzz(cls2)
+        api_map.super_and_sub?(f1, f2) || api_map.super_and_sub?(f2, f1)
+      end
+    end
+  end
+end

data/lib/solargraph/type_checker/param_def.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class TypeChecker
+    # Data about a method parameter definition. This is the information from
+    # the args list in the def call, not the `@param` tags.
+    #
+    class ParamDef
+      # @return [String]
+      attr_reader :name
+
+      # @return [Symbol]
+      attr_reader :type
+
+      def initialize name, type
+        @name = name
+        @type = type
+      end
+
+      class << self
+        # Get an array of ParamDefs from a method pin.
+        #
+        # @param pin [Solargraph::Pin::Method]
+        # @return [Array<ParamDef>]
+        def from pin
+          result = []
+          pin.parameters.each do |par|
+            result.push ParamDef.new(par.name, par.decl)
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/type_checker/problem.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class TypeChecker
+    # A problem reported by TypeChecker.
+    #
+    class Problem
+      # @return [Solargraph::Location]
+      attr_reader :location
+
+      # @return [String]
+      attr_reader :message
+
+      # @return [Pin::Base]
+      attr_reader :pin
+
+      # @return [String, nil]
+      attr_reader :suggestion
+
+      # @param location [Solargraph::Location]
+      # @param message [String]
+      # @param pin [Solargraph::Pin::Base, nil]
+      # @param suggestion [String, nil]
+      def initialize location, message, pin: nil, suggestion: nil
+        @location = location
+        @message = message
+        @pin = pin
+        @suggestion = suggestion
+      end
+    end
+  end
+end

data/lib/solargraph/type_checker/rules.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class TypeChecker
+    # Definitions of type checking rules to be performed at various levels
+    #
+    class Rules
+      LEVELS = {
+        normal: 0,
+        typed: 1,
+        strict: 2,
+        strong: 3
+      }.freeze
+
+      # @return [Symbol]
+      attr_reader :level
+
+      # @return [Integer]
+      attr_reader :rank
+
+      # @param level [Symbol]
+      def initialize level
+        @rank = if LEVELS.key?(level)
+          LEVELS[level]
+        else
+          Solargraph.logger.warn "Unrecognized TypeChecker level #{level}, assuming normal"
+          0
+        end
+        @level = LEVELS[LEVELS.values.index(@rank)]
+      end
+
+      def ignore_all_undefined?
+        rank < LEVELS[:strict]
+      end
+
+      def validate_consts?
+        rank >= LEVELS[:strict]
+      end
+
+      def validate_calls?
+        rank >= LEVELS[:strict]
+      end
+
+      def require_type_tags?
+        rank >= LEVELS[:strong]
+      end
+
+      def must_tag_or_infer?
+        rank > LEVELS[:typed]
+      end
+
+      def validate_tags?
+        rank > LEVELS[:normal]
+      end
+    end
+  end
+end

data/lib/solargraph/version.rb

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

data/lib/solargraph/views/_method.erb

@@ -0,0 +1,62 @@
+<h2>
+    Namespace:
+</h2>
+<p>
+    <a href="command:solargraph._openDocument?<%= CGI.escape "\"solargraph:/document?query=#{object.namespace}\"" %>"><%= object.namespace %></a>
+</p>
+<h2>
+    Overview:
+</h2>
+<%= htmlify object.docstring %>
+<p class="document-section">
+    <big><strong>Visibility:</strong></big> <%= object.visibility %>
+</p>
+<% unless object.tags(:param).empty? %>
+    <h2>
+        Parameters:
+    </h2>
+    <ul>
+        <% object.tags(:param).each do |tag| %>
+            <li>
+                <%= erb :_name_type_tag, layout: false, locals: {tag: tag} %>
+            </li>
+        <% end %>
+    </ul>
+<% end %>
+<% unless object.tags(:raise).empty? %>
+<h2>
+    Raises:
+</h2>
+<ul>
+    <% object.tags(:raise).each do |tag| %>
+        <li>
+            <%= erb :_name_type_tag, layout: false, locals: {tag: tag} %>
+        </li>
+    <% end %>
+</ul>
+<% end %>
+<h2>
+    Returns:
+</h2>
+<% if object.tag(:return).nil? %>
+    <p>
+        Undefined/unknown
+    </p>
+<% else %>
+    <ul>
+        <% object.tags(:return).each do |tag| %>
+            <li>
+                <%= erb :_name_type_tag, layout: false, locals: {tag: tag} %>
+            </li>
+        <% end %>
+    </ul>
+<% end %>
+<% examples = object.tags(:example) %>
+<% unless examples.nil? %>
+    <% examples.each do |example| %>
+        <h2>
+            Example: <%= example.name %>
+        </h2>
+        <%= ruby_to_html example.text.strip %>
+    <% end %>
+<% end %>

data/lib/solargraph/views/_name_type_tag.erb

@@ -0,0 +1,10 @@
+<%= tag.name %>
+<% unless tag.types.nil? or tag.types.empty? %>
+	[<%= escape(tag.types.join(', ')) %>]
+<% end %>
+<% unless tag.text.nil? || tag.text.empty? %>
+	<% unless (tag.name.nil? or tag.name.empty?) and (tag.types.nil? or tag.types.empty?) %>
+		-
+	<% end %>
+	<%= tag.text %>
+<% end %>

data/lib/solargraph/views/_namespace.erb

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

data/lib/solargraph/views/document.erb

@@ -0,0 +1,23 @@
+<% objects.reverse.each do |object| %>
+    <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>
+        <% end %>
+    </h1>
+    <% unless object.files.empty? %>
+        <h2>
+            Defined in:
+        </h2>
+        <ul>
+            <% object.files.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} %>
+    <% end %>
+<% end %>

data/lib/solargraph/views/environment.erb

@@ -0,0 +1,58 @@
+<html>
+  <head>
+    <title>Solargraph Environment</title>
+  </head>
+  <h1>
+    Solargraph Environment Info
+  </h1>
+  <h2>
+    System
+  </h2>
+  <ul>
+    <li>
+      Platform: <%= RUBY_PLATFORM %>
+    </li>
+    <li>
+      Shell: <%= ENV['SHELL'] %>
+    </li>
+    <li>
+      Ruby Version: <%= RUBY_VERSION %>
+    </li>
+    <li>
+      RuboCop Version: <%= RuboCop::Version::STRING %>
+    </li>
+  </ul>
+  <h2>
+    Solargraph
+  </h2>
+  <ul>
+    <li>
+      Solargraph Version: <%= Solargraph::VERSION %>
+    </li>
+    <li>
+      Core Documentation Version: <%= Solargraph::YardMap::CoreDocs.best_match %>
+    </li>
+    <li>
+      Core Cache Directory: <%= Solargraph::YardMap::CoreDocs.cache_dir %>
+    </li>
+    <% unless Solargraph::Parser.rubyvm? %>
+      <li>
+        Parser Target Version: <%= Solargraph::Parser.version %>
+      </li>
+    <% end %>
+    <li>
+      Using Bundler: <%= ENV.key?('BUNDLE_BIN_PATH') %>
+    </li>
+  </ul>
+  <h2>
+    Project
+  </h2>
+  <ul>
+    <li>
+      Config: <%= config %>
+    </li>
+    <li>
+      Workspace folders: <%= folders %>
+    </li>
+  </ul>
+</html>

data/lib/solargraph/views/layout.erb

@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>Solargraph</title>
+        <style>
+            a {
+                color: inherit;
+                text-decoration: underline;
+            }
+            h2 {
+                font-size: 110%;
+                margin: 1.5em 0 1em 0;
+            }
+            big {
+                font-size: 110%;
+            }
+            pre {
+                margin: 1em;
+                padding: 0.5em;
+                overflow: auto;
+                border: 1px solid gray;
+            }
+            ul.doc-list {
+                margin: 1em 0 1em 0.5em;
+                padding: 0;
+            }
+            ul.doc-list li {
+                list-style: none;
+                margin: 0.25em 0 0.25em 0;
+                padding: 0;
+            }
+            h1 small {
+                font-size: 75%;
+                font-weight: normal;
+            }
+            .document-section {
+                margin: 1.5em 0 1em 0;
+            }
+        </style>
+    </head>
+    <body>
+        <%= yield %>
+    </body>
+</html>