orthoses-rails 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76d6291b36d7d10e10f2d5b0898fa06a8a886375f9f91e91b2db718847c42eb2
-  data.tar.gz: 9d33694af285fdc0a214af35c26e143990689bca720429ca7029ccb48f0e531b
+  metadata.gz: f98262e6c8d3c7f75039f41d1a14b991de17171702663d111b7dc6e9d8cac2bb
+  data.tar.gz: 28db8b6a6bdee762946bb2c7287233804543a1e5f7f735e56ac1c2d8875dc457
 SHA512:
-  metadata.gz: a00f874e057a7515e2427bef047c25fc4a5bfe5f698e177b4e3919b4acc2df4cd4093b8fd407c7c493a1b548bbed0340f916af6f43bb37b0bd01e128f3ca3f8f
-  data.tar.gz: 77d8183eafa99f69864d37eae0dea091f0a2d0cf57530d10d524c61cb2ababdd8478ba6a2aad19e3be76119af7a6ee7be8e7fcd3bb8d1a7c06487c54aef3ebf3
+  metadata.gz: 13f1a9891b7a526aeed309854ed14bf6ee3e2b712ede4e7d0c63c33f8358f641061b6e81ad12773eff3e91043051f7ab16bb8aa349fb0c3ff38e4a7ce6b2654c
+  data.tar.gz: f3dd8dfea66c1b0477a9d17f736161e34b3a7a7c4fdaef3fc3948f84c60a6ac79fcfe1678392b8ca32746db4dc1b8f43a66e25b6d0dd4a6904440c1d0bc70cc0

data/README.md

