starscope 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d71f7d9d5748e9df63987f08669e56866a5669a7877a5b78bec7274ae6b11e3b
-  data.tar.gz: a037cc0b16644f69a37c1d9a00f076a036353cb84cbcaef39e17f864af2c70eb
+  metadata.gz: b664cd1fd9107436e9a2bf94a21c00249ed8970b905b34c8649eba4cca7336c7
+  data.tar.gz: 39aa4d99d25f820db321b1c5b58d9e8662ed45812a8636c047df52f25a9d38b1
 SHA512:
-  metadata.gz: 85d4390356102ec0dfc658fa99bb8816a197f48f990abe56fd5b1df7ac85d3d1ffdd93666ca463ca9c42a362ae81a369cc81fa700c83729a9e73a9ba1e431730
-  data.tar.gz: 6cb4cc84d760ba1e5114f2401878e9312eff5e1b7d30ae7b3c4feec10a76c0f87f1f3d00de59417aee8e5e57aa2eb9744ae6a851303b964d9b8edaf8fcec3dad
+  metadata.gz: 1fb43999baa94336ac2265045f0e7a06e18070d2199489bdc489155bc9baf03b9541922c8a9791b6d3a9578cda6cd2a75d20076a73b86d0d9481d2ae9659da05
+  data.tar.gz: a9ee933fffe03daf2b50f017499b188da833305da02012283823c771c5daa10e7c9a293486925f30afde29342e192a5bfbd1606ced1c8f20e848741eac839f27

data/.github/workflows/ruby-ci.yml

@@ -2,9 +2,9 @@ name: Ruby CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .starscope.db
 .bundle
+.byebug_history
 .config
 Gemfile.lock
 coverage

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 Changelog
 =========
 
