starscope 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.starscope.db
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (1.0.2)
+    coderay (1.0.9)
+    columnize (0.3.6)
+    debugger (1.6.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.1)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.2)
+    method_source (0.8.1)
+    parser (1.4.1)
+      ast (~> 1.0)
+      slop (~> 3.4)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-debugger (0.2.2)
+      debugger (~> 1.3)
+      pry (~> 0.9.10)
+    rake (10.0.4)
+    slop (3.4.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  parser
+  pry
+  pry-debugger
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Evan Huus
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+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++).
+
+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.
+
+[1] http://cscope.sourceforge.net/

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/starscope.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'optparse'
+require "starscope"
+
+options = {auto: true}
+DEFAULT_DB=".starscope.db"
+
+# Options Parsing
+OptionParser.new do |opts|
+  opts.banner = "Usage: starscope.rb [options] [PATHS]"
+
+  opts.on("-d", "--dump [TABLE]", "Dumps the DB or specified table to standard-out") do |tbl|
+    options[:dump] = tbl || true
+  end
+
+  opts.on("-n", "--no-auto", "Don't automatically create or update the database") do
+    options[:auto] = false
+  end
+
+  opts.on("-q", "--query QUERY", "Queries the database") do |query|
+    options[:query] = query
+  end
+
+  opts.on("-r", "--read-db READ", "Reads the database from PATH instead of #{DEFAULT_DB}") do |path|
+    options[:read] = path
+  end
+
+  opts.on("-s", "--summary", "Print a database summary to standard-out") do
+    options[:summary] = true
+  end
+
+  opts.on("-w", "--write-db PATH", "Writes the database to PATH instead of #{DEFAULT_DB}") do |path|
+    options[:write] = path
+  end
+
+end.parse!
+
+# Load the database
+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
+else
+  db.add_dirs(ARGV)
+end
+
+# Update it
+db.update if options[:auto] and not new
+
+# Write it
+if options[:auto] || options[:write]
+  db.save(options[:write] || DEFAULT_DB)
+end
+
+if options[:query]
+  table, value = options[:query].split(',', 2)
+  db.query(table.to_sym, value)
+end
+
+if options[:summary]
+  db.print_summary
+end
+
+if options[:dump]
+  if options[:dump].is_a? String
+    db.dump_table(options[:dump].to_sym)
+  else
+    db.dump_all
+  end
+end

data/lib/starscope.rb

@@ -0,0 +1,2 @@
+require "starscope/version"
+require "starscope/db"

data/lib/starscope/datum.rb

@@ -0,0 +1,40 @@
+class StarScope::Datum
+  attr_reader :key, :scope, :file, :line
+
+  def initialize(fqn, file, line)
+    @key = fqn[-1].to_sym
+    @scope = fqn[0...-1].map {|x| x.to_sym}
+    @file = file
+    @line = line
+  end
+
+  def score_match(fqn)
+    score = 0
+
+    i = -1
+    fqn[0...-1].reverse.each do |test|
+      if test.to_sym == @scope[i]
+        score += 5
+      elsif Regexp.new(test).match(@scope[i])
+        score += 3
+      elsif Regexp.new(test, Regexp::IGNORECASE).match(@scope[i])
+        score += 1
+      end
+      i -= 1
+    end
+
+    score - @scope.count - i + 1
+  end
+
+  def location
+    "#{file}:#{line}"
+  end
+
+  def to_s
+    if @scope.empty?
+      "#{key} -- #{location}"
+    else
+      "#{@scope.join " "} #{@key} -- #{location}"
+    end
+  end
+end

data/lib/starscope/db.rb