@@ -3,6 +3,45 @@
 [Orthoses](https://github.com/ksss/orthoses) extension for Ruby on Rails.
 Orthoses::Rails automatically generates RBS for methods added by Rails.
 
+## Features
+
+### Orthoses::ActiveModel::HasSecurePassword
+
+Add signatures that generated form `ActiveModel::SecurePassword::ClassMethods#has_secure_password`.
+
+### Orthoses::ActiveRecord::BelongsTo
+
+Add signatures that generated form `ActiveRecord::Associations::ClassMethods#belongs_to`.
+
+### Orthoses::ActiveRecord::GeneratedAttributeMethods
+
+Add signatures that generated from DB schema columns.
+
+### Orthoses::ActiveRecord::HasMany
+
+Add signatures that generated form `ActiveRecord::Associations::ClassMethods#has_many`.
+
+### Orthoses::ActiveRecord::HasOne
+
+Add signatures that generated form `ActiveRecord::Associations::ClassMethods#has_one`.
+
+### Orthoses::ActiveSupport::ClassAttribute
+
+Add signatures that generated form `Class#class_attribute`.
+
+### Orthoses::ActiveSupport::Concern
+
+Add signature `extend ActiveSupport::Concern` only.
+
+### Orthoses::ActiveSupport::MattrAccessor
+
+Add signatures that generated form `Module#mattr_accessor`, `Module#mattr_reader` and `Module#mattr_writer`.
+
+### Orthoses::ActiveSupport::TimeWithZone
+
+Add signatures `Time` and `ActiveSupport::TimeWithZone`.
+Methods and mixin delegated from `Time` are added to `ActiveSupport::TimeWithZone`.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/examples/rails/Rakefile

@@ -0,0 +1,373 @@
+REPO_ROOT = "#{File.dirname(__FILE__)}/src"
+$:.unshift("#{REPO_ROOT}/actioncable/lib")
+$:.unshift("#{REPO_ROOT}/actionmailbox/lib")
+$:.unshift("#{REPO_ROOT}/actionmailer/lib")
+$:.unshift("#{REPO_ROOT}/actionpack/lib")
+$:.unshift("#{REPO_ROOT}/actiontext/lib")
+$:.unshift("#{REPO_ROOT}/actionview/lib")
+$:.unshift("#{REPO_ROOT}/activejob/lib")
+$:.unshift("#{REPO_ROOT}/activemodel/lib")
+$:.unshift("#{REPO_ROOT}/activerecord/lib")
+$:.unshift("#{REPO_ROOT}/activestorage/lib")
+$:.unshift("#{REPO_ROOT}/activesupport/lib")
+$:.unshift("#{REPO_ROOT}/railties/lib")
+
+require 'orthoses'
+require 'orthoses-rails'
+require 'openssl'
+require 'cgi'
+require 'uri'
+
+Orthoses.logger.level = :error
+
+Orthoses::Utils.unautoload!
+
+def run_child_process
+  pid = fork do
+    yield
+  end
+  Process.wait(pid)
+end
+
+def switch_branch(name)
+  cd "src" do
+    sh "git switch #{name}"
+  end
+end
+
+def generate(out_dir, version)
+  loader = -> () {
+    # require "rails/all"
+    require "rails/app_updater"
+    require "active_support/all"
+    require "active_record"
+    require "active_job"
+    require "active_model"
+    require "active_storage"
+    require "action_dispatch"
+    require "action_mailbox"
+    require "action_mailer"
+    require "action_pack"
+    require "action_text"
+    require "action_view"
+
+    [
+      ActiveSupport,
+      ActiveModel,
+      ActiveJob,
+      ActiveRecord,
+      ActiveStorage,
+      ActionDispatch,
+      ActionMailbox,
+      ActionMailer,
+      ActionText,
+      ActionView,
+    ].each do |rails_mod|
+      rails_mod.eager_load!
+      Orthoses::Utils.each_const_recursive(rails_mod, on_error: -> (e) {
+        Orthoses.logger.warn "skip load const by [#{e.root}][#{e.const}](#{e.error.class})#{e.error.message}"
+      })
+      v = rails_mod.respond_to?(:version) ? rails_mod.version : nil
+      puts "loaded #{rails_mod}: v#{v}"
+    end
+    Orthoses::Utils.unautoload!
+  }
+  Orthoses::Builder.new do
+    use Orthoses::CreateFileByName,
+      base_dir: "#{out_dir}/#{version}",
+      header: "# !!! GENERATED CODE !!!"
+    use Orthoses::AvoidRecursiveAncestorError
+    use Orthoses::Filter,
+      if: -> (name, content) {
+        # OMG, both ERB and Erb are exist...
+        return false if name.start_with?("Erb")
+
+        # ArgumentError
+        return false if name.start_with?("I18n::Tests")
+
+        # FIXME: too hard
+        return false if name.include?("::Generators")
+
+        # Ignore known sig
+        return false if Orthoses::Utils.rbs_defined_class?(name, collection: true) && content.body.empty?
+
+        true
+      }
+    use Orthoses::Constant,
+      strict: false,
+      if: -> (current, const, _val, _rbs) {
+        !Orthoses::Utils.rbs_defined_const?("#{current}::#{const}", collection: true)
+      },
+      on_error: -> (e) {
+        Orthoses.logger.warn "[Orthoses::Constant] skip load const by #{e.root}[::#{e.const}] (#{e.error.class}) #{e.error.message}"
+      }
+    Orthoses::ActiveSupport.each do |middleware, **args|
+      use middleware, **args
+    end
+    use Orthoses::ActiveRecord::QueryMethods
+    use Orthoses::ActiveRecord::KnownSig
+    use Orthoses::ActiveModel::KnownSig
+    use Orthoses::ObjectSpaceAll
+    use Orthoses::LoadRBS,
+      paths: Dir.glob('patch/**/*.rbs')
+    use Orthoses::LoadRBS,
+      paths: Dir.glob('known_sig/**/*.rbs')
+    # require in method
+    use Orthoses::Tap do |store|
+      store.delete("DummyERB")
+      store.delete("DummyCompiler")
+    end
+    # see activerecord/lib/active_record/migration/compatibility.rb
+    use Orthoses::Tap do |store|
+      # TODO: make middleware
+      if defined?(ActiveRecord::Migration::Compatibility::V7_0)
+        store["ActiveRecord::Migration::Compatibility::V6_1"].header = nil
+        store["ActiveRecord::Migration::Compatibility::V7_0"].header = "class ActiveRecord::Migration::Compatibility::V7_0 < ActiveRecord::Migration::Current"
+      elsif defined?(ActiveRecord::Migration::Compatibility::V6_1)
+        store["ActiveRecord::Migration::Compatibility::V6_0"].header = nil
+        store["ActiveRecord::Migration::Compatibility::V6_1"].header = "class ActiveRecord::Migration::Compatibility::V6_1 < ActiveRecord::Migration::Current"
+      elsif defined?(ActiveRecord::Migration::Compatibility::V6_0)
+        store["ActiveRecord::Migration::Compatibility::V5_2"].header = nil
+        store["ActiveRecord::Migration::Compatibility::V6_0"].header = "class ActiveRecord::Migration::Compatibility::V6_0 < ActiveRecord::Migration::Current"
+      end
+    end
+    # class_eval in #each
+    # see activerecord/lib/active_record/migration/command_recorder.rb
+    use Orthoses::Tap do |store|
+      content = store["ActiveRecord::Migration::CommandRecorder"]
+      ActiveRecord::Migration::CommandRecorder::ReversibleAndIrreversibleMethods.each do |method|
+        content << "def #{method}: (*untyped args) ?{ () -> void } -> untyped"
+      end
+    end
+    # class_eval in #each
+    # see activerecord/lib/active_record/migration/command_recorder.rb
+    use Orthoses::Tap do |store|
+      content = store["ActiveRecord::Migration::CommandRecorder::StraightReversions"]
+      {
+        execute_block:     :execute_block,
+        create_table:      :drop_table,
+        create_join_table: :drop_join_table,
+        add_column:        :remove_column,
+        add_index:         :remove_index,
+        add_timestamps:    :remove_timestamps,
+        add_reference:     :remove_reference,
+        add_foreign_key:   :remove_foreign_key,
+        add_check_constraint: :remove_check_constraint,
+        enable_extension:  :disable_extension
+      }.each do |cmd, inv|
+        [[inv, cmd], [cmd, inv]].uniq.each do |method, inverse|
+          content << "def invert_#{method}: (untyped args) ?{ () -> void } -> [Symbol, untyped, Proc]"
+        end
+      end
+    end
+    # singleton_class.class_eval in included
+    use Orthoses::Tap do |store|
+      store["ActiveRecord::ModelSchema"].body.tap do |body|
+        body.delete("alias _inheritance_column= inheritance_column=")
+        body.delete("alias inheritance_column= real_inheritance_column=")
+      end
+    end
+    # alias in included block
+    use Orthoses::Tap do |store|
+      store["ActiveRecord::ConnectionAdapters::ColumnMethods"].body.tap do |body|
+        body.delete("alias blob binary")
+        body.delete("alias numeric decimal")
+      end
+    end
+    # > Use async_exec instead of exec_params on pg versions before 1.1
+    use Orthoses::Tap do |store|
+      store["PG::Connection"].body.clear
+    end
+    # Entrust to auto super class
+    use Orthoses::Tap do |store|
+      store.each do |_, content|
+        if content.header&.include?(" < Type::")
+          content.header.sub!(/ < Type::(.*)/, " < ::ActiveModel::Type::\\1")
+        end
+        # delegate to auto_header
+        if content.header&.start_with?("class Arel")
+          content.header = nil
+        end
+      end
+      store["ActionView::Helpers::Tags::CollectionRadioButtons::RadioButtonBuilder"].header = nil
+      store["ActionView::Helpers::Tags::CollectionCheckBoxes::CheckBoxBuilder"].header = nil
+      store["ActionView::SyntaxErrorInTemplate"].header = nil
+      # MigrationProxy cannot resolve name since class alias.
+      store["ActiveRecord::NullMigration"].header = nil
+    end
+    use Orthoses::DelegateClass
+    use Orthoses::Attribute
+    use Orthoses::Mixin,
+      if: -> (base_mod, how, mod) {
+        mod != Enumerable # TODO
+      }
+    use Orthoses::RBSPrototypeRB,
+      paths: Dir.glob('src/{railties,action{cable,mailbox,mailer,pack,text,view},active{job,model,record,storage,support}}/lib/**/*.rb'),
+      constant_filter: -> (member) { false },
+      mixin_filter: -> (member) { false }
+    run loader
+  end.call
+
+  # $ cat out/7.0/**/*.rbs | wc
+  # 68367  333370 2555378
+end
+
+versions = %w[
+  6.0
+  6.1
+  7.0
+]
+
+task :clean do
+  FileUtils.rm_rf("out")
+  FileUtils.rm_rf("export")
+end
+
+namespace :generate do
+  versions.each do |version|
+    task version do
+      switch_branch("#{version.tr('.', '-')}-stable")
+      run_child_process { generate("out", version) }
+    end
+  end
+
+  desc "generate all library"
+  task :all => versions
+end
+
+namespace :export do
+  versions.each do |version|
+    task version do |t|
+      export = "export/activesupport/#{version}"
+
+      sh "rm -fr #{export}"
+      sh "mkdir -p #{export}"
+
+      # minimum
+      sh "cp -a out/#{version}/active_support.rbs #{export}"
+      sh "cp -a out/#{version}/active_support #{export}"
+      sh "rm #{export}/active_support/railtie.rbs"
+
+      # core_ext
+      %w[
+        array benchmark big_decimal class date date_and_time date_time digest
+        enumerable file hash integer kernel load_error marshal module name_error numeric
+        object pathname range regexp securerandom string symbol time uri
+      ].each do |lib|
+        out = "out/#{version}/#{lib}"
+        sh "cp -a #{out} #{export}" if File.exist?(out)
+        sh "cp -a #{out}.rbs #{export}" if File.exist?("#{out}.rbs")
+      end
+
+      Pathname(export).join("EXTERNAL_TODO.rbs").write(<<~RBS)
+        module Minitest
+          class Test
+            def name: () -> untyped
+            def assert_raises: () -> untyped
+            def refute_empty: () -> untyped
+            def refute_equal: () -> untyped
+            def refute_in_delta: () -> untyped
+            def refute_in_epsilon: () -> untyped
+            def refute_includes: () -> untyped
+            def refute_instance_of: () -> untyped
+            def refute_kind_of: () -> untyped
+            def refute_match: () -> untyped
+            def refute_nil: () -> untyped
+            def refute_operator: () -> untyped
+            def refute_predicate: () -> untyped
+            def refute_respond_to: () -> untyped
+            def refute_same: () -> untyped
+          end
+        end
+        module DRb
+          module DRbUndumped
+          end
+        end
+        module Concurrent
+          class Map
+          end
+        end
+      RBS
+
+      case version
+      when "6.0", "6.1"
+        sh "rm -fr #{export}/uri"
+      when "7.0"
+        # deprecated
+        sh "rm -fr #{export}/uri{,.rbs}"
+      end
+
+      Pathname(export).join('_scripts').tap(&:mkdir).join('test').write(<<~'RUBY')
+        #!/usr/bin/env bash
+
+        # set -eou => Exit command with non-zero status code, Output logs of every command executed, Treat unset variables as an error when substituting.
+        set -eou pipefail
+        # Internal Field Separator - Linux shell variable
+        IFS=$'\n\t'
+        # Print shell input lines
+        set -v
+
+        # Set RBS_DIR variable to change directory to execute type checks using `steep check`
+        RBS_DIR=$(cd $(dirname $0)/..; pwd)
+        # Set REPO_DIR variable to validate RBS files added to the corresponding folder
+        REPO_DIR=$(cd $(dirname $0)/../../..; pwd)
+        # Validate RBS files, using the bundler environment present
+        bundle exec rbs --repo=$REPO_DIR \
+          -r digest -r benchmark -r time -r monitor -r date -r singleton \
+          -r logger -r mutex_m -r pathname -r json \
+          -r nokogiri \
+          -r activesupport validate --silent
+
+        cd ${RBS_DIR}/_test
+        # Run type checks
+        bundle exec steep check
+      RUBY
+      sh "chmod +x #{Pathname(export).join('_scripts').join('test')}"
+      Pathname(export).join('_test').tap(&:mkdir).join('Steepfile').write(<<~RUBY)
+        D = Steep::Diagnostic
+
+        target :test do
+          signature "."
+          check "."
+
+          repo_path "../../../"
+
+          library "benchmark"
+          library "date"
+          library "digest"
+          library "json"
+          library "logger"
+          library "monitor"
+          library "mutex_m"
+          library "pathname"
+          library "singleton"
+          library "time"
+
+          library "nokogiri"
+
+          library "activesupport:#{version}"
+
+          configure_code_diagnostics(D::Ruby.all_error)
+        end
+      RUBY
+      Pathname(export).join('_test').join('test.rb').write(<<~'RUBY')
+        require 'active_support/all'
+
+        # Test ActiveSupport::NumericWithFormat
+        42.to_s
+        42.to_s(:phone)
+      RUBY
+
+      sh "rbs --collection ../../rbs_collection.yaml -I #{export} validate --silent"
+    end
+  end
+
+  desc "export all library"
+  task :all => versions
+end
+
+task default: [
+  :clean,
+  'generate:all',
+  'export:all',
+]

data/examples/rails/known_sig/action_cable/connection/test_cookie_jar.rbs

@@ -0,0 +1,2 @@
+class ActionCable::Connection::TestCookieJar < ActiveSupport::HashWithIndifferentAccess[untyped, untyped]
+end

data/examples/rails/known_sig/action_controller/metal.rbs

@@ -0,0 +1,4 @@
+class ActionController::Metal < ::AbstractController::Base
+  @_request: ::ActionDispatch::Request
+  @_response: ::ActionDispatch::Response
+end

data/examples/rails/known_sig/action_dispatch/cookies/cookie_jar.rbs

@@ -0,0 +1,3 @@
+class ActionDispatch::Cookies::CookieJar
+  def to_h: () -> Hash[untyped, untyped]
+end

data/examples/rails/known_sig/action_dispatch/response.rbs

@@ -0,0 +1,4 @@
+class ActionDispatch::Response
+  # The HTTP status code.
+  attr_reader status: Integer
+end

data/examples/rails/patch/drb/drb_undumped.rbs

@@ -0,0 +1,2 @@
+module DRb::DRbUndumped
+end

data/examples/rails/patch/drb.rbs

@@ -0,0 +1,2 @@
+ module DRb
+ end

data/examples/rails/patch/erubi/engine.rbs

@@ -0,0 +1,4 @@
+module Erubi
+  class Engine
+  end
+end

data/examples/rails/patch/erubi.rbs

@@ -0,0 +1,2 @@
+module Erubi
+end

data/examples/rails/patch/minitest/kernel.rbs

@@ -0,0 +1,44 @@
+%a{annotate:rdoc:skip}
+module Kernel : ::BasicObject
+  private
+
+  # <!--
+  #   rdoc-file=lib/minitest/spec.rb
+  #   - describe(desc, *additional_desc, &block)
+  # -->
+  # Describe a series of expectations for a given target `desc`.
+  #
+  # Defines a test class subclassing from either Minitest::Spec or from the
+  # surrounding describe's class. The surrounding class may subclass
+  # Minitest::Spec manually in order to easily share code:
+  #
+  #     class MySpec < Minitest::Spec
+  #       # ... shared code ...
+  #     end
+  #
+  #     class TestStuff < MySpec
+  #       it "does stuff" do
+  #         # shared code available here
+  #       end
+  #       describe "inner stuff" do
+  #         it "still does stuff" do
+  #           # ...and here
+  #         end
+  #       end
+  #     end
+  #
+  # For more information on getting started with writing specs, see:
+  #
+  # http://www.rubyinside.com/a-minitestspec-tutorial-elegant-spec-style-testing-t
+  # hat-comes-with-ruby-5354.html
+  #
+  # For some suggestions on how to improve your specs, try:
+  #
+  # http://betterspecs.org
+  #
+  # but do note that several items there are debatable or specific to rspec.
+  #
+  # For more information about expectations, see Minitest::Expectations.
+  #
+  def describe: (untyped desc, *untyped additional_desc) { () -> untyped } -> untyped
+end

data/examples/rails/patch/minitest/minitest/abstract_reporter.rbs

@@ -0,0 +1,49 @@
+# <!-- rdoc-file=lib/minitest.rb -->
+# Defines the API for Reporters. Subclass this and override whatever you want.
+# Go nuts.
+#
+class Minitest::AbstractReporter
+  # <!--
+  #   rdoc-file=lib/minitest.rb
+  #   - start()
+  # -->
+  # Starts reporting on the run.
+  #
+  def start: () -> nil
+
+  # <!--
+  #   rdoc-file=lib/minitest.rb
+  #   - prerecord(klass, name)
+  # -->
+  # About to start running a test. This allows a reporter to show that it is
+  # starting or that we are in the middle of a test run.
+  #
+  def prerecord: (untyped klass, untyped name) -> nil
+
+  # <!--
+  #   rdoc-file=lib/minitest.rb
+  #   - record(result)
+  # -->
+  # Output and record the result of the test. Call
+  # [result#result_code](rdoc-ref:Runnable#result_code) to get the result
+  # character string. Stores the result of the run if the run did not pass.
+  #
+  def record: (untyped result) -> nil
+
+  # <!--
+  #   rdoc-file=lib/minitest.rb
+  #   - report()
+  # -->
+  # Outputs the summary of the run.
+  #
+  def report: () -> nil
+
+  # <!--
+  #   rdoc-file=lib/minitest.rb
+  #   - passed?()
+  # -->
+  # Did this run pass?
+  #
+  def passed?: () -> true
+  include Mutex_m
+end

data/examples/rails/patch/minitest/minitest/assertion.rbs

@@ -0,0 +1,16 @@
+# <!-- rdoc-file=lib/minitest.rb -->
+# Represents run failures.
+#
+class Minitest::Assertion < ::Exception
+  def error: () -> self
+
+  # <!--
+  #   rdoc-file=lib/minitest.rb
+  #   - location()
+  # -->
+  # Where was this run before an assertion was raised?
+  #
+  def location: () -> untyped
+  def result_code: () -> untyped
+  def result_label: () -> "Failure"
+end