rbs_rails 0.4.1 → 0.5.0

data/assets/sig/patches/README.md

@@ -1,4 +0,0 @@
-# patches
-
-This directory has monkey patches for RBS to make to pass `rbs validate`.
-These patches are unnecessary ideally, but we need them for some reasons, such as RBS's bug.

data/assets/sig/patches/for_actionpack.rbs

@@ -1,74 +0,0 @@
-
-module AbstractController
-  class Base
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    def send: (String | Symbol name, *untyped args) ?{ (*untyped) -> untyped } -> untyped
-
-    # bug: rbs prototype rb isn't aware of `class << self` for attr_reader
-    # https://github.com/rails/rails/blob/fbe2433be6e052a1acac63c7faf287c52ed3c5ba/actionpack/lib/abstract_controller/base.rb#L34-L35
-    def self.abstract: () -> untyped
-  end
-end
-
-module ActionController
-  class Metal
-    # alias bug?: https://github.com/ruby/rbs/issues/458
-    def status: -> untyped
-  end
-
-  class LiveTestResponse < Live::Response
-    # alias bug?: https://github.com/ruby/rbs/issues/458
-    def successful?: -> untyped
-    def not_found?: -> untyped
-    def server_error?: -> untyped
-  end
-end
-
-module ActionDispatch
-  class Response
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    attr_accessor cache_control: untyped
-
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    def location: () -> untyped
-  end
-
-  class Cookies
-    class CookieJar
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def to_h: () -> ::Hash[untyped, untyped]
-              | [T, U] () { (untyped) -> [T, U] } -> ::Hash[T, U]
-    end
-  end
-
-  module Journey
-    module Nodes
-      class Terminal < Node
-        # alias bug: https://github.com/ruby/rbs/issues/458
-        def left: () -> untyped
-      end
-    end
-  end
-
-  module Routing
-    class Mapper
-      module Resources
-        class SingletonResource < Resource
-          # alias bug: https://github.com/ruby/rbs/issues/458
-          attr_reader path: untyped
-        end
-      end
-    end
-
-    class OptionRedirect < Redirect
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      attr_reader block: untyped
-    end
-
-    class RouteSet
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def to_s: () -> String
-    end
-  end
-end
-

data/assets/sig/patches/for_actionview.rbs

@@ -1,19 +0,0 @@
-
-module ActionView
-  class OutputBuffer < ActiveSupport::SafeBuffer
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    def safe_concat: (untyped value) -> untyped
-  end
-
-  class LookupContext
-    class DetailsKey
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def equal?: (untyped other) -> bool
-    end
-  end
-
-  class Resolver
-    # Defined with meta-programming
-    def self.caching: () -> untyped
-  end
-end

data/assets/sig/patches/for_activemodel.rbs

@@ -1,11 +0,0 @@
-module ActiveModel
-  module Serialization
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    def `send`: (String name, *untyped args) ?{ (*untyped) -> untyped } -> untyped
-  end
-
-  module Validations
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    def `send`: (String name, *untyped args) ?{ (*untyped) -> untyped } -> untyped
-  end
-end

data/assets/sig/patches/for_activerecord.rbs

