starscope 1.2.0 → 1.3.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63556d4e16d22bf281211c311fa2ca379b7ec631
-  data.tar.gz: c48c940ea99cd383e0aa6f90a19b0cc2f9df6d96
+  metadata.gz: c09fb48ea12174fc241fc799d5eb948da2a44582
+  data.tar.gz: c56e8c9fc177ecc94d7dbd77b15af4a130b2c65f
 SHA512:
-  metadata.gz: ad88485b560c0b4f56aa48c76b7b42451d1e91e9f72ff65689207db6ffc1b85cc2c84966399965f4cdf08489d9f5f771bcefda1bc2f61dd83be38f59564f3346
-  data.tar.gz: e03b09376ac960ea2316e5436a9963af358862cebaf51bee7565607bd06b4f60c89df4e5bc5e4802345cd3f7d43f282eac321b853327de8c2ca2959b059dfb8a
+  metadata.gz: 715d7b4ff92b00c9a9e8feee0acd4e6a198215c66b142796a5c90f5eac7f66eafdf4890fd1314d323a62c00f1bbc65f3ad3a64d57f5942c6326952e47361b34c
+  data.tar.gz: ab315bcf74d0b42dc7420c8ee18a30fbc17b66a1a6e8259cfa93d19953d1a462de597fda4895ae3c10cf7bac762d27b546ac95ea2925c565aaf873d466920521

data/.travis.yml

@@ -4,4 +4,4 @@ rvm:
     - 1.8.7
     - 1.9.3
     - 2.0.0
-    - 2.1.1
+    - 2.1.5

data/CHANGELOG.md

@@ -1,7 +1,21 @@
 Changelog
 =========
 
