orthoses-rails 0.4.0 → 0.7.0

data/examples/rails/known_sig/activerecord/7.0/_active_record_relation.rbs

@@ -0,0 +1,49 @@
+interface _ActiveRecord_Relation[Model, PrimaryKey]
+  def all: () -> self
+  def ids: () -> Array[PrimaryKey]
+  def none: () -> self
+  def pluck: (Symbol | String column) -> Array[untyped]
+           | (*Symbol | String columns) -> Array[Array[untyped]]
+  def where: (*untyped) -> self
+  def not: (*untyped) -> self
+  def exists?: (*untyped) -> bool
+  def order: (*untyped) -> self
+  def group: (*Symbol | String) -> untyped
+  def distinct: () -> self
+  def or: (self) -> self
+  def merge: (self) -> self
+  def joins: (*String | Symbol) -> self
+           | (Hash[untyped, untyped]) -> self
+  def left_joins: (*String | Symbol) -> self
+           | (Hash[untyped, untyped]) -> self
+  def left_outer_joins: (*String | Symbol) -> self
+                      | (Hash[untyped, untyped]) -> self
+  def includes: (*String | Symbol) -> self
+              | (Hash[untyped, untyped]) -> self
+  def eager_load: (*String | Symbol) -> self
+                | (Hash[untyped, untyped]) -> self
+  def preload: (*String | Symbol) -> self
+             | (Hash[untyped, untyped]) -> self
+  def find_by: (*untyped) -> Model?
+  def find_by!: (*untyped) -> Model
+  def find: (PrimaryKey id) -> Model
+          | (Array[PrimaryKey]) -> Array[Model]
+          | (*PrimaryKey) -> Array[Model]
+          | () { (Model) -> boolish } -> Model?
+  def first: () -> Model?
+           | (Integer count) -> Array[Model]
+  def first!: () -> Model
+  def last: () -> Model?
+           | (Integer count) -> Array[Model]
+  def last!: () -> Model
+  def limit: (Integer | Arel::Nodes::SqlLiteral | nil) -> self
+  def limit!: (Integer | Arel::Nodes::SqlLiteral | nil) -> self
+  def find_each: (?batch_size: Integer, ?start: Integer, ?finish: Integer, ?error_on_ignore: bool) { (Model) -> void } -> nil
+  def find_in_batches: (?batch_size: Integer, ?start: Integer, ?finish: Integer, ?error_on_ignore: bool) { (self) -> void } -> nil
+  def destroy_all: () -> untyped
+  def delete_all: () -> untyped
+  def update_all: (*untyped) -> untyped
+  def each: () { (Model) -> void } -> self
+  def select: (*Symbol | String) -> self
+            | () { (Model) -> boolish } -> Array[Model]
+end

data/examples/rails/known_sig/activerecord/7.0/_active_record_relation_class_methods.rbs

@@ -0,0 +1,45 @@
+interface _ActiveRecord_Relation_ClassMethods[Model, Relation, PrimaryKey]
+  def all: () -> Relation
+  def ids: () -> Array[PrimaryKey]
+  def none: () -> Relation
+  def pluck: (Symbol | String column) -> Array[untyped]
+           | (*Symbol | String columns) -> Array[Array[untyped]]
+  def where: (*untyped) -> Relation
+  def exists?: (*untyped) -> bool
+  def order: (*untyped) -> Relation
+  def group: (*Symbol | String) -> untyped
+  def distinct: () -> self
+  def or: (Relation) -> Relation
+  def merge: (Relation) -> Relation
+  def joins: (*String | Symbol) -> self
+           | (Hash[untyped, untyped]) -> self
+  def left_joins: (*String | Symbol) -> self
+           | (Hash[untyped, untyped]) -> self
+  def left_outer_joins: (*String | Symbol) -> self
+                      | (Hash[untyped, untyped]) -> self
+  def includes: (*String | Symbol) -> self
+              | (Hash[untyped, untyped]) -> self
+  def eager_load: (*String | Symbol) -> self
+                | (Hash[untyped, untyped]) -> self
+  def preload: (*String | Symbol) -> self
+             | (Hash[untyped, untyped]) -> self
+  def find_by: (*untyped) -> Model?
+  def find_by!: (*untyped) -> Model
+  def find: (PrimaryKey id) -> Model
+          | (Array[PrimaryKey]) -> Array[Model]
+          | (*PrimaryKey) -> Array[Model]
+  def first: () -> Model?
+           | (Integer count) -> Array[Model]
+  def first!: () -> Model
+  def last: () -> Model?
+           | (Integer count) -> Array[Model]
+  def last!: () -> Model
+  def limit: (Integer | Arel::Nodes::SqlLiteral | nil) -> Relation
+  def find_each: (?batch_size: Integer, ?start: Integer, ?finish: Integer, ?error_on_ignore: bool) { (Model) -> void } -> nil
+  def find_in_batches: (?batch_size: Integer, ?start: Integer, ?finish: Integer, ?error_on_ignore: bool) { (self) -> void } -> nil
+  def destroy_all: () -> untyped
+  def delete_all: () -> untyped
+  def update_all: (*untyped) -> untyped
+  def select: (*Symbol | String) -> Relation
+            | () { (Model) -> boolish } -> Array[Model]
+end

data/examples/rails/known_sig/activesupport/7.0/active_support/duration.rbs

@@ -0,0 +1,4 @@
+class ActiveSupport::Duration
+  def since: (?untyped time) -> ::ActiveSupport::TimeWithZone
+  def ago: (?untyped time) -> ::ActiveSupport::TimeWithZone
+end

data/examples/rails/known_sig/activesupport/7.0/active_support/time_with_zone.rbs

@@ -0,0 +1,5 @@
+class ActiveSupport::TimeWithZone
+  def +: (ActiveSupport::Duration other) -> self
+  def -: (self other) -> Float
+       | (ActiveSupport::Duration other) -> self
+end

data/examples/rails/known_sig/activesupport/7.0/active_support/time_zone.rbs

@@ -0,0 +1,3 @@
+class ActiveSupport::TimeZone
+  def now: () -> ActiveSupport::TimeWithZone
+end

data/examples/rails/known_sig/activesupport/7.0/date.rbs

@@ -0,0 +1,6 @@
+class Date
+  def +: (ActiveSupport::Duration other) -> self
+    | ...
+  def -: (ActiveSupport::Duration other) -> self
+    | ...
+end

data/examples/rails/known_sig/activesupport/7.0/date_and_time/zones.rbs

@@ -0,0 +1,4 @@
+module DateAndTime::Zones
+  def in_time_zone: (?(ActiveSupport::TimeZone | String) zone) -> ::ActiveSupport::TimeWithZone
+                  | (false? zone) -> ::Time
+end

data/examples/rails/known_sig/activesupport/7.0/integer.rbs

@@ -0,0 +1,9 @@
+class Integer < ::Numeric
+  #   2.months # => 2 months
+  def months: () -> ActiveSupport::Duration
+
+  # Returns a Duration instance matching the number of years provided.
+  #
+  #   2.years # => 2 years
+  def years: () -> ActiveSupport::Duration
+end

data/examples/rails/known_sig/activesupport/7.0/numeric.rbs

@@ -0,0 +1,15 @@
+class Numeric
+  def kilobytes: () -> self
+  def megabytes: () -> self
+  def gigabytes: () -> self
+  def terabytes: () -> self
+  def petabytes: () -> self
+  def exabytes: () -> self
+  def seconds: () -> ActiveSupport::Duration
+  def minutes: () -> ActiveSupport::Duration
+  def hours: () -> ActiveSupport::Duration
+  def days: () -> ActiveSupport::Duration
+  def weeks: () -> ActiveSupport::Duration
+  def fortnights: () -> ActiveSupport::Duration
+  def in_milliseconds: () -> self
+end

data/examples/rails/known_sig/activesupport/7.0/string.rbs

@@ -0,0 +1,4 @@
+class String
+  def in_time_zone: (?(ActiveSupport::TimeZone | String) zone) -> ::ActiveSupport::TimeWithZone
+                  | (false? zone) -> ::Time
+end

data/{lib/orthoses/active_support/known_sig → examples/rails/known_sig/activesupport}/7.0/time.rbs

@@ -15,6 +15,14 @@ end
 
 class Time
   include DateAndTime::Calculations
+
+  # Returns <tt>Time.zone.now</tt> when <tt>Time.zone</tt> or <tt>config.time_zone</tt> are set, otherwise just returns <tt>Time.now</tt>.
+  def self.current: () -> ActiveSupport::TimeWithZone # strictly `(ActiveSupport::TimeWithZone | Time)` but it's inconvenient
+  def self.zone: () -> ActiveSupport::TimeZone # strictly `ActiveSupport::TimeWithZone?` but it's inconvenient
+
+  def ago: (untyped other) -> self
+  def advance: (untyped options) -> self
+  def change: (untyped options) -> self
   def in_time_zone: (?(ActiveSupport::TimeZone | String) new_zone) -> ::ActiveSupport::TimeWithZone
                   | (false? zone) -> ::Time
   def +: (ActiveSupport::Duration other) -> self

data/examples/rails/tasks/action_pack.rake

@@ -0,0 +1,141 @@
+stdlib_dependencies = %w[benchmark date digest json logger monitor mutex_m pathname singleton time minitest securerandom ipaddr did_you_mean]
+gem_dependencies = %w[nokogiri i18n rack rails-dom-testing]
+rails_dependencies = %w[activesupport actionview]
+
+VERSIONS.each do |version|
+  namespace version do
+    namespace :action_pack do
+      export = "export/actionpack/#{version}"
+
+      desc "export to #{export}"
+      task :export do
+        sh "rm -fr #{export}"
+        sh "mkdir -p #{export}"
+
+        sh "cp -a out/#{version}/action_pack.rbs #{export}"
+        sh "cp -a out/#{version}/action_pack #{export}"
+        sh "cp -a out/#{version}/action_controller.rbs #{export}"
+        sh "cp -a out/#{version}/action_controller #{export}"
+        sh "cp -a out/#{version}/action_dispatch.rbs #{export}"
+        sh "cp -a out/#{version}/action_dispatch #{export}"
+        sh "cp -a out/#{version}/abstract_controller.rbs #{export}"
+        sh "cp -a out/#{version}/abstract_controller #{export}"
+        sh "cp -a out/#{version}/mime.rbs #{export}"
+        sh "cp -a out/#{version}/mime #{export}"
+
+        sh "rm #{export}/action_controller/railtie.rbs"
+        sh "rm #{export}/action_dispatch/railtie.rbs"
+
+        Pathname(export).join("EXTERNAL_TODO.rbs").write(<<~RBS)
+          # !!! GENERATED CODE !!!
+          # Please see generators/rails-generator
+
+          class Ripper
+          end
+
+          class Delegator
+          end
+
+          class SimpleDelegator < ::Delegator
+          end
+
+          class ActionDispatch::Cookies::CookieJar
+            def to_h: () -> Hash[untyped, untyped]
+          end
+
+          module Rack
+            module Cache
+              class EntityStore
+              end
+              class MetaStore
+              end
+            end
+            module Session
+              class Dalli
+              end
+            end
+            module Test
+              class UploadedFile
+              end
+            end
+          end
+
+          module Rails
+            module Dom
+              module Testing
+                module Assertions
+                  include Rails::Dom::Testing::Assertions::SelectorAssertions
+
+                  include Rails::Dom::Testing::Assertions::DomAssertions
+
+                  extend ActiveSupport::Concern
+
+                  module DomAssertions
+                    public
+
+                    def assert_dom_equal: (untyped expected, untyped actual, ?untyped message) -> untyped
+
+                    def assert_dom_not_equal: (untyped expected, untyped actual, ?untyped message) -> untyped
+
+                    private
+
+                    def fragment: (untyped text) -> untyped
+                  end
+
+                  module SelectorAssertions
+                    include Rails::Dom::Testing::Assertions::SelectorAssertions::CountDescribable
+
+                    public
+
+                    def assert_select: (*untyped args) { (*untyped) -> untyped } -> untyped
+
+                    def assert_select_email: () { (*untyped) -> untyped } -> untyped
+
+                    def assert_select_encoded: (?untyped element) { (*untyped) -> untyped } -> untyped
+
+                    def css_select: (*untyped args) -> untyped
+
+                    private
+
+                    def assert_size_match!: (untyped size, untyped equals, untyped css_selector, ?untyped message) -> untyped
+
+                    def document_root_element: () -> untyped
+
+                    def nest_selection: (untyped selection) { (untyped) -> untyped } -> untyped
+
+                    def nodeset: (untyped node) -> untyped
+
+                    module CountDescribable
+                      extend ActiveSupport::Concern
+
+                      private
+
+                      def count_description: (untyped min, untyped max, untyped count) -> untyped
+
+                      def pluralize_element: (untyped quantity) -> untyped
+                    end
+                  end
+                end
+              end
+            end
+          end
+        RBS
+      end
+
+      desc "validate version=#{version} gem=action_pack"
+      task :validate do
+        stdlib_opt = stdlib_dependencies.map{"-r #{_1}"}.join(" ")
+        gem_opt = gem_dependencies.map{"-I ../../.gem_rbs_collection/#{_1}"}.join(" ")
+        rails_opt = rails_dependencies.map{"-I export/#{_1}/#{version}"}.join(" ")
+        sh "rbs #{stdlib_opt} #{gem_opt} #{rails_opt} -I #{export} validate --silent"
+      end
+
+      desc "install to ../../../gems/actionpack/#{version}"
+      task :install do
+        install_to = File.expand_path("../../../gems/actionpack/#{version}", __dir__)
+        sh "rm -fr #{install_to}"
+        sh "cp -a #{export} #{install_to}"
+      end
+    end
+  end
+end

