starscope 0.0.5 → 0.0.6

data/CHANGELOG.md

@@ -1,7 +1,18 @@
 Changelog
 =========
 
-v0.0.5 (trunk)
+v0.0.6 (trunk)
+-------------------
+
+Interface:
+ * Table names are now consistently conjugated (def -> defs, assign -> assigns)
+ * The `starscope` binary no longer has an unnecessary .rb suffix.
+
+Internals:
+ * Update to a new version of the ruby parser that is significantly faster.
+ * Database is now stored as gzipped JSON for better portability
+
+v0.0.5 (2013-06-22)
 -------------------
 
 New Features:

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    starscope (0.0.5)
-      parser (~> 1.4)
+    starscope (0.0.6)
+      parser (= 2.0.0.pre2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (1.0.2)
+    ast (1.1.0)
     coderay (1.0.9)
     columnize (0.3.6)
     debugger (1.6.0)
@@ -17,9 +17,9 @@ GEM
     debugger-linecache (1.2.0)
     debugger-ruby_core_source (1.2.2)
     method_source (0.8.1)
-    parser (1.4.1)
-      ast (~> 1.0)
-      slop (~> 3.4)
+    parser (2.0.0.pre2)
+      ast (~> 1.1)
+      slop (~> 3.4, >= 3.4.5)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)

data/README.md

@@ -1,6 +1,9 @@
 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++).
@@ -17,17 +20,17 @@ $ gem install starscope
 Build your database, by just running it in the project directory:
 ```
 $ cd ~/my-project
-$ starscope.rb
+$ starscope
 ```
 
 Ask it things with `-q`
 ```
-$ starscope.rb -q calls,new # Lists all callers of new
+$ starscope -q calls,new # Lists all callers of new
 ```
 
 Export it for use with your editor
 ```
-$ starscope.rb -e ctags
+$ starscope -e ctags
 ```
 
 [1] http://cscope.sourceforge.net/

data/TODO.md

@@ -0,0 +1,6 @@
+TODO
+=========
+
+* Parallelization, perhaps via https://github.com/grosser/parallel
+* Export advanced ctags annotations
+* Export to cscope format

data/bin/{starscope.rb → starscope}

@@ -74,7 +74,7 @@ def run_query(db, table, value)
     $stderr.puts "Invalid input - no query found."
     return
   end
-  puts db.query(table.to_sym, value)
+  puts db.query(table.to_sym, value).map {|val| StarScope::Datum.to_s(val)}
   return true
 rescue StarScope::DB::NoTableError
   $stderr.puts "Table '#{table}' doesn't exist."

data/lib/starscope/datum.rb

@@ -1,42 +1,48 @@
 class StarScope::Datum
-  attr_reader :key, :file
-
-  def initialize(fqn, file, line_no)
-    @key = fqn[-1].to_sym
-    @scope = fqn[0...-1].map {|x| x.to_sym}
-    @file = file
-    @line_no = line_no
-    @line = File.readlines(file)[line_no-1].chomp
+
+  def self.build(key, file, args)
+    args[:key]  = key
+    args[:file] = file
+
+    if args[:line_no]
+      args[:line] = File.readlines(file)[args[:line_no]-1].chomp
+    end
+
+    if args[:scope]
+      args[:scope] = args[:scope].map {|x| x.to_sym}
+    end
+
+    args
   end
 
-  def score_match(fqn)
+  def self.score_match(dat, fqn)
     score = 0
 
     i = -1
     fqn[0...-1].reverse.each do |test|
-      if test.to_sym == @scope[i]
+      if test.to_sym == dat[:scope][i]
         score += 5
-      elsif Regexp.new(test, Regexp::IGNORECASE).match(@scope[i])
+      elsif Regexp.new(test, Regexp::IGNORECASE).match(dat[:scope][i])
         score += 2
       end
       i -= 1
     end
 
-    score - @scope.count - i + 1
+    score - dat[:scope].count - i + 1
   end
 
-  def location
-    "#{@file}:#{@line_no}"
+  def self.location(dat)
+    "#{dat[:file]}:#{dat[:line_no]}"
   end
 
-  def to_s
+  def self.to_s(dat)
     str = ""
-    str << "#{@scope.join " "} " unless @scope.empty?
-    str << "#{@key} -- #{location}"
-    str << " (#{@line.strip})"
+    str << "#{dat[:scope].join " "} " unless dat[:scope].empty?
+    str << "#{dat[:key]} -- #{location dat}"
+    str << " (#{dat[:line].strip})"
   end
 
