solargraph 0.13.3 → 0.14.0

data/lib/solargraph/pin/plugin/method.rb

@@ -0,0 +1,25 @@
+module Solargraph
+  module Pin
+    module Plugin
+      class Method < Base
+        attr_reader :name
+        attr_reader :path
+        attr_reader :return_type
+        attr_reader :parameters
+        attr_reader :scope
+        attr_reader :visibility
+
+        def initialize name:, path:, return_type:, parameters:
+          @name = name
+          @path = path
+          @return_type = return_type
+          @parameters = parameters
+        end
+
+        def kind
+          Solargraph::Suggestion::METHOD
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/plugin/base.rb

@@ -1,37 +1,40 @@
 module Solargraph
   module Plugin
     class Base
+      # @return [Solargraph::ApiMap]
+      attr_reader :api_map
 
-      def initialize workspace
-        # @!attribute [r] workspace
-        #   @return [String]
-        define_singleton_method(:workspace) { workspace }
+      def initialize api_map
+        @api_map = api_map
         post_initialize
       end
 
       def post_initialize
       end
 
-      def start
-        raise "#{self.class} needs to implement the start method"
+      # @return [Array<String>]
+      def get_methods namespace:, root:, scope:, with_private: false
+        []
       end
 
-      def stop
-        raise "#{self.class} needs to implement the stop method"
+      # @return [Array<String>]
+      def get_constants namespace, root
+        []
       end
 
-      def get_methods namespace:, root:, scope:, with_private: false
-        raise "#{self.class} needs to implement the get_methods method"
+      # @return [String]
+      def get_fqns namespace, root
+        nil
       end
 
-      protected
-
-      def respond_ok data
-        Solargraph::Plugin::Response.new('ok', data)
+      # @return [Boolean]
+      def refresh
+        false
       end
 
-      def respond_err exception
-        Solargraph::Plugin::Response.new('err', [], exception.message)
+      # @return [Boolean]
+      def runtime?
+        false
       end
     end
   end

data/lib/solargraph/plugin/canceler.rb

@@ -0,0 +1,11 @@
+module Solargraph
+  module Plugin
+    # A placeholder plugin for disabling the default Runtime plugin.
+    #
+    class Canceler < Base
+      def runtime?
+        true
+      end
+    end
+  end
+end

data/lib/solargraph/plugin/process.rb

@@ -0,0 +1,145 @@
+require 'json'
+
+module Solargraph
+  module Plugin
+    class Process
+      def initialize
+        @required = []
+        post_initialize
+      end
+
+      def post_initialize
+      end
+
+      def run
+        until STDIN.closed?
+          input = gets
+          break if input.nil?
+          args = nil
+          begin
+            args = JSON.parse(input)
+            case args['command']
+            when 'require'
+              STDOUT.puts do_require args['paths']
+            when 'methods'
+              STDOUT.puts get_methods args['params']
+            when 'constants'
+              STDOUT.puts get_constants args['params']
+            when 'fqns'
+              STDOUT.puts get_fqns args['params']
+            else
+              STDOUT.puts respond_err "Unrecognized command #{args['command']}"
+            end
+          rescue JSON::ParserError => e
+            STDOUT.puts respond_err "Error parsing input: #{e.message}"
+          end
+          STDOUT.flush
+        end
+      end
+
+      private
+
+      def do_require paths
+        errors = []
+        paths.each do |p|
+          begin
+            require p
+            @required.push p
+          rescue Exception => e
+            STDERR.puts "Failed to require #{p}: #{e.message}"
+            errors.push "Failed to require #{p}: #{e.class} #{e.message}"
+          end
+        end
+        if errors.empty?
+          respond_ok
+        else
+          respond_err errors.join('; ')
+        end
+      end
+
+      def get_methods args
+        result = []
+        con = find_constant(args['namespace'], args['root'])
+        unless con.nil?
+          if (args['scope'] == 'class')
+            if args['with_private']
+              result.concat con.methods
+            else
+              result.concat con.public_methods
+            end
+          elsif (args['scope'] == 'instance')
+            if args['with_private']
+              result.concat con.instance_methods
+            else
+              result.concat con.public_instance_methods
+            end
+          end
+        end
+        respond_ok result
+      end
+
+      def get_constants args
+        result = []
+        con = find_constant(args['namespace'], args['root'])
+        unless con.nil?
+          #result.concat con.constants
+          con.constants.each do |c|
+            next if c == :Solargraph and !@required.include?('solargraph')
+            item = { name: c }
+            here = con.const_get(c)
+            item[:class] = here.class.to_s
+            result.push item
+          end
+        end
+        respond_ok result
+      end
+
+      def get_fqns args
+        con = find_constant(args['namespace'], args['root'])
+        respond_ok (con.nil? ? nil : con.to_s)
+      end
+
+      def find_constant(namespace, root)
+        result = nil
+        parts = root.split('::')
+        until parts.empty?
+          result = inner_find_constant("#{parts.join('::')}::#{namespace}")
+          parts.pop
+          break unless result.nil?
+        end
+        result = inner_find_constant(namespace) if result.nil?
+        result
+      end
+
+      def inner_find_constant(namespace)
+        cursor = Object
+        parts = namespace.split('::')
+        until parts.empty?
+          here = parts.shift
+          begin
+            cursor = cursor.const_get(here)
+          rescue NameError
+            return nil
+          end
+        end
+        cursor
+      end
+
+      def respond_ok data = []
+        {
+          status: 'ok',
+          message: nil,
+          data: data
+        }.to_json
+      end
+
+      def respond_err msg
+        {
+          status: 'err',
+          message: msg,
+          data: []
+        }.to_json
+      end
+    end
+  end
+end