data/examples/rails/tasks/action_view.rake

@@ -0,0 +1,77 @@
+stdlib_dependencies = %w[benchmark date digest json logger monitor mutex_m pathname singleton time minitest did_you_mean]
+gem_dependencies = %w[nokogiri i18n rack]
+rails_dependencies = %w[activesupport]
+
+VERSIONS.each do |version|
+  namespace version do
+    namespace :action_view do
+      export = "export/actionview/#{version}"
+
+      desc "export to #{export}"
+      task :export do
+        sh "rm -fr #{export}"
+        sh "mkdir -p #{export}"
+
+        sh "cp -a out/#{version}/action_view.rbs #{export}"
+        sh "cp -a out/#{version}/action_view #{export}"
+        sh "cp -a out/#{version}/erubi.rbs #{export}"
+        sh "cp -a out/#{version}/erubi #{export}"
+        sh "rm #{export}/action_view/railtie.rbs"
+        sh "rm -fr #{export}/action_view/test_case"
+        sh "rm #{export}/action_view/test_case.rbs"
+
+        File.open("out/#{version}/action_view/partial_renderer.rbs") do |r|
+          File.open("#{export}/action_view/partial_renderer.rbs", "w+") do |w|
+            outs = r.each_line.select do |line|
+              !line.include?("prepend ActiveRecord::Railties::CollectionCacheAssociationLoading")
+            end
+            w.puts(outs)
+          end
+        end
+
+        File.open("out/#{version}/action_view/routing_url_for.rbs") do |r|
+          File.open("#{export}/action_view/routing_url_for.rbs", "w+") do |w|
+            outs = r.each_line.select do |line|
+              !line.include?("include ActionDispatch::Routing::UrlFor")
+            end
+            w.puts(outs)
+          end
+        end
+
+        Pathname(export).join("EXTERNAL_TODO.rbs").write(<<~RBS)
+          # !!! GENERATED CODE !!!
+          # Please see generators/rails-generator
+
+          class Ripper
+          end
+
+          class Delegator
+          end
+
+          class SimpleDelegator < ::Delegator
+          end
+
+          module ERB
+            module Util
+            end
+          end
+        RBS
+      end
+
+      desc "validate version=#{version} gem=action_view"
+      task :validate do
+        stdlib_opt = stdlib_dependencies.map{"-r #{_1}"}.join(" ")
+        gem_opt = gem_dependencies.map{"-I ../../.gem_rbs_collection/#{_1}"}.join(" ")
+        rails_opt = rails_dependencies.map{"-I export/#{_1}/#{version}"}.join(" ")
+        sh "rbs #{stdlib_opt} #{gem_opt} #{rails_opt} -I #{export} validate --silent"
+      end
+
+      desc "install to ../../../gems/actionview/#{version}"
+      task :install do
+        install_to = File.expand_path("../../../gems/actionview/#{version}", __dir__)
+        sh "rm -fr #{install_to}"
+        sh "cp -a #{export} #{install_to}"
+      end
+    end
+  end
+end

