solargraph 0.23.6 → 0.24.0

data/lib/solargraph/source/change.rb

@@ -36,6 +36,12 @@ module Solargraph
             break
           end
           commit text, "#{new_text[0..-2]} "
+        elsif nullable and !range.nil? and new_text.empty?
+          offset = Position.to_offset(text, range.start)
+          if offset > 0 and text[offset - 1] == '.'
+            text = text[0..offset - 1] + ' ' + text[offset..-1]
+          end
+          commit text, new_text
         elsif range.nil?
           new_text
         else

data/lib/solargraph/source/fragment.rb

@@ -1,5 +1,10 @@
 module Solargraph
   class Source
+    # Information about a location in a source, including the location's word
+    # and signature, literal values at the base of signatures, and whether the
+    # location is inside a string or comment. ApiMaps use Fragments to provide
+    # results for completion and definition queries.
+    #
     class Fragment
       include NodeMethods
 
@@ -189,8 +194,7 @@ module Solargraph
       #
       # @return [Boolean]
       def comment?
-        @comment = get_comment_at(offset) if @comment.nil?
-        @comment
+        @comment ||= check_comment(line, column)
       end
 
       # Get the range of the word up to the current offset.
@@ -291,7 +295,8 @@ module Solargraph
         index -=1
         in_whitespace = false
         while index >= 0
-          break if index > 0 and comment?
+          pos = Position.from_offset(@code, index)
+          break if index > 0 and check_comment(pos.line, pos.character)
           unless !in_whitespace and string?
             break if brackets > 0 or parens > 0 or squares > 0
             char = @code[index, 1]
@@ -359,18 +364,29 @@ module Solargraph
         [index + 1, signature]
       end
 
-      # Determine if the specified index is inside a comment.
+      # Determine if the specified location is inside a comment.
       #
+      # @param lin [Integer]
+      # @param col [Integer]
       # @return [Boolean]
-      def get_comment_at(index)
-        return false if string?
-        # line, col = get_position_at(index)
+      def check_comment(lin, col)
+        index = Position.line_char_to_offset(source_from_parser, lin, col)
         @source.comments.each do |c|
           return true if index > c.location.expression.begin_pos and index <= c.location.expression.end_pos
         end
         false
       end
 
+      # True if the line and column are inside the specified range.
+      #
+      # @param location [Parser::Source::Range]
+      def compare_range line, column, location
+        return true if line == location.first_line and line == location.last_line and column >= location.column and column < location.last_column
+        return true if line > location.first_line and line < location.last_line
+        return true if line == location.last_line and column >= location.last_column and column < location.last_column
+        false
+      end
+
       # Select the word that directly precedes the specified index.
       # A word can only consist of letters, numbers, and underscores.
       #
@@ -457,6 +473,14 @@ module Solargraph
         end
         @signature_position
       end
+
+      # Range tests that depend on positions identified from parsed code, such
+      # as comment ranges, need to normalize EOLs to \n.
+      #
+      # @return [String]
+      def source_from_parser
+        @source_from_parser ||= @source.code.gsub(/\r\n/, "\n")
+      end
     end
   end
 end

data/lib/solargraph/source/location.rb

@@ -7,10 +7,17 @@ module Solargraph
       # @return [Solargraph::Source::Range]
       attr_reader :range
 
+      # @param filename [String]
+      # @param range [Solargraph::Source::Range]
       def initialize filename, range
         @filename = filename
         @range = range
       end
+
+      def == other
+        return false unless other.is_a?(Location)
+        filename == other.filename and range == other.range
+      end
     end
   end
 end

data/lib/solargraph/source/mapper.rb

@@ -1,3 +1,5 @@
+require 'tempfile'
+
 module Solargraph
   class Source
     # The Mapper generates pins and other data for Sources.
@@ -148,7 +150,8 @@ module Solargraph
                 if methpin.name == 'initialize' and methpin.scope == :instance
                   pins.push Solargraph::Pin::Method.new(methpin.location, methpin.namespace, 'new', methpin.docstring, :class, :public, methpin.parameters)
                   # @todo Smelly instance variable access.
-                  pins.last.instance_variable_set(:@return_type, methpin.namespace)
+                  # pins.last.instance_variable_set(:@return_type, methpin.namespace)
+                  pins.last.instance_variable_set(:@return_complex_types, ComplexType.parse(methpin.namespace))
                   pins.push Solargraph::Pin::Method.new(methpin.location, methpin.namespace, methpin.name, methpin.docstring, methpin.scope, :private, methpin.parameters)
                 elsif visibility == :module_function
                   pins.push Solargraph::Pin::Method.new(methpin.location, methpin.namespace, methpin.name, methpin.docstring, :class, :public, methpin.parameters)
@@ -363,7 +366,8 @@ module Solargraph
               ctxt += "#{p[num..-1]}\n"
             end
           }
-          parse = YARD::Docstring.parser.parse(ctxt)
+          parse = nil
+          suppress_stdout { parse = YARD::Docstring.parser.parse(ctxt) }
           unless parse.directives.empty?
             @directives[k] ||= []
             @directives[k].concat parse.directives
@@ -382,7 +386,8 @@ module Solargraph
         @directives.each_pair do |k, v|
           v.each do |d|
             ns = namespace_for(k.node)
-            docstring = YARD::Docstring.parser.parse(d.tag.text).to_docstring
+            docstring = nil
+            suppress_stdout { docstring = YARD::Docstring.parser.parse(d.tag.text).to_docstring }
             if d.tag.tag_name == 'attribute'
               t = (d.tag.types.nil? || d.tag.types.empty?) ? nil : d.tag.types.flatten.join('')
               if t.nil? or t.include?('r')
@@ -448,6 +453,26 @@ module Solargraph
         }
         args
       end
+
+      # Suppress writing data to STDOUT during execution of a block.
+      #
+      # @example
+      #   suppress_stdout { puts 'This will not get printed' }
+      #
+      def suppress_stdout
+        original_stdout = STDOUT.clone
+        # @todo It would be better to redirect to /dev/null or StringIO if
+        #   there's a cross-platform solution for it.
+        tempfile = Tempfile.new('tmp')
+        STDOUT.reopen tempfile
+        begin
+          yield
+        ensure
+          STDOUT.reopen original_stdout
+          tempfile.close
+          tempfile.unlink
+        end
+      end
     end
   end
 end

data/lib/solargraph/source/position.rb

@@ -81,6 +81,11 @@ module Solargraph
         raise InvalidOffsetError if character.nil?
         Position.new(line, character)
       end
+
+      def == other
+        return false unless other.is_a?(Position)
+        line == other.line and character == other.character
+      end
     end
   end
 end

data/lib/solargraph/source/range.rb

@@ -46,6 +46,11 @@ module Solargraph
       def self.from_to l1, c1, l2, c2
         Range.new(Position.new(l1, c1), Position.new(l2, c2))
       end
+
+      def == other
+        return false unless other.is_a?(Range)
+        start == other.start and ending == other.ending
+      end
     end
   end
 end

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.23.6'
+  VERSION = '0.24.0'
 end

data/lib/solargraph/yard_map.rb

@@ -52,10 +52,13 @@ module Solargraph
       @yardocs ||= []
     end
 
+    # @return [Array<String>]
     def unresolved_requires
       @unresolved_requires ||= []
     end
 
+    # @param y [String]
+    # @return [YARD::Registry]
     def load_yardoc y
       begin
         if y.kind_of?(Array)
@@ -71,6 +74,7 @@ module Solargraph
     end
 
     # @param query [String]
