orthoses-rails 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c109c955af37e4574528af34d8a3695450abf39f5359729625307c368b961259
-  data.tar.gz: 29d4ad1bf3e9d4a8d18e3108899c83cd133221d3f2dc1b3f3a6cb2165684c830
+  metadata.gz: 46bcd93481527f23bfe512d336313721f7cf17fe67bb124e51e016f59cff14c2
+  data.tar.gz: 7a783be26aeeb877069e4c0e431765e274bb07dd25438669ca8dbb58c6417405
 SHA512:
-  metadata.gz: f491dab5ce7ce402058fec79a42c1c776434bbb88adedd8928b70031f614ef57051d9501c279c628903269413e55db24e3c9493101e79c758cfb5a202ba41f37
-  data.tar.gz: 701d609fb62bfa2d9ac0e226090844bc93d526328121516cc07cb3c8424c3f2992b4f365c3cb0680379c972238b68a3fdaa87d36a0c4849803732a5603b09f3f
+  metadata.gz: ef3237aa508e90177b76dd160456404cf37dfcd1907b18ad299b1cd2f95e1abd4971762de5a0679850943b220348b7f7528689eef31be84651a30cbb29eb2601
+  data.tar.gz: 353ee63dc4a5bd7fa82fa59f571766b842690c09bd98d14e4f3f1defbb77ec14870f361149b3ac0ab6b46cad9b933f02ecaf8190a5824a4e3739b088ba14bea4

data/README.md

@@ -5,42 +5,36 @@ 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`.
+### Orthoses::ActiveModel
+
+- `HasSecurePassword`
+  - Add signatures that generated form `has_secure_password`.
+
+### Orthoses::ActiveRecord
+
+- `BelongsTo`
+  - Add signatures that generated form `belongs_to`.
+- `DelegatedType`
+  - Add signatures that generated from `delegated_type`
+- `Enum`
+  - Add signatures that generated from `enum`
+- `HasMany`
+  - Add signatures that generated form `has_many`.
+- `HasOne`
+  - Add signatures that generated form `has_one`.
+- `Scope`
+  - Add signatures that generated form `scope`.
+
+### Orthoses::ActiveSupport
+
+- `ClassAttribute`
+  - Add signatures that generated form `class_attribute`.
+- `Configurable`
+  - Add signatures that generated from `config_accessor`
+- `Delegation`
+  - Add signatures that generated from `delegate`. The type definition of the method or instance variable specified by `to` is required.
+- `MattrAccessor`
+  - Add signatures that generated form `mattr_accessor`, `cattr_accessor`, `mattr_reader`, `cattr_reader`, `mattr_writer` and `cattr_writer`.
 
 ## Installation
 
@@ -68,16 +62,14 @@ Orthoses::Builder.new do
   use YourCustom::Middleware
   use Orthoses::ActiveModel::HasSecurePassword
   use Orthoses::ActiveRecord::BelongsTo
-  use Orthoses::ActiveRecord::GeneratedAttributeMethods
   use Orthoses::ActiveRecord::HasMany
   use Orthoses::ActiveRecord::HasOne
-  use Orthoses::ActiveSupport::Concern
   use Orthoses::ActiveSupport::ClassAttribute
   use Orthoses::ActiveSupport::MattrAccessor
-  use Orthoses::ActiveSupport::TimeWithZone
   use Orthoses::Mixin
   use Orthoses::Constant, strict: false
   use Orthoses::ObjectSpaceAll
+  use Orthoses::Autoload
   run -> () {
     Rake::Task[:environment].invoke
     Rails.application.eager_load!

data/examples/rails/Rakefile

@@ -1,49 +1,26 @@
-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
+## run `$ rake`
 
 def switch_branch(name)
-  cd "src" do
+  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 "rails/all"
-    require "rails/app_updater"
-    require "active_support"
+    require "active_support/all"
     require "active_record"
     require "active_job"
     require "active_model"
-    require "active_storage"
+    require "active_storage/engine"
     require "action_dispatch"
     require "action_mailbox"
     require "action_mailer"
@@ -70,12 +47,21 @@ def generate(out_dir, version)
       v = rails_mod.respond_to?(:version) ? rails_mod.version : nil
       puts "loaded #{rails_mod}: v#{v}"
     end
-    Orthoses::Utils.unautoload!
+    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 !!!"
+      header: "# !!! GENERATED CODE !!!\n# Please see generators/rails-generator"
     use Orthoses::AvoidRecursiveAncestorError
     use Orthoses::Filter,
       if: -> (name, content) {
@@ -88,6 +74,9 @@ def generate(out_dir, version)
         # 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,
@@ -102,14 +91,13 @@ def generate(out_dir, version)
       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')
+      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: Dir.glob('known_sig/**/*.rbs')
-    # require in method
+      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")
@@ -192,53 +180,136 @@ def generate(out_dir, version)
       # 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::DelegateClass
-    use Orthoses::Attribute
     use Orthoses::RBSPrototypeRB,
-      paths: Dir.glob('src/{railties,action{cable,mailbox,mailer,pack,text,view},active{job,model,record,storage,support}}/lib/**/*.rb'),
+      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 }
+      mixin_filter: -> (member) { false },
+      attribute_filter: -> (member) { false }
+    use Orthoses::Autoload
     run loader
   end.call
 
-  sh "rbs --collection ../../rbs_collection.yaml -I #{out_dir}/#{version}/ validate --silent"
   # $ cat out/7.0/**/*.rbs | wc
-  # 72210  332252 2551928
+  # 69763  339342 2606899
 end
 
-namespace :generate do
-  task :v60 do
-    switch_branch("6-0-stable")
-    run_child_process { generate("out", "6.0") }
-  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
 
-  task :v61 do
-    switch_branch("6-1-stable")
-    run_child_process { generate("out", "6.1") }
-  end
+    # !!! GENERATED CODE !!!
+    # Please see generators/rails-generator
 
-  task :v70 do
-    switch_branch("7-0-stable")
-    run_child_process { generate("out", "7.0") }
-  end
+    # 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
 
-task :test do
-  sh "steep check"
+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,
-
-  'generate:v60',
-  'generate:v61',
-  'generate:v70',
+  *(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