solargraph 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f57a44dce57b4e3362168c2bc89aa6ddf989ed34
-  data.tar.gz: 146c7b72052a876bc2028a86a8d0058c1eacce5e
+  metadata.gz: 5d9772edc47881d8e944c68b737e4b065fb2fb30
+  data.tar.gz: 1f2dbd2d6ec31e1d94c485a87e8a247b4ed49fe0
 SHA512:
-  metadata.gz: 8b57d51bb651ad3abd0b65b5fe873fb02f944e28443cb46a658c73c9416903ac45d5e7677c78df4db6f29999a0f41c81ab246d0de5d595684104a46def6f931e
-  data.tar.gz: 7bedbcd9f10e87598ce66e2811023977fe63bdfe22e1e55a4774dde096cc824c80bde3f431a361d251b0638a3982964542ffc46891461c5c8d6a22b2f183a4ed
+  metadata.gz: b4d94536db05855102ea393348a8a6d589ad76f119d2205aecbb0f4f666e654fc748c1c6890037b44edf028050c6a46faac90c2dcbe6187702498dcb9d34f16e
+  data.tar.gz: 57223756d8581d876d77026e14397e50ab3d08913a2b15515081d05b2ec1ecf092741bd933078e22a106b4067c0745da14227f9b0ce0bed0e7bf4d1e8ecf61db

data/lib/solargraph.rb

@@ -1,6 +1,6 @@
 require 'solargraph/version'
 require 'rubygems/package'
-require 'yard'
+require 'yard-solargraph'
 
 module Solargraph
   autoload :Analyzer,    'solargraph/analyzer'
@@ -15,7 +15,8 @@ module Solargraph
   autoload :Server,      'solargraph/server'
   autoload :YardMap,     'solargraph/yard_map'
 
-  YARDOC_PATH = File.realpath(File.dirname(__FILE__) + "/../yardoc")
+  YARDOC_PATH = File.join(File.realpath(File.dirname(__FILE__)), '..', 'yardoc')
+  YARD_EXTENSION_FILE = File.join(File.realpath(File.dirname(__FILE__)), 'yard-solargraph.rb')
 end
 
 # Make sure the core and stdlib documentation is available
@@ -39,6 +40,3 @@ unless File.exist?(version_dir)
   tar_extract.close
   #FileUtils.rm File.join(cache_dir, '2.0.0.tar.gz')
 end
-
-# Define a @type tag to be used for documenting variables
-YARD::Tags::Library.define_tag("Type", :type, :with_types_and_name)

data/lib/solargraph/api_map.rb

@@ -14,9 +14,8 @@ module Solargraph
     ]
 
     MAPPABLE_METHODS = [
-      :include, :extend, :require, :autoload, :attr_reader, :attr_writer, :attr_accessor, :private, :public, :protected,
-      :solargraph_include_public_methods
-    ]
+      :include, :extend, :require, :autoload, :attr_reader, :attr_writer, :attr_accessor, :private, :public, :protected
+    ] # @todo Not including solargraph_include_public_methods (an experimental thing)
 
     include NodeMethods
 
@@ -463,6 +462,21 @@ module Solargraph
       arr
     end
     
+    def update_yardoc
+      if workspace.nil?
+        STDERR.puts "No workspace specified for yardoc update."
+      else
+        Dir.chdir(workspace) do
+          #YARD::Registry.load(yard_options[:include] - yard_options[:exclude], true)
+          #YARD::Registry.save
+          `yardoc -e #{Solargraph::YARD_EXTENSION_FILE} #{yard_options[:all]}`
+          unless $?.success?
+            STDERR.puts "There was an error processing the workspace yardoc."
+          end
+        end
+      end
+    end
+
     private
 
     def inner_get_methods(namespace, root = '', skip = [])
@@ -501,9 +515,9 @@ module Solargraph
             # from an include, or only from an extend?
             i = unpack_name(c.children[2])
             meths += inner_get_methods(i, root, skip) unless i == 'Kernel'
-          elsif c.type == :send and c.children[1] == :solargraph_include_public_methods
-            i = unpack_name(c.children[2])
-            meths += get_instance_methods(i, root, visibility: [:public])
+          #elsif c.type == :send and c.children[1] == :solargraph_include_public_methods
+          #  i = unpack_name(c.children[2])
+          #  meths += get_instance_methods(i, root, visibility: [:public])
           else
             meths += inner_get_methods_from_node(c, root, skip)
           end

data/lib/solargraph/code_map.rb

@@ -15,6 +15,7 @@ module Solargraph
         filename = filename.gsub(File::ALT_SEPARATOR, File::SEPARATOR) unless File::ALT_SEPARATOR.nil?
         workspace = CodeMap.find_workspace(filename)
       end
+      @filename = filename
       @api_map = api_map
       if @api_map.nil?
         @api_map = ApiMap.new(workspace)
@@ -200,6 +201,12 @@ module Solargraph
         end
         result += @api_map.namespaces_in('')
         result += @api_map.get_instance_methods('Kernel')
