gelauto 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9a90485262d6867a89f54f088f6cd71cd7490b41d22622edd4376387d97555a
-  data.tar.gz: 808a3f83fd11126ccf4d41ff65e770e28ba9e4d4912bfd9ddca50655471369b9
+  metadata.gz: 195e070c508f3696ca8107bf020e99571d25b9ce3b6d963f650423b4ffcab265
+  data.tar.gz: 8619e1c12452751ee78d247296afb0c9d7c9b3f4328fcdfba9ea913d5cb492d1
 SHA512:
-  metadata.gz: 861d47eebcf4b9709d3cdafa5119a39a30bcecdb0a5fe201accf46464861676a23392322e962afbdd356332537a5fca1bf50e8578baafa7e728564b5d2f9ce6c
-  data.tar.gz: 19011ece03802f5bd64991382d5cf0b7eae12cc8e431c13ff72e4d807d16a29e949e2a1df90b8505ac1c9f145f731d45af5265686fe3cf27f66699431ce803f8
+  metadata.gz: a50267721b8e10e49fd34d3c5f8a35ece67d0106599a927d8d8c9c53ceddcaf81be51bd41b58bf2df00d90fdf75311e37371fd6071d28100fbf4174fca34e0a1
+  data.tar.gz: 6f4d3179cb04eca9631315b5017061d99e726ae2721096a1de1ca5b544ce81c4955145e24f48fb5158669fe4a3f85acabb469de8ba86e831191ae58f0892b201

data/Gemfile

@@ -2,6 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'sorbet-runtime'
+
 group :development do
   gem 'pry-byebug'
   gem 'rspec'

data/README.md

@@ -1,4 +1,4 @@
-## gelauto [![Build Status](https://travis-ci.com/camertron/gelauto.svg?branch=master)](https://travis-ci.com/camertron/gelauto)
+## gelauto [![Build status](https://github.com/camertron/gelauto/actions/workflows/test.yml/badge.svg)](https://github.com/camertron/gelauto/actions/workflows/test.yml)
 
 Automatically annotate your code with Sorbet type definitions.
 
@@ -45,13 +45,13 @@ First, install the gem by running `gem install gelauto`. That will make the `gel
 Gelauto's only subcommand is `run`, which accepts a list of Ruby files to scan for methods and a command to run that will exercise your code.
 
 In this example, we're going to be running an [RSpec](https://github.com/rspec/rspec) test suite.
-Like most RSpec test suites, let's assume ours is stored in the `spec/` directory (that's the RSpec default too). Let's furthermore assume our code is stored in the `lib` directory. To run the test suite in `spec/` and add type definitions to our files in `lib/`, we might run the following command:
+Like most RSpec test suites, let's assume ours is stored in the `spec/` directory (that's the RSpec default too). To run the test suite in `spec/` and add type definitions to our ruby files, we might run the following command:
 
 ```bash
 gelauto run --annotate $(find . -name '*.rb') -- bundle exec rspec spec/
 ```
 
-You can also choose to run Gelauto with the `--rbi` flag, which will cause Gelauto to print results to standard output or to a file in [RBI format](https://sorbet.org/docs/rbi):
+You can also choose to run Gelauto with the `--rbi` flag, which will cause Gelauto to print results to standard output or to the given file in [RBI format](https://sorbet.org/docs/rbi):
 
 ```bash
 # print RBI output to STDOUT
@@ -126,17 +126,27 @@ require 'gelauto/rspec'
 to your spec_helper.rb, Rakefile, or wherever RSpec is configured. You'll also need to set the `GELAUTO_FILES` environment variable when running your test suite. For example:
 
 ```bash
-GELAUTO_FILES=$(find ./lib -name *.rb) bundle exec rspec
+GELAUTO_FILES=$(find . -name *.rb) bundle exec rspec
 ```
 
 Files can be separated by spaces, newlines, or commas. If you want Gelauto to annotate them, set `GELAUTO_ANNOTATE` to `true`, eg:
 
 ```bash
-GELAUTO_FILES=$(find ./lib -name *.rb) GELAUTO_ANNOTATE=true bundle exec rspec
+GELAUTO_FILES=$(find . -name *.rb) GELAUTO_ANNOTATE=true bundle exec rspec
 ```
 
 Finally, set `GELAUTO_RBI=/path/to/output.rbi` to have Gelauto emit an RBI file when the test suite finishes.
 
