starscope 1.1.2 → 1.2.0

data/test/unit/langs/golang_test.rb

@@ -0,0 +1,98 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+describe Starscope::Lang::Go do
+  before do
+    @db = {}
+    Starscope::Lang::Go.extract(GOLANG_SAMPLE) do |tbl, name, args|
+      @db[tbl] ||= []
+      @db[tbl] << Starscope::DB.normalize_record(GOLANG_SAMPLE, name, args)
+    end
+  end
+
+  it "must match golang files" do
+    Starscope::Lang::Go.match_file(GOLANG_SAMPLE).must_equal true
+  end
+
+  it "must not match non-golang files" do
+    Starscope::Lang::Go.match_file(RUBY_SAMPLE).must_equal false
+    Starscope::Lang::Go.match_file(EMPTY_FILE).must_equal false
+  end
+
+  it "must identify definitions" do
+    @db.keys.must_include :defs
+    defs = @db[:defs].map {|x| x[:name][-1]}
+
+    defs.must_include :a
+    defs.must_include :b
+    defs.must_include :c
+    defs.must_include :ttt
+    defs.must_include :main
+    defs.must_include :v1
+    defs.must_include :v2
+    defs.must_include :Sunday
+    defs.must_include :Monday
+    defs.must_include :single_var
+    defs.must_include :single_const
+
+    defs.wont_include :"0x00"
+    defs.wont_include :"0x01"
+    defs.wont_include :"0x02"
+    defs.wont_include :"0x03"
+  end
+
+  it "must identify endings" do
+    @db.keys.must_include :end
+    @db[:end].count.must_equal 7
+  end
+
+  it "must identify function calls" do
+    @db.keys.must_include :calls
+    calls = @db[:calls].group_by {|x| x[:name][-1]}
+
+    calls.keys.must_include :a
+    calls.keys.must_include :b
+    calls.keys.must_include :c
+    calls.keys.must_include :ttt
+    calls.keys.must_include :Errorf
+
+    calls[:a].count.must_equal 3
+    calls[:b].count.must_equal 4
+    calls[:c].count.must_equal 4
+    calls[:ttt].count.must_equal 2
+    calls[:Errorf].count.must_equal 1
+  end
+
+  it "must identify variable assignments" do
+    @db.keys.must_include :assigns
+    assigns = @db[:assigns].group_by {|x| x[:name][-1]}
+
+    assigns.keys.must_include :x
+    assigns.keys.must_include :y
+    assigns.keys.must_include :z
+    assigns.keys.must_include :n
+    assigns.keys.must_include :m
+    assigns.keys.must_include :msg
+
+    assigns[:x].count.must_equal 2
+    assigns[:y].count.must_equal 1
+    assigns[:z].count.must_equal 1
+    assigns[:n].count.must_equal 1
+    assigns[:m].count.must_equal 2
+  end
+
+  it "must identify imports" do
+    @db.keys.must_include :imports
+    imports = @db[:imports].group_by {|x| x[:name][-1]}
+
+    imports.keys.must_include :fmt
+  end
+
+  it "must correctly find the end of string constants" do
+    Starscope::Lang::Go.find_end_of_string('"123"foo', 0).must_equal 4
+    Starscope::Lang::Go.find_end_of_string('a"123"foo', 0).must_equal 1
+    Starscope::Lang::Go.find_end_of_string('a"123"foo', 1).must_equal 5
+    Starscope::Lang::Go.find_end_of_string('"1\""foo', 0).must_equal 4
+    Starscope::Lang::Go.find_end_of_string('"1\\""foo', 0).must_equal 4
+    Starscope::Lang::Go.find_end_of_string('"1\\\\\"foo', 0).must_equal 9
+  end
+end

data/test/unit/langs/ruby_test.rb

@@ -0,0 +1,66 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+describe Starscope::Lang::Ruby do
+  before do
+    @db = {}
+    Starscope::Lang::Ruby.extract(RUBY_SAMPLE) do |tbl, name, args|
+      @db[tbl] ||= []
+      @db[tbl] << Starscope::DB.normalize_record(RUBY_SAMPLE, name, args)
+    end
+  end
+
+  it "must match ruby files" do
+    Starscope::Lang::Ruby.match_file(RUBY_SAMPLE).must_equal true
+    Starscope::Lang::Ruby.match_file('bin/starscope').must_equal true
+  end
+
+  it "must not match non-ruby files" do
+    Starscope::Lang::Ruby.match_file(GOLANG_SAMPLE).must_equal false
+    Starscope::Lang::Ruby.match_file(EMPTY_FILE).must_equal false
+  end
+
+  it "must identify function definitions" do
+    @db.keys.must_include :defs
+    defs = @db[:defs].map {|x| x[:name][-1]}
+
+    defs.must_include :DB
+    defs.must_include :NoTableError
+    defs.must_include :load
+    defs.must_include :update
+    defs.must_include :files_from_path
+  end
+
+  it "must identify constant definitions" do
+    @db[:defs].map {|x| x[:name][-1]}.must_include :PBAR_FORMAT
+  end
+
+  it "must identify endings" do
+    @db.keys.must_include :end
+    @db[:end].count.must_equal 13
+  end
+
+  it "must identify function calls" do
+    @db.keys.must_include :calls
+    calls = @db[:calls].group_by {|x| x[:name][-1]}
+
+    calls.keys.must_include :add_file
+    calls.keys.must_include :each
+    calls[:add_file].count.must_equal 3
+    calls[:each].count.must_equal 8
+  end
+
+  it "must identify variable assignments" do
+    @db.keys.must_include :assigns
+    assigns = @db[:assigns].group_by {|x| x[:name][-1]}
+
+    assigns.keys.must_include :pbar
+    assigns.keys.must_include :PBAR_FORMAT
+    assigns.keys.must_include :foo
+    assigns[:pbar].count.must_equal 2
+    assigns[:PBAR_FORMAT].count.must_equal 1
+    assigns[:foo].count.must_equal 1
+
+    assigns.keys.wont_include "=".to_sym
+    assigns.keys.wont_include "<".to_sym
+  end
+end

