solargraph 0.18.2 → 0.18.3

data/lib/solargraph/source/change.rb

@@ -0,0 +1,70 @@
+module Solargraph
+  class Source
+    # A change to be applied to text.
+    #
+    class Change
+      # @return [Range]
+      attr_reader :range
+
+      # @return [String]
+      attr_reader :new_text
+
+      # @param range [Range] The starting and ending positions of the change.
+      #   If nil, the original text will be overwritten.
+      # @param new_text [String] The text to be changed.
+      def initialize range, new_text
+        @range = range
+        @new_text = new_text
+      end
+
+      # Write the change to the specified text.
+      #
+      # @param text [String] The text to be changed.
+      # @param nullable [Boolean] If true, minor changes that could generate
+      #   syntax errors will be repaired.
+      # @return [String] The updated text.
+      def write text, nullable = false
+        if nullable and !range.nil? and new_text.match(/[\.\[\{\(@\$:]$/)
+          commit text, "#{new_text[0..-2]} "
+        elsif range.nil?
+          new_text
+        else
+          commit text, new_text
+        end
+      end
+
+      # Repair an update by replacing the new text with similarly formatted
+      # whitespace.
+      #
+      # @param text [String] The text to be changed.
+      # @return [String] The updated text.
+      def repair text
+        fixed = new_text.gsub(/[^\s]/, ' ')
+        if range.nil?
+          fixed
+        else
+          commit text, fixed
+        end
+      end
+
+      private
+
+      def commit text, insert
+        start_offset = get_offset(text, range.start.line, range.start.character)
+        end_offset = get_offset(text, range.end.line, range.end.character)
+        (start_offset == 0 ? '' : text[0..start_offset-1].to_s) + insert.force_encoding('utf-8') + text[end_offset..-1].to_s
+      end
+
+      def get_offset text, line, column
+        offset = 0
+        feed = 0
+        text.lines.each do |l|
+          break if line == feed
+          offset += l.length
+          feed += 1
+        end
+        offset + column
+      end
+    end
+  end
+end

data/lib/solargraph/source/fragment.rb

@@ -33,11 +33,6 @@ module Solargraph
       #
       # @return [String]
       def namespace
-        # if @namespace.nil?
-        #   base = @source.parent_node_from(line, column, :class, :module, :def, :defs)
-        #   @namespace ||= @source.namespace_for(base)
-        # end
-        # @namespace
         if @namespace.nil?
           parts = []
           @tree.each do |n|
@@ -56,6 +51,17 @@ module Solargraph
         @argument ||= !signature_position.nil?
       end
 
+      def chained?
+        if @chained.nil?
+          @chained = false
+          @tree.each do |n|
+            @chained = true if n.type == :send
+            break
+          end
+        end
+        @chained
+      end
+
       # @return [Fragment]
       def recipient
         return nil if signature_position.nil?
@@ -90,6 +96,14 @@ module Solargraph
         @signature ||= signature_data[1]
       end
 
+      def valid?
+        @source.parsed?
+      end
+
+      def broken?
+        !valid?
+      end
+
       # Get the signature before the current word. Given the signature
       # `String.new.split`, the base is `String.new`.
       #
@@ -116,6 +130,26 @@ module Solargraph
         @base
       end
 
+      # @return [String]
+      def root
+        @root ||= signature.split('.').first
+      end
+
+      # @return [String]
+      def chain
+        @chain ||= signature.split('.')[1..-1].join('.')
+      end
+
+      # @return [String]
+      def base_chain
+        @base_chain ||= signature.split('.')[1..-2].join('.')
+      end
+
+      # @return [String]
+      def whole_chain
+        @whole_chain ||= whole_signature.split('.')[1..-1].join('.')
+      end
+
       # Get the remainder of the word after the current offset. Given the text
       # `foobar` with an offset of 3, the remainder is `bar`.
       #
@@ -159,8 +193,6 @@ module Solargraph
       #
       # @return [Boolean]
       def string?
-        # @string = @source.string_at?(offset) if @string.nil?
-        # @string
         @string ||= (node.type == :str or node.type == :dstr)
       end
 
@@ -191,25 +223,91 @@ module Solargraph
       # from the current offset.
       #
       # @return [Array<Solargraph::Pin::LocalVariable>]
-      def local_variable_pins
-        @local_variable_pins ||= @source.local_variable_pins.select{|pin| pin.visible_from?(node)}
+      def local_variable_pins name = nil
+        @local_variable_pins ||= prefer_non_nil_variables(@source.local_variable_pins.select{|pin| pin.visible_from?(node)})
+        return @local_variable_pins if name.nil?
+        @local_variable_pins.select{|pin| pin.name == name}
+      end
+
+      def calculated_signature
+        @calculated_signature ||= calculate
+      end
+
+      def calculated_whole_signature
+        @calculated_whole_signature ||= calculated_signature + remainder
+      end
+
+      def calculated_base
+        if @calculated_base.nil?
+          @calculated_base = calculated_signature[0..-2] if calculated_signature.end_with?('.')
+          @calculated_base ||= calculated_signature.split('.')[0..-2].join('.')
+        end
+        @calculated_base
       end
 
       private
 
+      def calculate
+        return signature if signature.empty? or signature.nil?
+        if signature.start_with?('.')
+          return signature if column < 2
+          # @todo Smelly exceptional case for arrays
+          return signature.sub(/^\.\[\]/, 'Array.new') if signature.start_with?('.[].')
+          pn = @source.node_at(line, column - 2)
+          unless pn.nil?
+            literal = infer_literal_node_type(pn)
+            unless literal.nil?
+              return "#{literal}.new#{signature}"
+            end
+          end
+          return signature
+        end
+        # @todo Smelly exceptional case for integers
+        base, rest = signature.split('.', 2)
+        base.sub!(/^[0-9]+?$/, 'Integer.new')
+        var = local_variable_pins(base).first
+        unless var.nil?
+          done = []
+          until var.nil?
+            break if done.include?(var)
+            done.push var
+            type = var.calculated_signature
+            break if type.nil?
+            base = type
+            var = local_variable_pins(base).first
+          end
+        end
+        base = @source.qualify(base, namespace)
+        base + (rest.nil? ? '' : ".#{rest}")
+      end
+
+      # @todo DRY this method. It exists in ApiMap.
+      # @return [Array<Solargraph::Pin::Base>]
+      def prefer_non_nil_variables pins
+        result = []
+        nil_pins = []
+        pins.each do |pin|
+          if pin.nil_assignment? and pin.return_type.nil?
+            nil_pins.push pin
+          else
+            result.push pin
+          end
+        end
+        result + nil_pins
+      end
+
       # @return [Integer]
       def offset
-        if @offset.nil?
-          @offset = 0
-          feed = 0
-          @code.lines.each { |l|
-            break if line == feed
-            @offset += l.length
-            feed += 1
-          }
-          @offset += column
-        end
-        @offset
+        @offset ||= get_offset(line, column)
+      end
+
+      def get_offset line, column
+        Position.line_char_to_offset(@code, line, column)
+      end
+
+      def get_position_at(offset)
+        pos = Position.from_offset(@code, offset)
+        [pos.line, pos.character]
       end
 
       def signature_data
@@ -228,6 +326,7 @@ module Solargraph
           unless !in_whitespace and string?
             break if brackets > 0 or parens > 0 or squares > 0
             char = @code[index, 1]
+            break if char.nil? # @todo Is this the right way to handle this?
             if brackets.zero? and parens.zero? and squares.zero? and [' ', "\r", "\n", "\t"].include?(char)
               in_whitespace = true
             else
@@ -267,22 +366,7 @@ module Solargraph
           end
           index -= 1
         end
-        if signature.start_with?('.')
-          # @todo Smelly exceptional case for arrays
-          if signature.start_with?('.[].')
-            signature.sub!(/^\.\[\]/, 'Array.new')
-          else
-            line, col = get_position_at(index - 1)
-            pn = @source.node_at(line, col)
-            unless pn.nil?
-              literal = infer_literal_node_type(pn)
-              unless literal.nil?
-                signature = "#{literal}.new#{signature}"
-                # @todo Determine the index from the beginning of the literal node?
-              end
-            end
-          end
-        end
+        # @todo Smelly exceptional case for numbers
         [index + 1, signature]
       end
 
@@ -364,36 +448,6 @@ module Solargraph
         @code[index..cursor-1]
       end
 
-      def get_position_at(offset)
-        cursor = 0
-        line = 0
-        col = nil
-        @code.lines.each do |l|
-          if cursor + l.length > offset
-            col = offset - cursor
-            break
-          end
-          if cursor + l.length == offset
-            if l.end_with?("\n")
-              col = 0
-              line += 1
-              break
-            else
-              col = l.length
-              break
-            end
-          end
-          if cursor + l.length - 1 == offset and !l.end_with?("\n")
-            col = l.length - 1
-            break
-          end
-          cursor += l.length
-          line += 1
-        end
-        raise "Invalid offset" if col.nil?
-        [line, col]
-      end
-
       def signature_position
         if @signature_position.nil?
           open_parens = 0

data/lib/solargraph/source/position.rb

@@ -1,4 +1,5 @@
 module Solargraph
+
   class Source
     class Position
       # @return [Integer]
@@ -21,6 +22,46 @@ module Solargraph
           character: character
         }
       end
+
+      def self.to_offset text, position
+        result = 0
+        feed = 0
+        line = position.line
+        column = position.character
+        text.lines.each do |l|
+          line_length = l.length
+          char_length = l.chomp.length
+          if feed == line
+            result += column
+            break
+          end
+          result += line_length
+          feed += 1
+        end
+        result
+      end
+
+      def self.line_char_to_offset text, line, character
+        to_offset(text, Position.new(line, character))
+      end
+
+      def self.from_offset text, offset
+        cursor = 0
+        line = 0
+        character = nil
+        text.lines.each do |l|
+          line_length = l.length
+          char_length = l.chomp.length
+          if cursor + char_length >= offset
+            character = offset - cursor
+            break
+          end
+          cursor += line_length
+          line += 1
+        end
+        raise InvalidOffsetError if character.nil?
+        Position.new(line, character)
+      end
     end
   end
 end

data/lib/solargraph/source/updater.rb

@@ -0,0 +1,48 @@
+module Solargraph
+  class Source
+    # Updaters contain changes to be applied to a source. The source applies
+    # the update via the Source#synchronize method.
+    #
+    class Updater
+      # @return [String]
+      attr_reader :filename
+
+      # @return [Integer]
+      attr_reader :version
+
+      # @return [Array<Change>]
+      attr_reader :changes
+
+      # @param filename [String] The file to update.
+      # @param version [Integer] A version number associated with this update.
+      # @param changes [Array<Solargraph::Source::Change>] The changes.
+      def initialize filename, version, changes
+        @filename = filename
+        @version = version
+        @changes = changes
+        @input = nil
+        @did_nullify = nil
+        @output = nil
+      end
+
+      def write text, nullable = false
+        can_nullify = (nullable and changes.length == 1)
+        return @output if @input == text and can_nullify == @did_nullify
+        @input = text
+        @output = text
+        @did_nullify = can_nullify
+        changes.each do |ch|
+          @output = ch.write(@output, can_nullify)
+        end
+        @output
+      end
+
+      def repair text
+        changes.each do |ch|
+          text = ch.repair(text)
+        end
+        text
+      end
+    end
+  end
+end

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
-module Solargraph
-  VERSION = '0.18.2'
-end
+module Solargraph
+  VERSION = '0.18.3'
+end

data/lib/solargraph/workspace/config.rb

@@ -16,15 +16,10 @@ module Solargraph
         unless @workspace.nil?
           sfile = File.join(@workspace, '.solargraph.yml')
           if File.file?(sfile)
-            begin
-              @raw_data = YAML.load(File.read(sfile))
-              conf = YAML.load(File.read(sfile))
-              include_globs = conf['include'] || include_globs
-              exclude_globs = conf['exclude'] || []
-            rescue Exception => e
-              STDERR.puts "Unable to read .solargraph.yml: #{e.class} #{e.message}"
-              @raw_data = {}
-            end
+            @raw_data = YAML.load(File.read(sfile))
+            conf = YAML.load(File.read(sfile))
+            include_globs = conf['include'] || include_globs
+            exclude_globs = conf['exclude'] || []
           end
         end
         @raw_data ||= {}