starscope 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf0545d7e2a35d02175c24c5ad16941d6fa61237
-  data.tar.gz: ff40e8a9c02faa7fc77d48c83b99b2fbc3e1ec2c
+  metadata.gz: da191b58f08b524eb31cda50bf5194e3b691e4e4
+  data.tar.gz: eaa0415c40b4428a741d162b6ce632b8a985a07d
 SHA512:
-  metadata.gz: e77b085891ca912792487ef07a6aeaaabc7ec5a94193879b62877f1729c2f205265d30c2eee3f12ba2272b69181f68025e55ed84767b12b506fc448aea83c9c8
-  data.tar.gz: bf3c86d110ec7c87e2d0393b3e06f8e87b4bf62ba860a4183c857d8ad082a3a047acccdf5d9453000a8762f7b404d59cbdbe766837c66ab5e41c527827396142
+  metadata.gz: ee659c9708a121d3c26dfc5a733fa90960bc71c6bbd5e19e47cc14278e45dbab63e7cc35a4b827b12db78b83be0f0951fef6015d5983dfa58ba450d29f4a5cc4
+  data.tar.gz: 73a5d16b4a4a21d8b4d4e2dc1eff507fb439445294868d809f76963e7264575c0a9a94b67a15ad9fb181ce63d590b7f86c5cf5b69583e21b698765945fcac2fb

data/.gitignore

@@ -3,6 +3,7 @@
 .starscope.db
 .bundle
 .config
+Gemfile.lock
 coverage
 InstalledFiles
 lib/bundler/man

data/.rubocop.yml

@@ -34,9 +34,6 @@ Style/ClassAndModuleChildren:
 Style/Documentation:
   Enabled: false
 
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
 Style/Next:
   Exclude:
     - 'test/fixtures/sample_ruby.rb'

data/.travis.yml

@@ -2,7 +2,6 @@ language: ruby
 sudo: false
 
 rvm:
-    - 1.8.7
     - 1.9.3
     - 2.0
     - 2.1

data/CHANGELOG.md

@@ -1,7 +1,23 @@
 Changelog
 =========
 
