rbs_rails 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dd350161bbcf1358c43fbda2fb5b42aa106b42a14f079a26e60338e9ccbae92
-  data.tar.gz: b5a700311050c8500037f70be69d652c96bbf20ebc0334ad49d7c97964b977ec
+  metadata.gz: 82919f7e04d613a702ad6cadbff8df905f23b54bf7dbdae04122a5af5df09608
+  data.tar.gz: 7070d476fe7f15776eed7fa406c423f18ba54077b4293ccb6064c151c7a89754
 SHA512:
-  metadata.gz: 414a6a9fa8feb585dbae5826c68e9043eedeb3b4e1c43d112efdcdcb61c10686d18dc76d57191c34f456ec43c36246cb4c096ceb59dba7cdf0bba4f10a5e4159
-  data.tar.gz: da5d5c7f919d5b2dedfb596bb8e207210ee9a3391db6af13372cc976b57f3ba89ca4b8a19578847f538b4b6adfd547c634f261ac8e21030f2ec98dee3e15147e
+  metadata.gz: 92c046d0f404ff63fe86b3fab5bd92dd24731919827c5ee04330cecf26ae158608e4b0babc1097977ef5cddcbd9474983621d188b996cf264cb96a65142adf95
+  data.tar.gz: 947c7022e0e49010cdc0fbce0bd453993f3ba0bc3df1fb5d406bce94361c49f8d61044b95ba9fed901e6635a9476b4c699812f2334e5e36552552138baada338

data/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6, 2.7, '3.0']
+    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
+    - run: bundle exec rake

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,8 @@
+# Change log
+
+## master (unreleased)
+
+## 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/bin/gem_rbs

@@ -0,0 +1,94 @@
+#!ruby
+
+require 'net/http'
+require 'json'
+require 'securerandom'
+require 'pathname'
+
+TOKEN = ENV.fetch('GITHUB_ACCESS_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: variable type
+    "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/lib/rbs_rails.rb

@@ -1,8 +1,12 @@
 require 'parser/current'
+require 'rbs'
+require 'stringio'
 
 require_relative "rbs_rails/version"
+require_relative "rbs_rails/util"
 require_relative 'rbs_rails/active_record'
 require_relative 'rbs_rails/path_helpers'
+require_relative 'rbs_rails/dependency_builder'
 
 module RbsRails
   class Error < StandardError; end

data/lib/rbs_rails/active_record.rb

@@ -1,59 +1,84 @@
 module RbsRails
   module ActiveRecord
-    def self.class_to_rbs(klass)
-      Generator.new(klass).generate
+
+    def self.class_to_rbs(klass, dependencies: [])
+      Generator.new(klass, dependencies: dependencies).generate
     end
 
     class Generator
-      def initialize(klass)
+      def initialize(klass, dependencies:)
         @klass = klass
+        @dependencies = dependencies
+        @klass_name = Util.module_name(klass)
+
+        namespaces = klass_name.split('::').tap{ |names| names.pop }
+        @dependencies << namespaces.join('::') unless namespaces.empty?
       end
 
       def generate
-        [
-          klass_decl,
-          relation_decl,
-          collection_proxy_decl,
-        ].join("\n")
+        Util.format_rbs klass_decl
       end
 
       private def klass_decl
         <<~RBS
           #{header}
-            extend _ActiveRecord_Relation_ClassMethods[#{klass.name}, #{relation_class_name}]
+            extend _ActiveRecord_Relation_ClassMethods[#{klass_name}, #{relation_class_name}]
 
-          #{columns.indent(2)}
-          #{associations.indent(2)}
-          #{enum_instance_methods.indent(2)}
-          #{enum_scope_methods(singleton: true).indent(2)}
-          #{scopes(singleton: true).indent(2)}
-          end
+          #{columns}
+          #{associations}
+          #{enum_instance_methods}
+          #{enum_scope_methods(singleton: true)}
+          #{scopes(singleton: true)}
+
+          #{relation_decl}
+
+          #{collection_proxy_decl}
+
+          #{footer}
         RBS
       end
 
       private def relation_decl
         <<~RBS
           class #{relation_class_name} < ActiveRecord::Relation
-            include _ActiveRecord_Relation[#{klass.name}]
-            include Enumerable[#{klass.name}]
-          #{enum_scope_methods(singleton: false).indent(2)}
-          #{scopes(singleton: false).indent(2)}
+            include _ActiveRecord_Relation[#{klass_name}]
+            include Enumerable[#{klass_name}]
+          #{enum_scope_methods(singleton: false)}
+          #{scopes(singleton: false)}
           end
         RBS
       end
 
       private def collection_proxy_decl
         <<~RBS
-          class #{klass.name}::ActiveRecord_Associations_CollectionProxy < ActiveRecord::Associations::CollectionProxy
+          class ActiveRecord_Associations_CollectionProxy < ActiveRecord::Associations::CollectionProxy
           end
         RBS
       end
 
-
       private def header
-        # @type var superclass: Class
-        superclass = _ = klass.superclass
-        "class #{klass.name} < #{superclass.name}"
+        namespace = +''
+        klass_name.split('::').map do |mod_name|
+          namespace += "::#{mod_name}"
+          mod_object = Object.const_get(namespace)
+          case mod_object
+          when Class
+            # @type var superclass: Class
+            superclass = _ = mod_object.superclass
+            superclass_name = Util.module_name(superclass)
+            @dependencies << superclass_name
+
+            "class #{mod_name} < #{superclass_name}"
+          when Module
+            "module #{mod_name}"
+          else
+            raise 'unreachable'
+          end
+        end.join("\n")
+      end
+
+      private def footer
+        "end\n" * klass_name.split('::').size
       end
 
       private def associations
@@ -67,7 +92,7 @@ module RbsRails
       private def has_many
         klass.reflect_on_all_associations(:has_many).map do |a|
           singular_name = a.name.to_s.singularize
-          type = a.klass.name
+          type = Util.module_name(a.klass)
           collection_type = "#{type}::ActiveRecord_Associations_CollectionProxy"
           <<~RUBY.chomp
             def #{a.name}: () -> #{collection_type}
@@ -80,7 +105,7 @@ module RbsRails
 
       private def has_one
         klass.reflect_on_all_associations(:has_one).map do |a|
-          type = a.polymorphic? ? 'untyped' : a.klass.name
+          type = a.polymorphic? ? 'untyped' : Util.module_name(a.klass)
           type_optional = optional(type)
           <<~RUBY.chomp
             def #{a.name}: () -> #{type}
@@ -95,7 +120,7 @@ module RbsRails
 
       private def belongs_to
         klass.reflect_on_all_associations(:belongs_to).map do |a|
-          type = a.polymorphic? ? 'untyped' : a.klass.name
+          type = a.polymorphic? ? 'untyped' : Util.module_name(a.klass)
           type_optional = optional(type)
           <<~RUBY.chomp
             def #{a.name}: () -> #{type}
@@ -235,10 +260,7 @@ module RbsRails
       private def parse_model_file
         return @parse_model_file if defined?(@parse_model_file)
 
-
-        # @type var class_name: String
-        class_name = _ = klass.name
-        path = Rails.root.join('app/models/', class_name.underscore + '.rb')
+        path = Rails.root.join('app/models/', klass_name.underscore + '.rb')
         return @parse_model_file = nil unless path.exist?
         return [] unless path.exist?
 
@@ -259,7 +281,7 @@ module RbsRails
       end
 
       private def relation_class_name
-        "#{klass.name}::ActiveRecord_Relation"
+        "ActiveRecord_Relation"
       end
 
       private def columns
@@ -321,8 +343,7 @@ module RbsRails
       end
 
       private
-      # @dynamic klass
-      attr_reader :klass
+      attr_reader :klass, :klass_name
     end
   end
 end

data/lib/rbs_rails/dependency_builder.rb

@@ -0,0 +1,43 @@
+module RbsRails
+  class DependencyBuilder
+    attr_reader :deps
+
+    def initialize
+      @deps = []
+    end
+
+    def build
+      dep_rbs = +""
+      done = Set.new(['ActiveRecord::Base', 'ActiveRecord', 'Object'])
+      deps.uniq!
+      while dep = deps.shift
+        next unless done.add?(dep)
+
+        case dep_object = Object.const_get(dep)
+        when Class
+          superclass = dep_object.superclass or raise
+          super_name = Util.module_name(superclass)
+          deps << super_name
+          dep_rbs << "class #{dep} < #{super_name} end\n"
+        when Module
+          dep_rbs << "module #{dep} end\n"
+        else
+          raise
+        end
+
+        # push namespaces
+        namespaces = dep.split('::')
+        namespaces.pop
+        namespaces.inject('') do |base, name|
+          full_name = base.empty? ? name : [base, name].join('::')
+          deps << full_name
+          full_name
+        end
+      end
+
+      unless dep_rbs.empty?
+        Util.format_rbs(dep_rbs)
+      end
+    end
+  end
+end

data/lib/rbs_rails/rake_task.rb

@@ -3,7 +3,7 @@ require 'rake/tasklib'
 
 module RbsRails
   class RakeTask < Rake::TaskLib
-    attr_accessor :ignore_model_if, :name
+    attr_accessor :ignore_model_if, :name, :signature_root_dir
 
     def initialize(name = :rbs_rails, &block)
       super()
@@ -12,6 +12,8 @@ module RbsRails
 
       block.call(self) if block
 
+      setup_signature_root_dir!
+
       def_copy_signature_files
       def_generate_rbs_for_models
       def_generate_rbs_for_path_helpers
@@ -30,9 +32,7 @@ module RbsRails
       task("#{name}: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)
+        RbsRails.copy_signatures(to: signature_root_dir)
       end
     end
 
@@ -41,23 +41,25 @@ module RbsRails
       task("#{name}:generate_rbs_for_models": :environment) do
         require 'rbs_rails'
 
-        out_dir = Rails.root / 'sig'
-        out_dir.mkdir unless out_dir.exist?
-
         Rails.application.eager_load!
 
+        dep_builder = DependencyBuilder.new
         
         # HACK: for steep
         (_ = ::ActiveRecord::Base).descendants.each do |klass|
           next if klass.abstract_class?
           next if ignore_model_if&.call(klass)
 
-          path = out_dir / "app/models/#{klass.name.underscore}.rbs"
-          FileUtils.mkdir_p(path.dirname)
+          path = signature_root_dir / "app/models/#{klass.name.underscore}.rbs"
+          path.dirname.mkpath
 
-          sig = RbsRails::ActiveRecord.class_to_rbs(klass)
+          sig = RbsRails::ActiveRecord.class_to_rbs(klass, dependencies: dep_builder.deps)
           path.write sig
         end
+
+        if dep_rbs = dep_builder.build
+          signature_root_dir.join('model_dependencies.rbs').write(dep_rbs)
+        end
       end
     end
 
@@ -66,10 +68,16 @@ module RbsRails
       task("#{name}:generate_rbs_for_path_helpers": :environment) do
         require 'rbs_rails'
 
-        out_path = Rails.root.join 'sig/path_helpers.rbs'
+        out_path = signature_root_dir.join 'path_helpers.rbs'
         rbs = RbsRails::PathHelpers.generate
         out_path.write rbs
       end
     end
+
+    private def setup_signature_root_dir!
+      @signature_root_dir ||= Rails.root / 'sig/rbs_rails'
+      @signature_root_dir = Pathname(@signature_root_dir)
+      @signature_root_dir.mkpath
+    end
   end
 end

data/lib/rbs_rails/util.rb

@@ -0,0 +1,25 @@
+module RbsRails
+  module Util
+    MODULE_NAME = Module.instance_method(:name)
+
+    extend self
+
+    if '2.7' <= RUBY_VERSION
+      def module_name(mod)
+        # HACK: RBS doesn't have UnboundMethod#bind_call
+        (_ = MODULE_NAME).bind_call(mod)
+      end
+    else
+      def module_name(mod)
+        MODULE_NAME.bind(mod).call
+      end
+    end
+
+    def format_rbs(rbs)
+      decls = RBS::Parser.parse_signature(rbs)
+      StringIO.new.tap do |io|
+        RBS::Writer.new(out: io).write(decls)
+      end.string
+    end
+  end
+end

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.6.0"
+  VERSION = "0.7.0"
 end

data/rbs_rails.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|gem_rbs)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/sig/rbs_rails/active_record.rbs

@@ -1,11 +1,11 @@
 module RbsRails::ActiveRecord
-  def self.class_to_rbs: (untyped klass) -> untyped
+  def self.class_to_rbs: (untyped klass, ?dependencies: Array[String]) -> untyped
 end
 
 class RbsRails::ActiveRecord::Generator
   @parse_model_file: nil | Parser::AST::Node
 
-  def initialize: (singleton(ActiveRecord::Base) klass) -> untyped
+  def initialize: (singleton(ActiveRecord::Base) klass, dependencies: Array[String]) -> untyped
 
   def generate: () -> String
 
@@ -17,6 +17,8 @@ class RbsRails::ActiveRecord::Generator
 
   def header: () -> String
 
+  def footer: () -> String
+
   def associations: () -> String
 
   def has_many: () -> String
@@ -55,5 +57,9 @@ class RbsRails::ActiveRecord::Generator
 
   def optional: (String) -> String
 
+  private
+
   attr_reader klass: singleton(ActiveRecord::Base)
+
+  attr_reader klass_name: String
 end

data/sig/rbs_rails/dependency_builder.rbs

@@ -0,0 +1,9 @@
+module RbsRails
+  class DependencyBuilder
+    attr_reader deps: Array[String]
+
+    def initialize: () -> void
+
+    def build: () -> (String | nil)
+  end
+end

data/sig/rbs_rails/rake_task.rbs

@@ -7,6 +7,8 @@ module RbsRails
 
     attr_accessor name: Symbol
 
+    attr_accessor signature_root_dir: Pathname
+
     def initialize: (?::Symbol name) { (self) -> void } -> void
 
     def def_all: () -> void
@@ -16,5 +18,9 @@ module RbsRails
     def def_generate_rbs_for_models: () -> void
 
     def def_generate_rbs_for_path_helpers: () -> void
+
+    private
+
+    def setup_signature_root_dir!: () -> void
   end
 end

data/sig/rbs_rails/util.rbs

@@ -0,0 +1,11 @@
+module RbsRails
+  module Util
+    MODULE_NAME: UnboundMethod
+
+    extend Util
+
+    def module_name: (Module) -> String
+
+    def format_rbs: (String) -> String
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs_rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-24 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -45,9 +45,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".gitmodules"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -79,6 +80,7 @@ files:
 - assets/sig/tzinfo.rbs
 - bin/add-type-params.rb
 - bin/console
+- bin/gem_rbs
 - bin/postprocess.rb
 - bin/rbs
 - bin/rbs-prototype-rb.rb
@@ -86,8 +88,10 @@ files:
 - bin/to-ascii.rb
 - lib/rbs_rails.rb
 - lib/rbs_rails/active_record.rb
+- lib/rbs_rails/dependency_builder.rb
 - lib/rbs_rails/path_helpers.rb
 - lib/rbs_rails/rake_task.rb
+- lib/rbs_rails/util.rb
 - lib/rbs_rails/version.rb
 - rbs_rails.gemspec
 - sig/fileutils.rbs
@@ -95,8 +99,10 @@ files:
 - sig/rake.rbs
 - sig/rbs_rails.rbs
 - sig/rbs_rails/active_record.rbs
+- sig/rbs_rails/dependency_builder.rbs
 - sig/rbs_rails/path_helpers.rbs
 - sig/rbs_rails/rake_task.rbs
+- sig/rbs_rails/util.rbs
 - sig/rbs_rails/version.rbs
 homepage: https://github.com/pocke/rbs_rails
 licenses:
@@ -119,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A RBS files generator for Rails application

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.6.5
-  - 2.7.0
-  - ruby-head
-
-before_install:
-  - gem install bundler -v 2.1.4
-
-cache: bundler