solargraph 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acab722ec6710f43f14625320985dbcd30dd2e19
-  data.tar.gz: c19b6542c62b928a4b585df460a131e70ab58912
+  metadata.gz: e99bdc143ca29ca298dc48668e2eab23a73fb338
+  data.tar.gz: a2c8fc45842f2d30f30c964f427962992223315e
 SHA512:
-  metadata.gz: e310d1270047cd3dbd9f21c4249efeaf3342417233bf1484f0e4cb86d944b1a6c24bf900a4a00580c86413f9b130f51289a705579e533f5bbdeab02958b13b49
-  data.tar.gz: 6815c3a16e85e7246e86ca3fe7358b4732b91fac3a09867fd149c32d9be7903436ac10f72650ddfb472164ca0be7bd322822da8be43385261844a9c581f109c5
+  metadata.gz: e7eee90d32b54be8ed26faa90c55794c68981e90e6fae4dfafba8a226847bb06fe90485876a82be679d83bca3fac5eb33c63072d98a517418c6437ba91956873
+  data.tar.gz: c8b992d21569e07e36db02c08c332c7309ee206daf81ff5489ce440a308b50d1e6cdabc337b728ecd37403e745f1f6fc4ffbb1562e3d486908f8372b2cafcd5d

data/lib/solargraph/api_map.rb

@@ -15,14 +15,20 @@ module Solargraph
     MAPPABLE_METHODS = [
       :include, :require, :autoload, :attr_reader, :attr_writer, :attr_accessor, :private, :public, :protected
     ]
+
     include NodeMethods
     
     attr_reader :workspace
 
     def initialize workspace = nil
       @workspace = workspace
-      #process_workspace
       clear
+      unless @workspace.nil? #or has_yardoc?
+        files = Dir[File.join workspace, 'lib', '**', '*.rb'] + Dir[File.join workspace, 'app', '**', '*.rb']
+        files.each { |f|
+          append_file f
+        }
+      end
     end
 
     def clear
@@ -31,17 +37,12 @@ module Solargraph
       @parent_stack = {}
       @namespace_map = {}
       @namespace_tree = {}
-      #@pending_requires = []
       @required = []
     end
 
-    #def process_workspace
-    #  clear
-    #  return if @workspace.nil?
-    #  process_files
-    #  process_requires
-    #  process_maps
-    #end
+    def has_yardoc?
+      workspace and File.exist?(File.join(workspace, '.yardoc'))
+    end
 
     def append_file filename
       append_source File.read(filename), filename
@@ -53,22 +54,21 @@ module Solargraph
     end
 
     def append_node node, comments, filename = nil
-      mapified = mapify(node)
+      @file_comments[filename] = associate_comments(node, comments)
+      mapified = reduce(node, @file_comments[filename])
       root = AST::Node.new(:begin, [filename])
       mapified.children.each { |c|
         root = root.append c
       }
       @file_nodes[filename] = root
-      @file_comments[filename] = associate_comments(mapified, comments)
       @required.uniq!
       process_maps
     end
 
     def associate_comments node, comments
