starscope 1.5.4 → 1.6.0

data/lib/starscope/exportable.rb

@@ -1,7 +1,10 @@
+require 'pathname'
+
 module Starscope
   module Exportable
     CTAGS_DEFAULT_PATH = 'tags'.freeze
     CSCOPE_DEFAULT_PATH = 'cscope.out'.freeze
+    ASCII = Encoding.find('ASCII')
 
     class UnknownExportFormatError < StandardError; end
 
@@ -17,7 +20,7 @@ module Starscope
 
       @output.normal("Exporting to '#{path}' in format '#{format}'...")
       path_prefix = Pathname.getwd.relative_path_from(Pathname.new(path).dirname.expand_path)
-      File.open(path, 'w') do |file|
+      File.open(path, 'wb') do |file|
         export_to(format, file, path_prefix)
       end
       @output.normal('Export complete.')
@@ -37,14 +40,14 @@ module Starscope
     private
 
     def export_ctags(file, path_prefix)
-      file.puts <<END
-!_TAG_FILE_FORMAT	2	/extended format/
-!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
-!_TAG_PROGRAM_AUTHOR	Evan Huus /eapache@gmail.com/
-!_TAG_PROGRAM_NAME	Starscope //
-!_TAG_PROGRAM_URL	https://github.com/eapache/starscope //
-!_TAG_PROGRAM_VERSION	#{Starscope::VERSION}	//
-END
+      file.puts <<~HEADER
+        !_TAG_FILE_FORMAT	2	/extended format/
+        !_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+        !_TAG_PROGRAM_AUTHOR	Evan Huus /eapache@gmail.com/
+        !_TAG_PROGRAM_NAME	Starscope //
+        !_TAG_PROGRAM_URL	https://github.com/eapache/starscope //
+        !_TAG_PROGRAM_VERSION	#{Starscope::VERSION}	//
+      HEADER
       defs = (@tables[:defs] || {}).sort_by { |x| x[:name][-1].to_s }
       defs.each do |record|
         file.puts ctag_line(record, @meta[:files][record[:file]], path_prefix)
@@ -148,7 +151,7 @@ END
       file.print("0\n")
       file.print("#{files.length}\n")
       buf = ''
-      files.each { |f| buf << f + "\n" }
+      files.each { |f| buf << "#{f}\n" }
       file.print("#{buf.length}\n#{buf}")
     end
 
@@ -157,6 +160,7 @@ END
       @tables.each do |tbl, records|
         records.each do |record|
           next unless record[:line_no]
+
           record[:tbl] = tbl
           db[record[:file]] ||= {}
           db[record[:file]][record[:line_no]] ||= []
@@ -175,16 +179,14 @@ END
         # use the column if we have it, otherwise fall back to scanning
         index = record[:col] || line.index(key)
 
-        while index && !valid_index?(line, index, key)
-          index = line.index(key, index + 1)
-        end
+        index = line.index(key, index + 1) while index && !valid_index?(line, index, key)
 
         next if index.nil?
 
         # Strip trailing non-word characters, otherwise cscope barfs on
         # function names like `include?`
         if key =~ /^\W*$/
-          next unless [:defs, :end].include?(record[:tbl])
+          next unless %i[defs end].include?(record[:tbl])
         else
           key.sub!(/\W+$/, '')
         end
@@ -207,25 +209,23 @@ END
 
         index = line.index(key, prev)
 
-        while index && index + key.length < offset && !valid_index?(line, index, key)
-          index = line.index(key, index + 1)
-        end
+        index = line.index(key, index + 1) while index && index + key.length < offset && !valid_index?(line, index, key)
 
         next unless index && index + key.length < offset
 
         buf << cscope_plaintext(line, prev, index) << "\n"
-        buf << "#{key}\n"
+        buf << "#{strip_unicode(key)}\n"
         prev = index + key.length
       end
 
       buf << cscope_plaintext(line, prev, offset) << "\n"
-      buf << cscope_mark(record) << record[:key] << "\n"
+      buf << cscope_mark(record) << strip_unicode(record[:key]) << "\n"
 
       buf << CSCOPE_GLOBAL_HACK_START if record[:type] == :func && record[:tbl] == :end
       buf
     rescue ArgumentError
       # invalid utf-8 byte sequence in the line, oh well
-      line
+      strip_unicode(line)
     end
 
     def valid_index?(line, index, key)
