rbs_rails 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4daa0714f5e127bc21e33e9737983999459a2dbb690202c6dc86408a68ef82b0
-  data.tar.gz: 54f9a8c04ca0f22c1a391a4d5a47c0294c54f50741843226655ae9e8175b0a51
+  metadata.gz: 16dd1379f4621410d78e352c8fdc8750d3fb469d8c395aee77de85d2f8570279
+  data.tar.gz: e50b75cc1e64a8630c1508805d146d2cf5edad065cdcab502f910fcb84bc51ef
 SHA512:
-  metadata.gz: f85bdbf2f59f5accdd54a062f5d5412f432b9d91b62b6f4ced371fbcc0d565ad661a1015d9193e4ee9add64ef69cf7243dd5603dc22b05182b59f3a122ecad2e
-  data.tar.gz: f75cc735df8961b0714af8bf4f38771f01542ed4162e69fb8adc677dcbfec0885fe15296bc84006b955d9370004dfcd6070fbd761c0b220f02d16f062fadcbba
+  metadata.gz: 12136882eeebf0e2219af85c6393f6b8a74c4bc6f268b57d5b9c931a99fa42ee81ed9deb9885d4209f28dbf43d9d57563641379031c199397cf520a7dc417f10
+  data.tar.gz: 40ffd8a1525501f736f759769a95183e3933da0c1063e5e939b6c4ccf23ae9d98731ef782c23f6c7eb6b7280b2c39f535379886edeb3abeb423810cf2ead58ac

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## 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

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

@@ -6,7 +6,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 gem "rake", "~> 13.0"
-gem 'rails', '< 6.1', '>= 6.0'
+gem 'rails', '< 7', '>= 6.0'
 gem 'rbs', '>= 2'
 gem 'steep'
 gem 'minitest'

data/Gemfile.lock

@@ -1,68 +1,72 @@
 PATH
   remote: .
   specs:
-    rbs_rails (0.10.0)
+    rbs_rails (0.10.1)
       parser
       rbs (>= 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.4.7)
-      actionpack (= 6.0.4.7)
+    actioncable (6.1.5)
+      actionpack (= 6.1.5)
+      activesupport (= 6.1.5)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.4.7)
-      actionpack (= 6.0.4.7)
-      activejob (= 6.0.4.7)
-      activerecord (= 6.0.4.7)
-      activestorage (= 6.0.4.7)
-      activesupport (= 6.0.4.7)
+    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.0.4.7)
-      actionpack (= 6.0.4.7)
-      actionview (= 6.0.4.7)
-      activejob (= 6.0.4.7)
+    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.0.4.7)
-      actionview (= 6.0.4.7)
-      activesupport (= 6.0.4.7)
-      rack (~> 2.0, >= 2.0.8)
+    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.0.4.7)
-      actionpack (= 6.0.4.7)
-      activerecord (= 6.0.4.7)
-      activestorage (= 6.0.4.7)
-      activesupport (= 6.0.4.7)
+    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.0.4.7)
-      activesupport (= 6.0.4.7)
+    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.0.4.7)
-      activesupport (= 6.0.4.7)
+    activejob (6.1.5)
+      activesupport (= 6.1.5)
       globalid (>= 0.3.6)
-    activemodel (6.0.4.7)
-      activesupport (= 6.0.4.7)
-    activerecord (6.0.4.7)
-      activemodel (= 6.0.4.7)
-      activesupport (= 6.0.4.7)
-    activestorage (6.0.4.7)
-      actionpack (= 6.0.4.7)
-      activejob (= 6.0.4.7)
-      activerecord (= 6.0.4.7)
-      marcel (~> 1.0.0)
-    activesupport (6.0.4.7)
+    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 (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
     builder (3.2.4)
     concurrent-ruby (1.1.9)
@@ -98,32 +102,32 @@ GEM
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.4.7)
-      actioncable (= 6.0.4.7)
-      actionmailbox (= 6.0.4.7)
-      actionmailer (= 6.0.4.7)
-      actionpack (= 6.0.4.7)
-      actiontext (= 6.0.4.7)
-      actionview (= 6.0.4.7)
-      activejob (= 6.0.4.7)
-      activemodel (= 6.0.4.7)
-      activerecord (= 6.0.4.7)
-      activestorage (= 6.0.4.7)
-      activesupport (= 6.0.4.7)
-      bundler (>= 1.3.0)
-      railties (= 6.0.4.7)
+    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.0.4.7)
-      actionpack (= 6.0.4.7)
-      activesupport (= 6.0.4.7)
+    railties (6.1.5)
+      actionpack (= 6.1.5)
+      activesupport (= 6.1.5)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      rake (>= 12.2)
+      thor (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.1)
@@ -149,9 +153,8 @@ GEM
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.2.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
@@ -164,11 +167,11 @@ PLATFORMS
 
 DEPENDENCIES
   minitest
-  rails (>= 6.0, < 6.1)
+  rails (>= 6.0, < 7)
   rake (~> 13.0)
   rbs (>= 2)
   rbs_rails!
   steep
 
 BUNDLED WITH
-   2.2.27
+   2.3.9

data/README.md

@@ -35,44 +35,30 @@ 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 'time'
-
-  library 'rack'
-
-  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_collection
+That's all! Now you can check your Rails app statically with `steep check` command.
 
 ## Development
 

data/lib/rbs_rails/active_record.rb

@@ -122,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}])
@@ -136,6 +140,8 @@ 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
@@ -151,6 +157,8 @@ 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)
           # @type var methods: Array[String]

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.10.0"
+  VERSION = "0.10.1"
 end

data/rbs_collection.lock.yaml

@@ -67,7 +67,7 @@ gems:
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: activerecord
-  version: '6.0'
+  version: '6.1'
   source:
     type: git
     name: ruby/gem_rbs_collection
@@ -75,7 +75,7 @@ gems:
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: activestorage
-  version: '6.0'
+  version: '6.1'
   source:
     type: git
     name: ruby/gem_rbs_collection

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
 

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.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-18 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