data/test/unit/{test_matcher.rb → matcher_test.rb}

@@ -1,6 +1,6 @@
 require File.expand_path('../../test_helper', __FILE__)
 
-describe StarScope::Matcher do
+describe Starscope::Matcher do
 
   SAMPLE_RECORDS = [
     {:name => [:"[abc"]},
@@ -9,25 +9,25 @@ describe StarScope::Matcher do
   ]
 
   it "must handle empty input" do
-    matcher = StarScope::Matcher.new("foo", [])
+    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 = 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 = Starscope::Matcher.new("a[bc]{2}", SAMPLE_RECORDS)
     matcher.query.must_equal [SAMPLE_RECORDS[0]]
 
-    matcher = StarScope::Matcher.new("a.*d", SAMPLE_RECORDS)
+    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 = Starscope::Matcher.new("[abc", SAMPLE_RECORDS)
     matcher.query.must_equal [SAMPLE_RECORDS[0]]
   end
 

data/test/unit/output_test.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+describe Starscope::Output do
+
+  it "must be quiet" do
+    buf = StringIO.new
+    out = Starscope::Output.new(:quiet, buf)
+    out.normal("foo")
+    out.extra("foo")
+    buf.size.must_equal 0
+  end
+
+  it "must be normal" do
+    buf = StringIO.new
+    out = Starscope::Output.new(:normal, buf)
+    out.normal("foo")
+    out.extra("foo")
+    buf.size.must_equal 4
+  end
+
+  it "must be verbose" do
+    buf = StringIO.new
+    out = Starscope::Output.new(:verbose, buf)
+    out.normal("foo")
+    out.extra("foo")
+    buf.size.must_equal 8
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: starscope
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Evan Huus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -108,6 +108,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A tool like the venerable cscope, but for ruby, golang and other languages
 email: eapache@gmail.com
 executables:
@@ -129,25 +143,31 @@ files:
 - doc/USER_GUIDE.md
 - lib/starscope.rb
 - lib/starscope/db.rb
+- lib/starscope/export.rb
 - lib/starscope/langs/coffeescript.rb
 - lib/starscope/langs/go.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/fixtures/db_added_files.json
 - test/fixtures/db_old.json.gz
+- test/fixtures/db_old_extractor.json
+- test/fixtures/db_out_of_date.json
+- test/fixtures/db_removed_files.json
+- test/fixtures/db_up_to_date.json
 - test/fixtures/empty
 - test/fixtures/sample_golang.go
 - test/fixtures/sample_ruby.rb
-- test/functional/test_starscope.rb
+- test/functional/starscope_test.rb
 - test/test_helper.rb
-- test/unit/test_db.rb
-- test/unit/test_golang.rb
-- test/unit/test_matcher.rb
-- test/unit/test_record.rb
-- test/unit/test_ruby.rb
+- test/unit/db_test.rb
+- test/unit/export_test.rb
+- test/unit/langs/golang_test.rb
+- test/unit/langs/ruby_test.rb
+- test/unit/matcher_test.rb
+- test/unit/output_test.rb
 homepage: https://github.com/eapache/starscope
 licenses:
 - MIT
@@ -173,14 +193,20 @@ signing_key:
 specification_version: 4
 summary: A code indexer and analyzer
 test_files:
+- test/fixtures/db_added_files.json
 - test/fixtures/db_old.json.gz
+- test/fixtures/db_old_extractor.json
+- test/fixtures/db_out_of_date.json
+- test/fixtures/db_removed_files.json
+- test/fixtures/db_up_to_date.json
 - test/fixtures/empty
 - test/fixtures/sample_golang.go
 - test/fixtures/sample_ruby.rb
-- test/functional/test_starscope.rb
+- test/functional/starscope_test.rb
 - test/test_helper.rb
-- test/unit/test_db.rb
-- test/unit/test_golang.rb
-- test/unit/test_matcher.rb
-- test/unit/test_record.rb
-- test/unit/test_ruby.rb
+- test/unit/db_test.rb
+- test/unit/export_test.rb
+- test/unit/langs/golang_test.rb
+- test/unit/langs/ruby_test.rb
+- test/unit/matcher_test.rb
+- test/unit/output_test.rb

data/lib/starscope/record.rb

@@ -1,98 +0,0 @@
-class StarScope::Record
-
-  @@cachedFile = nil
-  @@cachedLines = nil
-
-  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]
-      if @@cachedFile != file
-        @@cachedFile = file
-        @@cachedLines = File.readlines(file)
-      end
-
-      args[:line] = @@cachedLines[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, file)
-    ret = "#{rec[:name][-1]}\t#{rec[:file]}\t/^#{rec[:line]}$/"
-
-    ext = self.ctag_ext_tags(rec, file)
-    if not ext.empty?
-      ret << ";\""
-      ext.sort.each do |k, v|
-        ret << "\t#{k}:#{v}"
-      end
-    end
-
-    ret
-  end
-
-  def self.ctag_ext_tags(rec, file)
-    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["language"] = file[:lang]
-
-    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/test/functional/test_starscope.rb

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