starscope 1.3.3 → 1.4.0

data/lib/starscope/langs/ruby.rb

@@ -1,20 +1,20 @@
-require "parser/current"
+require 'parser/current'
 
 module Starscope::Lang
   module Ruby
     VERSION = 2
 
     def self.match_file(name)
-      return true if name.end_with?(".rb") || name.end_with?(".rake")
+      return true if name.end_with?('.rb') || name.end_with?('.rake')
       File.open(name) do |f|
         head = f.read(2)
-        return false if head.nil? || !head.start_with?("#!")
-        return f.readline.include?("ruby")
+        return false if head.nil? || !head.start_with?('#!')
+        return f.readline.include?('ruby')
       end
     end
 
-    def self.extract(file, &block)
-      ast = Parser::CurrentRuby.parse_file(file)
+    def self.extract(path, contents, &block)
+      ast = Parser::CurrentRuby.parse(contents)
       extract_tree(ast, [], &block) unless ast.nil?
     end
 
@@ -29,7 +29,7 @@ module Starscope::Lang
         scope += new_scope
       end
 
-      tree.children.each {|node| extract_tree(node, scope, &block) if node.is_a? AST::Node}
+      tree.children.each { |node| extract_tree(node, scope, &block) if node.is_a? AST::Node }
 
       scope.pop(new_scope.count)
     end
@@ -45,8 +45,8 @@ module Starscope::Lang
         if name.last.to_s =~ /\w+=$/
           name[-1] = name.last.to_s.chop.to_sym
           yield :assigns, name, :line_no => loc.line, :col => loc.column
-        elsif node.children[0].nil? and node.children[1] == :require and node.children[2].type == :str
-          yield :requires, node.children[2].children[0].split("/"),
+        elsif node.children[0].nil? && node.children[1] == :require && node.children[2].type == :str
+          yield :requires, node.children[2].children[0].split('/'),
             :line_no => loc.line, :col => loc.column
         end
 
@@ -83,7 +83,7 @@ module Starscope::Lang
       when :sym
         # handle `:foo` vs `foo: 1`
         col = if loc.begin
-                loc.begin.column+1
+                loc.begin.column + 1
               else
                 loc.expression.column
               end

data/lib/starscope/output.rb

@@ -1,10 +1,9 @@
 require 'ruby-progressbar'
 
 class Starscope::Output
-
   PBAR_FORMAT = '%t: %c/%C %E ||%b>%i||'
 
-  def initialize(level, out=STDOUT)
+  def initialize(level, out = STDOUT)
     @out = out
     @level = level
     @pbar = nil
@@ -13,8 +12,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,
-                                :out => @out)
+                                 :format => PBAR_FORMAT, :length => 80,
+                                 :out => @out)
     end
   end
 
@@ -46,5 +45,4 @@ class Starscope::Output
       @out.puts msg
     end
   end
-
 end

data/lib/starscope/queryable.rb

@@ -1,10 +1,9 @@
 require 'starscope/matcher'
 
 module Starscope::Queryable
-
-  def query(tables, value, filters={})
+  def query(tables, value, filters = {})
     tables = [tables] if tables.is_a?(Symbol)
-    tables.each { |t| raise Starscope::DB::NoTableError, "Table '#{t}' not found" unless @tables[t] }
+    tables.each { |t| fail Starscope::DB::NoTableError, "Table '#{t}' not found" unless @tables[t] }
     input = Enumerator.new do |y|
       tables.each do |t|
         @tables[t].each do |elem|
@@ -20,9 +19,9 @@ module Starscope::Queryable
 
   def run_query(query, input, filters)
     query = Starscope::Matcher.new(query)
-    filters.each {|k,v| filters[k] = Starscope::Matcher.new(v)}
+    filters.each { |k, v| filters[k] = Starscope::Matcher.new(v) }
 
-    results = input.select {|x| filter(x, filters)}.group_by {|x| match(x, query)}
+    results = input.select { |x| filter(x, filters) }.group_by { |x| match(x, query) }
 
     Starscope::Matcher::MATCH_TYPES.each do |type|
       next if results[type].nil? || results[type].empty?
@@ -40,7 +39,7 @@ module Starscope::Queryable
   end
 
   def match(record, query)
-    name = record[:name].map {|x| x.to_s}.join('::')
+    name = record[:name].map(&:to_s).join('::')
 
     query.match(name)
   end

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
 module Starscope
-  VERSION = "1.3.3"
+  VERSION = '1.4.0'
 end

data/starscope.gemspec

@@ -3,20 +3,20 @@ require File.expand_path('../lib/starscope/version.rb', __FILE__)
 Gem::Specification.new do |gem|
   gem.name          = 'starscope'
   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"]
+  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']
   gem.homepage      = 'https://github.com/eapache/starscope'
   gem.email         = 'eapache@gmail.com'
   gem.license       = 'MIT'
   gem.files         = `git ls-files`.split("\n")
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   gem.test_files    = `git ls-files -- test/*`.split("\n")
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
   gem.required_ruby_version = '>= 1.8.7'
 
   gem.add_dependency 'oj', '~> 2.9'
-  gem.add_dependency 'parser', '~> 2.2.0.3'
+  gem.add_dependency 'parser', '~> 2.2.2'
   gem.add_dependency 'ruby-progressbar', '~> 1.5'
   gem.add_dependency 'backports', '~> 3.6'
   gem.add_development_dependency 'bundler', '~> 1.5'

data/test/fixtures/db_missing_language.json

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

data/test/fixtures/db_old_subextractor.json

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

data/test/fixtures/sample_erb.erb

@@ -0,0 +1,14 @@
+<% if foo %>
+  malsgkjalsgkjaslfk
+<% elsif bar %>
+  lkajlfaksjflaksjf
+<% end %>
+
+
+<%- case x
+when :bar -%> <%= magic %> <% when :baz
+when :foo %>
+ x and :bar
+<% end %>
+
+<%= foo %>, <%=== bar -%>, <%= baz %>

data/test/fixtures/sample_ruby.rb

@@ -7,7 +7,6 @@ LANGS = [
 ]
 
 class Starscope::DB
-
   PBAR_FORMAT = '%t: %c/%C %E ||%b>%i||'
 
   class NoTableError < StandardError; end
@@ -31,12 +30,12 @@ class Starscope::DB
         elsif format <= 2
           # Old format (pre-json), so read the directories segment then rebuild
           len = stream.gets.to_i
-          add_paths(Marshal::load(stream.read(len)))
+          add_paths(Marshal.load(stream.read(len)))
         elsif format < DB_FORMAT
           # Old format, so read the directories segment then rebuild
           add_paths(Oj.load(stream.gets))
         elsif format > DB_FORMAT
-          raise UnknownDBFormatError
+          fail UnknownDBFormatError
         end
       end
     end
@@ -57,10 +56,10 @@ class Starscope::DB
     paths -= @paths
     return if paths.empty?
     @paths += paths
-    files = paths.map {|p| self.class.files_from_path(p)}.flatten
+    files = paths.map { |p| self.class.files_from_path(p) }.flatten
     return if files.empty?
     if @progress
-      pbar = ProgressBar.create(:title => "Building", :total => files.length, :format => PBAR_FORMAT, :length => 80)
+      pbar = ProgressBar.create(:title => 'Building', :total => files.length, :format => PBAR_FORMAT, :length => 80)
     end
     files.each do |f|
       add_file(f)
@@ -69,9 +68,9 @@ class Starscope::DB
   end
 
   def update
-    new_files = (@paths.map {|p| self.class.files_from_path(p)}.flatten) - @files.keys
+    new_files = (@paths.map { |p| self.class.files_from_path(p) }.flatten) - @files.keys
     if @progress
-      pbar = ProgressBar.create(:title => "Updating", :total => new_files.length + @files.length, :format => PBAR_FORMAT, :length => 80)
+      pbar = ProgressBar.create(:title => 'Updating', :total => new_files.length + @files.length, :format => PBAR_FORMAT, :length => 80)
     end
     changed = @files.keys.map do |f|
       changed = update_file(f)
@@ -101,13 +100,13 @@ class Starscope::DB
     if File.file?(path)
       [path]
     elsif File.directory?(path)
-      Dir[File.join(path, "**", "*")].select {|p| File.file?(p)}
+      Dir[File.join(path, '**', '*')].select { |p| File.file?(p) }
     else
       []
     end
   end
 
-  def db_by_line()
+  def db_by_line
     tmpdb = {}
     @tables.each do |tbl, vals|
       vals.each do |key, val|
@@ -115,21 +114,21 @@ class Starscope::DB
           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}
+            tmpdb[entry[:file]][entry[:line_no]] << { :tbl => tbl, :key => key, :entry => entry }
           end
         end
       end
     end
-    return tmpdb
+    tmpdb
   end
 
   def add_file(file)
-    return if not File.file? file
+    return unless File.file? file
 
     @files[file] = File.mtime(file).to_s
 
     LANGS.each do |lang|
-      next if not lang.match_file file
+      next unless lang.match_file file
       lang.extract file do |tbl, key, args|
         key = key.to_sym
         @tables[tbl] ||= {}
@@ -143,13 +142,13 @@ class Starscope::DB
     @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
 
   def update_file(file)
-    if not File.exists?(file) or not File.file?(file)
+    if !File.exist?(file) || !File.file?(file)
       remove_file(file)
       true
     elsif DateTime.parse(@files[file]).to_time < File.mtime(file)
@@ -160,5 +159,4 @@ class Starscope::DB
       false
     end
   end
-
 end

data/test/functional/starscope_test.rb

@@ -1,38 +1,37 @@
 require File.expand_path('../../test_helper', __FILE__)
 
-describe "starscope executable script" do
-
-  BASE = "bundle exec bin/starscope --quiet"
+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
+  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
+  it 'must produce the right version' do
     `#{BASE} -v`.chomp.must_equal Starscope::VERSION
   end
 
-  it "must produce a valid database summary" do
+  it 'must produce a valid database summary' do
     lines = `#{EXTRACT} -s`.lines.to_a
     lines.length.must_equal 8
   end
 
-  it "must produce a valid database dump" do
+  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
+  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"]
+      line.split[0..2].must_equal %w(Starscope DB add_file)
     end
 
     `#{EXTRACT} -q lang:ruby,calls,add_file`.each_line do |line|
-      line.split[0..2].must_equal ["Starscope", "DB", "add_file"]
+      line.split[0..2].must_equal %w(Starscope DB add_file)
     end
 
     `#{EXTRACT} -q lang:go,calls,add_file`.each_line do |line|
@@ -40,10 +39,10 @@ describe "starscope executable script" do
     end
   end
 
-  it "must correctly export to cscope" do
+  it 'must correctly export to cscope' do
     file = Tempfile.new('starscope_test')
     begin
-      `#{EXTRACT} -e cscope,#{file.path()}`
+      `#{EXTRACT} -e cscope,#{file.path}`
       $?.exitstatus.must_equal 0
     ensure
       file.close
@@ -51,15 +50,14 @@ describe "starscope executable script" do
     end
   end
 
-  it "must correctly export to ctags" do
+  it 'must correctly export to ctags' do
     file = Tempfile.new('starscope_test')
     begin
-      `#{EXTRACT} -e ctags,#{file.path()}`
+      `#{EXTRACT} -e ctags,#{file.path}`
       $?.exitstatus.must_equal 0
     ensure
       file.close
       file.unlink
     end
   end
-
 end

data/test/test_helper.rb

@@ -3,8 +3,9 @@ require 'minitest/pride'
 require 'mocha/mini_test'
 require File.expand_path('../../lib/starscope.rb', __FILE__)
 
-FIXTURES="test/fixtures"
+FIXTURES = 'test/fixtures'
 
 GOLANG_SAMPLE = "#{FIXTURES}/sample_golang.go"
 RUBY_SAMPLE = "#{FIXTURES}/sample_ruby.rb"
