jimeh-solargraph 0.40.4.0

data/lib/solargraph/location.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Solargraph
+  # A section of text identified by its filename and range.
+  #
+  class Location
+    # @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
+
+    # @return [Hash]
+    def to_hash
+      {
+        filename: filename,
+        range: range.to_hash
+      }
+    end
+
+    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
+  end
+end

data/lib/solargraph/logging.rb

@@ -0,0 +1,27 @@
+# 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
+    }
+
+    @@logger = Logger.new(STDERR, level: DEFAULT_LOG_LEVEL)
+    @@logger.formatter = proc do |severity, datetime, progname, msg|
+      "[#{severity}] #{msg}\n"
+    end
+
+    module_function
+
+    # @return [Logger]
+    def logger
+      @@logger
+    end
+  end
+end

data/lib/solargraph/page.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+require 'tilt'
+require 'yard'
+require 'cgi'
+
+module Solargraph
+  class Page
+    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
+        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]
+    # @return [String]
+    def render template, layout: true, locals: {}
+      @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.rb

@@ -0,0 +1,26 @@
+module Solargraph
+  module Parser
+    autoload :CommentRipper, 'solargraph/parser/comment_ripper'
+    autoload :Legacy, 'solargraph/parser/legacy'
+    autoload :Rubyvm, 'solargraph/parser/rubyvm'
+    autoload :Region, 'solargraph/parser/region'
+    autoload :NodeProcessor, 'solargraph/parser/node_processor'
+    autoload :Snippet, 'solargraph/parser/snippet'
+
+    class SyntaxError < StandardError
+    end
+
+    # True if the parser can use RubyVM.
+    #
+    def self.rubyvm?
+      !!defined?(RubyVM::AbstractSyntaxTree)
+      # false
+    end
+
+    selected = rubyvm? ? Rubyvm : Legacy
+    # include selected
+    extend selected::ClassMethods
+
+    NodeMethods = (rubyvm? ? Rubyvm::NodeMethods : Legacy::NodeMethods)
+  end
+end

data/lib/solargraph/parser/comment_ripper.rb

@@ -0,0 +1,52 @@
+require 'ripper'
+
+module Solargraph
+  module Parser
+    class CommentRipper < Ripper::SexpBuilder
+      def initialize src, filename = '(ripper)', lineno = 0
+        super
+        @buffer = src
+        @buffer_lines = @buffer.lines
+      end
+
+      def on_comment *args
+        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
+
+      def on_embdoc_beg *args
+        result = super
+        chomped = result[1].chomp
+        @comments[result[2][0]] = Snippet.new(Range.from_to(result[2][0], result[2][1], result[2][0], result[2][1] + chomped.length), chomped)
+        result
+      end
+
+      def on_embdoc *args
+        result = super
+        chomped = result[1].chomp
+        @comments[result[2][0]] = Snippet.new(Range.from_to(result[2][0], result[2][1], result[2][0], result[2][1] + chomped.length), chomped)
+        result
+      end
+
+      def on_embdoc_end *args
+        result = super
+        chomped = result[1].chomp
+        @comments[result[2][0]] = Snippet.new(Range.from_to(result[2][0], result[2][1], result[2][0], result[2][1] + chomped.length), chomped)
+        result
+      end
+
+      def parse
+        @comments = {}
+        super
+        @comments
+      end
+    end
+  end
+end

data/lib/solargraph/parser/legacy.rb

@@ -0,0 +1,12 @@
+module Solargraph
+  module Parser
+    module Legacy
+      autoload :FlawedBuilder, 'solargraph/parser/legacy/flawed_builder'
+      autoload :ClassMethods, 'solargraph/parser/legacy/class_methods'
+      autoload :NodeMethods, 'solargraph/parser/legacy/node_methods'
+      autoload :NodeChainer, 'solargraph/parser/legacy/node_chainer'
+    end
+  end
+end
+
+require 'solargraph/parser/legacy/node_processors'

