solargraph 0.58.0 → 0.59.0

data/lib/solargraph/location.rb

@@ -1,82 +1,85 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # A pointer to a section of source text identified by its filename
-  # and Range.
-  #
-  class Location
-    include Equality
-
-    # @return [String]
-    attr_reader :filename
-
-    # @return [Solargraph::Range]
-    attr_reader :range
-
-    # @param filename [String]
-    # @param range [Solargraph::Range]
-    def initialize filename, range
-      @filename = filename
-      @range = range
-    end
-
-    # @sg-ignore Fix "Not enough arguments to Module#protected"
-    protected def equality_fields
-      [filename, range]
-    end
-
-    # @param other [self]
-    def <=>(other)
-      return nil unless other.is_a?(Location)
-      if filename == other.filename
-        range <=> other.range
-      else
-        filename <=> other.filename
-      end
-    end
-
-    def rbs?
-      filename.end_with?('.rbs')
-    end
-
-    # @param location [self]
-    def contain? location
-      range.contain?(location.range.start) && range.contain?(location.range.ending) && filename == location.filename
-    end
-
-    def inspect
-      "<#{self.class.name}: filename=#{filename}, range=#{range.inspect}>"
-    end
-
-    def to_s
-      inspect
-    end
-
-    # @return [Hash]
-    def to_hash
-      {
-        filename: filename,
-        range: range.to_hash
-      }
-    end
-
-    # @param node [Parser::AST::Node, nil]
-    # @return [Location, nil]
-    def self.from_node(node)
-      return nil if node.nil? || node.loc.nil?
-      range = Range.from_node(node)
-      self.new(node.loc.expression.source_buffer.name, range)
-    end
-
-    # @param other [BasicObject]
-    def == other
-      return false unless other.is_a?(Location)
-      # @sg-ignore https://github.com/castwide/solargraph/pull/1114
-      filename == other.filename and range == other.range
-    end
-
-    def inspect
-      "#<#{self.class} #{filename}, #{range.inspect}>"
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  # A pointer to a section of source text identified by its filename
+  # and Range.
+  #
+  class Location
+    include Equality
+    include Comparable
+
+    # @return [String]
+    attr_reader :filename
+
+    # @return [Solargraph::Range]
+    attr_reader :range
+
+    # @param filename [String, nil]
+    # @param range [Solargraph::Range]
+    def initialize filename, range
+      raise 'Use nil to represent no-file' if filename&.empty?
+
+      @filename = filename
+      @range = range
+    end
+
+    # @param other [self]
+    def <=> other
+      return nil unless other.is_a?(Location)
+      if filename == other.filename
+        range <=> other.range
+      else
+        filename <=> other.filename
+      end
+    end
+
+    def rbs?
+      filename.end_with?('.rbs')
+    end
+
+    # @param location [self]
+    def contain? location
+      range.contain?(location.range.start) && range.contain?(location.range.ending) && filename == location.filename
+    end
+
+    def to_s
+      inspect
+    end
+
+    # @return [Hash]
+    def to_hash
+      {
+        filename: filename,
+        range: range.to_hash
+      }
+    end
+
+    # @param node [Parser::AST::Node, nil]
+    # @return [Location, nil]
+    def self.from_node node
+      return nil if node.nil? || node.loc.nil?
+      filename = node.loc.expression.source_buffer.name
+      # @sg-ignore flow sensitive typing needs to create separate ranges for postfix if
+      filename = nil if filename.empty?
+      range = Range.from_node(node)
+      # @sg-ignore Need to add nil check here
+      new(filename, range)
+    end
+
+    # @param other [BasicObject]
+    def == other
+      return false unless other.is_a?(Location)
+      filename == other.filename and range == other.range
+    end
+
+    def inspect
+      "#<#{self.class} #{filename}, #{range.inspect}>"
+    end
+
+    protected
+
+    def equality_fields
+      [filename, range]
+    end
+  end
+end

data/lib/solargraph/logging.rb

