starscope 1.4.1 → 1.5.0

data/lib/starscope/langs/javascript.rb

@@ -0,0 +1,114 @@
+require 'rkelly'
+require 'babel/transpiler'
+require 'sourcemap'
+
+module Starscope::Lang
+  module Javascript
+    VERSION = 0
+
+    def self.match_file(name)
+      name.end_with?('.js')
+    end
+
+    def self.extract(path, contents, &block)
+      transform = Babel::Transpiler.transform(contents,
+                                              'stage' => 0,
+                                              'blacklist' => ['validation.react'],
+                                              'externalHelpers' => true,
+                                              'compact' => false,
+                                              'sourceMaps' => true)
+      map = SourceMap::Map.from_hash(transform['map'])
+      ast = RKelly::Parser.new.parse(transform['code'])
+      lines = contents.lines.to_a
+
+      return unless ast
+
+      found = extract_methods(ast, map, lines, &block)
+
+      found = extract_var_decls(ast, map, lines, found, &block)
+
+      extract_var_reads(ast, map, lines, found, &block)
+    end
+
+    def self.extract_methods(ast, map, lines, &block)
+      found = {}
+
+      ast.each do |node|
+        case node
+        when RKelly::Nodes::FunctionExprNode, RKelly::Nodes::FunctionDeclNode
+          line = find_line(node.range.from, map, lines, node.value)
+          next unless line
+
+          type = :func
+          type = :class if lines[line - 1].include?("class #{node.value}")
+
+          yield :defs, node.value, line_no: line, type: type
+          found[node.value] ||= Set.new
+          found[node.value].add(line)
+
+          next if type == :class
+
+          mapping = map.bsearch(SourceMap::Offset.new(node.range.to.line, node.range.to.char))
+          yield :end, :'}', line_no: mapping.original.line, type: type
+        when RKelly::Nodes::FunctionCallNode
+          name = node_name(node.value)
+          next unless name
+
+          line = find_line(node.range.from, map, lines, name)
+          next unless line
+
+          yield :calls, name, line_no: line
+          found[name] ||= Set.new
+          found[name].add(line)
+        end
+      end
+
+      found
+    end
+
+    def self.extract_var_decls(ast, map, lines, found, &block)
+      ast.each do |node|
+        next unless node.is_a? RKelly::Nodes::VarDeclNode
+
+        line = find_line(node.range.from, map, lines, node.name)
+        next unless line
+
+        next if found[node.name] && found[node.name].include?(line)
+        yield :defs, node.name, line_no: line
+        found[node.name] ||= Set.new
+        found[node.name].add(line)
+      end
+
+      found
+    end
+
+    def self.extract_var_reads(ast, map, lines, found, &block)
+      ast.each do |node|
+        name = node_name(node)
+        next unless name
+
+        line = find_line(node.range.from, map, lines, name)
+        next unless line
+
+        next if found[name] && found[name].include?(line)
+        yield :reads, name, line_no: line
+      end
+    end
+
+    def self.node_name(node)
+      case node
+      when RKelly::Nodes::DotAccessorNode
+        node.accessor
+      when RKelly::Nodes::ResolveNode
+        node.value
+      end
+    end
+
+    def self.find_line(from, map, lines, name)
+      mapping = map.bsearch(SourceMap::Offset.new(from.line, from.char))
+      return unless mapping
+      return unless lines[mapping.original.line - 1].include? name
+      mapping.original.line
+    end
+  end
+end

data/lib/starscope/langs/ruby.rb

@@ -18,8 +18,6 @@ module Starscope::Lang
       extract_tree(ast, [], &block) unless ast.nil?
     end
 
-    private
-
     def self.extract_tree(tree, scope, &block)
       extract_node(tree, scope, &block)
 
@@ -40,45 +38,45 @@ module Starscope::Lang
       case node.type
       when :send
         name = scoped_name(node, scope)
-        yield :calls, name, :line_no => loc.line, :col => loc.column
+        yield :calls, name, line_no: loc.line, col: loc.column
 
