sorbet-eraser 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbfc0c7e028bd4e712e64d29a7c74e65d45937087a3f510f01afab434250b3d5
-  data.tar.gz: 6a89286f19c7ae6ed8e838beba49fcb799426fb14a58ed4b5c3b32d9b59935dc
+  metadata.gz: 3859ee512cb01ed5b84df15af3dedaa629c30d122e80a7436821841f87184562
+  data.tar.gz: 8392610b8fb03ea78d2572b684c2ccf9b4806f082043e3b2614550a370eeea13
 SHA512:
-  metadata.gz: efe378c67fa4749ac7461496d895c69e89ef28ca1f71d6c9385952a96320e8849a6ed15604d8219560903d047b0f9a1eda60fb938b07dc633f55da95a1082119
-  data.tar.gz: af3a02739fbbfdec2fd98c1bbb749b74a2a7f088c237f339966b186ad4b565e8cd353bac2bd4989f2fba8ae7435a096a058c4aca5cded0f209113826e284e994
+  metadata.gz: 02ee32fc8bcf3d1951ddd9577a4f46c181a01f196eb6c2af34bb8bb0b68a0ebc3fb28515d0ca1e391d2d1ee305d3012aafd943918df643dd2a3a44c5272a38b2
+  data.tar.gz: fa7b5e80e3fda49d50df015532110f6b4050450c5348f4d9f0ac6f40c8e2b411882a5348b38e305419b74e0bf6e833b887997bb6757e440fb3acc552e286d7e4

data/CHANGELOG.md

@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [0.4.0] - 2023-07-03
+
+### Added
+
+- `require "t"` now requires a file that only requires `"sorbet/eraser/t"`, so they are effectively the same thing. If you're in a situation where you need to load a different `"t"`, then you can manually require `"sorbet/eraser/t"` and it should work.
+- Replace all `typed:` comments with `typed: ignore`.
+
 ## [0.3.1] - 2023-06-27
 
 ### Added
@@ -34,7 +41,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - Require MFA for releasing.
 
-[unreleased]: https://github.com/kddnewton/sorbet-eraser/compare/v0.3.0...HEAD
+[unreleased]: https://github.com/kddnewton/sorbet-eraser/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/kddnewton/sorbet-eraser/compare/v0.3.1...v0.4.0
+[0.3.1]: https://github.com/kddnewton/sorbet-eraser/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/kddnewton/sorbet-eraser/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/kddnewton/sorbet-eraser/compare/v0.1.1...v0.2.0
 [0.1.1]: https://github.com/kddnewton/sorbet-eraser/compare/f6a712...v0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sorbet-eraser (0.3.1)