-  def ctag_line
-    "#{@key}\t#{@file}\t/^#{@line}$/;"
+  def self.ctag_line(dat)
+    "#{dat[:key]}\t#{dat[:file]}\t/^#{dat[:line]}$/;"
   end
 end

data/lib/starscope/db.rb

@@ -1,12 +1,14 @@
 require 'starscope/langs/ruby'
-require "starscope/datum"
+require 'starscope/datum'
+require 'date'
+require 'json'
 require 'zlib'
 
 LANGS = [StarScope::Lang::Ruby]
 
 class StarScope::DB
 
-  DB_FORMAT = 2
+  DB_FORMAT = 3
 
   class NoTableError < StandardError; end
   class UnknownDBFormatError < StandardError; end
@@ -22,12 +24,16 @@ class StarScope::DB
       Zlib::GzipReader.wrap(file) do |file|
         format = file.gets.to_i
         if format == DB_FORMAT
-          @dirs   = load_part(file)
-          @files  = load_part(file)
-          @tables = load_part(file)
+          @dirs   = JSON.parse(file.gets, symbolize_names: false)
+          @files  = JSON.parse(file.gets, symbolize_names: false)
+          @tables = JSON.parse(file.gets, symbolize_names: true)
+        elsif format <= 2
+          # Old format (pre-json), so read the directories segment then rebuild
+          len = file.gets.to_i
+          add_dirs(Marshal::load(file.read(len)))
         elsif format < DB_FORMAT
           # Old format, so read the directories segment then rebuild
-          add_dirs(load_part(file))
+          add_dirs(JSON.parse(file.gets, symbolize_names: false))
         elsif format > DB_FORMAT
           raise UnknownDBFormatError
         end
@@ -39,9 +45,9 @@ class StarScope::DB
     File.open(file, 'w') do |file|
       Zlib::GzipWriter.wrap(file) do |file|
         file.puts DB_FORMAT
-        save_part(file, @dirs)
-        save_part(file, @files)
-        save_part(file, @tables)
+        file.puts JSON.fast_generate @dirs
+        file.puts JSON.fast_generate @files
+        file.puts JSON.fast_generate @tables
       end
     end
   end
@@ -90,11 +96,15 @@ class StarScope::DB
   def query(table, value)
     fqn = value.split("::")
     raise NoTableError if not @tables[table]
-    results = @tables[table][fqn[-1].to_sym]
+    results = @tables[table][fqn.last.to_sym]
     return [] if results.nil? || results.empty?
-    results.sort! {|a,b| b.score_match(fqn) <=> a.score_match(fqn)}
-    best_score = results[0].score_match(fqn)
-    results.select {|result| best_score - result.score_match(fqn) < 4}
+    results.sort! do |a,b|
+      StarScope::Datum.score_match(b, fqn) <=> StarScope::Datum.score_match(a, fqn)
+    end
+    best_score = StarScope::Datum.score_match(results[0], fqn)
+    results.select do |result|
+      best_score - StarScope::Datum.score_match(result, fqn) < 4
+    end
   end
 
   def export_ctags(filename)
@@ -107,10 +117,10 @@ class StarScope::DB
 !_TAG_PROGRAM_URL	https://github.com/eapache/starscope //
 !_TAG_PROGRAM_VERSION	#{StarScope::VERSION}	//
 END
-      defs = (@tables[:def] || []).sort {|a,b| a <=> b}
+      defs = (@tables[:defs] || []).sort {|a,b| a <=> b}
       defs.each do |key, val|
         val.each do |entry|
-          file.puts entry.ctag_line
+          file.puts StarScope::Datum.ctag_line(entry)
         end
       end
     end
@@ -118,29 +128,17 @@ END
 
   private
 
-  def load_part(file)
-    len = file.gets.to_i
-    Marshal::load(file.read(len))
-  end
-
-  def save_part(file, val)
-    dat = Marshal.dump(val)
-    file.puts dat.length
-    file.write dat
-  end
-
   def add_file(file)
     return if not File.file? file
 
-    @files[file] = File.mtime(file)
+    @files[file] = File.mtime(file).to_s
 
     LANGS.each do |lang|
       next if not lang.match_file file
-      lang.extract file do |tblname, fqn, lineno|
-        datum = StarScope::Datum.new(fqn, file, lineno)
-        @tables[tblname] ||= {}
-        @tables[tblname][datum.key] ||= []
-        @tables[tblname][datum.key] << datum
+      lang.extract file do |tbl, key, args|
+        @tables[tbl] ||= {}
+        @tables[tbl][key] ||= []
+        @tables[tbl][key] << StarScope::Datum.build(key, file, args)
       end
     end
   end
