starscope 1.1.2 → 1.2.0

data/lib/starscope/matcher.rb

@@ -1,4 +1,4 @@
-class StarScope::Matcher
+class Starscope::Matcher
 
   MATCH_TYPES = [:full_match, :simple_match, :simple_regexp, :full_regexp]
 

data/lib/starscope/output.rb

@@ -1,10 +1,11 @@
 require 'ruby-progressbar'
 
-class StarScope::Output
+class Starscope::Output
 
   PBAR_FORMAT = '%t: %c/%C %E ||%b>%i||'
 
-  def initialize(level)
+  def initialize(level, out=STDOUT)
+    @out = out
     @level = level
     @pbar = nil
   end
@@ -12,7 +13,8 @@ class StarScope::Output
   def new_pbar(title, num_items)
     if @level != :quiet
       @pbar = ProgressBar.create(:title => title, :total => num_items,
-                                :format => PBAR_FORMAT, :length => 80)
+                                :format => PBAR_FORMAT, :length => 80,
+                                :out => @out)
     end
   end
 
@@ -25,12 +27,12 @@ class StarScope::Output
     @pbar = nil
   end
 
-  def log(msg)
-    return if @level != :verbose
+  def extra(msg)
+    return unless @level == :verbose
     output(msg)
   end
 
-  def print(msg)
+  def normal(msg)
     return if @level == :quiet
     output(msg)
   end
@@ -41,7 +43,7 @@ class StarScope::Output
     if @pbar
       @pbar.log(msg)
     else
-      puts msg
+      @out.puts msg
     end
   end
 

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
-module StarScope
-  VERSION = "1.1.2"
+module Starscope
+  VERSION = "1.2.0"
 end

data/starscope.gemspec