+    sorbet-eraser (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -12,6 +12,8 @@ Sometimes, you want to use Sorbet for development, but don't want to run `sorbet
 To handle these use cases, `sorbet-eraser` provides a way to erase all traces of `sorbet-runtime` code from your source code. This means that you can use Sorbet for development, but not have to worry about `sorbet-runtime` in production. For example,
 
 ```ruby
+# typed: true
+
 class HelloWorld
   extend T::Sig
 
@@ -25,6 +27,8 @@ end
 will be transformed into
 
 ```ruby
+             
+
 class HelloWorld
                
 
@@ -91,29 +95,30 @@ If you used any runtime structures like `T::Struct` or `T::Enum` you'll need a r
 
 Below is a table of the status of each `sorbet-runtime` construct and its current support status.
 
-| Construct                                           | Status | Replacement |
-| --------------------------------------------------- | ------ | ----------- |
-| `extend T::*`                                       | ✅     | Shimmed     |
-| `abstract!`, `final!`, `interface!`, `sealed!`      | ✅     | Shimmed     |
-| `mixes_in_class_methods(*)`, `requires_ancestor(*)` | ✅     | Shimmed     |
-| `type_member(*)`, `type_template(*)`                | ✅     | Shimmed     |
-| `class Foo < T::Enum`                               | ✅     | Shimmed     |
-| `class Foo < T::InexactStruct`                      | 🛠     | Shimmed     |
-| `class Foo < T::Struct`                             | 🛠     | Shimmed     |
-| `class Foo < T::ImmutableStruct`                    | 🛠     | Shimmed     |
-| `include T::Props`                                  | 🛠     | Shimmed     |
-| `include T::Props::Serializable`                    | 🛠     | Shimmed     |
-| `include T::Props::Constructor`                     | 🛠     | Shimmed     |
-| `sig`                                               | ✅     | Removed     |
-| `T.absurd(foo)`                                     | ✅     | Shimmed     |
-| `T.assert_type!(foo, bar)`                          | ✅     | `foo`       |
-| `T.bind(self, foo)`                                 | ✅     | `self`      |
-| `T.cast(foo, bar)`                                  | ✅     | `foo`       |
-| `T.let(foo, bar)`                                   | ✅     | `foo`       |
-| `T.must(foo)`                                       | ✅     | `foo`       |
-| `T.reveal_type(foo)`                                | ✅     | `foo`       |
-| `T.type_alias { foo }`                              | ✅     | Shimmed     |
-| `T.unsafe(foo)`                                     | ✅     | `foo`       |
+| Construct                                           | Status | Replacement       |
+| --------------------------------------------------- | ------ | ----------------- |
+| `# typed: foo`                                      | ✅     | `# typed: ignore` |
+| `extend T::*`                                       | ✅     | Shimmed           |
+| `abstract!`, `final!`, `interface!`, `sealed!`      | ✅     | Shimmed           |
+| `mixes_in_class_methods(*)`, `requires_ancestor(*)` | ✅     | Shimmed           |
+| `type_member(*)`, `type_template(*)`                | ✅     | Shimmed           |
+| `class Foo < T::Enum`                               | ✅     | Shimmed           |
+| `class Foo < T::InexactStruct`                      | 🛠     | Shimmed           |
+| `class Foo < T::Struct`                             | 🛠     | Shimmed           |
+| `class Foo < T::ImmutableStruct`                    | 🛠     | Shimmed           |
+| `include T::Props`                                  | 🛠     | Shimmed           |
+| `include T::Props::Serializable`                    | 🛠     | Shimmed           |
+| `include T::Props::Constructor`                     | 🛠     | Shimmed           |
+| `sig`                                               | ✅     | Removed           |
+| `T.absurd(foo)`                                     | ✅     | Shimmed           |
+| `T.assert_type!(foo, bar)`                          | ✅     | `foo`             |
+| `T.bind(self, foo)`                                 | ✅     | `self`            |
+| `T.cast(foo, bar)`                                  | ✅     | `foo`             |
+| `T.let(foo, bar)`                                   | ✅     | `foo`             |
+| `T.must(foo)`                                       | ✅     | `foo`             |
+| `T.reveal_type(foo)`                                | ✅     | `foo`             |
+| `T.type_alias { foo }`                              | ✅     | Shimmed           |
+| `T.unsafe(foo)`                                     | ✅     | `foo`             |
 
 In the above table, for `Status`:
 

data/lib/sorbet/eraser/parser.rb

@@ -86,7 +86,7 @@ module Sorbet
             @line_counts << MultiByteString.new(last_index, line)
           end
 
-          last_index += line.size
+          last_index += line.bytesize
         end
 
         @errors = []
@@ -213,7 +213,7 @@ module Sorbet
       # Track the open heredocs so we can replace the string literal ranges with
       # the range of their declarations.
       def on_heredoc_beg(value)
-        range = loc.then { |start| start...(start + value.size) }
+        range = loc.then { |start| start...(start + value.bytesize) }
         heredocs << [range, value, nil]
 
         Node.new(:@heredoc_beg, [value], range)
@@ -222,7 +222,7 @@ module Sorbet
       # If a heredoc ends, then the next string literal event will be the
       # heredoc.
       def on_heredoc_end(value)
-        range = loc.then { |start| start...(start + value.size) }
+        range = loc.then { |start| start...(start + value.bytesize) }
         heredocs.find { |(_, beg_arg, end_arg)| beg_arg.include?(value.strip) && end_arg.nil? }[2] = value
 
         Node.new(:@heredoc_end, [value], range)
@@ -251,7 +251,7 @@ module Sorbet
         next if handled.include?(:"on_#{event}")
 
         define_method(:"on_#{event}") do |value|
-          range = loc.then { |start| start...(start + (value&.size || 0)) }
+          range = loc.then { |start| start...(start + (value&.bytesize || 0)) }
           Node.new(:"@#{event}", [value], range)
         end
       end

data/lib/sorbet/eraser/patterns.rb

@@ -100,6 +100,30 @@ module Sorbet
         end
       end
 
+      # typed: ignore
+      # typed: false
+      # typed: true
+      # typed: strong
+      class TypedCommentPattern < Pattern
+        def replace(segment)
+          segment.gsub(/(\A#\s*typed:\s*)(?:ignore|false|true|strong)(\s*)\z/) do
+            "#{$1}ignore#{$2}"
+          end
+        end
+      end
+
+      def on_comment(comment)
+        super.tap do |node|
+          if lineno == 1 && comment.match?(/\A#\s*typed:\s*(?:ignore|false|true|strong)\s*\z/)
+            # typed: ignore
+            # typed: false
+            # typed: true
+            # typed: strong
+            patterns << TypedCommentPattern.new(node.range)
+          end
+        end
+      end
+
       def on_method_add_arg(call, arg_paren)
         if call.match?(/\A<call <var_ref <@const T>> <@period \.> <@ident (?:must|reveal_type|unsafe)>>\z/) && arg_paren.match?(/\A<arg_paren <args_add_block <args .+> false>>\z/)
           # T.must(foo)

data/lib/sorbet/eraser/t.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "sorbet/eraser/t/enum"
+require "sorbet/eraser/t/props"
+require "sorbet/eraser/t/struct"
+
+# For some constructs, it doesn't make as much sense to entirely remove them
+# since they're actually used to change runtime behavior. For example, T.absurd
+# will always raise an error. In this case instead of removing the content, we
+# can just shim it.
+module T
+  # These methods should really not be being called in a loop or any other kind
+  # of hot path, so here we're just going to shim them.
+  module Helpers
+    def abstract!; end
+    def interface!; end
+    def final!; end
+    def sealed!; end
+    def mixes_in_class_methods(*); end
+    def requires_ancestor(*); end
+  end
+
+  # Similar to the Helpers module, these things should only be called a couple
+  # of times, so shimming them here.
+  module Generic
+    include Helpers
+    def type_member(*, **); end
+    def type_template(*, **); end
+  end
+
+  # Keeping this module as a thing so that if there's any kind of weird
+  # reflection going on like is_a?(T::Sig) it will still work.
+  module Sig
+  end
+
+  # I really don't want to be shimming this, but there are places where people
+  # try to reference these values.
+  module Private
+    module RuntimeLevels
+      def self.default_checked_level; :never; end
+    end
+  
+    module Methods
+      module MethodHooks
+      end
+
+      module SingletonMethodHooks
+      end
+
+      def self.signature_for_method(method); method; end
+    end
+  end
+
+  # I also don't want to shim this, but there are places where people will
+  # reference it.
+  module Configuration
+    class << self
+      attr_accessor :inline_type_error_handler,
+                    :call_validation_error_handler,
+                    :sig_builder_error_handler
+    end
+  end
+
+  # Type aliases don't actually do anything, but they are usually assigned to
+  # constants, so in that case we need to return something.
+  def self.type_alias
+    Object.new
+  end
+
+  # Absurd always raises a TypeError within Sorbet, so mirroring that behavior
+  # here when T.absurd is called.
+  def self.absurd(value)
+    raise TypeError, value
+  end
+end

data/lib/sorbet/eraser/version.rb

@@ -2,6 +2,6 @@
 
 module Sorbet
   module Eraser
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

data/lib/t.rb

@@ -1,75 +1,3 @@
 # frozen_string_literal: true
 
-require "t/enum"
-require "t/props"
-require "t/struct"
-
-# For some constructs, it doesn't make as much sense to entirely remove them
-# since they're actually used to change runtime behavior. For example, T.absurd
-# will always raise an error. In this case instead of removing the content, we
-# can just shim it.
-module T
-  # These methods should really not be being called in a loop or any other kind
-  # of hot path, so here we're just going to shim them.
-  module Helpers
-    def abstract!; end
-    def interface!; end
-    def final!; end
-    def sealed!; end
-    def mixes_in_class_methods(*); end
-    def requires_ancestor(*); end
-  end
-
-  # Similar to the Helpers module, these things should only be called a couple
-  # of times, so shimming them here.
-  module Generic
-    include Helpers
-    def type_member(*, **); end
-    def type_template(*, **); end
-  end
-
-  # Keeping this module as a thing so that if there's any kind of weird
-  # reflection going on like is_a?(T::Sig) it will still work.
-  module Sig
-  end
-
-  # I really don't want to be shimming this, but there are places where people
-  # try to reference these values.
-  module Private
-    module RuntimeLevels
-      def self.default_checked_level; :never; end
-    end
-  
-    module Methods
-      module MethodHooks
-      end
-
-      module SingletonMethodHooks
-      end
-
-      def self.signature_for_method(method); method; end
-    end
-  end
-
-  # I also don't want to shim this, but there are places where people will
-  # reference it.
-  module Configuration
-    class << self
-      attr_accessor :inline_type_error_handler,
-                    :call_validation_error_handler,
-                    :sig_builder_error_handler
-    end
-  end
-
-  # Type aliases don't actually do anything, but they are usually assigned to
-  # constants, so in that case we need to return something.
-  def self.type_alias
-    Object.new
-  end
-
-  # Absurd always raises a TypeError within Sorbet, so mirroring that behavior
-  # here when T.absurd is called.
-  def self.absurd(value)
-    raise TypeError, value
-  end
-end
+require "sorbet/eraser/t"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-eraser
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,18 +77,19 @@ files:
 - lib/sorbet/eraser/cli.rb
 - lib/sorbet/eraser/parser.rb
 - lib/sorbet/eraser/patterns.rb
+- lib/sorbet/eraser/t.rb
+- lib/sorbet/eraser/t/enum.rb
+- lib/sorbet/eraser/t/props.rb
+- lib/sorbet/eraser/t/struct.rb
 - lib/sorbet/eraser/version.rb
 - lib/t.rb
-- lib/t/enum.rb
-- lib/t/props.rb
-- lib/t/struct.rb
 - sorbet-eraser.gemspec
 homepage: https://github.com/kddnewton/sorbet-eraser
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/kddnewton/sorbet-eraser/issues
-  changelog_uri: https://github.com/kddnewton/sorbet-eraser/blob/v0.3.1/CHANGELOG.md
+  changelog_uri: https://github.com/kddnewton/sorbet-eraser/blob/v0.4.0/CHANGELOG.md
   source_code_uri: https://github.com/kddnewton/sorbet-eraser
   rubygems_mfa_required: 'true'
 post_install_message: