starscope 0.1.10 → 1.0.0

data/lib/starscope/langs/coffeescript.rb

@@ -0,0 +1,12 @@
+module StarScope::Lang
+  module CoffeeScript
+
+    def self.match_file(name)
+      name.end_with?(".coffee")
+    end
+
+    def self.extract(file)
+      # TODO
+    end
+  end
+end

data/lib/starscope/langs/go.rb

@@ -10,7 +10,7 @@ module StarScope::Lang
     CONTROL_KEYS = ['if', 'for', 'switch', 'case']
 
     def self.match_file(name)
-      name =~ /.*\.go$/
+      name.end_with?(".go")
     end
 
     def self.extract(file, &block)
@@ -51,7 +51,7 @@ module StarScope::Lang
         when :struct
           case line
           when END_OF_BLOCK
-            yield :end, "}", :line_no => line_no, :scope => scope, :type => :class
+            yield :end, scope + ["}"], :line_no => line_no, :type => :class
             stack.pop
             scope.pop
           when /(.+)\s+\w+/
@@ -60,11 +60,11 @@ module StarScope::Lang
         when :interface
           case line
           when END_OF_BLOCK
-            yield :end, "}", :line_no => line_no, :scope => scope, :type => :class
+            yield :end, scope + ["}"], :line_no => line_no, :type => :class
             stack.pop
             scope.pop
           when /(\w+)\(.*\)\s+/
-            yield :defs, $1, :line_no => line_no, :scope => scope
+            yield :defs, scope + [$1], :line_no => line_no
           end
         when :def
           case line
@@ -81,7 +81,7 @@ module StarScope::Lang
             stack.pop
           when /"(.+)"/
             name = $1.split('/')
-            yield :imports, name[-1], :line_no => line_no, :scope => name[0...-1]
+            yield :imports, name, :line_no => line_no
           end
         else
           if stack[-1] == :func and /^\}/ =~ line
