rbs_rails 0.10.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16dd1379f4621410d78e352c8fdc8750d3fb469d8c395aee77de85d2f8570279
-  data.tar.gz: e50b75cc1e64a8630c1508805d146d2cf5edad065cdcab502f910fcb84bc51ef
+  metadata.gz: cb24ff75184c9065e46c16a3dc7b5822320255c0d7045ac82dae766b753c6638
+  data.tar.gz: 23ed2ffdbfe910c0140610016b2a6d7671a99a6bc72e569c03dfd77b9418e78f
 SHA512:
-  metadata.gz: 12136882eeebf0e2219af85c6393f6b8a74c4bc6f268b57d5b9c931a99fa42ee81ed9deb9885d4209f28dbf43d9d57563641379031c199397cf520a7dc417f10
-  data.tar.gz: 40ffd8a1525501f736f759769a95183e3933da0c1063e5e939b6c4ccf23ae9d98731ef782c23f6c7eb6b7280b2c39f535379886edeb3abeb423810cf2ead58ac
+  metadata.gz: 9f3c61ac885a8a3a8c607a9452ac21ce216a77aec13a84a2e77ec9285fdfcb4c7e43a6ff712825d538c297e29c611fad4978ef0cdebdca166c042dfb6cab8a2d
+  data.tar.gz: 2301cbe92bf518435e5f4323e3cc5bfbba5a4b01bfe6511916bdbfbb8f2a034421e41dc90f61035e8db8dad3bffc0108454ca62c7cf380edee967aa3ba35694e

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 ## master (unreleased)
 
+## 0.12.0
+
+* Support RBS v3. [#246](https://github.com/pocke/rbs_rails/pull/246)
+* Ignore `_scope` as enum field name. [#249](https://github.com/pocke/rbs_rails/pull/249)
+
+## 0.11.0 (2022-03-24)
+
+### New Features
+
+* Add rails generator to generate rbs.rake. [#217](https://github.com/pocke/rbs_rails/pull/217)
+
+### Bug Fixes
+
+* Do not expose polyfil RBSs. [#218](https://github.com/pocke/rbs_rails/pull/218)
+
 ## 0.10.1 (2022-03-23)
 
 ### Bug Fixes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbs_rails (0.10.1)
+    rbs_rails (0.12.0)
       parser
       rbs (>= 1)
 
@@ -163,7 +163,6 @@ GEM
 
 PLATFORMS
   ruby
-  x86_64-linux
 
 DEPENDENCIES
   minitest

data/README.md

@@ -20,12 +20,10 @@ Or install it yourself as:
 
 ## Usage
 
-Put the following code to `lib/tasks/rbs.rake`.
+Run the following command. It generates `lib/tasks/rbs.rake`.
 
-```ruby
-require 'rbs_rails/rake_task'
-
-RbsRails::RakeTask.new
+```console
+$ bin/rails g rbs_rails:install
 ```
 
 Then, the following three tasks are available.

data/lib/generators/rbs_rails/install_generator.rb

@@ -0,0 +1,26 @@
+require 'rails'
+
+module RbsRails
+  class InstallGenerator < Rails::Generators::Base
+    def create_raketask
+      create_file "lib/tasks/rbs.rake", <<~RUBY
+        require 'rbs_rails/rake_task'
+
+        RbsRails::RakeTask.new do |task|
+          # If you want to avoid generating RBS for some classes, comment in it.
+          # default: nil
+          #
+          # task.ignore_model_if = -> (klass) { klass == MyClass }
+
+          # If you want to change the rake task namespace, comment in it.
+          # default: :rbs_rails
+          # task.name = :cool_rbs_rails
+
+          # If you want to change where RBS Rails writes RBSs into, comment in it.
+          # default: Rails.root / 'sig/rbs_rails'
+          # task.signature_root_dir = Rails.root / 'my_sig/rbs_rails'
+        end
+      RUBY
+    end
+  end
+end

data/lib/rbs_rails/active_record.rb

@@ -12,6 +12,8 @@ module RbsRails
     end
 
     class Generator
+      IGNORED_ENUM_KEYS = %i[_prefix _suffix _default _scopes]
+
       def initialize(klass, dependencies:)
         @klass = klass
         @dependencies = dependencies
@@ -159,11 +161,13 @@ module RbsRails
         klass.reflect_on_all_associations(:belongs_to).map do |a|
           @dependencies << a.klass.name unless a.polymorphic?
 
+          is_optional = a.options[:optional]
+
           type = a.polymorphic? ? 'untyped' : Util.module_name(a.klass)
           type_optional = optional(type)
           # @type var methods: Array[String]
           methods = []
-          methods << "def #{a.name}: () -> #{type}"
+          methods << "def #{a.name}: () -> #{is_optional ? type_optional : type}"
           methods << "def #{a.name}=: (#{type_optional}) -> #{type_optional}"
           methods << "def reload_#{a.name}: () -> #{type_optional}"
           if !a.polymorphic?
@@ -316,7 +320,7 @@ module RbsRails
         methods = []
         enum_definitions.each do |hash|
           hash.each do |name, values|
-            next if name == :_prefix || name == :_suffix || name == :_default
+            next if IGNORED_ENUM_KEYS.include?(name)
 
             values.each do |label, value|
               value_method_name = enum_method_name(hash, name, label)
@@ -334,7 +338,7 @@ module RbsRails
         methods = []
         enum_definitions.each do |hash|
           hash.each do |name, values|
-            next if name == :_prefix || name == :_suffix || name == :_default
+            next if IGNORED_ENUM_KEYS.include?(name)
 
             values.each do |label, value|
               value_method_name = enum_method_name(hash, name, label)

data/lib/rbs_rails/util.rb

@@ -16,7 +16,16 @@ module RbsRails
     end
 
     def format_rbs(rbs)
-      decls = RBS::Parser.parse_signature(rbs)
+      decls =
+        if Gem::Version.new('3') <= Gem::Version.new(RBS::VERSION) 
+          # TODO: Remove this type annotation when rbs_rails depends on RBS v3
+          # @type var parsed: [RBS::Buffer, untyped, RBS::Declarations::t]
+          parsed = _ = RBS::Parser.parse_signature(rbs)
+          parsed[1] + parsed[2]
+        else
+          RBS::Parser.parse_signature(rbs)
+        end
+
       StringIO.new.tap do |io|
         RBS::Writer.new(out: io).write(decls)
       end.string

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.10.1"
+  VERSION = "0.12.0"
 end

data/sig/_internal/thor.rbs

@@ -0,0 +1,5 @@
+class Thor
+  module Actions
+    def create_file: (String, String) -> void
+  end
+end

data/sig/install_generator.rbs

@@ -0,0 +1,5 @@
+module RbsRails
+  class InstallGenerator < Rails::Generators::Base
+    def create_raketask: () -> void
+  end
+end

data/sig/rbs_rails/active_record.rbs

@@ -7,6 +7,8 @@ class RbsRails::ActiveRecord::Generator
   @parse_model_file: nil | Parser::AST::Node
   @dependencies: Array[String]
 
+  IGNORED_ENUM_KEYS: Array[Symbol]
+
   def initialize: (singleton(ActiveRecord::Base) klass, dependencies: Array[String]) -> untyped
 
   def generate: () -> String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs_rails
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -63,6 +63,7 @@ files:
 - bin/rbs-prototype-rb.rb
 - bin/setup
 - bin/to-ascii.rb
+- lib/generators/rbs_rails/install_generator.rb
 - lib/rbs_rails.rb
 - lib/rbs_rails/active_record.rb
 - lib/rbs_rails/dependency_builder.rb
@@ -73,8 +74,10 @@ files:
 - rbs_collection.lock.yaml
 - rbs_collection.yaml
 - rbs_rails.gemspec
-- sig/activerecord.rbs
-- sig/fileutils.rbs
+- sig/_internal/activerecord.rbs
+- sig/_internal/fileutils.rbs
+- sig/_internal/thor.rbs
+- sig/install_generator.rbs
 - sig/parser.rbs
 - sig/rake.rbs
 - sig/rbs_rails.rbs
@@ -106,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: A RBS files generator for Rails application