solargraph 0.28.3 → 0.29.0

data/lib/solargraph/source_map.rb

@@ -2,9 +2,11 @@ module Solargraph
   # An index of pins and other ApiMap-related data for a Source.
   #
   class SourceMap
+    autoload :NodeProcessor, 'solargraph/source_map/node_processor'
     autoload :Mapper,        'solargraph/source_map/mapper'
     autoload :Clip,          'solargraph/source_map/clip'
     autoload :Completion,    'solargraph/source_map/completion'
+    autoload :Region,        'solargraph/source_map/region'
 
     # @return [Source]
     attr_reader :source
@@ -15,6 +17,9 @@ module Solargraph
     # @return [Array<Pin::Base>]
     attr_reader :locals
 
+    # @param source [Source]
+    # @param pins [Array<Pin::Base>]
+    # @param locals [Array<Pin::Base>]
     def initialize source, pins, locals
       # HACK: Keep the library from changing this
       @source = source.dup
@@ -22,14 +27,17 @@ module Solargraph
       @locals = locals
     end
 
+    # @return [String]
     def filename
       source.filename
     end
 
+    # @return [String]
     def code
       source.code
     end
 
+    # @return [Array<Pin::Reference::Require>]
     def requires
       @requires ||= pins.select{|p| p.kind == Pin::REQUIRE_REFERENCE}
     end
@@ -46,12 +54,15 @@ module Solargraph
       @source.comment_at?(position)
     end
 
+    # @return [Array<Pin::Base>]
     def document_symbols
       @document_symbols ||= pins.select { |pin|
         [Pin::ATTRIBUTE, Pin::CONSTANT, Pin::METHOD, Pin::NAMESPACE].include?(pin.kind) and !pin.path.empty?
       }
     end
 
+    # @param query [String]
+    # @return [Array<Pin::Base>]
     def query_symbols query
       document_symbols.select{|pin| pin.path.include?(query)}
     end
@@ -82,6 +93,7 @@ module Solargraph
     end
 
     # @param other_map [SourceMap]
+    # @return Boolean
     def try_merge! other_map
       return false if pins.length != other_map.pins.length || locals.length != other_map.locals.length || requires.map(&:name).uniq.sort != other_map.requires.map(&:name).uniq.sort
       pins.each_index do |i|
@@ -101,12 +113,15 @@ module Solargraph
     end
 
     class << self
+      # @param filename [String]
       # @return [SourceMap]
       def load filename
         source = Solargraph::Source.load(filename)
         SourceMap.map(source)
       end
 
+      # @param code [String]
+      # @param filename [String, nil]
       # @return [SourceMap]
       def load_string code, filename = nil
         source = Solargraph::Source.load_string(code, filename)

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.28.3'
+  VERSION = '0.29.0'
 end

data/lib/solargraph/workspace.rb

@@ -139,23 +139,38 @@ module Solargraph
       end
     end
 
+    # Generate require paths from gemspecs if they exist or assume the default
+    # lib directory.
+    #
+    # @return [Array<String>]
     def generate_require_paths
       return configured_require_paths if directory.empty? || !gemspec?
       result = []
       gemspecs.each do |file|
+        base = File.dirname(file)
         # @todo Evaluating gemspec files violates the goal of not running
         #   workspace code, but this is how Gem::Specification.load does it
         #   anyway.
-        spec = eval(File.read(file), binding, file)
-        next unless Gem::Specification === spec
-        base = File.dirname(file)
-        result.concat spec.require_paths.map{ |path| File.join(base, path) } unless spec.nil?
+        begin
+           spec = eval(File.read(file), binding, file)
+           next unless Gem::Specification === spec
+           result.concat spec.require_paths.map{ |path| File.join(base, path) } unless spec.nil?
+        rescue Exception => e
+           # Don't die if we have an error during eval-ing a gem spec.
+           # Concat the default lib directory instead.
+           # @todo Should the client be informed of the error through
+           #   diagnostics or some other mechanism?
+           result.push File.join(base, 'lib')
+        end
       end
       result.concat config.require_paths
       result.push File.join(directory, 'lib') if result.empty?
       result
     end
 
+    # Get additional require paths defined in the configuration.
+    #
+    # @return [Array<String>]
     def configured_require_paths
       return ['lib'] if directory.empty?
       return [File.join(directory, 'lib')] if config.require_paths.empty?

data/lib/solargraph/yard_map.rb

@@ -23,10 +23,14 @@ module Solargraph
     # @return [Array<String>]
     attr_reader :required
 
+    attr_writer :with_dependencies
+
     # @param required [Array<String>]
-    def initialize(required: [])
+    # @param skip_dependencies [Boolean]
+    def initialize(required: [], with_dependencies: true)
       # HACK: YardMap needs its own copy of this array
       @required = required.clone
+      @with_dependencies = with_dependencies
       @gem_paths = {}
       @stdlib_namespaces = []
       process_requires
@@ -38,6 +42,11 @@ module Solargraph
       @pins ||= []
     end
 
+    def with_dependencies?
+      @with_dependencies ||= true unless @with_dependencies == false
+      @with_dependencies
+    end
+
     # @param new_requires [Array<String>]
     # @return [Boolean]
     def change new_requires
@@ -176,8 +185,7 @@ module Solargraph
             unless yardocs.include?(yd)
               yardocs.unshift yd
               result.concat process_yardoc yd
