rbs_activesupport 1.0.0 → 1.2.0

data/lib/rbs_activesupport/parser.rb

@@ -8,39 +8,62 @@ require "rbs/prototype/rb"
 module RbsActivesupport
   class Parser < ::RBS::Prototype::RB
     class MethodCall
-      attr_reader :name, :args
+      attr_reader :name #: t
+      attr_reader :args #: Array[RubyVM::AbstractSyntaxTree::Node]
+      attr_reader :trailing_comment #: String?
 
-      def initialize(name, args, private)
+      # @rbs @private: bool
+
+      # @rbs name: t
+      # @rbs args: Array[RubyVM::AbstractSyntaxTree::Node]
+      # @rbs private: bool
+      # @rbs trailing_comment: String?
+      def initialize(name, args, private, trailing_comment: nil) #: void
         @name = name
         @args = args
         @private = private
+        @trailing_comment = trailing_comment
       end
 
-      def private?
+      def private? #: bool
         @private
       end
     end
 
+    # @rbs!
+    #   type t = :class_attribute | :delegate | :cattr_accessor | :mattr_accessor | :cattr_reader | :mattr_reader |
+    #            :cattr_writer | :mattr_writer | :include
+
     METHODS = %i[
       class_attribute delegate cattr_accessor mattr_accessor cattr_reader mattr_reader cattr_writer mattr_writer include
-    ].freeze # steep:ignore IncompatibleAssignment
+    ].freeze #: Array[t] # steep:ignore IncompatibleAssignment
 
     alias process_orig process
 
-    attr_reader :method_calls
+    attr_reader :comment_parser #: CommentParser
+    attr_reader :method_calls #: Hash[RBS::Namespace, Array[MethodCall]]
 
-    def initialize
+    def initialize #: void
       super
+      @comment_parser = CommentParser.new
       @method_calls = Hash.new { |hash, key| hash[key] = [] }
     end
 
+    # @rbs string: String
+    def parse(string) #: void
+      comment_parser.parse(string)
+      super
+    end
+
+    # @rbs override
     def process(node, decls:, comments:, context:)
       case node.type
       when :FCALL, :VCALL
         args = node.children[1]&.children || []
         case node.children[0]
         when *METHODS
-          @method_calls[context.namespace] << MethodCall.new(node.children[0], args, private?(decls))
+          @method_calls[context.namespace] << MethodCall.new(node.children[0], args, private?(decls),
+                                                             trailing_comment: trailing_comment_for(node))
         else
           process_orig(node, decls: decls, comments: comments, context: context)
         end
@@ -49,7 +72,13 @@ module RbsActivesupport
       end
     end
 
-    def private?(decls)
+    # @rbs node: RubyVM::AbstractSyntaxTree::Node
+    def trailing_comment_for(node) #: String?
+      comment_parser.trailing_comments[node.last_lineno]
+    end
+
+    # @rbs decls: Array[RBS::AST::Declarations::t | RBS::AST::Members::t]
+    def private?(decls) #: bool
       current_accessibility(decls) == private
     end
   end

data/lib/rbs_activesupport/rake_task.rb

@@ -5,13 +5,20 @@ require "rake/tasklib"
 
 module RbsActivesupport
   class RakeTask < Rake::TaskLib
-    attr_accessor :name, :signature_root_dir
+    attr_accessor :name #: Symbol
+    attr_accessor :signature_root_dir #: Pathname
+    attr_accessor :target_directories #: Array[Pathname]
 
-    def initialize(name = :'rbs:activesupport', &block)
+    # @rbs @rbs_builder: RBS::DefinitionBuilder
+
+    # @rbs name: Symbol
+    # @rbs &block: ?(self) -> void
+    def initialize(name = :'rbs:activesupport', &block) #: void
       super()
 
       @name = name
       @signature_root_dir = Pathname(Rails.root / "sig/activesupport")
+      @target_directories = [Rails.root / "app"]
 
       block&.call(self)
 
@@ -20,14 +27,14 @@ module RbsActivesupport
       define_setup_task
     end
 
-    def define_setup_task
+    def define_setup_task #: void
       desc "Run all tasks of rbs_activesupport"
 
       deps = [:"#{name}:clean", :"#{name}:generate"]
       task("#{name}:setup" => deps)
     end
 
-    def define_generate_task
+    def define_generate_task #: void
       desc "Generate RBS files for activesupport gem"
       task("#{name}:generate": :environment) do
         require "rbs_activesupport" # load RbsActivesupport lazily
