starscope 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,8 +1,19 @@
 Changelog
 =========
 
-v0.0.4 (trunk)
---------------
+v0.0.5 (trunk)
+-------------------
+
+New Features:
+ * Export to ctags files
+
+Improvements:
+ * GNU Readline behaviour in line-mode
+ * Additional commands available in line-mode: !dump, !help, !version
+ * Prints the relevant line in query mode
+
+v0.0.4 (2013-06-08)
+-------------------
 
 New Features:
  * Line-mode (use the `-l` flag)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    starscope (0.0.4)
+    starscope (0.0.5)
       parser (~> 1.4)
 
 GEM

data/README.md

@@ -25,4 +25,9 @@ Ask it things with `-q`
 $ starscope.rb -q calls,new # Lists all callers of new
 ```
 
+Export it for use with your editor
+```
+$ starscope.rb -e ctags
+```
+
 [1] http://cscope.sourceforge.net/

data/bin/starscope.rb

@@ -4,7 +4,8 @@ lib = File.expand_path('../../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'optparse'
-require "starscope"
+require 'readline'
+require 'starscope'
 
 options = {auto: true}
 DEFAULT_DB=".starscope.db"
@@ -35,6 +36,9 @@ END
   end
 
   opts.separator "\nDatabase Management"
+  opts.on("-e", "--export FORMAT[,PATH]", "Export in FORMAT to PATH, see EXPORTING below") do |export|
+    options[:export] = export
+  end
   opts.on("-n", "--no-auto", "Don't automatically update/create the database") do
     options[:auto] = false
   end
@@ -51,6 +55,12 @@ END
     exit
   end
 
+  opts.separator <<END
+\nEXPORTING
+    At the moment only one export format is supported: 'ctags'. If you don't
+    specify a path, the file is written to 'tags' in the current directory.
+END
+
 end.parse!
 
 def print_summary(db)
@@ -59,15 +69,28 @@ def print_summary(db)
   end
 end
 
-def run_query(db, input, separator)
-  table, value = input.split(separator, 2)
+def run_query(db, table, value)
   if not value
-    $stderr.puts "Invalid query - did you separate your table and query with '#{separator}'?"
+    $stderr.puts "Invalid input - no query found."
     return
   end
   puts db.query(table.to_sym, value)
+  return true
 rescue StarScope::DB::NoTableError
   $stderr.puts "Table '#{table}' doesn't exist."
+  return false
+end
+
+def dump(db, table)
+  if table
+    db.dump_table(table.to_sym)
+  else
+    db.dump_all
+  end
+  return true
+rescue StarScope::DB::NoTableError
+  $stderr.puts "Table '#{table}' doesn't exist."
+  return false
 end
 
 if options[:auto] and not options[:write]
@@ -93,42 +116,70 @@ db.update if options[:read] and options[:auto]
 
 db.save(options[:write]) if options[:write]
 
-run_query(db, options[:query], ',') if options[:query]
+if options[:export]
+  format, path = options[:export].split(',', 2)
+  case format
+  when 'ctags'
+    db.export_ctags(path || 'tags')
+  else
+    puts "Unrecognized export format"
+  end
+end
+
+if options[:query]
+  table, query = options[:query].split(',', 2)
+  run_query(db, table, query)
+end
 
 print_summary(db) if options[:summary]
 
 if options[:dump]
   if options[:dump].is_a? String
-    db.dump_table(options[:dump].to_sym)
+    dump(db, options[:dump])
   else
-    db.dump_all
+    dump(db, nil)
   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:
+def linemode_help
+  <<END
+Input can be a query of the form 'TABLE QUERY' or a special command starting
+with a '!'. Recognized special commands are:
+  !dump [TABLE]
   !summary
   !update
-  !quit
 
+  !help
+  !version
+  !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
+end
+
+if options[:linemode]
+  puts "Run your query as 'TABLE QUERY' or run '!help' for more information."
+  while input = Readline.readline("> ", true)
+    cmd, param = input.split(' ', 2)
+    if cmd[0] == '!'
+      case cmd[1..-1]
+      when "dump"
+        dump(db, param)
+      when "summary"
+        print_summary(db)
+      when "update"
+        db.update
+        db.save(options[:write]) if options[:write]
+      when "help"
+        puts linemode_help
+      when "version"
+        puts StarScope::VERSION
+      when "quit"
+        exit
+      else
+        puts "Unknown command: '#{input}', try '!help'."
+      end
     else
-      run_query(db, input, ' ')
+      success = run_query(db, cmd, param)
+      puts "Try '!help'." unless success
     end
   end
 end

data/lib/starscope/datum.rb

@@ -1,11 +1,12 @@
 class StarScope::Datum
-  attr_reader :key, :scope, :file, :line
+  attr_reader :key, :file
 
-  def initialize(fqn, file, line)
+  def initialize(fqn, file, line_no)
     @key = fqn[-1].to_sym
     @scope = fqn[0...-1].map {|x| x.to_sym}
     @file = file
-    @line = line
+    @line_no = line_no
+    @line = File.readlines(file)[line_no-1].chomp
   end
 
   def score_match(fqn)
@@ -25,14 +26,17 @@ class StarScope::Datum
   end
 
   def location
-    "#{file}:#{line}"
+    "#{@file}:#{@line_no}"
   end
 
   def to_s
-    if @scope.empty?
-      "#{key} -- #{location}"
-    else
-      "#{@scope.join " "} #{@key} -- #{location}"
-    end
+    str = ""
+    str << "#{@scope.join " "} " unless @scope.empty?
+    str << "#{@key} -- #{location}"
+    str << " (#{@line.strip})"
+  end
+
+  def ctag_line
+    "#{@key}\t#{@file}\t/^#{@line}$/;"
   end
 end

data/lib/starscope/db.rb

@@ -6,9 +6,10 @@ LANGS = [StarScope::Lang::Ruby]
 
 class StarScope::DB
 
-  DB_FORMAT = 1
+  DB_FORMAT = 2
 
   class NoTableError < StandardError; end
+  class UnknownDBFormatError < StandardError; end
 
   def initialize
     @dirs = []
@@ -19,10 +20,17 @@ class StarScope::DB
   def load(file)
     File.open(file, 'r') do |file|
       Zlib::GzipReader.wrap(file) do |file|
-        raise "Database format not recognized" if DB_FORMAT != file.gets.to_i
-        @dirs   = load_part(file)
-        @files  = load_part(file)
-        @tables = load_part(file)
+        format = file.gets.to_i
+        if format == DB_FORMAT
+          @dirs   = load_part(file)
+          @files  = load_part(file)
+          @tables = load_part(file)
+        elsif format < DB_FORMAT
+          # Old format, so read the directories segment then rebuild
+          add_dirs(load_part(file))
+        elsif format > DB_FORMAT
+          raise UnknownDBFormatError
+        end
       end
     end
   end
@@ -89,6 +97,25 @@ class StarScope::DB
     results.select {|result| best_score - result.score_match(fqn) < 4}
   end
 
+  def export_ctags(filename)
+    File.open(filename, 'w') do |file|
+      file.puts <<END
+!_TAG_FILE_FORMAT	2	//
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Evan Huus //
+!_TAG_PROGRAM_NAME	Starscope //
+!_TAG_PROGRAM_URL	https://github.com/eapache/starscope //
+!_TAG_PROGRAM_VERSION	#{StarScope::VERSION}	//
+END
+      defs = (@tables[:def] || []).sort {|a,b| a <=> b}
+      defs.each do |key, val|
+        val.each do |entry|
+          file.puts entry.ctag_line
+        end
+      end
+    end
+  end
+
   private
 
   def load_part(file)

data/lib/starscope/version.rb

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

data/starscope.gemspec

@@ -1,24 +1,20 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.expand_path('../lib/starscope/version.rb', __FILE__)
 
-require 'starscope/version.rb'
+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 and other languages"
+  gem.authors       = ["Evan Huus"]
+  gem.homepage      = 'https://github.com/eapache/starscope'
+  gem.email         = 'eapache@gmail.com'
+  gem.files         = `git ls-files`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
 
-Gem::Specification.new do |s|
-  s.name          = 'starscope'
-  s.version       = StarScope::VERSION
-  s.date          = '2013-06-07'
-  s.summary       = "A code indexer and analyzer"
-  s.description   = "A tool like the venerable cscope, but for ruby and other languages"
-  s.authors       = ["Evan Huus"]
-  s.homepage      = 'https://github.com/eapache/starscope'
-  s.email         = 'evan.huus@jadedpixel.com'
-  s.files         = `git ls-files`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_dependency 'parser', '~> 1.4'
-  s.add_development_dependency 'bundler', '~> 1.3'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'pry-debugger'
+  gem.add_dependency 'parser', '~> 1.4'
+  gem.add_development_dependency 'bundler', '~> 1.3'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-debugger'
 end

metadata

@@ -1,98 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: starscope
 version: !ruby/object:Gem::Version
-  version: 0.0.4
   prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Evan Huus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-07 00:00:00.000000000 Z
+date: 2013-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: parser
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
+    none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+    none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: pry
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: pry-debugger
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     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
+email: eapache@gmail.com
 executables:
 - starscope.rb
 extensions: []
@@ -120,17 +120,23 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -3682950058124738529
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -3682950058124738529
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23