solargraph 0.32.1 → 0.32.2

data/lib/solargraph/yard_map/cache.rb

@@ -1,17 +1,17 @@
-module Solargraph
-  class YardMap
-    class Cache
-      def initialize
-        @path_pins = {}
-      end
-
-      def set_path_pins path, pins
-        @path_pins[path] = pins
-      end
-
-      def get_path_pins path
-        @path_pins[path]
-      end
-    end
-  end
-end
+module Solargraph
+  class YardMap
+    class Cache
+      def initialize
+        @path_pins = {}
+      end
+
+      def set_path_pins path, pins
+        @path_pins[path] = pins
+      end
+
+      def get_path_pins path
+        @path_pins[path]
+      end
+    end
+  end
+end

data/lib/solargraph/yard_map/core_docs.rb

@@ -1,163 +1,163 @@
-require 'net/http'
-require 'uri'
-require 'json'
-require 'fileutils'
-
-module Solargraph
-  class YardMap
-    # Tools for managing core documentation.
-    #
-    module CoreDocs
-      # The URL for downloading core documentation
-      SOURCE = 'https://solargraph.org/download'
-
-      # The default core documentation version
-      DEFAULT = '2.2.2'
-
-      class << self
-        # The directory where core documentation is installed.
-        #
-        # @return [String]
-        def cache_dir
-          # The directory is not stored in a variable so it can be overridden
-          # in specs.
-          ENV['SOLARGRAPH_CACHE'] || File.join(Dir.home, '.solargraph', 'cache')
-        end
-
-        # Ensure installation of minimum documentation.
-        #
-        # @return [void]
-        def require_minimum
-          return unless best_match.nil?
-          FileUtils.mkdir_p cache_dir
-          FileUtils.cp File.join(Solargraph::YARDOC_PATH, "#{DEFAULT}.tar.gz"), cache_dir
-          install_archive File.join(cache_dir, "#{DEFAULT}.tar.gz")
-        end
-
-        # True if core documentation is installed for the specified version
-        # number.
-        #
-        # @param ver [String] The version number to check
-        # @return [Boolean]
-        def valid?(ver)
-          dir = File.join(cache_dir, ver)
-          return false unless File.directory?(dir)
-          return false unless File.directory?(File.join(dir, 'yardoc'))
-          return false unless File.directory?(File.join(dir, 'yardoc-stdlib'))
-          true
-        end
-
-        # Get a list of version numbers for currently installed core
-        # documentation.
-        #
-        # @return [Array<String>] The installed version numbers
-        def versions
-          dirs = Dir[File.join(cache_dir, '*')].map{|d| File.basename(d)}
-          dirs.keep_if{|d| valid?(d)}
-          dirs.sort!{|a, b| Gem::Version.new(b) <=> Gem::Version.new(a)}
-          dirs
-        end
-
-        # Get the version number of the installed core documentation that is
-        # the closest match for the current Ruby version.
-        #
-        # @return [String] The closest match
-        def best_match
-          avail = versions
-          cur = Gem::Version.new(RUBY_VERSION)
-          avail.each do |v|
-            return v if Gem::Version.new(v) <= cur
-          end
-          avail.last
-        end
-
-        # Get a list of core documentation versions that are available for
-        # download.
-        #
-        # @return [Array<String>] The version numbers
-        def available
-          uri = URI.parse("#{SOURCE}/versions.json")
-          response = Net::HTTP.get_response(uri)
-          obj = JSON.parse(response.body)
-          raise SourceNotAvailableError, "Error connecting to #{SOURCE}" unless obj['status'] == 'ok'
-          obj['cores']
-        end
-
-        # Get the version number of core documentation available for download
-        # that is the closest match for the current Ruby version.
-        #
-        # @param current [String] The version to compare
-        # @return [String] The version number of the best match
-        def best_download current = RUBY_VERSION
-          rv = Gem::Version.new(current)
-          found = available
-          found.each do |ver|
-            return ver if Gem::Version.new(ver) <= rv
-          end
-          found.last
-        end
-
-        # Get the path to a yardoc file for Ruby core documentation.
-        #
-        # @param ver [String] The version number (best match is default)
-        # @return [String] The path to the yardoc
-        def yardoc_file(ver = best_match)
-          raise ArgumentError, "Invalid core yardoc version #{ver}" unless valid?(ver)
-          File.join(cache_dir, ver, 'yardoc')
-        end
-
-        # Get the path to a yardoc file for Ruby stdlib documentation.
-        #
-        # @param ver [String] The version number (best match is default)
-        # @return [String] The path to the yardoc
-        def yardoc_stdlib_file(ver = best_match)
-          raise ArgumentError, "Invalid core yardoc version #{ver}" unless valid?(ver)
-          File.join(cache_dir, ver, 'yardoc-stdlib')
-        end
-
-        # Download the specified version of core documentation.
-        #
-        # @param version [String]
-        # @return [void]
-        def download version
-          FileUtils.mkdir_p cache_dir
-          uri = URI.parse("#{SOURCE}/#{version}.tar.gz")
-          response = Net::HTTP.get_response(uri)
-          zipfile = File.join(cache_dir, "#{version}.tar.gz")
-          File.binwrite zipfile, response.body
-          install_archive zipfile
-        end
-
-        # Reset the core documentation cache to the minimum requirement.
-        #
-        # @return [void]
-        def clear
-          FileUtils.rm_rf cache_dir, secure: true
-          require_minimum
-        end
-
-        private
-
-        # Extract the specified archive to the core cache directory.
-        #
-        # @param filename [String]
-        # @return [void]
-        def install_archive filename
-          tar_extract = Gem::Package::TarReader.new(Zlib::GzipReader.open(filename))
-          tar_extract.rewind
-          tar_extract.each do |entry|
-            if entry.directory?
-              FileUtils.mkdir_p File.join(cache_dir, entry.full_name)
-            else
-              FileUtils.mkdir_p File.join(cache_dir, File.dirname(entry.full_name))
-              File.open(File.join(cache_dir, entry.full_name), 'wb') do |f|
-                f << entry.read
-              end
-            end
-          end
-          tar_extract.close
-        end
-      end
-    end
-  end
-end
+require 'net/http'
+require 'uri'
+require 'json'
+require 'fileutils'
+
+module Solargraph
+  class YardMap
+    # Tools for managing core documentation.
+    #
+    module CoreDocs
+      # The URL for downloading core documentation
+      SOURCE = 'https://solargraph.org/download'
+
+      # The default core documentation version
+      DEFAULT = '2.2.2'
+
+      class << self
+        # The directory where core documentation is installed.
+        #
+        # @return [String]
+        def cache_dir
+          # The directory is not stored in a variable so it can be overridden
+          # in specs.
+          ENV['SOLARGRAPH_CACHE'] || File.join(Dir.home, '.solargraph', 'cache')
+        end
+
+        # Ensure installation of minimum documentation.
+        #
+        # @return [void]
+        def require_minimum
+          return unless best_match.nil?
+          FileUtils.mkdir_p cache_dir
+          FileUtils.cp File.join(Solargraph::YARDOC_PATH, "#{DEFAULT}.tar.gz"), cache_dir
+          install_archive File.join(cache_dir, "#{DEFAULT}.tar.gz")
+        end
+
+        # True if core documentation is installed for the specified version
+        # number.
+        #
+        # @param ver [String] The version number to check
+        # @return [Boolean]
+        def valid?(ver)
+          dir = File.join(cache_dir, ver)
+          return false unless File.directory?(dir)
+          return false unless File.directory?(File.join(dir, 'yardoc'))
+          return false unless File.directory?(File.join(dir, 'yardoc-stdlib'))
+          true
+        end
+
+        # Get a list of version numbers for currently installed core
+        # documentation.
+        #
+        # @return [Array<String>] The installed version numbers
+        def versions
+          dirs = Dir[File.join(cache_dir, '*')].map{|d| File.basename(d)}
+          dirs.keep_if{|d| valid?(d)}
+          dirs.sort!{|a, b| Gem::Version.new(b) <=> Gem::Version.new(a)}
+          dirs
+        end
+
+        # Get the version number of the installed core documentation that is
+        # the closest match for the current Ruby version.
+        #
+        # @return [String] The closest match
+        def best_match
+          avail = versions
+          cur = Gem::Version.new(RUBY_VERSION)
+          avail.each do |v|
+            return v if Gem::Version.new(v) <= cur
+          end
+          avail.last
+        end
+
+        # Get a list of core documentation versions that are available for
+        # download.
+        #
+        # @return [Array<String>] The version numbers
+        def available
+          uri = URI.parse("#{SOURCE}/versions.json")
+          response = Net::HTTP.get_response(uri)
+          obj = JSON.parse(response.body)
+          raise SourceNotAvailableError, "Error connecting to #{SOURCE}" unless obj['status'] == 'ok'
+          obj['cores']
+        end
+
+        # Get the version number of core documentation available for download
+        # that is the closest match for the current Ruby version.
+        #
+        # @param current [String] The version to compare
+        # @return [String] The version number of the best match
+        def best_download current = RUBY_VERSION
+          rv = Gem::Version.new(current)
+          found = available
+          found.each do |ver|
+            return ver if Gem::Version.new(ver) <= rv
+          end
+          found.last
+        end
+
+        # Get the path to a yardoc file for Ruby core documentation.
+        #
+        # @param ver [String] The version number (best match is default)
+        # @return [String] The path to the yardoc
+        def yardoc_file(ver = best_match)
+          raise ArgumentError, "Invalid core yardoc version #{ver}" unless valid?(ver)
+          File.join(cache_dir, ver, 'yardoc')
+        end
+
+        # Get the path to a yardoc file for Ruby stdlib documentation.
+        #
+        # @param ver [String] The version number (best match is default)
+        # @return [String] The path to the yardoc
+        def yardoc_stdlib_file(ver = best_match)
+          raise ArgumentError, "Invalid core yardoc version #{ver}" unless valid?(ver)
+          File.join(cache_dir, ver, 'yardoc-stdlib')
+        end
+
+        # Download the specified version of core documentation.
+        #
+        # @param version [String]
+        # @return [void]
+        def download version
+          FileUtils.mkdir_p cache_dir
+          uri = URI.parse("#{SOURCE}/#{version}.tar.gz")
+          response = Net::HTTP.get_response(uri)
+          zipfile = File.join(cache_dir, "#{version}.tar.gz")
+          File.binwrite zipfile, response.body
+          install_archive zipfile
+        end
+
+        # Reset the core documentation cache to the minimum requirement.
+        #
+        # @return [void]
+        def clear
+          FileUtils.rm_rf cache_dir, secure: true
+          require_minimum
+        end
+
+        private
+
+        # Extract the specified archive to the core cache directory.
+        #
+        # @param filename [String]
+        # @return [void]
+        def install_archive filename
+          tar_extract = Gem::Package::TarReader.new(Zlib::GzipReader.open(filename))
+          tar_extract.rewind
+          tar_extract.each do |entry|
+            if entry.directory?
+              FileUtils.mkdir_p File.join(cache_dir, entry.full_name)
+            else
+              FileUtils.mkdir_p File.join(cache_dir, File.dirname(entry.full_name))
+              File.open(File.join(cache_dir, entry.full_name), 'wb') do |f|
+                f << entry.read
+              end
+            end
+          end
+          tar_extract.close
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/yard_map/core_gen.rb