@@ -36,18 +43,20 @@ module RbsActivesupport
 
         signature_root_dir.mkpath
 
-        (Rails.root / "app").glob("**/*.rb").each do |file|
-          rbs = Generator.new(file, rbs_builder).generate
-          next unless rbs
+        target_directories.each do |dir|
+          dir.glob("**/*.rb").each do |file|
+            rbs = Generator.new(file, rbs_builder).generate
+            next unless rbs
 
-          rbs_path = signature_root_dir / file.sub_ext(".rbs").relative_path_from(Rails.root)
-          rbs_path.dirname.mkpath
-          rbs_path.write(rbs)
+            rbs_path = signature_root_dir / file.sub_ext(".rbs").relative_path_from(Rails.root)
+            rbs_path.dirname.mkpath
+            rbs_path.write(rbs)
+          end
         end
       end
     end
 
-    def define_clean_task
+    def define_clean_task #: void
       desc "Clean RBS files for config gem"
       task "#{name}:clean" do
         signature_root_dir.rmtree if signature_root_dir.exist?
@@ -56,7 +65,7 @@ module RbsActivesupport
 
     private
 
-    def rbs_builder
+    def rbs_builder #: RBS::DefinitionBuilder
       @rbs_builder ||= begin
         loader = RBS::CLI::LibraryOptions.new.loader
         loader.add(path: Pathname("sig"))

data/lib/rbs_activesupport/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RbsActivesupport
-  VERSION = "1.0.0"
+  VERSION = "1.2.0" #: String
 end

data/lib/rbs_activesupport.rb

@@ -9,6 +9,7 @@ require_relative "rbs_activesupport/generator"
 require_relative "rbs_activesupport/include"
 require_relative "rbs_activesupport/method_searcher"
 require_relative "rbs_activesupport/parser"
+require_relative "rbs_activesupport/parser/comment_parser"
 require_relative "rbs_activesupport/version"
 
 module RbsActivesupport

data/rbs_collection.lock.yaml

@@ -6,7 +6,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: actionview
@@ -14,7 +14,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: activesupport
@@ -22,7 +22,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: ast
@@ -30,7 +30,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: base64
@@ -50,7 +50,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: connection_pool
@@ -58,7 +58,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: date
@@ -82,7 +82,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: io-console
@@ -114,7 +114,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: optparse
@@ -126,7 +126,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: parser
@@ -134,7 +134,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: pathname
@@ -154,7 +154,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rails-dom-testing
@@ -162,7 +162,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: railties
@@ -170,7 +170,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rainbow
@@ -178,7 +178,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rake
@@ -186,7 +186,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rbs
@@ -202,15 +202,19 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
+- name: ripper
+  version: '0'
+  source:
+    type: stdlib
 - name: rubocop
   version: '1.57'
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rubocop-ast
@@ -218,7 +222,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: securerandom
@@ -242,7 +246,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: time
@@ -262,7 +266,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: a6ed3d2c66aa743a4f6f71b70e0c7e912b94d054
+    revision: 4f55d83688a772342f0d96966cd51d06af03c2c8
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: uri

data/rbs_collection.yaml

@@ -13,7 +13,5 @@ sources:
 # A directory to install the downloaded RBSs
 path: .gem_rbs_collection
 
-# gems:
-#   # If you want to avoid installing rbs files for gems, you can specify them here.
-#   - name: GEM_NAME
-#     ignore: true
+gems:
+  - name: ripper

data/sig/generators/rbs_activesupport/install_generator.rbs

@@ -0,0 +1,7 @@
+# Generated from lib/generators/rbs_activesupport/install_generator.rb with RBS::Inline
+
+module RbsActivesupport
+  class InstallGenerator < Rails::Generators::Base
+    def create_raketask: () -> untyped
+  end
+end

data/sig/rbs_activesupport/ast.rbs

@@ -1,7 +1,13 @@
+# Generated from lib/rbs_activesupport/ast.rb with RBS::Inline
+
 module RbsActivesupport
   module AST
-    def eval_args: (Array[untyped] args) -> Array[Array[Symbol?]]
-    def eval_args_with_options: (Array[untyped] args) -> [Array[Symbol], Hash[Symbol, untyped]]
+    # @rbs node: Array[untyped]
+    def eval_args: (Array[untyped] node) -> Array[Array[Symbol?]]
+
+    # @rbs node: Array[untyped]
+    def eval_args_with_options: (Array[untyped] node) -> [ Array[Symbol], Hash[Symbol, untyped] ]
+
     def eval_node: (untyped node) -> untyped
   end
 end

