rbs 3.0.4 → 3.1.1

data/lib/rbs/cli.rb

@@ -3,6 +3,8 @@
 require "open3"
 require "optparse"
 require "shellwords"
+require "abbrev"
+require "stringio"
 
 module RBS
   class CLI
@@ -88,7 +90,7 @@ module RBS
       @stderr = stderr
     end
 
-    COMMANDS = [:ast, :annotate, :list, :ancestors, :methods, :method, :validate, :constant, :paths, :prototype, :vendor, :parse, :test, :collection]
+    COMMANDS = [:ast, :annotate, :list, :ancestors, :methods, :method, :validate, :constant, :paths, :prototype, :vendor, :parse, :test, :collection, :subtract]
 
     def parse_logging_options(opts)
       opts.on("--log-level LEVEL", "Specify log level (defaults to `warn`)") do |level|
@@ -450,7 +452,6 @@ Examples:
 EOU
 
         opts.on("--silent") do
-          require "stringio"
           @stdout = StringIO.new
         end
       end.parse!(args)
@@ -920,6 +921,10 @@ Options:
     end
 
     def run_parse(args, options)
+      parse_method = :parse_signature
+      # @type var e_code: String?
+      e_code = nil
+
       OptionParser.new do |opts|
         opts.banner = <<-EOB
 Usage: rbs parse [files...]
@@ -929,22 +934,35 @@ Parse given RBS files and print syntax errors.
 Examples:
 
   $ rbs parse sig/app/models.rbs sig/app/controllers.rbs
+
+Options:
         EOB
-      end.parse!(args)
 
-      loader = options.loader()
+        opts.on('-e CODE', 'One line RBS script to parse') { |e| e_code = e }
+        opts.on('--type', 'Parse code as a type') { |e| parse_method = :parse_type }
+        opts.on('--method-type', 'Parse code as a method type') { |e| parse_method = :parse_method_type }
+      end.parse!(args)
 
       syntax_error = false
-      args.each do |path|
+      bufs = args.flat_map do |path|
         path = Pathname(path)
-        loader.each_file(path, skip_hidden: false, immediate: true) do |file_path|
-          RBS.logger.info "Parsing #{file_path}..."
-          buffer = Buffer.new(content: file_path.read, name: file_path)
-          Parser.parse_signature(buffer)
-        rescue RBS::ParsingError => ex
-          stdout.puts ex.message
-          syntax_error = true
+        FileFinder.each_file(path, skip_hidden: false, immediate: true).map do |file_path|
+          Buffer.new(content: file_path.read, name: file_path)
+        end
+      end
+      bufs << Buffer.new(content: e_code, name: '-e') if e_code
+
+      bufs.each do |buf|
+        RBS.logger.info "Parsing #{buf.name}..."
+        case parse_method
+        when :parse_signature
+          Parser.parse_signature(buf)
+        else
+          Parser.public_send(parse_method, buf, require_eof: true)
         end
+      rescue RBS::ParsingError => ex
+        stdout.puts ex.message
+        syntax_error = true
       end
 
       exit 1 if syntax_error
@@ -1078,7 +1096,8 @@ EOB
       config_path = options.config_path or raise
       lock_path = Collection::Config.to_lockfile_path(config_path)
 
-      case args[0]
+      subcommand = Abbrev.abbrev(['install', 'update', 'help'])[args[0]] || args[0]
+      case subcommand
       when 'install'
         unless params[:frozen]
           Collection::Config.generate_lockfile(config_path: config_path, definition: Bundler.definition)
@@ -1154,5 +1173,80 @@ EOB
         opts.on('--frozen') if args[0] == 'install'
       end
     end
