gelauto 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9a90485262d6867a89f54f088f6cd71cd7490b41d22622edd4376387d97555a
-  data.tar.gz: 808a3f83fd11126ccf4d41ff65e770e28ba9e4d4912bfd9ddca50655471369b9
+  metadata.gz: b432e7c9cde4f686b0f5dfe56b1e535c8cbec893552ca72e3881de7c7736d189
+  data.tar.gz: 18e9c1edbf6fbdbe624c8e05153250aa1f7d2581d91f8131fc9c6bbbfeb52886
 SHA512:
-  metadata.gz: 861d47eebcf4b9709d3cdafa5119a39a30bcecdb0a5fe201accf46464861676a23392322e962afbdd356332537a5fca1bf50e8578baafa7e728564b5d2f9ce6c
-  data.tar.gz: 19011ece03802f5bd64991382d5cf0b7eae12cc8e431c13ff72e4d807d16a29e949e2a1df90b8505ac1c9f145f731d45af5265686fe3cf27f66699431ce803f8
+  metadata.gz: e9a6c22c6d79c023f3e03af57fe46af222379217527cfcb115d2aa10d946052f5f5d635ae9557093bfa2d9281958be1270291fae02b3983e9c7da2c35a2d0228
+  data.tar.gz: 6fe764a27342f40aea149cc01a2e92d93ddc9eb79d6e8d343c6685e64d28145a76cb42db2e3f1da60a7e00d54d1eeafecf299062327006f57d1d5ed4c1fbaefc

data/Gemfile

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

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 = [])
@@ -31,6 +32,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 +71,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/version.rb

@@ -1,3 +1,3 @@
 module Gelauto
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gelauto
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Cameron Dutro
@@ -72,6 +72,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