-              # @todo Testing performance
-              # result.concat add_gem_dependencies spec
+              result.concat add_gem_dependencies(spec) if with_dependencies?
             end
           end
         rescue Gem::LoadError => e
@@ -231,17 +239,16 @@ module Solargraph
       (spec.dependencies - spec.development_dependencies).each do |dep|
         begin
           depspec = Gem::Specification.find_by_name(dep.name)
-          @gem_paths[depspec.name] = depspec.full_gem_path unless depspec.nil?
+          next if depspec.nil? || @gem_paths.key?(depspec.name)
+          @gem_paths[depspec.name] = depspec.full_gem_path
           gy = YARD::Registry.yardoc_file_for_gem(dep.name)
           if gy.nil?
             unresolved_requires.push dep.name
           else
-            unless yardocs.include?(gy)
-              yardocs.unshift gy
-              result.concat process_yardoc gy
-              # @todo Trying only one level of dependencies
-              # result.concat add_gem_dependencies(depspec)
-            end
+            next if yardocs.include?(gy)
+            yardocs.unshift gy
+            result.concat process_yardoc gy
+            result.concat add_gem_dependencies(depspec)
           end
         rescue Gem::LoadError
           # This error probably indicates a bug in an installed gem

data/lib/yard-solargraph.rb

@@ -1,6 +1,4 @@
 require 'yard'
-require 'yard/templates/helpers/markup_helper'
-require 'yard/templates/helpers/html_helper'
 
 # Define a @type tag for documenting variables
 YARD::Tags::Library.define_tag("Type", :type, :with_types_and_name)

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.28.3
+  version: 0.29.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: parser
+  name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.5
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: htmlentities
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '4.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: 4.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '4.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: 4.3.4
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: eventmachine
+  name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: reverse_markdown
   requirement: !ruby/object:Gem::Requirement
@@ -99,81 +99,81 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.5
 - !ruby/object:Gem::Dependency
-  name: kramdown
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0.52'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0.52'
 - !ruby/object:Gem::Dependency
-  name: htmlentities
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '0.19'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.3.4
+        version: 0.19.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '0.19'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.3.4
+        version: 0.19.4
 - !ruby/object:Gem::Dependency
-  name: coderay
+  name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: tilt
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
+        version: 0.11.3
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.11.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -208,20 +208,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.3
 description: IDE tools for code completion and inline documentation
 email: admin@castwide.com
 executables:
@@ -319,12 +305,12 @@ files:
 - 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
 - lib/solargraph/pin/keyword.rb
 - lib/solargraph/pin/local_variable.rb
 - lib/solargraph/pin/localized.rb
 - lib/solargraph/pin/method.rb
+- lib/solargraph/pin/method_alias.rb
 - lib/solargraph/pin/method_parameter.rb
 - lib/solargraph/pin/namespace.rb
 - lib/solargraph/pin/plugin/method.rb
@@ -372,6 +358,25 @@ files:
 - lib/solargraph/source_map/clip.rb
 - lib/solargraph/source_map/completion.rb
 - lib/solargraph/source_map/mapper.rb
+- lib/solargraph/source_map/node_processor.rb
+- lib/solargraph/source_map/node_processor/alias_node.rb
+- lib/solargraph/source_map/node_processor/args_node.rb
+- lib/solargraph/source_map/node_processor/base.rb
+- lib/solargraph/source_map/node_processor/begin_node.rb
+- lib/solargraph/source_map/node_processor/block_node.rb
+- lib/solargraph/source_map/node_processor/casgn_node.rb
+- lib/solargraph/source_map/node_processor/cvasgn_node.rb
+- lib/solargraph/source_map/node_processor/def_node.rb
+- lib/solargraph/source_map/node_processor/defs_node.rb
+- lib/solargraph/source_map/node_processor/gvasgn_node.rb
+- lib/solargraph/source_map/node_processor/ivasgn_node.rb
+- lib/solargraph/source_map/node_processor/lvasgn_node.rb
+- lib/solargraph/source_map/node_processor/namespace_node.rb
+- lib/solargraph/source_map/node_processor/orasgn_node.rb
+- lib/solargraph/source_map/node_processor/sclass_node.rb
+- lib/solargraph/source_map/node_processor/send_node.rb
+- lib/solargraph/source_map/node_processor/sym_node.rb
+- lib/solargraph/source_map/region.rb
 - lib/solargraph/version.rb
 - lib/solargraph/views/_method.erb
 - lib/solargraph/views/_name_type_tag.erb

data/lib/solargraph/pin/helper.rb

@@ -1,41 +0,0 @@
-require 'yard'
-
-module Solargraph
-  module Pin
-    class Helper
-      include YARD::Templates::Helpers::HtmlHelper
-
-      attr_accessor :object
-      attr_accessor :serializer
-
-      def initialize object = nil
-        @object = object
-      end
-
-      def url_for(object)
-        '.'
-      end
-
-      def html_markup_rdoc(text)
-        # @todo The :rdoc markup class might not be immediately available.
-        #   If not, return nil for now under the assumption that the problem
-        #   will eventually fix itself.
-        return nil if markup_class(:rdoc).nil?
-        super
-      end
-
-      def options
-        if @options.nil?
-          @options = YARD::Templates::TemplateOptions.new
-          @options[:type] = :rdoc
-        end
-        @options
-      end
-
-      # HACK: The linkify method just returns the arguments as plain text
-      def linkify *args
-        args.join(', ')
-      end
-    end
-  end
-end