@@ -149,7 +147,7 @@ END
     @files.delete(file)
     @tables.each do |name, tbl|
       tbl.each do |key, val|
-        val.delete_if {|dat| dat.file == file}
+        val.delete_if {|dat| dat[:file] == file}
       end
     end
   end
@@ -157,7 +155,7 @@ END
   def update_file(file)
     if not File.exists?(file)
       remove_file(file)
-    elsif @files[file] < File.mtime(file)
+    elsif DateTime.parse(@files[file]).to_time < File.mtime(file)
       remove_file(file)
       add_file(file)
     end

data/lib/starscope/langs/ruby.rb

@@ -22,7 +22,7 @@ module StarScope::Lang
         @ast = ast
         @scope = []
       end
-      
+
       def extract(&block)
         extract_tree(@ast, &block)
       end
@@ -45,30 +45,42 @@ module StarScope::Lang
 
       def extract_node(node)
         if node.type == :send
-          yield :calls, scoped_name(node), node.source_map.expression.line
+          fqn = scoped_name(node)
+          yield :calls, fqn.last, line_no: node.location.expression.line,
+            scope: fqn[0...-1]
 
           if node.children[0].nil? and node.children[1] == :require and node.children[2].type == :str
-            yield :requires, node.children[2].children[0].split("/"), node.source_map.expression.line
+            fqn = node.children[2].children[0].split("/")
+            yield :requires, fqn.last, line_no: node.location.expression.line,
+              scope: fqn[0...-1]
           end
         end
 
         if node.type == :def
-          yield :def, @scope + [node.children[0]], node.source_map.expression.line
+          yield :defs, node.children[0],
+            line_no: node.location.expression.line,
+            scope: @scope
         elsif [:module, :class].include? node.type
-          yield :def, @scope + scoped_name(node.children[0]), node.source_map.expression.line
+          fqn = @scope + scoped_name(node.children[0])
+          yield :defs, fqn.last, line_no: node.location.expression.line,
+            scope: fqn[0...-1]
         end
 
-        if node.type == :cdecl
-          yield :assign, scoped_name(node), node.source_map.expression.line
-        elsif [:lvasgn, :ivasgn, :cvdecl, :cvasgn, :gvasgn].include? node.type
-          yield :assign, @scope + [node.children[0]], node.source_map.expression.line
+        if node.type == :casgn
+          fqn = scoped_name(node)
+          yield :assigns, fqn.last, line_no: node.location.expression.line,
+            scope: fqn[0...-1]
+        elsif [:lvasgn, :ivasgn, :cvasgn, :gvasgn].include? node.type
+          yield :assigns, node.children[0],
+            line_no: node.location.expression.line,
+            scope: @scope
         end
       end
 
       def scoped_name(node)
         if node.type == :block
           scoped_name(node.children[0])
-        elsif [:lvar, :ivar, :cvar, :gvar, :const, :send, :cdecl].include? node.type
+        elsif [:lvar, :ivar, :cvar, :gvar, :const, :send, :casgn].include? node.type
           if node.children[0].is_a? Symbol
             [node.children[0]]
           elsif node.children[0].is_a? AST::Node

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
 module StarScope
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/starscope.gemspec

@@ -12,7 +12,7 @@ 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 'parser', '~> 1.4'
+  gem.add_dependency 'parser', '= 2.0.0.pre2'
   gem.add_development_dependency 'bundler', '~> 1.3'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'pry'

metadata

@@ -2,14 +2,14 @@
 name: starscope
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Evan Huus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-22 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false
@@ -17,15 +17,15 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 2.0.0.pre2
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 2.0.0.pre2
     none: false
 - !ruby/object:Gem::Dependency
   prerelease: false
@@ -94,7 +94,7 @@ dependencies:
 description: A tool like the venerable cscope, but for ruby and other languages
 email: eapache@gmail.com
 executables:
-- starscope.rb
+- starscope
 extensions: []
 extra_rdoc_files: []
 files:
@@ -105,7 +105,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/starscope.rb
+- TODO.md
+- bin/starscope
 - lib/starscope.rb
 - lib/starscope/datum.rb
 - lib/starscope/db.rb
@@ -125,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: -3682950058124738529
+      hash: -2937951633006975654
       version: '0'
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: -3682950058124738529
+      hash: -2937951633006975654
       version: '0'
   none: false
 requirements: []