+    # @return [Array<String>]
     def search query
       found = []
       (yardocs + [@@stdlib_yardoc]).each { |y|
@@ -87,6 +91,7 @@ module Solargraph
     end
 
     # @param query [String]
+    # @return [YARD::CodeObjects::Base]
     def document query
       found = []
       (yardocs + [@@stdlib_yardoc]).each { |y|
@@ -99,6 +104,8 @@ module Solargraph
       found
     end
 
+    # @param namespace [String]
+    # @param scope [String]
     # @return [Array<Solargraph::Pin::Base>]
     def get_constants namespace , scope = ''
       cached = cache.get_constants(namespace, scope)
@@ -139,6 +146,9 @@ module Solargraph
       result
     end
 
+    # @param namespace [String]
+    # @param scope [String]
+    # @param visibility [Array<Symbol>]
     # @return [Array<Solargraph::Pin::Base>]
     def get_methods namespace, scope = '', visibility: [:public]
       return [] if namespace == '' and scope == ''
@@ -178,6 +188,9 @@ module Solargraph
       meths
     end
 
+    # @param namespace [String]
+    # @param scope [String]
+    # @param visibility [Array<Symbol>]
     # @return [Array<Solargraph::Pin::Base>]
     def get_instance_methods namespace, scope = '', visibility: [:public]
       return [] if namespace == '' and scope == ''
@@ -222,6 +235,9 @@ module Solargraph
       meths
     end
 
+    # @param namespace [String]
+    # @param scope [String]
+    # @return [String]
     def find_fully_qualified_namespace namespace, scope
       unless scope.nil? or scope.empty?
         parts = scope.split('::')
@@ -237,6 +253,9 @@ module Solargraph
       nil
     end
 
+    # @param path [String]
+    # @param space [String]
+    # @return [Array<Pin::YardObject>]
     def objects path, space = ''
       cached = cache.get_objects(path, space)
       return cached unless cached.nil?
@@ -257,6 +276,7 @@ module Solargraph
       result
     end
 
+    # @param fqns [String]
     # @return [Symbol] :class, :module, or nil
     def get_namespace_type(fqns)
       yardocs_documenting(fqns).each do |y|
@@ -323,6 +343,7 @@ module Solargraph
       end
     end
 
+    # @param spec [Gem::Specification]
     def add_gem_dependencies spec
       (spec.dependencies - spec.development_dependencies).each do |dep|
         spec = Gem::Specification.find_by_name(dep.name)
@@ -336,6 +357,9 @@ module Solargraph
       end
     end
 
+    # @param namespace [String]
+    # @param scope [String]
+    # @return [Array<String>]
     def combined_namespaces namespace, scope = ''
       combined = [namespace]
       unless scope.empty?
@@ -348,6 +372,8 @@ module Solargraph
       combined
     end
 
+    # @param namespace [String]
+    # @return [Array<String>]
     def yardocs_documenting namespace
       result = []
       if namespace == ''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.23.6
+  version: 0.24.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-02 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -241,12 +241,14 @@ files:
 - lib/solargraph/api_map/source_to_yard.rb
 - lib/solargraph/api_map/store.rb
 - lib/solargraph/api_map/type_methods.rb
+- lib/solargraph/complex_type.rb
 - lib/solargraph/core_fills.rb
 - lib/solargraph/diagnostics.rb
 - lib/solargraph/diagnostics/base.rb
 - lib/solargraph/diagnostics/require_not_found.rb
 - lib/solargraph/diagnostics/rubocop.rb
 - lib/solargraph/diagnostics/severities.rb
+- lib/solargraph/diagnostics/type_not_defined.rb
 - lib/solargraph/language_server.rb
 - lib/solargraph/language_server/completion_item_kinds.rb
 - lib/solargraph/language_server/error_codes.rb
@@ -311,6 +313,7 @@ files:
 - lib/solargraph/pin/constant.rb
 - lib/solargraph/pin/conversions.rb
 - lib/solargraph/pin/documenting.rb
+- lib/solargraph/pin/duck_method.rb
 - lib/solargraph/pin/global_variable.rb
 - lib/solargraph/pin/helper.rb
 - lib/solargraph/pin/instance_variable.rb