starscope 0.1.3 → 0.1.4

data/CHANGELOG.md

@@ -1,7 +1,21 @@
 Changelog
 =========
 
-v0.1.3 (trunk)
+v0.1.4 (trunk)
+-------------------
+
+New Features:
+ * Export to cscope databases.
+ * Regexes are now accepted in the last ('key') term of a query
+
+Bug Fixes:
+ * Don't match Golang function names ending with a dot.
+
+Misc:
+ * Dumping tables now sorts by key.
+ * Various bugfixes and improvements via updated dependencies.
+
+v0.1.3 (2013-10-15)
 -------------------
 
 Misc:

data/Gemfile.lock

@@ -1,38 +1,38 @@
 PATH
   remote: .
   specs:
-    starscope (0.1.3)
-      oj (~> 2.1)
-      parser (~> 2.0)
-      ruby-progressbar (~> 1.2)
+    starscope (0.1.4)
+      oj (~> 2.5)
+      parser (~> 2.1)
+      ruby-progressbar (~> 1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (1.1.0)
-    coderay (1.0.9)
+    coderay (1.1.0)
     columnize (0.3.6)
-    debugger (1.6.0)
+    debugger (1.6.5)
       columnize (>= 0.3.1)
       debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.2.1)
+      debugger-ruby_core_source (~> 1.3.1)
     debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.2.2)
-    method_source (0.8.1)
-    oj (2.1.6)
-    parser (2.0.0)
+    debugger-ruby_core_source (1.3.1)
+    method_source (0.8.2)
+    oj (2.5.3)
+    parser (2.1.2)
       ast (~> 1.1)
       slop (~> 3.4, >= 3.4.5)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
     pry-debugger (0.2.2)
       debugger (~> 1.3)
       pry (~> 0.9.10)
-    rake (10.0.4)
-    ruby-progressbar (1.2.0)
-    slop (3.4.5)
+    rake (10.1.1)
+    ruby-progressbar (1.4.0)
+    slop (3.4.7)
 
 PLATFORMS
   ruby

data/README.md

@@ -3,9 +3,6 @@ StarScope
 
 https://rubygems.org/gems/starscope
 
-*Note to those users looking at the GitHub language statistics: there is no perl
-here, that is their bug to fix.*
-
 Anyone who has done much programming in C (or C++) on a unix-based OS has come
 across the fantastic Cscope tool [1]. Sadly, it only works for C (and sort of
 works for C++).
@@ -34,5 +31,9 @@ Export it for use with your editor
 ```
 $ starscope -e ctags
 ```
+or
+```
+$ starscope -e cscope
+```
 
 [1] http://cscope.sourceforge.net/

data/TODO.md

@@ -3,5 +3,5 @@ TODO
 
 * Add --quiet to hide progress bar and --verbose to print each file
 * Parallelization, perhaps via https://github.com/grosser/parallel
+* Fuzzy matching, perhaps via https://github.com/seamusabshere/fuzzy_match
 * Export advanced ctags annotations
-* Export to cscope format

data/bin/starscope

@@ -57,8 +57,9 @@ END
 
   opts.separator <<END
 \nEXPORTING
-    At the moment only one export format is supported: 'ctags'. If you don't
-    specify a path, the file is written to 'tags' in the current directory.
+    At the moment two export formats are supported: 'ctags' and 'cscope'. If you
+    don't specify a path, the output is written to the files 'tags' (for ctags)
+    or 'cscope.out' (for cscope) in the current directory.
 END
 
 end.parse!
@@ -75,7 +76,7 @@ def run_query(db, table, value)
     return false
   end
   key, results = db.query(table.to_sym, value)
-  puts results.map {|val| StarScope::Datum.to_s(key, val)} if results
+  puts results.map {|val| StarScope::Datum.to_s(val)} if results
   return true
 rescue StarScope::DB::NoTableError
   $stderr.puts "Table '#{table}' doesn't exist."
@@ -128,6 +129,8 @@ if options[:export]
   case format
   when 'ctags'
     db.export_ctags(path || 'tags')
+  when 'cscope'
+    db.export_cscope(path || 'cscope.out')
   else
     puts "Unrecognized export format"
   end

