solargraph 0.33.2 → 0.34.0

data/lib/solargraph/yard_map/cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class YardMap
     class Cache

data/lib/solargraph/yard_map/core_docs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'uri'
 require 'json'

data/lib/solargraph/yard_map/core_gen.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'tmpdir'
 require 'pathname'

data/lib/solargraph/yard_map/mapper.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module Solargraph
   class YardMap
     class Mapper
+      @@object_file_cache = {}
+
       # @param code_objects [Array<YARD::CodeObject::Base>]
       # @param spec [Gem::Specification]
       def initialize code_objects, spec = nil
@@ -22,9 +26,8 @@ module Solargraph
       # @return [Array<Pin::Base>]
       def generate_pins code_object
         result = []
-        location = object_location(code_object, @spec)
         if code_object.is_a?(YARD::CodeObjects::NamespaceObject)
-          nspin = Solargraph::Pin::YardPin::Namespace.new(code_object, location)
+          nspin = Solargraph::Pin::YardPin::Namespace.new(code_object, @spec)
           @namespace_pins[code_object.path] = nspin
           result.push nspin
           if code_object.is_a?(YARD::CodeObjects::ClassObject) and !code_object.superclass.nil?
@@ -36,14 +39,13 @@ module Solargraph
             else
               superclass = code_object.superclass.to_s
             end
-            result.push Solargraph::Pin::Reference::Superclass.new(location: location, name: superclass, closure: nspin)
+            result.push Solargraph::Pin::Reference::Superclass.new(name: superclass, closure: nspin)
           end
           code_object.class_mixins.each do |m|
-            result.push Solargraph::Pin::Reference::Extend.new(location: location, closure: nspin, name: m.path)
+            result.push Solargraph::Pin::Reference::Extend.new(closure: nspin, name: m.path)
           end
           code_object.instance_mixins.each do |m|
             result.push Solargraph::Pin::Reference::Include.new(
-              location: location,
               closure: nspin, # @todo Fix this
               name: m.path
             )
@@ -52,30 +54,29 @@ module Solargraph
           closure = @namespace_pins[code_object.namespace.to_s]
           if code_object.name == :initialize && code_object.scope == :instance
             # @todo Check the visibility of <Class>.new
-            result.push Solargraph::Pin::YardPin::Method.new(code_object, location, 'new', :class, :public, closure)
-            result.push Solargraph::Pin::YardPin::Method.new(code_object, location, 'initialize', :instance, :private, closure)
+            result.push Solargraph::Pin::YardPin::Method.new(code_object, 'new', :class, :public, closure, @spec)
+            result.push Solargraph::Pin::YardPin::Method.new(code_object, 'initialize', :instance, :private, closure, @spec)
           else
-            result.push Solargraph::Pin::YardPin::Method.new(code_object, location, nil, nil, nil, closure)
+            result.push Solargraph::Pin::YardPin::Method.new(code_object, nil, nil, nil, closure, @spec)
           end
         elsif code_object.is_a?(YARD::CodeObjects::ConstantObject)
           closure = @namespace_pins[code_object.namespace]
-          result.push Solargraph::Pin::YardPin::Constant.new(code_object, location, closure)
+          result.push Solargraph::Pin::YardPin::Constant.new(code_object, closure, @spec)
         end
         result
       end
 
       # @param obj [YARD::CodeObjects::Base]
       # @return [Solargraph::Location, nil]
-      def object_location obj, spec = nil
-        @object_file_cache ||= {}
+      def self.object_location obj, spec = nil
         return nil if spec.nil? || obj.file.nil? || obj.line.nil?
         file = nil
-        if @object_file_cache.key?(obj.file)
-          file = @object_file_cache[obj.file]
+        if @@object_file_cache.key?(obj.file)
+          file = @@object_file_cache[obj.file]
         else
           tmp = File.join(spec.full_gem_path, obj.file)
           file = tmp if File.exist?(tmp)