-v1.2.0 (trunk)
+v1.3.0 (trunk)
+--------------------
+
+New Features:
+ * Give `*` as the table name in order to query all tables at once (#58).
+ * Specify filters for your queries for example `lang:ruby,calls,new` (#24).
+ * Ruby: Recognize variables and symbols outside of assignments, available in
+   the new `reads` and `sym` tables (#102).
+ * Cscope: export 'unmarked' or generic cscope tokens, providing a much richer
+   integration with cscope's "find this C symbol" (#60).
+
+Bug Fixes:
+ * Simplify query logic to match user expectations (#91)
+
+v1.2.0 (2014-09-02)
 --------------------
 
 Improvements:

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    starscope (1.2.0)
+    starscope (1.3.0.pre.rc1)
+      backports (~> 3.6)
       oj (~> 2.9)
       parser (~> 2.1)
       ruby-progressbar (~> 1.5)
@@ -10,23 +11,24 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.0.0)
+    backports (3.6.4)
     coderay (1.1.0)
     metaclass (0.0.4)
     method_source (0.8.2)
-    minitest (5.4.0)
+    minitest (5.5.0)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
-    oj (2.9.9)
-    parser (2.1.9)
+    oj (2.11.1)
+    parser (2.2.0.1)
       ast (>= 1.1, < 3.0)
       slop (~> 3.4, >= 3.4.5)
-    pry (0.10.0)
+    pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (10.3.2)
-    ruby-progressbar (1.5.1)
-    slop (3.5.0)
+    rake (10.4.2)
+    ruby-progressbar (1.7.1)
+    slop (3.6.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -9,7 +9,7 @@ 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](http://golang.org/), with a design intended to make it easy to add
+[Golang](https://golang.org/), with a design intended to make it easy to add
 [support for other languages](doc/LANGUAGE_SUPPORT.md) within the same framework
 (thus the name Starscope, i.e. \*scope).
 

data/bin/starscope

@@ -92,8 +92,8 @@ 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 file '#{Starscope::Export::CTAGS_DEFAULT_PATH}' (for
-    ctags) or '#{Starscope::Export::CSCOPE_DEFAULT_PATH}' (for cscope) in the current directory.
+    you don't specify a path, the output is written to the file '#{Starscope::Exportable::CTAGS_DEFAULT_PATH}' (for
+    ctags) or '#{Starscope::Exportable::CSCOPE_DEFAULT_PATH}' (for cscope) in the current directory.
 END
 
 end.parse!
@@ -110,12 +110,31 @@ def format_record(db, rec)
   "#{rec[:name].join " "} -- #{rec[:file]}:#{rec[:line_no]} (#{db.line_for_record(rec).strip})"
 end
 
-def run_query(db, table, value)
-  if !value
+def run_query(db, query, separator)
+  table = nil
+  match = []
+  filters = {}
+  query.split(separator).each do |tok|
+    unless table.nil?
+      match << tok
+      next
+    end
+
+    k, v = tok.split(':', 2)
+    if v.nil?
+      table = tok
+    else
+      filters[k.to_sym] = v
+    end
+  end
+  match = match.join(separator)
+
+  if !match
     $stderr.puts "Invalid input - no query found."
     return false
   end
-  results = db.query(table.to_sym, value)
+  tables = (table == '*' ? db.tables : table.to_sym)
+  results = db.query(tables, match, filters)
   if !results || results.empty?
     puts "No results found."
   else
@@ -164,7 +183,7 @@ end
 def export(db, param)
   format, path = param.split(',', 2)
   db.export(format.to_sym, path)
-rescue Starscope::Export::UnknownExportFormatError
+rescue Starscope::Exportable::UnknownExportFormatError
   $stderr.puts "Unrecognized export format \"#{format}\""
 end
 
@@ -203,10 +222,7 @@ db.save(options[:db]) if options[:write] && (new_data || !db_exists)
 
 options[:export].each { |target| export(db, target) }
 
-if options[:query]
-  table, query = options[:query].split(',', 2)
-  run_query(db, table, query)
-end
+run_query(db, options[:query], ',') if options[:query]
 
 print_summary(db) if options[:summary]
 
@@ -264,7 +280,7 @@ if options[:linemode]
           puts "Unknown command: '#{input}', try '!help'."
         end
       else
-        success = run_query(db, cmd, param)
+        success = run_query(db, input, ' ')
         puts "Try '!help'." unless success
       end
     end

data/doc/LANGUAGE_SUPPORT.md

@@ -5,7 +5,7 @@ Already Supported
 -----------------
 
  * [Ruby](https://www.ruby-lang.org/)
- * [Golang](http://golang.org/)
+ * [Golang](https://golang.org/)
 
 How to Add Another Language
 ---------------------------
@@ -47,6 +47,7 @@ methods:
    anything you want.
  * `extract` takes a readable file handle pointing to the file, and must parse
    the file, `yield`ing records as it finds function definitions and the like.
+   It may also return a final hash of file-wide metadata to store.
 
 The record requirements are pretty straight-forward:
 ```ruby
@@ -60,6 +61,8 @@ belongs (basically its type). Current tables already include:
  * `assigns` for variable assignment
  * `requires` for required files in Ruby
  * `imports` for imported packages in Golang
+ * `reads` for reading of variables, constants etc. (e.g. use in an expression)
+ * `sym` for Ruby symbols
 
 Try to use pre-existing tables where possible, but feel free to add more if the
 language has some weird feature that doesn't map to any of the above. You don't

data/doc/USER_GUIDE.md

@@ -20,7 +20,7 @@ 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](http://golang.org/), with a design intended to make it easy to add
+[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).
 
@@ -110,11 +110,12 @@ Queries
 -------
 
 To query the starscope database, pass the `-q` or `--query` flag with an
-argument in the following format: `TABLE,QUERY`. For example, `-q calls,new`
-would list all callers of `new` and `-q defs,bar` would list places that define
-a method or class named `bar`. See the [language support
+argument in the following format: `[FILTERS,]TABLE,QUERY`. For example,
+`-q calls,new` would list all callers of `new` and `-q defs,bar` would list
+places that define a method or class named `bar`. See the [language support
 documentation](LANGUAGE_SUPPORT.md) for a list of the most common tables, or use
-the `--summary` flag to list all the tables in the current database.
+the `--summary` flag to list all the tables in the current database. Pass `*` as
+the table name to query all tables.
 
 You can also search for scoped names such as `MyClass.new`. To do this, you must
 specify the scope with `::`, even if the language or instance you are searching
@@ -124,6 +125,11 @@ Queries using regular expressions are generally supported, and will be tried
 against both the base name and the fully-qualified name (again using `::` as the
 scope separator).
 
+You can optionally filter records based on their metadata prior to the actual
+query, by prefixing comma-separated `KEY:VALUE` pairs to the query string. A
+common use of this is to restrict a query to files of a given language, for
+example with `-q lang:ruby,calls,new`.
+
 Exporting
 ---------
 
@@ -148,9 +154,9 @@ Line-Mode
 
 Specifying `-l` or `--line-mode` places you into line-oriented mode, letting you
 run multiple queries without reloading the database each time. In line mode,
-input is normally a query of the form `TABLE QUERY`, or a special command
-starting with a `!`. Recognized special commands generally map to non-line-mode
-options:
+input is normally a query of the form `[FILTERS ]TABLE QUERY`, or a special
+command starting with a `!`. Recognized special commands generally map to
+non-line-mode options:
  * `!dump [TABLE]` - same as the `--dump` flag
  * `!export FORMAT[,PATH]` - same as the `--export` flag
  * `!summary` - same as the `--summary` flag

data/lib/starscope/db.rb

@@ -1,26 +1,28 @@
+require 'backports'
 require 'date'
 require 'oj'
 require 'set'
 require 'zlib'
 
-require 'starscope/export'
-require 'starscope/matcher'
+require 'starscope/exportable'
+require 'starscope/queryable'
 require 'starscope/output'
 
 # dynamically load all our language extractors
 LANGS = {}
 EXTRACTORS = []
-Dir.glob("#{File.dirname(__FILE__)}/langs/*.rb").each do |path|
-  require path
-  lang = /(\w+)\.rb$/.match(path)[1].capitalize
-  mod_name = "Starscope::Lang::#{lang}"
-  EXTRACTORS << eval(mod_name)
-  LANGS[lang.to_sym] = eval("#{mod_name}::VERSION")
+Dir.glob("#{File.dirname(__FILE__)}/langs/*.rb").each { |path| require path }
+
+Starscope::Lang.constants.each do |lang|
+  extractor = Starscope::Lang.const_get(lang)
+  EXTRACTORS << extractor
+  LANGS[lang.to_sym] = extractor.const_get(:VERSION)
 end
 
 class Starscope::DB
 
-  include Starscope::Export
+  include Starscope::Exportable
+  include Starscope::Queryable
 
   DB_FORMAT = 5
 
@@ -105,12 +107,6 @@ class Starscope::DB
     true
   end
 
-  def query(table, value)
-    raise NoTableError if not @tables[table]
-    input = @tables[table]
-    Starscope::Matcher.new(value, input).query()
-  end
-
   def line_for_record(rec)
     return rec[:line] if rec[:line]
 
@@ -242,27 +238,45 @@ class Starscope::DB
     @meta[:files][file] = {:last_updated => File.mtime(file).to_i}
 
     EXTRACTORS.each do |extractor|
-      next if not extractor.match_file file
-
-      lines = nil
-      line_cache = nil
-      extractor.extract file do |tbl, name, args|
-        @tables[tbl] ||= []
-        @tables[tbl] << self.class.normalize_record(file, name, args)
-
-        if args[:line_no]
-          line_cache ||= File.readlines(file)
-          lines ||= Array.new(line_cache.length)
-          lines[args[:line_no]-1] = line_cache[args[:line_no]-1].chomp
-        end
+      begin
+        next unless extractor.match_file file
+      rescue => e
+        @output.normal("#{extractor} raised #{e} while matching #{file}")
+        next
       end
 
-      @meta[:files][file][:lang] = extractor.name.split('::').last.to_sym
-      @meta[:files][file][:lines] = lines
+      extract_file(extractor, file)
+
       return
     end
   end
 
+  def extract_file(extractor, file)
+    lines = nil
+    line_cache = nil
+
+    extractor_metadata = extractor.extract(file) do |tbl, name, args|
+      @tables[tbl] ||= []
+      @tables[tbl] << self.class.normalize_record(file, name, args)
+
+      if args[:line_no]
+        line_cache ||= File.readlines(file)
+        lines ||= Array.new(line_cache.length)
+        lines[args[:line_no]-1] = line_cache[args[:line_no]-1].chomp
+      end
+    end
+
+    @meta[:files][file][:lang] = extractor.name.split('::').last.to_sym
+    @meta[:files][file][:lines] = lines
+
+    if extractor_metadata.is_a? Hash
+      @meta[:files][file] = extractor_metadata.merge!(@meta[:files][file])
+    end
+
+  rescue => e
+    @output.normal("#{extractor} raised #{e} while extracting #{file}")
+  end
+
   def file_changed(name)
     file_meta = @meta[:files][name]
     if !File.exists?(name) || !File.file?(name)

data/lib/starscope/{export.rb → exportable.rb}

@@ -1,4 +1,4 @@
-module Starscope::Export
+module Starscope::Exportable
 
   CTAGS_DEFAULT_PATH='tags'
   CSCOPE_DEFAULT_PATH='cscope.out'
@@ -95,11 +95,7 @@ END
             end
           end
 
-          buf << CSCOPE_GLOBAL_HACK_STOP if record[:type] == :func && record[:tbl] == :defs
-          buf << cscope_plaintext(line, prev, offset) << "\n"
-          buf << cscope_mark(record[:tbl], record) << record[:key] << "\n"
-          buf << CSCOPE_GLOBAL_HACK_START if record[:type] == :func && record[:tbl] == :end
-
+          buf << cscope_output(line, prev, offset, record)
           prev = offset + record[:key].length
 
         end
@@ -151,7 +147,7 @@ END
       # keep scanning if our current index doesn't actually match the key, or if
       # either the preceeding or succeeding character is a word character
       # (meaning we've accidentally matched the middle of some other token)
-      while !index.nil? &&
+      while index &&
         ((line[index, key.length] != key) ||
          (index > 0 && line[index-1] =~ /\w/) ||
          (index+key.length < line.length && line[index+key.length] =~ /\w/))
@@ -176,6 +172,37 @@ END
     return toks.sort
   end
 
+  def cscope_output(line, prev, offset, record)
+    buf = ""
+    buf << CSCOPE_GLOBAL_HACK_STOP if record[:type] == :func && record[:tbl] == :defs
+
+    tokens = record[:name][0...-1].map {|x| x.to_s.sub(/\W+$/, '')}.select {|x| !x.empty?}.join("|")
+    if !tokens.empty?
+      # output previous components of the name (ie the Foo in Foo::bar) as unmarked symbols
+      rxp = Regexp.new("\\W(#{tokens})\\W")
+      index = line.index(rxp, prev)
+
+      while index
+        tok = rxp.match(line[index..-1])[1]
+        index += 1
+        break if index+tok.length > offset
+        buf << cscope_plaintext(line, prev, index) << "\n"
+        buf << "#{tok}\n"
+        prev = index + tok.length
+        index = line.index(rxp, prev)
+      end
+    end
+
+    buf << cscope_plaintext(line, prev, offset) << "\n"
+    buf << cscope_mark(record) << record[:key] << "\n"
+
+    buf << CSCOPE_GLOBAL_HACK_START if record[:type] == :func && record[:tbl] == :end
+    buf
+  rescue ArgumentError
+    # invalid utf-8 byte sequence in the line, oh well
+    line
+  end
+
   def cscope_plaintext(line, start, stop)
     ret = line.slice(start, stop-start)
     ret.lstrip! if start == 0
@@ -186,8 +213,8 @@ END
     line
   end
 
-  def cscope_mark(tbl, rec)
-    case tbl
+  def cscope_mark(rec)
+    case rec[:tbl]
     when :end
       case rec[:type]
       when :func

data/lib/starscope/langs/ruby.rb

@@ -8,20 +8,14 @@ module Starscope::Lang
       return true if name.end_with?(".rb")
       File.open(name) do |f|
         head = f.read(2)
-        return false if head.nil? or not head.start_with?("#!")
+        return false if head.nil? || !head.start_with?("#!")
         return f.readline.include?("ruby")
       end
-    rescue ArgumentError # may occur if file is binary (invalid UTF)
-      false
     end
 
     def self.extract(file, &block)
-      begin
-        ast = Parser::CurrentRuby.parse_file(file)
-      rescue
-      else
-        extract_tree(ast, [], &block) if not ast.nil?
-      end
+      ast = Parser::CurrentRuby.parse_file(file)
+      extract_tree(ast, [], &block) unless ast.nil?
     end
 
     private
@@ -72,12 +66,22 @@ module Starscope::Lang
         yield :end, :end, :line_no => loc.end.line, :type => node.type, :col => loc.end.column
 
       when :casgn
-        fqn = scoped_name(node, scope)
-        yield :assigns, fqn, :line_no => loc.line, :col => loc.name.column
-        yield :defs, fqn, :line_no => loc.line, :col => loc.name.column
+        name = scoped_name(node, scope)
+        yield :assigns, name, :line_no => loc.line, :col => loc.name.column
+        yield :defs, name, :line_no => loc.line, :col => loc.name.column
 
       when :lvasgn, :ivasgn, :cvasgn, :gvasgn
         yield :assigns, scope + [node.children[0]], :line_no => loc.line, :col => loc.name.column
+
+      when :const
+        name = scoped_name(node, scope)
+        yield :reads, name, :line_no => loc.line, :col => loc.name.column
+
+      when :lvar, :ivar, :cvar, :gvar
+        yield :reads, scope + [node.children[0]], :line_no => loc.line, :col => loc.expression.column
+
+      when :sym
+        yield :sym, [node.children[0]], :line_no => loc.line, :col => loc.expression.column
       end
     end
 

data/lib/starscope/matcher.rb

@@ -1,44 +1,24 @@
-class Starscope::Matcher
+module Starscope
+  class Matcher
+    MATCH_TYPES = [:literal_match, :regexp_match]
 
-  MATCH_TYPES = [:full_match, :simple_match, :simple_regexp, :full_regexp]
+    def initialize(query)
+      @query = query
 
-  def initialize(query, input)
-    @query  = query
-    @input  = input
-    @regexp = Regexp.new(query, Regexp::IGNORECASE)
-  rescue RegexpError
-    # not a regex, oh well
-  end
-
-  def match(record)
-    name = record[:name].map {|x| x.to_s}
-    fullname = name.join('::')
-
-    case
-    when fullname == @query
-      :full_match
-    when name[-1] == @query
-      :simple_match
-    when @regexp
-      if @regexp.match(name[-1])
-        :simple_regexp
-      elsif @regexp.match(fullname)
-        :full_regexp
+      begin
+        @regexp = Regexp.new(@query, Regexp::IGNORECASE)
+      rescue RegexpError
+        # not a regex, oh well
       end
     end
-  end
-
-  def query
-    return [] if @input.empty?
 
-    results = @input.group_by {|x| match(x)}
-
-    MATCH_TYPES.each do |type|
-       next if results[type].nil? or results[type].empty?
-       return results[type]
-     end
-
-     return []
+    def match(input)
+      case
+      when input.end_with?(@query)
+        :literal_match
+      when @regexp && @regexp.match(input)
+        :regexp_match
+      end
+    end
   end
-
 end

data/lib/starscope/queryable.rb

@@ -0,0 +1,47 @@
+require 'starscope/matcher'
+
+module Starscope::Queryable
+
+  def query(tables, value, filters={})
+    tables = [tables] if tables.is_a?(Symbol)
+    tables.each { |t| raise NoTableError, "Table '#{t}' not found" unless @tables[t] }
+    input = Enumerator.new do |y|
+      tables.each do |t|
+        @tables[t].each do |elem|
+          y << elem
+        end
+      end
+    end
+
+    run_query(value, input, filters)
+  end
+
+  private
+
+  def run_query(query, input, filters)
+    query = Starscope::Matcher.new(query)
+    filters.each {|k,v| filters[k] = Starscope::Matcher.new(v)}
+
+    results = input.select {|x| filter(x, filters)}.group_by {|x| match(x, query)}
+
+    Starscope::Matcher::MATCH_TYPES.each do |type|
+      next if results[type].nil? || results[type].empty?
+      return results[type]
+    end
+
+    []
+  end
+
+  def filter(record, filters)
+    filters.all? do |key, filter|
+      target = record[key] || (@meta[:files][record[:file]] || {})[key]
+      target && filter.match(target.to_s)
+    end
+  end
+
+  def match(record, query)
+    name = record[:name].map {|x| x.to_s}.join('::')
+
+    query.match(name)
+  end
+end

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
 module Starscope
-  VERSION = "1.2.0"
+  VERSION = "1.3.0-rc1"
 end

data/starscope.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'oj', '~> 2.9'
   gem.add_dependency 'parser', '~> 2.1'
   gem.add_dependency 'ruby-progressbar', '~> 1.5'
+  gem.add_dependency 'backports', '~> 3.6'
   gem.add_development_dependency 'bundler', '~> 1.5'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'pry'

data/test/functional/starscope_test.rb

@@ -17,7 +17,7 @@ describe "starscope executable script" do
 
   it "must produce a valid database summary" do
     lines = `#{EXTRACT} -s`.lines.to_a
-    lines.length.must_equal 6
+    lines.length.must_equal 8
   end
 
   it "must produce a valid database dump" do
@@ -30,6 +30,14 @@ describe "starscope executable script" do
     `#{EXTRACT} -q calls,add_file`.each_line do |line|
       line.split[0..2].must_equal ["Starscope", "DB", "add_file"]
     end
+
+    `#{EXTRACT} -q lang:ruby,calls,add_file`.each_line do |line|
+      line.split[0..2].must_equal ["Starscope", "DB", "add_file"]
+    end
+
+    `#{EXTRACT} -q lang:go,calls,add_file`.each_line do |line|
+      line.must_equal "No results found.\n"
+    end
   end
 
   it "must correctly export to cscope" do
@@ -43,7 +51,7 @@ describe "starscope executable script" do
     end
   end
 
-  it "Must correctly export to ctags" do
+  it "must correctly export to ctags" do
     file = Tempfile.new('starscope_test')
     begin
       `#{EXTRACT} -e ctags,#{file.path()}`

data/test/unit/db_test.rb

@@ -113,6 +113,13 @@ describe Starscope::DB do
     @db.query(:calls, "add_file").length.must_equal 3
   end
 
+  it "must run queries on multiple tables" do
+    @db.add_paths([FIXTURES])
+    ret = @db.query([:calls, :defs], "foo")
+    ret.length.must_equal 1
+    ret.first[:name].last.must_equal :foo
+  end
+
   it "must symbolize compound name" do
     rec = Starscope::DB.normalize_record(:foo, ["a", :b], {})
     rec[:name].must_equal [:a, :b]
@@ -123,6 +130,18 @@ describe Starscope::DB do
     rec[:name].must_equal [:a]
   end
 
+  it "must store extractor metadata returned from the `extract` call" do
+    extractor = mock('extractor')
+    extractor.expects(:match_file).with(GOLANG_SAMPLE).returns(true)
+    extractor.expects(:extract).with(GOLANG_SAMPLE).returns({:a => 1})
+    extractor.expects(:name).returns('Foo')
+    EXTRACTORS.stubs(:each).yields(extractor)
+
+    @db.add_paths([GOLANG_SAMPLE])
+
+    @db.metadata(:files)[GOLANG_SAMPLE][:a].must_equal 1
+  end
+
   private
 
   def validate(db)

data/test/unit/{export_test.rb → exportable_test.rb}

@@ -1,6 +1,6 @@
 require File.expand_path('../../test_helper', __FILE__)
 
-describe Starscope::Export do
+describe Starscope::Exportable do
 
   before do
     @db = Starscope::DB.new(Starscope::Output.new(:quiet))

data/test/unit/queryable_test.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+describe Starscope::Queryable do
+
+  SAMPLE_RECORDS = [
+    {:name => [:"[abc"], :foo => "baz"},
+    {:name => [:"not a match"], :foo => "bar", :x => "y"},
+    {:name => [:a, :b, :c, :d], :file => :somefile},
+  ]
+
+  class MockQuerable
+    include Starscope::Queryable
+    def initialize
+      @tables = {
+        :mytable => SAMPLE_RECORDS,
+        :empty_table => []
+      }
+      @meta = {
+        :files => {
+          :somefile => {
+            :lang => :ruby
+          }
+        }
+      }
+    end
+  end
+
+  before do
+    @mock = MockQuerable.new
+  end
+
+  it "must handle empty input" do
+    @mock.query(:empty_table, "foo").must_be_empty
+  end
+
+  it "must handle scoped queries" do
+    @mock.query(:mytable, "a::b::").must_equal [SAMPLE_RECORDS[2]]
+  end
+
+  it "must handle regex queries" do
+    @mock.query(:mytable, "a[bc]{2}").must_equal [SAMPLE_RECORDS[0]]
+
+    @mock.query(:mytable, "a.*d").must_equal [SAMPLE_RECORDS[2]]
+  end
+
+  it "must handle malformed regexes" do
+    @mock.query(:mytable, "[abc").must_equal [SAMPLE_RECORDS[0]]
+  end
+
+  it "must handle simple filters" do
+    @mock.query(:mytable, ".*", :foo => "bar").must_equal [SAMPLE_RECORDS[1]]
+  end
+
+  it "must handle multiple filters" do
+    @mock.query(:mytable, ".*", :foo => "bar", :x => "y").must_equal [SAMPLE_RECORDS[1]]
+    @mock.query(:mytable, ".*", :foo => "bar", :x => "nope").must_be_empty
+  end
+
+  it "must handle filters on file properties" do
+    @mock.query(:mytable, ".*", :lang => "ruby").must_equal [SAMPLE_RECORDS[2]]
+  end
+end

metadata

@@ -1,125 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: starscope
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0.pre.rc1
 platform: ruby
 authors:
 - Evan Huus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2015-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A tool like the venerable cscope, but for ruby, golang and other languages
@@ -129,8 +143,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -143,12 +157,13 @@ files:
 - doc/USER_GUIDE.md
 - lib/starscope.rb
 - lib/starscope/db.rb
-- lib/starscope/export.rb
+- lib/starscope/exportable.rb
 - lib/starscope/langs/coffeescript.rb
 - lib/starscope/langs/go.rb
 - lib/starscope/langs/ruby.rb
 - lib/starscope/matcher.rb
 - lib/starscope/output.rb
+- lib/starscope/queryable.rb
 - lib/starscope/version.rb
 - starscope.gemspec
 - test/fixtures/db_added_files.json
@@ -163,11 +178,11 @@ files:
 - test/functional/starscope_test.rb
 - test/test_helper.rb
 - test/unit/db_test.rb
-- test/unit/export_test.rb
+- test/unit/exportable_test.rb
 - test/unit/langs/golang_test.rb
 - test/unit/langs/ruby_test.rb
-- test/unit/matcher_test.rb
 - test/unit/output_test.rb
+- test/unit/queryable_test.rb
 homepage: https://github.com/eapache/starscope
 licenses:
 - MIT
@@ -178,17 +193,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A code indexer and analyzer
@@ -205,8 +220,8 @@ test_files:
 - test/functional/starscope_test.rb
 - test/test_helper.rb
 - test/unit/db_test.rb
-- test/unit/export_test.rb
+- test/unit/exportable_test.rb
 - test/unit/langs/golang_test.rb
 - test/unit/langs/ruby_test.rb
-- test/unit/matcher_test.rb
 - test/unit/output_test.rb
+- test/unit/queryable_test.rb

data/test/unit/matcher_test.rb

@@ -1,34 +0,0 @@
-require File.expand_path('../../test_helper', __FILE__)
-
-describe Starscope::Matcher do
-
-  SAMPLE_RECORDS = [
-    {:name => [:"[abc"]},
-    {:name => [:"not a match"]},
-    {:name => [:a, :b, :c, :d]},
-  ]
-
-  it "must handle empty input" do
-    matcher = Starscope::Matcher.new("foo", [])
-    matcher.query.must_be_empty
-  end
-
-  it "must handle scoped queries" do
-    matcher = Starscope::Matcher.new("a::b::", SAMPLE_RECORDS)
-    matcher.query.must_equal [SAMPLE_RECORDS[2]]
-  end
-
-  it "must handle regex queries" do
-    matcher = Starscope::Matcher.new("a[bc]{2}", SAMPLE_RECORDS)
-    matcher.query.must_equal [SAMPLE_RECORDS[0]]
-
-    matcher = Starscope::Matcher.new("a.*d", SAMPLE_RECORDS)
-    matcher.query.must_equal [SAMPLE_RECORDS[2]]
-  end
-
-  it "must handle malformed regexes" do
-    matcher = Starscope::Matcher.new("[abc", SAMPLE_RECORDS)
-    matcher.query.must_equal [SAMPLE_RECORDS[0]]
-  end
-
-end