+v1.6.1 (2022-08-07)
+-------------------
+
+* Support for extracting javascript blocks from vue files.
+* Print a newline when exiting from line-mode via interrupt.
+* Support for Ruby 3.x "def foo = ..." method syntax (#192).
+* Don't generate conflicting `read` and `defs` entries for class and module
+  definitions (#176).
+
 v1.6.0 (2022-02-10)
 -------------------
 

data/bin/starscope

@@ -298,6 +298,7 @@ if options[:linemode]
       end
     end
   rescue Interrupt
+    puts
     exit
   end
 end

data/lib/starscope/langs/ruby.rb

@@ -1,4 +1,4 @@
-require 'parser/current'
+require 'parser/ruby31'
 
 module Starscope
   module Lang
@@ -29,7 +29,7 @@ module Starscope
         buffer = Parser::Source::Buffer.new(path, 1)
         buffer.source = contents.force_encoding(Encoding::UTF_8)
 
-        parser = Parser::CurrentRuby.new(Builder.new)
+        parser = Parser::Ruby31.new(Builder.new)
         parser.diagnostics.ignore_warnings = true
         parser.diagnostics.all_errors_are_fatal = false
 
@@ -41,12 +41,15 @@ module Starscope
         extract_node(tree, scope, &block)
 
         new_scope = []
+        child_nodes = tree.children
+
         if %i[class module].include? tree.type
           new_scope = scoped_name(tree.children[0], scope)
           scope += new_scope
+          child_nodes = child_nodes[1..] # module and class constant definitions are not "read"s
         end
 
-        tree.children.each { |node| extract_tree(node, scope, &block) if node.is_a? AST::Node }
+        child_nodes.each { |node| extract_tree(node, scope, &block) if node.is_a? AST::Node }
 
         scope.pop(new_scope.count)
       end
@@ -70,7 +73,12 @@ module Starscope
         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
+          if loc.end
+            yield :end, :end, line_no: loc.end.line, type: :func, col: loc.end.column
+          else
+            # ruby 3.x syntax for "def foo = ..."
+            yield :end, :end, line_no: loc.line, type: :func, col: loc.expression.end.column
+          end
 
         when :defs
           yield :defs, scope + [node.children[1]],

data/lib/starscope/langs/vue.rb

@@ -0,0 +1,32 @@
+module Starscope
+  module Lang
+    module Vue
+      VERSION = 1
+
+      SCRIPT_START = '<script>'.freeze
+      SCRIPT_END = '</script>'.freeze
+
+      def self.match_file(name)
+        name.end_with?('.vue')
+      end
+
+      def self.extract(_path, contents)
+        in_script = false
+
+        contents.lines.each_with_index do |line, line_no|
+          line_no += 1 # zero-index to one-index
+
+          if in_script
+            if line.strip == SCRIPT_END
+              in_script = false
+            else
+              yield Starscope::DB::FRAGMENT, :Javascript, frag: line, line_no: line_no
+            end
+          elsif line.strip == SCRIPT_START
+            in_script = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/starscope/version.rb

@@ -1,3 +1,3 @@
 module Starscope
-  VERSION = '1.6.0'.freeze
+  VERSION = '1.6.1'.freeze
 end

data/starscope.gemspec

@@ -27,9 +27,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'sourcemap', '~> 0.1'
 
   gem.add_development_dependency 'bundler', '>= 1.7'
+  gem.add_development_dependency 'byebug', '~> 11.1'
   gem.add_development_dependency 'minitest', '~> 5.12'
   gem.add_development_dependency 'mocha', '~> 1.3'
-  gem.add_development_dependency 'pry', '~> 0.11'
   gem.add_development_dependency 'rake', '~> 13.0'
   gem.add_development_dependency 'rubocop', '~> 1.25.0'
   gem.add_development_dependency 'rubocop-minitest', '~> 0.17.1'

data/test/fixtures/sample_ruby.rb

@@ -164,3 +164,6 @@ class Starscope::DB
 end
 
 puts __ENCODING__
+
+# Ruby 3.x syntax
+def get_lastfile(dirpath) = Dir.glob("#{ dirpath }/*").reject { |i| File.directory?(i) }.sort.last

data/test/fixtures/sample_vue.vue

@@ -0,0 +1,48 @@
+<template>
+  <div class="container">
+    <span>
+      <a
+        href="https://www.markdownguide.org/cheat-sheet/"
+        target="_blank"
+        style="padding-left: 6px; padding-bottom: 0px;"
+      >Markdown </a>
+      {{ descriptionLinkingVerb }} supported.
+    </span>
+  </div>
+</template>
+
+<script>
+import marked from 'marked';
+
+export default {
+  props: {
+    placeholderText: {
+      type: String,
+      default: 'This field supports Markdown. Try it out!'
+    }
+  },
+  computed: {
+    markdown() {
+      return marked(this.value || '');
+    }
+  },
+  methods: {
+    handleChange(e) {
+      this.$emit('change', e.target.value);
+    }
+  }
+}
+</script>
+
+<style scoped>
+@import "../shared/style.css";
+</style>
+
+<style>
+.container {
+  overflow: auto;
+  padding: 5px;
+  border-radius: 5px;
+}
+
+</style>

data/test/functional/starscope_test.rb

@@ -23,8 +23,9 @@ describe 'starscope executable script' do
     lines = `#{EXTRACT} -d requires`.lines.to_a
     _(lines[1].split.first).must_equal 'date'
     _(lines[2].split.first).must_equal 'foo-bar'
-    _(lines[3].split.first).must_equal 'react-native'
-    _(lines[4].split.first).must_equal 'zlib'
+    _(lines[3].split.first).must_equal 'marked'
+    _(lines[4].split.first).must_equal 'react-native'
+    _(lines[5].split.first).must_equal 'zlib'
   end
 
   it 'must correctly query the database' do

data/test/test_helper.rb

@@ -9,4 +9,5 @@ GOLANG_SAMPLE = "#{FIXTURES}/sample_golang.go".freeze
 JAVASCRIPT_EXAMPLE = "#{FIXTURES}/sample_javascript.js".freeze
 RUBY_SAMPLE = "#{FIXTURES}/sample_ruby.rb".freeze
 ERB_SAMPLE = "#{FIXTURES}/sample_erb.erb".freeze
+VUE_SAMPLE = "#{FIXTURES}/sample_vue.vue".freeze
 EMPTY_FILE = "#{FIXTURES}/empty".freeze

data/test/unit/langs/ruby_test.rb

@@ -28,15 +28,20 @@ describe Starscope::Lang::Ruby do
     _(defs).must_include :load
     _(defs).must_include :update
     _(defs).must_include :files_from_path
+    _(defs).must_include :get_lastfile
   end
 
   it 'must identify constant definitions' do
-    _(@db[:defs].map { |x| x[:name][-1] }).must_include :PBAR_FORMAT
+    _(@db.keys).must_include :defs
+    defs = @db[:defs].map { |x| x[:name][-1] }
+
+    _(defs).must_include :PBAR_FORMAT
+    _(defs).must_include :SOME_INVALID_ENCODING
   end
 
   it 'must identify endings' do
     _(@db.keys).must_include :end
-    _(@db[:end].count).must_equal 13
+    _(@db[:end].count).must_equal 14
   end
 
   it 'must identify function calls' do
@@ -63,4 +68,18 @@ describe Starscope::Lang::Ruby do
     _(assigns.keys).wont_include :'='
     _(assigns.keys).wont_include :<
   end
+
+  it 'must identify variable and constant reads' do
+    _(@db.keys).must_include :reads
+    reads = @db[:reads].map { |x| x[:name][-1] }
+
+    _(reads).must_include :Go
+    _(reads).must_include :Ruby
+    _(reads).must_include :DB_FORMAT
+    _(reads).must_include :UnknownDBFormatError
+    _(reads).must_include :path
+    _(reads).must_include :entry
+    _(reads).must_include :file
+    _(reads).must_include :@files
+  end
 end

data/test/unit/langs/vue_test.rb

@@ -0,0 +1,28 @@
+require_relative '../../test_helper'
+
+describe Starscope::Lang::Vue do
+  before do
+    @frags = []
+    Starscope::Lang::Vue.extract(VUE_SAMPLE, File.read(VUE_SAMPLE)) do |tbl, name, args|
+      _(tbl).must_equal Starscope::DB::FRAGMENT
+      _(name).must_equal :Javascript
+      @frags << args
+    end
+  end
+
+  it 'must match vue files' do
+    _(Starscope::Lang::Vue.match_file(VUE_SAMPLE)).must_equal true
+  end
+
+  it 'must not match non-vue files' do
+    _(Starscope::Lang::ERB.match_file(GOLANG_SAMPLE)).must_equal false
+    _(Starscope::Lang::ERB.match_file(EMPTY_FILE)).must_equal false
+  end
+
+  it 'must identify fragments' do
+    _(@frags.length).must_equal(20)
+    _(@frags).must_include({ frag: "import marked from 'marked';\n", line_no: 15 })
+    _(@frags).must_include({ frag: "    markdown() {\n", line_no: 25 })
+    _(@frags).must_include({ frag: "}\n", line_no: 34 })
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: starscope
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Evan Huus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: babel-transpiler
@@ -109,47 +109,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.12'
+        version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.12'
+        version: '11.1'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '5.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '5.12'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -236,6 +236,7 @@ files:
 - lib/starscope/langs/golang.rb
 - lib/starscope/langs/javascript.rb
 - lib/starscope/langs/ruby.rb
+- lib/starscope/langs/vue.rb
 - lib/starscope/matcher.rb
 - lib/starscope/output.rb
 - lib/starscope/queryable.rb
@@ -254,6 +255,7 @@ files:
 - test/fixtures/sample_golang.go
 - test/fixtures/sample_javascript.js
 - test/fixtures/sample_ruby.rb
+- test/fixtures/sample_vue.vue
 - test/functional/starscope_test.rb
 - test/test_helper.rb
 - test/unit/db_test.rb
@@ -263,6 +265,7 @@ files:
 - test/unit/langs/golang_test.rb
 - test/unit/langs/javascript_test.rb
 - test/unit/langs/ruby_test.rb
+- test/unit/langs/vue_test.rb
 - test/unit/output_test.rb
 - test/unit/queryable_test.rb
 homepage: https://github.com/eapache/starscope
@@ -285,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Smart code search and indexing
@@ -303,6 +306,7 @@ test_files:
 - test/fixtures/sample_golang.go
 - test/fixtures/sample_javascript.js
 - test/fixtures/sample_ruby.rb
+- test/fixtures/sample_vue.vue
 - test/functional/starscope_test.rb
 - test/test_helper.rb
 - test/unit/db_test.rb
@@ -312,5 +316,6 @@ test_files:
 - test/unit/langs/golang_test.rb
 - test/unit/langs/javascript_test.rb
 - test/unit/langs/ruby_test.rb
+- test/unit/langs/vue_test.rb
 - test/unit/output_test.rb
 - test/unit/queryable_test.rb