data/lib/solargraph/plugin/runtime.rb

@@ -1,14 +1,130 @@
+require 'json'
+
 module Solargraph
   module Plugin
     class Runtime < Base
-      def start
+      attr_writer :executable
+
+      def executable
+        @executable ||= 'solargraph-runtime'
+      end
+
+      def post_initialize
+        start_process
       end
 
-      def stop
+      # @return [Boolean]
+      def runtime?
+        true
       end
 
+      # Get an array of method names.
+      #
+      # @return [Array<String>]
       def get_methods namespace:, root:, scope:, with_private: false
-        raise "#{self.class} needs to implement the get_methods method"
+        response = send_get_methods(namespace, root, scope, with_private)
+        response['data']
+      end
+
+      # Get an array of constant names.
+      #
+      # @return [Array<String>]
+      def get_constants namespace, root
+        response = send_get_constants namespace, root
+        response['data']
+      end
+
+      def get_fqns namespace, root
+        response = send_get_fqns namespace, root
+        response['data']
+      end
+
+      def refresh
+        if api_map.nil?
+          false
+        else
+          if @current_required != api_map.required
+            STDERR.puts "Restarting #{self.class} process"
+            @io.close unless @io.nil? or @io.closed?
+            start_process
+            true
+          else
+            false
+          end
+        end
+      end
+
+      protected
+
+      def load_environment
+        return if api_map.nil?
+        STDERR.puts "Required paths given to Runtime: #{api_map.required}"
+        send_require api_map.required
+        @current_required = api_map.required.clone
+      end
+
+      private
+
+      def start_process
+        dir = Dir.pwd
+        unless api_map.nil? or api_map.workspace.nil?
+          dir = api_map.workspace
+        end
+        STDERR.puts "Starting #{self.class} process in #{dir}"
+        Dir.chdir(dir) do
+          @io = IO.popen(executable, 'r+')
+        end
+        load_environment
+      end
+
+      def send_require paths
+        cmd = {
+          command: 'require',
+          paths: paths
+        }
+        transact cmd
+      end
+
+      def send_get_methods namespace, root, scope, with_private
+        cmd = {
+          command: 'methods',
+          params: {
+            namespace: namespace,
+            root: root,
+            scope: scope,
+            with_private: with_private
+          }
+        }
+        transact cmd
+      end
+
+      def send_get_constants namespace, root
+        cmd = {
+          command: 'constants',
+          params: {
+            namespace: namespace,
+            root: root
+          }
+        }
+        transact cmd
+      end
+
+      def send_get_fqns namespace, root
+        cmd = {
+          command: 'fqns',
+          params: {
+            namespace: namespace,
+            root: root
+          }
+        }
+        transact cmd
+      end
+
+      def transact cmd
+        @io.puts cmd.to_json
+        @io.flush
+        result = @io.gets
+        JSON.parse(result)
       end
     end
   end

data/lib/solargraph/plugin.rb

@@ -2,6 +2,7 @@ module Solargraph
   module Plugin
     autoload :Base, 'solargraph/plugin/base'
     autoload :Runtime, 'solargraph/plugin/runtime'
-    autoload :Response, 'solargraph/plugin/response'
+    autoload :Canceler, 'solargraph/plugin/canceler'
+    autoload :Process, 'solargraph/plugin/process'
   end
 end

data/lib/solargraph/server.rb

@@ -47,10 +47,11 @@ module Solargraph
         @@semaphore.synchronize {
           api_map = @@api_hash[workspace]
         }
+        with_all = params['all'] == '1' ? true : false
         code_map = CodeMap.new(code: params['text'], filename: params['filename'], api_map: api_map, cursor: [params['line'].to_i, params['column'].to_i])
         offset = code_map.get_offset(params['line'].to_i, params['column'].to_i)
         sugg = code_map.suggest_at(offset, with_snippets: params['with_snippets'] == '1' ? true : false, filtered: true)