-        if name.last.to_s =~ /\w+=$/
+        if name.last =~ /\w+=$/
           name[-1] = name.last.to_s.chop.to_sym
-          yield :assigns, name, :line_no => loc.line, :col => loc.column
+          yield :assigns, name, line_no: loc.line, col: loc.column
         elsif node.children[0].nil? && node.children[1] == :require && node.children[2].type == :str
           yield :requires, node.children[2].children[0].split('/'),
-            :line_no => loc.line, :col => loc.column
+            line_no: loc.line, col: loc.column
         end
 
       when :def
         yield :defs, scope + [node.children[0]],
-          :line_no => loc.line, :type => :func, :col => loc.name.column
-        yield :end, :end, :line_no => loc.end.line, :type => :func, :col => loc.end.column
+          line_no: loc.line, type: :func, col: loc.name.column
+        yield :end, :end, line_no: loc.end.line, type: :func, col: loc.end.column
 
       when :defs
         yield :defs, scope + [node.children[1]],
-          :line_no => loc.line, :type => :func, :col => loc.name.column
-        yield :end, :end, :line_no => loc.end.line, :type => :func, :col => loc.end.column
+          line_no: loc.line, type: :func, col: loc.name.column
+        yield :end, :end, line_no: loc.end.line, type: :func, col: loc.end.column
 
       when :module, :class
         yield :defs, scope + scoped_name(node.children[0], scope),
-          :line_no => loc.line, :type => node.type, :col => loc.name.column
-        yield :end, :end, :line_no => loc.end.line, :type => node.type, :col => loc.end.column
+          line_no: loc.line, type: node.type, col: loc.name.column
+        yield :end, :end, line_no: loc.end.line, type: node.type, col: loc.end.column
 
       when :casgn
         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
+        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
+        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
+        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.name.column
+        yield :reads, scope + [node.children[0]], line_no: loc.line, col: loc.name.column
 
       when :sym
         # handle `:foo` vs `foo: 1`
@@ -87,7 +85,7 @@ module Starscope::Lang
               else
                 loc.expression.column
               end
-        yield :sym, [node.children[0]], :line_no => loc.line, :col => col
+        yield :sym, [node.children[0]], line_no: loc.line, col: col
       end
     end
 

data/lib/starscope/output.rb

@@ -11,9 +11,9 @@ class Starscope::Output
 
   def new_pbar(title, num_items)
     return if @level == :quiet
-    @pbar = ProgressBar.create(:title => title, :total => num_items,
-                               :format => PBAR_FORMAT, :length => 80,
-                               :out => @out)
+    @pbar = ProgressBar.create(title: title, total: num_items,
+                               format: PBAR_FORMAT, length: 80,
+                               out: @out)
   end
 
   def inc_pbar

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
 module Starscope
-  VERSION = '1.4.1'
+  VERSION = '1.5.0'
 end

data/starscope.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.version       = Starscope::VERSION
   gem.summary       = 'Smart code search and indexing'
   gem.description   = <<-EOF
-  Starscope is a code indexer, search and navigation tool for Ruby and Go.
+  Starscope is a code indexer, search and navigation tool for Ruby, Golang, and JavaScript.
   Inspired by the extremely popular Ctags and Cscope utilities, Starscope can
   answer a lot of questions about a lot of code.
   EOF
@@ -17,15 +17,18 @@ Gem::Specification.new do |gem|
   gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   gem.test_files    = `git ls-files -- test/*`.split("\n")
   gem.require_paths = ['lib']
-  gem.required_ruby_version = '>= 1.8.7'
+  gem.required_ruby_version = '>= 1.9.3'
 
   gem.add_dependency 'oj', '~> 2.9'
   gem.add_dependency 'parser', '~> 2.2.2'
   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'