@@ -90,46 +90,46 @@ module StarScope::Lang
           end
           case line
           when /^func\s+(\w+)\(/
-            yield :defs, $1, :line_no => line_no, :scope => scope, :type => :func
+            yield :defs, scope + [$1], :line_no => line_no, :type => :func
             stack.push(:func)
           when /^func\s+\(\w+\s+\*?(\w+)\)\s*(\w+)\(/
-            yield :defs, $2, :line_no => line_no, :scope => scope + [$1], :type => :func
+            yield :defs, scope + [$1, $2], :line_no => line_no, :type => :func
             stack.push(:func)
           when /^package\s+(\w+)/
-            yield :defs, $1, :line_no => line_no, :scope => scope, :type => :package
             scope.push($1)
+            yield :defs, scope, :line_no => line_no, :type => :package
           when /^type\s+(\w+)\s+struct\s*\{/
-            yield :defs, $1, :line_no => line_no, :scope => scope, :type => :class
             scope.push($1)
             stack.push(:struct)
+            yield :defs, scope, :line_no => line_no, :type => :class
           when /^type\s+(\w+)\s+interface\s*\{/
-            yield :defs, $1, :line_no => line_no, :scope => scope, :type => :class
             scope.push($1)
             stack.push(:interface)
+            yield :defs, scope, :line_no => line_no, :type => :class
           when /^type\s+(\w+)/
-            yield :defs, $1, :line_no => line_no, :scope => scope, :type => :type
+            yield :defs, scope + [$1], :line_no => line_no, :type => :type
           when /^import\s+"(.+)"/
             name = $1.split('/')
-            yield :imports, name[-1], :line_no => line_no, :scope => name[0...-1]
+            yield :imports, name, :line_no => line_no
           when /^import\s+\(/
             stack.push(:import)
           when /^var\s+\(/
             stack.push(:def)
-          when /^var\s+(\w+)\s+\w+/
-            yield :defs, $1, :line_no => line_no, :scope => scope
+          when /^var\s+(\w+)\s/
+            yield :defs, scope + [$1], :line_no => line_no
           when /^const\s+\(/
             stack.push(:def)
-          when /^const\s+(\w+)\s+\w+/
-            yield :defs, $1, :line_no => line_no, :scope => scope
+          when /^const\s+(\w+)\s/
+            yield :defs, scope + [$1], :line_no => line_no
           when /^\s+(.*?) :?=[^=]/
             $1.split(' ').each do |var|
               next if CONTROL_KEYS.include?(var)
               name = var.delete(',').split('.')
               next if name[0] == "_" # assigning to _ is a discard in golang
               if name.length == 1
-                yield :assigns, name[0], :line_no => line_no, :scope => scope
+                yield :assigns, scope + [name[0]], :line_no => line_no
               else
-                yield :assigns, name[1], :line_no => line_no, :scope => name[0..-1]
+                yield :assigns, name, :line_no => line_no
               end
             end
             parse_call(line, line_no, scope, &block)
@@ -153,17 +153,21 @@ module StarScope::Lang
           if BUILTIN_FUNCS.include?(name[0])
             yield :calls, name[0], :line_no => line_no
           else
-            yield :calls, name[0], :line_no => line_no, :scope => scope
+            yield :calls, scope + [name[0]], :line_no => line_no
           end
         else
-          yield :calls, name[-1], :line_no => line_no, :scope => name[0...-1]
+          yield :calls, name, :line_no => line_no
         end
       end
     end
 
     def self.parse_def(line, line_no, scope)
+      # if it doesn't start with a valid identifier character, it's probably
+      # part of a multi-line literal and we should skip it
+      return if not line =~ /^\s*[[:alpha:]_]/
+
       line.split.each do |var|
-        yield :defs, var.delete(','), :line_no => line_no, :scope => scope
+        yield :defs, scope + [var.delete(',')], :line_no => line_no
         break if not var.end_with?(',')
       end
     end

data/lib/starscope/langs/lua.rb

@@ -0,0 +1,12 @@
+module StarScope::Lang
+  module Lua
+
+    def self.match_file(name)
+      name.end_with?(".lua")
+    end
+
+    def self.extract(file)
+      # TODO
+    end
+  end
+end

data/lib/starscope/langs/ruby.rb

@@ -3,12 +3,14 @@ require "parser/current"
 module StarScope::Lang
   module Ruby
     def self.match_file(name)
-      return true if name =~ /.*\.rb$/
-      return File.open(name) {|f| f.readline} =~ /^#!.*ruby/
+      return true if name.end_with?(".rb")
+      File.open(name) do |f|
+        head = f.read(2)
+        return false if head.nil? or not head.start_with?("#!")
+        return f.readline.include?("ruby")
+      end
     rescue ArgumentError # may occur if file is binary (invalid UTF)
       false
-    rescue EOFError # occurs when file is empty
-      false
     end
 
     def self.extract(file, &block)
@@ -52,39 +54,29 @@ module StarScope::Lang
         case node.type
         when :send
           fqn = scoped_name(node)
-          yield :calls, fqn.last,
-            :line_no => node.location.expression.line,
-            :scope => fqn[0...-1]
+          yield :calls, fqn, :line_no => node.location.expression.line
           if node.children[0].nil? and node.children[1] == :require and node.children[2].type == :str
             fqn = node.children[2].children[0].split("/")
-            yield :requires, fqn.last,
-              :line_no => node.location.expression.line,
-              :scope => fqn[0...-1]
+            yield :requires, fqn, :line_no => node.location.expression.line
           end
         when :def
-          yield :defs, node.children[0],
-            :line_no => node.location.expression.line,
-            :scope => @scope, :type => :func
+          yield :defs, @scope + [node.children[0]],
+            :line_no => node.location.expression.line, :type => :func
           yield :end, :end, :line_no => node.location.end.line, :type => :func
         when :defs
-          yield :defs, node.children[1],
-            :line_no => node.location.expression.line,
-            :scope => @scope, :type => :func
+          yield :defs, @scope + [node.children[1]],
+            :line_no => node.location.expression.line, :type => :func
           yield :end, :end, :line_no => node.location.end.line, :type => :func
         when :module, :class
           fqn = @scope + scoped_name(node.children[0])
-          yield :defs, fqn.last, :line_no => node.location.expression.line,
-            :scope => fqn[0...-1], :type => node.type
+          yield :defs, fqn, :line_no => node.location.expression.line, :type => node.type
           yield :end, :end, :line_no => node.location.end.line, :type => node.type
         when :casgn
           fqn = scoped_name(node)
-          yield :assigns, fqn.last,
-            :line_no => node.location.expression.line,
-            :scope => fqn[0...-1]
+          yield :assigns, fqn, :line_no => node.location.expression.line
+          yield :defs, fqn, :line_no => node.location.expression.line
         when :lvasgn, :ivasgn, :cvasgn, :gvasgn
-          yield :assigns, node.children[0],
-            :line_no => node.location.expression.line,
-            :scope => @scope
+          yield :assigns, @scope + [node.children[0]], :line_no => node.location.expression.line
         end
       end
 

data/lib/starscope/matcher.rb

@@ -0,0 +1,44 @@
+class StarScope::Matcher
+
+  MATCH_TYPES = [:full_match, :simple_match, :simple_regexp, :full_regexp]
+
+  def initialize(query, input)
+    @query  = query
+    @input  = input
+    @regexp = Regexp.new(query, Regexp::IGNORECASE)
+  rescue RegexpError
+    # not a regex, oh well
+  end
+
+  def match(record)
+    name = record[:name].map {|x| x.to_s}
+    fullname = name.join('::')
+
+    case
+    when fullname == @query
+      :full_match
+    when name[-1] == @query
+      :simple_match
+    when @regexp
+      if @regexp.match(name[-1])
+        :simple_regexp
+      elsif @regexp.match(fullname)
+        :full_regexp
+      end
+    end
+  end
+
+  def query
+    return [] if @input.empty?
+
+    results = @input.group_by {|x| match(x)}
+
+    MATCH_TYPES.each do |type|
+       next if results[type].nil? or results[type].empty?
+       return results[type]
+     end
+
+     return []
+  end
+
+end

data/lib/starscope/output.rb

@@ -0,0 +1,41 @@
+require 'ruby-progressbar'
+
+class StarScope::Output
+
+  PBAR_FORMAT = '%t: %c/%C %E ||%b>%i||'
+
+  def initialize(progress, verbose)
+    @progress = progress
+    @verbose = verbose
+    @pbar = nil
+  end
+
+  def new_pbar(title, num_items)
+    if @progress
+      @pbar = ProgressBar.create(:title => title, :total => num_items,
+                                :format => PBAR_FORMAT, :length => 80)
+    end
+  end
+
+  def inc_pbar
+    @pbar.increment if @pbar
+  end
+
+  def finish_pbar
+    if @pbar
+      @pbar.finish
+      @pbar = nil
+    end
+  end
+
+  def log(msg)
+    return if not @verbose
+
+    if @pbar
+      @pbar.log(msg)
+    else
+      puts msg
+    end
+  end
+
+end

data/lib/starscope/record.rb

@@ -0,0 +1,88 @@
+class StarScope::Record
+
+  def self.build(file, name, args)
+    args[:file] = file
+
+    if name.is_a? Array
+      args[:name] = name.map {|x| x.to_sym}
+    else
+      args[:name] = [name.to_sym]
+    end
+
+    if args[:line_no]
+      args[:line] = File.readlines(file)[args[:line_no]-1].chomp
+    end
+
+    args
+  end
+
+  def self.format(rec)
+    "#{rec[:name].join " "} -- #{rec[:file]}:#{rec[:line_no]} (#{rec[:line].strip})"
+  end
+
+  def self.ctag_line(rec)
+    ret = "#{rec[:name][-1]}\t#{rec[:file]}\t/^#{rec[:line]}$/"
+
+    ext = self.ctag_ext_tags(rec)
+    if not ext.empty?
+      ret << ";\""
+      ext.each do |k, v|
+        ret << "\t#{k}:#{v}"
+      end
+    end
+
+    ret
+  end
+
+  def self.ctag_ext_tags(rec)
+    tag = {}
+
+    # these extensions are documented at http://ctags.sourceforge.net/FORMAT
+    case rec[:type]
+    when :func
+      tag["kind"] = "f"
+    when :module, :class
+      tag["kind"] = "c"
+    end
+
+    tag
+  end
+
+  def self.cscope_mark(tbl, rec)
+    case tbl
+    when :end
+      case rec[:type]
+      when :func
+        ret = "}"
+      else
+        return ""
+      end
+    when :file
+      ret = "@"
+    when :defs
+      case rec[:type]
+      when :func
+        ret = "$"
+      when :class, :module
+        ret = "c"
+      when :type
+        ret = "t"
+      else
+        ret = "g"
+      end
+    when :calls
+      ret = "`"
+    when :requires
+      ret = "~\""
+    when :imports
+      ret = "~<"
+    when :assigns
+      ret = "="
+    else
+      return ""
+    end
+
+    return "\t" + ret
+  end
+
+end

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
 module StarScope
-  VERSION = "0.1.10"
+  VERSION = "1.0.0"
 end

data/starscope.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.required_ruby_version = '>= 1.9.3'
 
-  gem.add_dependency 'oj', '~> 2.5'
+  gem.add_dependency 'oj', '~> 2.7'
   gem.add_dependency 'parser', '~> 2.1'
   gem.add_dependency 'ruby-progressbar', '~> 1.4'
   gem.add_development_dependency 'bundler', '~> 1.5'

data/test/files/sample_golang.go

@@ -1,14 +1,28 @@
 package main
 
+import "fmt"
+
 var (
 	v1, v2 int = 3, 4
+	raw        = []byte{
+		0x00, 0x01,
+		0x02, 0x03,
+	}
 )
 
+var single_var = 3
+
+const single_const = 4
+
 const (
 	Sunday = iota
 	Monday
 )
 
+type foo interface {
+	bar() int
+}
+
 func a(c int) int {
 	return 3
 }
@@ -41,4 +55,9 @@ func main() {
 	}
 
 	a(c(b(), b()))
+	c(y, z)
+	c(single_var, single_const)
+
+	fmt.Println(n)
+	fmt.Println(t)
 }