data/examples/rails/tasks/active_job.rake

@@ -0,0 +1,99 @@
+stdlib_dependencies = %w[time monitor singleton logger mutex_m json date benchmark digest minitest]
+gem_dependencies = %w[nokogiri]
+rails_dependencies = %w[activesupport]
+
+VERSIONS.each do |version|
+  namespace version do
+    namespace :active_job do
+      export = "export/activejob/#{version}"
+
+      desc "export to #{export}"
+      task :export do
+        sh "rm -fr #{export}"
+        sh "mkdir -p #{export}"
+
+        sh "cp -a out/#{version}/active_job.rbs #{export}"
+        sh "cp -a out/#{version}/active_job #{export}"
+        sh "rm #{export}/active_job/railtie.rbs"
+
+        Pathname(export).join("EXTERNAL_TODO.rbs").write(<<~RBS)
+          # !!! GENERATED CODE !!!
+          # Please see generators/rails-generator
+
+          module Que
+            class Job
+            end
+          end
+          module Qu
+            class Job
+            end
+          end
+        RBS
+
+        generate_test_script(
+          gem: :activejob,
+          version: version,
+          export: export,
+          stdlib_dependencies: stdlib_dependencies,
+          gem_dependencies: gem_dependencies,
+          rails_dependencies: rails_dependencies,
+        )
+
+        Pathname(export).join('_test').join('test.rb').write(<<~RUBY)
+          # !!! GENERATED CODE !!!
+          # Please see generators/rails-generator
+
+          class SendMessageJob < ActiveJob::Base
+            queue_as :default
+            self.queue_adapter = :sidekiq
+
+            before_enqueue do |job|
+              # before enqueued
+            end
+
+            around_perform :around_task
+
+            def perform(*args)
+              # Do something later
+            end
+
+            private
+
+            def around_task
+              # Do something before
+              # yield
+              # Do something after
+            end
+          end
+
+          SendMessageJob.perform_now
+          SendMessageJob.set(queue: :another_queue).perform_later(flag: false)
+        RUBY
+
+        Pathname(export).join('_test').join('test.rbs').write(<<~RBS)
+          # !!! GENERATED CODE !!!
+          # Please see generators/rails-generator
+
+          class SendMessageJob < ActiveJob::Base
+            def perform: (*untyped) -> void
+          end
+        RBS
+      end
+
+      desc "validate version=#{version} gem=active_job"
+      task :validate do
+        stdlib_opt = stdlib_dependencies.map{"-r #{_1}"}.join(" ")
+        gem_opt = gem_dependencies.map{"-I ../../.gem_rbs_collection/#{_1}"}.join(" ")
+        rails_opt = rails_dependencies.map{"-I export/#{_1}/#{version}"}.join(" ")
+        sh "rbs #{stdlib_opt} #{gem_opt} #{rails_opt} -I #{export} validate --silent"
+      end
+
+      desc "install to ../../../gems/activejob/#{version}"
+      task :install do
+        install_to = File.expand_path("../../../gems/activejob/#{version}", __dir__)
+        sh "rm -fr #{install_to}"
+        sh "cp -a #{export} #{install_to}"
+      end
+    end
+  end
+end

data/examples/rails/tasks/active_model.rake

@@ -0,0 +1,46 @@
+stdlib_dependencies = %w[benchmark date digest forwardable json logger monitor mutex_m singleton time minitest]
+gem_dependencies = %w[nokogiri]
+rails_dependencies = %w[activesupport]
+
+VERSIONS.each do |version|
+  namespace version do
+    namespace :active_model do
+      export = "export/activemodel/#{version}"
+
+      desc "export to #{export}"
+      task :export do
+        sh "rm -fr #{export}"
+        sh "mkdir -p #{export}"
+
+        sh "cp -a out/#{version}/active_model.rbs #{export}"
+        sh "cp -a out/#{version}/active_model #{export}"
+        sh "rm #{export}/active_model/railtie.rbs"
+
+        Pathname(export).join("EXTERNAL_TODO.rbs").write(<<~RBS)
+          # !!! GENERATED CODE !!!
+          # Please see generators/rails-generator
+
+          class Delegator
+          end
+          class SimpleDelegator < Delegator
+          end
+        RBS
+      end
+
+      desc "validate version=#{version} gem=active_model"
+      task :validate do
+        stdlib_opt = stdlib_dependencies.map{"-r #{_1}"}.join(" ")
+        gem_opt = gem_dependencies.map{"-I ../../.gem_rbs_collection/#{_1}"}.join(" ")
+        rails_opt = rails_dependencies.map{"-I export/#{_1}/#{version}"}.join(" ")
+        sh "rbs #{stdlib_opt} #{gem_opt} #{rails_opt} -I #{export} validate --silent"
+      end
+
+      desc "install to ../../../gems/activemodel/#{version}"
+      task :install do
+        install_to = File.expand_path("../../../gems/activemodel/#{version}", __dir__)
+        sh "rm -fr #{install_to}"
+        sh "cp -a #{export} #{install_to}"
+      end
+    end
+  end
+end

