starscope 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0034f945269abf5a562e9ac393621ef5ab6dfed0
-  data.tar.gz: 772a237027e861ea5a76c3e87a891fe9cc45b825
+  metadata.gz: bf0545d7e2a35d02175c24c5ad16941d6fa61237
+  data.tar.gz: ff40e8a9c02faa7fc77d48c83b99b2fbc3e1ec2c
 SHA512:
-  metadata.gz: 68a111fe637ba4a2e0307f04d5fec574bf3fca41ad9eee91cba1f1fe07cdaa36cc18ed953a29702a0dff4c4435cdb45b8b4a0ff06a1a39702aa8136bb9b04c27
-  data.tar.gz: fb56e7e538076c94866cd6d10b427919ed91ec50fba6f4d3692b30bbcd1e56eee004f4caba8eb64c832d8e490f67faaae3b9d3498fb951fbdb2613d662ff1327
+  metadata.gz: e77b085891ca912792487ef07a6aeaaabc7ec5a94193879b62877f1729c2f205265d30c2eee3f12ba2272b69181f68025e55ed84767b12b506fc448aea83c9c8
+  data.tar.gz: bf3c86d110ec7c87e2d0393b3e06f8e87b4bf62ba860a4183c857d8ad082a3a047acccdf5d9453000a8762f7b404d59cbdbe766837c66ab5e41c527827396142

data/.rubocop.yml

@@ -4,12 +4,12 @@ Lint/UnusedBlockArgument:
 Lint/UnusedMethodArgument:
   Enabled: false
 
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
 Metrics/AbcSize:
   Enabled: false
 
+Metrics/BlockNesting:
+  Enabled: false
+
 Metrics/ClassLength:
   Enabled: false
 
@@ -22,8 +22,24 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/ModuleLength:
+  Enabled: false
+
 Metrics/PerceivedComplexity:
   Enabled: false
 
+Style/ClassAndModuleChildren:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/Next:
+  Exclude:
+    - 'test/fixtures/sample_ruby.rb'
+
+Style/SpecialGlobalVars:
+  Enabled: false

data/.travis.yml

@@ -4,5 +4,6 @@ sudo: false
 rvm:
     - 1.8.7
     - 1.9.3
-    - 2.0.0
-    - 2.1.5
+    - 2.0
+    - 2.1
+    - 2.2

data/CHANGELOG.md

@@ -1,7 +1,15 @@
 Changelog
 =========
 
-v1.4.0 (trunk)
+v1.4.1 (trunk)
+--------------------
+
+Misc:
+ * Minor code style cleanups and documentation improvements.
+ * Bumped a few dependencies.
+ * Official support for ruby 2.2 although it already worked.
+
+v1.4.0 (2015-06-19)
 --------------------
 
 New Features:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    starscope (1.4.0)
+    starscope (1.4.1)
       backports (~> 3.6)
       oj (~> 2.9)
       parser (~> 2.2.2)
@@ -10,16 +10,16 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.0.0)
-    backports (3.6.4)
+    ast (2.1.0)
+    backports (3.6.6)
     coderay (1.1.0)
     metaclass (0.0.4)
     method_source (0.8.2)
-    minitest (5.7.0)
+    minitest (5.8.0)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
-    oj (2.12.9)
-    parser (2.2.2.5)
+    oj (2.12.13)
+    parser (2.2.2.6)
       ast (>= 1.1, < 3.0)
     pry (0.10.1)
       coderay (~> 1.1.0)

data/README.md

@@ -1,18 +1,32 @@
 Starscope
 =========
 