data/lib/starscope/datum.rb

@@ -1,7 +1,8 @@
 class StarScope::Datum
 
-  def self.build(file, args)
+  def self.build(file, key, args)
     args[:file] = file
+    args[:key] = key
 
     if args[:line_no]
       args[:line] = File.readlines(file)[args[:line_no]-1].chomp
@@ -40,14 +41,51 @@ class StarScope::Datum
     "#{dat[:file]}:#{dat[:line_no]}"
   end
 
-  def self.to_s(key, dat)
+  def self.to_s(dat)
     str = ""
     str << "#{dat[:scope].join " "} " if dat[:scope]
-    str << "#{key} -- #{location dat}"
+    str << "#{dat[:key]} -- #{location dat}"
     str << " (#{dat[:line].strip})"
   end
 
-  def self.ctag_line(key, dat)
-    "#{key}\t#{dat[:file]}\t/^#{dat[:line]}$/;"
+  def self.ctag_line(dat)
+    "#{dat[:key]}\t#{dat[:file]}\t/^#{dat[:line]}$/;"
+  end
+
+  def self.cscope_mark(tbl, dat)
+    case tbl
+    when :end
+      case dat[:type]
+      when :func
+        ret = "}"
+      else
+        return ""
+      end
+    when :file
+      ret = "@"
+    when :defs
+      case dat[: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/db.rb

@@ -13,7 +13,7 @@ LANGS = [
 
 class StarScope::DB
 
-  DB_FORMAT = 3
+  DB_FORMAT = 4
   PBAR_FORMAT = '%t: %c/%C %E ||%b>%i||'
 
   class NoTableError < StandardError; end
@@ -89,11 +89,11 @@ class StarScope::DB
   def dump_table(table)
     raise NoTableError if not @tables[table]
     puts "== Table: #{table} =="
-    @tables[table].each do |val, data|
+    @tables[table].sort_by{|k,v| k.downcase}.each do |val, data|
       puts "#{val}"
       data.each do |datum|
         print "\t"
-        puts StarScope::Datum.to_s(val, datum)
+        puts StarScope::Datum.to_s(datum)
       end
     end
   end
@@ -115,9 +115,18 @@ class StarScope::DB
   def query(table, value)
     fqn = value.split("::")
     raise NoTableError if not @tables[table]
-    key = fqn.last.to_sym
-    results = @tables[table][key]
-    return [] if results.nil? || results.empty?
+    key = fqn.last
+    results = @tables[table][key.to_sym] || []
+    if results.empty?
+      matcher = Regexp.new(key, Regexp::IGNORECASE)
+      @tables[table].each do |k,v|
+        if matcher.match(k)
+          results << v
+        end
+      end
+      results.flatten!
+    end
+    return results if results.empty?
     results.sort! do |a,b|
       StarScope::Datum.score_match(b, fqn) <=> StarScope::Datum.score_match(a, fqn)
     end
@@ -125,7 +134,7 @@ class StarScope::DB
     results = results.select do |result|
       best_score - StarScope::Datum.score_match(result, fqn) < 4
     end
-    return key, results
+    return fqn.last.to_sym, results
   end
 
   def export_ctags(filename)
@@ -141,12 +150,67 @@ END
       defs = (@tables[:defs] || {}).sort
       defs.each do |key, val|
         val.each do |entry|
-          file.puts StarScope::Datum.ctag_line(key, entry)
+          file.puts StarScope::Datum.ctag_line(entry)
         end
       end
     end
   end
 
+  # ftp://ftp.eeng.dcu.ie/pub/ee454/cygwin/usr/share/doc/mlcscope-14.1.8/html/cscope.html
+  def export_cscope(filename)
+    buf = ""
+    files = []
+    db_by_line().each do |file, lines|
+      if not lines.empty?
+        buf << "\t@#{file}\n\n"
+        files << file
+      end
+      lines.sort.each do |line_no, vals|
+        line = vals.first[:entry][:line].strip.gsub(/\s+/, ' ')
+        toks = {}
+
+        vals.each do |val|
+          index = line.index(val[:key].to_s)
+          while index
+            toks[index] = val
+            index = line.index(val[:key].to_s, index + 1)
+          end
+        end
+
+        next if toks.empty?
+
+        prev = 0
+        buf << line_no.to_s << " "
+        toks.sort().each do |offset, val|
+          buf << line.slice(prev...offset) << "\n"
+          buf << StarScope::Datum.cscope_mark(val[:tbl], val[:entry])
+          buf << val[:key].to_s << "\n"
+          prev = offset + val[:key].to_s.length
+        end
+        buf << line.slice(prev..-1) << "\n\n"
+      end
+    end
+
+    buf << "\t@\n"
+
+    header = "cscope 15 #{Dir.pwd} -c "
+    offset = "%010d\n" % (header.length + 11 + buf.length)
+
+    File.open(filename, 'w') do |file|
+      file.print(header)
+      file.print(offset)
+      file.print(buf)
+
+      file.print("#{@paths.length}\n")
+      @paths.each {|p| file.print("#{p}\n")}
+      file.print("0\n")
+      file.print("#{files.length}\n")
+      buf = ""
+      files.each {|f| buf << f + "\n"}
+      file.print("#{buf.length}\n#{buf}")
+    end
+  end
+
   private
 
   def self.files_from_path(path)
@@ -159,6 +223,22 @@ END
     end
   end
 
+  def db_by_line()
+    tmpdb = {}
+    @tables.each do |tbl, vals|
+      vals.each do |key, val|
+        val.each do |entry|
+          if entry[:line_no]
+            tmpdb[entry[:file]] ||= {}
+            tmpdb[entry[:file]][entry[:line_no]] ||= []
+            tmpdb[entry[:file]][entry[:line_no]] << {tbl: tbl, key: key, entry: entry}
+          end
+        end
+      end
+    end
+    return tmpdb
+  end
+
   def add_file(file)
     return if not File.file? file
 
@@ -170,7 +250,7 @@ END
         key = key.to_sym
         @tables[tbl] ||= {}
         @tables[tbl][key] ||= []
-        @tables[tbl][key] << StarScope::Datum.build(file, args)
+        @tables[tbl][key] << StarScope::Datum.build(file, key, args)
       end
     end
   end

data/lib/starscope/langs/go.rb

@@ -1,6 +1,6 @@
 module StarScope::Lang
   module Go
-    FUNC_CALL = /([\w\.]+?)\(.*\)/
+    FUNC_CALL = /([\w\.]*?\w)\(.*\)/
     BUILTIN_FUNCS = ['new', 'make', 'len', 'close', 'copy', 'delete',
                      'int', 'int8', 'int16', 'int32', 'int64',
                      'uint', 'uint8', 'uint16', 'uint32', 'uint64',
@@ -14,6 +14,7 @@ module StarScope::Lang
       stack = []
       scope = []
       str = File.readlines(file).each_with_index do |line, line_no|
+        line_no += 1 # zero-index to one-index
         # strip single-line comments like // foo
         match = /(.*)\/\//.match(line)
         if match
@@ -47,23 +48,25 @@ module StarScope::Lang
         when :struct
           case line
           when /\s*(\w+)\s+\w+/
-            yield :defs, $1, line_no: line_no+1, scope: scope
+            yield :defs, $1, line_no: line_no, scope: scope
           when /}/
+            yield :end, "}", line_no: line_no, scope: scope, type: :class
             stack.pop
             scope.pop
           end
         when :interface
           case line
           when /\s*(\w+)\(.*\)\s+/
-            yield :defs, $1, line_no: line_no+1, scope: scope
+            yield :defs, $1, line_no: line_no, scope: scope
           when /}/
+            yield :end, "}", line_no: line_no, scope: scope, type: :class
             stack.pop
             scope.pop
           end
         when :def
           case line
           when /\s*(\w+)\s+/
-            yield :defs, $1, line_no: line_no+1, scope: scope
+            yield :defs, $1, line_no: line_no, scope: scope
           when /\)/
             stack.pop
           end
