gelauto 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8bc0cbf96338d28a4c1551f2fc2cf7e7cbea122ccbf1ecbcbe3904713d77293
-  data.tar.gz: 42e169f43e1d41de1ebd1d426dcd23358271aa3a658dc3d8d37288767223df13
+  metadata.gz: a9a90485262d6867a89f54f088f6cd71cd7490b41d22622edd4376387d97555a
+  data.tar.gz: 808a3f83fd11126ccf4d41ff65e770e28ba9e4d4912bfd9ddca50655471369b9
 SHA512:
-  metadata.gz: c74d87844d920d0abc555b55f395d61ca0235fd34a4bbcc6eb449a76ee5b304f36a37cf40d8b74817b380162def7aa1224d813fbc0fc7e8f209644428423fbc4
-  data.tar.gz: 850a310b37004110ddbe9b78906c1524fd262cd8ae1c67c861172818231c930bcfd83ac57e9b394ef800ee255330e6b7f2a900bd5018026f78bc588ad68bb236
+  metadata.gz: 861d47eebcf4b9709d3cdafa5119a39a30bcecdb0a5fe201accf46464861676a23392322e962afbdd356332537a5fca1bf50e8578baafa7e728564b5d2f9ce6c
+  data.tar.gz: 19011ece03802f5bd64991382d5cf0b7eae12cc8e431c13ff72e4d807d16a29e949e2a1df90b8505ac1c9f145f731d45af5265686fe3cf27f66699431ce803f8

data/README.md

