curdle 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '03619ba9f0f656e0ecb014f9e363d30489dcdf5e0ba644ca6cfcd97d07ce117f'
+  data.tar.gz: f77085d060179a1d04ab0c1c7c7d33452d999dc076eba557a782ab16955ba339
+SHA512:
+  metadata.gz: 822585de86c1001268f0124c8b9fb88f8b6fc7b1fcbc73ed36196fef1bdc3fe7caa1cd1ce2c5d6bc4767d3e1f47a030c55bd9e153e593891b735ce08c101252a
+  data.tar.gz: e5f2be2f8e08e34a495965df1359f6fa25a5b9bd5c5c53866192fc6a65218bcc7a11fc1c9846cdce876c3b035f1ce6c3db6ec2485b2f6426aeca5b5186b80a19

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'pry-byebug'
+end
+
+group :test do
+  gem 'rspec'
+end
+
+group :development, :test do
+  gem 'rake'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Cameron Dutro
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require 'curdle'
+
+Bundler::GemHelper.install_tasks
+
+task default: :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/bin/curdle

@@ -0,0 +1,8 @@
+#! /usr/bin/env ruby
+
+require 'curdle'
+
+ARGV.each do |file|
+  Curdle.process_file(file)
+  puts "Wrote #{file}"
+end

data/curdle.gemspec

@@ -0,0 +1,23 @@
+$:.unshift File.expand_path('lib', __dir__)
+require 'curdle/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'curdle'
+  s.version  = ::Curdle::VERSION
+  s.authors  = ['Cameron Dutro']
+  s.email    = ['camertron@gmail.com']
+  s.homepage = 'http://github.com/camertron/curdle'
+
+  s.description = s.summary = 'Programmatically remove Sorbet type annotations from Ruby code.'
+
+  s.platform = Gem::Platform::RUBY
+
+  s.add_dependency 'parser', '~> 3.1'
+
+  s.add_development_dependency 'rspec'
+
+  s.require_path = 'lib'
+  s.executables << 'curdle'
+
+  s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'LICENSE', 'CHANGELOG.md', 'README.md', 'Rakefile', 'curdle.gemspec']
+end

data/lib/curdle/remove_sorbet.rb