+#### Minitest Helper
+
+Gelauto also comes with a handy Minitest helper. Simply add
+
+```ruby
+require 'gelauto/minitest'
+```
+
+to your test_helper.rb (or wherever Minitest is `require`d and configured). The same environment variables described above for RSpec, eg. `GELAUTO_FILES`, `GELAUTO_ANNOTATE`, and `GELAUTO_RBI`, can be used in a Minitest setup.
+
 ## How does it Work?
 
 Gelauto makes use of Ruby's [TracePoint API](https://ruby-doc.org/core-2.6/TracePoint.html). TracePoint effectively allows Gelauto to receive a notification whenever a Ruby method is called and whenever a method returns. That info combined with method location information gathered from parsing your Ruby files ahead of time allows Gelauto to know a) where methods are located, 2) what arguments they take, 3) the types of those arguments, and 4) the type of the return value.
@@ -147,7 +157,6 @@ Gelauto makes use of Ruby's [TracePoint API](https://ruby-doc.org/core-2.6/Trace
 
 * Half-baked support for singleton (i.e. static) methods.
 * Gelauto does not annotate Ruby files with `# typed: true` comments or `extend T::Sig`.
-* Gelauto ignores existing type signatures and will simply add another one right above the method.
 
 ## Running Tests
 

data/gelauto.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.description = s.summary = 'Automatically annotate your code with Sorbet type definitions.'
   s.platform = Gem::Platform::RUBY
 
-  s.add_dependency 'parser', '~> 2.6'
+  s.add_dependency 'parser', '~> 3.0'
   s.add_dependency 'gli', '~> 2.0'
 
   s.executables << 'gelauto'

data/lib/gelauto/method_index.rb

@@ -1,9 +1,10 @@
 module Gelauto
   class MethodIndex
-    attr_reader :index
+    attr_reader :index, :sig_index
 
     def initialize
       @index = Hash.new { |h, k| h[k] = {} }
+      @sig_index = Hash.new { |h, k| h[k] = {} }
     end
 
     def index_methods_in(path, ast, nesting = [])
@@ -16,10 +17,16 @@ module Gelauto
 
           if ast.type == :def
             name = ast.children[0]
-            args = ast.children[1].children.map { |c| c.children.first }
+            args = ast.children[1].children.each_with_object([]) do |c, memo|
+              # ignore anonymous args like **, etc
+              memo << c.children.first if c.children.first
+            end
           else
             name = ast.children[1]
-            args = ast.children[2].children.map { |c| c.children.first }
+            args = ast.children[2].children.each_with_object([]) do |c, memo|
+              # ignore anonymous args like **, etc
+              memo << c.children.first if c.children.first
+            end
           end
 
           md = MethodDef.new(name, args, nesting)
@@ -31,6 +38,10 @@ module Gelauto
         when :class, :module
           const_name = ast.children.first.children.last
           return visit_children(path, ast, nesting + [Namespace.new(const_name, ast.type)])
+        when :block
+          if ast.children.first.children.last == :sig
+            sig_index[path][ast.location.line] = true
+          end
       end
 
       visit_children(path, ast, nesting)
@@ -66,13 +77,14 @@ module Gelauto
     def annotate(path, code)
       lines = code.split(/\r?\n/)
       mds = index[path]
+      sigs = sig_index[path]
 
       [].tap do |annotated|
         lines.each_with_index do |line, idx|
           lineno = idx + 1
           md = mds[lineno]
 
-          if md.is_a?(MethodDef)
+          if md.is_a?(MethodDef) && !sigs[idx]
             indent = line[0...line.index(/[^\s]/)]
             annotated << "#{indent}#{md.to_sig}"
           end

data/lib/gelauto/minitest.rb

@@ -0,0 +1,25 @@
+require 'gelauto'
+
+Gelauto.paths += ENV.fetch('GELAUTO_FILES', '').split(/[\s\n,]/).map(&:strip)
+Gelauto.setup
+
+Minitest.after_run do
+  Gelauto.teardown
+
+  if ENV['GELAUTO_ANNOTATE'] == 'true'
+    Gelauto.each_absolute_path do |path|
+      Gelauto.annotate_file(path)
+      Gelauto::Logger.info("Annotated #{path}")
+    end
+  end
+
+  if ENV['GELAUTO_RBI']
+    rbi_str = Gelauto::Rbi.new(Gelauto.method_index).to_s
+
+    if ENV['GELAUTO_RBI'] == '-'
+      puts rbi_str
+    else
+      File.write(ENV['GELAUTO_RBI'], rbi_str)
+    end
+  end
+end

