rbs_rails 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a95c070dd8a694d1226c7985be11458ebea02c89fda95c6bc0842c84fd44b69a
-  data.tar.gz: 6e29540a2c6e0cb76b01ca08aa6081e4144260380900ecb632113eab04326ed6
+  metadata.gz: 820a0b86c257e12194d883e6f5edda1793b54cb789c2b57da2e496e16041c803
+  data.tar.gz: 173abfdce9274fc34671198b7640f5e84a92c8b0bb1a7ede8224cd2fb851137d
 SHA512:
-  metadata.gz: b5ef79213cc6cbdb1e4d20ea901ccd65071c6c2fea5c9dc28cc80cb75739e712534ad2d7b19fa9c4174d7fee5da50e787d7ccb742933e51e7f337b4fc285838c
-  data.tar.gz: ed7492f9b9b61fca7bc4d0ee52ebf9646d3127cf82c73d6b64d136d6c2cf248be86fa49a4324769bbde6d2304c5325be1e7cd6e7b6753e55d612f21627133f07
+  metadata.gz: 500bb14e66e9d6188d931e8a655b8af42b17caf13fa9487e8ad22318a54f34b5e05c412e65c2e68258d13165cb5760d09dc00d52d05b7cb9c9696e97dbbcc8bb
+  data.tar.gz: 86e1ec208cba577ce7ed5ac4a6b7bcd5ada10fe7d3ca0fd4ba5e014a68144bbe3182fcbd04145e9b9472be24a627eb0d5c3a2b7424661caae25d43507390d15a

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "gem_rbs"]
+	path = gem_rbs
+	url = https://github.com/ruby/gem_rbs.git

data/README.md

@@ -83,13 +83,25 @@ target :app do
 
   check 'app'
 
+  repo_path "path/to/rbs_repo"
+
   library 'pathname'
   library 'logger'
   library 'mutex_m'
   library 'date'
+
+  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
+
 ## Development
 
 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,7 +9,8 @@ task :steep do
 end
 
 task :rbs_validate do
-  sh 'bin/rbs validate --silent'
+  rbs = Pathname(__dir__).join('bin/rbs').to_s
+  sh "ruby #{rbs} validate --silent"
 end
 
 Rake::TestTask.new do |test|

data/Steepfile

@@ -3,10 +3,18 @@ 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 "strong_json"           # Gems
+
+  library 'activesupport'
+  library 'actionpack'
+  library 'activejob'
+  library 'activemodel'
+  library 'actionview'
+  library 'activerecord'
+  library 'railties'
 end

data/bin/add-type-params.rb

@@ -4,7 +4,7 @@ require 'bundler/inline'
 
 gemfile do
   source 'https://rubygems.org'
-  gem 'rbs', '>= 0.17'
+  gem 'rbs', '>= 0.19'
 end
 
 require 'rbs'

data/bin/postprocess.rb

@@ -6,7 +6,7 @@ require 'bundler/inline'
 
 gemfile do
   source 'https://rubygems.org'
-  gem 'rbs', '>= 0.17'
+  gem 'rbs', '>= 0.19.0'
 end
 
 require 'rbs'

data/bin/rbs

@@ -1,3 +1,30 @@
-#!/bin/bash
+#!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',
+  "--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,
+)
 
-rbs -rlogger -rpathname -rmutex_m -rdate -Isig -Iassets/sig $@

data/bin/rbs-prototype-rb.rb

@@ -17,7 +17,7 @@ using Module.new {
       end
     end
 
-    def process_class_methods(node, decls:, comments:, singleton:)
+    def process_class_methods(node, decls:, comments:, context:)
       return false unless node.type == :ITER
 
       fcall = node.children[0]
@@ -37,13 +37,13 @@ using Module.new {
       decls.push mod
 
       each_node [node.children[1]] do |child|
-        process child, decls: mod.members, comments: comments, singleton: false
+        process child, decls: mod.members, comments: comments, context: RBS::Prototype::RB::Context.initial
       end
 
       true
     end
 
-    def process_struct_new(node, decls:, comments:, singleton:)
+    def process_struct_new(node, decls:, comments:, context:)
       return unless node.type == :CDECL
 
       name, *_, rhs = node.children
@@ -78,13 +78,62 @@ using Module.new {
 
       if body
         each_node [body] do |child|
-          process child, decls: kls.members, comments: comments, singleton: false
+          process child, decls: kls.members, comments: comments, context: RBS::Prototype::RB::Context.initial
         end
       end
 
       true
     end
 
+    def process_attr_internal(node, decls:, comments:, context:)
+      case node.type
+      when :FCALL, :VCALL
+        args = node.children[1]&.children || []
+
+        case node.children[0]
+        when :attr_internal_reader
+          args.each do |arg|
+            if arg && (name = literal_to_symbol(arg))
+              decls << RBS::AST::Members::AttrReader.new(
+                name: name,
+                ivar_name: :"@_#{name}",
+                type: RBS::Types::Bases::Any.new(location: nil),
+                location: nil,
+                comment: comments[node.first_lineno - 1],
+                annotations: []
+              )
+            end
+          end
+        when :attr_internal_writer
+          args.each do |arg|
+            if arg && (name = literal_to_symbol(arg))
+              decls << RBS::AST::Members::AttrWriter.new(
+                name: name,
+                ivar_name: :"@_#{name}",
+                type: RBS::Types::Bases::Any.new(location: nil),
+                location: nil,
+                comment: comments[node.first_lineno - 1],
+                annotations: []
+              )
+            end
+          end
+        when :attr_internal_accessor, :attr_internal
+          args.each do |arg|
+            if arg && (name = literal_to_symbol(arg))
+              decls << RBS::AST::Members::AttrAccessor.new(
+                name: name,
+                ivar_name: :"@_#{name}",
+                type: RBS::Types::Bases::Any.new(location: nil),
+                location: nil,
+                comment: comments[node.first_lineno - 1],
+                annotations: []
+              )
+            end
+          end
+        end
+      end
+    end
+
     def class_new_method_to_type(node)
       case node.type
       when :CALL
@@ -129,7 +178,7 @@ using Module.new {
 
 module PrototypeExt
   def process(...)
-    process_class_methods(...) || process_struct_new(...) || super
+    process_class_methods(...) || process_struct_new(...) || process_attr_internal(...) || super
   end
 
   def literal_to_type(node)

data/lib/rbs_rails/active_record.rb

@@ -154,6 +154,7 @@ module RbsRails
         return [] unless ast
 
         traverse(ast).map do |node|
+          # @type block: nil | Hash[untyped, untyped]
           next unless node.type == :send
           next unless node.children[0].nil?
           next unless node.children[1] == :enum
@@ -192,6 +193,7 @@ module RbsRails
         return '' unless ast
 
         traverse(ast).map do |node|
+          # @type block: nil | String
           next unless node.type == :send
           next unless node.children[0].nil?
           next unless node.children[1] == :scope

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.4.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs_rails
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-21 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -46,39 +46,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitmodules"
 - ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - Steepfile
-- assets/sig/action_controller.rbs
 - assets/sig/action_mailer.rbs
-- assets/sig/active_record.rbs
 - assets/sig/builtin.rbs
 - assets/sig/capybara.rbs
 - assets/sig/concurrent.rbs
 - assets/sig/erb.rbs
 - assets/sig/erubi.rbs
-- assets/sig/generated/actionpack.rbs
-- assets/sig/generated/actionview.rbs
-- assets/sig/generated/activejob.rbs
-- assets/sig/generated/activemodel.rbs
-- assets/sig/generated/activerecord-meta-programming.rbs
-- assets/sig/generated/activerecord.rbs
-- assets/sig/generated/activesupport.rbs
-- assets/sig/generated/railties.rbs
 - assets/sig/i18n.rbs
 - assets/sig/libxml.rbs
 - assets/sig/minitest.rbs
 - assets/sig/nokogiri.rbs
-- assets/sig/patches/README.md
-- assets/sig/patches/for_actionpack.rbs
-- assets/sig/patches/for_actionview.rbs
-- assets/sig/patches/for_activemodel.rbs
-- assets/sig/patches/for_activerecord.rbs
-- assets/sig/patches/for_activesupport.rbs
-- assets/sig/patches/for_railties.rbs
 - assets/sig/pg.rbs
 - assets/sig/que.rbs
 - assets/sig/queue_classic.rbs
@@ -95,7 +79,6 @@ files:
 - assets/sig/tzinfo.rbs
 - bin/add-type-params.rb
 - bin/console
-- bin/generate_rbs_from_rails_source_code.rb
 - bin/postprocess.rb
 - bin/rbs
 - bin/rbs-prototype-rb.rb
@@ -133,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
+rubygems_version: 3.2.1
 signing_key:
 specification_version: 4
 summary: A RBS files generator for Rails application

data/assets/sig/action_controller.rbs

@@ -1,49 +0,0 @@
-interface _ActionController_API_and_Base
-  def request: () -> untyped
-  def params: () -> untyped
-  def session: () -> untyped
-  def cookies: () -> untyped
-  def flash: () -> untyped
-  def render: (*untyped) -> void
-  def redirect_to: (*untyped) -> void
-end
-
-interface _ActionController_API_and_Base_singletion
-  # hooks
-  def before_action: (*untyped) -> void
-  def around_action: (*untyped) -> void
-  def after_action: (*untyped) -> void
-  def skip_before_action: (*untyped) -> void
-  def skip_around_action: (*untyped) -> void
-  def skip_after_action: (*untyped) -> void
-  def prepend_before_action: (*untyped) -> void
-  def prepend_around_action: (*untyped) -> void
-  def prepend_after_action: (*untyped) -> void
-  def append_before_action: (*untyped) -> void
-  def append_around_action: (*untyped) -> void
-  def append_after_action: (*untyped) -> void
-
-  def rescue_from: (*Class, ?with: Symbol | Proc) { (Exception) -> void } -> void
-end
-
-module AbstractController
-  class Base
-  end
-end
-
-module ActionController
-  class Metal < ::AbstractController::Base
-  end
-
-  class Base < Metal
-    include _ActionController_API_and_Base
-    extend _ActionController_API_and_Base_singletion
-    extend ::ActionView::Layouts::ClassMethods
-  end
-
-  class API < Metal
-    include _ActionController_API_and_Base
-    extend _ActionController_API_and_Base_singletion
-  end
-end
-

data/assets/sig/active_record.rbs

@@ -1,137 +0,0 @@
-module ActiveRecord
-end
-
-class ActiveRecord::Base
-  def self.abstract_class=: (bool) -> void
-  def self.scope: (Symbol, ^(*untyped) -> untyped ) -> void
-                | (Symbol) { (*untyped) -> untyped } -> void
-  def self.belongs_to: (Symbol, ?untyped, **untyped) -> void
-  def self.has_many: (Symbol, ?untyped, **untyped) -> void
-  def self.has_one: (Symbol, ?untyped, **untyped) -> void
-  def self.transaction: [T] () { () -> T } -> T
-  def self.create!: (**untyped) -> instance
-  def self.validate: (*untyped) -> void
-  def self.validates: (*untyped) -> void
-  def self.enum: (Hash[Symbol, untyped]) -> void
-
-  # callbacks
-  def self.after_commit: (*untyped) -> void
-  def self.after_create: (*untyped) -> void
-  def self.after_destroy: (*untyped) -> void
-  def self.after_rollback: (*untyped) -> void
-  def self.after_save: (*untyped) -> void
-  def self.after_update: (*untyped) -> void
-  def self.after_validation: (*untyped) -> void
-  def self.around_create: (*untyped) -> void
-  def self.around_destroy: (*untyped) -> void
-  def self.around_save: (*untyped) -> void
-  def self.around_update: (*untyped) -> void
-  def self.before_create: (*untyped) -> void
-  def self.before_destroy: (*untyped) -> void
-  def self.before_save: (*untyped) -> void
-  def self.before_update: (*untyped) -> void
-  def self.before_validation: (*untyped) -> void
-
-  def self.columns: () -> Array[untyped]
-  def self.reflect_on_all_associations: (?Symbol) -> Array[untyped]
-
-  def will_save_change_to_attribute?: (String | Symbol attr_name, ?from: untyped, ?to: untyped) -> bool
-
-  def save!: (?validate: bool, ?touch: bool) -> self
-  def save: () -> bool
-  def update!: (*untyped) -> self
-  def update: (*untyped) -> bool
-  def destroy!: () -> self
-  def destroy: () -> bool
-  def valid?: () -> bool
-  def invalid?: () -> bool
-  def errors: () -> untyped
-  def []: (Symbol) -> untyped
-  def []=: (Symbol, untyped) -> untyped
-end
-
-class ActiveRecord::Relation
-end
-
-class ActiveRecord::Associations::CollectionProxy
-end
-
-interface _ActiveRecord_Relation[Model]
-  def all: () -> self
-  def ids: () -> Array[Integer]
-  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: (Integer id) -> Model
-  def first: () -> Model
-           | (Integer count) -> Array[Model]
-  def last: () -> Model
-           | (Integer count) -> Array[Model]
-  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
-end
-
-interface _ActiveRecord_Relation_ClassMethods[Model, Relation]
-  def all: () -> Relation
-  def ids: () -> Array[Integer]
-  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: (Integer id) -> Model
-  def first: () -> Model
-           | (Integer count) -> Array[Model]
-  def last: () -> Model
-           | (Integer count) -> Array[Model]
-  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
-end