@@ -0,0 +1,126 @@
+require 'starscope/langs/ruby'
+require "starscope/datum"
+require 'zlib'
+
+LANGS = [StarScope::Lang::Ruby]
+
+class StarScope::DB
+
+  def initialize
+    @dirs = []
+    @files = {}
+    @tables = {}
+  end
+
+  def load(file)
+    File.open(file, 'r') do |file|
+      Zlib::GzipReader.wrap(file) do |file|
+        raise "File version doesn't match" if StarScope::VERSION != file.gets.chomp
+        @dirs   = load_part(file)
+        @files  = load_part(file)
+        @tables = load_part(file)
+      end
+    end
+  end
+
+  def save(file)
+    File.open(file, 'w') do |file|
+      Zlib::GzipWriter.wrap(file) do |file|
+        file.puts StarScope::VERSION
+        save_part(file, @dirs)
+        save_part(file, @files)
+        save_part(file, @tables)
+      end
+    end
+  end
+
+  def add_dirs(dirs)
+    @dirs << dirs
+    dirs.each do |dir|
+      Dir["#{dir}/**/*"].each do |file|
+        add_file(file)
+      end
+    end
+  end
+
+  def update
+    @files.keys.each {|f| update_file(f)}
+    cur_files = @dirs.each {|d| Dir["#{d}/**/*"]}.flatten
+    (cur_files - @files.keys).each {|f| add_file(f)}
+  end
+
+  def dump_table(table)
+    puts "== Table: #{table} =="
+    @tables[table].each do |val, data|
+      puts "#{val}"
+      data.each do |datum|
+        print "\t"
+        puts datum
+      end
+    end
+  end
+
+  def dump_all
+    @tables.keys.each {|tbl| dump_table(tbl)}
+  end
+
+  def print_summary
+    @tables.each do |name, tbl|
+      puts "#{name} - #{tbl.keys.count} entries"
+    end
+  end
+
+  def query(table, value)
+    fqn = value.split("::")
+    results = @tables[table][fqn[-1].to_sym]
+    puts results.sort {|a,b| b.score_match(fqn) <=> a.score_match(fqn)}
+  end
+
+  private
+
+  def load_part(file)
+    len = file.gets.to_i
+    Marshal::load(file.read(len))
+  end
+
+  def save_part(file, val)
+    dat = Marshal.dump(val)
+    file.puts dat.length
+    file.write dat
+  end
+
+  def add_file(file)
+    return if not File.file? file
+
+    @files[file] = File.mtime(file)
+
+    LANGS.each do |lang|
+      next if not lang.match_file file
+      lang.extract file do |tblname, fqn, lineno|
+        datum = StarScope::Datum.new(fqn, file, lineno)
+        @tables[tblname] ||= {}
+        @tables[tblname][datum.key] ||= []
+        @tables[tblname][datum.key] << datum
+      end
+    end
+  end
+
+  def remove_file(file)
+    @files.delete(file)
+    @tables.each do |name, tbl|
+      tbl.each do |key, val|
+        val.delete_if {|dat| dat.file == file}
+      end
+    end
+  end
+
+  def update_file(file)
+    if not File.exists?(file)
+      remove_file(file)
+    elsif @files[file] < File.mtime(file)
+      remove_file(file)
+      add_file(file)
+    end
+  end
+
+end

data/lib/starscope/langs/ruby.rb

@@ -0,0 +1,89 @@
+require "parser/current"
+
+module StarScope::Lang
+  module Ruby
+    def self.match_file(name)
+      name =~ /.*\.rb/
+    end
+
+    def self.extract(file, &block)
+      begin
+        ast = Parser::CurrentRuby.parse_file(file)
+      rescue
+      else
+        Extractor.new(ast).extract &block
+      end
+    end
+
+    private
+
+    class Extractor
+      def initialize(ast)
+        @ast = ast
+        @scope = []
+      end
+      
+      def extract(&block)
+        extract_tree(@ast, &block)
+      end
+
+      private
+
+      def extract_tree(tree, &block)
+        extract_node tree, &block
+
+        new_scope = []
+        if [:class, :module].include? tree.type
+          new_scope = scoped_name(tree.children[0])
+          @scope += new_scope
+        end
+
+        tree.children.each {|node| extract_tree node, &block if node.is_a? AST::Node}
+
+        @scope.pop(new_scope.count)
+      end
+
+      def extract_node(node)
+        if node.type == :send
+          yield :calls, scoped_name(node), node.source_map.expression.line
+
+          if node.children[0].nil? and node.children[1] == :require and node.children[2].type == :str
+            yield :includes, node.children[2].children[0].split("/"), node.source_map.expression.line
+          end
+        end
+
+        if node.type == :def
+          yield :def, @scope + [node.children[0]], node.source_map.expression.line
+        elsif [:module, :class].include? node.type
+          yield :def, @scope + scoped_name(node.children[0]), node.source_map.expression.line
+        end
+
+        if node.type == :cdecl
+          yield :assign, scoped_name(node), node.source_map.expression.line
+        elsif [:lvasgn, :ivasgn, :cvdecl, :cvasgn, :gvasgn].include? node.type
+          yield :assign, @scope + [node.children[0]], node.source_map.expression.line
+        end
+      end
+
+      def scoped_name(node)
+        if node.type == :block
+          scoped_name(node.children[0])
+        elsif [:lvar, :ivar, :cvar, :gvar, :const, :send, :cdecl].include? node.type
+          if node.children[0].is_a? Symbol
+            [node.children[0]]
+          elsif node.children[0].is_a? AST::Node
+            scoped_name(node.children[0]) << node.children[1]
+          elsif node.children[0].nil?
+            if node.type == :const
+              [node.children[1]]
+            else
+              @scope + [node.children[1]]
+            end
+          end
+        else
+          [node.type]
+        end
+      end
+    end
+  end
+end

data/lib/starscope/value.rb

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

data/lib/starscope/version.rb

@@ -0,0 +1,3 @@
+module StarScope
+  VERSION = "0.0.1"
+end

data/starscope.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'starscope/version.rb'
+
+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'
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-debugger'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: starscope
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Evan Huus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: parser
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  name: bundler
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: rake
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: pry
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: pry-debugger
+  type: :development
+  prerelease: 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
+executables:
+- starscope.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/starscope.rb
+- lib/starscope.rb
+- lib/starscope/datum.rb
+- lib/starscope/db.rb
+- lib/starscope/langs/ruby.rb
+- lib/starscope/value.rb
+- lib/starscope/version.rb
+- starscope.gemspec
+homepage: https://github.com/eapache/starscope
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A code indexer and analyzer
+test_files: []