@@ -1,37 +1,55 @@
-# frozen_string_literal: true
-
-require 'logger'
-
-module Solargraph
-  module Logging
-    DEFAULT_LOG_LEVEL = Logger::WARN
-
-    LOG_LEVELS = {
-      'warn' => Logger::WARN,
-      'info' => Logger::INFO,
-      'debug' => Logger::DEBUG
-    }
-    configured_level = ENV.fetch('SOLARGRAPH_LOG', nil)
-    level = if LOG_LEVELS.keys.include?(configured_level)
-              LOG_LEVELS.fetch(configured_level)
-            else
-              if configured_level
-                warn "Invalid value for SOLARGRAPH_LOG: #{configured_level.inspect} - " \
-                     "valid values are #{LOG_LEVELS.keys}"
-              end
-              DEFAULT_LOG_LEVEL
-            end
-    @@logger = Logger.new(STDERR, level: level)
-    # @sg-ignore Fix cvar issue
-    @@logger.formatter = proc do |severity, datetime, progname, msg|
-      "[#{severity}] #{msg}\n"
-    end
-
-    module_function
-
-    # @return [Logger]
-    def logger
-      @@logger
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'logger'
+
+module Solargraph
+  module Logging
+    DEFAULT_LOG_LEVEL = Logger::WARN
+
+    LOG_LEVELS = {
+      'warn' => Logger::WARN,
+      'info' => Logger::INFO,
+      'debug' => Logger::DEBUG
+    }.freeze
+    configured_level = ENV.fetch('SOLARGRAPH_LOG', nil)
+    level = if LOG_LEVELS.keys.include?(configured_level)
+              LOG_LEVELS.fetch(configured_level)
+            else
+              if configured_level
+                warn "Invalid value for SOLARGRAPH_LOG: #{configured_level.inspect} - " \
+                     "valid values are #{LOG_LEVELS.keys}"
+              end
+              DEFAULT_LOG_LEVEL
+            end
+    @@logger = Logger.new($stderr, level: level)
+    # @sg-ignore Fix cvar issue
+    @@logger.formatter = proc do |severity, _datetime, _progname, msg|
+      "[#{severity}] #{msg}\n"
+    end
+
+    module_function
+
+    # override this in your class to temporarily set a custom
+    # filtering log level for the class (e.g., suppress any debug
+    # message by setting it to :info even if it is set elsewhere, or
+    # show existing debug messages by setting to :debug).
+    #
+    # @return [Symbol]
+    def log_level
+      :warn
+    end
+
+    # @return [Logger]
+    def logger
+      if LOG_LEVELS[log_level.to_s] == DEFAULT_LOG_LEVEL
+        @@logger
+      else
+        new_log_level = LOG_LEVELS[log_level.to_s]
+        logger = Logger.new($stderr, level: new_log_level)
+
+        logger.formatter = @@logger.formatter
+        logger
+      end
+    end
+  end
+end

data/lib/solargraph/page.rb

@@ -1,92 +1,92 @@
-# frozen_string_literal: true
-
-require 'ostruct'
-require 'tilt'
-require 'yard'
-require 'cgi'
-
-module Solargraph
-  class Page
-    # @todo This method directive is necessary because OpenStruct.new confuses
-    #   the typechecker.
-    # @!method self.new(locals, render_method)
-    #   @param locals[Hash]
-    #   @param render_method [Proc]
-    #   @return [Binder]
-    class Binder < OpenStruct
-      # @param locals [Hash]
-      # @param render_method [Proc]
-      def initialize locals, render_method
-        super(locals)
-        define_singleton_method :render do |template, layout: false, locals: {}|
-          render_method.call(template, layout: layout, locals: locals)
-        end
-        define_singleton_method :erb do |template, layout: false, locals: {}|
-          render_method.call(template, layout: layout, locals: locals)
-        end
-      end
-
-      # @param text [String]
-      # @return [String]
-      def htmlify text
-        # @type [String]
-        YARD::Templates::Helpers::Markup::RDocMarkup.new(text).to_html
-      end
-
-      # @param text [String]
-      # @return [String]
-      def escape text
-        CGI.escapeHTML(text)
-      end
-
-      # @param code [String]
-      # @return [String]
-      def ruby_to_html code
-        code
-      end
-    end
-    private_constant :Binder
-
-    # @param directory [String]
-    def initialize directory = VIEWS_PATH
-      directory = VIEWS_PATH if directory.nil? or !File.directory?(directory)
-      directories = [directory]
-      directories.push VIEWS_PATH if directory != VIEWS_PATH
-      # @type [Proc]
-      # @param template [String]
-      # @param layout [Boolean]
-      # @param locals [Hash]
-      @render_method = proc { |template, layout: false, locals: {}|
-        binder = Binder.new(locals, @render_method)
-        if layout
-          Tilt::ERBTemplate.new(Page.select_template(directories, 'layout')).render(binder) do
-            Tilt::ERBTemplate.new(Page.select_template(directories, template)).render(binder)
-          end
-        else
-          Tilt::ERBTemplate.new(Page.select_template(directories, template)).render(binder)
-        end
-      }
-    end
-
-    # @param template [String]
-    # @param layout [Boolean]
-    # @param locals [Hash]
-    # @sg-ignore
-    # @return [String]
-    def render template, layout: true, locals: {}
-      # @type [String]
-      @render_method.call(template, layout: layout, locals: locals)
-    end
-
-    # @param directories [Array<String>]
-    # @param name [String]
-    # @return [String]
-    def self.select_template directories, name
-      directories.each do |dir|
-        path = File.join(dir, "#{name}.erb")
-        return path if File.file?(path)
-      end
-      raise FileNotFoundError, "Template not found: #{name}"
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'ostruct'
+require 'tilt'
+require 'yard'
+require 'cgi'
+
+module Solargraph
+  class Page
+    # @todo This method directive is necessary because OpenStruct.new confuses
+    #   the typechecker.
+    # @!method self.new(locals, render_method)
+    #   @param locals[Hash]
+    #   @param render_method [Proc]
+    #   @return [Binder]
+    class Binder < OpenStruct
+      # @param locals [Hash]
+      # @param render_method [Proc]
+      def initialize locals, render_method
+        super(locals)
+        define_singleton_method :render do |template, layout: false, locals: {}|
+          render_method.call(template, layout: layout, locals: locals)
+        end
+        define_singleton_method :erb do |template, layout: false, locals: {}|
+          render_method.call(template, layout: layout, locals: locals)
+        end
+      end
+
+      # @param text [String]
+      # @return [String]
+      def htmlify text
+        # @type [String]
+        YARD::Templates::Helpers::Markup::RDocMarkup.new(text).to_html
+      end
+
+      # @param text [String]
+      # @return [String]
+      def escape text
+        CGI.escapeHTML(text)
+      end
+
+      # @param code [String]
+      # @return [String]
+      def ruby_to_html code
+        code
+      end
+    end
+    private_constant :Binder
+
+    # @param directory [String]
+    def initialize directory = VIEWS_PATH
+      directory = VIEWS_PATH if directory.nil? || !File.directory?(directory)
+      directories = [directory]
+      directories.push VIEWS_PATH if directory != VIEWS_PATH
+      # @type [Proc]
+      # @param template [String]
+      # @param layout [Boolean]
+      # @param locals [Hash]
+      @render_method = proc { |template, layout: false, locals: {}|
+        binder = Binder.new(locals, @render_method)
+        if layout
+          Tilt::ERBTemplate.new(Page.select_template(directories, 'layout')).render(binder) do
+            Tilt::ERBTemplate.new(Page.select_template(directories, template)).render(binder)
+          end
+        else
+          Tilt::ERBTemplate.new(Page.select_template(directories, template)).render(binder)
+        end
+      }
+    end
+
+    # @param template [String]
+    # @param layout [Boolean]
+    # @param locals [Hash]
+    # @sg-ignore
+    # @return [String]
+    def render template, layout: true, locals: {}
+      # @type [String]
+      @render_method.call(template, layout: layout, locals: locals)
+    end
+
+    # @param directories [Array<String>]
+    # @param name [String]
+    # @return [String]
+    def self.select_template directories, name
+      directories.each do |dir|
+        path = File.join(dir, "#{name}.erb")
+        return path if File.file?(path)
+      end
+      raise FileNotFoundError, "Template not found: #{name}"
+    end
+  end
+end

data/lib/solargraph/parser/comment_ripper.rb