data/examples/rails/tasks/active_record.rake

@@ -0,0 +1,88 @@
+stdlib_dependencies = %w[time monitor singleton logger mutex_m json date benchmark digest forwardable did_you_mean openssl socket minitest]
+gem_dependencies = %w[nokogiri]
+rails_dependencies = %w[activesupport activemodel]
+
+VERSIONS.each do |version|
+  namespace version do
+    namespace :active_record do
+      export = "export/activerecord/#{version}"
+
+      desc "export to #{export}"
+      task :export do
+        sh "rm -fr #{export}"
+        sh "mkdir -p #{export}"
+
+        sh "cp -a out/#{version}/active_record.rbs #{export}"
+        sh "cp -a out/#{version}/active_record #{export}"
+        sh "cp -a out/#{version}/arel #{export}"
+        sh "cp -a out/#{version}/arel.rbs #{export}"
+        sh "cp -a out/#{version}/_active_record_relation.rbs #{export}"
+
+        sh "rm #{export}/active_record/railtie.rbs"
+        sh "rm -fr #{export}/active_record/connection_adapters" # FIXME
+        sh "rm -fr #{export}/active_record/migration/compatibility" # FIXME
+        sh "rm -f #{export}/active_record/destroy_association_async_job.rbs" # move to railties
+
+        sh "cat out/#{version}/active_record/base.rbs | grep -v ActiveStorage > #{export}/active_record/base.rbs"
+
+        Pathname(export).join("EXTERNAL_TODO.rbs").write(<<~RBS)
+          # !!! GENERATED CODE !!!
+          # Please see generators/rails-generator
+
+          module PG
+            class SimpleDecoder
+            end
+          end
+          module GlobalID
+            module Identification
+            end
+            module FixtureSet
+            end
+          end
+        RBS
+
+        generate_test_script(
+          gem: :activerecord,
+          version: version,
+          export: export,
+          stdlib_dependencies: stdlib_dependencies,
+          gem_dependencies: gem_dependencies,
+          rails_dependencies: rails_dependencies,
+        )
+
+        Pathname(export).join('_test').join('test.rb').write(<<~RUBY)
+          # !!! GENERATED CODE !!!
+          # Please see generators/rails-generator
+
+          class User < ActiveRecord::Base
+          end
+
+          user = User.new
+        RUBY
+
+        Pathname(export).join('_test').join('test.rbs').write(<<~RBS)
+          # !!! GENERATED CODE !!!
+          # Please see generators/rails-generator
+
+          class User < ActiveRecord::Base
+          end
+        RBS
+      end
+
+      desc "validate version=#{version} gem=active_record"
+      task :validate do
+        stdlib_opt = stdlib_dependencies.map{"-r #{_1}"}.join(" ")
+        gem_opt = gem_dependencies.map{"-I ../../.gem_rbs_collection/#{_1}"}.join(" ")
+        rails_opt = rails_dependencies.map{"-I export/#{_1}/#{version}"}.join(" ")
+        sh "rbs #{stdlib_opt} #{gem_opt} #{rails_opt} -I #{export} validate --silent"
+      end
+
+      desc "install to ../../../gems/activerecord/#{version}"
+      task :install do
+        install_to = File.expand_path("../../../gems/activerecord/#{version}", __dir__)
+        sh "rm -fr #{install_to}"
+        sh "cp -a #{export} #{install_to}"
+      end
+    end
+  end
+end