@@ -51,7 +51,15 @@ Like most RSpec test suites, let's assume ours is stored in the `spec/` director
 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 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 a file in [RBI format](https://sorbet.org/docs/rbi):
+
+```bash
+# print RBI output to STDOUT
+gelauto run --annotate --rbi - $(find . -name '*.rb') -- bundle exec rspec spec/
+
+# write RBI output to a file
+gelauto run --annotate --rbi ./rbi/mylib.rbi $(find . -name '*.rb') -- bundle exec rspec spec/
+```
 
 In this second example, we're going to be running a minitest test suite. Like most minitest suites, let's assume ours is stored in the `test/` directory (that's the Rails default too). To run the test suite in `test/`, we might run the following command:
 
@@ -121,12 +129,14 @@ to your spec_helper.rb, Rakefile, or wherever RSpec is configured. You'll also n
 GELAUTO_FILES=$(find ./lib -name *.rb) bundle exec rspec
 ```
 
-Files can be separated by spaces, newlines, or commas. Finally, if you want Gelauto to annotate them, set `GELAUTO_ANNOTATE` to `true`, eg:
+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
 ```
 
+Finally, set `GELAUTO_RBI=/path/to/output.rbi` to have Gelauto emit an RBI file when the test suite finishes.
+
 ## 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.

data/bin/gelauto

@@ -1,5 +1,7 @@
 #! /usr/bin/env ruby
 
+$:.push(File.expand_path(File.join(%w(.. lib)), __dir__))
+
 require 'gelauto'
 require 'gelauto/version'
 require 'gli'
@@ -31,10 +33,25 @@ module Gelauto
       c.switch [:a, :annotate]
 
       c.desc 'Print type signatures to STDOUT in RBI format. Ignores --silent.'
-      c.default_value false
-      c.switch [:r, :rbi]
+      c.flag [:r, :rbi], type: String
+
+      c.desc 'Change into the given directory before running the command.'
+      c.default_value '.'
+      c.flag [:d, :dir], type: String
 
       c.action do |global_options, options, args|
+        if options[:rbi] && options[:rbi] != '-'
+          dir = File.dirname(options[:rbi])
+
+          unless File.exist?(dir)
+            puts "--rbi: #{dir} does not exist :("
+          end
+        end
+
+        unless File.exist?(options[:dir])
+          puts "--dir: #{options[:dir]} does not exist :("
+        end
+
         paths, _, cmd = args.chunk_while { |arg1, arg2| arg1 != '--' && arg2 != '--' }.to_a
         Gelauto.paths += paths
 
@@ -47,6 +64,7 @@ module Gelauto
         begin
           Gelauto.setup
           ARGV.replace(cmd)
+          Dir.chdir(options[:dir])
           load exe
         ensure
           Gelauto.teardown
@@ -61,7 +79,13 @@ module Gelauto
           end
 
           if options[:rbi]
-            puts Gelauto::Rbi.new(Gelauto.method_index).to_s
+            rbi_str = Gelauto::Rbi.new(Gelauto.method_index).to_s
+
+            if options[:rbi] == '-'
+              puts rbi_str
+            else
+              File.write(options[:rbi], rbi_str)
+            end
           end
         end
       end

data/lib/gelauto/array_type.rb

@@ -12,7 +12,7 @@ module Gelauto
 
     def to_sig
       if self[:elem].empty?
-        'T::Array'
+        'T::Array[T.untyped]'
       else
         "T::Array[#{self[:elem].to_sig}]"
       end

data/lib/gelauto/hash_type.rb

@@ -15,7 +15,7 @@ module Gelauto
 
     def to_sig
       if self[:key].empty? && self[:value].empty?
-        'T::Hash'
+        'T::Hash[T.untyped, T.untyped]'
       else
         "T::Hash[#{self[:key].to_sig}, #{self[:value].to_sig}]"
       end

data/lib/gelauto/rspec.rb

@@ -15,5 +15,15 @@ RSpec.configure do |config|
         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
 end

data/lib/gelauto/type_set.rb

@@ -53,8 +53,10 @@ module Gelauto
         'T.untyped'
       elsif sigs.size == 1
         sigs.first
+      elsif nilable
+        "T.nilable(T.any(#{sigs.join(', ')}))"
       else
-        "T.#{nilable ? 'nilable' : 'any'}(#{sigs.join(', ')})"
+        "T.any(#{sigs.join(', ')})"
       end
     end
   end

data/lib/gelauto/version.rb

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

data/spec/gelauto_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Gelauto do
@@ -23,6 +25,28 @@ describe Gelauto do
     end
   end
 
+  context 'with Sorbet generic types' do
+    it 'uses T.nilable with T.any correctly' do
+      Gelauto.discover do
+        GelautoSpecs::Utility.safe_to_string(nil)
+        GelautoSpecs::Utility.safe_to_string(1.0)
+        GelautoSpecs::Utility.safe_to_string(2)
+      end
+
+      safe_to_string = get_indexed_method(GelautoSpecs::Utility, :safe_to_string)
+      expect(safe_to_string.to_sig).to eq('sig { params(input: T.nilable(T.any(Float, Integer))).returns(String) }')
+    end
+
+    it 'uses T.Hash and T::Array with T.untyped correctly' do
+      Gelauto.discover do
+        GelautoSpecs::Utility.safe_get_keys({})
+      end
+
+      safe_get_keys = get_indexed_method(GelautoSpecs::Utility, :safe_get_keys)
+      expect(safe_get_keys.to_sig).to eq('sig { params(input: T::Hash[T.untyped, T.untyped]).returns(T::Array[T.untyped]) }')
+    end
+  end
+
   context 'with generic types' do
     before do
       Gelauto.discover do

data/spec/support/client.rb

@@ -24,6 +24,24 @@ module GelautoSpecs
       Response.new(200, 'it worked!')
     end
   end
+
+  class Utility
+    def self.safe_to_string(input)
+      if input.nil?
+        ''
+      else
+        input.to_s
+      end
+    end
+
+    def self.safe_get_keys(input)
+      if input.nil?
+        []
+      else
+        input.keys
+      end
+    end
+  end
 end
 
 Gelauto.paths << __FILE__

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gelauto
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -95,7 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Automatically annotate your code with Sorbet type definitions.