data/lib/solargraph/parser/legacy/class_methods.rb

@@ -0,0 +1,109 @@
+require 'parser/current'
+
+module Solargraph
+  module Parser
+    module Legacy
+      module ClassMethods
+        # @param code [String]
+        # @param filename [String]
+        # @return [Array(Parser::AST::Node, Array<Parser::Source::Comment>)]
+        def parse_with_comments code, filename = nil
+          buffer = ::Parser::Source::Buffer.new(filename, 0)
+          buffer.source = code
+          node = parser.parse(buffer)
+          comments = CommentRipper.new(code, filename, 0).parse
+          [node, comments]
+        rescue ::Parser::SyntaxError => e
+          raise Parser::SyntaxError, e.message
+        end
+
+        # @param code [String]
+        # @param filename [String, nil]
+        # @param line [Integer]
+        # @return [Parser::AST::Node]
+        def parse code, filename = nil, line = 0
+          buffer = ::Parser::Source::Buffer.new(filename, line)
+          buffer.source = code
+          parser.parse(buffer)
+        rescue ::Parser::SyntaxError => e
+          raise Parser::SyntaxError, e.message
+        end
+
+        # @return [Parser::Base]
+        def parser
+          # @todo Consider setting an instance variable. We might not need to
+          #   recreate the parser every time we use it.
+          parser = ::Parser::CurrentRuby.new(FlawedBuilder.new)
+          parser.diagnostics.all_errors_are_fatal = true
+          parser.diagnostics.ignore_warnings      = true
+          parser
+        end
+
+        def map source
+          NodeProcessor.process(source.node, Region.new(source: source))
+        end
+
+        def returns_from node
+          NodeMethods.returns_from(node)
+        end
+
+        def references source, name
+          inner_node_references(name, source.node).map do |n|
+            offset = Position.to_offset(source.code, NodeMethods.get_node_start_position(n))
+            soff = source.code.index(name, offset)
+            eoff = soff + name.length
+            Location.new(
+              source.filename,
+              Range.new(
+                Position.from_offset(source.code, soff),
+                Position.from_offset(source.code, eoff)
+              )
+            )
+          end
+        end
+
+        # @param name [String]
+        # @param top [AST::Node]
+        # @return [Array<AST::Node>]
+        def inner_node_references name, top
+          result = []
+          if top.is_a?(AST::Node) && top.to_s.include?(":#{name}")
+            result.push top if top.children.any? { |c| c.to_s == name }
+            top.children.each { |c| result.concat inner_node_references(name, c) }
+          end
+          result
+        end
+
+        def chain *args
+          NodeChainer.chain *args
+        end
+
+        def chain_string *args
+          NodeChainer.load_string *args
+        end
+
+        def process_node *args
+          Solargraph::Parser::NodeProcessor.process *args
+        end
+
+        def infer_literal_node_type node
+          NodeMethods.infer_literal_node_type node
+        end
+
+        def version
+          parser.version
+        end
+
+        def is_ast_node? node
+          node.is_a?(::Parser::AST::Node)
+        end
+
+        def node_range node
+          st = Position.new(node.loc.line, node.loc.column)
+          en = Position.new(node.loc.last_line, node.loc.last_column)
+          Range.new(st, en)
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/legacy/flawed_builder.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module Legacy
+      # A custom builder for source parsers that ignores character encoding
+      # issues in literal strings.
+      #
+      class FlawedBuilder < ::Parser::Builders::Default
+        def string_value(token)
+          value(token)
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/legacy/node_chainer.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module Legacy
+      # A factory for generating chains from nodes.
+      #
+      class NodeChainer
+        include NodeMethods
+        Chain = Source::Chain
+
+        # @param node [Parser::AST::Node]
+        # @param filename [String]
+        def initialize node, filename = nil, in_block = false
+          @node = node
+          @filename = filename
+          @in_block = in_block ? 1 : 0
+        end
+
+        # @return [Source::Chain]
+        def chain
+          links = generate_links(@node)
+          Chain.new(links, @node, (Parser.is_ast_node?(@node) && @node.type == :splat))
+        end
+
+        class << self
+          # @param node [Parser::AST::Node]
+          # @param filename [String]
+          # @return [Source::Chain]
+          def chain node, filename = nil, in_block = false
+            NodeChainer.new(node, filename, in_block).chain
+          end
+
+          # @param code [String]
+          # @return [Source::Chain]
+          def load_string(code)
+            node = Parser.parse(code.sub(/\.$/, ''))
+            chain = NodeChainer.new(node).chain
+            chain.links.push(Chain::Link.new) if code.end_with?('.')
+            chain
+          end
+        end
+
+        private
+
+        # @param n [Parser::AST::Node]
+        # @return [Array<Chain::Link>]
+        def generate_links n
+          return [] unless n.is_a?(::Parser::AST::Node)
+          return generate_links(n.children[0]) if n.type == :begin
+          return generate_links(n.children[0]) if n.type == :splat
+          result = []
+          if n.type == :block
+            @in_block += 1
+            result.concat generate_links(n.children[0])
+            @in_block -= 1
+          elsif n.type == :send
+            if n.children[0].is_a?(::Parser::AST::Node)
+              result.concat generate_links(n.children[0])
+              args = []
+              n.children[2..-1].each do |c|
+                args.push NodeChainer.chain(c)
+              end
+              result.push Chain::Call.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
+            elsif n.children[0].nil?
+              args = []
+              n.children[2..-1].each do |c|
+                args.push NodeChainer.chain(c)
+              end
+              result.push Chain::Call.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
+            else
+              raise "No idea what to do with #{n}"
+            end
+          elsif n.type == :self
+            result.push Chain::Head.new('self')
+          elsif n.type == :zsuper
+            result.push Chain::ZSuper.new('super', @in_block > 0 || block_passed?(n))
+          elsif n.type == :super
+            args = n.children.map { |c| NodeChainer.chain(c) }
+            result.push Chain::Call.new('super', args, @in_block > 0 || block_passed?(n))
+          elsif n.type == :const
+            const = unpack_name(n)
+            result.push Chain::Constant.new(const)
+          elsif [:lvar, :lvasgn].include?(n.type)
+            result.push Chain::Call.new(n.children[0].to_s)
+          elsif [:ivar, :ivasgn].include?(n.type)
+            result.push Chain::InstanceVariable.new(n.children[0].to_s)
+          elsif [:cvar, :cvasgn].include?(n.type)
+            result.push Chain::ClassVariable.new(n.children[0].to_s)
+          elsif [:gvar, :gvasgn].include?(n.type)
+            result.push Chain::GlobalVariable.new(n.children[0].to_s)
+          elsif n.type == :or_asgn
+            result.concat generate_links n.children[1]
+          elsif [:class, :module, :def, :defs].include?(n.type)
+            # @todo Undefined or what?
+            result.push Chain::UNDEFINED_CALL
+          elsif n.type == :and
+            result.concat generate_links(n.children.last)
+          elsif n.type == :or
+            result.push Chain::Or.new([NodeChainer.chain(n.children[0], @filename), NodeChainer.chain(n.children[1], @filename)])
+          elsif [:begin, :kwbegin].include?(n.type)
+            result.concat generate_links(n.children[0])
+          elsif n.type == :block_pass
+            result.push Chain::BlockVariable.new("&#{n.children[0].children[0].to_s}")
+          else
+            lit = infer_literal_node_type(n)
+            result.push (lit ? Chain::Literal.new(lit) : Chain::Link.new)
+          end
+          result
+        end
+
+        def block_passed? node
+          node.children.last.is_a?(::Parser::AST::Node) && node.children.last.type == :block_pass
+        end
+      end
+    end
+  end
+end