+        unless @filename.nil? or @api_map.yardoc_has_file?(@filename)
+          m = @code.match(/# +@bind \[([a-z0-9_:]*)/i)
+          unless m.nil?
+            @api_map.get_instance_methods(m[1])
+          end
+        end
       end
       result = reduce_starting_with(result, word_at(index)) if filtered
       result.uniq{|s| s.path}

data/lib/solargraph/node_methods.rb

@@ -67,7 +67,9 @@ module Solargraph
       if @yard_options.nil?
         @yard_options = {
           include: [],
-          exclude: []
+          exclude: [],
+          flags: [],
+          all: []
         }
         unless workspace.nil?
           yardopts_file = File.join(workspace, '.yardopts')
@@ -75,7 +77,10 @@ module Solargraph
             yardopts = File.read(yardopts_file)
             yardopts.lines.each { |line|
               arg = line.strip
-              if !arg.start_with?('-')
+              @yard_options[:all].push arg
+              if arg.start_with?('-')
+                @yard_options[:flags].push arg
+              else
                 @yard_options[:include].push arg
               end
             }

data/lib/solargraph/server.rb

@@ -75,6 +75,9 @@ module Solargraph
         @@semaphore.synchronize {
           @@api_hash[directory] = api_map
         }
+        #Thread.new {
+          api_map.update_yardoc
+        #}
       end
 
       def constant_updates

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/lib/solargraph/yard_map.rb

@@ -11,6 +11,8 @@ module Solargraph
       unless workspace.nil?
         wsy = File.join(workspace, '.yardoc')
         yardocs.push wsy if File.exist?(wsy)
+        #wsy = Dir[File.join workspace, '**/*.rb']
+        #yardocs.push(wsy)
       end
       used = []
       required.each { |r|
@@ -41,10 +43,18 @@ module Solargraph
       @yardocs ||= []
     end
 
+    def load_yardoc y
+      if y.kind_of?(Array)
+        YARD::Registry.load y, true
+      else
+        YARD::Registry.load! y
+      end
+    end
+
     def search query
       found = []
       yardocs.each { |y|
-        yard = YARD::Registry.load! y
+        yard = load_yardoc(y)
         unless yard.nil?
           yard.paths.each { |p|
             found.push p if p.downcase.include?(query.downcase)
@@ -57,7 +67,7 @@ module Solargraph
     def document query
       found = []
       yardocs.each { |y|
-        yard = YARD::Registry.load! y
+        yard = load_yardoc(y)
         unless yard.nil?
           obj = yard.at query
           found.push obj unless obj.nil?
@@ -73,8 +83,19 @@ module Solargraph
       consts = []
       result = []
       yardocs.each { |y|
-        yard = YARD::Registry.load! y
+        yard = load_yardoc(y)
         unless yard.nil?
+          if namespace == '' and scope == ''
+            # Check for a bind tag in the yardoc root. If it exists, treat
+            # workspace code as a DSL that uses public instance methods in the
+            # specified namespaces.
+            b = yard.root.tag(:bind)
+            unless b.nil?
+              b.types.each { |t|
+                consts += get_instance_methods(t, '', visibility: :public)
+              }
+            end
+          end
           ns = nil
           if scope == ''
             ns = yard.at(namespace)
@@ -102,7 +123,7 @@ module Solargraph
 
     def at signature
       yardocs.each { |y|
-        yard = YARD::Registry.load! y
+        yard = load_yardoc(y)
         unless yard.nil?
           obj = yard.at(signature)
           return obj unless obj.nil?
@@ -113,7 +134,7 @@ module Solargraph
 
     def resolve signature, scope
       yardocs.each { |y|
-        yard = YARD::Registry.load! y
+        yard = load_yardoc(y)
         unless yard.nil?
           obj = yard.resolve(P(scope), signature)
           return obj unless obj.nil?
@@ -128,7 +149,7 @@ module Solargraph
       return cached unless cached.nil?
       meths = []
       yardocs.each { |y|
-        yard = YARD::Registry.load! y
+        yard = load_yardoc(y)
         unless yard.nil?
           ns = nil
           ns = find_first_resolved_namespace(yard, namespace, scope)
@@ -160,7 +181,7 @@ module Solargraph
       return cached unless cached.nil?
       meths = []
       yardocs.each { |y|
-        yard = YARD::Registry.load! y
+        yard = load_yardoc(y)
         unless yard.nil?
           ns = nil
           ns = find_first_resolved_namespace(yard, namespace, scope)
@@ -190,7 +211,7 @@ module Solargraph
 
     def find_fully_qualified_namespace namespace, scope
       yardocs.each { |y|
-        yard = YARD::Registry.load! y
+        yard = load_yardoc(y)
         unless yard.nil?
           obj = find_first_resolved_namespace(yard, namespace, scope)
           return obj.path unless obj.nil? or !obj.kind_of?(YARD::CodeObjects::NamespaceObject)

data/lib/yard-solargraph.rb

@@ -0,0 +1,27 @@
+require 'yard'
+require 'yard/handlers/ruby/base'
+
+class YardHandlerExtension < YARD::Handlers::Ruby::HandlesExtension
+  def matches? node
+    if node.docstring and node.docstring.include?(name)
+      true
+    else
+      false
+    end
+  end
+end
+
+class MyHandler < YARD::Handlers::Ruby::CommentHandler
+  handles YardHandlerExtension.new("@bind")
+
+  process do
+    if owner.type == :root
+      d = YARD::Docstring.new(statement.docstring)
+      owner.add_tag d.tag(:bind)
+    end
+  end
+end
+
+# Define a @type tag to be used for documenting variables
+YARD::Tags::Library.define_tag("Type", :type, :with_types_and_name)
+YARD::Tags::Library.define_tag("Bind", :bind, :with_types)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-01 00:00:00.000000000 Z
+date: 2017-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -150,6 +150,7 @@ files:
 - lib/solargraph/views/search.erb
 - lib/solargraph/yard_map.rb
 - lib/solargraph/yard_map/cache.rb
+- lib/yard-solargraph.rb
 - yardoc/2.0.0.tar.gz
 homepage: http://castwide.com
 licenses: