pry-sorbet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bfc26a70315521bb64ed1dd37c0d5270d33821417a0630052092b0f2efebba0f
+  data.tar.gz: bd69b579be964eb4f007a4506e58aad3f864f392004aa27bd56941081d45feba
+SHA512:
+  metadata.gz: ece438c8451b3c4831d9714514e2c0cc516d0a40cf97173aff42abe76798d87f449b4701118411f76ad46f15cf965eacd28041458e3f253164b4c275cc0f79a9
+  data.tar.gz: 7c0810dc4586b041fad1c8e734a41dbd38a8b5dfc484c9b8ac8ce7df0e23222c18e01d23034e077cce5ff00ac6c97e27b27917390f6389d57eb2282f3207188c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pry-sorbet.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Aaron Christiansen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# pry-sorbet
+
+pry-sorbet is a Pry extension which enables it to work seamlessly with Sorbet
+projects.
+
+**Before:** Incorrect method source
+
+```
+From: /home/aaron/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/sorbet-runtime-0.4.4929/lib/types/private/methods/_methods.rb @ line 208:
+Owner: #<Class:Foo>
+Visibility: public
+Number of lines: 35
+
+T::Private::ClassUtils.replace_method(mod, method_name) do |*args, &blk|
+  if !T::Private::Methods.has_sig_block_for_method(new_method)
+    # This should only happen if the user used alias_method to grab a handle
+    # to the original pre-unwound `sig` method. I guess we'll just proxy the
+    # call forever since we don't know who is holding onto this handle to
+```
+
+**After:** Method source and a signature!
+
+```
+From: playground/test.rb @ line 9:
+Owner: #<Class:Foo>
+Visibility: public
+Sorbet: sig { returns(Integer) }
+Number of lines: 3
+
+def self.bar
+  3
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pry-sorbet'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pry-sorbet
+
+## Usage
+
+Make sure you've required `pry-sorbet`. The `$` command in Pry will be
+automatically overwritten to add the Sorbet-specific functionality.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/AaronC81/pry-sorbet.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/extension.rb

@@ -0,0 +1,101 @@
+require 'sorbet-runtime'
+require 'pry'
+
+class Pry
+  class Command
+    class ShowInfo
+      old_method_sections = instance_method(:method_sections)
+
+      define_method(:method_sections) do |code_object|
+        sorbet_object = T::Private::Methods.signature_for_method(code_object)
+
+        if sorbet_object
+          call_chain = []
+
+          # Modifiers
+          call_chain << "generated" if sorbet_object.generated
+
+          if sorbet_object.mode != "standard"
+            # This is a string like "overridable_override"
+            call_chain += sorbet_object.mode.split("_")
+          end
+
+          # Parameters
+          all_parameters = []
+
+          #   Positional
+          all_parameters += sorbet_object.arg_types.map do |(name, type)|
+            "#{name}: #{type}"
+          end
+
+          #   Splat
+          if sorbet_object.rest_type
+            all_parameters << "#{sorbet_object.rest_name}: #{sorbet_object.rest_type}"
+          end
+
+          #   Keyword
+          all_parameters += sorbet_object.kwarg_types.map do |(name, type)|
+            "#{name}: #{type}"
+          end
+
+          #   Double-splat
+          if sorbet_object.rest_type
+            all_parameters << "#{sorbet_object.keyrest_name}: #{sorbet_object.keyrest_type}"
+          end
+
+          #   Block
+          if sorbet_object.block_type
+            all_parameters << "#{sorbet_object.block_name}: #{sorbet_object.block_type}"
+          end          
+
+          call_chain << "params(#{all_parameters.join(", ")})" if all_parameters.any?
+
+          # Returns
+          if sorbet_object.return_type.is_a?(T::Private::Types::Void)
+            call_chain << "void"
+          else
+            call_chain << "returns(#{sorbet_object.return_type})"
+          end
+
+          sorbet_string = "sig { #{call_chain.join(".")} }"
+        else
+          sorbet_string = "Unknown"
+        end
+
+        old_method_sections.bind(self).(code_object).merge({
+          sorbet: "\n\e[1mSorbet:\e[0m #{sorbet_string}"
+        })
+      end
+
+      old_method_header = instance_method(:method_header)
+
+      define_method(:method_header) do |code_object, line_num|
+        old_method_header.bind(self).(code_object, line_num) \
+          + method_sections(code_object)[:sorbet]
+      end
+    end
+  end
+
+  class Method
+    # Maybe use a dict or something, I think methods are suitable keys
+    define_method(:source_location) do
+      loc = super()
+
+      file_path, line = loc
+      return loc unless file_path && File.exists?(file_path)
+
+      first_source_line = IO.readlines(file_path)[line - 1]
+
+      # This is how Sorbet replaces methods.
+      # If Sorbet undergoes drastic refactorings, this may need to be updated!
+      initial_sorbet_line = "T::Private::ClassUtils.replace_method(mod, method_name) do |*args, &blk|"
+      replaced_sorbet_line = "mod.send(:define_method, method_sig.method_name) do |*args, &blk|"
+
+      if [initial_sorbet_line, replaced_sorbet_line].include?(first_source_line.strip)
+        T::Private::Methods.signature_for_method(@method).method.source_location
+      else
+        loc
+      end
+    end
+  end
+end

data/lib/pry_sorbet.rb

@@ -0,0 +1 @@
+require_relative 'extension.rb'

data/pry-sorbet.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "pry-sorbet"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Aaron Christiansen"]
+  spec.email         = ["aaronc20000@gmail.com"]
+
+  spec.summary       = %q{Pry plugin for Sorbet}
+  spec.homepage      = "https://github.com/AaronC81/pry-sorbet"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: pry-sorbet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Christiansen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- aaronc20000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/extension.rb
+- lib/pry_sorbet.rb
+- pry-sorbet.gemspec
+homepage: https://github.com/AaronC81/pry-sorbet
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/AaronC81/pry-sorbet
+  source_code_uri: https://github.com/AaronC81/pry-sorbet
+  changelog_uri: https://github.com/AaronC81/pry-sorbet/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Pry plugin for Sorbet
+test_files: []