+
+    def run_subtract(args, _)
+      write_to_file = false
+      # @type var subtrahend_paths: Array[String]
+      subtrahend_paths = []
+
+      opts = OptionParser.new do |opts|
+        opts.banner = <<~HELP
+          Usage:
+            rbs subtract [options...] minuend.rbs [minuend2.rbs, ...] subtrahend.rbs
+            rbs subtract [options...] minuend.rbs [minuend2.rbs, ...] --subtrahend subtrahend_1.rbs --subtrahend subtrahend_2.rbs
+
+          Remove duplications between RBS files.
+
+          Examples:
+
+            # Generate RBS files from the codebase.
+            $ rbs prototype rb lib/ > generated.rbs
+
+            # Write more descrictive types by hand.
+            $ $EDITOR handwritten.rbs
+
+            # Remove hand-written method definitions from generated.rbs.
+            $ rbs subtract --write generated.rbs handwritten.rbs
+
+          Options:
+        HELP
+        opts.on('-w', '--write', 'Overwrite files directry') { write_to_file = true }
+        opts.on('--subtrahend=PATH', '') { |path| subtrahend_paths << path }
+        opts.parse!(args)
+      end
+
+      if subtrahend_paths.empty?
+        *minuend_paths, subtrahend_path = args
+        unless subtrahend_path
+          stdout.puts opts.help
+          exit 1
+        end
+        subtrahend_paths << subtrahend_path
+      else
+        minuend_paths = args
+      end
+
+      if minuend_paths.empty?
+        stdout.puts opts.help
+        exit 1
+      end
+
+      subtrahend = Environment.new.tap do |env|
+        loader = EnvironmentLoader.new(core_root: nil)
+        subtrahend_paths.each do |path|
+          loader.add(path: Pathname(path))
+        end
+        loader.load(env: env)
+      end
+
+      minuend_paths.each do |minuend_path|
+        FileFinder.each_file(Pathname(minuend_path), immediate: true, skip_hidden: true) do |rbs_path|
+          buf = Buffer.new(name: rbs_path, content: rbs_path.read)
+          _, dirs, decls = Parser.parse_signature(buf)
+          subtracted = Subtractor.new(decls, subtrahend).call
+
+          io = StringIO.new
+          w = Writer.new(out: io)
+          w.write(dirs)
+          w.write(subtracted)
+
+          if write_to_file
+            rbs_path.write(io.string)
+          else
+            stdout.puts(io.string)
+          end
+        end
+      end
+    end
   end
 end

data/lib/rbs/collection/config/lockfile_generator.rb

@@ -76,7 +76,7 @@ module RBS
             end
 
             if spec = gem_hash[dep.name]
-              assign_gem(name: dep.name, version: spec.version, ignored_gems: ignored_gems, src_data: nil)
+              assign_gem(name: dep.name, version: spec.version, ignored_gems: ignored_gems, src_data: nil, skip: dep.source.is_a?(Bundler::Source::Gemspec))
             end
           end
 
@@ -91,50 +91,56 @@ module RBS
           end
         end
 
-        private def assign_gem(name:, version:, src_data:, ignored_gems:)
+        private def assign_gem(name:, version:, src_data:, ignored_gems:, skip: false)
           return if ignored_gems.include?(name)
           return if lockfile.gems.key?(name)
 
-          # @type var locked: Lockfile::library?
+          unless skip
+            # @type var locked: Lockfile::library?
 
-          if existing_lockfile
-            locked = existing_lockfile.gems[name]
-          end
+            if existing_lockfile
+              locked = existing_lockfile.gems[name]
+            end
 
-          # If rbs_collection.lock.yaml contain the gem, use it.
-          # Else find the gem from gem_collection.
-          unless locked
-            source =
-              if src_data
-                Sources.from_config_entry(src_data, base_directory: config.config_path.dirname)
-              else
-                find_source(name: name)
+            # If rbs_collection.lock.yaml contain the gem, use it.
+            # Else find the gem from gem_collection.
+            unless locked
+              source =
+                if src_data
+                  Sources.from_config_entry(src_data, base_directory: config.config_path.dirname)
+                else
+                  find_source(name: name)
+                end
+
+              if source
+                installed_version = version
+                best_version = find_best_version(version: installed_version, versions: source.versions(name))
+
+                locked = {
+                  name: name,
+                  version: best_version.to_s,
+                  source: source,
+                }
               end
-
-            if source
-              installed_version = version
-              best_version = find_best_version(version: installed_version, versions: source.versions(name))
-
-              locked = {
-                name: name,
-                version: best_version.to_s,
-                source: source,
-              }
             end