@@ -0,0 +1,209 @@
+require 'parser/current'
+
+module Curdle
+  class RemoveSorbet < ::Parser::TreeRewriter
+    def on_send(node)
+      remove_extend(node, 'T::Sig') ||
+        remove_extend(node, 'T::Generic') ||
+        remove_extend(node, 'T::Helpers') ||
+        remove_t_send(node) ||
+        remove_abstract_bang(node)
+
+      super
+    end
+
+    def on_block(node)
+      remove_sig(node)
+      super
+    end
+
+    def on_ivasgn(node)
+      remove_let(node)
+      super
+    end
+
+    def on_casgn(node)
+      remove_let(node) ||
+        remove_type_member(node) ||
+        remove_type_alias(node)
+
+      super
+    end
+
+    private
+
+    def remove_extend(send_node, const_str)
+      receiver, name, *args = *send_node
+      return false unless receiver.nil? && name == :extend
+      return false unless args.size == 1
+      return false unless args.first.location.expression.is?(const_str)
+
+      replace(
+        send_node.location.expression,
+        "# #{send_node.location.expression.source}"
+      )
+
+      true
+    end
+
+    def remove_sig(block_node)
+      send_node, = *block_node
+      receiver, name, *args = *send_node
+      return false unless receiver.nil? && name == :sig && args.empty?
+
+      comment_out_node(block_node)
+
+      true
+    end
+
+    def remove_t_send(send_node)
+      receiver, name = *send_node
+      return false unless receiver && receiver.location.expression.is?('T')
+
+      remove_cast(send_node) ||
+        remove_must(send_node) ||
+        remove_unsafe(send_node)
+
+      true
+    end
+
+    def remove_abstract_bang(send_node)
+      receiver, name = *send_node
+      return false unless receiver.nil? && name == :abstract!
+
+      comment_out_node(send_node)
+
+      true
+    end
+
+    def remove_cast(send_node)
+      _, name, *args = *send_node
+      return false unless name == :cast
+
+      remove_method_call(send_node)
+      remove_all_but_first_arg(send_node)
+
+      true
+    end
+
+    def remove_must(send_node)
+      _, name, *args = *send_node
+      return false unless name == :must
+
+      remove_method_call(send_node)
+
+      true
+    end
+
+    def remove_unsafe(send_node)
+      _, name, *args = *send_node
+      return false unless name == :unsafe
+
+      remove_method_call(send_node)
+
+      true
+    end
+
+    def remove_let(asgn_node)
+      case asgn_node.type
+        when :ivasgn
+          lhs_var, rhs = *asgn_node
+        when :casgn
+          _, lhs_var, rhs = *asgn_node
+        else
+          raise "Unexpected node type '#{asgn_node.type}'"
+      end
+
+      return false unless rhs
+      return false unless rhs.type == :send
+
+      receiver, name, *args = *rhs
+      return false unless name == :let && receiver.location.expression.is?('T')
+
+      if args.first.type == :ivar || args.first.type == :cvar
+        rhs_var, = *args.first
+
+        # Indicates the @ivar = T.let(@ivar, ...) pattern. The entire ivar
+        # assignment statement can be removed
+        if lhs_var == rhs_var
+          comment_out_node(asgn_node)
+        end
+      else
+        # indicates assigning the ivar to an actual value, in which case we
+        # can just remove the let and all args except the first
+        remove_method_call(rhs)
+        remove_all_but_first_arg(rhs)
+      end
+
+      true
+    end
+
+    def remove_type_member(casgn_node)
+      _, _const_name, value_node = *casgn_node
+      return false unless value_node.type == :send
+
+      receiver, name = *value_node
+      return false unless receiver.nil? && name == :type_member
+
+      comment_out_node(casgn_node)
+
+      true
+    end
+
+    def remove_type_alias(casgn_node)
+      _, _const_name, value_node = *casgn_node
+      return false unless value_node.type == :block
+
+      send_node, = *value_node
+      receiver, name = *send_node
+      return false unless receiver && receiver.location.expression.is?('T') && name == :type_alias
+
+      comment_out_node(casgn_node)
+
+      true
+    end
+
+    def remove_method_call(send_node)
+      receiver, name = *send_node
+
+      # remove receiver, dot, and method name
+      remove(receiver.location.expression) if receiver
+      remove(send_node.location.dot) if send_node.location.dot
+      remove(send_node.location.selector)
+
+      # remove enclosing parens
+      remove(send_node.location.begin) if send_node.location.begin
+      remove(send_node.location.end)   if send_node.location.end
+    end
+
+    def remove_all_but_first_arg(send_node)
+      _, _, *args = *send_node
+      first_arg_loc = args[0].location.expression
+      remove(args[1].location.expression.with(begin_pos: first_arg_loc.end_pos))
+    end
+
+    def comment_out_node(node)
+      location = include_leading_whitespace(node.location.expression)
+      lines = location.source.split(/\r?\n/)
+      indent = lines.map { |line| line.index(/[\S]/) }.min
+      new_str = lines.map { |line| line.insert(indent, '# ') }.join("\n")
+      replace(location, new_str)
+    end
+
+    def include_leading_whitespace(location)
+      source = location.source_buffer.source
+      start = source.rindex(/[^ \t]/, location.begin_pos - 1) + 1
+      location.with(begin_pos: start)
+    end
+
+    # this isn't used anywhere but it was so hard to write I'm keeping it in case
+    # I ever need to use it again
+    def include_trailing_whitespace(location)
+      if m = source.match(/[ \t]*(?:\r?\n)*/, location.end_pos)
+        location = location.with(end_pos: location.end_pos + m[0].size)
+      end
+
+      location
+    end
+  end
+end

data/lib/curdle/tasks.rb

@@ -0,0 +1,46 @@
+module Curdle
+  module Tasks
+    class << self
+      include Rake::DSL
+
+      def install(gemspec_file = find_gemspec)
+        task :build do
+          require 'tmpdir'
+          require 'fileutils'
+
+          Dir.mktmpdir do |build_dir|
+            spec = Bundler.load_gemspec(gemspec_file)
+
+            spec.files.each do |source_path|
+              next if File.directory?(source_path)
+
+              dest_path = File.join(build_dir, source_path)
+              FileUtils.mkdir_p(File.dirname(dest_path))
+
+              if File.extname(source_path) == '.rb'
+                File.write(dest_path, Curdle.process(File.read(source_path)))
+              else
+                FileUtils.cp(source_path, dest_path)
+              end
+            end
+
+            system("gem build --silent -C #{build_dir}")
+            artifact = Dir.glob(File.join(build_dir, "#{spec.name}*.gem")).first
+
+            FileUtils.mkdir_p('pkg')
+            artifact_dest = File.join('pkg', File.basename(artifact))
+            FileUtils.cp(artifact, artifact_dest)
+
+            puts "#{spec.name} #{spec.version} built to #{artifact_dest}."
+          end
+        end
+      end
+
+      private
+
+      def find_gemspec
+        Dir.glob(File.join(Dir.getwd, '*.gemspec')).first
+      end
+    end
+  end
+end

data/lib/curdle/version.rb

@@ -0,0 +1,3 @@
+module Curdle
+  VERSION = '1.0.0'
+end

data/lib/curdle.rb