@@ -240,10 +240,10 @@ END
       ret.lstrip! if start == 0
       ret.rstrip! if stop == line.length
       ret.gsub!(/\s+/, ' ')
-      ret.empty? ? ' ' : ret
+      ret.empty? ? ' ' : strip_unicode(ret)
     rescue ArgumentError
       # invalid utf-8 byte sequence in the line, oh well
-      line
+      strip_unicode(line)
     end
 
     def cscope_mark(rec)
@@ -258,16 +258,16 @@ 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
+        ret = case rec[:type]
+              when :func
+                '$'
+              when :class, :module
+                'c'
+              when :type
+                't'
+              else
+                'g'
+              end
       when :calls
         ret = '`'
       when :requires
@@ -280,7 +280,11 @@ END
         return ''
       end
 
-      "\t" + ret
+      "\t#{ret}"
+    end
+
+    def strip_unicode(str)
+      str.encode(ASCII, invalid: :replace, undef: :replace, replace: '')
     end
   end
 end

data/lib/starscope/fragment_extractor.rb

@@ -5,16 +5,15 @@ module Starscope
       @frags = frags
     end
 
-    def extract(path, text)
-      text = @frags.map { |f| f.delete(:frag).strip }.join("\n")
+    def extract(path, _text)
+      compiled_text = @frags.map { |f| f.delete(:frag).strip }.join("\n")
 
-      extractor_metadata = @child.extract(path, text) do |tbl, name, args|
+      @child.extract(path, compiled_text) do |tbl, name, args|
         args.merge!(@frags[args[:line_no] - 1]) if args[:line_no]
         yield tbl, name, args
       end
 
       # TODO: translate metadata?
-      extractor_metadata
     end
 
     def name

data/lib/starscope/langs/erb.rb

@@ -3,8 +3,8 @@ module Starscope
     module ERB
       VERSION = 1
 
-      ERB_START = /<%(?:-|={1,4})?/
-      ERB_END = /-?%>/
+      ERB_START = /<%(?:-|={1,4})?/.freeze
+      ERB_END = /[-=]?%>/.freeze
 
       def self.match_file(name)
         name.end_with?('.erb')
@@ -20,7 +20,7 @@ module Starscope
             term = line.index(ERB_END)
             if term
               yield Starscope::DB::FRAGMENT, :Ruby, frag: line[0...term], line_no: line_no
-              line = line[term + 1..-1]
+              line = line[term + 1..]
               multiline = false
             else
               yield Starscope::DB::FRAGMENT, :Ruby, frag: line, line_no: line_no

data/lib/starscope/langs/golang.rb

@@ -3,13 +3,13 @@ module Starscope
     module Golang
       VERSION = 1
 
-      FUNC_CALL = /([\w\.]*?\w)\(/
-      END_OF_BLOCK = /^\s*\}\s*$/
-      END_OF_GROUP = /^\s*\)\s*$/
-      STRING_LITERAL = /".+?"/
-      BUILTIN_FUNCS = %w(new make len close copy delete int int8 int16 int32 int64
-                         uint uint8 uint16 uint32 uint64 string byte).freeze
-      CONTROL_KEYS = %w(if for switch case).freeze
+      FUNC_CALL = /([[[:word:]].]*?[[:word:]])\(/.freeze
+      END_OF_BLOCK = /^\s*\}\s*$/.freeze
+      END_OF_GROUP = /^\s*\)\s*$/.freeze
+      STRING_LITERAL = /".+?"/.freeze
+      BUILTIN_FUNCS = %w[new make len close copy delete int int8 int16 int32 int64
+                         uint uint8 uint16 uint32 uint64 string byte].freeze
+      CONTROL_KEYS = %w[if for switch case].freeze
 
       def self.match_file(name)
         name.end_with?('.go')
@@ -36,6 +36,7 @@ module Starscope
           if stack[-1] == :comment
             match = %r{\*/(.*)}.match(line)
             next unless match
+
             line = match[1]
             stack.pop
           end
@@ -45,7 +46,7 @@ module Starscope
             pos = 0
             while (match = STRING_LITERAL.match(line, pos))
               eos = find_end_of_string(line, match.begin(0))
-              line = line[0..match.begin(0)] + line[eos..-1]
+              line = line[0..match.begin(0)] + line[eos..]
               pos = match.begin(0) + 2
             end
           end
@@ -56,14 +57,14 @@ module Starscope
             case line
             when END_OF_BLOCK
               end_block(line_no, scope, stack, &block)