data/lib/gelauto/rbi.rb

@@ -31,7 +31,7 @@ module Gelauto
       io.write(indent(h[:methods].map { |md| md.to_rbi }.join("\n\n"), indent_level))
 
       h[:children].each_with_index do |((namespace, type), next_level), idx|
-        io.write("\n\n") if idx > 0
+        io.write("\n\n") if idx > 0 || h[:methods].size > 0
         io.write(indent("#{type} #{namespace}", indent_level))
         io.write("\n")
         compose(next_level, io, indent_level + 1)

data/lib/gelauto/type_set.rb

@@ -43,7 +43,9 @@ module Gelauto
         if rt == ::NilClass
           nilable = true
         else
-          ret << t.to_sig
+          t.to_sig.tap do |s|
+            ret << s if s
+          end
         end
       end
 

data/lib/gelauto/version.rb

@@ -1,3 +1,3 @@
 module Gelauto
-  VERSION = '2.0.0'
+  VERSION = '2.2.0'
 end

data/lib/gelauto.rb

@@ -92,7 +92,7 @@ module Gelauto
           )
 
           Gelauto::Logger.info("Indexed #{idx + 1}/#{paths.size} paths")
-        rescue Parser::SyntaxError => e
+        rescue Parser::SyntaxError
           Gelauto::Logger.error("Syntax error in #{path}, skipping")
         end
       end

data/spec/gelauto_spec.rb

@@ -80,6 +80,27 @@ describe Gelauto do
     end
   end
 
+  context 'with existing signatures' do
+    before do
+      Gelauto.discover do
+        @request = GelautoSpecs::Request.new
+        @request.to_a('Hello', 'World')
+        @request.to_s(100)
+      end
+    end
+
+    it 'skips existing sig, adds missing sig' do
+      file = File.read('spec/support/annotated.rb')
+      expect(file.lines.count).to eq(17)
+      # does not add a signature to the method with an existing signature
+      annotated = annotate(@request, :to_a, file)
+      expect(annotated.lines.count).to eq(17)
+      # does add a signature to the method without a signature
+      annotated = annotate(@request, :to_s, file)
+      expect(annotated.lines.count).to eq(18)
+    end
+  end
+
   context 'with nested generic types' do
     before do
       Gelauto.discover do

data/spec/spec_helper.rb

@@ -20,6 +20,11 @@ RSpec.configure do |config|
         path, lineno = obj.method(method_name).source_location
         Gelauto.method_index.find(path, lineno)
       end
+
+      def annotate(obj, method_name, code)
+        path, _lineno = obj.method(method_name).source_location
+        Gelauto.method_index.annotate(path, code)
+      end
     end
   )
 end

data/spec/support/annotated.rb

@@ -0,0 +1,17 @@
+require 'sorbet-runtime'
+
+module GelautoSpecs
+  class Request
+    extend T::Sig
+    sig { params(status: String, body: String).returns(T::Array[String]) }
+    def to_a(status, body)
+      [status, body]
+    end
+
+    def to_s(number)
+      number&.to_s
+    end
+  end
+end
+
+Gelauto.paths << __FILE__

data/spec/support/client.rb

@@ -1,3 +1,5 @@
+require 'sorbet-runtime'
+
 module GelautoSpecs
   class Response
     attr_reader :status, :body

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gelauto
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Cameron Dutro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-25 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +61,7 @@ files:
 - lib/gelauto/logger.rb
 - lib/gelauto/method_def.rb
 - lib/gelauto/method_index.rb
+- lib/gelauto/minitest.rb
 - lib/gelauto/namespace.rb
 - lib/gelauto/null_logger.rb
 - lib/gelauto/rbi.rb
@@ -72,6 +73,7 @@ files:
 - lib/gelauto/version.rb
 - spec/gelauto_spec.rb
 - spec/spec_helper.rb
+- spec/support/annotated.rb
 - spec/support/client.rb
 - spec/support/config.yml
 - spec/support/image.rb
@@ -80,7 +82,7 @@ files:
 homepage: http://github.com/camertron/gelauto
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,9 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: Automatically annotate your code with Sorbet type definitions.
 test_files: []