@@ -0,0 +1,18 @@
+require 'parser/current'
+
+module Curdle
+  autoload :RemoveSorbet, 'curdle/remove_sorbet'
+  autoload :Tasks,        'curdle/tasks'
+
+  def self.process_file(file)
+    code = File.read(file)
+    File.write(file, process(code, file))
+  end
+
+  def self.process(code, filename = '(curdle)')
+    ast = Parser::CurrentRuby.parse(code)
+    buffer = Parser::Source::Buffer.new(filename, source: code)
+    rewriter = Curdle::RemoveSorbet.new
+    rewriter.rewrite(buffer, ast)
+  end
+end

data/spec/curdle_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+describe Curdle do
+  def verify(input, expected)
+    expect(described_class.process(input)).to eq(expected)
+  end
+
+  it 'removes extend T::Sig' do
+    verify('extend T::Sig', '# extend T::Sig')
+  end
+
+  it 'removes extend T::Generic' do
+    verify('extend T::Generic', '# extend T::Generic')
+  end
+
+  it 'removes extend T::Helpers' do
+    verify('extend T::Helpers', '# extend T::Helpers')
+  end
+
+  it 'removes casts' do
+    verify('foo = T.cast(bar, String)', 'foo = bar')
+  end
+
+  it 'removes musts' do
+    verify('foo = T.must(bar)', 'foo = bar')
+  end
+
+  it 'removes unsafes' do
+    verify('foo = T.unsafe(bar)', 'foo = bar')
+  end
+
+  it 'removes abstract! calls' do
+    verify(<<~END1, <<~END2)
+      class Foo
+        abstract!
+      end
+    END1
+      class Foo
+        # abstract!
+      end
+    END2
+  end
+
+  it 'removes single-line sigs' do
+    verify(<<~END1, <<~END2)
+      class Foo
+        sig { returns(String) }
+        def foo
+        end
+      end
+    END1
+      class Foo
+        # sig { returns(String) }
+        def foo
+        end
+      end
+    END2
+  end
+
+  it 'removes multi-line sigs' do
+    verify(<<~END1, <<~END2)
+      class Foo
+        sig {
+          params(bar: String, baz: Integer).returns(String)
+        }
+        def foo(bar, baz)
+        end
+      end
+    END1
+      class Foo
+        # sig {
+        #   params(bar: String, baz: Integer).returns(String)
+        # }
+        def foo(bar, baz)
+        end
+      end
+    END2
+  end
+
+  it 'removes T.let assigned to an instance variable' do
+    verify(<<~END1, <<~END2)
+      class Foo
+        def initialize
+          @version = T.let(@version, T.nilable(String))
+        end
+      end
+    END1
+      class Foo
+        def initialize
+          # @version = T.let(@version, T.nilable(String))
+        end
+      end
+    END2
+  end
+
+  it 'removes T.let ivar with an actual value' do
+    verify(<<~END1, <<~END2)
+      class Foo
+        def initialize
+          @version = T.let(version, T.nilable(String))
+        end
+      end
+    END1
+      class Foo
+        def initialize
+          @version = version
+        end
+      end
+    END2
+  end
+
+  it 'removes T.let assigned to a constant' do
+    verify(<<~END1, <<~END2)
+      class Foo
+        FOO = T.let('foo'.freeze, String)
+      end
+    END1
+      class Foo
+        FOO = 'foo'.freeze
+      end
+    END2
+  end
+
+  it 'removes type_members' do
+    verify(<<~END1, <<~END2)
+      class Foo
+        extend T::Generic
+
+        Elem = type_member
+      end
+    END1
+      class Foo
+        # extend T::Generic
+
+        # Elem = type_member
+      end
+    END2
+  end
+
+  it 'removes type_aliases' do
+    verify(<<~END1, <<~END2)
+      class Foo
+        AfterCallback = T.type_alias do
+          T.proc.params(cmd: T::Array[String], last_status: T.nilable(Process::Status)).void
+        end
+      end
+    END1
+      class Foo
+        # AfterCallback = T.type_alias do
+        #   T.proc.params(cmd: T::Array[String], last_status: T.nilable(Process::Status)).void
+        # end
+      end
+    END2
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.push(__dir__)
+
+require 'rspec'
+require 'curdle'
+require 'pry-byebug'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: curdle
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Programmatically remove Sorbet type annotations from Ruby code.
+email:
+- camertron@gmail.com
+executables:
+- curdle
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- Rakefile
+- bin/curdle
+- curdle.gemspec
+- lib/curdle.rb
+- lib/curdle/remove_sorbet.rb
+- lib/curdle/tasks.rb
+- lib/curdle/version.rb
+- spec/curdle_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/camertron/curdle
+licenses: []
+metadata: {}
+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.2.32
+signing_key:
+specification_version: 4
+summary: Programmatically remove Sorbet type annotations from Ruby code.
+test_files: []