starscope 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+Changelog
+=========
+
+v0.0.4 (trunk)
+--------------
+
+New Features:
+ * Line-mode (use the `-l` flag)
+
+Other Improvements:
+ * Better error handling
+ * General polish

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    starscope (0.0.3)
-      parser
+    starscope (0.0.4)
+      parser (~> 1.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -6,6 +6,23 @@ across the fantastic Cscope tool [1]. Sadly, it only works for C (and sort of
 works for C++).
 
 StarScope is a similar tool for Ruby, with a design intended to make it easy to
-add support for other languages at some point within the same framework.
+add support for other languages at some point within the same framework (thus
+the name StarScope, ie \*scope).
+
+Install it as a gem:
+```
+$ gem install starscope
+```
+
+Build your database, by just running it in the project directory:
+```
+$ cd ~/my-project
+$ starscope.rb
+```
+
+Ask it things with `-q`
+```
+$ starscope.rb -q calls,new # Lists all callers of new
+```
 
 [1] http://cscope.sourceforge.net/

data/bin/starscope.rb

@@ -24,6 +24,9 @@ END
   opts.on("-d", "--dump [TABLE]", "Dumps the DB or specified table to stdout") do |tbl|
     options[:dump] = tbl || true
   end
+  opts.on("-l", "--line-mode", "Starts line-oriented interface") do
+    options[:linemode] = true
+  end
   opts.on("-q", "--query TABLE,QUERY", "Looks up QUERY in TABLE") do |query|
     options[:query] = query
   end
@@ -50,39 +53,49 @@ END
 
 end.parse!
 
-# Load the database
+def print_summary(db)
+  db.summary.each do |name, count|
+    printf("%-8s %5d keys\n", name, count)
+  end
+end
+
+def run_query(db, input, separator)
+  table, value = input.split(separator, 2)
+  if not value
+    $stderr.puts "Invalid query - did you separate your table and query with '#{separator}'?"
+    return
+  end
+  puts db.query(table.to_sym, value)
+rescue StarScope::DB::NoTableError
+  $stderr.puts "Table '#{table}' doesn't exist."
+end
+
+if options[:auto] and not options[:write]
+  options[:write] = DEFAULT_DB
+end
+
+if File.exists?(DEFAULT_DB) and not options[:read]
+  options[:read] = DEFAULT_DB
+end
+
 db = StarScope::DB.new
-new = true
+
 if options[:read]
   db.load(options[:read])
-  new = false
-elsif File.exists?(DEFAULT_DB)
-  db.load(DEFAULT_DB)
-  new = false
-end
-
-if ARGV.empty?
-  db.add_dirs(['.']) if new
+  db.add_dirs(ARGV)
+elsif ARGV.empty?
+  db.add_dirs(['.'])
 else
   db.add_dirs(ARGV)
 end
 
-# Update it
-db.update if options[:auto] and not new
+db.update if options[:read] and options[:auto]
 
-# Write it
-if options[:auto] || options[:write]
-  db.save(options[:write] || DEFAULT_DB)
-end
+db.save(options[:write]) if options[:write]
 
-if options[:query]
-  table, value = options[:query].split(',', 2)
-  db.query(table.to_sym, value)
-end
+run_query(db, options[:query], ',') if options[:query]
 
-if options[:summary]
-  db.print_summary
-end
+print_summary(db) if options[:summary]
 
 if options[:dump]
   if options[:dump].is_a? String
@@ -91,3 +104,31 @@ if options[:dump]
     db.dump_all
   end
 end
+
+if options[:linemode]
+  puts <<END
+Normal input is of the form
+  table query
+and returns the result of that query. The following special commands
+are also recognized:
+  !summary
+  !update
+  !quit
+
+END
+  while true
+    print "> "
+    input = gets.chomp
+    case input
+    when "!summary"
+      print_summary(db)
+    when "!update"
+      db.update
+      db.save(options[:write]) if options[:write]
+    when "!quit"
+      exit
+    else
+      run_query(db, input, ' ')
+    end
+  end
+end

data/lib/starscope/db.rb

@@ -8,6 +8,8 @@ class StarScope::DB
 
   DB_FORMAT = 1
 
+  class NoTableError < StandardError; end
+
   def initialize
     @dirs = []
     @files = {}
@@ -37,7 +39,7 @@ class StarScope::DB
   end
 
   def add_dirs(dirs)
-    @dirs << dirs
+    @dirs += dirs
     dirs.each do |dir|
       Dir["#{dir}/**/*"].each do |file|
         add_file(file)
@@ -52,6 +54,7 @@ class StarScope::DB
   end
 
   def dump_table(table)
+    raise NoTableError if not @tables[table]
     puts "== Table: #{table} =="
     @tables[table].each do |val, data|
       puts "#{val}"
@@ -66,22 +69,24 @@ class StarScope::DB
     @tables.keys.each {|tbl| dump_table(tbl)}
   end
 
-  def print_summary
-    @tables.each do |name, tbl|
-      puts "#{name} - #{tbl.keys.count} entries"
+  def summary
+    ret = {}
+
+    @tables.each_key do |key|
+      ret[key] = @tables[key].keys.count
     end
+
+    ret
   end
 
   def query(table, value)
     fqn = value.split("::")
+    raise NoTableError if not @tables[table]
     results = @tables[table][fqn[-1].to_sym]
+    return [] if results.nil? || results.empty?
     results.sort! {|a,b| b.score_match(fqn) <=> a.score_match(fqn)}
     best_score = results[0].score_match(fqn)
-    results.each do |result|
-      # 4 is a guess at the best heuristic, not magic
-      return if best_score - result.score_match(fqn) > 4
-      puts result
-    end
+    results.select {|result| best_score - result.score_match(fqn) < 4}
   end
 
   private

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
 module StarScope
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/starscope.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'parser'
+  s.add_dependency 'parser', '~> 1.4'
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'pry'

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: starscope
 version: !ruby/object:Gem::Version
+  version: 0.0.4
   prerelease: 
-  version: 0.0.3
 platform: ruby
 authors:
 - Evan Huus
@@ -12,85 +12,85 @@ cert_chain: []
 date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-  name: parser
+        version: '1.4'
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-    none: false
-  name: bundler
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: rake
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: pry
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: pry-debugger
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 description: A tool like the venerable cscope, but for ruby and other languages
 email: evan.huus@jadedpixel.com
 executables:
@@ -99,6 +99,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -119,17 +120,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23