starscope 0.1.10 → 1.0.0

data/test/lib/test_db.rb

@@ -1,9 +1,26 @@
 require File.expand_path('../../test_helper', __FILE__)
+require 'tempfile'
 
 describe StarScope::DB do
 
+  def validate(db)
+    files = db.instance_eval('@meta[: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
+
+    tbls = db.instance_eval('@tables')
+    defs = tbls[:defs].map {|x| x[:name][-1]}
+    assert defs.include? :DB
+    assert defs.include? :NoTableError
+    assert defs.include? :load
+    assert defs.include? :update
+    assert defs.include? :files_from_path
+  end
+
   before do
-    @db = StarScope::DB.new(false)
+    @db = StarScope::DB.new(false, false)
   end
 
   it "must raise on invalid tables" do
@@ -11,34 +28,81 @@ describe StarScope::DB do
   end
 
   it "must correctly add paths" do
-    paths = [GOLANG_SAMPLE, 'test/files']
+    paths = [GOLANG_SAMPLE, 'test/files/**/*']
     @db.add_paths(paths)
-    @db.instance_eval('@paths').must_equal paths
-    @db.instance_eval('@files').keys.must_include GOLANG_SAMPLE
-    @db.instance_eval('@files').keys.must_include RUBY_SAMPLE
+    @db.instance_eval('@meta[:paths]').must_equal paths
+    validate(@db)
   end
 
   it "must correctly pick up new files in old paths" do
-    @db.instance_eval('@paths = ["test/files"]')
+    @db.instance_eval('@meta[:paths] = ["test/files/**/*"]')
     @db.update
-    files = @db.instance_eval('@files').keys
-    files.must_include GOLANG_SAMPLE
-    files.must_include RUBY_SAMPLE
+    validate(@db)
   end
 
   it "must correctly remove old files in existing paths" do
-    @db.instance_eval('@paths = ["test/files"]')
-    @db.instance_eval('@files = {"test/files/foo"=>"2012-01-01"}')
-    @db.instance_eval('@files').keys.must_include 'test/files/foo'
+    @db.instance_eval('@meta[:paths] = ["test/files"]')
+    @db.instance_eval('@meta[:files] = {"test/files/foo" => {:last_update=>1}}')
+    @db.instance_eval('@meta[:files]').keys.must_include 'test/files/foo'
     @db.update
-    @db.instance_eval('@files').keys.wont_include 'test/files/foo'
+    @db.instance_eval('@meta[:files]').keys.wont_include 'test/files/foo'
   end
 
   it "must correctly load an old DB file" do
     @db.load('test/files/db_old.json.gz')
-    @db.instance_eval('@paths').must_equal ['test/files']
-    @db.instance_eval('@files').keys.must_include GOLANG_SAMPLE
-    @db.instance_eval('@files').keys.must_include RUBY_SAMPLE
+    @db.instance_eval('@meta[:paths]').must_equal ['test/files/**/*']
+    validate(@db)
+  end
+
+  it "must correctly round-trip a database" do
+    file = Tempfile.new('starscope_test')
+    begin
+      @db.add_paths(['test/files'])
+      @db.save(file.path)
+      tmp = StarScope::DB.new(false, false)
+      tmp.load(file.path)
+      validate(tmp)
+    ensure
+      file.close
+      file.unlink
+    end
+  end
+
+  it "must correctly export to ctags" do
+    file = Tempfile.new('starscope_test')
+    begin
+      @db.add_paths(['test/files'])
+      @db.export_ctags(file)
+      file.rewind
+      lines = file.lines.to_a
+      lines.must_include "NoTableError\ttest/files/sample_ruby.rb\t/^  class NoTableError < StandardError; end$/;\"\tkind:c\n"
+    ensure
+      file.close
+      file.unlink
+    end
+  end
+
+  it "must correctly export to cscope" do
+    file = Tempfile.new('starscope_test')
+    begin
+      @db.add_paths(['test/files'])
+      @db.export_cscope(file)
+      file.rewind
+      lines = file.lines.to_a
+      lines.must_include "\t@test/files/sample_golang.go\n"
+      lines.must_include "\tgSunday\n"
+      lines.must_include "\t`add_file\n"
+    ensure
+      file.close
+      file.unlink
+    end
+  end
+
+  it "must correctly run queries" do
+    @db.add_paths(['test/files'])
+    @db.query(:calls, "abc").must_equal []
+    @db.query(:defs, "xyz").must_equal []
+    @db.query(:calls, "add_file").length.must_equal 3
   end
 
 end

data/test/lib/test_golang.rb

@@ -3,11 +3,9 @@ require File.expand_path('../../test_helper', __FILE__)
 class TestGolang < Minitest::Test
   def setup
     @db = {}
-    StarScope::Lang::Go.extract(GOLANG_SAMPLE) do |tbl, key, args|
-      key = key.to_sym
-      @db[tbl] ||= {}
-      @db[tbl][key] ||= []
-      @db[tbl][key] << args
+    StarScope::Lang::Go.extract(GOLANG_SAMPLE) do |tbl, name, args|
+      @db[tbl] ||= []
+      @db[tbl] << StarScope::Record.build(GOLANG_SAMPLE, name, args)
     end
   end
 
@@ -19,7 +17,7 @@ class TestGolang < Minitest::Test
 
   def test_defs
     assert @db.keys.include? :defs
-    defs = @db[:defs].keys
+    defs = @db[:defs].map {|x| x[:name][-1]}
     assert defs.include? :a
     assert defs.include? :b
     assert defs.include? :c
@@ -29,31 +27,36 @@ class TestGolang < Minitest::Test
     assert defs.include? :v2
     assert defs.include? :Sunday
     assert defs.include? :Monday
+    assert defs.include? :single_var
+    assert defs.include? :single_const
+
+    refute defs.include? :"0x00"
+    refute defs.include? :"0x01"
+    refute defs.include? :"0x02"
+    refute defs.include? :"0x03"
   end
 
-  def test_function_ends
+  def test_ends
     assert @db.keys.include? :end
-    ends = @db[:end]
-    assert ends.keys.count == 1
-    assert ends.values.first.count == 5
+    assert @db[:end].count == 6
   end
 
   def test_function_calls
     assert @db.keys.include? :calls
-    calls = @db[:calls]
+    calls = @db[:calls].group_by {|x| x[:name][-1]}
     assert calls.keys.include? :a
     assert calls.keys.include? :b
     assert calls.keys.include? :c
     assert calls.keys.include? :ttt
     assert calls[:a].count == 3
     assert calls[:b].count == 4
-    assert calls[:c].count == 2
+    assert calls[:c].count == 4
     assert calls[:ttt].count == 2
   end
 
   def test_variable_assigns
     assert @db.keys.include? :assigns
-    assigns = @db[:assigns]
+    assigns = @db[:assigns].group_by {|x| x[:name][-1]}
     assert assigns.keys.include? :x
     assert assigns.keys.include? :y
     assert assigns.keys.include? :z

data/test/lib/test_matcher.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+describe StarScope::Matcher do
+
+  SAMPLE_RECORDS = [
+    {:name => [:"[abc"]},
+    {:name => [:"not a match"]},
+    {:name => [:a, :b, :c, :d]},
+  ]
+
+  it "must handle empty input" do
+    matcher = StarScope::Matcher.new("foo", [])
+    matcher.query.must_be_empty
+  end
+
+  it "must handle scoped queries" do
+    matcher = StarScope::Matcher.new("a::b::", SAMPLE_RECORDS)
+    matcher.query.must_equal [SAMPLE_RECORDS[2]]
+  end
+
+  it "must handle regex queries" do
+    matcher = StarScope::Matcher.new("a[bc]{2}", SAMPLE_RECORDS)
+    matcher.query.must_equal [SAMPLE_RECORDS[0]]
+
+    matcher = StarScope::Matcher.new("a.*d", SAMPLE_RECORDS)
+    matcher.query.must_equal [SAMPLE_RECORDS[2]]
+  end
+
+  it "must handle malformed regexes" do
+    matcher = StarScope::Matcher.new("[abc", SAMPLE_RECORDS)
+    matcher.query.must_equal [SAMPLE_RECORDS[0]]
+  end
+
+end

data/test/lib/test_record.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+describe StarScope::Record do
+
+  it "must symbolize compound name" do
+    rec = StarScope::Record.build(:foo, ["a", :b], {})
+    rec[:name].must_equal [:a, :b]
+  end
+
+  it "must symbolize and array-wrap simple name" do
+    rec = StarScope::Record.build(:foo, "a", {})
+    rec[:name].must_equal [:a]
+  end
+
+  it "must read correct line from file" do
+    rec = StarScope::Record.build(GOLANG_SAMPLE, :a, {:line_no => 1})
+    rec[:line].must_equal "package main"
+  end
+
+end

data/test/lib/test_ruby.rb

@@ -3,11 +3,9 @@ require File.expand_path('../../test_helper', __FILE__)
 class TestRuby < Minitest::Test
   def setup
     @db = {}
-    StarScope::Lang::Ruby.extract(RUBY_SAMPLE) do |tbl, key, args|
-      key = key.to_sym
-      @db[tbl] ||= {}
-      @db[tbl][key] ||= []
-      @db[tbl][key] << args
+    StarScope::Lang::Ruby.extract(RUBY_SAMPLE) do |tbl, name, args|
+      @db[tbl] ||= []
+      @db[tbl] << StarScope::Record.build(RUBY_SAMPLE, name, args)
     end
   end
 
@@ -20,7 +18,7 @@ class TestRuby < Minitest::Test
 
   def test_function_defs
     assert @db.keys.include? :defs
-    defs = @db[:defs].keys
+    defs = @db[:defs].map {|x| x[:name][-1]}
     assert defs.include? :DB
     assert defs.include? :NoTableError
     assert defs.include? :load
@@ -28,16 +26,18 @@ class TestRuby < Minitest::Test
     assert defs.include? :files_from_path
   end
 
-  def test_function_ends
+  def test_constant_defs
+    assert @db[:defs].map {|x| x[:name][-1]}.include? :PBAR_FORMAT
+  end
+
+  def test_ends
     assert @db.keys.include? :end
-    ends = @db[:end]
-    assert ends.keys.count == 1
-    assert ends.values.first.count == 13
+    assert @db[:end].count == 13
   end
 
   def test_function_calls
     assert @db.keys.include? :calls
-    calls = @db[:calls]
+    calls = @db[:calls].group_by {|x| x[:name][-1]}
     assert calls.keys.include? :add_file
     assert calls.keys.include? :each
     assert calls[:add_file].count == 3
@@ -46,7 +46,7 @@ class TestRuby < Minitest::Test
 
   def test_variable_assigns
     assert @db.keys.include? :assigns
-    assigns = @db[:assigns]
+    assigns = @db[:assigns].group_by {|x| x[:name][-1]}
     assert assigns.keys.include? :pbar
     assert assigns.keys.include? :PBAR_FORMAT
     assert assigns[:pbar].count == 2

data/test/lib/test_starscope.rb

@@ -0,0 +1,33 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class TestStarScope < Minitest::Test
+
+  EXEC = 'bundle exec bin/starscope --no-read --no-write --no-progress ./test/files/'
+
+  def test_help
+    `#{EXEC} -h`.each_line do |line|
+      assert line.length <= 80
+    end
+  end
+
+  def test_version
+    assert `#{EXEC} -v`.chomp == StarScope::VERSION
+  end
+
+  def test_summary
+    lines = `#{EXEC} -s`.lines
+  end
+
+  def test_dump
+    lines = `#{EXEC} -d requires`.lines.to_a
+    assert lines[1].split.first == 'date'
+    assert lines[2].split.first == 'zlib'
+  end
+
+  def test_query
+    `#{EXEC} -q calls,add_file`.each_line do |line|
+      assert line.split[0..2] == ["StarScope", "DB", "add_file"]
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starscope
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -140,10 +140,14 @@ files:
 - Rakefile
 - bin/starscope
 - lib/starscope.rb
-- lib/starscope/datum.rb
 - lib/starscope/db.rb
+- lib/starscope/langs/coffeescript.rb
 - lib/starscope/langs/go.rb
+- lib/starscope/langs/lua.rb
 - lib/starscope/langs/ruby.rb
+- lib/starscope/matcher.rb
+- lib/starscope/output.rb
+- lib/starscope/record.rb
 - lib/starscope/version.rb
 - starscope.gemspec
 - test/files/db_old.json.gz
@@ -152,8 +156,10 @@ files:
 - test/files/sample_ruby.rb
 - test/lib/test_db.rb
 - test/lib/test_golang.rb
+- test/lib/test_matcher.rb
+- test/lib/test_record.rb
 - test/lib/test_ruby.rb
-- test/lib/test_version.rb
+- test/lib/test_starscope.rb
 - test/test_helper.rb
 homepage: https://github.com/eapache/starscope
 licenses:
@@ -176,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 818285020742325812
+      hash: 4554607803448639637
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -190,6 +196,8 @@ test_files:
 - test/files/sample_ruby.rb
 - test/lib/test_db.rb
 - test/lib/test_golang.rb
+- test/lib/test_matcher.rb
+- test/lib/test_record.rb
 - test/lib/test_ruby.rb
-- test/lib/test_version.rb
+- test/lib/test_starscope.rb
 - test/test_helper.rb

data/lib/starscope/datum.rb

@@ -1,91 +0,0 @@
-class StarScope::Datum
-
-  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
-    end
-
-    if args[:scope]
-      if args[:scope].empty?
-        args.delete(:scope)
-      else
-        args[:scope] = args[:scope].map {|x| x.to_sym}
-      end
-    end
-
-    args
-  end
-
-  def self.score_match(dat, fqn)
-    return 0 if not dat[:scope]
-
-    score = 0
-
-    i = -1
-    fqn[0...-1].reverse.each do |test|
-      if test.to_sym == dat[:scope][i]
-        score += 5
-      elsif Regexp.new(test, Regexp::IGNORECASE).match(dat[:scope][i])
-        score += 2
-      end
-      i -= 1
-    end
-
-    score - dat[:scope].count - i + 1
-  end
-
-  def self.location(dat)
-    "#{dat[:file]}:#{dat[:line_no]}"
-  end
-
-  def self.to_s(dat)
-    str = ""
-    str << "#{dat[:scope].join " "} " if dat[:scope]
-    str << "#{dat[:key]} -- #{location dat}"
-    str << " (#{dat[:line].strip})"
-  end
-
-  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