rbs_rails 0.8.2 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d70009e239cba7c79ad16cf1861495051952a6930205678b05fcf5ad97f0809
-  data.tar.gz: 20e8d58362c2222651aa10430417ac90af1b8e38e5b3bbfcfdf43f186f77eff6
+  metadata.gz: 16dd1379f4621410d78e352c8fdc8750d3fb469d8c395aee77de85d2f8570279
+  data.tar.gz: e50b75cc1e64a8630c1508805d146d2cf5edad065cdcab502f910fcb84bc51ef
 SHA512:
-  metadata.gz: ef998ce7910f4169eb43716ed8ad0132338751b0c9346213cb02ddecae71fe1c0159d8eb2404877cd599dbd352fe42d3d52bd1316f6577fe2568c912ec0f402a
-  data.tar.gz: 846055b9290bfb250e933686a7dcd05bd52ff331cc1a83a3ddae4cd05ff480b2b43b7c164dbbbff164f25c568837b9d30353eb787464f430b08ffbed69737add
+  metadata.gz: 12136882eeebf0e2219af85c6393f6b8a74c4bc6f268b57d5b9c931a99fa42ee81ed9deb9885d4209f28dbf43d9d57563641379031c199397cf520a7dc417f10
+  data.tar.gz: 40ffd8a1525501f736f759769a95183e3933da0c1063e5e939b6c4ccf23ae9d98731ef782c23f6c7eb6b7280b2c39f535379886edeb3abeb423810cf2ead58ac

data/.dependabot/config.yml

@@ -3,6 +3,3 @@ update_configs:
   - package_manager: "ruby:bundler"
     directory: "/"
     update_schedule: "live"
-  - package_manager: "ruby:bundler"
-    directory: "/test/app/"
-    update_schedule: "live"

data/.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, '3.0', head]
+        ruby: [2.6, 2.7, '3.0', 3.1, head]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
@@ -23,7 +23,5 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: bin/gem_rbs
+    - run: bin/setup
     - run: bundle exec rake

data/.gitignore

@@ -9,4 +9,4 @@
 /test/app/sig/rbs_rails
 /test/app/sig/app
 /test/app/sig/path_helpers.rbs
-/gem_rbs
+/.gem_rbs_collection/

data/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 ## master (unreleased)
 
+## 0.10.1 (2022-03-23)
+
+### Bug Fixes
+
+* Generate dependency types of relations. [#216](https://github.com/pocke/rbs_rails/pull/216)
+
+## 0.10.0 (2022-03-18)
+
+### New Features
+
+* Support `has_secure_password`. [#193](https://github.com/pocke/rbs_rails/pull/193)
+* Support Active Storage. [#195](https://github.com/pocke/rbs_rails/pull/195)
+
+### Bug Fixes
+
+* Use absolute path for class names to avoid using incorrect class. [#201](https://github.com/pocke/rbs_rails/pull/201)
+* Fix NoMethodError on enum with `_default` option. [#208](https://github.com/pocke/rbs_rails/pull/208)
+
+## 0.9.0 (2021-09-18)
+
+### New Features
+
+* Support delegated_type association. [#181](https://github.com/pocke/rbs_rails/pull/181)
+
+### Bug Fixes
+
+* Fix error on a table that doesn't have the PK. [#121](https://github.com/pocke/rbs_rails/pull/121)
+* Quote variable names to avoid syntax errors. [#178](https://github.com/pocke/rbs_rails/pull/178)
+* Add scope methods to `ActiveRecord_Associations_CollectionProxy`. [#182](https://github.com/pocke/rbs_rails/pull/182)
+* Make `has_one` association optional. [#180](https://github.com/pocke/rbs_rails/pull/180)
+* Omit some methods for polymorphic associations. [#184](https://github.com/pocke/rbs_rails/pull/184)
+* Include enum methods to GeneratedRelationMethods. [#183](https://github.com/pocke/rbs_rails/pull/183)
+* Include `_ActiveRecord_Relation` to `CollectionProxy`. [#189](https://github.com/pocke/rbs_rails/pull/189)
+
 ## 0.8.2 (2021-02-20)
 
 *  Add ActiveRecord::AttributeMethods::Dirty methods [#104](https://github.com/pocke/rbs_rails/pull/104)

data/DESIGN.md

@@ -0,0 +1,36 @@
+# RBS Generator for Active Record models
+
+The RBS generator for Active Record models focus on generating methods that are generated by Active Record.
+For example, it generates the following things.
+
+* Classes which inherit `ActiveRecord::Base`
+* Generated methods by Active Record
+  * Column methods. e.g. `name` and `name=` methods for `name` column.
+  * Relation methods. e.g. `users` and `users=` methods for `has_many :users`.
+  * And so on.
+
+I designed it generates "valid" RBSs. "valid" means the generated RBSs pass `rbs validate` only with `rbs collection`.
+So if you need to do something to pass `rbs validate`, it's a bug. For example, if you see `RBS::NoSuperclassFoundError` for the generated RBS, it is a bug.
+
+RBS Rails focuses on generating "generated" methods. It means it doesn't generate methods that are defined by the user.
+For example:
+
+```ruby
+class User < ApplicationRecord
+  # RBS Rails generates articles methods and so on
+  # becasue they are generated by Active Record.
+  has_many :articles
+
+  # RBS Rails does NOT generate full_name method
+  # because the user defines it.
+  def full_name
+    first_name + last_name
+  end
+end
+```
+
+You can use `rbs prototype rb`, `rbs prototype runtime` and `typeprof` commands to generate them.
+
+# RBS Generator for the path helper
+
+TODO

data/Gemfile

@@ -1,9 +1,12 @@
 source "https://rubygems.org"
 
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
 # Specify your gem's dependencies in rbs_rails.gemspec
 gemspec
 
 gem "rake", "~> 13.0"
-gem 'rbs', '>= 1.0.0'
-gem 'steep', '>= 0.34.0'
+gem 'rails', '< 7', '>= 6.0'
+gem 'rbs', '>= 2'
+gem 'steep'
 gem 'minitest'

data/Gemfile.lock

@@ -1,50 +1,165 @@
 PATH
   remote: .
   specs:
-    rbs_rails (0.8.2)
+    rbs_rails (0.10.1)
       parser
       rbs (>= 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.2.1)
+    actioncable (6.1.5)
+      actionpack (= 6.1.5)
+      activesupport (= 6.1.5)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.5)
+      actionpack (= 6.1.5)
+      activejob (= 6.1.5)
+      activerecord (= 6.1.5)
+      activestorage (= 6.1.5)
+      activesupport (= 6.1.5)
+      mail (>= 2.7.1)
+    actionmailer (6.1.5)
+      actionpack (= 6.1.5)
+      actionview (= 6.1.5)
+      activejob (= 6.1.5)
+      activesupport (= 6.1.5)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.5)
+      actionview (= 6.1.5)
+      activesupport (= 6.1.5)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.5)
+      actionpack (= 6.1.5)
+      activerecord (= 6.1.5)
+      activestorage (= 6.1.5)
+      activesupport (= 6.1.5)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.5)
+      activesupport (= 6.1.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.5)
+      activesupport (= 6.1.5)
+      globalid (>= 0.3.6)
+    activemodel (6.1.5)
+      activesupport (= 6.1.5)
+    activerecord (6.1.5)
+      activemodel (= 6.1.5)
+      activesupport (= 6.1.5)
+    activestorage (6.1.5)
+      actionpack (= 6.1.5)
+      activejob (= 6.1.5)
+      activerecord (= 6.1.5)
+      activesupport (= 6.1.5)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
-    ast_utils (0.4.0)
-      parser (>= 2.7.0)
-    concurrent-ruby (1.1.8)
-    ffi (1.14.2)
-    i18n (1.8.9)
+    builder (3.2.4)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    erubi (1.10.0)
+    ffi (1.15.5)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    language_server-protocol (3.15.0.1)
-    listen (3.4.1)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    minitest (5.14.3)
-    parser (3.0.0.0)
+    loofah (2.15.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.15.0)
+    nio4r (2.5.8)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    rb-fsevent (0.10.4)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.5)
+      actioncable (= 6.1.5)
+      actionmailbox (= 6.1.5)
+      actionmailer (= 6.1.5)
+      actionpack (= 6.1.5)
+      actiontext (= 6.1.5)
+      actionview (= 6.1.5)
+      activejob (= 6.1.5)
+      activemodel (= 6.1.5)
+      activerecord (= 6.1.5)
+      activestorage (= 6.1.5)
+      activesupport (= 6.1.5)
+      bundler (>= 1.15.0)
+      railties (= 6.1.5)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.5)
+      actionpack (= 6.1.5)
+      activesupport (= 6.1.5)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (1.0.6)
-    steep (0.41.0)
+    rbs (2.2.2)
+    sprockets (4.0.3)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    steep (0.49.1)
       activesupport (>= 5.1)
-      ast_utils (>= 0.4.0)
-      language_server-protocol (~> 3.15.0.1)
+      language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
-      parser (>= 2.7)
+      parallel (>= 1.0.0)
+      parser (>= 3.0)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (~> 1.0.3)
+      rbs (>= 2.2.0)
+      terminal-table (>= 2, < 4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -52,10 +167,11 @@ PLATFORMS
 
 DEPENDENCIES
   minitest
+  rails (>= 6.0, < 7)
   rake (~> 13.0)
-  rbs (>= 1.0.0)
+  rbs (>= 2)
   rbs_rails!
-  steep (>= 0.34.0)
+  steep
 
 BUNDLED WITH
-   2.2.4
+   2.3.9

data/README.md

@@ -35,46 +35,34 @@ Then, the following three tasks are available.
 * `rbs_rails:all`: Execute all tasks of RBS Rails
 
 
+### Install RBS for `rails` gem
 
+You need to install `rails` gem's RBS files. I highly recommend using `rbs collection`.
+
+1. Add `gem 'rails'` to your `Gemfile`.
+1. Then execute the following commands
+   ```console
+   $ bundle install
+   $ bundle exec rbs collection install
+   ```
 
 ### Steep integration
 
-You need to specify the following libraries by `Steepfile`.
+Put the following code as `Steepfile`.
 
 ```ruby
-# Steepfile
-
 target :app do
   signature 'sig'
 
   check 'app'
-
-  repo_path "path/to/rbs_repo"
-
-  library 'pathname'
-  library 'logger'
-  library 'mutex_m'
-  library 'date'
-  library 'monitor'
-  library 'singleton'
-  library 'tsort'
-
-  library 'activesupport'
-  library 'actionpack'
-  library 'activejob'
-  library 'activemodel'
-  library 'actionview'
-  library 'activerecord'
-  library 'railties'
 end
 ```
 
-You need to put RBS repo to `path/to/rbs_repo`. See https://github.com/ruby/gem_rbs
+That's all! Now you can check your Rails app statically with `steep check` command.
 
 ## Development
 
-After checking out the repo, run `GITHUB_TOKEN=xxx bin/setup` to install dependencies.
-`GITHUB_TOKEN` environment variable is required to fetch RBS from [ruby/gem_rbs](https://github.com/ruby/gem_rbs) repository.
+After checking out the repo, run `bin/setup` to install dependencies.
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/Rakefile

@@ -9,8 +9,10 @@ task :steep do
 end
 
 task :rbs_validate do
-  rbs = Pathname(__dir__).join('bin/rbs').to_s
-  sh "ruby #{rbs} validate --silent"
+  repo = ENV['RBS_REPO_DIR']&.then do |env|
+    "--repo=#{env}"
+  end
+  sh "rbs #{repo} validate --silent"
 end
 
 Rake::TestTask.new do |test|

data/Steepfile

@@ -3,21 +3,5 @@ target :lib do
   signature 'assets/sig'
 
   check "lib"                       # Directory name
-  repo_path ENV['RBS_REPO_DIR'] || './gem_rbs/gems'
-
-  library "pathname"
-  library "logger"
-  library "mutex_m"
-  library "date"
-  library 'monitor'
-  library 'singleton'
-  library 'tsort'
-
-  library 'activesupport'
-  library 'actionpack'
-  library 'activejob'
-  library 'activemodel'
-  library 'actionview'
-  library 'activerecord'
-  library 'railties'
+  repo_path ENV['RBS_REPO_DIR'] if ENV['RBS_REPO_DIR']
 end

data/bin/setup

@@ -4,6 +4,6 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-bin/gem_rbs
+bundle exec rbs collection install --frozen
 
 # Do any other automated setup that you need to do here

data/lib/rbs_rails/active_record.rb

@@ -32,10 +32,16 @@ module RbsRails
 
           #{columns}
           #{associations}
+          #{generated_association_methods}
+          #{has_secure_password}
+          #{delegated_type_instance}
+          #{delegated_type_scope(singleton: true)}
           #{enum_instance_methods}
           #{enum_scope_methods(singleton: true)}
           #{scopes(singleton: true)}
 
+          #{generated_relation_methods_decl}
+
           #{relation_decl}
 
           #{collection_proxy_decl}
@@ -46,25 +52,37 @@ module RbsRails
 
       private def pk_type
         pk = klass.primary_key
+        return 'top' unless pk
+
         col = klass.columns.find {|col| col.name == pk }
         sql_type_to_class(col.type)
       end
 
+      private def generated_relation_methods_decl
+        <<~RBS
+          module GeneratedRelationMethods
+            #{enum_scope_methods(singleton: false)}
+            #{scopes(singleton: false)}
+            #{delegated_type_scope(singleton: false)}
+          end
+        RBS
+      end
+
       private def relation_decl
         <<~RBS
-          class #{relation_class_name} < ActiveRecord::Relation
+          class #{relation_class_name} < ::ActiveRecord::Relation
+            include GeneratedRelationMethods
             include _ActiveRecord_Relation[#{klass_name}, #{pk_type}]
             include Enumerable[#{klass_name}]
-
-          #{enum_scope_methods(singleton: false)}
-          #{scopes(singleton: false)}
           end
         RBS
       end
 
       private def collection_proxy_decl
         <<~RBS
-          class ActiveRecord_Associations_CollectionProxy < ActiveRecord::Associations::CollectionProxy
+          class ActiveRecord_Associations_CollectionProxy < ::ActiveRecord::Associations::CollectionProxy
+            include GeneratedRelationMethods
+            include _ActiveRecord_Relation[#{klass_name}, #{pk_type}]
           end
         RBS
       end
@@ -81,7 +99,7 @@ module RbsRails
             superclass_name = Util.module_name(superclass)
             @dependencies << superclass_name
 
-            "class #{mod_name} < #{superclass_name}"
+            "class #{mod_name} < ::#{superclass_name}"
           when Module
             "module #{mod_name}"
           else
@@ -104,9 +122,13 @@ module RbsRails
 
       private def has_many
         klass.reflect_on_all_associations(:has_many).map do |a|
+          @dependencies << a.klass.name
+
           singular_name = a.name.to_s.singularize
           type = Util.module_name(a.klass)
           collection_type = "#{type}::ActiveRecord_Associations_CollectionProxy"
+          @dependencies << collection_type
+
           <<~RUBY.chomp
             def #{a.name}: () -> #{collection_type}
             def #{a.name}=: (#{collection_type} | Array[#{type}]) -> (#{collection_type} | Array[#{type}])
@@ -118,10 +140,12 @@ module RbsRails
 
       private def has_one
         klass.reflect_on_all_associations(:has_one).map do |a|
+          @dependencies << a.klass.name unless a.polymorphic?
+
           type = a.polymorphic? ? 'untyped' : Util.module_name(a.klass)
           type_optional = optional(type)
           <<~RUBY.chomp
-            def #{a.name}: () -> #{type}
+            def #{a.name}: () -> #{type_optional}
             def #{a.name}=: (#{type_optional}) -> #{type_optional}
             def build_#{a.name}: (untyped) -> #{type}
             def create_#{a.name}: (untyped) -> #{type}
@@ -133,25 +157,166 @@ module RbsRails
 
       private def belongs_to
         klass.reflect_on_all_associations(:belongs_to).map do |a|
+          @dependencies << a.klass.name unless a.polymorphic?
+
           type = a.polymorphic? ? 'untyped' : Util.module_name(a.klass)
           type_optional = optional(type)
-          <<~RUBY.chomp
-            def #{a.name}: () -> #{type}
-            def #{a.name}=: (#{type_optional}) -> #{type_optional}
-            def build_#{a.name}: (untyped) -> #{type}
-            def create_#{a.name}: (untyped) -> #{type}
-            def create_#{a.name}!: (untyped) -> #{type}
-            def reload_#{a.name}: () -> #{type_optional}
-          RUBY
+          # @type var methods: Array[String]
+          methods = []
+          methods << "def #{a.name}: () -> #{type}"
+          methods << "def #{a.name}=: (#{type_optional}) -> #{type_optional}"
+          methods << "def reload_#{a.name}: () -> #{type_optional}"
+          if !a.polymorphic?
+            methods << "def build_#{a.name}: (untyped) -> #{type}"
+            methods << "def create_#{a.name}: (untyped) -> #{type}"
+            methods << "def create_#{a.name}!: (untyped) -> #{type}"
+          end
+          methods.join("\n")
         end.join("\n")
       end
 
+      private def generated_association_methods
+        # @type var sigs: Array[String]
+        sigs = []
+
+        # Needs to require "active_storage/engine"
+        if klass.respond_to?(:attachment_reflections)
+          sigs << "module GeneratedAssociationMethods"
+          sigs << klass.attachment_reflections.map do |name, reflection|
+            case reflection.macro
+            when :has_one_attached
+              <<~EOS
+                def #{name}: () -> ActiveStorage::Attached::One
+                def #{name}=: (ActionDispatch::Http::UploadedFile) -> ActionDispatch::Http::UploadedFile
+                            | (Rack::Test::UploadedFile) -> Rack::Test::UploadedFile
+                            | (ActiveStorage::Blob) -> ActiveStorage::Blob
+                            | (String) -> String
+                            | ({ io: IO, filename: String, content_type: String? }) -> { io: IO, filename: String, content_type: String? }
+                            | (nil) -> nil
+              EOS
+            when :has_many_attached
+              <<~EOS
+                def #{name}: () -> ActiveStorage::Attached::Many
+                def #{name}=: (untyped) -> untyped
+              EOS
+            else
+              raise
+            end
+          end.join("\n")
+          sigs << "end"
+          sigs << "include GeneratedAssociationMethods"
+        end
+
+        sigs.join("\n")
+      end
+
+      private def delegated_type_scope(singleton:)
+        definitions = delegated_type_definitions
+        return "" unless definitions
+        definitions.map do |definition|
+          definition[:types].map do |type|
+            scope_name = type.tableize.gsub("/", "_")
+            "def #{singleton ? 'self.' : ''}#{scope_name}: () -> #{relation_class_name}"
+          end
+        end.flatten.join("\n")
+      end
+
+      private def delegated_type_instance
+        definitions = delegated_type_definitions
+        return "" unless definitions
+        # @type var methods: Array[String]
+        methods = []
+        definitions.each do |definition|
+          methods << "def #{definition[:role]}_class: () -> Class"
+          methods << "def #{definition[:role]}_name: () -> String"
+          methods << definition[:types].map do |type|
+            scope_name = type.tableize.gsub("/", "_")
+            singular = scope_name.singularize
+            <<~RUBY.chomp
+              def #{singular}?: () -> bool
+              def #{singular}: () -> #{type.classify}?
+              def #{singular}_id: () -> Integer?
+            RUBY
+          end.join("\n")
+        end
+        methods.join("\n")
+      end
+
+      private def delegated_type_definitions
+        ast = parse_model_file
+        return unless ast
+
+        traverse(ast).map do |node|
+          # @type block: { role: Symbol, types: Array[String] }?
+          next unless node.type == :send
+          next unless node.children[0].nil?
+          next unless node.children[1] == :delegated_type
+
+          role_node = node.children[2]
+          next unless role_node
+          next unless role_node.type == :sym
+          # @type var role: Symbol
+          role = role_node.children[0]
+
+          args_node = node.children[3]
+          next unless args_node
+          next unless args_node.type == :hash
+
+          types = traverse(args_node).map do |n|
+            # @type block: Array[String]?
+            next unless n.type == :pair
+            key_node = n.children[0]
+            next unless key_node
+            next unless key_node.type == :sym
+            next unless key_node.children[0] == :types
+
+            types_node = n.children[1]
+            next unless types_node
+            next unless types_node.type == :array
+            code = types_node.loc.expression.source
+            eval(code)
+          end.compact.flatten
+
+          { role: role, types: types }
+        end.compact
+      end
+
+      private def has_secure_password
+        ast = parse_model_file
+        return unless ast
+
+        traverse(ast).map do |node|
+          # @type block: String?
+          next unless node.type == :send
+          next unless node.children[0].nil?
+          next unless node.children[1] == :has_secure_password
+
+          attribute_node = node.children[2]
+          attribute = if attribute_node && attribute_node.type == :sym
+                        attribute_node.children[0]
+                      else
+                        :password
+                      end
+
+          <<~EOS
+            module ActiveModel_SecurePassword_InstanceMethodsOnActivation_#{attribute}
+              attr_reader #{attribute}: String?
+              def #{attribute}=: (String) -> String
+              def #{attribute}_confirmation=: (String) -> String
+              def authenticate_#{attribute}: (String) -> (#{klass_name} | false)
+              #{attribute == :password ? "alias authenticate authenticate_password" : ""}
+            end
+            include ActiveModel_SecurePassword_InstanceMethodsOnActivation_#{attribute}
+          EOS
+        end.compact.join("\n")
+      end
+
       private def enum_instance_methods
         # @type var methods: Array[String]
         methods = []
         enum_definitions.each do |hash|
           hash.each do |name, values|
-            next if name == :_prefix || name == :_suffix
+            next if name == :_prefix || name == :_suffix || name == :_default
 
             values.each do |label, value|
               value_method_name = enum_method_name(hash, name, label)
@@ -169,7 +334,7 @@ module RbsRails
         methods = []
         enum_definitions.each do |hash|
           hash.each do |name, values|
-            next if name == :_prefix || name == :_suffix
+            next if name == :_prefix || name == :_suffix || name == :_default
 
             values.each do |label, value|
               value_method_name = enum_method_name(hash, name, label)
@@ -230,7 +395,9 @@ module RbsRails
         ast = parse_model_file
         return '' unless ast
 
-        traverse(ast).map do |node|
+        prefix = singleton ? 'self.' : ''
+
+        sigs = traverse(ast).map do |node|
           # @type block: nil | String
           next unless node.type == :send
           next unless node.children[0].nil?
@@ -246,8 +413,16 @@ module RbsRails
           next unless body_node.type == :block
 
           args = args_to_type(body_node.children[1])
-          "def #{singleton ? 'self.' : ''}#{name}: #{args} -> #{relation_class_name}"
-        end.compact.join("\n")
+          "def #{prefix}#{name}: #{args} -> #{relation_class_name}"
+        end.compact
+
+        if klass.respond_to?(:attachment_reflections)
+          klass.attachment_reflections.each do |name, _reflection|
+            sigs << "def #{prefix}with_attached_#{name}: () -> #{relation_class_name}"
+          end
+        end
+
+        sigs.join("\n")
       end
 
       private def args_to_type(args_node)
@@ -258,17 +433,17 @@ module RbsRails
         args_node.children.each do |node|
           case node.type
           when :arg
-            res << "untyped #{node.children[0]}"
+            res << "untyped `#{node.children[0]}`"
           when :optarg
-            res << "?untyped #{node.children[0]}"
+            res << "?untyped `#{node.children[0]}`"
           when :kwarg
             res << "#{node.children[0]}: untyped"
           when :kwoptarg
             res << "?#{node.children[0]}: untyped"
           when :restarg
-            res << "*untyped #{node.children[0]}"
+            res << "*untyped `#{node.children[0]}`"
           when :kwrestarg
-            res << "**untyped #{node.children[0]}"
+            res << "**untyped `#{node.children[0]}`"
           when :blockarg
             block = " { (*untyped) -> untyped }"
           else
@@ -292,7 +467,7 @@ module RbsRails
       end
 
       private def traverse(node, &block)
-        return to_enum(__method__, node) unless block_given?
+        return to_enum(__method__ || raise, node) unless block_given?
 
         # @type var block: ^(Parser::AST::Node) -> untyped
         block.call node
@@ -306,7 +481,8 @@ module RbsRails
       end
 
       private def columns
-        klass.columns.map do |col|
+        mod_sig = +"module GeneratedAttributeMethods\n"
+        mod_sig << klass.columns.map do |col|
           class_name = if enum_definitions.any? { |hash| hash.key?(col.name) || hash.key?(col.name.to_sym) }
                          'String'
                        else
@@ -315,7 +491,9 @@ module RbsRails
           class_name_opt = optional(class_name)
           column_type = col.null ? class_name_opt : class_name
           sig = <<~EOS
-            attr_accessor #{col.name} (): #{column_type}
+            def #{col.name}: () -> #{column_type}
+            def #{col.name}=: (#{column_type}) -> #{column_type}
+            def #{col.name}?: () -> bool
             def #{col.name}_changed?: () -> bool
             def #{col.name}_change: () -> [#{class_name_opt}, #{class_name_opt}]
             def #{col.name}_will_change!: () -> void
@@ -332,9 +510,12 @@ module RbsRails
             def restore_#{col.name}!: () -> void
             def clear_#{col.name}_change: () -> void
           EOS
-          sig << "attr_accessor #{col.name}? (): #{class_name}\n" if col.type == :boolean
+          sig << "\n"
           sig
         end.join("\n")
+        mod_sig << "\nend\n"
+        mod_sig << "include GeneratedAttributeMethods"
+        mod_sig
       end
 
       private def optional(class_name)

data/lib/rbs_rails/dependency_builder.rb

@@ -1,14 +1,14 @@
 module RbsRails
   class DependencyBuilder
-    attr_reader :deps
+    attr_reader :deps, :done
 
     def initialize
       @deps = []
+      @done = Set.new(['ActiveRecord::Base', 'ActiveRecord', 'Object'])
     end
 
     def build
       dep_rbs = +""
-      done = Set.new(['ActiveRecord::Base', 'ActiveRecord', 'Object'])
       deps.uniq!
       while dep = deps.shift
         next unless done.add?(dep)

data/lib/rbs_rails/rake_task.rb

@@ -44,6 +44,7 @@ module RbsRails
 
           sig = RbsRails::ActiveRecord.class_to_rbs(klass, dependencies: dep_builder.deps)
           path.write sig
+          dep_builder.done << klass.name
         end
 
         if dep_rbs = dep_builder.build

data/lib/rbs_rails/version.rb

@@ -2,5 +2,5 @@ module RbsRails
   # Because of copy_signatures is defined by lib/rbs_rails.rb
   # @dynamic self.copy_signatures
 
-  VERSION = "0.8.2"
+  VERSION = "0.10.1"
 end

data/rbs_collection.lock.yaml

@@ -0,0 +1,144 @@
+---
+sources:
+- name: ruby/gem_rbs_collection
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  revision: main
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: set
+  version: '0'
+  source:
+    type: stdlib
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: optparse
+  version: '0'
+  source:
+    type: stdlib
+- name: rubygems
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: actionpack
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6320a194c85afbf4ff332c3eb75fcae2a6518c92
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: actionview
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6320a194c85afbf4ff332c3eb75fcae2a6518c92
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activejob
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6320a194c85afbf4ff332c3eb75fcae2a6518c92
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activemodel
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6320a194c85afbf4ff332c3eb75fcae2a6518c92
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activerecord
+  version: '6.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6320a194c85afbf4ff332c3eb75fcae2a6518c92
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activestorage
+  version: '6.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6320a194c85afbf4ff332c3eb75fcae2a6518c92
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activesupport
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6320a194c85afbf4ff332c3eb75fcae2a6518c92
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6320a194c85afbf4ff332c3eb75fcae2a6518c92
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rack
+  version: 2.2.2
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6320a194c85afbf4ff332c3eb75fcae2a6518c92
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: railties
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 6320a194c85afbf4ff332c3eb75fcae2a6518c92
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rbs
+  version: 2.2.2
+  source:
+    type: rubygems
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: tempfile
+  version: '0'
+  source:
+    type: stdlib
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: time
+  version: '0'
+  source:
+    type: stdlib

data/rbs_collection.yaml

@@ -0,0 +1,36 @@
+# Download sources
+sources:
+  - name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Ignores - Gemfile.lock contains them but their RBSs are unnecessary
+  - name: steep
+    ignore: true
+  - name: nokogiri
+    ignore: true
+  - name: ast
+    ignore: true
+  - name: rainbow
+    ignore: true
+  - name: listen
+    ignore: true
+
+  # ignore RBS Rails itself
+  - name: rbs_rails
+    ignore: true
+
+  # They'are necessary to load RBS gem.
+  # See https://github.com/ruby/rbs/pull/921
+  - name: logger
+  - name: set
+  - name: pathname
+  - name: json
+  - name: optparse
+  - name: rubygems
+  - name: tsort

data/sig/rbs_rails/active_record.rbs

@@ -5,6 +5,7 @@ end
 
 class RbsRails::ActiveRecord::Generator
   @parse_model_file: nil | Parser::AST::Node
+  @dependencies: Array[String]
 
   def initialize: (singleton(ActiveRecord::Base) klass, dependencies: Array[String]) -> untyped
 
@@ -14,6 +15,8 @@ class RbsRails::ActiveRecord::Generator
 
   def pk_type: () -> String
 
+  def generated_relation_methods_decl: () -> String
+
   def relation_decl: () -> String
 
   def collection_proxy_decl: () -> String
@@ -30,6 +33,16 @@ class RbsRails::ActiveRecord::Generator
 
   def belongs_to: () -> String
 
+  def generated_association_methods: () -> String
+
+  def delegated_type_scope: (singleton: bool) -> String
+
+  def delegated_type_instance: () -> String
+
+  def delegated_type_definitions: () -> Array[{ role: Symbol, types: Array[String] }]?
+
+  def has_secure_password: () -> String?
+
   def enum_instance_methods: () -> String
 
   def enum_scope_methods: (singleton: untyped `singleton`) -> String

data/sig/rbs_rails/dependency_builder.rbs

@@ -1,6 +1,7 @@
 module RbsRails
   class DependencyBuilder
     attr_reader deps: Array[String]
+    attr_reader done: Set[String]
 
     def initialize: () -> void
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs_rails
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.10.1
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-20 00:00:00.000000000 Z
+date: 2022-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -50,6 +50,7 @@ files:
 - ".gitignore"
 - ".gitmodules"
 - CHANGELOG.md
+- DESIGN.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -58,9 +59,7 @@ files:
 - Steepfile
 - bin/add-type-params.rb
 - bin/console
-- bin/gem_rbs
 - bin/postprocess.rb
-- bin/rbs
 - bin/rbs-prototype-rb.rb
 - bin/setup
 - bin/to-ascii.rb
@@ -71,6 +70,8 @@ files:
 - lib/rbs_rails/rake_task.rb
 - lib/rbs_rails/util.rb
 - lib/rbs_rails/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
 - rbs_rails.gemspec
 - sig/activerecord.rbs
 - sig/fileutils.rbs
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: A RBS files generator for Rails application

data/bin/gem_rbs

@@ -1,94 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'net/http'
-require 'json'
-require 'securerandom'
-require 'pathname'
-
-TOKEN = ENV.fetch('GITHUB_TOKEN')
-VERSION = "6.0.3.2"
-
-def req(query)
-  http = Net::HTTP.new("api.github.com", 443)
-  http.use_ssl = true
-  header = {
-    "Authorization" => "Bearer #{TOKEN}",
-    'Content-Type' => 'application/json',
-    'User-Agent' => 'gem_rbs client',
-  }
-  resp = http.request_post('/graphql', JSON.generate(query), header)
-  JSON.parse(resp.body, symbolize_names: true).tap do |content|
-    raise content[:errors].inspect if content[:errors]
-  end
-end
-
-class QueryBuilder
-  attr_reader :variables
-
-  def initialize
-    @queries = []
-    @variables = {}
-  end
-
-  def add(query, variables)
-    query = query.dup
-    variables = variables.transform_keys do |key|
-      next key unless @variables.key?(key)
-
-      new_key = key + '_' + SecureRandom.hex(8)
-      query.gsub!(key, new_key)
-      new_key
-    end
-
-    @queries << query
-    @variables.merge!(variables)
-  end
-
-  def query
-    # TODO: Allow non-String type for variables
-    "query(#{variables.keys.map { |v| "$#{v}: String!" }.join(',')}) { #{@queries.join("\n")} }"
-  end
-end
-
-gems = %w[activesupport actionpack activejob activemodel actionview activerecord railties]
-
-builder = QueryBuilder.new
-gems.each do |gem|
-  path = "main:gems/#{gem}/#{VERSION}"
-  builder.add(<<~GRAPHQL, { 'path' => path })
-    #{gem}:repository(owner: "ruby", name: "gem_rbs_collection") {
-      object(expression: $path) {
-        ... on Tree {
-          entries {
-            name
-            object {
-              ... on Blob {
-                isTruncated
-                text
-              }
-            }
-          }
-        }
-      }
-    }
-  GRAPHQL
-end
-
-resp = req(query: builder.query, variables: builder.variables)
-
-resp[:data].each do |gem_name, gem_value|
-  gem_value.dig(:object, :entries).each do |entry|
-    fname = entry[:name]
-    if fname.end_with?('.rbs')
-      content =
-        if entry.dig(:object, :isTruncated)
-          `curl -H 'Accept: application/vnd.github.v3.raw' -H Authorization: token #{TOKEN} https://api.github.com/repos/ruby/gem_rbs_collection/contents/gems/#{gem_name}/#{VERSION}/#{fname}`
-        else
-          entry.dig(:object, :text)
-        end
-      dir = Pathname("gem_rbs/gems/#{gem_name}/#{VERSION}")
-      dir.mkpath
-      dir.join(fname).write(content)
-    end
-  end
-end

data/bin/rbs

@@ -1,30 +0,0 @@
-#!ruby
-
-require 'pathname'
-root = Pathname(__dir__) / '../'
-
-def v(require)
-  if v = ENV['RAILS_VERSION']
-    "#{require}:#{v}"
-  else
-    require
-  end
-end
-
-def repo
-  ENV['RBS_REPO_DIR'] || Pathname(__dir__).join('../gem_rbs/gems').to_s
-end
-
-exec(
-  'rbs',
-  # Require stdlibs
-  '-rlogger', '-rpathname', '-rmutex_m', '-rdate', '-rmonitor', '-rsingleton', '-rtsort',
-  "--repo=#{repo}",
-  # Require Rails libraries
-  v('-ractivesupport'), v('-ractionpack'), v('-ractivejob'), v('-ractivemodel'), v('-ractionview'), v('-ractiverecord'), v('-rrailties'),
-  # Load signatures that are bundled in rbs_rails
-  '-I' + root.join('sig').to_s, '-I' + root.join('assets/sig').to_s,
-  # Expand arguments
-  *ARGV,
-)
-