rbs_rails 0.5.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820a0b86c257e12194d883e6f5edda1793b54cb789c2b57da2e496e16041c803
-  data.tar.gz: 173abfdce9274fc34671198b7640f5e84a92c8b0bb1a7ede8224cd2fb851137d
+  metadata.gz: 2d70009e239cba7c79ad16cf1861495051952a6930205678b05fcf5ad97f0809
+  data.tar.gz: 20e8d58362c2222651aa10430417ac90af1b8e38e5b3bbfcfdf43f186f77eff6
 SHA512:
-  metadata.gz: 500bb14e66e9d6188d931e8a655b8af42b17caf13fa9487e8ad22318a54f34b5e05c412e65c2e68258d13165cb5760d09dc00d52d05b7cb9c9696e97dbbcc8bb
-  data.tar.gz: 86e1ec208cba577ce7ed5ac4a6b7bcd5ada10fe7d3ca0fd4ba5e014a68144bbe3182fcbd04145e9b9472be24a627eb0d5c3a2b7424661caae25d43507390d15a
+  metadata.gz: ef998ce7910f4169eb43716ed8ad0132338751b0c9346213cb02ddecae71fe1c0159d8eb2404877cd599dbd352fe42d3d52bd1316f6577fe2568c912ec0f402a
+  data.tar.gz: 846055b9290bfb250e933686a7dcd05bd52ff331cc1a83a3ddae4cd05ff480b2b43b7c164dbbbff164f25c568837b9d30353eb787464f430b08ffbed69737add

data/.dependabot/config.yml

@@ -0,0 +1,8 @@
+version: 1
+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

@@ -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

@@ -6,5 +6,7 @@
 /pkg/
 /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/.gitmodules

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

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Change log
+
+## master (unreleased)
+
+## 0.8.2 (2021-02-20)
+
+*  Add ActiveRecord::AttributeMethods::Dirty methods [#104](https://github.com/pocke/rbs_rails/pull/104)
+*  Define find method based on primary key [#105](https://github.com/pocke/rbs_rails/pull/105)
+
+## 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

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rbs_rails.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem 'rbs', '>= 0.14.0'
+gem "rake", "~> 13.0"
+gem 'rbs', '>= 1.0.0'
 gem 'steep', '>= 0.34.0'
 gem 'minitest'

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    rbs_rails (0.8.2)
+      parser
+      rbs (>= 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.2.1)
+      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)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.15.0.1)
+    listen (3.4.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    minitest (5.14.3)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (1.0.6)
+    steep (0.41.0)
+      activesupport (>= 5.1)
+      ast_utils (>= 0.4.0)
+      language_server-protocol (~> 3.15.0.1)
+      listen (~> 3.0)
+      parser (>= 2.7)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (~> 1.0.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  minitest
+  rake (~> 13.0)
+  rbs (>= 1.0.0)
+  rbs_rails!
+  steep (>= 0.34.0)
+
+BUNDLED WITH
+   2.2.4

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
-
-task generate_rbs_for_model: :environment do
-  require 'rbs_rails'
-
-  out_dir = Rails.root / 'sig'
-  out_dir.mkdir unless out_dir.exist?
-
-  Rails.application.eager_load!
+require 'rbs_rails/rake_task'
 
-  ActiveRecord::Base.descendants.each do |klass|
-    next if klass.abstract_class?
+RbsRails::RakeTask.new
+```
 
-    path = out_dir / "app/models/#{klass.name.underscore}.rbs"
-    FileUtils.mkdir_p(path.dirname)
+Then, the following three tasks are available.
 
-    sig = RbsRails::ActiveRecord.class_to_rbs(klass)
-    path.write sig
-  end
-end
-```
+* `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
 
-### 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
 
@@ -89,6 +55,9 @@ target :app do
   library 'logger'
   library 'mutex_m'
   library 'date'
+  library 'monitor'
+  library 'singleton'
+  library 'tsort'
 
   library 'activesupport'
   library 'actionpack'
@@ -104,7 +73,10 @@ You need to put RBS repo to `path/to/rbs_repo`. See https://github.com/ruby/gem_
 
 ## 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/Steepfile

@@ -9,6 +9,9 @@ target :lib do
   library "logger"
   library "mutex_m"
   library "date"
+  library 'monitor'
+  library 'singleton'
+  library 'tsort'
 
   library 'activesupport'
   library 'actionpack'

data/bin/add-type-params.rb

@@ -4,7 +4,7 @@ require 'bundler/inline'
 
 gemfile do
   source 'https://rubygems.org'
-  gem 'rbs', '>= 0.19'
+  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_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/postprocess.rb

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

data/bin/rbs

@@ -18,7 +18,7 @@ end
 exec(
   'rbs',
   # Require stdlibs
-  '-rlogger', '-rpathname', '-rmutex_m', '-rdate',
+  '-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'),

data/bin/rbs-prototype-rb.rb

@@ -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,
@@ -98,6 +99,7 @@ using Module.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: []
@@ -111,6 +113,7 @@ using Module.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: []
@@ -124,6 +127,7 @@ using Module.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: []
@@ -171,7 +175,7 @@ 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
 }