-[![Gem Version](https://badge.fury.io/rb/starscope.svg)](http://badge.fury.io/rb/starscope)
+[![Gem Version](https://img.shields.io/gem/v/starscope.svg)](https://rubygems.org/gems/starscope)
 [![Build Status](https://travis-ci.org/eapache/starscope.svg?branch=master)](https://travis-ci.org/eapache/starscope)
 [![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-active-blue.svg)](https://eapache.github.io/conduct.html)
 
-Anyone who has done much programming in C (or C++) on a Unix-based OS has come
-across the fantastic [Cscope](http://cscope.sourceforge.net/) tool. Sadly, it
-only works for C (and sort of works for C++).
+Starscope is a code indexer, search and navigation tool for
+[Ruby](https://www.ruby-lang.org/) and [Golang](https://golang.org/), with a
+design intended to make it easy to add
+[support for other languages](doc/LANGUAGE_SUPPORT.md).
 
-Starscope is a similar tool for [Ruby](https://www.ruby-lang.org/) and
-[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).
+Inspired by the extremely popular [Ctags](https://en.wikipedia.org/wiki/Ctags)
+and [Cscope](http://cscope.sourceforge.net/) utilities, Starscope can answer a
+lot of questions about your code. It can tell you:
+ - where methods are defined
+ - where methods are called
+ - where variables are assigned
+ - where symbols are used
+ - where files and libraries are imported or required
+
+While Ctags already supports Ruby and Go, it can only tell you where things are
+defined. Cscope can answer a lot more of your questions, but it is limited to
+just the C language family. Starscope was written to combine the power of
+Cscope with the flexibility of Ctags, bringing full code indexing to as many
+developers as possible.
+
+Quick Start
+-----------
 
 Install it as a gem:
 ```
@@ -40,9 +54,9 @@ More Documentation
 ------------------
 
  * [User Guide](doc/USER_GUIDE.md)
- * [Database Format](doc/DB_FORMAT.md)
- * [Language Support](doc/LANGUAGE_SUPPORT.md)
  * [Version History](CHANGELOG.md)
+ * [Language Support](doc/LANGUAGE_SUPPORT.md)
+ * [Database Format](doc/DB_FORMAT.md)
 
 Other Uses
 ----------

data/bin/starscope

@@ -251,7 +251,7 @@ end
 if options[:linemode]
   puts "Run your query as 'TABLE QUERY' or run '!help' for more information."
   begin
-    while input = Readline.readline('> ', true)
+    while (input = Readline.readline('> ', true))
       next if input.empty?
       cmd, param = input.split(' ', 2)
       if cmd[0] == '!'
@@ -284,5 +284,7 @@ if options[:linemode]
       end
     end
   rescue Interrupt
+    # just exit
+    return
   end
 end

data/lib/starscope/exportable.rb

@@ -134,7 +134,7 @@ END
     buf << "\t@\n"
 
     header = "cscope 15 #{Dir.pwd} -c "
-    offset = "%010d\n" % (header.length + 11 + buf.bytes.count)
+    offset = format("%010d\n", header.length + 11 + buf.bytes.count)
 
     file.print(header)
     file.print(offset)
@@ -208,11 +208,11 @@ END
         index = line.index(key, index + 1)
       end
 
-      if index && index + key.length < offset
-        buf << cscope_plaintext(line, prev, index) << "\n"
-        buf << "#{key}\n"
-        prev = index + key.length
-      end
+      next unless index && index + key.length < offset
+
+      buf << cscope_plaintext(line, prev, index) << "\n"
+      buf << "#{key}\n"
+      prev = index + key.length
     end
 
     buf << cscope_plaintext(line, prev, offset) << "\n"

data/lib/starscope/langs/erb.rb

@@ -26,19 +26,19 @@ module Starscope::Lang
           end
         end
 
-        unless multiline
-          line.scan(/#{ERB_START}(.*?)#{ERB_END}/) do |match|
-            yield FRAGMENT, :Ruby, :frag => match[0], :line_no => line_no
-          end
-
-          line.gsub!(/<%.*?%>/, '')
+        next if multiline
 
-          match = /#{ERB_START}(.*)$/.match(line)
-          if match
-            yield FRAGMENT, :Ruby, :frag => match[1], :line_no => line_no
-            multiline = true
-          end
+        line.scan(/#{ERB_START}(.*?)#{ERB_END}/) do |match|
+          yield FRAGMENT, :Ruby, :frag => match[0], :line_no => line_no
         end
+
+        line.gsub!(/<%.*?%>/, '')
+
+        match = /#{ERB_START}(.*)$/.match(line)
+        next unless match
+
+        yield FRAGMENT, :Ruby, :frag => match[1], :line_no => line_no
+        multiline = true
       end
     end
   end

data/lib/starscope/langs/go.rb

@@ -41,7 +41,7 @@ module Starscope::Lang
         if stack[-1] != :import && !line.start_with?('import')
           # strip string literals like "foo" unless they're part of an import
           pos = 0
-          while match = STRING_LITERAL.match(line[pos..-1])
+          while (match = STRING_LITERAL.match(line[pos..-1]))
             eos = find_end_of_string(line, match.begin(0))
             line = line[0..match.begin(0)] + line[eos..-1]
             pos += match.begin(0) + 2

data/lib/starscope/matcher.rb

@@ -9,6 +9,7 @@ module Starscope
         @regexp = Regexp.new(@query, Regexp::IGNORECASE)
       rescue RegexpError
         # not a regex, oh well
+        return
       end
     end
 

data/lib/starscope/output.rb

@@ -10,11 +10,10 @@ class Starscope::Output
   end
 
   def new_pbar(title, num_items)
-    if @level != :quiet
-      @pbar = ProgressBar.create(:title => title, :total => num_items,
-                                 :format => PBAR_FORMAT, :length => 80,
-                                 :out => @out)
-    end
+    return if @level == :quiet
+    @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.0'
+  VERSION = '1.4.1'
 end

data/starscope.gemspec

@@ -3,8 +3,12 @@ require File.expand_path('../lib/starscope/version.rb', __FILE__)
 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, golang and other languages'
+  gem.summary       = 'Smart code search and indexing'
+  gem.description   = <<-EOF
+  Starscope is a code indexer, search and navigation tool for Ruby and Go.
+  Inspired by the extremely popular Ctags and Cscope utilities, Starscope can
+  answer a lot of questions about a lot of code.
+  EOF
   gem.authors       = ['Evan Huus']
   gem.homepage      = 'https://github.com/eapache/starscope'
   gem.email         = 'eapache@gmail.com'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: starscope
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Evan Huus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -136,7 +136,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A tool like the venerable cscope, but for ruby, golang and other languages
+description: |2
+    Starscope is a code indexer, search and navigation tool for Ruby and Go.
+    Inspired by the extremely popular Ctags and Cscope utilities, Starscope can
+    answer a lot of questions about a lot of code.
 email: eapache@gmail.com
 executables:
 - starscope
@@ -210,10 +213,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A code indexer and analyzer
+summary: Smart code search and indexing
 test_files:
 - test/fixtures/db_added_files.json
 - test/fixtures/db_missing_language.json