starscope 1.0.2 → 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38376cc70ae8d935176b3b428d6b82acb2e9ed28
+  data.tar.gz: eb7761acf9adc1aef79eaf1e2e74b04d7be51ca2
+SHA512:
+  metadata.gz: b2df9c55e2e0ca2ab3c0aeb825f7a9e9f3dec274216256a9e712eb60ea3176c4851925799b5621220fa59eca32ff67ba5813699eec056aa285840397f91775db
+  data.tar.gz: c5159b4997e35cd23f29ffee1a17da99e298dcdb7a02789a5b64435cd645e1af56788c5666c1ef5ac3dccfd5fdc250e48c62e7c170a8aaf71009e62138590d19

data/CHANGELOG.md

@@ -1,7 +1,16 @@
 Changelog
 =========
 
-v1.0.2 (trunk)
+v1.0.3 (trunk)
+--------------------
+
+Improvements:
+ * Optimized extracting lines from parsed files.
+
+Misc:
+ * Code cleanup.
+
+v1.0.2 (2014-04-19)
 --------------------
 
 Bug Fixes:

data/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: .
   specs:
-    starscope (1.0.2)
-      oj (~> 2.7)
+    starscope (1.0.3)
+      oj (~> 2.9)
       parser (~> 2.1)
-      ruby-progressbar (~> 1.4)
+      ruby-progressbar (~> 1.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (1.1.0)
+    ast (2.0.0)
     coderay (1.1.0)
     method_source (0.8.2)
-    minitest (5.3.3)
-    oj (2.7.3)
-    parser (2.1.8)
-      ast (~> 1.1)
+    minitest (5.3.4)
+    oj (2.9.4)
+    parser (2.1.9)
+      ast (>= 1.1, < 3.0)
       slop (~> 3.4, >= 3.4.5)
     pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
-    rake (10.2.2)
-    ruby-progressbar (1.4.2)
+    rake (10.3.2)
+    ruby-progressbar (1.5.1)
     slop (3.5.0)
 
 PLATFORMS

data/README.md

@@ -35,6 +35,8 @@ $ starscope -e ctags
 $ starscope -e cscope
 ```
 
+More flags and options are available, run `starscope --help` for the complete list.
+
 Other Uses
 ----------
 

data/lib/starscope/db.rb

@@ -35,20 +35,20 @@ class StarScope::DB
     @output.log("Reading database from `#{file}`... ")
     File.open(file, 'r') do |file|
       Zlib::GzipReader.wrap(file) do |file|
-        format = file.gets.to_i
-        if format == DB_FORMAT
+        case file.gets.to_i
+        when DB_FORMAT
           @meta   = Oj.load(file.gets)
           @tables = Oj.load(file.gets)
           return false
-        elsif format <= 2
+        when 3..4
+          # Old format, so read the directories segment then rebuild
+          add_paths(Oj.load(file.gets))
+          return true
+        when 0..2
           # Old format (pre-json), so read the directories segment then rebuild
           len = file.gets.to_i
           add_paths(Marshal::load(file.read(len)))
           return true
-        elsif format <= 4
-          # Old format, so read the directories segment then rebuild
-          add_paths(Oj.load(file.gets))
-          return true
         else
           raise UnknownDBFormatError
         end
@@ -190,10 +190,11 @@ END
     buf = ""
     files = []
     db_by_line().each do |filename, lines|
-      if not lines.empty?
-        buf << "\t@#{filename}\n\n"
-        files << filename
-      end
+      next if lines.empty?
+
+      buf << "\t@#{filename}\n\n"
+      files << filename
+
       lines.sort.each do |line_no, records|
         begin
           line = records.first[:line].strip.gsub(/\s+/, ' ')
@@ -201,25 +202,25 @@ END
           # invalid utf-8 byte sequence in the line, just do our best
           line = records.first[:line]
         end
-        toks = {}
 
+        toks = {}
         records.each do |record|
-          index = line.index(record[:name][-1].to_s)
+          key = record[:name][-1].to_s
+          index = line.index(key)
           while index
             toks[index] = record
-            index = line.index(record[:name][-1].to_s, index + 1)
+            index = line.index(key, index + 1)
           end
         end
-
         next if toks.empty?
 
         prev = 0
         buf << line_no.to_s << " "
-        toks.sort().each do |offset, record|
+        toks.sort.each do |offset, record|
+          key = record[:name][-1].to_s
           buf << line.slice(prev...offset) << "\n"
-          buf << StarScope::Record.cscope_mark(record[:tbl], record)
-          buf << record[:name][-1].to_s << "\n"
-          prev = offset + record[:name][-1].to_s.length
+          buf << StarScope::Record.cscope_mark(record[:tbl], record) << key << "\n"
+          prev = offset + key.length
         end
         buf << line.slice(prev..-1) << "\n\n"
       end

data/lib/starscope/langs/go.rb

@@ -18,51 +18,39 @@ module StarScope::Lang
       scope = []
       str = File.readlines(file).each_with_index do |line, line_no|
         line_no += 1 # zero-index to one-index
+
         # strip single-line comments like // foo
         match = /(.*)\/\//.match(line)
-        if match
-          line = match[1]
-        end
+        line = match[1] if match
         # strip single-line comments like foo /* foo */ foo
         match = /(.*?)\/\*.*\*\/(.*)/.match(line)
-        if match
-          line = match[1] + match[2]
-        end
+        line = match[1] + match[2] if match
         # strip end-of-line comment starters like foo /* foo \n
         match = /(.*?)\/\*/.match(line)
-        if match
-          line = match[1]
-          ends_with_comment = true
-        else
-          ends_with_comment = false
-        end
+        line = match[1] if match
+        ends_with_comment = !match.nil?
+
         # if we're in a block comment, wait for it to end
         if stack[-1] == :comment
           match = /\*\/(.*)/.match(line)
-          if match
-            line = match[1]
-            stack.pop
-          else
-            next
-          end
+          next unless match
+          line = match[1]
+          stack.pop
         end
+
         # poor-man's parser
         case stack[-1]
         when :struct
           case line
           when END_OF_BLOCK
-            yield :end, scope + ["}"], :line_no => line_no, :type => :class
-            stack.pop
-            scope.pop
+            end_block(line_no, scope, stack, &block)
           when /(.+)\s+\w+/
             parse_def($1, line_no, scope, &block)
           end
         when :interface
           case line
           when END_OF_BLOCK
-            yield :end, scope + ["}"], :line_no => line_no, :type => :class
-            stack.pop
-            scope.pop
+            end_block(line_no, scope, stack, &block)
           when /(\w+)\(.*\)\s+/
             yield :defs, scope + [$1], :line_no => line_no
           end
@@ -83,60 +71,18 @@ module StarScope::Lang
             name = $1.split('/')
             yield :imports, name, :line_no => line_no
           end
-        else
-          if stack[-1] == :func and /^\}/ =~ line
+        when :func
+          case line
+          when /^\}/
             yield :end, "}", :line_no => line_no, :type => :func
             stack.pop