-          end
 
-          if locked
-            lockfile.gems[name] = locked
+            if locked
+              lockfile.gems[name] = locked
 
-            locked[:source].dependencies_of(locked[:name], locked[:version])&.each do |dep|
-              assign_stdlib(name: dep["name"], from_gem: name)
+              locked[:source].dependencies_of(locked[:name], locked[:version])&.each do |dep|
+                assign_stdlib(name: dep["name"], from_gem: name)
+              end
             end
           end
 
-          gem_hash[name].dependencies.each do |dep|
-            if spec = gem_hash[dep.name]
-              assign_gem(name: dep.name, version: spec.version, src_data: nil, ignored_gems: ignored_gems)
+          if spec = gem_hash.fetch(name, nil)
+            spec.dependencies.each do |dep|
+              if dep_spec = gem_hash[dep.name]
+                assign_gem(name: dep.name, version: dep_spec.version, src_data: nil, ignored_gems: ignored_gems)
+              end
             end
+          else
+            RBS.logger.warn "Cannot find `#{name}` gem. Using incorrect Bundler context? (#{definition.lockfile})"
           end
         end
 

data/lib/rbs/definition_builder.rb

@@ -239,14 +239,6 @@ module RBS
             definition.class_variables.merge!(defn.class_variables)
           end
 
-          all_interfaces = one_ancestors.each_extended_interface.flat_map do |interface|
-            other_interfaces = ancestor_builder.interface_ancestors(interface.name).ancestors #: Array[Definition::Ancestor::Instance]
-            other_interfaces = other_interfaces.select {|ancestor| ancestor.source }
-            [interface, *other_interfaces]
-          end
-          interface_methods = interface_methods(all_interfaces)
-          import_methods(definition, type_name, methods, interface_methods, Substitution.new)
-
           one_ancestors.each_extended_module do |mod|
             mod.args.each do |arg|
               validate_type_presence(arg)
@@ -256,7 +248,12 @@ module RBS
             define_instance(definition, mod.name, subst)
           end
 
-          interface_methods = interface_methods(one_ancestors.each_extended_interface.to_a)
+          all_interfaces = one_ancestors.each_extended_interface.flat_map do |interface|
+            other_interfaces = ancestor_builder.interface_ancestors(interface.name).ancestors #: Array[Definition::Ancestor::Instance]
+            other_interfaces = other_interfaces.select {|ancestor| ancestor.source }
+            [interface, *other_interfaces]
+          end
+          interface_methods = interface_methods(all_interfaces)
           import_methods(definition, type_name, methods, interface_methods, Substitution.new)
 
           entry.decls.each do |d|

data/lib/rbs/environment.rb

@@ -365,7 +365,7 @@ module RBS
         name = decl.name.with_prefix(namespace)
 
         if interface_entry = interface_decls[name]
-          DuplicatedDeclarationError.new(name, decl, interface_entry.decl)
+          raise DuplicatedDeclarationError.new(name, decl, interface_entry.decl)
         end
 
         interface_decls[name] = InterfaceEntry.new(name: name, decl: decl, outer: outer)
@@ -374,7 +374,7 @@ module RBS
         name = decl.name.with_prefix(namespace)
 
         if entry = type_alias_decls[name]
-          DuplicatedDeclarationError.new(name, decl, entry.decl)
+          raise DuplicatedDeclarationError.new(name, decl, entry.decl)
         end
 
         type_alias_decls[name] = TypeAliasEntry.new(name: name, decl: decl, outer: outer)

data/lib/rbs/environment_loader.rb

@@ -12,6 +12,8 @@ module RBS
       end
     end
 
+    include FileFinder
+
     Library = _ = Struct.new(:name, :version, keyword_init: true)
 
     attr_reader :core_root
@@ -129,35 +131,13 @@ module RBS
       end
     end
 