-          @object_file_cache[obj.file] = file
+          @@object_file_cache[obj.file] = file
         end
         return nil if file.nil?
         Solargraph::Location.new(file, Solargraph::Range.from_to(obj.line - 1, 0, obj.line - 1, 0))

data/lib/solargraph/yard_map/rdoc_to_yard.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'rdoc'
+require 'rdoc/rdoc'
+require 'tmpdir'
+require 'fileutils'
+
+module Solargraph
+  class YardMap
+    module RdocToYard
+      extend ApiMap::SourceToYard
+
+      # @param spec [Gem::Specification]
+      def self.run spec
+        Dir.mktmpdir do |tmpdir|
+          rdir = File.join(tmpdir, 'rdoc')
+          Dir.chdir spec.full_gem_path do
+            pins = []
+            pins.push Solargraph::Pin::ROOT_PIN
+            name_hash = {}
+            cmd = "rdoc -q -N -r -o #{rdir}"
+            spec.load_paths.each do |path|
+              cmd += " -i #{path}"
+            end
+            `#{cmd}`
+            store = RDoc::Store.new(rdir)
+            store.load_all
+            store.cache[:modules].each do |mod|
+              # store.load_class(mod)
+              # @type [RDoc::NormalClass]
+              mod = store.find_class_or_module(mod)
+              closure = pins.select { |pin| pin.path == mod.full_name.split('::')[0..-2].join('::') }.first || pins.first
+              namepin = Solargraph::Pin::Namespace.new(
+                type: (mod.module? ? :module : :class),
+                name: mod.name,
+                comments: commentary(mod.comment),
+                closure: closure,
+                location: locate(mod)
+              )
+              mod.parse(mod.comment_location)
+              # @param inc [RDoc::Include]
+              mod.includes.each do |inc|
+                pins.push Solargraph::Pin::Reference::Include.new(
+                  location: locate(inc),
+                  name: inc.name,
+                  closure: namepin
+                )
+              end
+              # @param inc [RDoc::Extend]
+              mod.extends.each do |ext|
+                pins.push Solargraph::Pin::Reference::Extend.new(
+                  location: locate(ext),
+                  name: ext.name,
+                  closure: namepin
+                )
+              end
+              pins.push namepin
+              name_hash[mod.full_name] = namepin
+              # @param met [RDoc::AnyMethod]
+              mod.each_method do |met|
+                pin = Solargraph::SourceMap.load_string("def Object.tmp#{met.param_seq};end").first_pin('Object.tmp') || Solargraph::Pin::BaseMethod.new
+                pins.push Solargraph::Pin::Method.new(
+                  name: met.name,
+                  closure: namepin,
+                  comments: commentary(met.comment),
+                  scope: met.type.to_sym,
+                  args: pin.parameters,
+                  visibility: met.visibility,
+                  location: locate(met)
+                )
+              end
+              # @param const [RDoc::Constant]
+              mod.each_constant do |const|
+                pins.push Solargraph::Pin::Constant.new(
+                  name: const.name,
+                  closure: namepin,
+                  comments: commentary(const.comment),
+                  location: locate(const)
+                )
+              end
+            end
+            mapstore = Solargraph::ApiMap::Store.new(pins)
+            rake_yard(mapstore)
+            YARD::Registry.clear
+            code_object_map.values.each do |co|
+              YARD::Registry.register(co)
+            end
+            cache_dir = File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{spec.name}-#{spec.version}", "yardoc")
+            FileUtils.remove_entry_secure cache_dir if File.exist?(cache_dir)
+            FileUtils.mkdir_p cache_dir
+            # @todo Should merge be true?
+            YARD::Registry.save true, cache_dir
+          end
+        end
+      end
+
+      def self.base_name mod
+        mod.full_name.split('::')[0..-2].join('::')
+      end
+
+      def self.commentary cmnt
+        result = []
+        cmnt.parts.each do |part|
+          result.push RDoc::Markup::ToHtml.new({}).to_html(part.text) if part.respond_to?(:text)
+        end
+        result.join("\n\n")
+      end
+
+      # @param obj [RDoc::Context]
+      def self.locate obj
+        # @todo line is always nil for some reason
+        file, line = find_file(obj)
+        return nil if file.nil?
+        Location.new(
+          file,
+          Range.from_to(line || 1, 0, line || 1, 0)
+        )
+      end
+
+      def self.find_file obj
+        if obj.respond_to?(:in_files) && !obj.in_files.empty?
+          [obj.in_files.first.to_s.sub(/^file /, ''), obj.in_files.first.line]
+        else
+          [obj.file_name, obj.line]
+        end
+      end
+    end
+  end
+end

data/lib/yard-solargraph.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yard'
 
 module Solargraph
@@ -14,6 +16,12 @@ YARD::Tags::Library.define_tag("Type", :type, :with_types_and_name)
 YARD::Tags::Library.define_tag("Yieldself", :yieldself, :with_types)
 # Define a @yieldpublic tag for documenting block domains
 YARD::Tags::Library.define_tag("Yieldpublic", :yieldpublic, :with_types)
+# Define a @return_single_parameter tag for returning e.g. Array parameters
+YARD::Tags::Library.define_tag('ReturnSingleParameter', :return_single_parameter)
+# Define a @yieldparam_single_parameter tag for yielding e.g. Array parameters
+YARD::Tags::Library.define_tag('YieldparamSingleParameter', :yieldparam_single_parameter)
+# Define a @return_value_parameter tag for returning e.g. Hash values
+YARD::Tags::Library.define_tag('ReturnValueParameter', :return_value_parameter)
 # Define a @!domain directive for documenting DSLs
 YARD::Tags::Library.define_directive("domain", :with_types, Solargraph::DomainDirective)
 # Define an @!override directive for overriding method tags

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.33.2
+  version: 0.34.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-21 00:00:00.000000000 Z
+date: 2019-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -262,6 +262,11 @@ files:
 - lib/solargraph/complex_type.rb
 - lib/solargraph/complex_type/type_methods.rb
 - lib/solargraph/complex_type/unique_type.rb
+- lib/solargraph/convention.rb
+- lib/solargraph/convention/base.rb
+- lib/solargraph/convention/gemfile.rb
+- lib/solargraph/convention/gemspec.rb
+- lib/solargraph/convention/rspec.rb
 - lib/solargraph/core_fills.rb
 - lib/solargraph/diagnostics.rb
 - lib/solargraph/diagnostics/base.rb
@@ -271,6 +276,8 @@ files:
 - lib/solargraph/diagnostics/severities.rb
 - lib/solargraph/diagnostics/type_check.rb
 - lib/solargraph/diagnostics/update_errors.rb
+- lib/solargraph/documentor.rb
+- lib/solargraph/environ.rb
 - lib/solargraph/language_server.rb
 - lib/solargraph/language_server/completion_item_kinds.rb
 - lib/solargraph/language_server/error_codes.rb
@@ -349,6 +356,7 @@ files:
 - lib/solargraph/pin/global_variable.rb
 - lib/solargraph/pin/instance_variable.rb
 - lib/solargraph/pin/keyword.rb
+- lib/solargraph/pin/keyword_param.rb
 - lib/solargraph/pin/local_variable.rb
 - lib/solargraph/pin/localized.rb
 - lib/solargraph/pin/method.rb
@@ -435,6 +443,7 @@ files:
 - lib/solargraph/yard_map/core_docs.rb
 - lib/solargraph/yard_map/core_gen.rb
 - lib/solargraph/yard_map/mapper.rb
+- lib/solargraph/yard_map/rdoc_to_yard.rb
 - lib/yard-solargraph.rb
 - solargraph.gemspec
 - travis-bundler.rb