starscope 0.1.4 → 0.1.5

data/CHANGELOG.md

@@ -1,7 +1,18 @@
 Changelog
 =========
 
-v0.1.4 (trunk)
+v0.1.5 (trunk)
+-------------------
+
+New Features:
+ * Add --no-progress option to hide progress-bar.
+
+Misc:
+ * Explicitly print "No results found" to avoid mysterious empty output.
+ * Recognize ruby files with a #!ruby line but no .rb suffix.
+ * Help output now fits in 80-column terminal.
+
+v0.1.4 (2014-01-05)
 -------------------
 
 New Features:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    starscope (0.1.4)
+    starscope (0.1.5)
       oj (~> 2.5)
       parser (~> 2.1)
       ruby-progressbar (~> 1.4)

data/README.md

@@ -1,15 +1,16 @@
 StarScope
 =========
 
-https://rubygems.org/gems/starscope
+[![Gem Version](https://badge.fury.io/rb/starscope.png)](http://badge.fury.io/rb/starscope)
 
 Anyone who has done much programming in C (or C++) on a unix-based OS has come
-across the fantastic Cscope tool [1]. Sadly, it only works for C (and sort of
-works for C++).
+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 and Go, with a design intended to make it
-easy to add support for other languages at some point within the same framework
-(thus the name StarScope, ie \*scope).
+StarScope is a similar tool for [Ruby](https://www.ruby-lang.org/) and
+[Golang](http://golang.org/), with a design intended to make it easy to add
+support for other languages at some point within the same framework (thus the
+name StarScope, ie \*scope).
 
 Install it as a gem:
 ```
@@ -35,5 +36,3 @@ or
 ```
 $ starscope -e cscope
 ```
-
-[1] http://cscope.sourceforge.net/

data/TODO.md

@@ -1,7 +1,6 @@
 TODO
 =========
 
-* Add --quiet to hide progress bar and --verbose to print each file
 * Parallelization, perhaps via https://github.com/grosser/parallel
 * Fuzzy matching, perhaps via https://github.com/seamusabshere/fuzzy_match
 * Export advanced ctags annotations

data/bin/starscope

@@ -7,15 +7,15 @@ require 'optparse'
 require 'readline'
 require 'starscope'
 
-options = {auto: true}
+options = {auto: true, progress: true}
 DEFAULT_DB=".starscope.db"
 
 # Options Parsing
 OptionParser.new do |opts|
   opts.banner = <<END
-Usage: starscope.rb [options] [PATHS]
+Usage: starscope [options] [PATHS]
 
-If you don't pass any of -n, -r, -w or PATHS the default behaviour is to recurse
+If you don't pass any of -n, -r, -w or PATHS, default behaviour is to recurse
 in the current directory and build or update the database `#{DEFAULT_DB}`.
 
 Query scopes must be specified with `::`, for example -q calls,File::mtime.
@@ -36,16 +36,16 @@ END
   end
 
   opts.separator "\nDatabase Management"
-  opts.on("-e", "--export FORMAT[,PATH]", "Export in FORMAT to PATH, see EXPORTING below") do |export|
+  opts.on("-e", "--export FORMAT[,PATH]", "Export in FORMAT to PATH, (see EXPORTING)") do |export|
     options[:export] = export
   end
-  opts.on("-n", "--no-auto", "Don't automatically update/create the database") do
+  opts.on("-n", "--no-auto", "Don't automatically update/create the DB") do
     options[:auto] = false
   end
-  opts.on("-r", "--read-db PATH", "Reads the DB from PATH instead of the default") do |path|
+  opts.on("-r", "--read-db PATH", "Reads the DB from PATH instead of default") do |path|
     options[:read] = path
   end
-  opts.on("-w", "--write-db PATH", "Writes the DB to PATH instead of the default") do |path|
+  opts.on("-w", "--write-db PATH", "Writes the DB to PATH instead of default") do |path|
     options[:write] = path
   end
 
@@ -54,12 +54,15 @@ END
     puts StarScope::VERSION
     exit
   end
+  opts.on("--no-progress", "Don't show progress-bar when updating DB") do
+    options[:progress] = false
+  end
 
   opts.separator <<END
 \nEXPORTING
-    At the moment two export formats are supported: 'ctags' and 'cscope'. If you
-    don't specify a path, the output is written to the files 'tags' (for ctags)
-    or 'cscope.out' (for cscope) in the current directory.
+    At the moment two export formats are supported: 'ctags' and 'cscope'. If
+    you don't specify a path, the output is written to the files 'tags' (for
+    ctags) or 'cscope.out' (for cscope) in the current directory.
 END
 
 end.parse!
@@ -76,7 +79,11 @@ def run_query(db, table, value)
     return false
   end
   key, results = db.query(table.to_sym, value)
-  puts results.map {|val| StarScope::Datum.to_s(val)} if results
+  if results
+    puts results.map {|val| StarScope::Datum.to_s(val)}
+  else
+    puts "No results found."
+  end
   return true
 rescue StarScope::DB::NoTableError
   $stderr.puts "Table '#{table}' doesn't exist."
@@ -104,7 +111,7 @@ if File.exists?(DEFAULT_DB) and not options[:read]
   options[:read] = DEFAULT_DB
 end
 
-db = StarScope::DB.new
+db = StarScope::DB.new(options[:progress])
 
 if options[:read]
   db.load(options[:read])

data/lib/starscope/db.rb

@@ -19,7 +19,8 @@ class StarScope::DB
   class NoTableError < StandardError; end
   class UnknownDBFormatError < StandardError; end
 
-  def initialize
+  def initialize(progress)
+    @progress = progress
     @paths = []
     @files = {}
     @tables = {}
@@ -64,24 +65,28 @@ class StarScope::DB
     @paths += paths
     files = paths.map {|p| self.class.files_from_path(p)}.flatten
     return if files.empty?
-    pbar = ProgressBar.create(title: "Building", total: files.length, format: PBAR_FORMAT, length: 80)
+    if @progress
+      pbar = ProgressBar.create(title: "Building", total: files.length, format: PBAR_FORMAT, length: 80)
+    end
     files.each do |f|
       add_file(f)
-      pbar.increment
+      pbar.increment if @progress
     end
   end
 
   def update
     new_files = (@paths.map {|p| self.class.files_from_path(p)}.flatten) - @files.keys
-    pbar = ProgressBar.create(title: "Updating", total: new_files.length + @files.length, format: PBAR_FORMAT, length: 80)
+    if @progress
+      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)
-      pbar.increment
+      pbar.increment if @progress
       changed
     end
     new_files.each do |f|
       add_file(f)
-      pbar.increment
+      pbar.increment if @progress
     end
     changed.any? || !new_files.empty?
   end

data/lib/starscope/langs/ruby.rb

@@ -3,7 +3,10 @@ require "parser/current"
 module StarScope::Lang
   module Ruby
     def self.match_file(name)
-      name =~ /.*\.rb$/
+      return true if name =~ /.*\.rb$/
+      return File.open(name) {|f| f.readline} =~ /^#!.*ruby/
+    rescue ArgumentError # may occur if file is binary (invalid UTF)
+      false
     end
 
     def self.extract(file, &block)

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
 module StarScope
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/starscope.gemspec

@@ -4,7 +4,7 @@ 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, go and other languages"
+  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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starscope
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -123,7 +123,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A tool like the venerable cscope, but for ruby, go and other languages
+description: A tool like the venerable cscope, but for ruby, golang and other languages
 email: eapache@gmail.com
 executables:
 - starscope
@@ -144,7 +144,6 @@ files:
 - lib/starscope/db.rb
 - lib/starscope/langs/go.rb
 - lib/starscope/langs/ruby.rb
-- lib/starscope/value.rb
 - lib/starscope/version.rb
 - starscope.gemspec
 homepage: https://github.com/eapache/starscope

data/lib/starscope/value.rb

@@ -1,7 +0,0 @@
-class StarScope::Value
-  attr_reader :simple
-
-  def initialize(simple)
-    @simple = simple
-  end
-end