-v1.4.1 (trunk)
+v1.5.0 (trunk)
+--------------------
+
+New Features:
+ * Javascript support, including basic ES6/ES7 and JSX (via Babel).
+ * Implemented `--force-update` flag to rescan all files even if they apparently
+   haven't changed (#139).
+ * Added support for a shared configuration file in `~/starscope.json` (#140).
+   This is primarily useful for commonly excluded files (e.g. `cscope.out`).
+
+Bug Fixes:
+ * Fixed a really weird corruption in certain rare cscope export cases (#129).
+
+Misc:
+ * Drop support for ruby 1.8.7, it was getting annoying and is long unsupported.
+
+v1.4.1 (2015-09-12)
 --------------------
 
 Misc:

data/README.md

@@ -6,9 +6,9 @@ Starscope
 [![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-active-blue.svg)](https://eapache.github.io/conduct.html)
 
 Starscope is a code indexer, search and navigation tool for
-[Ruby](https://www.ruby-lang.org/) and [Golang](https://golang.org/), with a
-design intended to make it easy to add
-[support for other languages](doc/LANGUAGE_SUPPORT.md).
+[Ruby](https://www.ruby-lang.org/), [Golang](https://golang.org/), and
+[JavaScript](https://en.wikipedia.org/wiki/JavaScript) with a design intended
+to make it easy to add [support for other languages](doc/LANGUAGE_SUPPORT.md).
 
 Inspired by the extremely popular [Ctags](https://en.wikipedia.org/wiki/Ctags)
 and [Cscope](http://cscope.sourceforge.net/) utilities, Starscope can answer a
@@ -19,9 +19,9 @@ lot of questions about your code. It can tell you:
  - where symbols are used
  - where files and libraries are imported or required
 
-While Ctags already supports Ruby and Go, it can only tell you where things are
-defined. Cscope can answer a lot more of your questions, but it is limited to
-just the C language family. Starscope was written to combine the power of
+While Ctags already supports many languages, it can only tell you where things
+are defined. Cscope can answer a lot more of your questions, but it is limited
+to just the C language family. Starscope was written to combine the power of
 Cscope with the flexibility of Ctags, bringing full code indexing to as many
 developers as possible.
 

data/Rakefile

@@ -6,4 +6,4 @@ Rake::TestTask.new do |t|
 end
 
 desc 'Run tests'
-task :default => :test
+task default: :test

data/bin/starscope

@@ -3,18 +3,21 @@
 lib = File.expand_path('../../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
+require 'oj'
 require 'optparse'
 require 'readline'
 require 'starscope'
 
 DEFAULT_DB = '.starscope.db'
-
-options = { :read => true,
-            :write => true,
-            :update => true,
-            :output => :normal,
-            :export => [],
-            :db => DEFAULT_DB
+CONFIG_FILE = File.join(Dir.home, '.starscope.json')
+GLOBAL_CONFIG = File.exist?(CONFIG_FILE) ? Oj.load_file(CONFIG_FILE, symbol_keys: true) : {}
+
+options = { read: true,
+            write: true,
+            update: true,
+            output: :normal,
+            export: [],
+            db: DEFAULT_DB
 }
 
 # Options Parsing
@@ -68,6 +71,9 @@ END
   opts.on('--no-update', "Don't update the DB") do
     options[:update] = false
   end
+  opts.on('--force-update', 'Rebuild the DB by rescanning all files') do
+    options[:forceUpdate] = true
+  end
 
   opts.separator "\nMisc"
   opts.on('-v', '--version', 'Print the version number') do
@@ -100,7 +106,7 @@ end.parse!
 def print_summary(db)
   tables = db.tables
   puts 'No tables' if tables.empty?
-  tables.sort { |a, b| a.to_s <=> b.to_s }.each do |table|
+  tables.sort.each do |table|
     printf("%-9s %6d records\n", table, db.records(table).length)
   end
 end
@@ -186,7 +192,7 @@ rescue Starscope::Exportable::UnknownExportFormatError
 end
 
 output = Starscope::Output.new(options[:output])
-db = Starscope::DB.new(output)
+db = Starscope::DB.new(output, GLOBAL_CONFIG)
 
 db_exists = File.exist?(options[:db])
 
@@ -203,6 +209,11 @@ if options[:exclude]
   new_data = true
 end
 
+if options[:forceUpdate]
+  db.drop_all
+  options[:update] = true
+end
+
 if !ARGV.empty?
   # paths specified, add them
   db.add_paths(ARGV)

data/doc/LANGUAGE_SUPPORT.md

@@ -6,6 +6,8 @@ Already Supported
 
  * [Ruby](https://www.ruby-lang.org/)
  * [Golang](https://golang.org/)
+ * [JavaScript](https://en.wikipedia.org/wiki/JavaScript)
+   (including ES6/ES7 and JSX via [Babel](https://babeljs.io/))
 
 How to Add Another Language
 ---------------------------

data/doc/USER_GUIDE.md

@@ -19,10 +19,11 @@ Anyone who has done much programming in C (or C++) on a Unix-based OS has come
 across the fantastic [Cscope](http://cscope.sourceforge.net/) tool. Sadly, it
 only works for C (and sort of works for C++).
 
-Starscope is a similar tool for [Ruby](https://www.ruby-lang.org/) and
-[Golang](https://golang.org/), with a design intended to make it easy to add
-[support for other languages](LANGUAGE_SUPPORT.md) within the same framework
-(thus the name Starscope, i.e. \*scope).
+Starscope is a similar tool for [Ruby](https://www.ruby-lang.org/),
+[Golang](https://golang.org/), and
+[JavaScript](https://en.wikipedia.org/wiki/JavaScript), with a design intended
+to make it easy to add [support for other languages](LANGUAGE_SUPPORT.md)
+within the same framework (thus the name Starscope, i.e. \*scope).
 
 Installation
 ------------
@@ -79,7 +80,9 @@ to use another file, specify one with `-f` or `--file`.
 
 The default behaviour is always to read the database (if it exists), update it,
 and write out the updated version. You can control this behaviour by passing any
-of the `--no-read`, `--no-write` and `--no-update` flags.
+of the `--no-read`, `--no-write` and `--no-update` flags. If you pass the
+`--force-update` flag then all files and directories will be re-scanned, not
+just the ones that have changed.
 
 To get a summary of the current database contents, pass the `-s` or `--summary`
 flag.
@@ -106,6 +109,15 @@ Excluded patterns are also remembered, and can be added at any time. If an
 existing file in the database matches a newly added exclusion rule, it will be
 removed.
 
+For commonly excluded files you can create a `~/.starscope.json` file with
+contents like:
+```json
+{
+  "excludes": ["foo", "bar"]
+}
+```
+Patterns listed there will be excluded from all starscope databases by default.
+
 Queries
 -------
 

data/lib/starscope/db.rb

@@ -1,4 +1,3 @@
-require 'backports'
 require 'date'
 require 'oj'
 require 'set'
@@ -31,11 +30,12 @@ class Starscope::DB
   class NoTableError < StandardError; end
   class UnknownDBFormatError < StandardError; end
 
-  def initialize(output)
+  def initialize(output, config = {})
     @output = output
-    @meta = { :paths => [], :files => {}, :excludes => [],
-              :langs => LANGS, :version => Starscope::VERSION }
+    @meta = { paths: [], files: {}, excludes: [],
+              langs: LANGS, version: Starscope::VERSION }
     @tables = {}
+    @config = config
   end
 
   # returns true iff the database was already in the most recent format
@@ -69,6 +69,7 @@ class Starscope::DB
     paths = paths.map { |p| self.class.normalize_fnmatch(p) }
     @meta[:excludes] += paths
     @meta[:excludes].uniq!
+    @all_excludes = nil # clear cache
 
     excluded = @meta[:files].keys.select { |name| matches_exclude?(name, paths) }
     remove_files(excluded)
@@ -77,6 +78,7 @@ class Starscope::DB
   def add_paths(paths)
     @output.extra("Adding files in paths #{paths}...")
     @meta[:excludes] -= paths.map { |p| self.class.normalize_fnmatch(p) }
+    @all_excludes = nil # clear cache
     paths = paths.map { |p| self.class.normalize_glob(p) }
     @meta[:paths] += paths
     @meta[:paths].uniq!
@@ -136,6 +138,11 @@ class Starscope::DB
     @meta[key]
   end
 
+  def drop_all
+    @meta[:files] = {}
+    @tables = {}
+  end
+
   private
 
   def open_db(filename)
@@ -209,7 +216,11 @@ class Starscope::DB
     end
   end
 
-  def matches_exclude?(file, patterns = @meta[:excludes])
+  def all_excludes
+    @all_excludes ||= @meta[:excludes] + (@config[:excludes] || []).map { |x| self.class.normalize_fnmatch(x) }
+  end
+
+  def matches_exclude?(file, patterns = all_excludes)
     patterns.map { |p| File.fnmatch(p, file) }.any?
   end
 
@@ -238,7 +249,7 @@ class Starscope::DB
   end
 
   def parse_file(file)
-    @meta[:files][file] = { :last_updated => File.mtime(file).to_i }
+    @meta[:files][file] = { last_updated: File.mtime(file).to_i }
 
     EXTRACTORS.each do |extractor|
       begin
@@ -295,7 +306,7 @@ class Starscope::DB
 
   def file_changed(name)
     file_meta = @meta[:files][name]
-    if !File.exist?(name) || !File.file?(name)
+    if matches_exclude?(name) || !File.exist?(name) || !File.file?(name)
       :deleted
     elsif (file_meta[:last_updated] < File.mtime(name).to_i) ||
           language_out_of_date(file_meta[:lang]) ||

data/lib/starscope/exportable.rb

@@ -228,15 +228,16 @@ END
   def valid_index?(line, index, key)
     # index is valid if the key exists at it, and the prev/next chars are not word characters
     ((line[index, key.length] == key) &&
-     (index == 0 || line[index - 1] !~ /\w/) &&
-     (index + key.length == line.length || line[index + key.length] !~ /\w/))
+     (index == 0 || line[index - 1] !~ /[[:word:]]/) &&
+     (index + key.length == line.length || line[index + key.length] !~ /[[:word:]]/))
   end
 
   def cscope_plaintext(line, start, stop)
     ret = line.slice(start, stop - start)
     ret.lstrip! if start == 0
     ret.rstrip! if stop == line.length
-    ret.gsub(/\s+/, ' ')
+    ret.gsub!(/\s+/, ' ')
+    ret.empty? ? ' ' : ret
   rescue ArgumentError
     # invalid utf-8 byte sequence in the line, oh well
     line

data/lib/starscope/langs/erb.rb

@@ -18,18 +18,18 @@ module Starscope::Lang
         if multiline
           term = line.index(ERB_END)
           if term
-            yield FRAGMENT, :Ruby, :frag => line[0...term], :line_no => line_no
+            yield FRAGMENT, :Ruby, frag: line[0...term], line_no: line_no
             line = line[term + 1..-1]
             multiline = false
           else
-            yield FRAGMENT, :Ruby, :frag => line, :line_no => line_no
+            yield FRAGMENT, :Ruby, frag: line, line_no: line_no
           end
         end
 
         next if multiline
 
         line.scan(/#{ERB_START}(.*?)#{ERB_END}/) do |match|
-          yield FRAGMENT, :Ruby, :frag => match[0], :line_no => line_no
+          yield FRAGMENT, :Ruby, frag: match[0], line_no: line_no
         end
 
         line.gsub!(/<%.*?%>/, '')
@@ -37,7 +37,7 @@ module Starscope::Lang
         match = /#{ERB_START}(.*)$/.match(line)
         next unless match
 
-        yield FRAGMENT, :Ruby, :frag => match[1], :line_no => line_no
+        yield FRAGMENT, :Ruby, frag: match[1], line_no: line_no
         multiline = true
       end
     end

data/lib/starscope/langs/go.rb

@@ -41,10 +41,10 @@ module Starscope::Lang
         if stack[-1] != :import && !line.start_with?('import')
           # strip string literals like "foo" unless they're part of an import
           pos = 0
-          while (match = STRING_LITERAL.match(line[pos..-1]))
+          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]
-            pos += match.begin(0) + 2
+            pos = match.begin(0) + 2
           end
         end
 
@@ -62,7 +62,7 @@ module Starscope::Lang
           when END_OF_BLOCK
             end_block(line_no, scope, stack, &block)
           when /(\w+)\(.*\)\s+/
-            yield :defs, scope + [Regexp.last_match(1)], :line_no => line_no
+            yield :defs, scope + [Regexp.last_match(1)], line_no: line_no
           end
         when :def
           case line
@@ -80,12 +80,12 @@ module Starscope::Lang
             stack.pop
           when /"(.+)"/
             name = Regexp.last_match(1).split('/')
-            yield :imports, name, :line_no => line_no
+            yield :imports, name, line_no: line_no
           end
         when :func
           case line
           when /^\}/
-            yield :end, '}', :line_no => line_no, :type => :func
+            yield :end, '}', line_no: line_no, type: :func
             stack.pop
           else
             parse_new_line(line, line_no, scope, stack, &block)
@@ -104,38 +104,38 @@ module Starscope::Lang
     def self.parse_new_line(line, line_no, scope, stack, &block)
       case line
       when /^func\s+(\w+)\(/
-        yield :defs, scope + [Regexp.last_match(1)], :line_no => line_no, :type => :func
+        yield :defs, scope + [Regexp.last_match(1)], line_no: line_no, type: :func
         stack.push(:func)
       when /^func\s+\(\w+\s+\*?(\w+)\)\s*(\w+)\(/
-        yield :defs, scope + [Regexp.last_match(1), Regexp.last_match(2)], :line_no => line_no, :type => :func
+        yield :defs, scope + [Regexp.last_match(1), Regexp.last_match(2)], line_no: line_no, type: :func
         stack.push(:func)
       when /^package\s+(\w+)/
         scope.push(Regexp.last_match(1))
-        yield :defs, scope, :line_no => line_no, :type => :package
+        yield :defs, scope, line_no: line_no, type: :package
       when /^type\s+(\w+)\s+struct\s*\{/
         scope.push(Regexp.last_match(1))
         stack.push(:struct)
-        yield :defs, scope, :line_no => line_no, :type => :class
+        yield :defs, scope, line_no: line_no, type: :class
       when /^type\s+(\w+)\s+interface\s*\{/
         scope.push(Regexp.last_match(1))
         stack.push(:interface)
-        yield :defs, scope, :line_no => line_no, :type => :class
+        yield :defs, scope, line_no: line_no, type: :class
       when /^type\s+(\w+)/
-        yield :defs, scope + [Regexp.last_match(1)], :line_no => line_no, :type => :type
+        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
+        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
+        yield :defs, scope + [Regexp.last_match(1)], line_no: line_no
         parse_call(line, line_no, scope, &block)
       when /^const\s+\(/
         stack.push(:def)
       when /^const\s+(\w+)\s/
-        yield :defs, scope + [Regexp.last_match(1)], :line_no => line_no
+        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|
@@ -143,9 +143,9 @@ module Starscope::Lang
           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
+            yield :assigns, scope + [name[0]], line_no: line_no
           else
-            yield :assigns, name, :line_no => line_no
+            yield :assigns, name, line_no: line_no
           end
         end
         parse_call(line, line_no, scope, &block)
@@ -160,12 +160,12 @@ module Starscope::Lang
         if name.length == 1
           next if name[0] == 'func'
           if BUILTIN_FUNCS.include?(name[0])
-            yield :calls, name[0], :line_no => line_no
+            yield :calls, name[0], line_no: line_no
           else
-            yield :calls, scope + [name[0]], :line_no => line_no
+            yield :calls, scope + [name[0]], line_no: line_no
           end
         else
-          yield :calls, name, :line_no => line_no
+          yield :calls, name, line_no: line_no
         end
       end
     end
@@ -176,13 +176,13 @@ module Starscope::Lang
       return unless line =~ /^\s*[[:alpha:]_]/
 
       line.split.each do |var|
-        yield :defs, scope + [var.delete(',')], :line_no => line_no
+        yield :defs, scope + [var.delete(',')], line_no: line_no
         break unless var.end_with?(',')
       end
     end
 
     def self.end_block(line_no, scope, stack)
-      yield :end, scope + ['}'], :line_no => line_no, :type => :class
+      yield :end, scope + ['}'], line_no: line_no, type: :class
       stack.pop
       scope.pop
     end
@@ -192,9 +192,9 @@ module Starscope::Lang
       (start + 1...line.length).each do |i|
         if escape
           escape = false
-        elsif line[i].chr == '\\'
+        elsif line[i] == '\\'
           escape = true
-        elsif line[i].chr == '"'
+        elsif line[i] == '"'
           return i
         end
       end