-        JSON.generate({ "status" => "ok", "suggestions" => sugg.map(&:as_json) })
+        JSON.generate({ "status" => "ok", "suggestions" => sugg.map{|s| s.as_json(all: with_all)} })
       rescue Exception => e
         STDERR.puts e
         STDERR.puts e.backtrace.join("\n")
@@ -76,6 +77,20 @@ module Solargraph
       end
     end
 
+    post '/resolve' do
+      content_type :json
+      workspace = params['workspace'] || nil
+      result = []
+      @@semaphore.synchronize {
+        api_map = @@api_hash[workspace]
+        unless api_map.nil?
+          # @todo Get suggestions that match the path
+          result.concat api_map.get_path_suggestions(params['path'])
+        end
+      }
+      { "status" => "ok", "suggestions" => result.map{|s| s.as_json(all: true)} }.to_json
+    end
+
     post '/hover' do
       content_type :json
       begin
@@ -118,6 +133,10 @@ module Solargraph
       erb :document
     end
 
+    post '/shutdown' do
+      exit
+    end
+
     def htmlify text
       rdoc_to_html text
     end
@@ -133,10 +152,6 @@ module Solargraph
     end
 
     class << self
-      #def run!
-      #  super
-      #end
-
       def prepare_workspace directory
         Thread.new do
           @@semaphore.synchronize do
@@ -146,6 +161,7 @@ module Solargraph
           end
         end
       end
+
     end
 
     class Helpers

data/lib/solargraph/server_methods.rb

@@ -1,3 +1,5 @@
+require 'socket'
+
 module Solargraph
   module ServerMethods
     def available_port

data/lib/solargraph/shell.rb

@@ -3,9 +3,6 @@ require 'json'
 require 'fileutils'
 require 'rubygems/package'
 require 'zlib'
-require 'net/http'
-require 'socket'
-require 'bundler'
 
 module Solargraph
   class Shell < Thor
@@ -63,11 +60,31 @@ module Solargraph
       Solargraph::Server.set :port, port
       Solargraph::Server.set :views, options[:views] unless options[:views].nil?
       Solargraph::Server.set :public_folder, options[:files] unless options[:files].nil?
+      my_pid = nil
       Solargraph::Server.run! do
         STDERR.puts "Solargraph server pid=#{Process.pid} port=#{port}"
+        my_pid = Process.pid
+        Signal.trap("INT") do
+          Solargraph::Server.stop!
+        end
+        Signal.trap("TERM") do
+          Solargraph::Server.stop!
+        end
       end
     end
     
+
+    desc 'plugin PLUGIN_NAME', 'Run a Solargraph runtime plugin'
+    option :workspace, type: :string, aliases: :w, desc: 'The workspace'
+    option :port, type: :numeric, aliases: :p, desc: 'The server port', required: true
+    option :ppid, type: :numeric, desc: 'ppid'
+    def plugin plugin_name
+      # @todo Find the correct plugin based on the provided name
+      cls = Solargraph::Plugin::Runtime
+      #SolargraphRailsExt::Server.new(options[:workspace], options[:port]).run
+      cls.serve options[:workspace], options[:port], options[:ppid]
+    end
+
     desc 'suggest', 'Get code suggestions for the provided input'
     long_desc <<-LONGDESC
       Analyze a Ruby file and output a list of code suggestions in JSON format.

data/lib/solargraph/suggestion.rb

@@ -96,8 +96,11 @@ module Solargraph
       @params
     end
 
+    def inject_detail
+    end
+
     def as_json args = {}