-            when /(.+)\s+\w+/
+            when /(.+)\s+[[:word:]]+/
               parse_def(Regexp.last_match(1), line_no, scope, &block)
             end
           when :interface
             case line
             when END_OF_BLOCK
               end_block(line_no, scope, stack, &block)
-            when /(\w+)\(.*\)\s+/
+            when /([[:word:]]+)\(.*\)\s+/
               yield :defs, scope + [Regexp.last_match(1)], line_no: line_no
             end
           when :def
@@ -105,45 +106,42 @@ module Starscope
       # handles new lines (when not in the middle of an existing definition)
       def self.parse_new_line(line, line_no, scope, stack, &block)
         case line
-        when /^func\s+(\w+)\(/
+        when /^func\s+([[:word:]]+)\(/
           yield :defs, scope + [Regexp.last_match(1)], line_no: line_no, type: :func
           stack.push(:func)
-        when /^func\s+\(\w+\s+\*?(\w+)\)\s*(\w+)\(/
+        when /^func\s+\([[:word:]]+\s+\*?([[:word:]]+)\)\s*([[:word:]]+)\(/
           yield :defs, scope + [Regexp.last_match(1), Regexp.last_match(2)], line_no: line_no, type: :func
           stack.push(:func)
-        when /^package\s+(\w+)/
+        when /^package\s+([[:word:]]+)/
           scope.push(Regexp.last_match(1))
           yield :defs, scope, line_no: line_no, type: :package
-        when /^type\s+(\w+)\s+struct\s*\{/
+        when /^type\s+([[:word:]]+)\s+struct\s*\{/
           scope.push(Regexp.last_match(1))
           stack.push(:struct)
           yield :defs, scope, line_no: line_no, type: :class
-        when /^type\s+(\w+)\s+interface\s*\{/
+        when /^type\s+([[:word:]]+)\s+interface\s*\{/
           scope.push(Regexp.last_match(1))
           stack.push(:interface)
           yield :defs, scope, line_no: line_no, type: :class
-        when /^type\s+(\w+)/
+        when /^type\s+([[:word:]]+)/
           yield :defs, scope + [Regexp.last_match(1)], line_no: line_no, type: :type
         when /^import\s+"(.+)"/
           name = Regexp.last_match(1).split('/')
           yield :imports, name, line_no: line_no
         when /^import\s+\(/
           stack.push(:import)
-        when /^var\s+\(/
-          stack.push(:def)
-        when /^var\s+(\w+)\s/
-          yield :defs, scope + [Regexp.last_match(1)], line_no: line_no
-          parse_call(line, line_no, scope, &block)
-        when /^const\s+\(/
+        when /^var\s+\(/, /^const\s+\(/
           stack.push(:def)
-        when /^const\s+(\w+)\s/
+        when /^var\s+([[:word:]]+)\s/, /^const\s+([[:word:]]+)\s/
           yield :defs, scope + [Regexp.last_match(1)], line_no: line_no
           parse_call(line, line_no, scope, &block)
         when /^\s+(.*?) :?=[^=]/
-          Regexp.last_match(1).split(' ').each do |var|
+          Regexp.last_match(1).split.each do |var|
             next if CONTROL_KEYS.include?(var)
+
             name = var.delete(',').split('.')
             next if name[0] == '_' # assigning to _ is a discard in golang
+
             if name.length == 1
               yield :assigns, scope + [name[0]], line_no: line_no
             else
@@ -158,9 +156,10 @@ module Starscope
 
       def self.parse_call(line, line_no, scope)
         line.scan(FUNC_CALL) do |match|
-          name = match[0].split('.').select { |chunk| !chunk.empty? }
+          name = match[0].split('.').reject(&:empty?)
           if name.length == 1
             next if name[0] == 'func'
+
             if BUILTIN_FUNCS.include?(name[0])
               yield :calls, name[0], line_no: line_no
             else

data/lib/starscope/langs/javascript.rb

@@ -96,7 +96,8 @@ module Starscope
             next
           end
 
-          next if found[node.name] && found[node.name].include?(line)
+          next if found[node.name]&.include?(line)
+
           yield :defs, node.name, line_no: line
           found[node.name] ||= Set.new
           found[node.name].add(line)
@@ -113,7 +114,8 @@ module Starscope
           line = find_line(node.range.from, map, lines, name)
           next unless line
 
-          next if found[name] && found[name].include?(line)
+          next if found[name]&.include?(line)
+
           yield :reads, name, line_no: line
         end
       end

data/lib/starscope/langs/ruby.rb

@@ -16,9 +16,11 @@ module Starscope
 
       def self.match_file(name)
         return true if name.end_with?('.rb', '.rake')
+
         File.open(name) do |f|
           head = f.read(2)
           return false if head.nil? || !head.start_with?('#!')
+
           return f.readline.include?('ruby')
         end
       end
@@ -39,7 +41,7 @@ module Starscope
         extract_node(tree, scope, &block)
 
         new_scope = []
-        if [:class, :module].include? tree.type
+        if %i[class module].include? tree.type
           new_scope = scoped_name(tree.children[0], scope)
           scope += new_scope
         end
@@ -90,7 +92,16 @@ module Starscope
 
         when :const
           name = scoped_name(node, scope)
-          yield :reads, name, line_no: loc.line, col: loc.name.column
+          # handle `__ENCODING__` and other weird quasi-constants
+          column = case loc
+                   when Parser::Source::Map::Constant
+                     loc.name.column
+                   when Parser::Source::Map
+                     loc.column
+                   when nil
+                     return
+                   end
+          yield :reads, name, line_no: loc.line, col: column
 
         when :lvar, :ivar, :cvar, :gvar
           yield :reads, scope + [node.children[0]], line_no: loc.line, col: loc.name.column
@@ -109,7 +120,7 @@ module Starscope
       def self.scoped_name(node, scope)
         if node.type == :block
           scoped_name(node.children[0], scope)
-        elsif [:lvar, :ivar, :cvar, :gvar, :const, :send, :casgn].include? node.type
+        elsif %i[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/matcher.rb

@@ -1,6 +1,6 @@
 module Starscope
   class Matcher
-    MATCH_TYPES = [:literal_match, :regexp_match].freeze
+    MATCH_TYPES = %i[literal_match regexp_match].freeze
 
     def initialize(query)
       @query = query
@@ -13,10 +13,9 @@ module Starscope
     end
 
     def match(input)
-      case
-      when input.end_with?(@query)
+      if input.end_with?(@query)
         :literal_match
-      when @regexp && @regexp.match(input)
+      elsif @regexp&.match(input)
         :regexp_match
       end
     end

data/lib/starscope/output.rb

@@ -4,7 +4,7 @@ module Starscope
   class Output
     PBAR_FORMAT = '%t: %c/%C %E ||%b>%i||'.freeze
 
-    def initialize(level, out = STDOUT)
+    def initialize(level, out = $stdout)
       @out = out
       @level = level
       @pbar = nil
@@ -12,27 +12,30 @@ module Starscope
 
     def new_pbar(title, num_items)
       return if @level == :quiet
+
       @pbar = ProgressBar.create(title: title, total: num_items,
                                  format: PBAR_FORMAT, length: 80,
                                  out: @out)
     end
 
     def inc_pbar
-      @pbar.increment if @pbar
+      @pbar&.increment
     end
 
     def finish_pbar
-      @pbar.finish if @pbar
+      @pbar&.finish
       @pbar = nil
     end
 
     def extra(msg)
       return unless @level == :verbose
+
       output(msg)
     end
 
     def normal(msg)
       return if @level == :quiet
+
       output(msg)
     end
 

data/lib/starscope/queryable.rb

@@ -26,6 +26,7 @@ module Starscope
 
       Starscope::Matcher::MATCH_TYPES.each do |type|
         next if results[type].nil? || results[type].empty?
+
         return results[type]
       end
 

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
 module Starscope
-  VERSION = '1.5.4'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/starscope.gemspec

@@ -1,14 +1,14 @@
-require File.expand_path('../lib/starscope/version.rb', __FILE__)
+require File.expand_path('lib/starscope/version.rb', __dir__)
 
 Gem::Specification.new do |gem|
   gem.name          = 'starscope'
   gem.version       = Starscope::VERSION
   gem.summary       = 'Smart code search and indexing'
-  gem.description   = <<-EOF
+  gem.description   = <<-DESC
   Starscope is a code indexer, search and navigation tool for Ruby, Golang, and JavaScript.
   Inspired by the extremely popular Ctags and Cscope utilities, Starscope can
   answer a lot of questions about a lot of code.
-  EOF
+  DESC
   gem.authors       = ['Evan Huus']
   gem.homepage      = 'https://github.com/eapache/starscope'
   gem.email         = 'eapache@gmail.com'
@@ -17,19 +17,22 @@ Gem::Specification.new do |gem|
   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.required_ruby_version = '>= 1.9.3'
+  gem.required_ruby_version = '>= 2.6'
 
-  gem.add_dependency 'oj', '~> 2.9'
-  gem.add_dependency 'parser', '~> 2.3'
-  gem.add_dependency 'ruby-progressbar', '~> 1.8'
-  gem.add_dependency 'rkelly-remix', '~> 0.0.7'
   gem.add_dependency 'babel-transpiler', '~> 0.7'
+  gem.add_dependency 'oj', '~> 3.7'
+  gem.add_dependency 'parser', '~> 3.1'
+  gem.add_dependency 'rkelly-remix', '~> 0.0.7'
+  gem.add_dependency 'ruby-progressbar', '~> 1.9'
   gem.add_dependency 'sourcemap', '~> 0.1'
 
-  gem.add_development_dependency 'bundler', '~> 1.7'
-  gem.add_development_dependency 'rake', '~> 11.2'
-  gem.add_development_dependency 'pry', '~> 0.10.1'
-  gem.add_development_dependency 'minitest', '~> 5.8'
-  gem.add_development_dependency 'mocha', '~> 1.1'
-  gem.add_development_dependency 'rubocop', '~> 0.39.0'
+  gem.add_development_dependency 'bundler', '>= 1.7'
+  gem.add_development_dependency 'minitest', '~> 5.12'
+  gem.add_development_dependency 'mocha', '~> 1.3'
+  gem.add_development_dependency 'pry', '~> 0.11'
+  gem.add_development_dependency 'rake', '~> 13.0'
+  gem.add_development_dependency 'rubocop', '~> 1.25.0'
+  gem.add_development_dependency 'rubocop-minitest', '~> 0.17.1'
+  gem.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end

data/test/fixtures/sample_golang.go

@@ -10,7 +10,7 @@ var (
 	}
 )
 
-var single_var = 3
+var single_var_Äunicode = 3
 
 const single_const = 4
 

data/test/fixtures/sample_ruby.rb

@@ -162,3 +162,5 @@ class Starscope::DB
     end
   end
 end
+
+puts __ENCODING__

data/test/functional/starscope_test.rb

@@ -1,43 +1,43 @@
 require_relative '../test_helper'
 
-describe 'starscope executable script' do
-  BASE = 'bundle exec bin/starscope --quiet'.freeze
-  EXTRACT = "#{BASE} --no-read --no-write #{FIXTURES}".freeze
+BASE = 'bundle exec bin/starscope --quiet'.freeze
+EXTRACT = "#{BASE} --no-read --no-write #{FIXTURES}".freeze
 
+describe 'starscope executable script' do
   it 'must not produce help wider than 80 characters' do
     `#{BASE} -h`.each_line do |line|
-      line.length.must_be :<=, 80
+      _(line.length).must_be :<=, 80
     end
   end
 
   it 'must produce the right version' do
-    `#{BASE} -v`.chomp.must_equal Starscope::VERSION
+    _(`#{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 8
+    _(lines.length).must_equal 8
   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 'foo-bar'
-    lines[3].split.first.must_equal 'react-native'
-    lines[4].split.first.must_equal 'zlib'
+    _(lines[1].split.first).must_equal 'date'
+    _(lines[2].split.first).must_equal 'foo-bar'
+    _(lines[3].split.first).must_equal 'react-native'
+    _(lines[4].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 %w(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 %w(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|
-      line.must_equal "No results found.\n"
+      _(line).must_equal "No results found.\n"
     end
   end
 
@@ -45,7 +45,7 @@ describe 'starscope executable script' do
     file = Tempfile.new('starscope_test')
     begin
       `#{EXTRACT} -e cscope,#{file.path}`
-      $?.exitstatus.must_equal 0
+      _($?.exitstatus).must_equal 0
     ensure
       file.close
       file.unlink
@@ -56,7 +56,7 @@ describe 'starscope executable script' do
     file = Tempfile.new('starscope_test')
     begin
       `#{EXTRACT} -e ctags,#{file.path}`
-      $?.exitstatus.must_equal 0
+      _($?.exitstatus).must_equal 0
     ensure
       file.close
       file.unlink

data/test/test_helper.rb

@@ -1,6 +1,6 @@
 require 'minitest/autorun'
 require 'minitest/pride'
-require 'mocha/mini_test'
+require 'mocha/minitest'
 require_relative '../lib/starscope'
 
 FIXTURES = 'test/fixtures'.freeze