-  gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'mocha'
+  gem.add_dependency 'rkelly-remix', '~> 0.0.7'
+  gem.add_dependency 'babel-transpiler', '~> 0.7'
+  gem.add_dependency 'sourcemap', '~> 0.1'
+
+  gem.add_development_dependency 'bundler', '~> 1.7'
+  gem.add_development_dependency 'rake', '~> 10.4'
+  gem.add_development_dependency 'pry', '~> 0.10.1'
+  gem.add_development_dependency 'minitest', '~> 5.8'
+  gem.add_development_dependency 'mocha', '~> 1.1'
 end

data/test/fixtures/sample_javascript.js

@@ -0,0 +1,117 @@
+/* @flow */
+
+import React from 'react-native';
+
+var {
+  Component,
+  StyleSheet,
+} = React;
+
+var {NavigationBar} = Navigator;
+
+var styles = StyleSheet.create({
+  navigatorBar: {
+    height: NavigationBar.Styles.General.NavBarHeight,
+    justifyContent: 'center',
+    alignItems: 'center',
+  },
+});
+
+var func1 = () => {
+  return 1;
+};
+
+function foo() {
+  return bar;
+}
+
+StatusBarIOS.setStyle(1);
+Router.routes = routes;
+
+class MyStat {
+  static myStatFunc(
+    title
+  ): void {
+  }
+}
+
+var NavigatorRouteMapper = {
+  LeftButton({route}, navigator, index) {
+    if (!index) { return null; } // Nothing below in stack.
+
+    return (
+      <TouchableOpacity onPress={() => navigator.pop()}>
+        <Text style={{color: 'white', fontSize: 12, marginLeft: 1}}>‹</Text>
+      </TouchableOpacity>
+    );
+  },
+
+  RightButton() {
+    return null;
+  },
+};
+
+class Navigation extends Component {
+  constructor(props) {
+    super(props);
+    this.state = {key: 'foo', selectedTab: 'foo'};
+    func1();
+
+  }
+
+  _tabItem(routeName: string, params: Object, badgeCount?: number) : PropTypes.element {
+    var route = routes[routeName];
+
+    var onTabPress = () => {
+      if (this.state.selectedTab === routeName) {
+        if (route === Router.currentRoute) {
+          Router.navigator._currentQueryFetcherRoot.fetchData();
+        } else {
+          Router.popToTop();
+        }
+      } else {
+        this.setState({selectedTab: routeName});
+      }
+    };
+
+    return (
+      <TabBarIOS.Item
+        badge={badgeCount}
+        selected={this.state.selectedTab === routeName}
+        onPress={onTabPress}
+      >
+        <Navigator
+          ref={::this._setCurrentNavigator}
+          navigationBar={
+            <NavigationBar routeMapper={NavigatorRouteMapper} style={{backgroundColor: Branding.pink}} />
+          }
+        />
+
+      </TabBarIOS.Item>
+    );
+  }
+
+  _setCurrentNavigator(nav) {
+    Router.navigator = nav;
+  }
+
+  _renderTabScene({route, params}, nav) {
+    var setRef = (ref) => {
+      nav._currentQueryFetcherRoot = ref;
+    };
+
+    return <QueryFetcherRoot ref={setRef} component={route.component} route={route} params={params} />;
+  }
+
+  render() {
+    return (
+      <TabBarIOS tintColor={Branding.yellow} barTintColor={Branding.green}>
+        {this._tabItem('foo', {})}
+        {this._tabItem('bar', {})}
+        {this._tabItem('baz', {})}
+      </TabBarIOS>
+    );
+  }
+}
+
+export default Navigation;

data/test/fixtures/sample_ruby.rb

@@ -26,7 +26,7 @@ class Starscope::DB
         if format == DB_FORMAT
           @paths  = Oj.load(stream.gets)
           @files  = Oj.load(stream.gets)
-          @tables = Oj.load(stream.gets, :symbol_keys => true)
+          @tables = Oj.load(stream.gets, symbol_keys: true)
         elsif format <= 2
           # Old format (pre-json), so read the directories segment then rebuild
           len = stream.gets.to_i