data/sig/rbs_activesupport/attribute_accessor.rbs

@@ -1,15 +1,29 @@
+# Generated from lib/rbs_activesupport/attribute_accessor.rb with RBS::Inline
+
 module RbsActivesupport
   class AttributeAccessor
     attr_reader name: Symbol
+
     attr_reader options: Hash[untyped, untyped]
 
+    # @rbs name: Symbol
+    # @rbs options: Hash[untyped, untyped]
     def initialize: (Symbol name, Hash[untyped, untyped] options) -> void
+
+    def type: () -> String
+
     def singleton_reader?: () -> bool
+
     def singleton_writer?: () -> bool
+
     def instance_accessor?: () -> bool
+
     def instance_reader?: () -> bool
+
     def instance_writer?: () -> bool
+
     def public?: () -> bool
+
     def private?: () -> bool
   end
 end

data/sig/rbs_activesupport/class_attribute.rbs

@@ -1,14 +1,27 @@
+# Generated from lib/rbs_activesupport/class_attribute.rb with RBS::Inline
+
 module RbsActivesupport
   class ClassAttribute
     attr_reader name: Symbol
+
     attr_reader options: Hash[untyped, untyped]
 
+    # @rbs name: Symbol
+    # @rbs options: Hash[untyped, untyped]
     def initialize: (Symbol name, Hash[untyped, untyped] options) -> void
+
+    def type: () -> String
+
     def instance_accessor?: () -> bool
+
     def instance_reader?: () -> bool
+
     def instance_writer?: () -> bool
+
     def instance_predicate?: () -> bool
+
     def public?: () -> bool
+
     def private?: () -> bool
   end
 end

data/sig/rbs_activesupport/declaration_builder.rbs

@@ -1,3 +1,5 @@
+# Generated from lib/rbs_activesupport/declaration_builder.rb with RBS::Inline
+
 module RbsActivesupport
   class DeclarationBuilder
     type t = AttributeAccessor | ClassAttribute | Delegate | Include
@@ -6,20 +8,46 @@ module RbsActivesupport
 
     attr_reader method_searcher: MethodSearcher
 
+    # @rbs method_searcher: MethodSearcher
     def initialize: (MethodSearcher method_searcher) -> void
-    def build: (RBS::Namespace namespace, Array[Parser::MethodCall] method_calls) -> [Array[String], Array[String]]
+
+    # @rbs namespace: RBS::Namespace
+    # @rbs method_calls: Array[Parser::MethodCall]
+    def build: (RBS::Namespace namespace, Array[Parser::MethodCall] method_calls) -> [ Array[String], Array[String] ]
 
     private
 
+    # @rbs namespace: RBS::Namespace
+    # @rbs method_calls: Array[Parser::MethodCall]
     def build_method_calls: (RBS::Namespace namespace, Array[Parser::MethodCall] method_calls) -> Array[t]
+
+    # @rbs method_call: Parser::MethodCall
     def build_attribute_accessor: (Parser::MethodCall method_call) -> Array[AttributeAccessor]
-    def build_class_attribute: (Parser::MethodCall method_calls) -> Array[ClassAttribute]
-    def build_delegate: (RBS::Namespace namespace, Parser::MethodCall method_calls) -> Array[Delegate]
-    def build_include: (RBS::Namespace namespace, Parser::MethodCall method_calls) -> Array[Include]
+
+    # @rbs method_call: Parser::MethodCall
+    def build_class_attribute: (Parser::MethodCall method_call) -> Array[ClassAttribute]
+
+    # @rbs namespace: RBS::Namespace
+    # @rbs method_call: Parser::MethodCall
+    def build_delegate: (RBS::Namespace namespace, Parser::MethodCall method_call) -> Array[Delegate]
+
+    # @rbs namespace: RBS::Namespace
+    # @rbs method_call: Parser::MethodCall
+    def build_include: (RBS::Namespace namespace, Parser::MethodCall method_call) -> Array[Include]
+
+    # @rbs decl: t
     def render: (t decl) -> String?
+
+    # @rbs decl: AttributeAccessor
     def render_attribute_accessor: (AttributeAccessor decl) -> String
+
+    # @rbs decl: ClassAttribute
     def render_class_attribute: (ClassAttribute decl) -> String
+
+    # @rbs decl: Delegate
     def render_delegate: (Delegate decl) -> String
+
+    # @rbs decl: Include
     def render_include: (Include decl) -> String?
   end
 end

data/sig/rbs_activesupport/delegate.rbs

@@ -1,13 +1,24 @@
+# Generated from lib/rbs_activesupport/delegate.rb with RBS::Inline
+
 module RbsActivesupport
   class Delegate
     attr_reader namespace: RBS::Namespace
+
     attr_reader method: Symbol
+
     attr_reader options: Hash[Symbol, untyped]
 
+    # @rbs namespace: RBS::Namespace
+    # @rbs method: Symbol
+    # @rbs options: Hash[Symbol, untyped]
     def initialize: (RBS::Namespace namespace, Symbol method, Hash[Symbol, untyped] options) -> void
+
     def to: () -> Symbol
+
     def method_name: () -> Symbol
+
     def public?: () -> bool
+
     def private?: () -> bool
   end
 end

data/sig/rbs_activesupport/generator.rbs

@@ -1,20 +1,34 @@
+# Generated from lib/rbs_activesupport/generator.rb with RBS::Inline
+
 module RbsActivesupport
   class Generator
+    # @rbs pathname: Pathname
+    # @rbs rbs_builder: RBS::DefinitionBuilder
     def self.generate: (Pathname pathname, RBS::DefinitionBuilder rbs_builder) -> String?
 
     include AST
 
     attr_reader pathname: Pathname
+
     attr_reader declaration_builder: DeclarationBuilder
 
+    # @rbs pathname: Pathname
+    # @rbs rbs_builder: RBS::DefinitionBuilder
     def initialize: (Pathname pathname, RBS::DefinitionBuilder rbs_builder) -> void
+
     def generate: () -> String?
 
     private
 
+    # @rbs rbs: String
     def format: (String rbs) -> String
+
     def parse_source_code: () -> Hash[RBS::Namespace, Array[Parser::MethodCall]]
+
+    # @rbs namespace: RBS::Namespace
     def header: (RBS::Namespace namespace) -> String
+
+    # @rbs namespace: RBS::Namespace
     def footer: (RBS::Namespace namespace) -> String
   end
 end

data/sig/rbs_activesupport/include.rbs

@@ -1,16 +1,30 @@
+# Generated from lib/rbs_activesupport/include.rb with RBS::Inline
+
 module RbsActivesupport
   class Include
     attr_reader context: RBS::Namespace
+
     attr_reader module_path: Array[Symbol?]
+
     attr_reader options: Hash[Symbol, untyped]
 
+    # @rbs context: RBS::Namespace
+    # @rbs module_path: Array[Symbol?]
+    # @rbs options: Hash[Symbol, untyped]
     def initialize: (RBS::Namespace context, Array[Symbol?] module_path, Hash[Symbol, untyped] options) -> void
+
     def argument: () -> RBS::Namespace
+
+    # @rbs %a{pure}
     %a{pure}
     def module_name: () -> RBS::Namespace?
+
     def concern?: () -> bool
+
     def classmethods?: () -> bool
+
     def public?: () -> bool
+
     def private?: () -> bool
   end
 end

data/sig/rbs_activesupport/method_searcher.rbs

@@ -1,12 +1,19 @@
+# Generated from lib/rbs_activesupport/method_searcher.rb with RBS::Inline
+
 module RbsActivesupport
   class MethodSearcher
     attr_reader rbs_builder: RBS::DefinitionBuilder
 
+    # @rbs rbs_builder: RBS::DefinitionBuilder
     def initialize: (RBS::DefinitionBuilder rbs_builder) -> void
+
+    # @rbs delegate: Delegate
     def method_types_for: (Delegate delegate) -> Array[String]
 
     private
 
-    def lookup_method_types: (RBS::TypeName namespace, Symbol method) -> Array[RBS::MethodType]
+    # @rbs type_name: RBS::TypeName
+    # @rbs method: Symbol
+    def lookup_method_types: (RBS::TypeName type_name, Symbol method) -> Array[RBS::MethodType]
   end
 end

data/sig/rbs_activesupport/parser/comment_parser.rbs

@@ -0,0 +1,16 @@
+# Generated from lib/rbs_activesupport/parser/comment_parser.rb with RBS::Inline
+
+module RbsActivesupport
+  class Parser
+    class CommentParser
+      attr_reader line_comments: Hash[Integer, String]
+
+      attr_reader trailing_comments: Hash[Integer, String]
+
+      def initialize: () -> void
+
+      # @rbs string: String
+      def parse: (String string) -> self
+    end
+  end
+end