-    def each_file(path, immediate:, skip_hidden:, &block)
-      case
-      when path.file?
-        if path.extname == ".rbs" || immediate
-          yield path
-        end
-
-      when path.directory?
-        if path.basename.to_s.start_with?("_")
-          if skip_hidden
-            unless immediate
-              return
-            end
-          end
-        end
-
-        path.children.sort.each do |child|
-          each_file(child, immediate: false, skip_hidden: skip_hidden, &block)
-        end
-      end
-    end
-
     def each_signature
       files = Set[]
 
       each_dir do |source, dir|
         skip_hidden = !source.is_a?(Pathname)
 
-        each_file(dir, skip_hidden: skip_hidden, immediate: true) do |path|
+        FileFinder.each_file(dir, skip_hidden: skip_hidden, immediate: true) do |path|
           next if files.include?(path)
 
           files << path

data/lib/rbs/errors.rb

@@ -22,11 +22,16 @@ module RBS
 
   module DetailedMessageable
     def detailed_message(highlight: false, **)
+      msg = super
+
+      # Support only one line
+      return msg unless location.start_line == location.end_line
+
       indent = " " * location.start_column
       marker = "^" * (location.end_column - location.start_column)
 
       io = StringIO.new
-      io.puts super
+      io.puts msg
       io.puts
       io.print "\e[1m" if highlight
       io.puts "  #{location.buffer.lines[location.end_line - 1]}"
@@ -125,7 +130,9 @@ module RBS
     end
   end
 
-  class NoTypeFoundError < BaseError
+  class NoTypeFoundError < DefinitionError
+    include DetailedMessageable
+
     attr_reader :type_name
     attr_reader :location
 
@@ -163,6 +170,8 @@ module RBS
   end
 
   class InheritModuleError < DefinitionError
+    include DetailedMessageable
+
     attr_reader :super_decl
 
     def initialize(super_decl)
@@ -171,6 +180,10 @@ module RBS
       super "#{Location.to_string(super_decl.location)}: Cannot inherit a module: #{super_decl.name}"
     end
 
+    def location
+      @super_decl.location
+    end
+
     def self.check!(super_decl, env:)
       return if env.class_decl?(super_decl.name) || env.class_alias?(super_decl.name)
 
@@ -179,6 +192,8 @@ module RBS
   end
 
   class NoSelfTypeFoundError < DefinitionError
+    include DetailedMessageable
+
     attr_reader :type_name
     attr_reader :location
 
@@ -197,6 +212,8 @@ module RBS
   end
 
   class NoMixinFoundError < DefinitionError
+    include DetailedMessageable
+
     attr_reader :type_name
     attr_reader :member
 
@@ -217,6 +234,8 @@ module RBS
   end
 
   class DuplicatedMethodDefinitionError < DefinitionError
+    include DetailedMessageable
+
     attr_reader :type
     attr_reader :method_name
     attr_reader :members
@@ -256,6 +275,8 @@ module RBS
   end
 
   class DuplicatedInterfaceMethodDefinitionError < DefinitionError
+    include DetailedMessageable
+
     attr_reader :type
     attr_reader :method_name
     attr_reader :member
@@ -268,6 +289,10 @@ module RBS
       super "#{member.location}: Duplicated method definition: #{qualified_method_name}"
     end
 
+    def location
+      member.location
+    end
+
     def qualified_method_name
       case type
       when Types::ClassSingleton
@@ -283,6 +308,8 @@ module RBS
   end
 
   class UnknownMethodAliasError < DefinitionError
+    include DetailedMessageable
+
     attr_reader :type_name
     attr_reader :original_name
     attr_reader :aliased_name
@@ -310,6 +337,8 @@ module RBS
   end
 
   class InvalidOverloadMethodError < DefinitionError
+    include DetailedMessageable
+
     attr_reader :type_name
     attr_reader :method_name
     attr_reader :kind
@@ -330,6 +359,10 @@ module RBS
 
       super "#{Location.to_string members[0].location}: Invalid method overloading: #{type_name}#{delimiter}#{method_name}"
     end
+
+    def location
+      members[0].location
+    end
   end
 
   class GenericParameterMismatchError < LoadingError
@@ -357,6 +390,8 @@ module RBS
   end
 
   class InvalidVarianceAnnotationError < DefinitionError
+    include DetailedMessageable
+
     attr_reader :type_name
     attr_reader :param
     attr_reader :location
@@ -371,6 +406,8 @@ module RBS
   end
 
   class RecursiveAliasDefinitionError < DefinitionError
+    include DetailedMessageable
+
     attr_reader :type
     attr_reader :defs
 
@@ -389,6 +426,8 @@ module RBS
   end
 
   class MixinClassError < DefinitionError
+    include DetailedMessageable
+
     attr_reader :type_name
     attr_reader :member
 
@@ -426,6 +465,8 @@ module RBS
   end
 
   class RecursiveTypeAliasError < BaseError
+    include DetailedMessageable
+
     attr_reader :alias_names
     attr_reader :location
 
@@ -442,6 +483,8 @@ module RBS
   end
 
   class NonregularTypeAliasError < BaseError
+    include DetailedMessageable
+
     attr_reader :diagnostic
     attr_reader :location
 
@@ -454,6 +497,8 @@ module RBS
   end
 
   class CyclicTypeParameterBound < BaseError
+    include DetailedMessageable
+
     attr_reader :params, :type_name, :method_name, :location
 
     def initialize(type_name:, method_name:, params:, location:)
@@ -467,6 +512,8 @@ module RBS
   end
 
   class InconsistentClassModuleAliasError < BaseError
+    include DetailedMessageable
+
     attr_reader :alias_entry
 
     def initialize(entry)
@@ -482,9 +529,15 @@ module RBS
 
       super "#{Location.to_string(entry.decl.location&.[](:old_name))}: A #{expected_kind} `#{entry.decl.new_name}` cannot be an alias of a #{actual_kind} `#{entry.decl.old_name}`"
     end
+
+    def location
+      @alias_entry.decl.location
+    end
   end
 
   class CyclicClassAliasDefinitionError < BaseError
+    include DetailedMessageable
+
     attr_reader :alias_entry
 
     def initialize(entry)
@@ -492,5 +545,9 @@ module RBS
 
       super "#{Location.to_string(entry.decl.location&.[](:old_name))}: A #{alias_entry.decl.new_name} is a cyclic definition"
     end
+
+    def location
+      @alias_entry.decl.location
+    end
   end
 end

data/lib/rbs/file_finder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RBS
+  module FileFinder
+    module_function
+
+    def self.each_file(path, immediate:, skip_hidden:, &block)
+      return enum_for(__method__, path, immediate: immediate, skip_hidden: skip_hidden) unless block
+
+      case
+      when path.file?
+        if path.extname == ".rbs" || immediate
+          yield path
+        end
+
+      when path.directory?
+        if path.basename.to_s.start_with?("_")
+          if skip_hidden
+            unless immediate
+              return
+            end
+          end
+        end
+
+        path.children.sort.each do |child|
+          each_file(child, immediate: false, skip_hidden: skip_hidden, &block)
+        end
+      end
+    end
+  end
+end

data/lib/rbs/parser_aux.rb

@@ -2,14 +2,14 @@
 
 module RBS
   class Parser
-    def self.parse_type(source, range: 0..., variables: [])
+    def self.parse_type(source, range: 0..., variables: [], require_eof: false)
       buf = buffer(source)
-      _parse_type(buf, range.begin || 0, range.end || buf.last_position, variables)
+      _parse_type(buf, range.begin || 0, range.end || buf.last_position, variables, require_eof)
     end
 
-    def self.parse_method_type(source, range: 0..., variables: [])
+    def self.parse_method_type(source, range: 0..., variables: [], require_eof: false)
       buf = buffer(source)
-      _parse_method_type(buf, range.begin || 0, range.end || buf.last_position, variables)
+      _parse_method_type(buf, range.begin || 0, range.end || buf.last_position, variables, require_eof)
     end
 
     def self.parse_signature(source)

data/lib/rbs/prototype/rb.rb

@@ -215,7 +215,8 @@ module RBS
           when :include
             args.each do |arg|
               if (name = const_to_name(arg, context: context))
-                decls << AST::Members::Include.new(
+                klass = context.singleton ? AST::Members::Extend : AST::Members::Include
+                decls << klass.new(
                   name: name,
                   args: [],
                   annotations: [],