-      {
+      result = {
         label: @label,
         kind: @kind,
         insert: @insert,
@@ -106,17 +109,19 @@ module Solargraph
         location: (@location.nil? ? nil : @location.to_s),
         arguments: @arguments,
         params: params,
-        return_type: return_type,
-        documentation: documentation
+        return_type: return_type
       }
+      result[:documentation] = documentation if args[:all]
+      result
     end
 
     def to_json args = {}
       as_json.to_json(args)
     end
 
+    # @param pin [Solargraph::Pin::Base]
     def self.pull pin, return_type = nil
-      Suggestion.new(pin.name, insert: pin.name.gsub(/=/, ' = '), kind: pin.kind, docstring: pin.docstring, detail: pin.namespace, arguments: pin.parameters, path: pin.path, return_type: return_type)
+      Suggestion.new(pin.name, insert: pin.name.gsub(/=/, ' = '), kind: pin.kind, docstring: pin.docstring, detail: pin.namespace, arguments: pin.parameters, path: pin.path, return_type: return_type, location: pin.location)
     end
   end
 

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.13.3'
+  VERSION = '0.14.0'
 end

data/lib/solargraph/yard_map.rb

@@ -2,8 +2,14 @@ require 'parser/current'
 require 'yard'
 
 module Solargraph
-
   class YardMap
+    @@stdlib_yardoc = File.join(Dir.home, '.solargraph', 'cache', '2.0.0', 'yardoc-stdlib')
+    @@stdlib_namespaces = []
+    YARD::Registry.load! @@stdlib_yardoc
+    YARD::Registry.all(:class, :module).each do |ns|
+      @@stdlib_namespaces.push ns.path
+    end
+
     autoload :Cache, 'solargraph/yard_map/cache'
 
     attr_reader :workspace
@@ -35,6 +41,7 @@ module Solargraph
         end
       end
       yardocs.push File.join(Dir.home, '.solargraph', 'cache', '2.0.0', 'yardoc')
+      #yardocs.push File.join(Dir.home, '.solargraph', 'cache', '2.0.0', 'yardoc-stdlib')
       yardocs.uniq!
       yardocs.each do |y|
         load_yardoc y
@@ -43,7 +50,7 @@ module Solargraph
           @namespace_yardocs[ns.path].push y
         end
       end
-      #cache_core
+      cache_core
     end
 
     # @return [Solargraph::LiveMap]
@@ -73,7 +80,7 @@ module Solargraph
     # @param query [String]
     def search query
       found = []
-      yardocs.each { |y|
+      (yardocs + [@@stdlib_yardoc]).each { |y|
         yard = load_yardoc(y)
         unless yard.nil?
           yard.paths.each { |p|
@@ -87,7 +94,7 @@ module Solargraph
     # @param query [String]
     def document query
       found = []
-      yardocs.each { |y|
+      (yardocs + [@@stdlib_yardoc]).each { |y|
         yard = load_yardoc(y)
         unless yard.nil?
           obj = yard.at query
@@ -256,6 +263,22 @@ module Solargraph
       result
     end
 
+    # @return [Symbol] :class, :module, or nil
+    def get_namespace_type(fqns)
+      yardocs_documenting(fqns).each do |y|
+        yard = load_yardoc y
+        unless yard.nil?
+          obj = yard.at(fqns)
+          unless obj.nil?
+            return :class if obj.kind_of?(YARD::CodeObjects::ClassObject)
+            return :module if obj.kind_of?(YARD::CodeObjects::ModuleObject)
+            return nil
+          end
+        end
+      end
+      nil
+    end
+
     def bundled_gem_yardocs
       result = []
       unless workspace.nil?
@@ -320,7 +343,7 @@ module Solargraph
     end
 
     def cache_core
-      c = get_constants '', ''
+      get_constants '', ''
     end
 
     def kind_of_object obj
@@ -340,7 +363,7 @@ module Solargraph
       spec.nondevelopment_dependencies.each do |dep|
         gy = YARD::Registry.yardoc_file_for_gem(dep.name)
         if gy.nil?
-          STDERR.puts "Required path not found: #{r}"
+          STDERR.puts "Required path not found: #{dep.name}"
         else
           #STDERR.puts "Adding #{gy}"
           yardocs.unshift gy
@@ -367,6 +390,7 @@ module Solargraph
       else
         result.concat @namespace_yardocs[namespace] unless @namespace_yardocs[namespace].nil?
       end
+      result.push @@stdlib_yardoc if result.empty? and @@stdlib_namespaces.include?(namespace)
       result
     end
   end

data/lib/solargraph.rb

@@ -3,9 +3,7 @@ require 'rubygems/package'
 require 'yard-solargraph'
 
 module Solargraph
-  autoload :Analyzer,      'solargraph/analyzer'
   autoload :Shell,         'solargraph/shell'
-  autoload :LiveParser,    'solargraph/live_parser'
   autoload :ApiMap,        'solargraph/api_map'
   autoload :CodeMap,       'solargraph/code_map'
   autoload :NodeMethods,   'solargraph/node_methods'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.14.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2017-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -180,10 +180,12 @@ description: IDE tools for code completion and inline documentation
 email: admin@castwide.com
 executables:
 - solargraph
+- solargraph-runtime
 extensions: []
 extra_rdoc_files: []
 files:
 - bin/solargraph
+- bin/solargraph-runtime
 - lib/solargraph.rb
 - lib/solargraph/api_map.rb
 - lib/solargraph/api_map/cache.rb
@@ -206,10 +208,12 @@ files:
 - lib/solargraph/pin/instance_variable.rb
 - lib/solargraph/pin/local_variable.rb
 - lib/solargraph/pin/method.rb
+- lib/solargraph/pin/plugin/method.rb
 - lib/solargraph/pin/symbol.rb
 - lib/solargraph/plugin.rb
 - lib/solargraph/plugin/base.rb
-- lib/solargraph/plugin/response.rb
+- lib/solargraph/plugin/canceler.rb
+- lib/solargraph/plugin/process.rb
 - lib/solargraph/plugin/runtime.rb
 - lib/solargraph/server.rb
 - lib/solargraph/server_methods.rb