@@ -71,56 +74,57 @@ module StarScope::Lang
           case line
           when /"(.+)"/
             name = $1.split('/')
-            yield :imports, name[-1], line_no: line_no+1, scope: name[0...-1]
+            yield :imports, name[-1], line_no: line_no, scope: name[0...-1]
           when /\)/
             stack.pop
           end
         else
           if stack[-1] == :func and /^}/ =~ line
+            yield :end, "}", line_no: line_no, type: :func
             stack.pop
           end
           case line
           when /^func\s+(\w+)\(/
-            yield :defs, $1, line_no: line_no+1, scope: scope
+            yield :defs, $1, line_no: line_no, scope: scope, type: :func
             stack.push(:func)
           when /^func\s+\(\w+\s+\*?(\w+)\)\s*(\w+)\(/
-            yield :defs, $2, line_no: line_no+1, scope: scope + [$1]
+            yield :defs, $2, line_no: line_no, scope: scope + [$1], type: :func
             stack.push(:func)
           when /^package\s+(\w+)/
-            yield :defs, $1, line_no: line_no+1, scope: scope
+            yield :defs, $1, line_no: line_no, scope: scope, type: :package
             scope.push($1)
           when /^type\s+(\w+)\s+struct\s*{/
-            yield :defs, $1, line_no: line_no+1, scope: scope
+            yield :defs, $1, line_no: line_no, scope: scope, type: :class
             scope.push($1)
             stack.push(:struct)
           when /^type\s+(\w+)\s+interface\s*{/
-            yield :defs, $1, line_no: line_no+1, scope: scope
+            yield :defs, $1, line_no: line_no, scope: scope, type: :class
             scope.push($1)
             stack.push(:interface)
           when /^type\s+(\w+)/
-            yield :defs, $1, line_no: line_no+1, scope: scope
+            yield :defs, $1, line_no: line_no, scope: scope, type: :type
           when /^import\s+"(.+)"/
             name = $1.split('/')
-            yield :imports, name[-1], line_no: line_no+1, scope: name[0...-1]
+            yield :imports, name[-1], line_no: line_no, scope: name[0...-1]
           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+1, scope: scope
+            yield :defs, $1, line_no: line_no, scope: scope
           when /^const\s+\(/
             stack.push(:def)
           when /^const\s+(\w+)\s+\w+/
-            yield :defs, $1, line_no: line_no+1, scope: scope
+            yield :defs, $1, line_no: line_no, scope: scope
           when /^\s+(.*?) :?= ((.*?)\(.*\))?/
             $1.split(',').each do |var|
               var = var.strip
               name = var.split('.')
               case name.length
               when 1
-                yield :assigns, name[0], line_no: line_no+1, scope: scope
+                yield :assigns, name[0], line_no: line_no, scope: scope
               when 2
-                yield :assigns, name[1], line_no: line_no+1, scope: [name[0]]
+                yield :assigns, name[1], line_no: line_no, scope: [name[0]]
               end
             end
             if $2
@@ -149,12 +153,12 @@ module StarScope::Lang
       when 1
         return nil if name[0] == 'func'
         if BUILTIN_FUNCS.include?(name[0])
-          return :calls, name[0], line_no: line_no+1
+          return :calls, name[0], line_no: line_no
         else
-          return :calls, name[0], line_no: line_no+1, scope: scope
+          return :calls, name[0], line_no: line_no, scope: scope
         end
       else
-        return :calls, name[-1], line_no: line_no+1, scope: name[0...-1]
+        return :calls, name[-1], line_no: line_no, scope: name[0...-1]
       end
     end
   end

data/lib/starscope/langs/ruby.rb

@@ -59,15 +59,18 @@ module StarScope::Lang
         when :def
           yield :defs, node.children[0],
             line_no: node.location.expression.line,
-            scope: @scope
+            scope: @scope, 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
+            scope: @scope, 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]
+            scope: fqn[0...-1], 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,

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
 module StarScope
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/starscope.gemspec

@@ -13,9 +13,9 @@ Gem::Specification.new do |gem|
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'oj', '~> 2.1'
-  gem.add_dependency 'parser', '~> 2.0'
-  gem.add_dependency 'ruby-progressbar', '~> 1.2'
+  gem.add_dependency 'oj', '~> 2.5'
+  gem.add_dependency 'parser', '~> 2.1'
+  gem.add_dependency 'ruby-progressbar', '~> 1.4'
   gem.add_development_dependency 'bundler', '~> 1.3'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'pry'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starscope
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2014-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement