rbs_rails 0.4.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a95c070dd8a694d1226c7985be11458ebea02c89fda95c6bc0842c84fd44b69a
-  data.tar.gz: 6e29540a2c6e0cb76b01ca08aa6081e4144260380900ecb632113eab04326ed6
+  metadata.gz: 30c59f478f8fa0cd0c41751feb468a04208e057ff318edf80717b63d2f4664b8
+  data.tar.gz: f382afdc82aaa47b6fe14cba2cdcbb62f127dc04d95020b71ed1b6c1aa8dfd9d
 SHA512:
-  metadata.gz: b5ef79213cc6cbdb1e4d20ea901ccd65071c6c2fea5c9dc28cc80cb75739e712534ad2d7b19fa9c4174d7fee5da50e787d7ccb742933e51e7f337b4fc285838c
-  data.tar.gz: ed7492f9b9b61fca7bc4d0ee52ebf9646d3127cf82c73d6b64d136d6c2cf248be86fa49a4324769bbde6d2304c5325be1e7cd6e7b6753e55d612f21627133f07
+  metadata.gz: 54ca5ed84a59c4e67892f8c4e72cdc190420d457345523eb11b3dd4efe7dde5d8662afc7ace9dbee3be1aa5577b257b028ccdba20297b45332919999ac648914
+  data.tar.gz: 61ba620c335f27ddb58ce96d4bf3d03ea61071c528b587b7fa419d93c462ba6d96e6ad4e508243a1e6aff903966bfa49e18a02ecf9eb69f053c2cdd215da20a7

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6, 2.7, '3.0', head]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      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: bundle exec rake

data/.gitignore

@@ -7,4 +7,7 @@
 /spec/reports/
 /tmp/
 /Gemfile.lock
-/test/sig
+/test/app/sig/rbs_rails
+/test/app/sig/app
+/test/app/sig/path_helpers.rbs
+/gem_rbs

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change log
+
+## master (unreleased)
+
+## 0.8.1 (2021-01-09)
+
+* Skip generation RBS fro class that doesn't have table in DB. [#95](https://github.com/pocke/rbs_rails/pull/95)
+
+## 0.8.0 (2020-12-31)
+
+* **[BREAKING]** Move RBS files that are copied by `rbs_rails:copy_signature_files` task to [ruby/gem_rbs](https://github.com/ruby/gem_rbs) repository [#90](https://github.com/pocke/rbs_rails/pull/90)
+* Allow all kinds of argument for scope [#89](https://github.com/pocke/rbs_rails/pull/89)
+
+## 0.7.0 (2020-12-28)
+
+* **[BREAKING]** Re-structure signature directory. [#86](https://github.com/pocke/rbs_rails/pull/86)
+* Generate ActiveRecord models with namespaces and superclasses. [#87](https://github.com/pocke/rbs_rails/pull/87)

data/Gemfile

@@ -4,6 +4,6 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 12.0"
-gem 'rbs', '>= 0.14.0'
-gem 'steep', '>= 0.34.0'
+gem 'rbs', '1.0.0'
+gem 'steep', '>= 0.34.0', git: 'https://github.com/soutaro/steep.git'
 gem 'minitest'

data/README.md

@@ -7,7 +7,7 @@ RBS files generator for Ruby on Rails.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rbs_rails'
+gem 'rbs_rails', require: false
 ```
 
 And then execute:
@@ -20,56 +20,22 @@ Or install it yourself as:
 
 ## Usage
 
-### For Active Record models
-
-It has two tasks.
-
-* `copy_signature_files`: Copy type definition files for Rails from rbs_rails.
-* `generate_rbs_for_model`: Generate RBS files from model classes.
+Put the following code to `lib/tasks/rbs.rake`.
 
 ```ruby
-# Rakefile
-
-task copy_signature_files: :environment do
-  require 'rbs_rails'
-
-  to = Rails.root.join('sig/rbs_rails/')
-  to.mkpath unless to.exist?
-  RbsRails.copy_signatures(to: to)
-end
+require 'rbs_rails/rake_task'
 
-task generate_rbs_for_model: :environment do
-  require 'rbs_rails'
-
-  out_dir = Rails.root / 'sig'
-  out_dir.mkdir unless out_dir.exist?
+RbsRails::RakeTask.new
+```
 
-  Rails.application.eager_load!
+Then, the following three tasks are available.
 
-  ActiveRecord::Base.descendants.each do |klass|
-    next if klass.abstract_class?
+* `rbs_rails:generate_rbs_for_models`: Generate RBS files for Active Record models
+* `rbs_rails:generate_rbs_for_path_helpers`: Generate RBS files for path helpers
+* `rbs_rails:all`: Execute all tasks of RBS Rails
 
-    path = out_dir / "app/models/#{klass.name.underscore}.rbs"
-    FileUtils.mkdir_p(path.dirname)
 
-    sig = RbsRails::ActiveRecord.class_to_rbs(klass)
-    path.write sig
-  end
-end
-```
 
-### For path helpers
-
-```ruby
-# Rakefile
-
-task generate_rbs_for_path_helpers: :environment do
-  require 'rbs_rails'
-  out_path = Rails.root.join 'sig/path_helpers.rbs'
-  rbs = RbsRails::PathHelpers.generate
-  out_path.write rbs
-end
-```
 
 ### Steep integration
 
@@ -83,16 +49,34 @@ target :app do
 
   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
+
 ## 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.
+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.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

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,21 @@ 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 'monitor'
+  library 'singleton'
+  library 'tsort'
+
+  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', '1.0.0'
 end
 
 require 'rbs'
@@ -16,6 +16,7 @@ end
 def env
   @env ||= begin
     loader = RBS::EnvironmentLoader.new()
+    loader.add(library: 'tsort')
     RBS::Environment.from_loader(loader).resolve_type_names
   end
 end

data/bin/gem_rbs

@@ -0,0 +1,94 @@
+#!/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") {
+      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/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/postprocess.rb

@@ -6,7 +6,7 @@ require 'bundler/inline'
 
 gemfile do
   source 'https://rubygems.org'
-  gem 'rbs', '>= 0.17'
+  gem 'rbs', '1.0.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', '-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,
+)
 
-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
@@ -68,6 +68,7 @@ using Module.new {
           kls.members << RBS::AST::Members::AttrAccessor.new(
             name: f.children.first,
             type: untyped,
+            kind: :instance,
             ivar_name: false,
             annotations: [],
             location: nil,
@@ -78,13 +79,65 @@ 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),
+                kind: context.attribute_kind,
+                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),
+                kind: context.attribute_kind,
+                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),
+                kind: context.attribute_kind,
+                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
@@ -122,14 +175,14 @@ using Module.new {
 
     def struct_as_superclass
       name = RBS::TypeName.new(name: 'Struct', namespace: RBS::Namespace.root)
-      RBS::AST::Declarations::Class::Super.new(name: name, args: ['untyped'])
+      RBS::AST::Declarations::Class::Super.new(name: name, args: ['untyped'], location: nil)
     end
   end
 }
 
 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)