@@ -1,84 +0,0 @@
-module ActiveRecord
-  class Relation
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    def lock_value: () -> untyped
-  end
-
-  module QueryMethods
-    # It is defined with meta programming
-    def extending_values: () -> untyped
-  end
-
-  module ConnectionAdapters
-    module PostgreSQL
-      module OID
-        class Uuid < ActiveModel::Type::Value
-          # alias bug: https://github.com/ruby/rbs/issues/458
-          def deserialize: (*untyped) -> untyped
-        end
-      end
-    end
-  end
-
-  module ConnectionAdapters
-    class PostgreSQLAdapter < AbstractAdapter
-      def database_version: (*untyped) -> untyped
-    end
-  end
-
-  class Migration
-    class CommandRecorder
-      # They are defined with meta programming
-      def add_reference: (*untyped) -> untyped
-      def remove_reference: (*untyped) -> untyped
-      def invert_add_reference: (*untyped) -> untyped
-      def invert_remove_reference: (*untyped) -> untyped
-    end
-  end
-
-  class Result
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    def map: [U] () { (untyped arg0) -> U } -> ::Array[U]
-           | () -> ::Enumerator[untyped, ::Array[untyped]]
-  end
-end
-
-module Arel
-  module Nodes
-    class Quoted < Arel::Nodes::Unary
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def value: () -> untyped
-    end
-
-    class Equality < Arel::Nodes::Binary
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def left: () -> untyped
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def right: () -> untyped
-    end
-
-    class TableAlias < Arel::Nodes::Binary
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def left: () -> untyped
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def right: () -> untyped
-    end
-
-    class UnqualifiedColumn < Arel::Nodes::Unary
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def expr: () -> untyped
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def expr=: (untyped) -> untyped
-    end
-
-    class ValuesList < Unary
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def expr: () -> untyped
-    end
-
-    class With < Arel::Nodes::Unary
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def expr: () -> untyped
-    end
-  end
-end

data/assets/sig/patches/for_activesupport.rbs

@@ -1,48 +0,0 @@
-class Object
-  # Object#sum is actually not defined, but rbs prototype rb generates it mistakenly due to `class << Benchmark`.
-  # So we need to define it to suppress the alias error.
-  def sum: () -> untyped
-end
-
-class Time
-  # alias bug: https://github.com/ruby/rbs/issues/458
-  def xmlschema: (?::Integer fraction_digits) -> ::String
-end
-
-module ActiveSupport
-  class TestCase < ::Minitest::Test
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    def name: () -> untyped
-    def assert_raises: (*untyped) -> untyped
-    def refute_empty: (*untyped) -> untyped
-    def refute_equal: (*untyped) -> untyped
-    def refute_in_delta: (*untyped) -> untyped
-    def refute_in_epsilon: (*untyped) -> untyped
-    def refute_includes: (*untyped) -> untyped
-    def refute_instance_of: (*untyped) -> untyped
-    def refute_kind_of: (*untyped) -> untyped
-    def refute_match: (*untyped) -> untyped
-    def refute_nil: (*untyped) -> untyped
-    def refute_operator: (*untyped) -> untyped
-    def refute_predicate: (*untyped) -> untyped
-    def refute_respond_to: (*untyped) -> untyped
-    def refute_same: (*untyped) -> untyped
-  end
-
-  module Notifications
-    class Fanout
-      module Subscribers
-        class AllMessages
-          # alias bug: https://github.com/ruby/rbs/issues/458
-          def ===: (untyped) -> bool
-        end
-      end
-    end
-  end
-
-  class TimeWithZone
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    def <: (untyped) -> bool
-    def >: (untyped) -> bool
-  end
-end

data/assets/sig/patches/for_railties.rbs

@@ -1,30 +0,0 @@
-
-module Rails
-  class Application < Engine
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    def app: () -> untyped
-  end
-
-  class Engine < Railtie
-    # bug: rbs prototype rb isn't aware of `class << self` for attr_*
-    def self.isolated: () -> untyped
-    def self.isolated=: (untyped) -> untyped
-
-    # alias bug: https://github.com/ruby/rbs/issues/458
-    def self.railtie_name: (?untyped? name) -> untyped
-  end
-
-  module Generators
-    class PluginGenerator < AppBase
-      # alias bug: https://github.com/ruby/rbs/issues/458
-      def app_path: () -> untyped
-    end
-  end
-
-  module Initializable
-    class Collection[T] < Array[T]
-      def each: () -> ::Enumerator[T, self]
-              | () { (T item) -> void } -> self
-    end
-  end
-end

data/bin/generate_rbs_from_rails_source_code.rb