@@ -1,76 +1,76 @@
-require 'fileutils'
-require 'tmpdir'
-require 'pathname'
-require 'rubygems/package'
-require 'shellwords'
-
-module Solargraph
-  class YardMap
-    # Tools for generating core documentation.
-    #
-    module CoreGen
-      class << self
-        # Generate documentation from the specified Ruby source directory.
-        #
-        # @param ruby_dir [String] The Ruby source directory
-        # @param dest_dir [String] The destination directory for the yardocs
-        # @return [void]
-        def generate_docs ruby_dir, dest_dir
-          path_name = Pathname.new(Dir.pwd).join(dest_dir).to_s
-          FileUtils.mkdir_p path_name
-          Dir.chdir(ruby_dir) do
-            `yardoc --plugin coregen -b "#{File.join(path_name, 'yardoc')}" -n *.c`
-            raise 'An error occurred generating the core yardoc.' unless $?.success?
-            # YARD::CLI::Yardoc.run('--plugin', 'coregen', '-b', "#{File.join(path_name, 'yardoc')}", '-n', File.join(ruby_dir, '*.c'))
-            `yardoc -b "#{File.join(path_name, 'yardoc-stdlib')}" -n lib ext`
-            raise 'An error occurred generating the stdlib yardoc.' unless $?.success?
-            # YARD::CLI::Yardoc.run('-b', "#{File.join(path_name, 'yardoc-stdlib')}", '-n', File.join(ruby_dir, 'lib', '**', '*.rb'), File.join(ruby_dir, 'ext', '**', '*.c'), File.join(ruby_dir, 'ext', '**', '*.rb'))
-          end
-        end
-
-        # Generate a gzip of documentation from the specified Ruby source
-        # directory.
-        #
-        # This method is designed to generate the directory architecture that
-        # YardMap core docs expect.
-        #
-        # @param ruby_dir [String] The Ruby source directory
-        # @param ver_name [String, nil] The version name
-        # @param dest_dir [String] The destination directory
-        # @return [void]
-        def generate_gzip ruby_dir, ver_name = nil, dest_dir = Dir.pwd
-          Dir.mktmpdir do |tmp|
-            base_name = ver_name || begin
-              match = ruby_dir.match(/\d+\.\d+\.\d+$/)
-              raise "Unable to determine version name from #{ruby_dir}" if match.nil?
-              match[0]
-            end
-            path_name = Pathname.new(tmp).join(base_name).to_s
-            generate_docs ruby_dir, path_name
-            gzip path_name, Pathname.new(dest_dir).join("#{base_name}.tar.gz").to_s
-          end
-        end
-
-        private
-
-        # @param dir [String] The directory to compress
-        # @param dst [String] The destination file
-        def gzip dir, dst
-          File.open(dst, 'wb') do |file|
-            Zlib::GzipWriter.wrap(file) do |gzip|
-              Gem::Package::TarWriter.new(gzip) do |tar|
-                Dir["#{dir}/**/*"].each do |filename|
-                  next if File.directory?(filename)
-                  relname = File.join(File.basename(dir), filename[dir.length+1..-1])
-                  tar.add_file_simple(relname, 0o644, File.size(filename)) do |io|
-                    io.write File.read_binary(filename)
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+require 'fileutils'
+require 'tmpdir'
+require 'pathname'
+require 'rubygems/package'
+require 'shellwords'
+
+module Solargraph
+  class YardMap
+    # Tools for generating core documentation.
+    #
+    module CoreGen
+      class << self
+        # Generate documentation from the specified Ruby source directory.
+        #
+        # @param ruby_dir [String] The Ruby source directory
+        # @param dest_dir [String] The destination directory for the yardocs
+        # @return [void]
+        def generate_docs ruby_dir, dest_dir
+          path_name = Pathname.new(Dir.pwd).join(dest_dir).to_s
+          FileUtils.mkdir_p path_name
+          Dir.chdir(ruby_dir) do
+            `yardoc --plugin coregen -b "#{File.join(path_name, 'yardoc')}" -n *.c`
+            raise 'An error occurred generating the core yardoc.' unless $?.success?
+            # YARD::CLI::Yardoc.run('--plugin', 'coregen', '-b', "#{File.join(path_name, 'yardoc')}", '-n', File.join(ruby_dir, '*.c'))
+            `yardoc -b "#{File.join(path_name, 'yardoc-stdlib')}" -n lib ext`
+            raise 'An error occurred generating the stdlib yardoc.' unless $?.success?
+            # YARD::CLI::Yardoc.run('-b', "#{File.join(path_name, 'yardoc-stdlib')}", '-n', File.join(ruby_dir, 'lib', '**', '*.rb'), File.join(ruby_dir, 'ext', '**', '*.c'), File.join(ruby_dir, 'ext', '**', '*.rb'))
+          end
+        end
+
+        # Generate a gzip of documentation from the specified Ruby source
+        # directory.
+        #
+        # This method is designed to generate the directory architecture that
+        # YardMap core docs expect.
+        #
+        # @param ruby_dir [String] The Ruby source directory
+        # @param ver_name [String, nil] The version name
+        # @param dest_dir [String] The destination directory
+        # @return [void]
+        def generate_gzip ruby_dir, ver_name = nil, dest_dir = Dir.pwd
+          Dir.mktmpdir do |tmp|
+            base_name = ver_name || begin
+              match = ruby_dir.match(/\d+\.\d+\.\d+$/)
+              raise "Unable to determine version name from #{ruby_dir}" if match.nil?
+              match[0]
+            end
+            path_name = Pathname.new(tmp).join(base_name).to_s
+            generate_docs ruby_dir, path_name
+            gzip path_name, Pathname.new(dest_dir).join("#{base_name}.tar.gz").to_s
+          end
+        end
+
+        private
+
+        # @param dir [String] The directory to compress
+        # @param dst [String] The destination file
+        def gzip dir, dst
+          File.open(dst, 'wb') do |file|
+            Zlib::GzipWriter.wrap(file) do |gzip|
+              Gem::Package::TarWriter.new(gzip) do |tar|
+                Dir["#{dir}/**/*"].each do |filename|
+                  next if File.directory?(filename)
+                  relname = File.join(File.basename(dir), filename[dir.length+1..-1])
+                  tar.add_file_simple(relname, 0o644, File.size(filename)) do |io|
+                    io.write File.read_binary(filename)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end