-      comment_hash = Parser::Source::Comment.associate(node, comments)
+      comment_hash = Parser::Source::Comment.associate_locations(node, comments)
       yard_hash = {}
       comment_hash.each_pair { |k, v|
-        #ctxt = v.map(&:text).join("\r\n")
         ctxt = ''
         v.each { |l|
           ctxt += l.text.gsub(/^#/, '') + "\n"
@@ -81,7 +81,8 @@ module Solargraph
 
     def get_comment_for node
       filename = get_filename_for(node)
-      @file_comments[filename][node] unless @file_comments[filename].nil?
+      return nil if @file_comments[filename].nil?
+      @file_comments[filename][node.loc]
     end
 
     def self.get_keywords without_snippets: false
@@ -142,7 +143,17 @@ module Solargraph
         }
         unless cursor.nil?
           cursor.keys.each { |k|
-            result.push Suggestion.new(k, kind: Suggestion::CLASS)
+            type = get_namespace_type(k, fqns)
+            kind = nil
+            detail = nil
+            if type == :class
+              kind = Suggestion::CLASS
+              detail = 'Class'
+            elsif type == :module
+              kind = Suggestion::MODULE
+              detail = 'Module'
+            end
+            result.push Suggestion.new(k, kind: kind, detail: detail)
           }
           nodes = get_namespace_nodes(fqns)
           nodes.each { |n|
@@ -225,7 +236,6 @@ module Solargraph
       if node.kind_of?(AST::Node)
         node.children.each { |c|
           if c.kind_of?(AST::Node)
-            #next if [:class, :module].include?(c.type)
             is_inst = !find_parent(c, :def).nil?
             if c.type == :ivasgn and ( (scope == :instance and is_inst) or (scope != :instance and !is_inst) )
               arr.push Suggestion.new(c.children[0], kind: Suggestion::VARIABLE)
@@ -266,7 +276,7 @@ module Solargraph
     end
     
     def get_global_variables
-      # TODO I bet these aren't getting mapped at all. Damn.
+      # TODO: Get them
       []
     end
     
@@ -323,19 +333,25 @@ module Solargraph
     end
     
     def get_instance_methods(namespace, root = '')
-      meths = inner_get_instance_methods(namespace, root, [])
+      meths = []
+      meths += inner_get_instance_methods(namespace, root, []) unless has_yardoc?
       yard = YardMap.new(required: @required, workspace: @workspace)
-      type = get_namespace_type(namespace, root)
-      if type == :class
-        meths += yard.get_instance_methods('Object')
-      elsif type == :module
-        meths += yard.get_instance_methods('Module')
-      end
-      meths += yard.get_instance_methods(namespace, root)
-      sc = get_superclass(namespace, root)
-      until sc.nil?
-        meths += yard.get_instance_methods(sc, root)
-        sc = get_superclass(sc)
+      yard_meths = yard.get_instance_methods(namespace, root)
+      if yard_meths.any?
+        meths.concat yard_meths
+      else
+        type = get_namespace_type(namespace, root)
+        if type == :class
+          meths += yard.get_instance_methods('Object')
+        elsif type == :module
+          meths += yard.get_instance_methods('Module')
+        end
+        # TODO: Look out for repeats. Consider not doing this at all.
+        sc = get_superclass(namespace, root)
+        until sc.nil?
+          meths += yard.get_instance_methods(sc, root)
+          sc = get_superclass(sc)
+        end
       end
       meths
     end
@@ -374,7 +390,7 @@ module Solargraph
             elsif current_scope == :public
               if c.kind_of?(AST::Node) and c.type == :def
                 cmnt = get_comment_for(c)
-                meths.push Suggestion.new(c.children[0], kind: Suggestion::METHOD, documentation: cmnt) if c.children[0].to_s[0].match(/[a-z]/i)
+                meths.push Suggestion.new(c.children[0], kind: Suggestion::METHOD, documentation: cmnt, detail: fqns) if c.children[0].to_s[0].match(/[a-z]/i)
               elsif c.kind_of?(AST::Node) and c.type == :send and c.children[1] == :attr_reader
                 c.children[2..-1].each { |x|
                   meths.push Suggestion.new(x.children[0], kind: Suggestion::METHOD) if x.type == :sym
@@ -421,15 +437,6 @@ module Solargraph
     
     private
     
-    def mapify node
-      root = node
-      if !root.kind_of?(AST::Node) or root.type != :begin
-        root = AST::Node.new(:begin, [node], {})
-      end
-      root = reduce root
-      root
-    end
-    
     def mappable?(node)
       # TODO Add node.type :casgn (constant assignment)
       if node.kind_of?(AST::Node) and (node.type == :class or node.type == :module or node.type == :def or node.type == :defs or node.type == :ivasgn or node.type == :gvasgn or node.type == :or_asgn)
@@ -441,42 +448,42 @@ module Solargraph
       end
     end
     
-    def reduce node
-      mappable = get_mappable_nodes(node.children)
+    def reduce node, comment_hash
+      mappable = get_mappable_nodes(node.children, comment_hash)
       result = node.updated nil, mappable
       result
     end
     
-    def get_mappable_nodes arr
+    def get_mappable_nodes arr, comment_hash
       result = []
       arr.each { |n|
         if mappable?(n)
-          min = minify(n)
+          min = minify(n, comment_hash)
           result.push min
         else
           next unless n.kind_of?(AST::Node)
-          result += get_mappable_nodes(n.children)
+          result += get_mappable_nodes(n.children, comment_hash)
         end
       }
       result
     end
     
-    def minify node
+    def minify node, comment_hash
       return node if node.type == :args
       type = node.type
       children = []
       if node.type == :class
         children += node.children[0, 2]
-        children += get_mappable_nodes(node.children[2..-1])
+        children += get_mappable_nodes(node.children[2..-1], comment_hash)
       elsif node.type == :def
         children += node.children[0, 2]
-        children += get_mappable_nodes(node.children[2..-1])
+        children += get_mappable_nodes(node.children[2..-1], comment_hash)
       elsif node.type == :defs
         children += node.children[0, 3]
-        children += get_mappable_nodes(node.children[3..-1])
+        children += get_mappable_nodes(node.children[3..-1], comment_hash)
       elsif node.type == :module
         children += node.children[0, 1]
-        children += get_mappable_nodes(node.children[1..-1])
+        children += get_mappable_nodes(node.children[1..-1], comment_hash)
       elsif node.type == :ivasgn or node.type == :gvasgn
         children += node.children
       elsif node.type == :send and node.children[1] == :include
@@ -500,7 +507,7 @@ module Solargraph
     end
     
     def map_parents node, tree = []
-      if node.kind_of?(AST::Node) #and (node.type == :class or node.type == :module)
+      if node.kind_of?(AST::Node)
         @parent_stack[node] = tree
         node.children.each { |c|
           map_parents c, [node] + tree

data/lib/solargraph/code_map.rb

@@ -7,26 +7,30 @@ module Solargraph
     
     include NodeMethods
     
-    def initialize code: '', filename: nil
-      workspace = nil
-      unless filename.nil?
-        filename.gsub!(File::ALT_SEPARATOR, File::SEPARATOR) unless File::ALT_SEPARATOR.nil?
+    def initialize code: '', filename: nil, workspace: nil
+      if workspace.nil? and !filename.nil?
+        filename = filename.gsub(File::ALT_SEPARATOR, File::SEPARATOR) unless File::ALT_SEPARATOR.nil?
         workspace = CodeMap.find_workspace(filename)
       end
-      @api_map = ApiMap.new(workspace)
-      unless workspace.nil?
-        files = Dir[File.join workspace, '**', '*.rb']
-        files.each { |f|
-          unless filename == f
-            @api_map.append_file f
+      if workspace.nil?
+        @api_map = ApiMap.new(workspace)
+      else
+        ser_file = File.join(workspace, '.solargraph.ser')
+        if File.exist?(ser_file)
+          begin
+            @api_map = Marshal.load(File.read(ser_file))
+          rescue Exception => e
+            @api_map = ApiMap.new(workspace)
           end
-        }
+        else
+          @api_map = ApiMap.new(workspace)
+        end
       end
 
       @code = code.gsub(/\r/, '')
       tries = 0
       # Hide incomplete code to avoid syntax errors
-      tmp = "#{code}\nX".gsub(/[\.@]([\s])/, '#\1').gsub(/([\A\s]?)def([\s]*?[\n\Z])/, '\1#ef\2')
+      tmp = "#{@code}\nX".gsub(/[\.@]([\s])/, '#\1').gsub(/([\A\s]?)def([\s]*?[\n\Z])/, '\1#ef\2')
       #tmp = code
       begin
         @node, comments = Parser::CurrentRuby.parse_with_comments(tmp)
@@ -36,7 +40,6 @@ module Solargraph
           tries += 1
           spot = e.diagnostic.location.begin_pos
           if spot == tmp.length
-            puts e.message
             tmp = tmp[0..-2] + '#'
           else
             tmp = tmp[0..spot] + '#' + tmp[spot+2..-1].to_s
@@ -181,20 +184,7 @@ module Solargraph
           result = @api_map.namespaces_in(ns)
         end
       elsif phrase.include?('.')
-        # It's a method call
-        # TODO: For now we're assuming only one period. That's obviously a bad assumption.
-        #base = phrase[0..phrase.index('.')-1]
-        #ns_here = namespace_at(index)
-        #result = @api_map.get_methods(base, ns_here)
-        #scope = parent_node_from(index, :class, :module, :def, :defs) || @node
-        #var = find_local_variable_node(base, scope)
-        #unless var.nil?
-        #  obj = infer(var.children[1])
-        #  result = @api_map.get_instance_methods(obj) unless obj.nil?
-        #end
-        
-        # TODO: Alternate version that resolves signature
-        result = resolve_signature_at index
+        result = resolve_signature_at @code[0, index].rindex('.')
       else
         current_namespace = namespace_at(index)
         parts = current_namespace.to_s.split('::')

data/lib/solargraph/server.rb

@@ -14,7 +14,7 @@ module Solargraph
       rescue Exception => e
         STDERR.puts e
         STDERR.puts e.backtrace.join("\n")
-        { "status" => "err", "message" => e.message }.to_json
+        { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
       end
     end
   end

data/lib/solargraph/shell.rb

@@ -54,6 +54,18 @@ module Solargraph
       Solargraph::Server.run!
     end
     
+    desc 'serialize DIRECTORY', 'Cache an API map of DIRECTORY'
+    def serialize directory
+      api_map = ApiMap.new directory
+      files = Dir[File.join directory, 'lib', '**', '*.rb'] + Dir[File.join directory, 'app', '**', '*.rb']
+      files.each { |f|
+        api_map.append_file f
+      }
+      File.open(File.join(directory, '.solargraph.ser'), 'wb') { |file|
+        file << Marshal.dump(api_map)
+      }
+    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.
@@ -76,7 +88,8 @@ module Solargraph
       rescue Exception => e
         STDERR.puts e
         STDERR.puts e.backtrace.join("\n")
-        result = { "status" => "err", "message" => e.message }.to_json
+        #result = { "status" => "err", "message" => e.message }.to_json
+        result = { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
         STDOUT.puts result
       end
     end

data/lib/solargraph/suggestion.rb

@@ -10,15 +10,16 @@ module Solargraph
     VARIABLE = 'Variable'
     SNIPPET = 'Snippet'
 
-    attr_reader :label, :kind, :insert, :detail, :documentation
+    attr_reader :label, :kind, :insert, :detail, :documentation, :code_object, :location
 
-    def initialize label, kind: KEYWORD, insert: nil, detail: nil, documentation: nil, code_object: nil
+    def initialize label, kind: KEYWORD, insert: nil, detail: nil, documentation: nil, code_object: nil, location: nil
       @label = label.to_s
       @kind = kind
       @insert = insert || @label
       @detail = detail
       @code_object = code_object
       @documentation = documentation
+      @location = location
     end
     
     def to_s
@@ -26,14 +27,19 @@ module Solargraph
     end
 
     def to_json args={}
-      {
+      obj = {
         label: @label,
         kind: @kind,
         insert: @insert,
         detail: @detail,
-        #documentation: (@documentation.nil? ? nil : @documentation.all)
-        documentation: (@code_object.nil? ? nil : YARD::Templates::Engine.render(format: :text, object: @code_object))
-      }.to_json(args)
+        location: (@location.nil? ? nil : @location.to_s)
+      }
+      if @code_object.nil?
+        obj[:documentation] = @documentation.all unless @documentation.nil?
+      else
+        obj[:documentation] = @code_object.docstring.all unless @code_object.docstring.nil?
+      end
+      obj.to_json(args)
     end
   end
 

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/solargraph/yard_map.rb

@@ -10,12 +10,20 @@ module Solargraph
         wsy = File.join(workspace, '.yardoc')
         yardocs.push wsy if File.exist?(wsy)
       end
+      used = []
       required.each { |r|
-        gy = YARD::Registry.yardoc_file_for_gem(r)
-        yardocs.push gy unless gy.nil?
+        if workspace.nil? or !File.exist?(File.join workspace, 'lib', "#{r}.rb")
+          g = r.split('/').first
+          unless used.include?(g)
+            used.push g
+            gy = YARD::Registry.yardoc_file_for_gem(g)
+            yardocs.push gy unless gy.nil?
+          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!
     end
 
     def yardocs
@@ -38,7 +46,16 @@ module Solargraph
         end
       }
       consts.each { |c|
-        result.push Suggestion.new(c.to_s.split('::').last, kind: Suggestion::CLASS)
+        detail = nil
+        kind = nil
+        if c.kind_of?(YARD::CodeObjects::ClassObject)
+          detail = 'Class'
+          kind = Suggestion::CLASS
+        elsif c.kind_of?(YARD::CodeObjects::ModuleObject)
+          detail = 'Module'
+          kind = Suggestion::MODULE
+        end
+        result.push Suggestion.new(c.to_s.split('::').last, detail: detail, kind: kind)
       }
       result
     end
@@ -79,7 +96,7 @@ module Solargraph
           unless ns.nil?
             ns.meths(scope: :class, visibility: [:public]).each { |m|
               n = m.to_s.split('.').last
-              meths.push Suggestion.new("#{n}", kind: Suggestion::METHOD) if n.to_s.match(/^[a-z]/i)
+              meths.push Suggestion.new("#{n}", kind: Suggestion::METHOD, detail: "#{ns}") if n.to_s.match(/^[a-z]/i)
             }
             if ns.kind_of?(YARD::CodeObjects::ClassObject) and namespace != 'Class'
               meths += get_instance_methods('Class')
@@ -104,7 +121,9 @@ module Solargraph
           unless ns.nil?
             ns.meths(scope: :instance, visibility: [:public]).each { |m|
               n = m.to_s.split('#').last
-              meths.push Suggestion.new("#{n}", kind: Suggestion::METHOD, documentation: m.docstring, code_object: m) if n.to_s.match(/^[a-z]/i) and !m.to_s.start_with?('Kernel#') and !m.docstring.to_s.include?(':nodoc:')
+              if n.to_s.match(/^[a-z]/i) and !m.to_s.start_with?('Kernel#') and !m.docstring.to_s.include?(':nodoc:')
+                meths.push Suggestion.new("#{n}", kind: Suggestion::METHOD, documentation: m.docstring, code_object: m, detail: "#{ns}", location: "#{m.file}:#{m.line}")
+              end
             }
             if ns.kind_of?(YARD::CodeObjects::ClassObject) and namespace != 'Object'
               meths += get_instance_methods('Object')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-18 00:00:00.000000000 Z
+date: 2017-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser