rbs 3.9.4 → 4.1.1

data/lib/rbs/cli/validate.rb

@@ -4,36 +4,33 @@ module RBS
   class CLI
     class Validate
       class Errors
-        def initialize(limit:, exit_error:)
+        def initialize(limit:)
           @limit = limit
-          @exit_error = exit_error
           @errors = []
-          @has_syntax_error = false
         end
 
         def add(error)
-          if error.instance_of?(WillSyntaxError)
-            RBS.logger.warn(build_message(error))
-            @has_syntax_error = true
-          else
-            @errors << error
-          end
+          @errors << error
           finish if @limit == 1
         end
 
+        def try(&block)
+          catch(:finish) do |tag|
+            @tag = tag
+            yield
+            finish()
+          end
+        end
+
         def finish
-          if @errors.empty?
-            if @exit_error && @has_syntax_error
-              exit 1
-            else
-              # success
-            end
-          else
+          unless @errors.empty?
             @errors.each do |error|
               RBS.logger.error(build_message(error))
             end
-            exit 1
+            throw @tag, 1
           end
+
+          0
         end
 
         private
@@ -53,7 +50,6 @@ module RBS
         @env = Environment.from_loader(loader).resolve_type_names
         @builder = DefinitionBuilder.new(env: @env)
         @validator = Validator.new(env: @env)
-        exit_error = false
         limit = nil #: Integer?
         OptionParser.new do |opts|
           opts.banner = <<EOU
@@ -70,25 +66,25 @@ EOU
             RBS.print_warning { "`--silent` option is deprecated because it's silent by default. You can use --log-level option of rbs command to display more information." }
           end
           opts.on("--[no-]exit-error-on-syntax-error", "exit(1) if syntax error is detected") {|bool|
-            exit_error = bool
+            RBS.print_warning { "`--exit-error-on-syntax-error` option is deprecated because it's validated during parsing.." }
           }
           opts.on("--fail-fast", "Exit immediately as soon as a validation error is found.") do |arg|
             limit = 1
           end
         end.parse!(args)
 
-        @errors = Errors.new(limit: limit, exit_error: exit_error)
+        @errors = Errors.new(limit: limit)
       end
 
       def run
-        validate_class_module_definition
-        validate_class_module_alias_definition
-        validate_interface
-        validate_constant
-        validate_global
-        validate_type_alias
-
-        @errors.finish
+        @errors.try do
+          validate_class_module_definition
+          validate_class_module_alias_definition
+          validate_interface
+          validate_constant
+          validate_global
+          validate_type_alias
+        end
       end
 
       private
@@ -109,29 +105,23 @@ EOU
 
           case entry
           when Environment::ClassEntry
-            entry.decls.each do |decl|
-              if super_class = decl.decl.super_class
+            entry.each_decl do |decl|
+              if super_class = decl.super_class
                 super_class.args.each do |arg|
-                  void_type_context_validator(arg, true)
-                  no_self_type_validator(arg)
-                  no_classish_type_validator(arg)
                   @validator.validate_type(arg, context: nil)
                 end
               end
             end
           when Environment::ModuleEntry
-            entry.decls.each do |decl|
-              decl.decl.self_types.each do |self_type|
+            entry.each_decl do |decl|
+              decl.self_types.each do |self_type|
                 self_type.args.each do |arg|
-                  void_type_context_validator(arg, true)
-                  no_self_type_validator(arg)
-                  no_classish_type_validator(arg)
                   @validator.validate_type(arg, context: nil)
                 end
 
                 self_params =
                   if self_type.name.class?
-                    @env.normalized_module_entry(self_type.name)&.type_params
+                    @env.module_entry(self_type.name, normalized: true)&.type_params
                   else
                     @env.interface_decls[self_type.name]&.decl&.type_params
                   end
@@ -143,7 +133,7 @@ EOU
             end
           end
 
-          d = entry.primary.decl
+          d = entry.primary_decl
 
           @validator.validate_type_params(
             d.type_params,
@@ -153,55 +143,43 @@ EOU
 
           d.type_params.each do |param|
             if ub = param.upper_bound_type
-              void_type_context_validator(ub)
-              no_self_type_validator(ub)
-              no_classish_type_validator(ub)
               @validator.validate_type(ub, context: nil)
             end
 
+            if lb = param.lower_bound_type
+              @validator.validate_type(lb, context: nil)
+            end
+
             if dt = param.default_type
-              void_type_context_validator(dt, true)
-              no_self_type_validator(dt)
-              no_classish_type_validator(dt)
               @validator.validate_type(dt, context: nil)
             end
           end
 
           TypeParamDefaultReferenceError.check!(d.type_params)
 
-          entry.decls.each do |d|
-            d.decl.each_member do |member|
-              case member
-              when AST::Members::MethodDefinition
-                @validator.validate_method_definition(member, type_name: name)
-                member.overloads.each do |ov|
-                  void_type_context_validator(ov.method_type)
-                end
-              when AST::Members::Attribute
-                void_type_context_validator(member.type)
-              when AST::Members::Mixin
-                member.args.each do |arg|
-                  no_self_type_validator(arg)
-                  unless arg.is_a?(Types::Bases::Void)
-                    void_type_context_validator(arg, true)
-                  end
-                end
-                params =
-                  if member.name.class?
-                    module_decl = @env.normalized_module_entry(member.name) or raise
-                    module_decl.type_params
-                  else
-                    interface_decl = @env.interface_decls.fetch(member.name)
-                    interface_decl.decl.type_params
-                  end
-                InvalidTypeApplicationError.check!(type_name: member.name, params: params, args: member.args, location: member.location)
-              when AST::Members::Var
-                @validator.validate_variable(member)
-                void_type_context_validator(member.type)
-                if member.is_a?(AST::Members::ClassVariable)
-                  no_self_type_validator(member.type)
+          entry.each_decl do |decl|
+            case decl
+            when AST::Declarations::Base
+              decl.each_member do |member|
+                case member
+                when AST::Members::MethodDefinition
+                  @validator.validate_method_definition(member, type_name: name)
+                when AST::Members::Mixin
+                  params =
+                    if member.name.class?
+                      module_decl = @env.module_entry(member.name, normalized: true) or raise
+                      module_decl.type_params
+                    else
+                      interface_decl = @env.interface_decls.fetch(member.name)
+                      interface_decl.decl.type_params
+                    end
+                  InvalidTypeApplicationError.check!(type_name: member.name, params: params, args: member.args, location: member.location)
+                when AST::Members::Var
+                  @validator.validate_variable(member)
                 end
               end
+            else
+              raise "Unknown declaration: #{decl.class}"
             end
           end
         rescue BaseError => error
@@ -233,16 +211,14 @@ EOU
 
           decl.decl.type_params.each do |param|
             if ub = param.upper_bound_type
-              void_type_context_validator(ub)
-              no_self_type_validator(ub)
-              no_classish_type_validator(ub)
               @validator.validate_type(ub, context: nil)
             end
 
+            if lb = param.lower_bound_type
+              @validator.validate_type(lb, context: nil)
+            end
+
             if dt = param.default_type
-              void_type_context_validator(dt, true)
-              no_self_type_validator(dt)
-              no_classish_type_validator(dt)
               @validator.validate_type(dt, context: nil)
             end
           end
@@ -253,10 +229,6 @@ EOU
             case member
             when AST::Members::MethodDefinition
               @validator.validate_method_definition(member, type_name: name)
-              member.overloads.each do |ov|
-                void_type_context_validator(ov.method_type)
-                no_classish_type_validator(ov.method_type)
-              end
             end
           end
         rescue BaseError => error
@@ -269,9 +241,6 @@ EOU
           RBS.logger.info "Validating constant: `#{name}`..."
           @validator.validate_type const.decl.type, context: const.context
           @builder.ensure_namespace!(name.namespace, location: const.decl.location)
-          no_self_type_validator(const.decl.type)
-          no_classish_type_validator(const.decl.type)
-          void_type_context_validator(const.decl.type)
         rescue BaseError => error
           @errors.add(error)
         end
@@ -281,9 +250,6 @@ EOU
         @env.global_decls.each do |name, global|
           RBS.logger.info "Validating global: `#{name}`..."
           @validator.validate_type global.decl.type, context: nil
-          no_self_type_validator(global.decl.type)
-          no_classish_type_validator(global.decl.type)
-          void_type_context_validator(global.decl.type)
         rescue BaseError => error
           @errors.add(error)
         end
@@ -306,52 +272,23 @@ EOU
 
           decl.decl.type_params.each do |param|
             if ub = param.upper_bound_type
-              void_type_context_validator(ub)
-              no_self_type_validator(ub)
-              no_classish_type_validator(ub)
               @validator.validate_type(ub, context: nil)
             end
 
+            if lb = param.lower_bound_type
+              @validator.validate_type(lb, context: nil)
+            end
+
             if dt = param.default_type
-              void_type_context_validator(dt, true)
-              no_self_type_validator(dt)
-              no_classish_type_validator(dt)
               @validator.validate_type(dt, context: nil)
             end
           end
 
           TypeParamDefaultReferenceError.check!(decl.decl.type_params)
-
-          no_self_type_validator(decl.decl.type)
-          no_classish_type_validator(decl.decl.type)
-          void_type_context_validator(decl.decl.type)
         rescue BaseError => error
           @errors.add(error)
         end
       end
-
-      private
-
-      def no_self_type_validator(type)
-        if type.has_self_type?
-          @errors.add WillSyntaxError.new("`self` type is not allowed in this context", location: type.location)
-        end
-      end
-
-      def no_classish_type_validator(type)
-        if type.has_classish_type?
-          @errors.add WillSyntaxError.new("`instance` or `class` type is not allowed in this context", location: type.location)
-        end
-      end
-
-      def void_type_context_validator(type, allowed_here = false)
-        if allowed_here
-          return if type.is_a?(Types::Bases::Void)
-        end
-        if type.with_nonreturn_void?
-          @errors.add WillSyntaxError.new("`void` type is only allowed in return type or generics parameter", location: type.location)
-        end
-      end
     end
   end
 end

data/lib/rbs/cli.rb

@@ -136,10 +136,12 @@ module RBS
       case command
       when :version
         stdout.puts opts.ver
+        0
       when *COMMANDS
         __send__ :"run_#{command}", args, options
       else
         stdout.puts opts.help
+        0
       end
     end
 
@@ -175,10 +177,9 @@ EOB
 
       env = Environment.from_loader(loader).resolve_type_names
 
-      decls = env.declarations.select do |decl|
-        loc = decl.location or raise
+      decls = env.sources.select do |source|
         # @type var name: String
-        name = loc.buffer.name
+        name = source.buffer.name.to_s
 
         patterns.empty? || patterns.any? do |pat|
           case pat
@@ -188,10 +189,12 @@ EOB
             name.end_with?(pat) || File.fnmatch(pat, name, File::FNM_EXTGLOB)
           end
         end
-      end
+      end.flat_map { _1.declarations }
 
       stdout.print JSON.generate(decls)
       stdout.flush
+
+      0
     end
 
     def run_list(args, options)
@@ -255,6 +258,8 @@ EOB
           stdout.puts "#{name} (interface)"
         end
       end
+
+      0
     end
 
     def run_ancestors(args, options)
@@ -280,7 +285,7 @@ EOU
 
       unless args.size == 1
         stdout.puts "Expected one argument."
-        return
+        return 1
       end
 
       loader = options.loader()
@@ -318,6 +323,8 @@ EOU
       else
         stdout.puts "Cannot find class: #{type_name}"
       end
+
+      0
     end
 
     def run_methods(args, options)
@@ -345,7 +352,7 @@ EOU
 
       unless args.size == 1
         stdout.puts "Expected one argument."
-        return
+        return 1
       end
 
       loader = options.loader()
@@ -374,6 +381,8 @@ EOU
       else
         stdout.puts "Cannot find class: #{type_name}"
       end
+
+      0
     end
 
     def run_method(args, options)
@@ -399,7 +408,7 @@ EOU
 
       unless args.size == 2
         stdout.puts "Expected two arguments, but given #{args.size}."
-        return
+        return 1
       end
 
       loader = options.loader()
@@ -411,7 +420,7 @@ EOU
 
       unless env.module_name?(type_name)
         stdout.puts "Cannot find class: #{type_name}"
-        return
+        return 1
       end
 
       definition = case kind
@@ -427,7 +436,7 @@ EOU
 
       unless method
         stdout.puts "Cannot find method: #{method_name}"
-        return
+        return 1
       end
 
       stdout.puts "#{type_name}#{kind == :instance ? "#" : "."}#{method_name}"
@@ -441,6 +450,8 @@ EOU
         stdout.puts format("    %s %-#{length_max}s   at %s", separator, type, type.location)
         separator = "|"
       end
+
+      0
     end
 
     def run_validate(args, options)
@@ -470,7 +481,7 @@ EOU
 
       unless args.size == 1
         stdout.puts "Expected one argument."
-        return
+        return 1
       end
 
       loader = options.loader()
@@ -503,6 +514,8 @@ EOU
       else
         stdout.puts " => [no constant]"
       end
+
+      0
     end
 
     def run_paths(args, options)
@@ -545,6 +558,8 @@ EOU
           stdout.puts "#{dir} (#{kind_of[dir]}, library, name=#{source.name})"
         end
       end
+
+      0
     end
 
     def run_prototype(args, options)
@@ -648,6 +663,8 @@ EOU
 
         writer = Writer.new(out: stdout)
         writer.write decls
+
+        0
       else
         stdout.puts <<EOU
 Usage: rbs prototype [generator...] [args...]
@@ -661,7 +678,7 @@ Examples:
   $ rbs prototype rbi foo.rbi
   $ rbs prototype runtime String
 EOU
-        exit 1
+        1
       end
     end
 
@@ -713,12 +730,12 @@ EOU
 
       unless has_parser?
         stdout.puts "Not supported on this interpreter (#{RUBY_ENGINE})."
-        exit 1
+        return 1
       end
 
       if args.empty?
         stdout.puts opts
-        return nil
+        return 1
       end
 
       new_parser = -> do
@@ -828,6 +845,8 @@ EOU
         writer = Writer.new(out: stdout)
         writer.write parser.decls
       end
+
+      0
     end
 
     def run_vendor(args, options)
@@ -881,6 +900,8 @@ Options:
 
       stdout.puts "  Copying RBS files..."
       vendorer.copy!
+
+      0
     end
 
     def run_parse(args, options)
@@ -913,7 +934,7 @@ Options:
           Buffer.new(content: file_path.read, name: file_path)
         end
       end
-      bufs << Buffer.new(content: e_code, name: '-e') if e_code
+      bufs << Buffer.new(content: e_code, name: Pathname('-e')) if e_code
 
       bufs.each do |buf|
         RBS.logger.info "Parsing #{buf.name}..."
@@ -928,7 +949,11 @@ Options:
         syntax_error = true
       end
 
-      exit 1 if syntax_error
+      if syntax_error
+        1
+      else
+        0
+      end
     end
 
     def run_annotate(args, options)
@@ -937,8 +962,6 @@ Options:
       source = RBS::Annotate::RDocSource.new()
       annotator = RBS::Annotate::RDocAnnotator.new(source: source)
 
-      preserve = true
-
       OptionParser.new do |opts|
         opts.banner = <<-EOB
 Usage: rbs annotate [options...] [files...]
@@ -947,7 +970,7 @@ Import documents from RDoc and update RBS files.
 
 Examples:
 
-  $ rbs annotate stdlib/pathname/**/*.rbs
+  $ rbs annotate stdlib/logger/**/*.rbs
 
 Options:
         EOB
@@ -959,7 +982,7 @@ Options:
         opts.on("-d", "--dir DIRNAME", "Load RDoc from DIRNAME") {|d| source.extra_dirs << Pathname(d) }
         opts.on("--[no-]arglists", "Generate arglists section (defaults to true)") {|b| annotator.include_arg_lists = b }
         opts.on("--[no-]filename", "Include source file name in the documentation (defaults to true)") {|b| annotator.include_filename = b }
-        opts.on("--[no-]preserve", "Try preserve the format of the original file (defaults to true)") {|b| preserve = b }
+        opts.on("--[no-]preserve", "[Deprecated] It always preserves the format") { stdout.puts "The `--preserve` option is deprecated. The tool always preserves the format of RBS files." }
       end.parse!(args)
 
       source.load()
@@ -969,13 +992,15 @@ Options:
         if path.directory?
           Pathname.glob((path + "**/*.rbs").to_s).each do |path|
             stdout.puts "Processing #{path}..."
-            annotator.annotate_file(path, preserve: preserve)
+            annotator.annotate_file(path)
           end
         else
           stdout.puts "Processing #{path}..."
-          annotator.annotate_file(path, preserve: preserve)
+          annotator.annotate_file(path)
         end
       end
+
+      0
     end
 
     def test_opt options
@@ -1029,7 +1054,7 @@ EOB
 
       if args.length.zero?
         stdout.puts opts.help
-        exit 1
+        return 1
       end
 
       # @type var env_hash: Hash[String, String?]
@@ -1045,11 +1070,12 @@ EOB
 
       # @type var out: String
       # @type var err: String
+      # @type var status: Process::Status
       out, err, status = __skip__ = Open3.capture3(env_hash, *args)
       stdout.print(out)
       stderr.print(err)
 
-      status
+      status.to_i
     end
 
     def run_collection(args, options)
@@ -1074,7 +1100,7 @@ EOB
       when 'init'
         if config_path.exist?
           puts "#{config_path} already exists"
-          exit 1
+          return 1
         end
 
         config_path.write(<<~'YAML')
@@ -1102,15 +1128,17 @@ EOB
       when 'clean'
         unless lock_path.exist?
           puts "#{lock_path} should exist to clean"
-          exit 1
+          return 1
         end
         Collection::Cleaner.new(lockfile_path: lock_path)
       when 'help', 'hel', 'he', 'h'
         puts opts.help
       else
         puts opts.help
-        exit 1
+        return 1
       end
+
+      0
     end
 
     def collection_options(args)
@@ -1172,7 +1200,7 @@ EOB
         *minuend_paths, subtrahend_path = args
         unless subtrahend_path
           stdout.puts opts.help
-          exit 1
+          return 1
         end
         subtrahend_paths << subtrahend_path
       else
@@ -1181,7 +1209,7 @@ EOB
 
       if minuend_paths.empty?
         stdout.puts opts.help
-        exit 1
+        return 1
       end
 
       subtrahend = Environment.new.tap do |env|
@@ -1214,10 +1242,12 @@ EOB
           end
         end
       end
+
+      0
     end
 
     def run_diff(argv, library_options)
-      Diff.new(argv: argv, library_options: library_options, stdout: stdout, stderr: stderr).run
+      Diff.new(stdout: stdout, stderr: stderr).run(argv: argv, library_options: library_options)
     end
   end
 end