+ERB_SAMPLE = "#{FIXTURES}/sample_erb.erb"
 EMPTY_FILE = "#{FIXTURES}/empty"

data/test/unit/db_test.rb

@@ -2,18 +2,15 @@ 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
+  it 'must raise on invalid tables' do
+    proc { @db.records(:foo) }.must_raise Starscope::DB::NoTableError
   end
 
-  it "must add paths" do
+  it 'must add paths' do
     paths = [GOLANG_SAMPLE, "#{FIXTURES}/**/*"]
     @db.add_paths(paths)
 
@@ -21,7 +18,7 @@ describe Starscope::DB do
     validate(@db)
   end
 
-  it "must add excludes" do
+  it 'must add excludes' do
     paths = [GOLANG_SAMPLE, "#{FIXTURES}/**/*"]
     @db.add_paths(paths)
     @db.add_excludes(["#{FIXTURES}/**"])
@@ -33,14 +30,14 @@ describe Starscope::DB do
     @db.records(:end).must_be_empty
   end
 
-  it "must pick up new files in old paths" do
+  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
+  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"
@@ -62,7 +59,7 @@ describe Starscope::DB do
     @db.records(:calls).wont_be_empty
   end
 
-  it "must update unchanged existing files with old extractor versions" do
+  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]
@@ -77,22 +74,53 @@ describe Starscope::DB do
     @db.records(:calls).wont_be_empty
   end
 
-  it "must not update file with up-to-date time and extractor" do
+  it 'must update unchanged existing files with old sublang extractor versions' do
+    @db.load("#{FIXTURES}/db_old_subextractor.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[:sublangs].must_be_empty
+    file[:lines].wont_be_empty
+    @db.records(:defs).wont_be_empty
+    @db.records(:calls).wont_be_empty
+  end
+
+  it 'must update unchanged existing files when the extractor has been removed' do
+    @db.load("#{FIXTURES}/db_missing_language.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
+    file[:last_updated].must_equal 10_000_000_000
     @db.tables.must_be_empty
   end
 
-  it "must load an old DB file" do
+  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
+  it 'must round-trip a database' do
     file = Tempfile.new('starscope_test')
     begin
       @db.add_paths([FIXTURES])
@@ -106,34 +134,34 @@ describe Starscope::DB do
     end
   end
 
-  it "must run queries" do
+  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
+    @db.query(:calls, 'abc').must_equal []
+    @db.query(:defs, 'xyz').must_equal []
+    @db.query(:calls, 'add_file').length.must_equal 3
   end
 
-  it "must run queries on multiple tables" do
+  it 'must run queries on multiple tables' do
     @db.add_paths([FIXTURES])
-    ret = @db.query([:calls, :defs], "foo")
-    ret.length.must_equal 1
+    ret = @db.query([:calls, :defs], 'foo')
+    ret.length.must_equal 3
     ret.first[:name].last.must_equal :foo
   end
 
-  it "must symbolize compound name" do
-    rec = Starscope::DB.normalize_record(:foo, ["a", :b], {})
+  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", {})
+  it 'must symbolize and array-wrap simple name' do
+    rec = Starscope::DB.normalize_record(:foo, 'a', {})
     rec[:name].must_equal [:a]
   end
 
-  it "must store extractor metadata returned from the `extract` call" do
+  it 'must store extractor metadata returned from the `extract` call' do
     extractor = mock('extractor')
     extractor.expects(:match_file).with(GOLANG_SAMPLE).returns(true)
-    extractor.expects(:extract).with(GOLANG_SAMPLE).returns({:a => 1})
+    extractor.expects(:extract).with(GOLANG_SAMPLE, File.read(GOLANG_SAMPLE)).returns(:a => 1)
     extractor.expects(:name).returns('Foo')
     EXTRACTORS.stubs(:each).yields(extractor)
 
@@ -156,5 +184,4 @@ describe Starscope::DB do
     db.records(:imports).wont_be_empty
     db.records(:requires).wont_be_empty
   end
-
 end