orthoses-rails 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdff122ed7b5425e10cdf2fa105b8ffb7a583554589f93f8703bb014abbbafd0
-  data.tar.gz: 6d991ce9480237d0f605bbb3935c50f072c6794594b037e459ef3c0dfdcb92c3
+  metadata.gz: bf5adf50ae35b548291c69ba03b7eb6086e1214c863b83c85de0af3c81de3b17
+  data.tar.gz: a162e4dc8583a4a738ac38b41ee7fb65db67349e08b2ead5f8bfc41bc3b057c1
 SHA512:
-  metadata.gz: 2f1c3be987e9a8096a89918e4c16ef4ad8170c9e77d3e7a074541c98f4255944dde188b74f3d4693764e1f77d7fc600f6e67f9be6309aa2c433cecc746439af3
-  data.tar.gz: 49eaa832bc2a488b0b390df8fa962990898c6e9873f1476e9eae17d94073f9bc2e538be6fba54ebeaca7e33cc4245f0a68fff705f069e009c8284973d14906b8
+  metadata.gz: 8c5494faf887bb600e081967321ec6c25e24610206de9014323f13e6b43147711eb05fd1d670f815adca2739f8f80988823a5c7b06adcc193092144b7aafb0d3
+  data.tar.gz: 119911fd1cd01d7fc059fc3c23f989573771126a5ca4aa4a7091a7ca604a0a6d5d86726eda48312969695a30ec70498dd2af060231abca09aecb56212cfa2b68

data/examples/rails/Rakefile

@@ -0,0 +1,315 @@
+## run `$ rake`
+
+def switch_branch(name)
+  cd "_src" do
+    sh "git switch #{name}"
+  end
+end
+
+def generate(out_dir, version)
+  require 'orthoses'
+  require 'orthoses-rails'
+  require 'openssl'
+  require 'cgi'
+  require 'uri'
+
+  Orthoses.logger.level = :error
+
+  loader = -> () {
+    require "active_support/all"
+    require "active_record"
+    require "active_job"
+    require "active_model"
+    require "active_storage/engine"
+    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
+    eval(<<~RUBY)
+      module Dummy
+        class Application < Rails::Application
+          config.load_defaults #{version.to_s}
+          config.active_storage.service = :local
+        end
+      end
+    RUBY
+    ENV['RAILS_ENV'] = 'development'
+    Rails.application.initialize!
+  }
+  Orthoses::Builder.new do
+    use Orthoses::CreateFileByName,
+      base_dir: "#{out_dir}/#{version}",
+      header: "# !!! GENERATED CODE !!!\n# Please see generators/rails-generator"
+    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::LoadRBS,
+      paths: -> { Orthoses::PathHelper.best_version_paths(::ActiveRecord::VERSION::STRING, "known_sig/activerecord") }
+    use Orthoses::LoadRBS,
+      paths: -> { Orthoses::PathHelper.best_version_paths(::ActiveModel::VERSION::STRING, "known_sig/activemodel") }
+    use Orthoses::LoadRBS,
+      paths: -> { Orthoses::PathHelper.best_version_paths(::ActiveSupport::VERSION::STRING, "known_sig/activesupport") }
+    # # 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}}/{app,lib}/**/*.rb'),
+      constant_filter: -> (member) { false },
+      mixin_filter: -> (member) { false },
+      attribute_filter: -> (member) { false }
+    use Orthoses::Autoload
+    run loader
+  end.call
+
+  # $ cat out/7.0/**/*.rbs | wc
+  # 69763  339342 2606899
+end
+
+def generate_test_script(gem:, version:, export:, stdlib_dependencies:, gem_dependencies:, rails_dependencies:)
+  Pathname(export).join('_scripts').tap(&:mkdir).join('test').write(<<~SHELL)
+    #!/usr/bin/env bash
+
+    # !!! GENERATED CODE !!!
+    # Please see generators/rails-generator
+
+    # 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 #{stdlib_dependencies.map{"-r #{_1}"}.join(" ")} \\
+      #{gem_dependencies.map{"-r #{_1}"}.join(" ")} \\
+      -r #{gem} validate --silent
+
+    cd ${RBS_DIR}/_test
+    # Run type checks
+    bundle exec steep check
+  SHELL
+
+  sh "chmod +x #{Pathname(export).join('_scripts').join('test')}"
+
+  Pathname(export).join('_test').tap(&:mkdir).join('Steepfile').write(<<~RUBY)
+    # !!! GENERATED CODE !!!
+    # Please see generators/rails-generator
+
+    D = Steep::Diagnostic
+
+    target :test do
+      signature "."
+      check "."
+
+      repo_path "../../../"
+
+    #{stdlib_dependencies.map{"  library \"#{_1}\""}.join("\n")}
+    #{gem_dependencies.map{"  library \"#{_1}\""}.join("\n")}
+
+      library "#{gem}:#{version}"
+
+      configure_code_diagnostics(D::Ruby.all_error)
+    end
+  RUBY
+end
+
+VERSIONS = %w[
+  6.0
+  6.1
+  7.0
+]
+Object.private_constant :VERSIONS
+
+GEMS = %w[
+  active_support
+  active_model
+  active_record
+  active_job
+  active_storage
+]
+Object.private_constant :GEMS
+
+task :clean do
+  FileUtils.rm_rf("out")
+end
+
+namespace :bundle do
+  task :update do
+    VERSIONS.each do |version|
+      sh "BUNDLE_GEMFILE=gemfiles/Gemfile_#{version.tr('.', '_')} bundle update"
+    end
+  end
+end
+
+VERSIONS.each do |version|
+  namespace version do
+    desc "run all version=#{version}"
+    task :all => [
+      "#{version}:generate",
+      *(GEMS.map{"#{version}:#{_1}:export"}),
+      # *(GEMS.map{"#{version}:#{_1}:validate"}),
+      # *(GEMS.map{"#{version}:#{_1}:install"})
+    ]
+
+    desc "generate version=#{version}"
+    task :generate do |t|
+      gemfile = File.expand_path("gemfiles/Gemfile_#{version.tr('.', '_')}")
+      sh "BUNDLE_GEMFILE=#{gemfile} bundle install"
+      sh "BUNDLE_GEMFILE=#{gemfile} bundle exec rake #{t.name}_exec"
+    end
+
+    task :generate_exec do
+      switch_branch("#{version.tr('.', '-')}-stable")
+      generate("out", version)
+    end
+  end
+end
+
+load 'tasks/active_job.rake'
+load 'tasks/active_model.rake'
+load 'tasks/active_record.rake'
+load 'tasks/active_storage.rake'
+load 'tasks/active_support.rake'
+
+task default: [
+  :clean,
+  *(VERSIONS.map {"#{_1}:all"})
+]