@@ -1,201 +0,0 @@
-# Usage
-#
-#   ruby bin/generate_rbs_from_rails_source_code.rb ../../rails/rails actionpack
-
-require 'bundler/inline'
-
-require 'pathname'
-require 'open3'
-
-SIG_DIR = Pathname('assets/sig/generated/')
-
-def bin(c)
-  Pathname(__dir__).join(c).to_s
-end
-
-def sh!(*cmd, **kwargs)
-  puts(cmd.join(' '))
-  Open3.capture2(*cmd, **kwargs).then do |out, status|
-    raise unless status.success?
-
-    out
-  end
-end
-
-def patch!(name, rbs)
-  case name
-  when 'actionpack'
-    rbs.gsub!(/(      def _reduce_\d+: \(untyped val, untyped _values\) -> )([A-Z]\w*)/) do
-      "#{$~[1]}Nodes::#{$~[2]}"
-    end || raise('it looks unnecessary.')
-
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!('-> Parameter', '-> Parameter[untyped]') || raise('it looks unnecessary')
-  when 'railties'
-    rbs.gsub!(
-      'class NonSymbolAccessDeprecatedHash < HashWithIndifferentAccess',
-      'class NonSymbolAccessDeprecatedHash[T, U] < HashWithIndifferentAccess[T, U]')
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      'def middleware: () -> Hash',
-      'def middleware: () -> Hash[untyped, untyped]')
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      'def +: (untyped other) -> Collection',
-      'def +: (untyped other) -> Collection[untyped]')
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      'def initializers_for: (untyped binding) -> Collection',
-      'def initializers_for: (untyped binding) -> Collection[untyped]')
-  when 'activesupport'
-    rbs.gsub!(
-      /^  include Java$/,
-      '  # include Java # Java module is missing')
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      'class Configuration < ActiveSupport::InheritableOptions',
-      'class Configuration[T, U] < ActiveSupport::InheritableOptions[T, U]')
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      'class InheritableOptions < OrderedOptions',
-      'class InheritableOptions[T, U] < OrderedOptions[T, U]')
-    rbs.gsub!( # ref: 5c507aaae492ff5b2002fdd3ece2044b283b5d6f
-      'include ActiveSupport::Logger::Severity',
-      'include ::Logger::Severity')
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      'def with_indifferent_access: () -> ActiveSupport::HashWithIndifferentAccess',
-      'def with_indifferent_access: () -> ActiveSupport::HashWithIndifferentAccess[K, V]')
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      'def inquiry: () -> ActiveSupport::ArrayInquirer',
-      'def inquiry: () -> ActiveSupport::ArrayInquirer[Elem]')
-
-    # These aliases are actually defined, but it causes duplicated method definition
-    rbs.gsub!('alias to_s to_formatted_s', '')
-    rbs.gsub!('alias + plus_with_duration', '')
-    rbs.gsub!('alias - minus_with_duration', '')
-    rbs.gsub!('alias - minus_with_coercion', '')
-    rbs.gsub!('alias <=> compare_with_coercion', '')
-    rbs.gsub!('alias eql? eql_with_coercion', '')
-    rbs.gsub!('alias self.at self.at_with_coercion', '')
-    rbs.gsub!('alias inspect readable_inspect', '')
-    rbs.gsub!('alias default_inspect inspect', '')
-
-    rbs.gsub!('HashWithIndifferentAccess: untyped', <<~RBS)
-      # NOTE: HashWithIndifferentAccess and ActiveSupport::HashWithIndifferentAccess are the same object
-      #       but RBS doesn't have class alias syntax
-      class HashWithIndifferentAccess[T, U] < ActiveSupport::HashWithIndifferentAccess[T, U]
-      end
-    RBS
-  when 'actionview'
-    rbs.gsub!(
-      'class CheckBoxBuilder < Builder',
-      'class CheckBoxBuilder < CollectionHelpers::Builder')
-    rbs.gsub!(
-      'class RadioButtonBuilder < Builder',
-      'class RadioButtonBuilder < CollectionHelpers::Builder')
-    rbs.gsub!('TemplateError: untyped', <<~RBS)
-      # It is actual TemplateError = Template::Error, but we can't write it in RBS
-      class TemplateError < Template::Error
-      end
-    RBS
-  when 'activerecord'
-    rbs.gsub!(':==', 'Symbol') # To avoid syntax error
-
-    rbs.gsub!(
-      '< Type::Value',
-      '< ActiveModel::Type::Value')
-    rbs.gsub!(
-      '< Type::Binary',
-      '< ActiveModel::Type::Binary')
-    rbs.gsub!(
-      '< Type::Decimal',
-      '< ActiveModel::Type::Decimal')
-    rbs.gsub!(
-      '< Type::String',
-      '< ActiveModel::Type::String')
-    rbs.gsub!(
-      '< Type::Integer',
-      '< ActiveModel::Type::Integer')
-
-    rbs.gsub!(
-      'class SchemaDumper < SchemaDumper',
-      'class SchemaDumper < ActiveRecord::SchemaDumper')
-    rbs.gsub!(
-      'def schema_creation: () -> SchemaCreation',
-      'def schema_creation: () -> untyped')
-    rbs.gsub!('V6_0: untyped', <<~RBS)
-      # V6_0 and Current are the same object actually. hack for https://github.com/ruby/rbs/issues/345
-      class V6_0 < Current
-      end
-    RBS
-    rbs.gsub!('alias numeric decimal', '')
-
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      '-> ColumnDefinition',
-      '-> ColumnDefinition[untyped]')
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      'def build_point: (untyped x, untyped y) -> ActiveRecord::Point',
-      'def build_point: (untyped x, untyped y) -> ActiveRecord::Point[untyped]')
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      'class NullMigration < MigrationProxy',
-      'class NullMigration[T] < MigrationProxy[T]')
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      '-> JoinKeys',
-      '-> JoinKeys[untyped]')
-    # XXX: I guess add-type-params.rb resolves this
-    rbs.gsub!(
-      'def row_num_literal: (untyped order_by) -> RowNumber',
-      'def row_num_literal: (untyped order_by) -> RowNumber[untyped]')
-
-    rbs.gsub!(
-      'def get_database_version: () -> Version',
-      'def get_database_version: () -> AbstractAdapter::Version')
-    rbs.gsub!(
-      'def get_database_version: () -> SQLite3Adapter::Version',
-      'def get_database_version: () -> AbstractAdapter::Version')
-    rbs.gsub!(
-      'def []: (untyped name) -> Attribute',
-      'def []: (untyped name) -> ::Arel::Attributes::Attribute')
-
-  end
-end
-
-def generate1!(rails_code_dir, name)
-  files = Pathname(rails_code_dir).join(name, 'lib').glob('**/*.rb').map(&:to_s)
-  generated_rbs_path = SIG_DIR.join("#{name}.rbs")
-
-  rbs = sh! 'ruby', bin("rbs-prototype-rb.rb"), 'prototype', 'rb', *files
-  rbs.gsub!(/^(?<indent>\s*)class (?<name>\S+) < $/) { "#{$~[:indent]}class #{$~[:name]} # Note: It inherits unnamed class, but omitted" }
-  rbs.gsub!(/[^[:ascii:]]+/, '(trim non-ascii characters)')
-  patch! name, rbs
-  generated_rbs_path.write(rbs)
-
-end
-
-def generate2!(rails_code_dir, name)
-  generated_rbs_path = SIG_DIR.join("#{name}.rbs")
-
-  rbs = sh! 'ruby', bin('add-type-params.rb'), generated_rbs_path.to_s
-  generated_rbs_path.write(rbs)
-
-  sh!({ 'ONLY' => name }, 'ruby', bin('postprocess.rb'), '-rlogger', '-rmutex_m', '-Iassets/sig', '-Isig', 'assets/')
-end
-
-def main(rails_code_dir, name)
-  if name == 'all'
-    gems = %w[activesupport actionpack activejob activemodel actionview activerecord railties]
-    gems.each { |n| generate1!(rails_code_dir, n) }
-    gems.each { |n| generate2!(rails_code_dir, n) }
-  else
-    generate1!(rails_code_dir, name)
-    generate2!(rails_code_dir, name)
-  end
-end
-
-main(*ARGV)