rbs_rails 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820a0b86c257e12194d883e6f5edda1793b54cb789c2b57da2e496e16041c803
-  data.tar.gz: 173abfdce9274fc34671198b7640f5e84a92c8b0bb1a7ede8224cd2fb851137d
+  metadata.gz: 5dd350161bbcf1358c43fbda2fb5b42aa106b42a14f079a26e60338e9ccbae92
+  data.tar.gz: b5a700311050c8500037f70be69d652c96bbf20ebc0334ad49d7c97964b977ec
 SHA512:
-  metadata.gz: 500bb14e66e9d6188d931e8a655b8af42b17caf13fa9487e8ad22318a54f34b5e05c412e65c2e68258d13165cb5760d09dc00d52d05b7cb9c9696e97dbbcc8bb
-  data.tar.gz: 86e1ec208cba577ce7ed5ac4a6b7bcd5ada10fe7d3ca0fd4ba5e014a68144bbe3182fcbd04145e9b9472be24a627eb0d5c3a2b7424661caae25d43507390d15a
+  metadata.gz: 414a6a9fa8feb585dbae5826c68e9043eedeb3b4e1c43d112efdcdcb61c10686d18dc76d57191c34f456ec43c36246cb4c096ceb59dba7cdf0bba4f10a5e4159
+  data.tar.gz: da5d5c7f919d5b2dedfb596bb8e207210ee9a3391db6af13372cc976b57f3ba89ca4b8a19578847f538b4b6adfd547c634f261ac8e21030f2ec98dee3e15147e

data/.gitignore

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

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,23 @@ 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?
+require 'rbs_rails/rake_task'
 
-  Rails.application.eager_load!
+RbsRails::RakeTask.new
+```
 
-  ActiveRecord::Base.descendants.each do |klass|
-    next if klass.abstract_class?
+Then, the following four tasks are available.
 
-    path = out_dir / "app/models/#{klass.name.underscore}.rbs"
-    FileUtils.mkdir_p(path.dirname)
+* `rbs_rails:copy_signature_files`: Copy RBS files for rbs_rails
+* `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
 
-    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
 

data/assets/sig/rails.rbs

@@ -1,5 +1,5 @@
 module Rails
-  overload def self.env: () -> ActiveSupport::StringInquirer
+  def self.env: () -> ActiveSupport::StringInquirer | ...
 
   module Dom
     module Testing
@@ -8,7 +8,3 @@ module Rails
     end
   end
 end
-
-class Rails::Application
-  def routes: () -> untyped
-end

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'

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

data/lib/rbs_rails/active_record.rb

@@ -303,23 +303,20 @@ module RbsRails
         when :string, :text, :citext, :uuid, :binary
           'String'
         when :datetime
-          # TODO
-          # ActiveSupport::TimeWithZone.name
-          'Time'
+          'ActiveSupport::TimeWithZone'
         when :boolean
-          "TrueClass | FalseClass"
+          "bool"
         when :jsonb, :json
           "untyped"
         when :date
-          # TODO
-          # Date.name
-          'untyped'
+          'Date'
         when :time
           'Time'
         when :inet
           "IPAddr"
         else
-          raise "unexpected: #{t.inspect}"
+          # Unknown column type, give up
+          'untyped'
         end
       end
 

data/lib/rbs_rails/rake_task.rb

@@ -0,0 +1,75 @@
+require 'rake'
+require 'rake/tasklib'
+
+module RbsRails
+  class RakeTask < Rake::TaskLib
+    attr_accessor :ignore_model_if, :name
+
+    def initialize(name = :rbs_rails, &block)
+      super()
+
+      @name = name
+
+      block.call(self) if block
+
+      def_copy_signature_files
+      def_generate_rbs_for_models
+      def_generate_rbs_for_path_helpers
+      def_all
+    end
+
+    def def_all
+      desc 'Run all tasks of rbs_rails'
+
+      deps = [:"#{name}:copy_signature_files", :"#{name}:generate_rbs_for_models", :"#{name}:generate_rbs_for_path_helpers"]
+      task("#{name}:all": deps)
+    end
+
+    def def_copy_signature_files
+      desc 'Copy RBS files for rbs_rails'
+      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)
+      end
+    end
+
+    def def_generate_rbs_for_models
+      desc 'Generate RBS files for Active Record models'
+      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!
+
+        
+        # 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)
+
+          sig = RbsRails::ActiveRecord.class_to_rbs(klass)
+          path.write sig
+        end
+      end
+    end
+
+    def def_generate_rbs_for_path_helpers
+      desc 'Generate RBS files for path helpers'
+      task("#{name}: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
+    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.5.0"
+  VERSION = "0.6.0"
 end

data/rbs_rails.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'parser'
-  spec.add_runtime_dependency 'rbs', '>= 0.17'
+  spec.add_runtime_dependency 'rbs', '>= 1'
 end

data/sig/fileutils.rbs

@@ -1,3 +1,4 @@
 module FileUtils
   def self.cp_r: (Pathname, Pathname) -> untyped
+  def self.mkdir_p: (String | Array[String], ?untyped) -> Array[String]
 end

data/sig/rake.rbs

@@ -0,0 +1,6 @@
+module Rake
+  class TaskLib
+    def desc: (String) -> void
+    def task: (Hash[Symbol, Symbol | Array[Symbol]]) ?{ () -> void } -> void
+  end
+end

data/sig/rbs_rails/rake_task.rbs

@@ -0,0 +1,20 @@
+module RbsRails
+  class RakeTask < Rake::TaskLib
+    interface _Filter
+      def call: (Class) -> boolish
+    end
+    attr_accessor ignore_model_if: _Filter | nil
+
+    attr_accessor name: Symbol
+
+    def initialize: (?::Symbol name) { (self) -> void } -> void
+
+    def def_all: () -> void
+
+    def def_copy_signature_files: () -> void
+
+    def def_generate_rbs_for_models: () -> void
+
+    def def_generate_rbs_for_path_helpers: () -> void
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs_rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1'
 description: A RBS files generator for Rails application
 email:
 - kuwabara@pocke.me
@@ -87,13 +87,16 @@ files:
 - lib/rbs_rails.rb
 - lib/rbs_rails/active_record.rb
 - lib/rbs_rails/path_helpers.rb
+- lib/rbs_rails/rake_task.rb
 - lib/rbs_rails/version.rb
 - rbs_rails.gemspec
 - sig/fileutils.rbs
 - sig/parser.rbs
+- sig/rake.rbs
 - sig/rbs_rails.rbs
 - sig/rbs_rails/active_record.rbs
 - sig/rbs_rails/path_helpers.rbs
+- sig/rbs_rails/rake_task.rbs
 - sig/rbs_rails/version.rbs
 homepage: https://github.com/pocke/rbs_rails
 licenses:
@@ -116,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.1
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A RBS files generator for Rails application