-          end
-          case line
-          when /^func\s+(\w+)\(/
-            yield :defs, scope + [$1], :line_no => line_no, :type => :func
-            stack.push(:func)
-          when /^func\s+\(\w+\s+\*?(\w+)\)\s*(\w+)\(/
-            yield :defs, scope + [$1, $2], :line_no => line_no, :type => :func
-            stack.push(:func)
-          when /^package\s+(\w+)/
-            scope.push($1)
-            yield :defs, scope, :line_no => line_no, :type => :package
-          when /^type\s+(\w+)\s+struct\s*\{/
-            scope.push($1)
-            stack.push(:struct)
-            yield :defs, scope, :line_no => line_no, :type => :class
-          when /^type\s+(\w+)\s+interface\s*\{/
-            scope.push($1)
-            stack.push(:interface)
-            yield :defs, scope, :line_no => line_no, :type => :class
-          when /^type\s+(\w+)/
-            yield :defs, scope + [$1], :line_no => line_no, :type => :type
-          when /^import\s+"(.+)"/
-            name = $1.split('/')
-            yield :imports, name, :line_no => line_no
-          when /^import\s+\(/
-            stack.push(:import)
-          when /^var\s+\(/
-            stack.push(:def)
-          when /^var\s+(\w+)\s/
-            yield :defs, scope + [$1], :line_no => line_no
-          when /^const\s+\(/
-            stack.push(:def)
-          when /^const\s+(\w+)\s/
-            yield :defs, scope + [$1], :line_no => line_no
-          when /^\s+(.*?) :?=[^=]/
-            $1.split(' ').each do |var|
-              next if CONTROL_KEYS.include?(var)
-              name = var.delete(',').split('.')
-              next if name[0] == "_" # assigning to _ is a discard in golang
-              if name.length == 1
-                yield :assigns, scope + [name[0]], :line_no => line_no
-              else
-                yield :assigns, name, :line_no => line_no
-              end
-            end
-            parse_call(line, line_no, scope, &block)
           else
-            parse_call(line, line_no, scope, &block)
+            parse_new_line(line, line_no, scope, stack, &block)
           end
+        else
+          parse_new_line(line, line_no, scope, stack, &block)
         end
+
         # if the line looks like "foo /* foo" then we enter the comment state
         # after parsing the usable part of the line
         if ends_with_comment
@@ -145,6 +91,58 @@ module StarScope::Lang
       end
     end
 
+    # handles new lines (when not in the middle of an existing definition)
+    def self.parse_new_line(line, line_no, scope, stack, &block)
+      case line
+      when /^func\s+(\w+)\(/
+        yield :defs, scope + [$1], :line_no => line_no, :type => :func
+        stack.push(:func)
+      when /^func\s+\(\w+\s+\*?(\w+)\)\s*(\w+)\(/
+        yield :defs, scope + [$1, $2], :line_no => line_no, :type => :func
+        stack.push(:func)
+      when /^package\s+(\w+)/
+        scope.push($1)
+        yield :defs, scope, :line_no => line_no, :type => :package
+      when /^type\s+(\w+)\s+struct\s*\{/
+        scope.push($1)
+        stack.push(:struct)
+        yield :defs, scope, :line_no => line_no, :type => :class
+      when /^type\s+(\w+)\s+interface\s*\{/
+        scope.push($1)
+        stack.push(:interface)
+        yield :defs, scope, :line_no => line_no, :type => :class
+      when /^type\s+(\w+)/
+        yield :defs, scope + [$1], :line_no => line_no, :type => :type
+      when /^import\s+"(.+)"/
+        name = $1.split('/')
+        yield :imports, name, :line_no => line_no
+      when /^import\s+\(/
+        stack.push(:import)
+      when /^var\s+\(/
+        stack.push(:def)
+      when /^var\s+(\w+)\s/
+        yield :defs, scope + [$1], :line_no => line_no
+      when /^const\s+\(/
+        stack.push(:def)
+      when /^const\s+(\w+)\s/
+        yield :defs, scope + [$1], :line_no => line_no
+      when /^\s+(.*?) :?=[^=]/
+        $1.split(' ').each do |var|
+          next if CONTROL_KEYS.include?(var)
+          name = var.delete(',').split('.')
+          next if name[0] == "_" # assigning to _ is a discard in golang
+          if name.length == 1
+            yield :assigns, scope + [name[0]], :line_no => line_no
+          else
+            yield :assigns, name, :line_no => line_no
+          end
+        end
+        parse_call(line, line_no, scope, &block)
+      else
+        parse_call(line, line_no, scope, &block)
+      end
+    end
+
     def self.parse_call(line, line_no, scope)
       line.scan(FUNC_CALL) do |match|
         name = match[0].split('.').select {|chunk| not chunk.empty?}
@@ -171,5 +169,11 @@ module StarScope::Lang
         break if not var.end_with?(',')
       end
     end
+
+    def self.end_block(line_no, scope, stack)
+      yield :end, scope + ["}"], :line_no => line_no, :type => :class
+      stack.pop
+      scope.pop
+    end
   end
 end

data/lib/starscope/langs/ruby.rb

@@ -51,32 +51,38 @@ module StarScope::Lang
       end
 
       def extract_node(node)
+        loc = node.location
+
         case node.type
         when :send
-          fqn = scoped_name(node)
-          yield :calls, fqn, :line_no => node.location.expression.line
+          yield :calls, scoped_name(node), :line_no => loc.expression.line
           if node.children[0].nil? and node.children[1] == :require and node.children[2].type == :str
-            fqn = node.children[2].children[0].split("/")
-            yield :requires, fqn, :line_no => node.location.expression.line
+            yield :requires, node.children[2].children[0].split("/"),
+              :line_no => loc.expression.line
           end
+
         when :def
           yield :defs, @scope + [node.children[0]],
-            :line_no => node.location.expression.line, :type => :func
-          yield :end, :end, :line_no => node.location.end.line, :type => :func
+            :line_no => loc.expression.line, :type => :func
+          yield :end, :end, :line_no => loc.end.line, :type => :func
+
         when :defs
           yield :defs, @scope + [node.children[1]],
-            :line_no => node.location.expression.line, :type => :func
-          yield :end, :end, :line_no => node.location.end.line, :type => :func
+            :line_no => loc.expression.line, :type => :func
+          yield :end, :end, :line_no => loc.end.line, :type => :func
+
         when :module, :class
-          fqn = @scope + scoped_name(node.children[0])
-          yield :defs, fqn, :line_no => node.location.expression.line, :type => node.type
-          yield :end, :end, :line_no => node.location.end.line, :type => node.type
+          yield :defs, @scope + scoped_name(node.children[0]),
+            :line_no => loc.expression.line, :type => node.type
+          yield :end, :end, :line_no => loc.end.line, :type => node.type
+
         when :casgn
           fqn = scoped_name(node)
-          yield :assigns, fqn, :line_no => node.location.expression.line
-          yield :defs, fqn, :line_no => node.location.expression.line
+          yield :assigns, fqn, :line_no => loc.expression.line
+          yield :defs, fqn, :line_no => loc.expression.line
+
         when :lvasgn, :ivasgn, :cvasgn, :gvasgn
-          yield :assigns, @scope + [node.children[0]], :line_no => node.location.expression.line
+          yield :assigns, @scope + [node.children[0]], :line_no => loc.expression.line
         end
       end
 

data/lib/starscope/record.rb

@@ -1,5 +1,8 @@
 class StarScope::Record
 
+  @@cachedFile = nil
+  @@cachedLines = nil
+
   def self.build(file, name, args)
     args[:file] = file
 
@@ -10,7 +13,12 @@ class StarScope::Record
     end
 
     if args[:line_no]
-      args[:line] = File.readlines(file)[args[:line_no]-1].chomp
+      if @@cachedFile != file
+        @@cachedFile = file
+        @@cachedLines = File.readlines(file)
+      end
+
+      args[:line] = @@cachedLines[args[:line_no]-1].chomp
     end
 
     args

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
 module StarScope
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/starscope.gemspec

@@ -15,9 +15,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.required_ruby_version = '>= 1.8.7'
 
-  gem.add_dependency 'oj', '~> 2.7'
+  gem.add_dependency 'oj', '~> 2.9'
   gem.add_dependency 'parser', '~> 2.1'
-  gem.add_dependency 'ruby-progressbar', '~> 1.4'
+  gem.add_dependency 'ruby-progressbar', '~> 1.5'
   gem.add_development_dependency 'bundler', '~> 1.5'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'pry'

data/test/lib/test_record.rb

@@ -13,8 +13,23 @@ describe StarScope::Record do
   end
 
   it "must read correct line from file" do
+
+    # we interleave the files here to test the cache
+
     rec = StarScope::Record.build(GOLANG_SAMPLE, :a, {:line_no => 1})
     rec[:line].must_equal "package main"
+
+    rec = StarScope::Record.build(GOLANG_SAMPLE, :a, {:line_no => 62})
+    rec[:line].must_equal "\tfmt.Println(t)"
+
+    rec = StarScope::Record.build(RUBY_SAMPLE, :a, {:line_no => 1})
+    rec[:line].must_equal "require 'date'"
+
+    rec = StarScope::Record.build(RUBY_SAMPLE, :a, {:line_no => 163})
+    rec[:line].must_equal "end"
+
+    rec = StarScope::Record.build(GOLANG_SAMPLE, :a, {:line_no => 63})
+    rec[:line].must_equal "}"
   end
 
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: starscope
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-  prerelease: 
+  version: 1.0.3
 platform: ruby
 authors:
 - Evan Huus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-19 00:00:00.000000000 Z
+date: 2014-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,23 +41,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,49 +69,43 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A tool like the venerable cscope, but for ruby, golang and other languages
@@ -163,30 +148,26 @@ files:
 homepage: https://github.com/eapache/starscope
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2115433325249412524
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A code indexer and analyzer
 test_files:
 - test/files/db_old.json.gz