@@ -2,7 +2,7 @@ require File.expand_path('../lib/starscope/version.rb', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = 'starscope'
-  gem.version       = StarScope::VERSION
+  gem.version       = Starscope::VERSION
   gem.summary       = "A code indexer and analyzer"
   gem.description   = "A tool like the venerable cscope, but for ruby, golang and other languages"
   gem.authors       = ["Evan Huus"]
@@ -22,4 +22,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'mocha'
 end

data/test/fixtures/db_added_files.json

@@ -0,0 +1,8 @@
+5
+{
+    ":paths": ["test/fixtures/**/*"],
+    ":excludes": [],
+    ":langs": {},
+    ":files": {}
+}
+{}

data/test/fixtures/db_old_extractor.json

@@ -0,0 +1,15 @@
+5
+{
+    ":paths": [],
+    ":excludes": [],
+    ":langs": {
+        ":Go": 0
+    },
+    ":files": {
+        "test/fixtures/sample_golang.go": {
+            ":last_updated": 10000000000,
+            ":lang": ":Go"
+        }
+    }
+}
+{}

data/test/fixtures/db_out_of_date.json

@@ -0,0 +1,15 @@
+5
+{
+    ":paths": [],
+    ":excludes": [],
+    ":langs": {
+        ":Go": 1234
+    },
+    ":files": {
+        "test/fixtures/sample_golang.go": {
+            ":last_updated": 1,
+            ":lang": ":Go"
+        }
+    }
+}
+{}

data/test/fixtures/db_removed_files.json

@@ -0,0 +1,12 @@
+5
+{
+    ":paths": ["test/fixtures/**/*"],
+    ":excludes": [],
+    ":langs": {},
+    ":files": {
+        "test/fixtures/foo": {
+            ":last_updated": 1
+        }
+    }
+}
+{}

data/test/fixtures/db_up_to_date.json

@@ -0,0 +1,15 @@
+5
+{
+    ":paths": [],
+    ":excludes": [],
+    ":langs": {
+        ":Go": 1234
+    },
+    ":files": {
+        "test/fixtures/sample_golang.go": {
+            ":last_updated": 10000000000,
+            ":lang": ":Go"
+        }
+    }
+}
+{}

data/test/fixtures/sample_ruby.rb

@@ -2,11 +2,11 @@ require 'date'
 require 'zlib'
 
 LANGS = [
-  StarScope::Lang::Go,
-  StarScope::Lang::Ruby
+  Starscope::Lang::Go,
+  Starscope::Lang::Ruby
 ]
 
-class StarScope::DB
+class Starscope::DB
 
   PBAR_FORMAT = '%t: %c/%C %E ||%b>%i||'
 
@@ -20,21 +20,21 @@ class StarScope::DB
     self.foo = :bar
   end
 
-  def load(file)
-    File.open(file, 'r') do |file|
-      Zlib::GzipReader.wrap(file) do |file|
-        format = file.gets.to_i
+  def load(filename)
+    File.open(filename, 'r') do |file|
+      Zlib::GzipReader.wrap(file) do |stream|
+        format = stream.gets.to_i
         if format == DB_FORMAT
-          @paths  = Oj.load(file.gets)
-          @files  = Oj.load(file.gets)
-          @tables = Oj.load(file.gets, :symbol_keys => true)
+          @paths  = Oj.load(stream.gets)
+          @files  = Oj.load(stream.gets)
+          @tables = Oj.load(stream.gets, :symbol_keys => true)
         elsif format <= 2
           # Old format (pre-json), so read the directories segment then rebuild
-          len = file.gets.to_i
-          add_paths(Marshal::load(file.read(len)))
+          len = stream.gets.to_i
+          add_paths(Marshal::load(stream.read(len)))
         elsif format < DB_FORMAT
           # Old format, so read the directories segment then rebuild
-          add_paths(Oj.load(file.gets))
+          add_paths(Oj.load(stream.gets))
         elsif format > DB_FORMAT
           raise UnknownDBFormatError
         end
@@ -42,13 +42,13 @@ class StarScope::DB
     end
   end
 
-  def save(file)
-    File.open(file, 'w') do |file|
-      Zlib::GzipWriter.wrap(file) do |file|
-        file.puts DB_FORMAT
-        file.puts Oj.dump @paths
-        file.puts Oj.dump @files
-        file.puts Oj.dump @tables
+  def save(filename)
+    File.open(filename, 'w') do |file|
+      Zlib::GzipWriter.wrap(file) do |stream|
+        stream.puts DB_FORMAT
+        stream.puts Oj.dump @paths
+        stream.puts Oj.dump @files
+        stream.puts Oj.dump @tables
       end
     end
   end
@@ -134,7 +134,7 @@ class StarScope::DB
         key = key.to_sym
         @tables[tbl] ||= {}
         @tables[tbl][key] ||= []
-        @tables[tbl][key] << StarScope::Datum.build(file, key, args)
+        @tables[tbl][key] << Starscope::Datum.build(file, key, args)
       end
     end
   end

data/test/functional/starscope_test.rb

@@ -0,0 +1,57 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+describe "starscope executable script" do
+
+  BASE = "bundle exec bin/starscope --quiet"
+  EXTRACT = "#{BASE} --no-read --no-write #{FIXTURES}"
+
+  it "must not produce help wider than 80 characters" do
+    `#{BASE} -h`.each_line do |line|
+      line.length.must_be :<=, 80
+    end
+  end
+
+  it "must produce the right version" do
+    `#{BASE} -v`.chomp.must_equal Starscope::VERSION
+  end
+
+  it "must produce a valid database summary" do
+    lines = `#{EXTRACT} -s`.lines.to_a
+    lines.length.must_equal 6
+  end
+
+  it "must produce a valid database dump" do
+    lines = `#{EXTRACT} -d requires`.lines.to_a
+    lines[1].split.first.must_equal 'date'
+    lines[2].split.first.must_equal 'zlib'
+  end
+
+  it "must correctly query the database" do
+    `#{EXTRACT} -q calls,add_file`.each_line do |line|
+      line.split[0..2].must_equal ["Starscope", "DB", "add_file"]
+    end
+  end
+
+  it "must correctly export to cscope" do
+    file = Tempfile.new('starscope_test')
+    begin
+      `#{EXTRACT} -e cscope,#{file.path()}`
+      $?.exitstatus.must_equal 0
+    ensure
+      file.close
+      file.unlink
+    end
+  end
+
+  it "Must correctly export to ctags" do
+    file = Tempfile.new('starscope_test')
+    begin
+      `#{EXTRACT} -e ctags,#{file.path()}`
+      $?.exitstatus.must_equal 0
+    ensure
+      file.close
+      file.unlink
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -1,5 +1,6 @@
 require 'minitest/autorun'
 require 'minitest/pride'
+require 'mocha/mini_test'
 require File.expand_path('../../lib/starscope.rb', __FILE__)
 
 FIXTURES="test/fixtures"

data/test/unit/db_test.rb

@@ -0,0 +1,141 @@
+require File.expand_path('../../test_helper', __FILE__)
+require 'tempfile'
+
+describe Starscope::DB do
+
+  before do
+    @db = Starscope::DB.new(Starscope::Output.new(:quiet))
+  end
+
+  it "must raise on invalid tables" do
+    proc {
+      @db.records(:foo)
+    }.must_raise Starscope::DB::NoTableError
+  end
+
+  it "must add paths" do
+    paths = [GOLANG_SAMPLE, "#{FIXTURES}/**/*"]
+    @db.add_paths(paths)
+
+    @db.metadata(:paths).must_equal paths
+    validate(@db)
+  end
+
+  it "must add excludes" do
+    paths = [GOLANG_SAMPLE, "#{FIXTURES}/**/*"]
+    @db.add_paths(paths)
+    @db.add_excludes(["#{FIXTURES}/**"])
+
+    files = @db.metadata(:files).keys
+    files.wont_include RUBY_SAMPLE
+    files.wont_include GOLANG_SAMPLE
+    @db.records(:defs).must_be_empty
+    @db.records(:end).must_be_empty
+  end
+
+  it "must pick up new files in old paths" do
+    @db.load("#{FIXTURES}/db_added_files.json")
+    @db.update
+
+    validate(@db)
+  end
+
+  it "must remove old files in existing paths" do
+    @db.load("#{FIXTURES}/db_removed_files.json")
+    @db.update
+    @db.metadata(:files).keys.wont_include "#{FIXTURES}/foo"
+  end
+
+  it "must update stale existing files when extractor hasn't changed" do
+    @db.load("#{FIXTURES}/db_out_of_date.json")
+    @db.metadata(:langs)[:Go].must_be :>=, LANGS[:Go]
+
+    cur_mtime = @db.metadata(:files)[GOLANG_SAMPLE][:last_updated]
+    File.expects(:mtime).twice.returns(cur_mtime + 1)
+    @db.update
+
+    file = @db.metadata(:files)[GOLANG_SAMPLE]
+    file[:last_updated].must_equal cur_mtime + 1
+    file[:lang].must_equal :Go
+    file[:lines].wont_be_empty
+    @db.records(:defs).wont_be_empty
+    @db.records(:calls).wont_be_empty
+  end
+
+  it "must update unchanged existing files with old extractor versions" do
+    @db.load("#{FIXTURES}/db_old_extractor.json")
+
+    cur_mtime = @db.metadata(:files)[GOLANG_SAMPLE][:last_updated]
+    File.expects(:mtime).twice.returns(cur_mtime)
+    @db.update
+
+    file = @db.metadata(:files)[GOLANG_SAMPLE]
+    file[:last_updated].must_equal cur_mtime
+    file[:lang].must_equal :Go
+    file[:lines].wont_be_empty
+    @db.records(:defs).wont_be_empty
+    @db.records(:calls).wont_be_empty
+  end
+
+  it "must not update file with up-to-date time and extractor" do
+    @db.load("#{FIXTURES}/db_up_to_date.json")
+    @db.update
+
+    file = @db.metadata(:files)[GOLANG_SAMPLE]
+    file[:last_updated].must_equal 10000000000
+    @db.tables.must_be_empty
+  end
+
+  it "must load an old DB file" do
+    @db.load("#{FIXTURES}/db_old.json.gz")
+    @db.metadata(:paths).must_equal ["#{FIXTURES}/**/*"]
+    validate(@db)
+  end
+
+  it "must round-trip a database" do
+    file = Tempfile.new('starscope_test')
+    begin
+      @db.add_paths([FIXTURES])
+      @db.save(file.path)
+      tmp = Starscope::DB.new(Starscope::Output.new(:quiet))
+      tmp.load(file.path)
+      validate(tmp)
+    ensure
+      file.close
+      file.unlink
+    end
+  end
+
+  it "must run queries" do
+    @db.add_paths([FIXTURES])
+    @db.query(:calls, "abc").must_equal []
+    @db.query(:defs, "xyz").must_equal []
+    @db.query(:calls, "add_file").length.must_equal 3
+  end
+
+  it "must symbolize compound name" do
+    rec = Starscope::DB.normalize_record(:foo, ["a", :b], {})
+    rec[:name].must_equal [:a, :b]
+  end
+
+  it "must symbolize and array-wrap simple name" do
+    rec = Starscope::DB.normalize_record(:foo, "a", {})
+    rec[:name].must_equal [:a]
+  end
+
+  private
+
+  def validate(db)
+    files = db.metadata(:files)
+    files.keys.must_include GOLANG_SAMPLE
+    files.keys.must_include RUBY_SAMPLE
+    files[GOLANG_SAMPLE][:last_updated].must_equal File.mtime(GOLANG_SAMPLE).to_i
+    files[RUBY_SAMPLE][:last_updated].must_equal File.mtime(RUBY_SAMPLE).to_i
+
+    db.records(:defs).wont_be_empty
+    db.records(:calls).wont_be_empty
+    db.records(:imports).wont_be_empty
+    db.records(:requires).wont_be_empty
+  end
+
+end

data/test/unit/export_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+describe Starscope::Export do
+
+  before do
+    @db = Starscope::DB.new(Starscope::Output.new(:quiet))
+    @db.add_paths([FIXTURES])
+    @buf = StringIO.new
+  end
+
+  it "must export to ctags" do
+    @db.export_to(:ctags, @buf)
+    @buf.rewind
+    lines = @buf.lines.to_a
+    lines.must_include "NoTableError\t#{FIXTURES}/sample_ruby.rb\t/^  class NoTableError < StandardError; end$/;\"\tkind:c\tlanguage:Ruby\n"
+  end
+
+  it "must export to cscope" do
+    @db.export_to(:cscope, @buf)
+    @buf.rewind
+    lines = @buf.lines.to_a
+
+    lines.must_include "\t@#{FIXTURES}/sample_golang.go\n"
+    lines.must_include "\tgSunday\n"
+    lines.must_include "\t`add_file\n"
+    lines.must_include "\t}}\n"
+    lines.must_include "13 class \n"
+
+    lines.wont_include "= [\n"
+    lines.wont_include "4 LANGS = [\n"
+    lines.wont_include "116 tmpdb[entry[:file]][entry[:line_no]] ||= []\n"
+  end
+
+end