@@ -59,7 +59,7 @@ class Starscope::DB
     files = paths.map { |p| self.class.files_from_path(p) }.flatten
     return if files.empty?
     if @progress
-      pbar = ProgressBar.create(:title => 'Building', :total => files.length, :format => PBAR_FORMAT, :length => 80)
+      pbar = ProgressBar.create(title: 'Building', total: files.length, format: PBAR_FORMAT, length: 80)
     end
     files.each do |f|
       add_file(f)
@@ -70,7 +70,7 @@ class Starscope::DB
   def update
     new_files = (@paths.map { |p| self.class.files_from_path(p) }.flatten) - @files.keys
     if @progress
-      pbar = ProgressBar.create(:title => 'Updating', :total => new_files.length + @files.length, :format => PBAR_FORMAT, :length => 80)
+      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)
@@ -114,7 +114,7 @@ class Starscope::DB
           if entry[:line_no]
             tmpdb[entry[:file]] ||= {}
             tmpdb[entry[:file]][entry[:line_no]] ||= []
-            tmpdb[entry[:file]][entry[:line_no]] << { :tbl => tbl, :key => key, :entry => entry }
+            tmpdb[entry[:file]][entry[:line_no]] << { tbl: tbl, key: key, entry: entry }
           end
         end
       end

data/test/functional/starscope_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../../test_helper', __FILE__)
+require_relative '../test_helper'
 
 describe 'starscope executable script' do
   BASE = 'bundle exec bin/starscope --quiet'

data/test/test_helper.rb

@@ -1,11 +1,12 @@
 require 'minitest/autorun'
 require 'minitest/pride'
 require 'mocha/mini_test'
-require File.expand_path('../../lib/starscope.rb', __FILE__)
+require_relative '../lib/starscope'
 
 FIXTURES = 'test/fixtures'
 
 GOLANG_SAMPLE = "#{FIXTURES}/sample_golang.go"
+JAVASCRIPT_EXAMPLE = "#{FIXTURES}/sample_javascript.js"
 RUBY_SAMPLE = "#{FIXTURES}/sample_ruby.rb"
 ERB_SAMPLE = "#{FIXTURES}/sample_erb.erb"
 EMPTY_FILE = "#{FIXTURES}/empty"

data/test/unit/db_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../../test_helper', __FILE__)
+require_relative '../test_helper'
 require 'tempfile'
 
 describe Starscope::DB do
@@ -144,7 +144,7 @@ describe Starscope::DB do
   it 'must run queries on multiple tables' do
     @db.add_paths([FIXTURES])
     ret = @db.query([:calls, :defs], 'foo')
-    ret.length.must_equal 3
+    ret.length.must_equal 4
     ret.first[:name].last.must_equal :foo
   end
 
@@ -161,7 +161,7 @@ describe Starscope::DB do
   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, File.read(GOLANG_SAMPLE)).returns(:a => 1)
+    extractor.expects(:extract).with(GOLANG_SAMPLE, File.read(GOLANG_SAMPLE)).returns(a: 1)
     extractor.expects(:name).returns('Foo')
     EXTRACTORS.stubs(:each).yields(extractor)
 

data/test/unit/exportable_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../../test_helper', __FILE__)
+require_relative '../test_helper'
 
 describe Starscope::Exportable do
   before do
@@ -10,14 +10,14 @@ describe Starscope::Exportable do
   it 'must export to ctags' do
     @db.export_to(:ctags, @buf)
     @buf.rewind
-    lines = @buf.lines.to_a
+    lines = @buf.each_line.to_a
     lines.must_include "NoTableError\t#{FIXTURES}/sample_ruby.rb\t/^  class NoTableError < StandardError; end$/;\"\tkind:c\tlanguage:Ruby\n"
   end
 
   it 'must export to cscope' do
     @db.export_to(:cscope, @buf)
     @buf.rewind
-    lines = @buf.lines.to_a
+    lines = @buf.each_line.to_a
 
     lines.must_include "\t@#{FIXTURES}/sample_golang.go\n"
     lines.must_include "\tgSunday\n"