@@ -1,69 +1,84 @@
-require 'ripper'
-
-module Solargraph
-  module Parser
-    class CommentRipper < Ripper::SexpBuilderPP
-      # @!override Ripper::SexpBuilder#on_embdoc_beg
-      #   @return [Array(Symbol, String, Array)]
-      # @!override Ripper::SexpBuilder#on_embdoc
-      #   @return [Array(Symbol, String, Array)]
-      # @!override Ripper::SexpBuilder#on_embdoc_end
-      #   @return [Array(Symbol, String, Array)]
-
-      # @param src [String]
-      # @param filename [String]
-      # @param lineno [Integer]
-      def initialize src, filename = '(ripper)', lineno = 0
-        super
-        @buffer = src
-        @buffer_lines = @buffer.lines
-      end
-
-      def on_comment *args
-        # @sg-ignore
-        # @type [Array(Symbol, String, Array([Integer, nil], [Integer, nil]))]
-        result = super
-        if @buffer_lines[result[2][0]][0..result[2][1]].strip =~ /^#/
-          chomped = result[1].chomp
-          if result[2][0] == 0 && chomped.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '').match(/^#\s*frozen_string_literal:/)
-            chomped = '#'
-          end
-          @comments[result[2][0]] = Snippet.new(Range.from_to(result[2][0], result[2][1], result[2][0], result[2][1] + chomped.length), chomped)
-        end
-        result
-      end
-
-      # @param result [Array(Symbol, String, Array([Integer, nil], [Integer, nil]))]
-      # @return [void]
-      def create_snippet(result)
-        chomped = result[1].chomp
-        @comments[result[2][0]] = Snippet.new(Range.from_to(result[2][0] || 0, result[2][1] || 0, result[2][0] || 0, (result[2][1] || 0) + chomped.length), chomped)
-      end
-
-      def on_embdoc_beg *args
-        result = super
-        create_snippet(result)
-        result
-      end
-
-      def on_embdoc *args
-        result = super
-        create_snippet(result)
-        result
-      end
-
-      def on_embdoc_end *args
-        result = super
-        create_snippet(result)
-        result
-      end
-
-      # @return [Hash{Integer => Solargraph::Parser::Snippet}]
-      def parse
-        @comments = {}
-        super
-        @comments
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'ripper'
+
+module Solargraph
+  module Parser
+    class CommentRipper < Ripper::SexpBuilderPP
+      # @!override Ripper::SexpBuilder#on_embdoc_beg
+      #   @return [Array(Symbol, String, Array)]
+      # @!override Ripper::SexpBuilder#on_embdoc
+      #   @return [Array(Symbol, String, Array)]
+      # @!override Ripper::SexpBuilder#on_embdoc_end
+      #   @return [Array(Symbol, String, Array)]
+
+      # @param src [String]
+      # @param filename [String]
+      # @param lineno [Integer]
+      def initialize src, filename = '(ripper)', lineno = 0
+        super
+        @buffer = src
+        @buffer_lines = @buffer.lines
+      end
+
+      def on_comment *args
+        # @sg-ignore
+        # @type [Array(Symbol, String, Array([Integer, nil], [Integer, nil]))]
+        result = super
+        # @sg-ignore Need to add nil check here
+        if @buffer_lines[result[2][0]][0..result[2][1]].strip =~ /^#/
+          chomped = result[1].chomp
+          if result[2][0].zero? && chomped.encode('UTF-8', 'binary', invalid: :replace, undef: :replace,
+                                                                     replace: '').match(/^#\s*frozen_string_literal:/)
+            chomped = '#'
+          end
+          @comments[result[2][0]] =
+            Snippet.new(Range.from_to(result[2][0], result[2][1], result[2][0], result[2][1] + chomped.length), chomped)
+        end
+        result
+      end
+
+      # @param result [Array(Symbol, String, Array([Integer, nil], [Integer, nil]))]
+      # @return [void]
+      def create_snippet result
+        chomped = result[1].chomp
+        @comments[result[2][0]] =
+          Snippet.new(
+            Range.from_to(result[2][0] || 0, result[2][1] || 0, result[2][0] || 0,
+                          (result[2][1] || 0) + chomped.length), chomped
+          )
+      end
+
+      # @sg-ignore @override is adding, not overriding
+      def on_embdoc_beg *args
+        result = super
+        # @sg-ignore @override is adding, not overriding
+        create_snippet(result)
+        result
+      end
+
+      # @sg-ignore @override is adding, not overriding
+      def on_embdoc *args
+        result = super
+        # @sg-ignore @override is adding, not overriding
+        create_snippet(result)
+        result
+      end
+
+      # @sg-ignore @override is adding, not overriding
+      def on_embdoc_end *args
+        result = super
+        # @sg-ignore @override is adding, not overriding
+        create_snippet(result)
+        result
+      end
+
+      # @return [Hash{Integer => Solargraph::Parser::Snippet}]
+      def parse
+        @comments = {}
+        super
+        @comments
+      end
+    end
+  end
+end