data/examples/rails/config/database.yml

@@ -0,0 +1,8 @@
+development:
+  primary: &primary
+    adapter: sqlite3
+    pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+    timeout: 5000
+    database: ':memory:'
+  replica:
+    <<: *primary

data/examples/rails/config/storage.yml

@@ -0,0 +1,3 @@
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>

data/examples/rails/gemfiles/Gemfile_6_0

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+ruby "~> 3.1.0"
+
+gemspec path: '../../../'
+
+gem "rails", ">= 6.0", "< 6.1"
+gem "sqlite3"
+# gem "orthoses", path: "../../../../orthoses"
+
+if RUBY_VERSION >= "3.1"
+  gem "net-smtp", require: false
+  gem "net-imap", require: false
+  gem "net-pop", require: false
+  gem "psych", "~> 3"
+end

data/examples/rails/gemfiles/Gemfile_6_0.lock

@@ -0,0 +1,172 @@
+PATH
+  remote: ../../..
+  specs:
+    orthoses-rails (0.4.0)
+      orthoses (>= 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.5)
+      actionpack (= 6.0.5)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.5)
+      actionpack (= 6.0.5)
+      activejob (= 6.0.5)
+      activerecord (= 6.0.5)
+      activestorage (= 6.0.5)
+      activesupport (= 6.0.5)
+      mail (>= 2.7.1)
+    actionmailer (6.0.5)
+      actionpack (= 6.0.5)
+      actionview (= 6.0.5)
+      activejob (= 6.0.5)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.5)
+      actionview (= 6.0.5)
+      activesupport (= 6.0.5)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.5)
+      actionpack (= 6.0.5)
+      activerecord (= 6.0.5)
+      activestorage (= 6.0.5)
+      activesupport (= 6.0.5)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.5)
+      activesupport (= 6.0.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.5)
+      activesupport (= 6.0.5)
+      globalid (>= 0.3.6)
+    activemodel (6.0.5)
+      activesupport (= 6.0.5)
+    activerecord (6.0.5)
+      activemodel (= 6.0.5)
+      activesupport (= 6.0.5)
+    activestorage (6.0.5)
+      actionpack (= 6.0.5)
+      activejob (= 6.0.5)
+      activerecord (= 6.0.5)
+      marcel (~> 1.0)
+    activesupport (6.0.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    digest (3.1.0)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.16.1)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    orthoses (0.10.0)
+      rbs (~> 2.0)
+    psych (3.3.2)
+    racc (1.6.0)
+    rack (2.2.3.1)
+    rack-test (2.0.0)
+      rack (>= 1.3)
+    rails (6.0.5)
+      actioncable (= 6.0.5)
+      actionmailbox (= 6.0.5)
+      actionmailer (= 6.0.5)
+      actionpack (= 6.0.5)
+      actiontext (= 6.0.5)
+      actionview (= 6.0.5)
+      activejob (= 6.0.5)
+      activemodel (= 6.0.5)
+      activerecord (= 6.0.5)
+      activestorage (= 6.0.5)
+      activesupport (= 6.0.5)
+      bundler (>= 1.3.0)
+      railties (= 6.0.5)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (6.0.5)
+      actionpack (= 6.0.5)
+      activesupport (= 6.0.5)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.6)
+    rbs (2.6.0)
+    sprockets (4.1.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.4)
+    strscan (3.0.3)
+    thor (1.2.1)
+    thread_safe (0.3.6)
+    timeout (0.3.0)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  net-imap
+  net-pop
+  net-smtp
+  orthoses-rails!
+  psych (~> 3)
+  rails (>= 6.0, < 6.1)
+  sqlite3
+
+RUBY VERSION
+   ruby 3.1.1p18
+
+BUNDLED WITH
+   2.3.9

data/examples/rails/gemfiles/Gemfile_6_1

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+ruby "~> 3.1.0"
+
+gemspec path: '../../../'
+
+gem "rails", ">= 6.1", "< 7"
+gem "sqlite3"
+# gem "orthoses", path: "../../../../orthoses"
+
+if RUBY_VERSION >= "3.1"
+  gem "net-smtp", require: false
+  gem "net-imap", require: false
+  gem "net-pop", require: false
+end